Route53Profiles / Client / list_profile_associations

list_profile_associations#

Route53Profiles.Client.list_profile_associations(**kwargs)#

Lists all the VPCs that the specified Route 53 Profile is associated with.

See also: AWS API Documentation

Request Syntax

response = client.list_profile_associations(
    MaxResults=123,
    NextToken='string',
    ProfileId='string',
    ResourceId='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.

  • ProfileId (string) – ID of the Profile.

  • ResourceId (string) – ID of the VPC.

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'ProfileAssociations': [
        {
            'CreationTime': datetime(2015, 1, 1),
            'Id': 'string',
            'ModificationTime': datetime(2015, 1, 1),
            'Name': 'string',
            'OwnerId': 'string',
            'ProfileId': 'string',
            'ResourceId': 'string',
            'Status': 'COMPLETE'|'DELETING'|'UPDATING'|'CREATING'|'DELETED'|'FAILED',
            'StatusMessage': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • NextToken (string) –

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

    • ProfileAssociations (list) –

      A complex type that containts settings information about the profile’s VPC associations.

      • (dict) –

        An association between a Route 53 Profile and a VPC.

        • CreationTime (datetime) –

          The date and time that the Profile association was created, in Unix time format and Coordinated Universal Time (UTC).

        • Id (string) –

          ID of the Profile association.

        • ModificationTime (datetime) –

          The date and time that the Profile association was modified, in Unix time format and Coordinated Universal Time (UTC).

        • Name (string) –

          Name of the Profile association.

        • OwnerId (string) –

          Amazon Web Services account ID of the Profile association owner.

        • ProfileId (string) –

          ID of the Profile.

        • ResourceId (string) –

          The Amazon Resource Name (ARN) of the VPC.

        • Status (string) –

          Status of the Profile association.

        • StatusMessage (string) –

          Additional information about the Profile association.

Exceptions

  • Route53Profiles.Client.exceptions.InvalidParameterException

  • Route53Profiles.Client.exceptions.ThrottlingException

  • Route53Profiles.Client.exceptions.ValidationException

  • Route53Profiles.Client.exceptions.AccessDeniedException

  • Route53Profiles.Client.exceptions.InvalidNextTokenException