SimpleDB / Client / list_domains

list_domains#

SimpleDB.Client.list_domains(**kwargs)#

The ListDomains operation lists all domains associated with the Access Key ID. It returns domain names up to the limit set by MaxNumberOfDomains. A NextToken is returned if there are more than MaxNumberOfDomains domains. Calling ListDomains successive times with the NextToken provided by the operation returns up to MaxNumberOfDomains more domain names with each successive operation call.

See also: AWS API Documentation

Request Syntax

response = client.list_domains(
    MaxNumberOfDomains=123,
    NextToken='string'
)
Parameters:

  • MaxNumberOfDomains (integer) – The maximum number of domain names you want returned. The range is 1 to 100. The default setting is 100.

  • NextToken (string) – A string informing Amazon SimpleDB where to start the next list of domain names.

Return type:

dict

Returns:

Response Syntax

{
    'DomainNames': [
        'string',
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • DomainNames (list) – A list of domain names that match the expression.

      • (string) –

    • NextToken (string) – An opaque token indicating that there are more domains than the specified MaxNumberOfDomains still available.

Exceptions

  • SimpleDB.Client.exceptions.InvalidParameterValue

  • SimpleDB.Client.exceptions.InvalidNextToken