Route53Profiles / Client / get_profile

get_profile#

Route53Profiles.Client.get_profile(**kwargs)#

Returns information about a specified Route 53 Profile, such as whether whether the Profile is shared, and the current status of the Profile.

See also: AWS API Documentation

Request Syntax

response = client.get_profile(
    ProfileId='string'
)
Parameters:

ProfileId (string) –

[REQUIRED]

ID of the Profile.

Return type:

dict

Returns:

Response Syntax

{
    'Profile': {
        'Arn': 'string',
        'ClientToken': 'string',
        'CreationTime': datetime(2015, 1, 1),
        'Id': 'string',
        'ModificationTime': datetime(2015, 1, 1),
        'Name': 'string',
        'OwnerId': 'string',
        'ShareStatus': 'NOT_SHARED'|'SHARED_WITH_ME'|'SHARED_BY_ME',
        'Status': 'COMPLETE'|'DELETING'|'UPDATING'|'CREATING'|'DELETED'|'FAILED',
        'StatusMessage': 'string'
    }
}

Response Structure

  • (dict) –

    • Profile (dict) –

      Information about the Profile, including the status of the Profile.

      • Arn (string) –

        The Amazon Resource Name (ARN) of the Profile.

      • ClientToken (string) –

        The ClientToken value that was assigned when the Profile was created.

      • CreationTime (datetime) –

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

      • Id (string) –

        ID of the Profile.

      • ModificationTime (datetime) –

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

      • Name (string) –

        Name of the Profile.

      • OwnerId (string) –

        Amazon Web Services account ID of the Profile owner.

      • ShareStatus (string) –

        Sharing status for the Profile.

      • Status (string) –

        The status for the Profile.

      • StatusMessage (string) –

        Status message that includes additiona information about the Profile.

Exceptions

  • Route53Profiles.Client.exceptions.ResourceNotFoundException

  • Route53Profiles.Client.exceptions.ThrottlingException

  • Route53Profiles.Client.exceptions.ValidationException

  • Route53Profiles.Client.exceptions.AccessDeniedException