1// Code generated by smithy-go-codegen DO NOT EDIT. 2 3package health 4 5import ( 6 "context" 7 "fmt" 8 awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware" 9 "github.com/aws/aws-sdk-go-v2/aws/signer/v4" 10 "github.com/aws/aws-sdk-go-v2/service/health/types" 11 "github.com/aws/smithy-go/middleware" 12 smithyhttp "github.com/aws/smithy-go/transport/http" 13) 14 15// Returns the event types that meet the specified filter criteria. You can use 16// this API operation to find information about the AWS Health event, such as the 17// category, AWS service, and event code. The metadata for each event appears in 18// the EventType 19// (https://docs.aws.amazon.com/health/latest/APIReference/API_EventType.html) 20// object. If you don't specify a filter criteria, the API operation returns all 21// event types, in no particular order. This API operation uses pagination. Specify 22// the nextToken parameter in the next request to return more results. 23func (c *Client) DescribeEventTypes(ctx context.Context, params *DescribeEventTypesInput, optFns ...func(*Options)) (*DescribeEventTypesOutput, error) { 24 if params == nil { 25 params = &DescribeEventTypesInput{} 26 } 27 28 result, metadata, err := c.invokeOperation(ctx, "DescribeEventTypes", params, optFns, addOperationDescribeEventTypesMiddlewares) 29 if err != nil { 30 return nil, err 31 } 32 33 out := result.(*DescribeEventTypesOutput) 34 out.ResultMetadata = metadata 35 return out, nil 36} 37 38type DescribeEventTypesInput struct { 39 40 // Values to narrow the results returned. 41 Filter *types.EventTypeFilter 42 43 // The locale (language) to return information in. English (en) is the default and 44 // the only supported value at this time. 45 Locale *string 46 47 // The maximum number of items to return in one batch, between 10 and 100, 48 // inclusive. 49 MaxResults *int32 50 51 // If the results of a search are large, only a portion of the results are 52 // returned, and a nextToken pagination token is returned in the response. To 53 // retrieve the next batch of results, reissue the search request and include the 54 // returned token. When all results have been returned, the response does not 55 // contain a pagination token value. 56 NextToken *string 57} 58 59type DescribeEventTypesOutput struct { 60 61 // A list of event types that match the filter criteria. Event types have a 62 // category (issue, accountNotification, or scheduledChange), a service (for 63 // example, EC2, RDS, DATAPIPELINE, BILLING), and a code (in the format 64 // AWS_SERVICE_DESCRIPTION ; for example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT). 65 EventTypes []types.EventType 66 67 // If the results of a search are large, only a portion of the results are 68 // returned, and a nextToken pagination token is returned in the response. To 69 // retrieve the next batch of results, reissue the search request and include the 70 // returned token. When all results have been returned, the response does not 71 // contain a pagination token value. 72 NextToken *string 73 74 // Metadata pertaining to the operation's result. 75 ResultMetadata middleware.Metadata 76} 77 78func addOperationDescribeEventTypesMiddlewares(stack *middleware.Stack, options Options) (err error) { 79 err = stack.Serialize.Add(&awsAwsjson11_serializeOpDescribeEventTypes{}, middleware.After) 80 if err != nil { 81 return err 82 } 83 err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpDescribeEventTypes{}, middleware.After) 84 if err != nil { 85 return err 86 } 87 if err = addSetLoggerMiddleware(stack, options); err != nil { 88 return err 89 } 90 if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil { 91 return err 92 } 93 if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil { 94 return err 95 } 96 if err = addResolveEndpointMiddleware(stack, options); err != nil { 97 return err 98 } 99 if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil { 100 return err 101 } 102 if err = addRetryMiddlewares(stack, options); err != nil { 103 return err 104 } 105 if err = addHTTPSignerV4Middleware(stack, options); err != nil { 106 return err 107 } 108 if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil { 109 return err 110 } 111 if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil { 112 return err 113 } 114 if err = addClientUserAgent(stack); err != nil { 115 return err 116 } 117 if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil { 118 return err 119 } 120 if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil { 121 return err 122 } 123 if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDescribeEventTypes(options.Region), middleware.Before); err != nil { 124 return err 125 } 126 if err = addRequestIDRetrieverMiddleware(stack); err != nil { 127 return err 128 } 129 if err = addResponseErrorMiddleware(stack); err != nil { 130 return err 131 } 132 if err = addRequestResponseLogging(stack, options); err != nil { 133 return err 134 } 135 return nil 136} 137 138// DescribeEventTypesAPIClient is a client that implements the DescribeEventTypes 139// operation. 140type DescribeEventTypesAPIClient interface { 141 DescribeEventTypes(context.Context, *DescribeEventTypesInput, ...func(*Options)) (*DescribeEventTypesOutput, error) 142} 143 144var _ DescribeEventTypesAPIClient = (*Client)(nil) 145 146// DescribeEventTypesPaginatorOptions is the paginator options for 147// DescribeEventTypes 148type DescribeEventTypesPaginatorOptions struct { 149 // The maximum number of items to return in one batch, between 10 and 100, 150 // inclusive. 151 Limit int32 152 153 // Set to true if pagination should stop if the service returns a pagination token 154 // that matches the most recent token provided to the service. 155 StopOnDuplicateToken bool 156} 157 158// DescribeEventTypesPaginator is a paginator for DescribeEventTypes 159type DescribeEventTypesPaginator struct { 160 options DescribeEventTypesPaginatorOptions 161 client DescribeEventTypesAPIClient 162 params *DescribeEventTypesInput 163 nextToken *string 164 firstPage bool 165} 166 167// NewDescribeEventTypesPaginator returns a new DescribeEventTypesPaginator 168func NewDescribeEventTypesPaginator(client DescribeEventTypesAPIClient, params *DescribeEventTypesInput, optFns ...func(*DescribeEventTypesPaginatorOptions)) *DescribeEventTypesPaginator { 169 if params == nil { 170 params = &DescribeEventTypesInput{} 171 } 172 173 options := DescribeEventTypesPaginatorOptions{} 174 if params.MaxResults != nil { 175 options.Limit = *params.MaxResults 176 } 177 178 for _, fn := range optFns { 179 fn(&options) 180 } 181 182 return &DescribeEventTypesPaginator{ 183 options: options, 184 client: client, 185 params: params, 186 firstPage: true, 187 } 188} 189 190// HasMorePages returns a boolean indicating whether more pages are available 191func (p *DescribeEventTypesPaginator) HasMorePages() bool { 192 return p.firstPage || p.nextToken != nil 193} 194 195// NextPage retrieves the next DescribeEventTypes page. 196func (p *DescribeEventTypesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeEventTypesOutput, error) { 197 if !p.HasMorePages() { 198 return nil, fmt.Errorf("no more pages available") 199 } 200 201 params := *p.params 202 params.NextToken = p.nextToken 203 204 var limit *int32 205 if p.options.Limit > 0 { 206 limit = &p.options.Limit 207 } 208 params.MaxResults = limit 209 210 result, err := p.client.DescribeEventTypes(ctx, ¶ms, optFns...) 211 if err != nil { 212 return nil, err 213 } 214 p.firstPage = false 215 216 prevToken := p.nextToken 217 p.nextToken = result.NextToken 218 219 if p.options.StopOnDuplicateToken && prevToken != nil && p.nextToken != nil && *prevToken == *p.nextToken { 220 p.nextToken = nil 221 } 222 223 return result, nil 224} 225 226func newServiceMetadataMiddleware_opDescribeEventTypes(region string) *awsmiddleware.RegisterServiceMetadata { 227 return &awsmiddleware.RegisterServiceMetadata{ 228 Region: region, 229 ServiceID: ServiceID, 230 SigningName: "health", 231 OperationName: "DescribeEventTypes", 232 } 233} 234