AWS API Changes

2023/11/03 - AWS Launch Wizard - 8 new api methods

Changes AWS Launch Wizard is a service that helps reduce the time it takes to deploy applications to the cloud while providing a guided deployment experience.

ListWorkloadDeploymentPatterns (new)

Link ¶

Lists the workload deployment patterns.

See also: AWS API Documentation

Request Syntax

client.list_workload_deployment_patterns(
    maxResults=123,
    nextToken='string',
    workloadName='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.

type workloadName:

string

param workloadName:

[REQUIRED]

The name of the workload.

rtype:

dict

returns:

Response Syntax

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

Response Structure

(dict) --
- 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.
- workloadDeploymentPatterns (list) --
  
  Describes the workload deployment patterns.
  - (dict) --
    
    Describes a workload deployment pattern.
    - deploymentPatternName (string) --
      
      The name of a workload deployment pattern.
    - description (string) --
      
      The description of a workload deployment pattern.
    - displayName (string) --
      
      The display name 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.
    - workloadName (string) --
      
      The name of the workload.
    - workloadVersionName (string) --
      
      The name of the workload deployment pattern version.

ListWorkloads (new)

Link ¶

Lists the workloads.

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

{
    'nextToken': 'string',
    'workloads': [
        {
            'displayName': 'string',
            'workloadName': 'string'
        },
    ]
}

Response Structure

(dict) --
- 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.
- workloads (list) --
  
  Information about the workloads.
  - (dict) --
    
    Describes workload data.
    - displayName (string) --
      
      The display name of the workload data.
    - workloadName (string) --
      
      The name of the workload.

ListDeployments (new)

Link ¶

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
DEPLOYMENT_STATUS

(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': [
        {
            'createdAt': datetime(2015, 1, 1),
            'id': 'string',
            'name': 'string',
            'patternName': 'string',
            'status': 'COMPLETED'|'CREATING'|'DELETE_IN_PROGRESS'|'DELETE_INITIATING'|'DELETE_FAILED'|'DELETED'|'FAILED'|'IN_PROGRESS'|'VALIDATING',
            'workloadName': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

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

GetDeployment (new)

Link ¶

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),
        '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',
        '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.
  - 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 specifications of the deployment. For more information on specifications for each deployment, see Workload specifications.
    - (string) --
      - (string) --
  - status (string) --
    
    The status of the deployment.
  - workloadName (string) --
    
    The name of the workload.

GetWorkload (new)

Link ¶

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': {
        'description': 'string',
        'displayName': 'string',
        'documentationUrl': 'string',
        'iconUrl': 'string',
        'status': 'ACTIVE'|'INACTIVE'|'DISABLED'|'DELETED',
        'statusMessage': 'string',
        'workloadName': 'string'
    }
}

Response Structure

(dict) --
- workload (dict) --
  
  Information about the workload.
  - description (string) --
    
    The description of a workload.
  - displayName (string) --
    
    The display name of a workload.
  - documentationUrl (string) --
    
    The URL of a workload document.
  - iconUrl (string) --
    
    The URL of a workload icon.
  - status (string) --
    
    The status of a workload.
  - statusMessage (string) --
    
    The message about a workload's status.
  - workloadName (string) --
    
    The name of the workload.

DeleteDeployment (new)

Link ¶

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',
    'statusReason': 'string'
}

Response Structure

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

CreateDeployment (new)

Link ¶

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'
    },
    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. For more information on the specifications required for creating a deployment, see Workload specifications.

(string) --
- (string) --

type workloadName:

string

param workloadName:

[REQUIRED]

The name of the workload. You can use the ListWorkloadDeploymentPatterns 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.

ListDeploymentEvents (new)

Link ¶

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': [
        {
            'description': 'string',
            'name': 'string',
            'status': 'CANCELED'|'CANCELING'|'COMPLETED'|'CREATED'|'FAILED'|'IN_PROGRESS'|'PENDING'|'TIMED_OUT',
            'statusReason': 'string',
            'timestamp': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --
- deploymentEvents (list) --
  
  Lists the deployment events.
  - (dict) --
    
    A summary of the deployment event data.
    - description (string) --
      
      The description of the deployment event.
    - name (string) --
      
      The name 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.
- 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.