OpsWorks / Client / describe_deployments

describe_deployments

OpsWorks.Client.describe_deployments(**kwargs)

Requests a description of a specified set of deployments.

Note

This call accepts only one resource-identifying parameter.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.

See also: AWS API Documentation

Request Syntax

response = client.describe_deployments(
    StackId='string',
    AppId='string',
    DeploymentIds=[
        'string',
    ]
)

Parameters:

• StackId (string) – The stack ID. If you include this parameter, the command returns a description of the commands associated with the specified stack.

• AppId (string) – The app ID. If you include this parameter, the command returns a description of the commands associated with the specified app.

• DeploymentIds (list) –

  An array of deployment IDs to be described. If you include this parameter, the command returns a description of the specified deployments. Otherwise, it returns a description of every deployment.

  • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'Deployments': [
        {
            'DeploymentId': 'string',
            'StackId': 'string',
            'AppId': 'string',
            'CreatedAt': 'string',
            'CompletedAt': 'string',
            'Duration': 123,
            'IamUserArn': 'string',
            'Comment': 'string',
            'Command': {
                'Name': 'install_dependencies'|'update_dependencies'|'update_custom_cookbooks'|'execute_recipes'|'configure'|'setup'|'deploy'|'rollback'|'start'|'stop'|'restart'|'undeploy',
                'Args': {
                    'string': [
                        'string',
                    ]
                }
            },
            'Status': 'string',
            'CustomJson': 'string',
            'InstanceIds': [
                'string',
            ]
        },
    ]
}

Response Structure

• (dict) –

  Contains the response to a DescribeDeployments request.

  • Deployments (list) –

    An array of Deployment objects that describe the deployments.

    • (dict) –

      Describes a deployment of a stack or app.

      • DeploymentId (string) –

        The deployment ID.

      • StackId (string) –

        The stack ID.

      • AppId (string) –

        The app ID.

      • CreatedAt (string) –

        Date when the deployment was created.

      • CompletedAt (string) –

        Date when the deployment completed.

      • Duration (integer) –

        The deployment duration.

      • IamUserArn (string) –

        The user’s IAM ARN.

      • Comment (string) –

        A user-defined comment.

      • Command (dict) –

        Used to specify a stack or deployment command.

        • Name (string) –

          Specifies the operation. You can specify only one command.

          For stacks, the following commands are available:

          • execute_recipes: Execute one or more recipes. To specify the recipes, set an Args parameter named recipes to the list of recipes to be executed. For example, to execute phpapp::appsetup, set Args to {"recipes":["phpapp::appsetup"]}.

          • install_dependencies: Install the stack’s dependencies.

          • update_custom_cookbooks: Update the stack’s custom cookbooks.

          • update_dependencies: Update the stack’s dependencies.

          Note

          The update_dependencies and install_dependencies commands are supported only for Linux instances. You can run the commands successfully on Windows instances, but they do nothing.

          For apps, the following commands are available:

          • deploy: Deploy an app. Ruby on Rails apps have an optional Args parameter named migrate. Set Args to {“migrate”:[“true”]} to migrate the database. The default setting is {“migrate”:[“false”]}.

          • rollback Roll the app back to the previous version. When you update an app, OpsWorks Stacks stores the previous version, up to a maximum of five versions. You can use this command to roll an app back as many as four versions.

          • start: Start the app’s web or application server.

          • stop: Stop the app’s web or application server.

          • restart: Restart the app’s web or application server.

          • undeploy: Undeploy the app.

        • Args (dict) –

          The arguments of those commands that take arguments. It should be set to a JSON object with the following format:

          {"arg_name1" : ["value1", "value2", ...], "arg_name2" : ["value1", "value2", ...], ...}

          The update_dependencies command takes two arguments:

          • upgrade_os_to - Specifies the Amazon Linux version that you want instances to run, such as Amazon Linux 2. You must also set the allow_reboot argument to true.

          • allow_reboot - Specifies whether to allow OpsWorks Stacks to reboot the instances if necessary, after installing the updates. This argument can be set to either true or false. The default value is false.

          For example, to upgrade an instance to Amazon Linux 2018.03, set Args to the following.

          { "upgrade_os_to":["Amazon Linux 2018.03"], "allow_reboot":["true"] }

          • (string) –

            • (list) –

              • (string) –

      • Status (string) –

        The deployment status:

        • running

        • successful

        • failed

      • CustomJson (string) –

        A string that contains user-defined custom JSON. It can be used to override the corresponding default stack configuration attribute values for stack or to pass data to recipes. The string should be in the following format:

        "{\"key1\": \"value1\", \"key2\": \"value2\",...}"

        For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes.

      • InstanceIds (list) –

        The IDs of the target instances.

        • (string) –

Exceptions

• OpsWorks.Client.exceptions.ValidationException

• OpsWorks.Client.exceptions.ResourceNotFoundException