ElasticBeanstalk / Client / list_platform_versions

list_platform_versions#

ElasticBeanstalk.Client.list_platform_versions(**kwargs)#

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.

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

See also: AWS API Documentation

Request Syntax

response = client.list_platform_versions(
    Filters=[
        {
            'Type': 'string',
            'Operator': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxRecords=123,
    NextToken='string'
)
Parameters:

  • Filters (list) –

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

    • (dict) –

      Describes criteria to restrict the results when listing platform versions.

      The filter is evaluated as follows: Type Operator Values[1]

      • Type (string) –

        The platform version attribute to which the filter values are applied.

        Valid values: PlatformName | PlatformVersion | PlatformStatus | PlatformBranchName | PlatformLifecycleState | PlatformOwner | SupportedTier | SupportedAddon | ProgrammingLanguageName | OperatingSystemName

      • Operator (string) –

        The operator to apply to the Type with each of the Values.

        Valid values: = | != | < | <= | > | >= | contains | begins_with | ends_with

      • Values (list) –

        The list of values applied to the filtering platform version attribute. Only one value is supported for all current operators.

        The following list shows valid filter values for some filter attributes.

        • PlatformStatus: Creating | Failed | Ready | Deleting | Deleted

        • PlatformLifecycleState: recommended

        • SupportedTier: WebServer/Standard | Worker/SQS/HTTP

        • SupportedAddon: Log/S3 | Monitoring/Healthd | WorkerDaemon/SQSD

        • (string) –

  • MaxRecords (integer) – The maximum number of platform version values returned in one call.

  • NextToken (string) –

    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.

Return type:

dict

Returns:

Response Syntax

{
    'PlatformSummaryList': [
        {
            'PlatformArn': 'string',
            'PlatformOwner': 'string',
            'PlatformStatus': 'Creating'|'Failed'|'Ready'|'Deleting'|'Deleted',
            'PlatformCategory': 'string',
            'OperatingSystemName': 'string',
            'OperatingSystemVersion': 'string',
            'SupportedTierList': [
                'string',
            ],
            'SupportedAddonList': [
                'string',
            ],
            'PlatformLifecycleState': 'string',
            'PlatformVersion': 'string',
            'PlatformBranchName': 'string',
            'PlatformBranchLifecycleState': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • PlatformSummaryList (list) –

      Summary information about the platform versions.

      • (dict) –

        Summary information about a platform version.

        • PlatformArn (string) –

          The ARN of the platform version.

        • PlatformOwner (string) –

          The AWS account ID of the person who created the platform version.

        • PlatformStatus (string) –

          The status of the platform version. You can create an environment from the platform version once it is ready.

        • PlatformCategory (string) –

          The category of platform version.

        • OperatingSystemName (string) –

          The operating system used by the platform version.

        • OperatingSystemVersion (string) –

          The version of the operating system used by the platform version.

        • SupportedTierList (list) –

          The tiers in which the platform version runs.

          • (string) –

        • SupportedAddonList (list) –

          The additions associated with the platform version.

          • (string) –

        • PlatformLifecycleState (string) –

          The state of the platform version in its lifecycle.

          Possible values: recommended | empty

          If an empty value is returned, the platform version is supported but isn’t the recommended one for its branch.

        • PlatformVersion (string) –

          The version string of the platform version.

        • PlatformBranchName (string) –

          The platform branch to which the platform version belongs.

        • PlatformBranchLifecycleState (string) –

          The state of the platform version’s branch in its lifecycle.

          Possible values: beta | supported | deprecated | retired

    • NextToken (string) –

      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.

Exceptions