LaunchWizard / Client / list_workload_deployment_patterns

list_workload_deployment_patterns¶

LaunchWizard.Client.list_workload_deployment_patterns(**kwargs)¶

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

Request Syntax

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

Parameters:

workloadName (string) –
[REQUIRED]

The name of the workload.
maxResults (integer) – 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.
nextToken (string) – The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

Return type:

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.
        
        Note
        This is a Tagged Union structure. Only one of the following top level keys will be set: managementAccount, delegatedAdmin. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        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.

Exceptions

LaunchWizard.Client.exceptions.InternalServerException
LaunchWizard.Client.exceptions.ValidationException
LaunchWizard.Client.exceptions.ResourceNotFoundException