LaunchWizard / Client / list_workloads

list_workloads

LaunchWizard.Client.list_workloads(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.list_workloads(
    maxResults=123,
    nextToken='string'
)
Parameters:

  • 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

{
    'workloads': [
        {
            'workloadName': 'string',
            'displayName': 'string',
            'status': 'ACTIVE'|'INACTIVE'|'DISABLED'|'DELETED',
            'accountConstraints': [
                {
                    'managementAccount': {},
                    'delegatedAdmin': {
                        'servicePrincipal': 'string'
                    }
                },
            ]
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • workloads (list) –

      Information about the workloads.

      • (dict) –

        Describes workload data.

        • workloadName (string) –

          The name of the workload.

        • displayName (string) –

          The display name of the workload data.

        • status (string) –

          The status of the workload.

        • 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