get_deployment_strategy

get_deployment_strategy(**kwargs)

Retrieves information about a deployment strategy. A deployment strategy defines important criteria for rolling out your configuration to the designated targets. A deployment strategy includes the overall duration required, a percentage of targets to receive the deployment during each interval, an algorithm that defines how percentage grows, and bake time.

See also: AWS API Documentation

Request Syntax

response = client.get_deployment_strategy(
    DeploymentStrategyId='string'
)

Parameters

DeploymentStrategyId (string) --

[REQUIRED]

The ID of the deployment strategy to get.

Return type

dict

Returns

Response Syntax

{
    'Id': 'string',
    'Name': 'string',
    'Description': 'string',
    'DeploymentDurationInMinutes': 123,
    'GrowthType': 'LINEAR'|'EXPONENTIAL',
    'GrowthFactor': ...,
    'FinalBakeTimeInMinutes': 123,
    'ReplicateTo': 'NONE'|'SSM_DOCUMENT'
}

Response Structure

• (dict) --
  • Id (string) --

    The deployment strategy ID.

  • Name (string) --

    The name of the deployment strategy.

  • Description (string) --

    The description of the deployment strategy.

  • DeploymentDurationInMinutes (integer) --

    Total amount of time the deployment lasted.

  • GrowthType (string) --

    The algorithm used to define how percentage grew over time.

  • GrowthFactor (float) --

    The percentage of targets that received a deployed configuration during each interval.

  • FinalBakeTimeInMinutes (integer) --

    The amount of time that AppConfig monitored for alarms before considering the deployment to be complete and no longer eligible for automatic rollback.

  • ReplicateTo (string) --

    Save the deployment strategy to a Systems Manager (SSM) document.

Exceptions

• AppConfig.Client.exceptions.ResourceNotFoundException
• AppConfig.Client.exceptions.InternalServerException
• AppConfig.Client.exceptions.BadRequestException

Examples

The following get-deployment-strategy example lists the details of the specified deployment strategy.

response = client.get_deployment_strategy(
    DeploymentStrategyId='1225qzk',
)

print(response)

Expected Output:

{
    'DeploymentDurationInMinutes': 15,
    'FinalBakeTimeInMinutes': 0,
    'GrowthFactor': 25,
    'GrowthType': 'LINEAR',
    'Id': '1225qzk',
    'Name': 'Example-Deployment',
    'ReplicateTo': 'SSM_DOCUMENT',
    'ResponseMetadata': {
        '...': '...',
    },
}