ElasticBeanstalk / Client / delete_platform_version

delete_platform_version#

ElasticBeanstalk.Client.delete_platform_version(**kwargs)#

Deletes the specified version of a custom platform.

See also: AWS API Documentation

Request Syntax

response = client.delete_platform_version(
    PlatformArn='string'
)
Parameters:

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

Return type:

dict

Returns:

Response Syntax

{
    'PlatformSummary': {
        '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'
    }
}

Response Structure

  • (dict) –

    • PlatformSummary (dict) –

      Detailed information about the version of the custom platform.

      • 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

Exceptions