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(
    workloadName='string',
    deploymentPatternName='string'
)
Parameters:

  • workloadName (string) –

    [REQUIRED]

    The name of the workload.

  • deploymentPatternName (string) –

    [REQUIRED]

    The name of the deployment pattern.

Return type:

dict

Returns:

Response Syntax

{
    'workloadDeploymentPattern': {
        'workloadName': 'string',
        'deploymentPatternName': 'string',
        'workloadVersionName': 'string',
        'deploymentPatternVersionName': 'string',
        'displayName': 'string',
        'description': 'string',
        'status': 'ACTIVE'|'INACTIVE'|'DISABLED'|'DELETED',
        'statusMessage': 'string',
        'accountConstraints': [
            {
                'managementAccount': {},
                'delegatedAdmin': {
                    'servicePrincipal': '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.

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

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

          • 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