View a markdown version of this page

DescribeServiceLifecycle - AWS Health

DescribeServiceLifecycle

Returns lifecycle information for AWS services, including end-of-life dates, version recommendations, and lifecycle events.

Request Syntax

{ "filter": { "service": "string" }, "maxResults": number, "nextToken": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

filter

Values to narrow the results returned.

Type: ServiceLifecycleFilter object

Required: No

maxResults

The maximum number of items to return in one batch, between 1 and 20, inclusive.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 20.

Required: No

nextToken

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.

Type: String

Length Constraints: Minimum length of 4. Maximum length of 10000.

Pattern: [a-zA-Z0-9=/+_.-]{4,10000}

Required: No

Response Syntax

{ "nextToken": "string", "serviceLifecycles": [ { "lifecycleEvents": [ { "date": number, "description": "string", "impactRisks": [ "string" ], "lifecycleEventType": "string", "regions": [ "string" ] } ], "recommendedVersion": "string", "service": "string", "title": "string", "version": "string" } ] }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

nextToken

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.

Type: String

Length Constraints: Minimum length of 4. Maximum length of 10000.

Pattern: [a-zA-Z0-9=/+_.-]{4,10000}

serviceLifecycles

The list of service lifecycle entries matching the filter criteria.

Type: Array of ServiceLifecycle objects

Errors

For information about the errors that are common to all actions, see Common Error Types.

InvalidPaginationToken

The specified pagination token (nextToken) is not valid.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: