AWS Launch Wizard

2024/05/31 - AWS Launch Wizard - 4 new 2 updated api methods

Changes  This release adds support for describing workload deployment specifications, deploying additional workload types, and managing tags for Launch Wizard resources with API operations.

GetWorkloadDeploymentPattern (new) Link ¶

Returns details for a given workload and deployment pattern, including the available specifications. You can use the ListWorkloads operation to discover the available workload names and the ListWorkloadDeploymentPatterns operation to discover the available deployment pattern names of a given workload.

See also: AWS API Documentation

Request Syntax

client.get_workload_deployment_pattern(
    deploymentPatternName='string',
    workloadName='string'
)
type deploymentPatternName

string

param deploymentPatternName

[REQUIRED]

The name of the deployment pattern.

type workloadName

string

param workloadName

[REQUIRED]

The name of the workload.

rtype

dict

returns

Response Syntax

{
    'workloadDeploymentPattern': {
        'deploymentPatternName': 'string',
        'description': 'string',
        'displayName': 'string',
        'specifications': [
            {
                'allowedValues': [
                    'string',
                ],
                'conditionals': [
                    {
                        'comparator': 'string',
                        'name': 'string',
                        'value': 'string'
                    },
                ],
                'description': 'string',
                'name': 'string',
                'required': 'string'
            },
        ],
        'status': 'ACTIVE'|'INACTIVE'|'DISABLED'|'DELETED',
        'statusMessage': 'string',
        'workloadName': 'string',
        'workloadVersionName': 'string'
    }
}

Response Structure

  • (dict) --

    • workloadDeploymentPattern (dict) --

      Details about the workload deployment pattern.

      • deploymentPatternName (string) --

        The name of the deployment pattern.

      • description (string) --

        The description of the deployment pattern.

      • displayName (string) --

        The display name of the deployment pattern.

      • specifications (list) --

        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.

        • (dict) --

          A field that details a specification of a deployment pattern.

          • allowedValues (list) --

            The allowed values of the deployment specification.

            • (string) --

          • conditionals (list) --

            The conditionals used for the deployment specification.

            • (dict) --

              A field that details a condition of the specifications for a deployment.

              • comparator (string) --

                The comparator of the condition.

                Valid values: Equal | NotEqual

              • name (string) --

                The name of the deployment condition.

              • value (string) --

                The value of the condition.

          • description (string) --

            The description of the deployment specification.

          • name (string) --

            The name of the deployment specification.

          • required (string) --

            Indicates if the deployment specification is required.

      • status (string) --

        The status of the deployment pattern.

      • statusMessage (string) --

        The status message of the deployment pattern.

      • workloadName (string) --

        The workload name of the deployment pattern.

      • workloadVersionName (string) --

        The workload version name of the deployment pattern.

UntagResource (new) Link ¶

Removes the specified tags from the given resource.

See also: AWS API Documentation

Request Syntax

client.untag_resource(
    resourceArn='string',
    tagKeys=[
        'string',
    ]
)
type resourceArn

string

param resourceArn

[REQUIRED]

The Amazon Resource Name (ARN) of the resource.

type tagKeys

list

param tagKeys

[REQUIRED]

Keys identifying the tags to remove.

  • (string) --

rtype

dict

returns

Response Syntax

{}

Response Structure

  • (dict) --

TagResource (new) Link ¶

Adds the specified tags to the given resource.

See also: AWS API Documentation

Request Syntax

client.tag_resource(
    resourceArn='string',
    tags={
        'string': 'string'
    }
)
type resourceArn

string

param resourceArn

[REQUIRED]

The Amazon Resource Name (ARN) of the resource.

type tags

dict

param tags

[REQUIRED]

One or more tags to attach to the resource.

  • (string) --

    • (string) --

rtype

dict

returns

Response Syntax

{}

Response Structure

  • (dict) --

ListTagsForResource (new) Link ¶

Lists the tags associated with a specified resource.

See also: AWS API Documentation

Request Syntax

client.list_tags_for_resource(
    resourceArn='string'
)
type resourceArn

string

param resourceArn

[REQUIRED]

The Amazon Resource Name (ARN) of the resource.

rtype

dict

returns

Response Syntax

{
    'tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --

    • tags (dict) --

      Information about the tags.

      • (string) --

        • (string) --

CreateDeployment (updated) Link ¶
Changes (request)
{'tags': {'string': 'string'}}

Creates a deployment for the given workload. Deployments created by this operation are not available in the Launch Wizard console to use the Clone deployment action on.

See also: AWS API Documentation

Request Syntax

client.create_deployment(
    deploymentPatternName='string',
    dryRun=True|False,
    name='string',
    specifications={
        'string': 'string'
    },
    tags={
        'string': 'string'
    },
    workloadName='string'
)
type deploymentPatternName

string

param deploymentPatternName

[REQUIRED]

The name of the deployment pattern supported by a given workload. You can use the ListWorkloadDeploymentPatterns operation to discover supported values for this parameter.

type dryRun

boolean

param dryRun

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation . Otherwise, it is UnauthorizedOperation .

type name

string

param name

[REQUIRED]

The name of the deployment.

type specifications

dict

param specifications

[REQUIRED]

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) --

type tags

dict

param tags

The tags to add to the deployment.

  • (string) --

    • (string) --

type workloadName

string

param workloadName

[REQUIRED]

The name of the workload. You can use the ListWorkloads operation to discover supported values for this parameter.

rtype

dict

returns

Response Syntax

{
    'deploymentId': 'string'
}

Response Structure

  • (dict) --

    • deploymentId (string) --

      The ID of the deployment.

GetDeployment (updated) Link ¶
Changes (response)
{'deployment': {'deploymentArn': 'string', 'tags': {'string': 'string'}}}

Returns information about the deployment.

See also: AWS API Documentation

Request Syntax

client.get_deployment(
    deploymentId='string'
)
type deploymentId

string

param deploymentId

[REQUIRED]

The ID of the deployment.

rtype

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.