AWS API Changes

2024/04/22 - Route 53 Profiles - 16 new api methods

Changes Route 53 Profiles allows you to apply a central DNS configuration across many VPCs regardless of account.

CreateProfile (new)

Link ¶

Creates an empty Route 53 Profile.

Request Syntax

client.create_profile(
    ClientToken='string',
    Name='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

type ClientToken:

string

param ClientToken:

[REQUIRED]

ClientToken is an idempotency token that ensures a call to CreateProfile completes only once. You choose the value to pass. For example, an issue might prevent you from getting a response from CreateProfile. In this case, safely retry your call to CreateProfile by using the same CreateProfile parameter value.

This field is autopopulated if not provided.

type Name:

string

param Name:

[REQUIRED]

A name for the Profile.

type Tags:

list

param Tags:

A list of the tag keys and values that you want to associate with the Route 53 Profile.

(dict) --

Tag for the Profile.
- Key (string) -- [REQUIRED]
  
  Key associated with the Tag.
- Value (string) -- [REQUIRED]
  
  Value for the Tag.

rtype:

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) --
  
  The Profile that you just created.
  - 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.

DeleteProfile (new)

Link ¶

Deletes the specified Route 53 Profile. Before you can delete a profile, you must first disassociate it from all VPCs.

See also: AWS API Documentation

Request Syntax

client.delete_profile(
    ProfileId='string'
)

type ProfileId:

string

param ProfileId:

[REQUIRED]

The ID of the Profile that you want to delete.

rtype:

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 DeleteProfile request, including the status of the request.
  - 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.

ListProfileAssociations (new)

Link ¶

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

See also: AWS API Documentation

Request Syntax

client.list_profile_associations(
    MaxResults=123,
    NextToken='string',
    ProfileId='string',
    ResourceId='string'
)

type MaxResults:

integer

param MaxResults:

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.

type NextToken:

string

param NextToken:

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.

type ProfileId:

string

param ProfileId:

ID of the Profile.

type ResourceId:

string

param ResourceId:

ID of the VPC.

rtype:

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.

GetProfile (new)

Link ¶

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

client.get_profile(
    ProfileId='string'
)

type ProfileId:

string

param ProfileId:

[REQUIRED]

ID of the Profile.

rtype:

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.

ListProfileResourceAssociations (new)

Link ¶

Lists all the resource associations for the specified Route 53 Profile.

See also: AWS API Documentation

Request Syntax

client.list_profile_resource_associations(
    MaxResults=123,
    NextToken='string',
    ProfileId='string',
    ResourceType='string'
)

type MaxResults:

integer

param MaxResults:

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

type NextToken:

string

param NextToken:

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

type ProfileId:

string

param ProfileId:

[REQUIRED]

The ID of the Profile.

type ResourceType:

string

param ResourceType:

ID of a resource if you want information on only one type.

rtype:

dict

returns:

Response Syntax

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

Response Structure

(dict) --
- NextToken (string) --
  
  If more than MaxResults resource associations match the specified criteria, you can submit another ListProfileResourceAssociations request to get the next group of results. In the next request, specify the value of NextToken from the previous response.
- ProfileResourceAssociations (list) --
  
  Information about the profile resource association that you specified in a GetProfileResourceAssociation request.
  - (dict) --
    
    The association between a Route 53 Profile and resources.
    - CreationTime (datetime) --
      
      The date and time that the Profile resource association was created, in Unix time format and Coordinated Universal Time (UTC).
    - Id (string) --
      
      ID of the Profile resource association.
    - ModificationTime (datetime) --
      
      The date and time that the Profile resource association was modified, in Unix time format and Coordinated Universal Time (UTC).
    - Name (string) --
      
      Name of the Profile resource association.
    - OwnerId (string) --
      
      Amazon Web Services account ID of the Profile resource association owner.
    - ProfileId (string) --
      
      Profile ID of the Profile that the resources are associated with.
    - ResourceArn (string) --
      
      The Amazon Resource Name (ARN) of the resource association.
    - ResourceProperties (string) --
      
      If the DNS resource is a DNS Firewall rule group, this indicates the priority.
    - ResourceType (string) --
      
      Resource type, such as a private hosted zone, or DNS Firewall rule group.
    - Status (string) --
      
      Status of the Profile resource association.
    - StatusMessage (string) --
      
      Additional information about the Profile resource association.

ListTagsForResource (new)

Link ¶

Lists the tags that you associated with the specified resource.

See also: AWS API Documentation

Request Syntax

client.list_tags_for_resource(
    ResourceArn='string'
)

type ResourceArn:

string

param ResourceArn:

[REQUIRED]

The Amazon Resource Name (ARN) for the resource that you want to list the tags for.

rtype:

dict

returns:

Response Syntax

{
    'Tags': {
        'string': 'string'
    }
}

Response Structure

(dict) --
- Tags (dict) --
  
  The tags that are associated with the resource that you specified in the ListTagsForResource request.
  - (string) --
    - (string) --

TagResource (new)

Link ¶

Adds one or more tags to a specified resource.

See also: AWS API Documentation

Request Syntax

client.tag_resource(
    ResourceArn='string',
    Tags={
        'string': 'string'
    }
)

type ResourceArn:

string

param ResourceArn:

[REQUIRED]

The Amazon Resource Name (ARN) for the resource that you want to add tags to.

type Tags:

dict

param Tags:

[REQUIRED]

The tags that you want to add to the specified resource.

(string) --
- (string) --

rtype:

dict

returns:

Response Syntax

{}

Response Structure

(dict) --

UntagResource (new)

Link ¶

Removes one or more tags from a specified resource.

See also: AWS API Documentation

Request Syntax

client.untag_resource(
    ResourceArn='string',
    TagKeys=[
        'string',
    ]
)

type ResourceArn:

string

param ResourceArn:

[REQUIRED]

The Amazon Resource Name (ARN) for the resource that you want to remove tags from.

type TagKeys:

list

param TagKeys:

[REQUIRED]

The tags that you want to remove to the specified resource.

(string) --

rtype:

dict

returns:

Response Syntax

{}

Response Structure

(dict) --

GetProfileAssociation (new)

Link ¶

Retrieves a Route 53 Profile association for a VPC. A VPC can have only one Profile association, but a Profile can be associated with up to 5000 VPCs.

See also: AWS API Documentation

Request Syntax

client.get_profile_association(
    ProfileAssociationId='string'
)

type ProfileAssociationId:

string

param ProfileAssociationId:

[REQUIRED]

The identifier of the association you want to get information about.

rtype:

dict

returns:

Response Syntax

{
    'ProfileAssociation': {
        '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) --
- ProfileAssociation (dict) --
  
  Information about the Profile association that you specified in a GetProfileAssociation request.
  - 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.

AssociateResourceToProfile (new)

Link ¶

Associates a DNS reource configuration to a Route 53 Profile.

See also: AWS API Documentation

Request Syntax

client.associate_resource_to_profile(
    Name='string',
    ProfileId='string',
    ResourceArn='string',
    ResourceProperties='string'
)

type Name:

string

param Name:

[REQUIRED]

Name for the resource association.

type ProfileId:

string

param ProfileId:

[REQUIRED]

ID of the Profile.

type ResourceArn:

string

param ResourceArn:

[REQUIRED]

Amazon resource number, ARN, of the DNS resource.

type ResourceProperties:

string

param ResourceProperties:

If you are adding a DNS Firewall rule group, include also a priority in this format:

Key=FirewallRuleGroupPriority,Value=100

rtype:

dict

returns:

Response Syntax

{
    'ProfileResourceAssociation': {
        'CreationTime': datetime(2015, 1, 1),
        'Id': 'string',
        'ModificationTime': datetime(2015, 1, 1),
        'Name': 'string',
        'OwnerId': 'string',
        'ProfileId': 'string',
        'ResourceArn': 'string',
        'ResourceProperties': 'string',
        'ResourceType': 'string',
        'Status': 'COMPLETE'|'DELETING'|'UPDATING'|'CREATING'|'DELETED'|'FAILED',
        'StatusMessage': 'string'
    }
}

Response Structure

(dict) --
- ProfileResourceAssociation (dict) --
  
  Infromation about the AssociateResourceToProfile, including a status message.
  - CreationTime (datetime) --
    
    The date and time that the Profile resource association was created, in Unix time format and Coordinated Universal Time (UTC).
  - Id (string) --
    
    ID of the Profile resource association.
  - ModificationTime (datetime) --
    
    The date and time that the Profile resource association was modified, in Unix time format and Coordinated Universal Time (UTC).
  - Name (string) --
    
    Name of the Profile resource association.
  - OwnerId (string) --
    
    Amazon Web Services account ID of the Profile resource association owner.
  - ProfileId (string) --
    
    Profile ID of the Profile that the resources are associated with.
  - ResourceArn (string) --
    
    The Amazon Resource Name (ARN) of the resource association.
  - ResourceProperties (string) --
    
    If the DNS resource is a DNS Firewall rule group, this indicates the priority.
  - ResourceType (string) --
    
    Resource type, such as a private hosted zone, or DNS Firewall rule group.
  - Status (string) --
    
    Status of the Profile resource association.
  - StatusMessage (string) --
    
    Additional information about the Profile resource association.

GetProfileResourceAssociation (new)

Link ¶

Returns information about a specified Route 53 Profile resource association.

See also: AWS API Documentation

Request Syntax

client.get_profile_resource_association(
    ProfileResourceAssociationId='string'
)

type ProfileResourceAssociationId:

string

param ProfileResourceAssociationId:

[REQUIRED]

The ID of the profile resource association that you want to get information about.

rtype:

dict

returns:

Response Syntax

{
    'ProfileResourceAssociation': {
        'CreationTime': datetime(2015, 1, 1),
        'Id': 'string',
        'ModificationTime': datetime(2015, 1, 1),
        'Name': 'string',
        'OwnerId': 'string',
        'ProfileId': 'string',
        'ResourceArn': 'string',
        'ResourceProperties': 'string',
        'ResourceType': 'string',
        'Status': 'COMPLETE'|'DELETING'|'UPDATING'|'CREATING'|'DELETED'|'FAILED',
        'StatusMessage': 'string'
    }
}

Response Structure

(dict) --
- ProfileResourceAssociation (dict) --
  
  Information about the Profile resource association that you specified in a GetProfileResourceAssociation request.
  - CreationTime (datetime) --
    
    The date and time that the Profile resource association was created, in Unix time format and Coordinated Universal Time (UTC).
  - Id (string) --
    
    ID of the Profile resource association.
  - ModificationTime (datetime) --
    
    The date and time that the Profile resource association was modified, in Unix time format and Coordinated Universal Time (UTC).
  - Name (string) --
    
    Name of the Profile resource association.
  - OwnerId (string) --
    
    Amazon Web Services account ID of the Profile resource association owner.
  - ProfileId (string) --
    
    Profile ID of the Profile that the resources are associated with.
  - ResourceArn (string) --
    
    The Amazon Resource Name (ARN) of the resource association.
  - ResourceProperties (string) --
    
    If the DNS resource is a DNS Firewall rule group, this indicates the priority.
  - ResourceType (string) --
    
    Resource type, such as a private hosted zone, or DNS Firewall rule group.
  - Status (string) --
    
    Status of the Profile resource association.
  - StatusMessage (string) --
    
    Additional information about the Profile resource association.

UpdateProfileResourceAssociation (new)

Link ¶

Updates the specified Route 53 Profile resourse association.

See also: AWS API Documentation

Request Syntax

client.update_profile_resource_association(
    Name='string',
    ProfileResourceAssociationId='string',
    ResourceProperties='string'
)

type Name:

string

param Name:

Name of the resource association.

type ProfileResourceAssociationId:

string

param ProfileResourceAssociationId:

[REQUIRED]

ID of the resource association.

type ResourceProperties:

string

param ResourceProperties:

If you are adding a DNS Firewall rule group, include also a priority in this format:

Key=FirewallRuleGroupPriority,Value=100.

rtype:

dict

returns:

Response Syntax

{
    'ProfileResourceAssociation': {
        'CreationTime': datetime(2015, 1, 1),
        'Id': 'string',
        'ModificationTime': datetime(2015, 1, 1),
        'Name': 'string',
        'OwnerId': 'string',
        'ProfileId': 'string',
        'ResourceArn': 'string',
        'ResourceProperties': 'string',
        'ResourceType': 'string',
        'Status': 'COMPLETE'|'DELETING'|'UPDATING'|'CREATING'|'DELETED'|'FAILED',
        'StatusMessage': 'string'
    }
}

Response Structure

(dict) --
- ProfileResourceAssociation (dict) --
  
  Information about the UpdateProfileResourceAssociation request, including a status message.
  - CreationTime (datetime) --
    
    The date and time that the Profile resource association was created, in Unix time format and Coordinated Universal Time (UTC).
  - Id (string) --
    
    ID of the Profile resource association.
  - ModificationTime (datetime) --
    
    The date and time that the Profile resource association was modified, in Unix time format and Coordinated Universal Time (UTC).
  - Name (string) --
    
    Name of the Profile resource association.
  - OwnerId (string) --
    
    Amazon Web Services account ID of the Profile resource association owner.
  - ProfileId (string) --
    
    Profile ID of the Profile that the resources are associated with.
  - ResourceArn (string) --
    
    The Amazon Resource Name (ARN) of the resource association.
  - ResourceProperties (string) --
    
    If the DNS resource is a DNS Firewall rule group, this indicates the priority.
  - ResourceType (string) --
    
    Resource type, such as a private hosted zone, or DNS Firewall rule group.
  - Status (string) --
    
    Status of the Profile resource association.
  - StatusMessage (string) --
    
    Additional information about the Profile resource association.

DisassociateResourceFromProfile (new)

Link ¶

Dissoaciated a specified resource, from the Route 53 Profile.

See also: AWS API Documentation

Request Syntax

client.disassociate_resource_from_profile(
    ProfileId='string',
    ResourceArn='string'
)

type ProfileId:

string

param ProfileId:

[REQUIRED]

The ID of the Profile.

type ResourceArn:

string

param ResourceArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the resource.

rtype:

dict

returns:

Response Syntax

{
    'ProfileResourceAssociation': {
        'CreationTime': datetime(2015, 1, 1),
        'Id': 'string',
        'ModificationTime': datetime(2015, 1, 1),
        'Name': 'string',
        'OwnerId': 'string',
        'ProfileId': 'string',
        'ResourceArn': 'string',
        'ResourceProperties': 'string',
        'ResourceType': 'string',
        'Status': 'COMPLETE'|'DELETING'|'UPDATING'|'CREATING'|'DELETED'|'FAILED',
        'StatusMessage': 'string'
    }
}

Response Structure

(dict) --
- ProfileResourceAssociation (dict) --
  
  Information about the DisassociateResourceFromProfile request, including the status of the request.
  - CreationTime (datetime) --
    
    The date and time that the Profile resource association was created, in Unix time format and Coordinated Universal Time (UTC).
  - Id (string) --
    
    ID of the Profile resource association.
  - ModificationTime (datetime) --
    
    The date and time that the Profile resource association was modified, in Unix time format and Coordinated Universal Time (UTC).
  - Name (string) --
    
    Name of the Profile resource association.
  - OwnerId (string) --
    
    Amazon Web Services account ID of the Profile resource association owner.
  - ProfileId (string) --
    
    Profile ID of the Profile that the resources are associated with.
  - ResourceArn (string) --
    
    The Amazon Resource Name (ARN) of the resource association.
  - ResourceProperties (string) --
    
    If the DNS resource is a DNS Firewall rule group, this indicates the priority.
  - ResourceType (string) --
    
    Resource type, such as a private hosted zone, or DNS Firewall rule group.
  - Status (string) --
    
    Status of the Profile resource association.
  - StatusMessage (string) --
    
    Additional information about the Profile resource association.

ListProfiles (new)

Link ¶

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

See also: AWS API Documentation

Request Syntax

client.list_profiles(
    MaxResults=123,
    NextToken='string'
)

type MaxResults:

integer

param MaxResults:

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

type NextToken:

string

param NextToken:

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

rtype:

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.

DisassociateProfile (new)

Link ¶

Dissociates a specified Route 53 Profile from the specified VPC.

See also: AWS API Documentation

Request Syntax

client.disassociate_profile(
    ProfileId='string',
    ResourceId='string'
)

type ProfileId:

string

param ProfileId:

[REQUIRED]

ID of the Profile.

type ResourceId:

string

param ResourceId:

[REQUIRED]

The ID of the VPC.

rtype:

dict

returns:

Response Syntax

{
    'ProfileAssociation': {
        '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) --
- ProfileAssociation (dict) --
  
  Information about the DisassociateProfile request.
  - 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.

AssociateProfile (new)

Link ¶

Associates a Route 53 Profiles profile with a VPC. A VPC can have only one Profile associated with it, but a Profile can be associated with up to 5000 VPCs.

See also: AWS API Documentation

Request Syntax

client.associate_profile(
    Name='string',
    ProfileId='string',
    ResourceId='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

type Name:

string

param Name:

[REQUIRED]

A name for the association.

type ProfileId:

string

param ProfileId:

[REQUIRED]

ID of the Profile.

type ResourceId:

string

param ResourceId:

[REQUIRED]

The ID of the VPC.

type Tags:

list

param Tags:

A list of the tag keys and values that you want to identify the Profile association.

(dict) --

Tag for the Profile.
- Key (string) -- [REQUIRED]
  
  Key associated with the Tag.
- Value (string) -- [REQUIRED]
  
  Value for the Tag.

rtype:

dict

returns:

Response Syntax

{
    'ProfileAssociation': {
        '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) --
- ProfileAssociation (dict) --
  
  The association that you just created. The association has an ID that you can use to identify it in other requests, like update and delete.
  - 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.