// Code generated by smithy-go-codegen DO NOT EDIT. package elasticache import ( "context" "fmt" awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware" "github.com/aws/aws-sdk-go-v2/aws/signer/v4" "github.com/aws/aws-sdk-go-v2/service/elasticache/types" "github.com/aws/smithy-go/middleware" smithyhttp "github.com/aws/smithy-go/transport/http" "time" ) // Returns events related to clusters, cache security groups, and cache parameter // groups. You can obtain events specific to a particular cluster, cache security // group, or cache parameter group by providing the name as a parameter. By // default, only the events occurring within the last hour are returned; however, // you can retrieve up to 14 days' worth of events if necessary. func (c *Client) DescribeEvents(ctx context.Context, params *DescribeEventsInput, optFns ...func(*Options)) (*DescribeEventsOutput, error) { if params == nil { params = &DescribeEventsInput{} } result, metadata, err := c.invokeOperation(ctx, "DescribeEvents", params, optFns, c.addOperationDescribeEventsMiddlewares) if err != nil { return nil, err } out := result.(*DescribeEventsOutput) out.ResultMetadata = metadata return out, nil } // Represents the input of a DescribeEvents operation. type DescribeEventsInput struct { // The number of minutes worth of events to retrieve. Duration *int32 // The end of the time interval for which to retrieve events, specified in ISO // 8601 format. Example: 2017-03-30T07:03:49.555Z EndTime *time.Time // An optional marker returned from a prior request. Use this marker for // pagination of results from this operation. If this parameter is specified, the // response includes only records beyond the marker, up to the value specified by // MaxRecords . Marker *string // The maximum number of records to include in the response. If more records exist // than the specified MaxRecords value, a marker is included in the response so // that the remaining results can be retrieved. Default: 100 Constraints: minimum // 20; maximum 100. MaxRecords *int32 // The identifier of the event source for which events are returned. If not // specified, all sources are included in the response. SourceIdentifier *string // The event source to retrieve events for. If no value is specified, all events // are returned. SourceType types.SourceType // The beginning of the time interval to retrieve events for, specified in ISO // 8601 format. Example: 2017-03-30T07:03:49.555Z StartTime *time.Time noSmithyDocumentSerde } // Represents the output of a DescribeEvents operation. type DescribeEventsOutput struct { // A list of events. Each element in the list contains detailed information about // one event. Events []types.Event // Provides an identifier to allow retrieval of paginated results. Marker *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata noSmithyDocumentSerde } func (c *Client) addOperationDescribeEventsMiddlewares(stack *middleware.Stack, options Options) (err error) { err = stack.Serialize.Add(&awsAwsquery_serializeOpDescribeEvents{}, middleware.After) if err != nil { return err } err = stack.Deserialize.Add(&awsAwsquery_deserializeOpDescribeEvents{}, middleware.After) if err != nil { return err } if err = addSetLoggerMiddleware(stack, options); err != nil { return err } if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil { return err } if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil { return err } if err = addResolveEndpointMiddleware(stack, options); err != nil { return err } if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil { return err } if err = addRetryMiddlewares(stack, options); err != nil { return err } if err = addHTTPSignerV4Middleware(stack, options); err != nil { return err } if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil { return err } if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil { return err } if err = addClientUserAgent(stack, options); err != nil { return err } if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil { return err } if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil { return err } if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDescribeEvents(options.Region), middleware.Before); err != nil { return err } if err = awsmiddleware.AddRecursionDetection(stack); err != nil { return err } if err = addRequestIDRetrieverMiddleware(stack); err != nil { return err } if err = addResponseErrorMiddleware(stack); err != nil { return err } if err = addRequestResponseLogging(stack, options); err != nil { return err } return nil } // DescribeEventsAPIClient is a client that implements the DescribeEvents // operation. type DescribeEventsAPIClient interface { DescribeEvents(context.Context, *DescribeEventsInput, ...func(*Options)) (*DescribeEventsOutput, error) } var _ DescribeEventsAPIClient = (*Client)(nil) // DescribeEventsPaginatorOptions is the paginator options for DescribeEvents type DescribeEventsPaginatorOptions struct { // The maximum number of records to include in the response. If more records exist // than the specified MaxRecords value, a marker is included in the response so // that the remaining results can be retrieved. Default: 100 Constraints: minimum // 20; maximum 100. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool } // DescribeEventsPaginator is a paginator for DescribeEvents type DescribeEventsPaginator struct { options DescribeEventsPaginatorOptions client DescribeEventsAPIClient params *DescribeEventsInput nextToken *string firstPage bool } // NewDescribeEventsPaginator returns a new DescribeEventsPaginator func NewDescribeEventsPaginator(client DescribeEventsAPIClient, params *DescribeEventsInput, optFns ...func(*DescribeEventsPaginatorOptions)) *DescribeEventsPaginator { if params == nil { params = &DescribeEventsInput{} } options := DescribeEventsPaginatorOptions{} if params.MaxRecords != nil { options.Limit = *params.MaxRecords } for _, fn := range optFns { fn(&options) } return &DescribeEventsPaginator{ options: options, client: client, params: params, firstPage: true, nextToken: params.Marker, } } // HasMorePages returns a boolean indicating whether more pages are available func (p *DescribeEventsPaginator) HasMorePages() bool { return p.firstPage || (p.nextToken != nil && len(*p.nextToken) != 0) } // NextPage retrieves the next DescribeEvents page. func (p *DescribeEventsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeEventsOutput, error) { if !p.HasMorePages() { return nil, fmt.Errorf("no more pages available") } params := *p.params params.Marker = p.nextToken var limit *int32 if p.options.Limit > 0 { limit = &p.options.Limit } params.MaxRecords = limit result, err := p.client.DescribeEvents(ctx, ¶ms, optFns...) if err != nil { return nil, err } p.firstPage = false prevToken := p.nextToken p.nextToken = result.Marker if p.options.StopOnDuplicateToken && prevToken != nil && p.nextToken != nil && *prevToken == *p.nextToken { p.nextToken = nil } return result, nil } func newServiceMetadataMiddleware_opDescribeEvents(region string) *awsmiddleware.RegisterServiceMetadata { return &awsmiddleware.RegisterServiceMetadata{ Region: region, ServiceID: ServiceID, SigningName: "elasticache", OperationName: "DescribeEvents", } }