// Code generated by smithy-go-codegen DO NOT EDIT. package health 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/health/types" "github.com/aws/smithy-go/middleware" smithyhttp "github.com/aws/smithy-go/transport/http" ) // Returns information about events that meet the specified filter criteria. // Events are returned in a summary form and do not include the detailed // description, any additional metadata that depends on the event type, or any // affected resources. To retrieve that information, use the DescribeEventDetails (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetails.html) // and DescribeAffectedEntities (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntities.html) // operations. If no filter criteria are specified, all events are returned. // Results are sorted by lastModifiedTime , starting with the most recent event. // - When you call the DescribeEvents operation and specify an entity for the // entityValues parameter, Health might return public events that aren't specific // to that resource. For example, if you call DescribeEvents and specify an ID // for an Amazon Elastic Compute Cloud (Amazon EC2) instance, Health might return // events that aren't specific to that resource or service. To get events that are // specific to a service, use the services parameter in the filter object. For // more information, see Event (https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html) // . // - This API operation uses pagination. Specify the nextToken parameter in the // next request to return more results. 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 } type DescribeEventsInput struct { // Values to narrow the results returned. Filter *types.EventFilter // The locale (language) to return information in. English (en) is the default and // the only supported value at this time. Locale *string // The maximum number of items to return in one batch, between 10 and 100, // inclusive. MaxResults *int32 // If the results of a search are large, only a portion of the results are // returned, and a nextToken pagination token is returned in the response. To // retrieve the next batch of results, reissue the search request and include the // returned token. When all results have been returned, the response does not // contain a pagination token value. NextToken *string noSmithyDocumentSerde } type DescribeEventsOutput struct { // The events that match the specified filter criteria. Events []types.Event // If the results of a search are large, only a portion of the results are // returned, and a nextToken pagination token is returned in the response. To // retrieve the next batch of results, reissue the search request and include the // returned token. When all results have been returned, the response does not // contain a pagination token value. NextToken *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(&awsAwsjson11_serializeOpDescribeEvents{}, middleware.After) if err != nil { return err } err = stack.Deserialize.Add(&awsAwsjson11_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 items to return in one batch, between 10 and 100, // inclusive. 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.MaxResults != nil { options.Limit = *params.MaxResults } for _, fn := range optFns { fn(&options) } return &DescribeEventsPaginator{ options: options, client: client, params: params, firstPage: true, nextToken: params.NextToken, } } // 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.NextToken = p.nextToken var limit *int32 if p.options.Limit > 0 { limit = &p.options.Limit } params.MaxResults = limit result, err := p.client.DescribeEvents(ctx, ¶ms, optFns...) if err != nil { return nil, err } p.firstPage = false prevToken := p.nextToken p.nextToken = result.NextToken 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: "health", OperationName: "DescribeEvents", } }