Route53Profiles *************** Client ====== class Route53Profiles.Client A low-level client representing Route 53 Profiles With Amazon Route 53 Profiles you can share Route 53 configurations with VPCs and AWS accounts import boto3 client = boto3.client('route53profiles') These are the available methods: * associate_profile * associate_resource_to_profile * can_paginate * close * create_profile * delete_profile * disassociate_profile * disassociate_resource_from_profile * get_paginator * get_profile * get_profile_association * get_profile_resource_association * get_waiter * list_profile_associations * list_profile_resource_associations * list_profiles * list_tags_for_resource * tag_resource * untag_resource * update_profile_resource_association Paginators ========== Paginators are available on a client instance via the "get_paginator" method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide. The available paginators are: * ListProfileAssociations * ListProfileResourceAssociations * ListProfiles Route53Profiles / Paginator / ListProfileAssociations ListProfileAssociations *********************** class Route53Profiles.Paginator.ListProfileAssociations paginator = client.get_paginator('list_profile_associations') paginate(**kwargs) Creates an iterator that will paginate through responses from "Route53Profiles.Client.list_profile_associations()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( ProfileId='string', ResourceId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **ProfileId** (*string*) -- ID of the Profile. * **ResourceId** (*string*) -- ID of the VPC. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { '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) --* * **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. Route53Profiles / Paginator / ListProfileResourceAssociations ListProfileResourceAssociations ******************************* class Route53Profiles.Paginator.ListProfileResourceAssociations paginator = client.get_paginator('list_profile_resource_associations') paginate(**kwargs) Creates an iterator that will paginate through responses from "Route53Profiles.Client.list_profile_resource_associations()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( ProfileId='string', ResourceType='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **ProfileId** (*string*) -- **[REQUIRED]** The ID of the Profile. * **ResourceType** (*string*) -- ID of a resource if you want information on only one type. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { '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) --* * **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. Route53Profiles / Paginator / ListProfiles ListProfiles ************ class Route53Profiles.Paginator.ListProfiles paginator = client.get_paginator('list_profiles') paginate(**kwargs) Creates an iterator that will paginate through responses from "Route53Profiles.Client.list_profiles()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max- items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'ProfileSummaries': [ { 'Arn': 'string', 'Id': 'string', 'Name': 'string', 'ShareStatus': 'NOT_SHARED'|'SHARED_WITH_ME'|'SHARED_BY_ME' }, ] } **Response Structure** * *(dict) --* * **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. Route53Profiles / Client / get_paginator get_paginator ************* Route53Profiles.Client.get_paginator(operation_name) Create a paginator for an operation. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Raises: **OperationNotPageableError** -- Raised if the operation is not pageable. You can use the "client.can_paginate" method to check if an operation is pageable. Return type: "botocore.paginate.Paginator" Returns: A paginator object. Route53Profiles / Client / can_paginate can_paginate ************ Route53Profiles.Client.can_paginate(operation_name) Check if an operation can be paginated. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Returns: "True" if the operation can be paginated, "False" otherwise. Route53Profiles / Client / get_profile_association get_profile_association *********************** Route53Profiles.Client.get_profile_association(**kwargs) 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** response = client.get_profile_association( ProfileAssociationId='string' ) Parameters: **ProfileAssociationId** (*string*) -- **[REQUIRED]** The identifier of the association you want to get information about. Return type: 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. **Exceptions** * "Route53Profiles.Client.exceptions.ResourceNotFoundException" * "Route53Profiles.Client.exceptions.ThrottlingException" * "Route53Profiles.Client.exceptions.ValidationException" * "Route53Profiles.Client.exceptions.AccessDeniedException" Route53Profiles / Client / associate_profile associate_profile ***************** Route53Profiles.Client.associate_profile(**kwargs) 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 1000 of VPCs (and you can request a higher quota). For more information, see https://docs.aws.amazon.com/Route53/late st/DeveloperGuide/DNSLimitations.html#limits-api-entities. See also: AWS API Documentation **Request Syntax** response = client.associate_profile( Name='string', ProfileId='string', ResourceId='string', Tags=[ { 'Key': 'string', 'Value': 'string' }, ] ) Parameters: * **Name** (*string*) -- **[REQUIRED]** A name for the association. * **ProfileId** (*string*) -- **[REQUIRED]** ID of the Profile. * **ResourceId** (*string*) -- **[REQUIRED]** The ID of the VPC. * **Tags** (*list*) -- 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. Return type: 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. **Exceptions** * "Route53Profiles.Client.exceptions.ResourceNotFoundException" * "Route53Profiles.Client.exceptions.ResourceExistsException" * "Route53Profiles.Client.exceptions.LimitExceededException" * "Route53Profiles.Client.exceptions.InvalidParameterException" * "Route53Profiles.Client.exceptions.ThrottlingException" * "Route53Profiles.Client.exceptions.ValidationException" * "Route53Profiles.Client.exceptions.AccessDeniedException" * "Route53Profiles.Client.exceptions.ConflictException" Route53Profiles / Client / list_tags_for_resource list_tags_for_resource ********************** Route53Profiles.Client.list_tags_for_resource(**kwargs) Lists the tags that you associated with the specified resource. See also: AWS API Documentation **Request Syntax** response = client.list_tags_for_resource( ResourceArn='string' ) Parameters: **ResourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) for the resource that you want to list the tags for. Return type: 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) --* **Exceptions** * "Route53Profiles.Client.exceptions.ResourceNotFoundException" * "Route53Profiles.Client.exceptions.ThrottlingException" * "Route53Profiles.Client.exceptions.ValidationException" * "Route53Profiles.Client.exceptions.AccessDeniedException" * "Route53Profiles.Client.exceptions.ConflictException" Route53Profiles / Client / untag_resource untag_resource ************** Route53Profiles.Client.untag_resource(**kwargs) Removes one or more tags from a specified resource. See also: AWS API Documentation **Request Syntax** response = client.untag_resource( ResourceArn='string', TagKeys=[ 'string', ] ) Parameters: * **ResourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) for the resource that you want to remove tags from. * **TagKeys** (*list*) -- **[REQUIRED]** The tags that you want to remove to the specified resource. * *(string) --* Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "Route53Profiles.Client.exceptions.ResourceNotFoundException" * "Route53Profiles.Client.exceptions.ThrottlingException" * "Route53Profiles.Client.exceptions.ValidationException" * "Route53Profiles.Client.exceptions.AccessDeniedException" * "Route53Profiles.Client.exceptions.ConflictException" 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" Route53Profiles / Client / get_waiter get_waiter ********** Route53Profiles.Client.get_waiter(waiter_name) Returns an object that can wait for some condition. Parameters: **waiter_name** (*str*) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters. Returns: The specified waiter object. Return type: "botocore.waiter.Waiter" Route53Profiles / Client / get_profile_resource_association get_profile_resource_association ******************************** Route53Profiles.Client.get_profile_resource_association(**kwargs) Returns information about a specified Route 53 Profile resource association. See also: AWS API Documentation **Request Syntax** response = client.get_profile_resource_association( ProfileResourceAssociationId='string' ) Parameters: **ProfileResourceAssociationId** (*string*) -- **[REQUIRED]** The ID of the profile resource association that you want to get information about. Return type: 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. **Exceptions** * "Route53Profiles.Client.exceptions.ResourceNotFoundException" * "Route53Profiles.Client.exceptions.InvalidParameterException" * "Route53Profiles.Client.exceptions.ThrottlingException" * "Route53Profiles.Client.exceptions.ValidationException" * "Route53Profiles.Client.exceptions.AccessDeniedException" 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" Route53Profiles / Client / associate_resource_to_profile associate_resource_to_profile ***************************** Route53Profiles.Client.associate_resource_to_profile(**kwargs) Associates a DNS reource configuration to a Route 53 Profile. See also: AWS API Documentation **Request Syntax** response = client.associate_resource_to_profile( Name='string', ProfileId='string', ResourceArn='string', ResourceProperties='string' ) Parameters: * **Name** (*string*) -- **[REQUIRED]** Name for the resource association. * **ProfileId** (*string*) -- **[REQUIRED]** ID of the Profile. * **ResourceArn** (*string*) -- **[REQUIRED]** Amazon resource number, ARN, of the DNS resource. * **ResourceProperties** (*string*) -- If you are adding a DNS Firewall rule group, include also a priority. The priority indicates the processing order for the rule groups, starting with the priority assinged the lowest value. The allowed values for priority are between 100 and 9900. Return type: 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. **Exceptions** * "Route53Profiles.Client.exceptions.ResourceNotFoundException" * "Route53Profiles.Client.exceptions.LimitExceededException" * "Route53Profiles.Client.exceptions.InternalServiceErrorException" * "Route53Profiles.Client.exceptions.InvalidParameterException" * "Route53Profiles.Client.exceptions.ThrottlingException" * "Route53Profiles.Client.exceptions.ValidationException" * "Route53Profiles.Client.exceptions.AccessDeniedException" * "Route53Profiles.Client.exceptions.ConflictException" Route53Profiles / Client / create_profile create_profile ************** Route53Profiles.Client.create_profile(**kwargs) Creates an empty Route 53 Profile. See also: AWS API Documentation **Request Syntax** response = client.create_profile( ClientToken='string', Name='string', Tags=[ { 'Key': 'string', 'Value': 'string' }, ] ) Parameters: * **ClientToken** (*string*) -- **[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. * **Name** (*string*) -- **[REQUIRED]** A name for the Profile. * **Tags** (*list*) -- 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. 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) --* 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. **Exceptions** * "Route53Profiles.Client.exceptions.LimitExceededException" * "Route53Profiles.Client.exceptions.InvalidParameterException" * "Route53Profiles.Client.exceptions.ThrottlingException" * "Route53Profiles.Client.exceptions.ValidationException" * "Route53Profiles.Client.exceptions.AccessDeniedException" Route53Profiles / Client / close close ***** Route53Profiles.Client.close() Closes underlying endpoint connections. Route53Profiles / Client / list_profile_resource_associations list_profile_resource_associations ********************************** Route53Profiles.Client.list_profile_resource_associations(**kwargs) Lists all the resource associations for the specified Route 53 Profile. See also: AWS API Documentation **Request Syntax** response = client.list_profile_resource_associations( MaxResults=123, NextToken='string', ProfileId='string', ResourceType='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*) -- **[REQUIRED]** The ID of the Profile. * **ResourceType** (*string*) -- ID of a resource if you want information on only one type. Return type: 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. **Exceptions** * "Route53Profiles.Client.exceptions.ResourceNotFoundException" * "Route53Profiles.Client.exceptions.InternalServiceErrorException" * "Route53Profiles.Client.exceptions.InvalidParameterException" * "Route53Profiles.Client.exceptions.ThrottlingException" * "Route53Profiles.Client.exceptions.ValidationException" * "Route53Profiles.Client.exceptions.AccessDeniedException" * "Route53Profiles.Client.exceptions.InvalidNextTokenException" Route53Profiles / Client / delete_profile delete_profile ************** Route53Profiles.Client.delete_profile(**kwargs) 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** response = client.delete_profile( ProfileId='string' ) Parameters: **ProfileId** (*string*) -- **[REQUIRED]** The ID of the Profile that you want to delete. 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 "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. **Exceptions** * "Route53Profiles.Client.exceptions.ResourceNotFoundException" * "Route53Profiles.Client.exceptions.ThrottlingException" * "Route53Profiles.Client.exceptions.ValidationException" * "Route53Profiles.Client.exceptions.AccessDeniedException" * "Route53Profiles.Client.exceptions.ConflictException" Route53Profiles / Client / disassociate_profile disassociate_profile ******************** Route53Profiles.Client.disassociate_profile(**kwargs) Dissociates a specified Route 53 Profile from the specified VPC. See also: AWS API Documentation **Request Syntax** response = client.disassociate_profile( ProfileId='string', ResourceId='string' ) Parameters: * **ProfileId** (*string*) -- **[REQUIRED]** ID of the Profile. * **ResourceId** (*string*) -- **[REQUIRED]** The ID of the VPC. Return type: 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. **Exceptions** * "Route53Profiles.Client.exceptions.ResourceNotFoundException" * "Route53Profiles.Client.exceptions.LimitExceededException" * "Route53Profiles.Client.exceptions.InvalidParameterException" * "Route53Profiles.Client.exceptions.ThrottlingException" * "Route53Profiles.Client.exceptions.ValidationException" * "Route53Profiles.Client.exceptions.AccessDeniedException" Route53Profiles / Client / disassociate_resource_from_profile disassociate_resource_from_profile ********************************** Route53Profiles.Client.disassociate_resource_from_profile(**kwargs) Dissoaciated a specified resource, from the Route 53 Profile. See also: AWS API Documentation **Request Syntax** response = client.disassociate_resource_from_profile( ProfileId='string', ResourceArn='string' ) Parameters: * **ProfileId** (*string*) -- **[REQUIRED]** The ID of the Profile. * **ResourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the resource. Return type: 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. **Exceptions** * "Route53Profiles.Client.exceptions.ResourceNotFoundException" * "Route53Profiles.Client.exceptions.LimitExceededException" * "Route53Profiles.Client.exceptions.InternalServiceErrorException" * "Route53Profiles.Client.exceptions.InvalidParameterException" * "Route53Profiles.Client.exceptions.ThrottlingException" * "Route53Profiles.Client.exceptions.ValidationException" * "Route53Profiles.Client.exceptions.AccessDeniedException" * "Route53Profiles.Client.exceptions.ConflictException" 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" Route53Profiles / Client / tag_resource tag_resource ************ Route53Profiles.Client.tag_resource(**kwargs) Adds one or more tags to a specified resource. See also: AWS API Documentation **Request Syntax** response = client.tag_resource( ResourceArn='string', Tags={ 'string': 'string' } ) Parameters: * **ResourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) for the resource that you want to add tags to. * **Tags** (*dict*) -- **[REQUIRED]** The tags that you want to add to the specified resource. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "Route53Profiles.Client.exceptions.ResourceNotFoundException" * "Route53Profiles.Client.exceptions.ThrottlingException" * "Route53Profiles.Client.exceptions.ValidationException" * "Route53Profiles.Client.exceptions.AccessDeniedException" Route53Profiles / Client / update_profile_resource_association update_profile_resource_association *********************************** Route53Profiles.Client.update_profile_resource_association(**kwargs) Updates the specified Route 53 Profile resourse association. See also: AWS API Documentation **Request Syntax** response = client.update_profile_resource_association( Name='string', ProfileResourceAssociationId='string', ResourceProperties='string' ) Parameters: * **Name** (*string*) -- Name of the resource association. * **ProfileResourceAssociationId** (*string*) -- **[REQUIRED]** ID of the resource association. * **ResourceProperties** (*string*) -- If you are adding a DNS Firewall rule group, include also a priority. The priority indicates the processing order for the rule groups, starting with the priority assinged the lowest value. The allowed values for priority are between 100 and 9900. Return type: 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. **Exceptions** * "Route53Profiles.Client.exceptions.ResourceNotFoundException" * "Route53Profiles.Client.exceptions.LimitExceededException" * "Route53Profiles.Client.exceptions.InternalServiceErrorException" * "Route53Profiles.Client.exceptions.InvalidParameterException" * "Route53Profiles.Client.exceptions.ThrottlingException" * "Route53Profiles.Client.exceptions.ValidationException" * "Route53Profiles.Client.exceptions.AccessDeniedException" * "Route53Profiles.Client.exceptions.ConflictException"