AWS API Changes

2026/01/16 - AWS Launch Wizard - 3 new6 updated api methods

Changes Added UpdateDeployment, ListDeploymentPatternVersions and GetDeploymentPatternVersion APIs for Launch Wizard

GetDeploymentPatternVersion (new)

Link ¶

Returns information about a deployment pattern version.

Request Syntax

client.get_deployment_pattern_version(
    workloadName='string',
    deploymentPatternName='string',
    deploymentPatternVersionName='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.

type deploymentPatternName:

string

param deploymentPatternName:

[REQUIRED]

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

type deploymentPatternVersionName:

string

param deploymentPatternVersionName:

[REQUIRED]

The name of the deployment pattern version.

rtype:

dict

returns:

Response Syntax

{
    'deploymentPatternVersion': {
        'deploymentPatternVersionName': 'string',
        'description': 'string',
        'documentationUrl': 'string',
        'workloadName': 'string',
        'deploymentPatternName': 'string'
    }
}

Response Structure

(dict) --
- deploymentPatternVersion (dict) --
  
  The deployment pattern version.
  - deploymentPatternVersionName (string) --
    
    The name of the deployment pattern version.
  - description (string) --
    
    The description of the deployment pattern version.
  - documentationUrl (string) --
    
    The URL of the documentation for the deployment pattern version.
  - workloadName (string) --
    
    The name of the workload.
  - deploymentPatternName (string) --
    
    The name of the deployment pattern.

UpdateDeployment (new)

Link ¶

Updates a deployment.

See also: AWS API Documentation

Request Syntax

client.update_deployment(
    deploymentId='string',
    specifications={
        'string': 'string'
    },
    workloadVersionName='string',
    deploymentPatternVersionName='string',
    dryRun=True|False,
    force=True|False
)

type deploymentId:

string

param deploymentId:

[REQUIRED]

The ID 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 workloadVersionName:

string

param workloadVersionName:

The name of the workload version.

type deploymentPatternVersionName:

string

param deploymentPatternVersionName:

The name of the deployment pattern version.

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 force:

boolean

param force:

Forces the update even if validation warnings are present.

rtype:

dict

returns:

Response Syntax

{
    'deployment': {
        'name': 'string',
        'id': 'string',
        'workloadName': 'string',
        'patternName': 'string',
        'status': 'COMPLETED'|'CREATING'|'DELETE_IN_PROGRESS'|'DELETE_INITIATING'|'DELETE_FAILED'|'DELETED'|'FAILED'|'IN_PROGRESS'|'VALIDATING'|'UPDATE_IN_PROGRESS'|'UPDATE_COMPLETED'|'UPDATE_FAILED'|'UPDATE_ROLLBACK_COMPLETED'|'UPDATE_ROLLBACK_FAILED',
        'createdAt': datetime(2015, 1, 1),
        'modifiedAt': datetime(2015, 1, 1)
    }
}

Response Structure

(dict) --
- deployment (dict) --
  
  The deployment.
  - name (string) --
    
    The name of the deployment
  - id (string) --
    
    The ID of the deployment.
  - workloadName (string) --
    
    The name of the workload.
  - patternName (string) --
    
    The name of the workload deployment pattern.
  - status (string) --
    
    The status of the deployment.
  - createdAt (datetime) --
    
    The time the deployment was created.
  - modifiedAt (datetime) --
    
    The time the deployment was last modified.

ListDeploymentPatternVersions (new)

Link ¶

Lists the deployment pattern versions.

See also: AWS API Documentation

Request Syntax

client.list_deployment_pattern_versions(
    workloadName='string',
    deploymentPatternName='string',
    maxResults=123,
    nextToken='string',
    filters=[
        {
            'name': 'updateFromVersion',
            'values': [
                '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.

type deploymentPatternName:

string

param deploymentPatternName:

[REQUIRED]

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

type maxResults:

integer

param maxResults:

The maximum number of deployment pattern versions to list.

type nextToken:

string

param nextToken:

The token for the next set of results.

type filters:

list

param filters:

Filters to apply when listing deployment pattern versions.

(dict) --

A filter for deployment pattern versions. Use this filter to specify criteria for querying deployment pattern versions in Launch Wizard.
- name (string) -- [REQUIRED]
  
  The name of the filter attribute. Specifies which attribute to filter on when querying deployment pattern versions.
- values (list) -- [REQUIRED]
  
  The values to filter by. Contains the specific values to match against when filtering deployment pattern versions.
  - (string) --

rtype:

dict

returns:

Response Syntax

{
    'deploymentPatternVersions': [
        {
            'deploymentPatternVersionName': 'string',
            'description': 'string',
            'documentationUrl': 'string',
            'workloadName': 'string',
            'deploymentPatternName': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --
- deploymentPatternVersions (list) --
  
  The deployment pattern versions.
  - (dict) --
    
    Describes a deployment pattern version summary.
    - deploymentPatternVersionName (string) --
      
      The name of the deployment pattern version.
    - description (string) --
      
      The description of the deployment pattern version.
    - documentationUrl (string) --
      
      The URL of the documentation for the deployment pattern version.
    - workloadName (string) --
      
      The name of the workload.
    - deploymentPatternName (string) --
      
      The name of the deployment pattern.
- nextToken (string) --
  
  The token for the next set of results.

DeleteDeployment (updated)

Link ¶
Changes (response)

{'status': {'UPDATE_COMPLETED',
            'UPDATE_FAILED',
            'UPDATE_IN_PROGRESS',
            'UPDATE_ROLLBACK_COMPLETED',
            'UPDATE_ROLLBACK_FAILED'}}

Deletes a deployment.

See also: AWS API Documentation

Request Syntax

client.delete_deployment(
    deploymentId='string'
)

type deploymentId:

string

param deploymentId:

[REQUIRED]

The ID of the deployment.

rtype:

dict

returns:

Response Syntax

{
    'status': 'COMPLETED'|'CREATING'|'DELETE_IN_PROGRESS'|'DELETE_INITIATING'|'DELETE_FAILED'|'DELETED'|'FAILED'|'IN_PROGRESS'|'VALIDATING'|'UPDATE_IN_PROGRESS'|'UPDATE_COMPLETED'|'UPDATE_FAILED'|'UPDATE_ROLLBACK_COMPLETED'|'UPDATE_ROLLBACK_FAILED',
    'statusReason': 'string'
}

Response Structure

(dict) --
- status (string) --
  
  The status of the deployment.
- statusReason (string) --
  
  The reason for the deployment status.

GetDeployment (updated)

Link ¶
Changes (response)

{'deployment': {'modifiedAt': 'timestamp',
                'status': {'UPDATE_COMPLETED',
                           'UPDATE_FAILED',
                           'UPDATE_IN_PROGRESS',
                           'UPDATE_ROLLBACK_COMPLETED',
                           'UPDATE_ROLLBACK_FAILED'}}}

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': {
        'name': 'string',
        'id': 'string',
        'workloadName': 'string',
        'patternName': 'string',
        'status': 'COMPLETED'|'CREATING'|'DELETE_IN_PROGRESS'|'DELETE_INITIATING'|'DELETE_FAILED'|'DELETED'|'FAILED'|'IN_PROGRESS'|'VALIDATING'|'UPDATE_IN_PROGRESS'|'UPDATE_COMPLETED'|'UPDATE_FAILED'|'UPDATE_ROLLBACK_COMPLETED'|'UPDATE_ROLLBACK_FAILED',
        'createdAt': datetime(2015, 1, 1),
        'modifiedAt': datetime(2015, 1, 1),
        'specifications': {
            'string': 'string'
        },
        'resourceGroup': 'string',
        'deletedAt': datetime(2015, 1, 1),
        'tags': {
            'string': 'string'
        },
        'deploymentArn': 'string'
    }
}

Response Structure

(dict) --
- deployment (dict) --
  
  An object that details the deployment.
  - name (string) --
    
    The name of the deployment.
  - id (string) --
    
    The ID of the deployment.
  - workloadName (string) --
    
    The name of the workload.
  - patternName (string) --
    
    The pattern name of the deployment.
  - status (string) --
    
    The status of the deployment.
  - createdAt (datetime) --
    
    The time the deployment was created.
  - modifiedAt (datetime) --
    
    The time the deployment was last modified.
  - 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) --
  - resourceGroup (string) --
    
    The resource group of the deployment.
  - deletedAt (datetime) --
    
    The time the deployment was deleted.
  - tags (dict) --
    
    Information about the tags attached to a deployment.
    - (string) --
      - (string) --
  - deploymentArn (string) --
    
    The Amazon Resource Name (ARN) of the deployment.

GetWorkloadDeploymentPattern (updated)

Link ¶
Changes (response)

{'workloadDeploymentPattern': {'deploymentPatternVersionName': 'string'}}

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',
        '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.
  - 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

ListDeployments (updated)

Link ¶
Changes (response)

{'deployments': {'modifiedAt': 'timestamp',
                 'status': {'UPDATE_COMPLETED',
                            'UPDATE_FAILED',
                            'UPDATE_IN_PROGRESS',
                            'UPDATE_ROLLBACK_COMPLETED',
                            'UPDATE_ROLLBACK_FAILED'}}}

Lists the deployments that have been created.

See also: AWS API Documentation

Request Syntax

client.list_deployments(
    filters=[
        {
            'name': 'WORKLOAD_NAME'|'DEPLOYMENT_STATUS',
            'values': [
                'string',
            ]
        },
    ],
    maxResults=123,
    nextToken='string'
)

type filters:

list

param filters:

Filters to scope the results. The following filters are supported:

WORKLOAD_NAME - The name used in deployments.
DEPLOYMENT_STATUS - COMPLETED | CREATING | DELETE_IN_PROGRESS | DELETE_INITIATING | DELETE_FAILED | DELETED | FAILED | IN_PROGRESS | VALIDATING

(dict) --

A filter name and value pair that is used to return more specific results from a describe operation. Filters can be used to match a set of resources by specific criteria.
- name (string) --
  
  The name of the filter. Filter names are case-sensitive.
- values (list) --
  
  The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.
  - (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

{
    'deployments': [
        {
            'name': 'string',
            'id': 'string',
            'workloadName': 'string',
            'patternName': 'string',
            'status': 'COMPLETED'|'CREATING'|'DELETE_IN_PROGRESS'|'DELETE_INITIATING'|'DELETE_FAILED'|'DELETED'|'FAILED'|'IN_PROGRESS'|'VALIDATING'|'UPDATE_IN_PROGRESS'|'UPDATE_COMPLETED'|'UPDATE_FAILED'|'UPDATE_ROLLBACK_COMPLETED'|'UPDATE_ROLLBACK_FAILED',
            'createdAt': datetime(2015, 1, 1),
            'modifiedAt': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --
- deployments (list) --
  
  Lists the deployments.
  - (dict) --
    
    A summary of the deployment data.
    - name (string) --
      
      The name of the deployment
    - id (string) --
      
      The ID of the deployment.
    - workloadName (string) --
      
      The name of the workload.
    - patternName (string) --
      
      The name of the workload deployment pattern.
    - status (string) --
      
      The status of the deployment.
    - createdAt (datetime) --
      
      The time the deployment was created.
    - modifiedAt (datetime) --
      
      The time the deployment was last modified.
- 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': {'deploymentPatternVersionName': 'string'}}

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'
        },
    ],
    '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.
- 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': {'status': 'ACTIVE | INACTIVE | DISABLED | DELETED'}}

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'
        },
    ],
    '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.
- 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.