LaunchWizard / Client / get_deployment

get_deployment

LaunchWizard.Client.get_deployment(**kwargs)

Returns information about the deployment.

See also: AWS API Documentation

Request Syntax

response = client.get_deployment(
    deploymentId='string'
)
Parameters:

deploymentId (string) –

[REQUIRED]

The ID of the deployment.

Return type:

dict

Returns:

Response Syntax

{
    'deployment': {
        'createdAt': datetime(2015, 1, 1),
        'deletedAt': datetime(2015, 1, 1),
        'deploymentArn': 'string',
        'id': 'string',
        'name': 'string',
        'patternName': 'string',
        'resourceGroup': 'string',
        'specifications': {
            'string': 'string'
        },
        'status': 'COMPLETED'|'CREATING'|'DELETE_IN_PROGRESS'|'DELETE_INITIATING'|'DELETE_FAILED'|'DELETED'|'FAILED'|'IN_PROGRESS'|'VALIDATING',
        'tags': {
            'string': 'string'
        },
        'workloadName': 'string'
    }
}

Response Structure

  • (dict) –

    • deployment (dict) –

      An object that details the deployment.

      • createdAt (datetime) –

        The time the deployment was created.

      • deletedAt (datetime) –

        The time the deployment was deleted.

      • deploymentArn (string) –

        The Amazon Resource Name (ARN) of the deployment.

      • id (string) –

        The ID of the deployment.

      • name (string) –

        The name of the deployment.

      • patternName (string) –

        The pattern name of the deployment.

      • resourceGroup (string) –

        The resource group of the deployment.

      • specifications (dict) –

        The settings specified for the deployment. These settings define how to deploy and configure your resources created by the deployment. For more information about the specifications required for creating a deployment for a SAP workload, see SAP deployment specifications. To retrieve the specifications required to create a deployment for other workloads, use the GetWorkloadDeploymentPattern operation.

        • (string) –

          • (string) –

      • status (string) –

        The status of the deployment.

      • tags (dict) –

        Information about the tags attached to a deployment.

        • (string) –

          • (string) –

      • workloadName (string) –

        The name of the workload.

Exceptions