Route53Profiles / Client / list_profiles

list_profiles#

Route53Profiles.Client.list_profiles(**kwargs)#

Lists all the Route 53 Profiles associated with your Amazon Web Services account.

See also: AWS API Documentation

Request Syntax

response = client.list_profiles(
    MaxResults=123,
    NextToken='string'
)
Parameters:
  • MaxResults (integer) –

    The maximum number of objects that you want to return for this request. If more objects are available, in the response, a NextToken value, which you can use in a subsequent call to get the next batch of objects, is provided.

    If you don’t specify a value for MaxResults, up to 100 objects are returned.

  • NextToken (string) –

    For the first call to this list request, omit this value.

    When you request a list of objects, at most the number of objects specified by MaxResults is returned. If more objects are available for retrieval, a NextToken value is returned in the response. To retrieve the next batch of objects, use the token that was returned for the prior request in your next request.

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'ProfileSummaries': [
        {
            'Arn': 'string',
            'Id': 'string',
            'Name': 'string',
            'ShareStatus': 'NOT_SHARED'|'SHARED_WITH_ME'|'SHARED_BY_ME'
        },
    ]
}

Response Structure

  • (dict) –

    • NextToken (string) –

      If more than MaxResults resource associations match the specified criteria, you can submit another ListProfiles request to get the next group of results. In the next request, specify the value of NextToken from the previous response.

    • ProfileSummaries (list) –

      Summary information about the Profiles.

      • (dict) –

        Summary information about a Route 53 Profile.

        • Arn (string) –

          The Amazon Resource Name (ARN) of the Profile.

        • Id (string) –

          ID of the Profile.

        • Name (string) –

          Name of the Profile.

        • ShareStatus (string) –

          Share status of the Profile.

Exceptions

  • Route53Profiles.Client.exceptions.InvalidParameterException

  • Route53Profiles.Client.exceptions.ThrottlingException

  • Route53Profiles.Client.exceptions.ValidationException

  • Route53Profiles.Client.exceptions.AccessDeniedException

  • Route53Profiles.Client.exceptions.InvalidNextTokenException