:doc:`LaunchWizard <../../launch-wizard>` / Client / get_workload_deployment_pattern

*******************************
get_workload_deployment_pattern
*******************************



.. py:method:: LaunchWizard.Client.get_workload_deployment_pattern(**kwargs)

  

  Returns details for a given workload and deployment pattern, including the available specifications. You can use the `ListWorkloads <https://docs.aws.amazon.com/launchwizard/latest/APIReference/API_ListWorkloads.html>`__ operation to discover the available workload names and the `ListWorkloadDeploymentPatterns <https://docs.aws.amazon.com/launchwizard/latest/APIReference/API_ListWorkloadDeploymentPatterns.html>`__ operation to discover the available deployment pattern names of a given workload.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/launch-wizard-2018-05-10/GetWorkloadDeploymentPattern>`_  


  **Request Syntax**
  ::

    response = 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 <https://docs.aws.amazon.com/launchwizard/latest/APIReference/launch-wizard-specifications-sap.html>`__. To retrieve the specifications required to create a deployment for other workloads, use the `GetWorkloadDeploymentPattern <https://docs.aws.amazon.com/launchwizard/latest/APIReference/API_GetWorkloadDeploymentPattern.html>`__ 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``

                  
            
          
        
      
    
  
  **Exceptions**
  
  *   :py:class:`LaunchWizard.Client.exceptions.InternalServerException`

  
  *   :py:class:`LaunchWizard.Client.exceptions.ValidationException`

  
  *   :py:class:`LaunchWizard.Client.exceptions.ResourceNotFoundException`

  