MainframeModernization / Client / list_deployments

list_deployments#

MainframeModernization.Client.list_deployments(**kwargs)#

Returns a list of all deployments of a specific application. A deployment is a combination of a specific application and a specific version of that application. Each deployment is mapped to a particular application version.

Request Syntax

response = client.list_deployments(
    applicationId='string',
    maxResults=123,
    nextToken='string'
)

Parameters:

applicationId (string) –
[REQUIRED]

The application identifier.
maxResults (integer) – The maximum number of objects to return.
nextToken (string) – A pagination token returned from a previous call to this operation. This specifies the next item to return. To return to the beginning of the list, exclude this parameter.

Return type:

dict

Returns:

Response Syntax

{
    'deployments': [
        {
            'applicationId': 'string',
            'applicationVersion': 123,
            'creationTime': datetime(2015, 1, 1),
            'deploymentId': 'string',
            'environmentId': 'string',
            'status': 'Deploying'|'Succeeded'|'Failed',
            'statusReason': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- deployments (list) –
  
  The list of deployments that is returned.
  - (dict) –
    
    A subset of information about a specific deployment.
    - applicationId (string) –
      
      The unique identifier of the application.
    - applicationVersion (integer) –
      
      The version of the application.
    - creationTime (datetime) –
      
      The timestamp when the deployment was created.
    - deploymentId (string) –
      
      The unique identifier of the deployment.
    - environmentId (string) –
      
      The unique identifier of the runtime environment.
    - status (string) –
      
      The current status of the deployment.
    - statusReason (string) –
      
      The reason for the reported status.
- nextToken (string) –
  
  If there are more items to return, this contains a token that is passed to a subsequent call to this operation to retrieve the next set of items.

Exceptions

MainframeModernization.Client.exceptions.ValidationException
MainframeModernization.Client.exceptions.InternalServerException
MainframeModernization.Client.exceptions.AccessDeniedException
MainframeModernization.Client.exceptions.ThrottlingException
MainframeModernization.Client.exceptions.ResourceNotFoundException