AWS Launch Wizard

2026/08/24 - AWS Launch Wizard - 5 updated api methods

Changes  Added accountConstraints and patternType to GetWorkload, ListWorkloads, GetWorkloadDeploymentPattern and ListWorkloadDeploymentPatterns for Launch Wizard

GetWorkload (updated) Link ¶
Changes (response) 
{'workload': {'accountConstraints': [{'delegatedAdmin': {'servicePrincipal': 'string'},
                                      'managementAccount': {}}]}}

Returns information about a workload.

See also: AWS API Documentation

Request Syntax

client.get_workload(
    workloadName='string'
)
type workloadName:

string

param workloadName:

[REQUIRED]

The name of the workload.

rtype:

dict

returns:

Response Syntax

{
    'workload': {
        'workloadName': 'string',
        'displayName': 'string',
        'status': 'ACTIVE'|'INACTIVE'|'DISABLED'|'DELETED',
        'accountConstraints': [
            {
                'managementAccount': {},
                'delegatedAdmin': {
                    'servicePrincipal': 'string'
                }
            },
        ],
        'description': 'string',
        'documentationUrl': 'string',
        'iconUrl': 'string',
        'statusMessage': 'string'
    }
}

Response Structure

  • (dict) --

    • workload (dict) --

      Information about the workload.

      • workloadName (string) --

        The name of the workload.

      • displayName (string) --

        The display name of a workload.

      • status (string) --

        The status of a workload.

        You can list deployments in the DISABLED status.

      • accountConstraints (list) --

        Optional list of constraints describing what kind of AWS account is allowed to deploy this workload or deployment pattern. Within a single list the semantics are OR: an account satisfies the list if it satisfies any entry. Workload-level and pattern-level lists combine with AND at deployment time. An absent or empty list at this level means no constraint at this level.

        • (dict) --

          A constraint on which AWS account a deployment can be initiated from. Specify one of the supported constraint types.

          • managementAccount (dict) --

            The deployment must be initiated from the AWS Organizations management account.

          • delegatedAdmin (dict) --

            The deployment must be initiated from a delegated administrator account for the specified service principal.

            • servicePrincipal (string) --

              The service principal for which the account must be a delegated administrator. For example, stacksets.cloudformation.amazonaws.com.

      • description (string) --

        The description of a workload.

      • documentationUrl (string) --

        The URL of a workload document.

      • iconUrl (string) --

        The URL of a workload icon.

      • statusMessage (string) --

        The message about a workload's status.

GetWorkloadDeploymentPattern (updated) Link ¶
Changes (response) 
{'workloadDeploymentPattern': {'accountConstraints': [{'delegatedAdmin': {'servicePrincipal': 'string'},
                                                       'managementAccount': {}}]}}

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(
    workloadName='string',
    deploymentPatternName='string'
)
type workloadName:

string

param workloadName:

[REQUIRED]

The name of the workload.

type deploymentPatternName:

string

param deploymentPatternName:

[REQUIRED]

The name of the deployment pattern.

rtype:

dict

returns:

Response Syntax

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

Response Structure

  • (dict) --

    • workloadDeploymentPattern (dict) --

      Details about the workload deployment pattern.

      • workloadName (string) --

        The workload name of the deployment pattern.

      • deploymentPatternName (string) --

        The name of the deployment pattern.

      • workloadVersionName (string) --

        The workload version name of the deployment pattern.

      • deploymentPatternVersionName (string) --

        The version name of the deployment pattern.

      • displayName (string) --

        The display name of the deployment pattern.

      • description (string) --

        The description of the deployment pattern.

      • status (string) --

        The status of the deployment pattern.

      • statusMessage (string) --

        The status message of the deployment pattern.

      • accountConstraints (list) --

        Optional list of constraints describing what kind of AWS account is allowed to deploy this workload or deployment pattern. Within a single list the semantics are OR: an account satisfies the list if it satisfies any entry. Workload-level and pattern-level lists combine with AND at deployment time. An absent or empty list at this level means no constraint at this level.

        • (dict) --

          A constraint on which AWS account a deployment can be initiated from. Specify one of the supported constraint types.

          • managementAccount (dict) --

            The deployment must be initiated from the AWS Organizations management account.

          • delegatedAdmin (dict) --

            The deployment must be initiated from a delegated administrator account for the specified service principal.

            • servicePrincipal (string) --

              The service principal for which the account must be a delegated administrator. For example, stacksets.cloudformation.amazonaws.com.

      • 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.

          • name (string) --

            The name of the deployment specification.

          • description (string) --

            The description of the deployment specification.

          • allowedValues (list) --

            The allowed values of the deployment specification.

            • (string) --

          • required (string) --

            Indicates if the deployment specification is required.

          • conditionals (list) --

            The conditionals used for the deployment specification.

            • (dict) --

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

              • name (string) --

                The name of the deployment condition.

              • value (string) --

                The value of the condition.

              • comparator (string) --

                The comparator of the condition.

                Valid values: Equal | NotEqual

ListDeploymentEvents (updated) Link ¶
Changes (response) 
{'deploymentEvents': {'metadata': {'string': 'string'}}}

Lists the events of a deployment.

See also: AWS API Documentation

Request Syntax

client.list_deployment_events(
    deploymentId='string',
    maxResults=123,
    nextToken='string'
)
type deploymentId:

string

param deploymentId:

[REQUIRED]

The ID of the deployment.

type maxResults:

integer

param maxResults:

The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output.

type nextToken:

string

param nextToken:

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

rtype:

dict

returns:

Response Syntax

{
    'deploymentEvents': [
        {
            'name': 'string',
            'description': 'string',
            'status': 'CANCELED'|'CANCELING'|'COMPLETED'|'CREATED'|'FAILED'|'IN_PROGRESS'|'PENDING'|'TIMED_OUT',
            'statusReason': 'string',
            'timestamp': datetime(2015, 1, 1),
            'metadata': {
                'string': 'string'
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • deploymentEvents (list) --

      Lists the deployment events.

      • (dict) --

        A summary of the deployment event data.

        • name (string) --

          The name of the deployment event.

        • description (string) --

          The description of the deployment event.

        • status (string) --

          The status of the deployment event.

        • statusReason (string) --

          The reason of the deployment event status.

        • timestamp (datetime) --

          The timestamp of the deployment event.

        • metadata (dict) --

          A map of metadata key-value pairs associated with a deployment event. For error detection events, contains workload context and log excerpts used for troubleshooting.

          • (string) --

            • (string) --

    • nextToken (string) --

      The token to include in another request to get the next page of items. This value is null when there are no more items to return.

ListWorkloadDeploymentPatterns (updated) Link ¶
Changes (response) 
{'workloadDeploymentPatterns': {'accountConstraints': [{'delegatedAdmin': {'servicePrincipal': 'string'},
                                                        'managementAccount': {}}]}}

Lists the workload deployment patterns for a given workload name. You can use the ListWorkloads operation to discover the available workload names.

See also: AWS API Documentation

Request Syntax

client.list_workload_deployment_patterns(
    workloadName='string',
    maxResults=123,
    nextToken='string'
)
type workloadName:

string

param workloadName:

[REQUIRED]

The name of the workload.

type maxResults:

integer

param maxResults:

The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output.

type nextToken:

string

param nextToken:

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

rtype:

dict

returns:

Response Syntax

{
    'workloadDeploymentPatterns': [
        {
            'workloadName': 'string',
            'deploymentPatternName': 'string',
            'workloadVersionName': 'string',
            'deploymentPatternVersionName': 'string',
            'displayName': 'string',
            'description': 'string',
            'status': 'ACTIVE'|'INACTIVE'|'DISABLED'|'DELETED',
            'statusMessage': 'string',
            'accountConstraints': [
                {
                    'managementAccount': {},
                    'delegatedAdmin': {
                        'servicePrincipal': 'string'
                    }
                },
            ]
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • workloadDeploymentPatterns (list) --

      Describes the workload deployment patterns.

      • (dict) --

        Describes a workload deployment pattern.

        • workloadName (string) --

          The name of the workload.

        • deploymentPatternName (string) --

          The name of a workload deployment pattern.

        • workloadVersionName (string) --

          The name of the workload deployment pattern version.

        • deploymentPatternVersionName (string) --

          The version name of a workload deployment pattern.

        • displayName (string) --

          The display name of a workload deployment pattern.

        • description (string) --

          The description of a workload deployment pattern.

        • status (string) --

          The status of a workload deployment pattern.

        • statusMessage (string) --

          A message about a workload deployment pattern's status.

        • accountConstraints (list) --

          Optional list of constraints describing what kind of AWS account is allowed to deploy this workload or deployment pattern. Within a single list the semantics are OR: an account satisfies the list if it satisfies any entry. Workload-level and pattern-level lists combine with AND at deployment time. An absent or empty list at this level means no constraint at this level.

          • (dict) --

            A constraint on which AWS account a deployment can be initiated from. Specify one of the supported constraint types.

            • managementAccount (dict) --

              The deployment must be initiated from the AWS Organizations management account.

            • delegatedAdmin (dict) --

              The deployment must be initiated from a delegated administrator account for the specified service principal.

              • servicePrincipal (string) --

                The service principal for which the account must be a delegated administrator. For example, stacksets.cloudformation.amazonaws.com.

    • nextToken (string) --

      The token to include in another request to get the next page of items. This value is null when there are no more items to return.

ListWorkloads (updated) Link ¶
Changes (response) 
{'workloads': {'accountConstraints': [{'delegatedAdmin': {'servicePrincipal': 'string'},
                                       'managementAccount': {}}]}}

Lists the available workload names. You can use the ListWorkloadDeploymentPatterns operation to discover the available deployment patterns for a given workload.

See also: AWS API Documentation

Request Syntax

client.list_workloads(
    maxResults=123,
    nextToken='string'
)
type maxResults:

integer

param maxResults:

The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output.

type nextToken:

string

param nextToken:

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

rtype:

dict

returns:

Response Syntax

{
    'workloads': [
        {
            'workloadName': 'string',
            'displayName': 'string',
            'status': 'ACTIVE'|'INACTIVE'|'DISABLED'|'DELETED',
            'accountConstraints': [
                {
                    'managementAccount': {},
                    'delegatedAdmin': {
                        'servicePrincipal': 'string'
                    }
                },
            ]
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • workloads (list) --

      Information about the workloads.

      • (dict) --

        Describes workload data.

        • workloadName (string) --

          The name of the workload.

        • displayName (string) --

          The display name of the workload data.

        • status (string) --

          The status of the workload.

        • accountConstraints (list) --

          Optional list of constraints describing what kind of AWS account is allowed to deploy this workload or deployment pattern. Within a single list the semantics are OR: an account satisfies the list if it satisfies any entry. Workload-level and pattern-level lists combine with AND at deployment time. An absent or empty list at this level means no constraint at this level.

          • (dict) --

            A constraint on which AWS account a deployment can be initiated from. Specify one of the supported constraint types.

            • managementAccount (dict) --

              The deployment must be initiated from the AWS Organizations management account.

            • delegatedAdmin (dict) --

              The deployment must be initiated from a delegated administrator account for the specified service principal.

              • servicePrincipal (string) --

                The service principal for which the account must be a delegated administrator. For example, stacksets.cloudformation.amazonaws.com.

    • nextToken (string) --

      The token to include in another request to get the next page of items. This value is null when there are no more items to return.