ListDomains

class SageMaker.Paginator.ListDomains
paginator = client.get_paginator('list_domains')
paginate(**kwargs)

Creates an iterator that will paginate through responses from SageMaker.Client.list_domains().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
PaginationConfig (dict) --

A dictionary that provides parameters to control pagination.

  • MaxItems (integer) --

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) --

    The size of each page.

  • StartingToken (string) --

    A token to specify where to start paginating. This is the NextToken from a previous response.

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'
        },
    ],

}

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.