ElasticBeanstalk / Client / describe_platform_version

describe_platform_version#

ElasticBeanstalk.Client.describe_platform_version(**kwargs)#

Describes a platform version. Provides full details. Compare to ListPlatformVersions, which provides summary information about a list of platform versions.

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.describe_platform_version(
    PlatformArn='string'
)
Parameters:

PlatformArn (string) – The ARN of the platform version.

Return type:

dict

Returns:

Response Syntax

{
    'PlatformDescription': {
        'PlatformArn': 'string',
        'PlatformOwner': 'string',
        'PlatformName': 'string',
        'PlatformVersion': 'string',
        'SolutionStackName': 'string',
        'PlatformStatus': 'Creating'|'Failed'|'Ready'|'Deleting'|'Deleted',
        'DateCreated': datetime(2015, 1, 1),
        'DateUpdated': datetime(2015, 1, 1),
        'PlatformCategory': 'string',
        'Description': 'string',
        'Maintainer': 'string',
        'OperatingSystemName': 'string',
        'OperatingSystemVersion': 'string',
        'ProgrammingLanguages': [
            {
                'Name': 'string',
                'Version': 'string'
            },
        ],
        'Frameworks': [
            {
                'Name': 'string',
                'Version': 'string'
            },
        ],
        'CustomAmiList': [
            {
                'VirtualizationType': 'string',
                'ImageId': 'string'
            },
        ],
        'SupportedTierList': [
            'string',
        ],
        'SupportedAddonList': [
            'string',
        ],
        'PlatformLifecycleState': 'string',
        'PlatformBranchName': 'string',
        'PlatformBranchLifecycleState': 'string'
    }
}

Response Structure

  • (dict) –

    • PlatformDescription (dict) –

      Detailed information about the platform version.

      • PlatformArn (string) –

        The ARN of the platform version.

      • PlatformOwner (string) –

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

      • PlatformName (string) –

        The name of the platform version.

      • PlatformVersion (string) –

        The version of the platform version.

      • SolutionStackName (string) –

        The name of the solution stack used by the platform version.

      • PlatformStatus (string) –

        The status of the platform version.

      • DateCreated (datetime) –

        The date when the platform version was created.

      • DateUpdated (datetime) –

        The date when the platform version was last updated.

      • PlatformCategory (string) –

        The category of the platform version.

      • Description (string) –

        The description of the platform version.

      • Maintainer (string) –

        Information about the maintainer of the 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.

      • ProgrammingLanguages (list) –

        The programming languages supported by the platform version.

        • (dict) –

          A programming language supported by the platform.

          • Name (string) –

            The name of the programming language.

          • Version (string) –

            The version of the programming language.

      • Frameworks (list) –

        The frameworks supported by the platform version.

        • (dict) –

          A framework supported by the platform.

          • Name (string) –

            The name of the framework.

          • Version (string) –

            The version of the framework.

      • CustomAmiList (list) –

        The custom AMIs supported by the platform version.

        • (dict) –

          A custom AMI available to platforms.

          • VirtualizationType (string) –

            The type of virtualization used to create the custom AMI.

          • ImageId (string) –

            THe ID of the image used to create the custom AMI.

      • SupportedTierList (list) –

        The tiers supported by the platform version.

        • (string) –

      • SupportedAddonList (list) –

        The additions supported by the platform version.

        • (string) –

      • PlatformLifecycleState (string) –

        The state of the platform version in its lifecycle.

        Possible values: Recommended | null

        If a null value is returned, the platform version isn’t the recommended one for its branch. Each platform branch has a single recommended platform version, typically the most recent one.

      • 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

Exceptions

  • ElasticBeanstalk.Client.exceptions.InsufficientPrivilegesException

  • ElasticBeanstalk.Client.exceptions.ElasticBeanstalkServiceException