start-deployment¶

Description¶

Starts a deployment.

Synopsis¶

  start-deployment
--application-id <value>
--environment-id <value>
--deployment-strategy-id <value>
--configuration-profile-id <value>
--configuration-version <value>
[--description <value>]
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--application-id (string)

The application ID.

--environment-id (string)

The environment ID.

--deployment-strategy-id (string)

The deployment strategy ID.

--configuration-profile-id (string)

The configuration profile ID.

--configuration-version (string)

The configuration version to deploy.

--description (string)

A description of the deployment.

--tags (map)

Metadata to assign to the deployment. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Examples¶

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To start a configuration deployment

The following start-deployment example starts a deployment to the application using the specified environment, deployment strategy, and configuration profile.

aws appconfig start-deployment \
    --application-id 339ohji \
    --environment-id 54j1r29 \
    --deployment-strategy-id 1225qzk \
    --configuration-profile-id ur8hx2f \
    --configuration-version 1

Output:

{
    "ApplicationId": "339ohji",
    "EnvironmentId": "54j1r29",
    "DeploymentStrategyId": "1225qzk",
    "ConfigurationProfileId": "ur8hx2f",
    "DeploymentNumber": 1,
    "ConfigurationName": "Example-Configuration-Profile",
    "ConfigurationLocationUri": "ssm-parameter://Example-Parameter",
    "ConfigurationVersion": "1",
    "DeploymentDurationInMinutes": 15,
    "GrowthType": "LINEAR",
    "GrowthFactor": 25.0,
    "FinalBakeTimeInMinutes": 0,
    "State": "DEPLOYING",
    "EventLog": [
        {
            "EventType": "DEPLOYMENT_STARTED",
            "TriggeredBy": "USER",
            "Description": "Deployment started",
            "OccurredAt": "2021-09-17T21:43:54.205000+00:00"
        }
    ],
    "PercentageComplete": 0.0,
    "StartedAt": "2021-09-17T21:43:54.205000+00:00"
}

For more information, see Step 5: Deploying a configuration in the AWS AppConfig User Guide.

Output¶

ApplicationId -> (string)

The ID of the application that was deployed.

EnvironmentId -> (string)

The ID of the environment that was deployed.

DeploymentStrategyId -> (string)

The ID of the deployment strategy that was deployed.

ConfigurationProfileId -> (string)

The ID of the configuration profile that was deployed.

DeploymentNumber -> (integer)

The sequence number of the deployment.

ConfigurationName -> (string)

The name of the configuration.

ConfigurationLocationUri -> (string)

Information about the source location of the configuration.

ConfigurationVersion -> (string)

The configuration version that was deployed.

Description -> (string)

The description of the deployment.

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 to receive 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.

State -> (string)

The state of the deployment.

EventLog -> (list)

A list containing all events related to a deployment. The most recent events are displayed first.

(structure)

An object that describes a deployment event.

EventType -> (string)

The type of deployment event. Deployment event types include the start, stop, or completion of a deployment; a percentage update; the start or stop of a bake period; and the start or completion of a rollback.

TriggeredBy -> (string)

The entity that triggered the deployment event. Events can be triggered by a user, AppConfig, an Amazon CloudWatch alarm, or an internal error.

Description -> (string)

A description of the deployment event. Descriptions include, but are not limited to, the user account or the Amazon CloudWatch alarm ARN that initiated a rollback, the percentage of hosts that received the deployment, or in the case of an internal error, a recommendation to attempt a new deployment.

ActionInvocations -> (list)

The list of extensions that were invoked as part of the deployment.

(structure)

An extension that was invoked as part of a deployment event.

ExtensionIdentifier -> (string)

The name, the ID, or the Amazon Resource Name (ARN) of the extension.

ActionName -> (string)

The name of the action.

Uri -> (string)

The extension URI associated to the action point in the extension definition. The URI can be an Amazon Resource Name (ARN) for one of the following: an Lambda function, an Amazon Simple Queue Service queue, an Amazon Simple Notification Service topic, or the Amazon EventBridge default event bus.

RoleArn -> (string)

An Amazon Resource Name (ARN) for an Identity and Access Management assume role.

ErrorMessage -> (string)

The error message when an extension invocation fails.

ErrorCode -> (string)

The error code when an extension invocation fails.

InvocationId -> (string)

A system-generated ID for this invocation.

OccurredAt -> (timestamp)

The date and time the event occurred.

PercentageComplete -> (float)

The percentage of targets for which the deployment is available.

StartedAt -> (timestamp)

The time the deployment started.

CompletedAt -> (timestamp)

The time the deployment completed.

AppliedExtensions -> (list)

A list of extensions that were processed as part of the deployment. The extensions that were previously associated to the configuration profile, environment, or the application when StartDeployment was called.

(structure)

An extension that was invoked during a deployment.

ExtensionId -> (string)

The system-generated ID of the extension.

ExtensionAssociationId -> (string)

The system-generated ID for the association.

VersionNumber -> (integer)

The extension version number.

Parameters -> (map)

One or more parameters for the actions called by the extension.

key -> (string)

value -> (string)

Table of Contents

Feedback

User Guide