LaunchWizard / Client / get_workload

get_workload

LaunchWizard.Client.get_workload(**kwargs)

Returns information about a workload.

See also: AWS API Documentation

Request Syntax

response = client.get_workload(
    workloadName='string'
)
Parameters:

workloadName (string) –

[REQUIRED]

The name of the workload.

Return type:

dict

Returns:

Response Syntax

{
    'workload': {
        'workloadName': 'string',
        'displayName': 'string',
        'status': 'ACTIVE'|'INACTIVE'|'DISABLED'|'DELETED',
        'accountConstraints': [
            {
                'managementAccount': {},
                'delegatedAdmin': {
                    'servicePrincipal': 'string'
                }
            },
        ],
        'description': 'string',
        'documentationUrl': 'string',
        'iconUrl': 'string',
        'statusMessage': 'string'
    }
}

Response Structure

  • (dict) –

    • workload (dict) –

      Information about the workload.

      • workloadName (string) –

        The name of the workload.

      • displayName (string) –

        The display name of a workload.

      • status (string) –

        The status of a workload.

        You can list deployments in the DISABLED 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.

      • description (string) –

        The description of a workload.

      • documentationUrl (string) –

        The URL of a workload document.

      • iconUrl (string) –

        The URL of a workload icon.

      • statusMessage (string) –

        The message about a workload’s status.

Exceptions