SageMaker / Client / list_domains

list_domains

SageMaker.Client.list_domains(**kwargs)

Lists the domains.

See also: AWS API Documentation

Request Syntax

response = client.list_domains(
    NextToken='string',
    MaxResults=123
)

Parameters:

• NextToken (string) – If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

• MaxResults (integer) – This parameter defines the maximum number of results that can be return in a single response. The MaxResults parameter is an upper bound, not a target. If there are more results available than the value specified, a NextToken is provided in the response. The NextToken indicates that the user should get the next set of results by providing this token as a part of a subsequent call. The default value for MaxResults is 10.

Return type:

dict

Returns:

Response Syntax

{
    'Domains': [
        {
            'DomainArn': 'string',
            'DomainId': 'string',
            'DomainName': 'string',
            'Status': 'Deleting'|'Failed'|'InService'|'Pending'|'Updating'|'Update_Failed'|'Delete_Failed',
            'CreationTime': datetime(2015, 1, 1),
            'LastModifiedTime': datetime(2015, 1, 1),
            'Url': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • Domains (list) –

    The list of domains.

    • (dict) –

      The domain’s details.

      • DomainArn (string) –

        The domain’s Amazon Resource Name (ARN).

      • DomainId (string) –

        The domain ID.

      • DomainName (string) –

        The domain name.

      • Status (string) –

        The status.

      • CreationTime (datetime) –

        The creation time.

      • LastModifiedTime (datetime) –

        The last modified time.

      • Url (string) –

        The domain’s URL.

  • NextToken (string) –

    If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.