LaunchWizard / Client / get_workload_deployment_pattern

get_workload_deployment_pattern#

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

response = client.get_workload_deployment_pattern(
    deploymentPatternName='string',
    workloadName='string'
)
Parameters:

  • deploymentPatternName (string) –

    [REQUIRED]

    The name of the deployment pattern.

  • workloadName (string) –

    [REQUIRED]

    The name of the workload.

Return type:

dict

Returns:

Response Syntax

{
    'workloadDeploymentPattern': {
        'deploymentPatternName': 'string',
        'description': 'string',
        'displayName': 'string',
        'specifications': [
            {
                'allowedValues': [
                    'string',
                ],
                'conditionals': [
                    {
                        'comparator': 'string',
                        'name': 'string',
                        'value': 'string'
                    },
                ],
                'description': 'string',
                'name': 'string',
                'required': 'string'
            },
        ],
        'status': 'ACTIVE'|'INACTIVE'|'DISABLED'|'DELETED',
        'statusMessage': 'string',
        'workloadName': 'string',
        'workloadVersionName': 'string'
    }
}

Response Structure

  • (dict) –

    • workloadDeploymentPattern (dict) –

      Details about the workload deployment pattern.

      • deploymentPatternName (string) –

        The name of the deployment pattern.

      • description (string) –

        The description of the deployment pattern.

      • displayName (string) –

        The display name 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.

          • allowedValues (list) –

            The allowed values of the deployment specification.

            • (string) –

          • conditionals (list) –

            The conditionals used for the deployment specification.

            • (dict) –

              A field that details a condition of the specifications for a deployment.

              • comparator (string) –

                The comparator of the condition.

                Valid values: Equal | NotEqual

              • name (string) –

                The name of the deployment condition.

              • value (string) –

                The value of the condition.

          • description (string) –

            The description of the deployment specification.

          • name (string) –

            The name of the deployment specification.

          • required (string) –

            Indicates if the deployment specification is required.

      • status (string) –

        The status of the deployment pattern.

      • statusMessage (string) –

        The status message of the deployment pattern.

      • workloadName (string) –

        The workload name of the deployment pattern.

      • workloadVersionName (string) –

        The workload version name of the deployment pattern.

Exceptions