ListPlatformVersions - AWS Elastic Beanstalk

ListPlatformVersions

Lists the platform versions available for your account in an AWS Region. Provides summary information about each platform version. Compare to DescribePlatformVersion, which provides full details about a single platform version.

This action only returns information about platform versions that the calling principle has IAM permissions to access. For example, consider a case where a user only has permission to access one of ten platform versions. When the user calls the ListPlatformVersions action, the response will only include the one platform version that the user has permission to access instead of all ten platform versions. If the user doesn’t have access to any of the platform versions an empty result is returned.

Note

The AWSElasticBeanstalkReadOnly managed policy allows operators to view information about resources related to Elastic Beanstalk environments. For more information, see Managing Elastic Beanstalk user policies in the AWS Elastic Beanstalk Developer Guide. For detailed instructions to attach a policy to a user or group, see the section Controlling access with managed policies in the same topic.

For definitions of platform version and other platform-related terms, see AWS Elastic Beanstalk Platforms Glossary.

Request Parameters

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

Filters.member.N

Criteria for restricting the resulting list of platform versions. The filter is interpreted as a logical conjunction (AND) of the separate PlatformFilter terms.

Type: Array of PlatformFilter objects

Required: No

MaxRecords

The maximum number of platform version values returned in one call.

Type: Integer

Valid Range: Minimum value of 1.

Required: No

NextToken

For a paginated request. Specify a token from a previous response page to retrieve the next response page. All other parameter values must be identical to the ones specified in the initial request.

If no NextToken is specified, the first page is retrieved.

Type: String

Required: No

Response Elements

The following elements are returned by the service.

NextToken

In a paginated request, if this value isn't null, it's the token that you can pass in a subsequent request to get the next response page.

Type: String

PlatformSummaryList.member.N

Summary information about the platform versions.

Type: Array of PlatformSummary objects

Errors

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

ElasticBeanstalkService

A generic service exception has occurred.

HTTP Status Code: 400

InsufficientPrivileges

The specified account does not have sufficient privileges for one or more AWS services.

HTTP Status Code: 403

See Also

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