AWS SDK for PHP 3.x

Client: Aws\Route53Profiles\Route53ProfilesClient

Service ID: route53profiles

Version: 2018-05-10

This page describes the parameters and results for the operations of the Route 53 Profiles (2018-05-10), and shows how to use the Aws\Route53Profiles\Route53ProfilesClient object to call the described operations. This documentation is specific to the 2018-05-10 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

AssociateProfile ( array $params = [] ): Associates a Route 53 Profiles profile with a VPC.
AssociateResourceToProfile ( array $params = [] ): Associates a DNS reource configuration to a Route 53 Profile.
CreateProfile ( array $params = [] ): Creates an empty Route 53 Profile.
DeleteProfile ( array $params = [] ): Deletes the specified Route 53 Profile.
DisassociateProfile ( array $params = [] ): Dissociates a specified Route 53 Profile from the specified VPC.
DisassociateResourceFromProfile ( array $params = [] ): Dissoaciated a specified resource, from the Route 53 Profile.
GetProfile ( array $params = [] ): Returns information about a specified Route 53 Profile, such as whether whether the Profile is shared, and the current status of the Profile.
GetProfileAssociation ( array $params = [] ): Retrieves a Route 53 Profile association for a VPC.
GetProfileResourceAssociation ( array $params = [] ): Returns information about a specified Route 53 Profile resource association.
ListProfileAssociations ( array $params = [] ): Lists all the VPCs that the specified Route 53 Profile is associated with.
ListProfileResourceAssociations ( array $params = [] ): Lists all the resource associations for the specified Route 53 Profile.
ListProfiles ( array $params = [] ): Lists all the Route 53 Profiles associated with your Amazon Web Services account.
ListTagsForResource ( array $params = [] ): Lists the tags that you associated with the specified resource.
TagResource ( array $params = [] ): Adds one or more tags to a specified resource.
UntagResource ( array $params = [] ): Removes one or more tags from a specified resource.
UpdateProfileResourceAssociation ( array $params = [] ): Updates the specified Route 53 Profile resourse association.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

ListProfileAssociations
ListProfileResourceAssociations
ListProfiles

Operations

AssociateProfile

$result = $client->associateProfile([/* ... */]);
$promise = $client->associateProfileAsync([/* ... */]);

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/latest/DeveloperGuide/DNSLimitations.html#limits-api-entities.

Parameter Syntax

$result = $client->associateProfile([
    'Name' => '<string>', // REQUIRED
    'ProfileId' => '<string>', // REQUIRED
    'ResourceId' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members

Name

Required: Yes
Type: string

A name for the association.

ProfileId

Required: Yes
Type: string

ID of the Profile.

ResourceId

Required: Yes
Type: string

The ID of the VPC.

Tags

Type: Array of Tag structures

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

Result Syntax

[
    'ProfileAssociation' => [
        'CreationTime' => <DateTime>,
        'Id' => '<string>',
        'ModificationTime' => <DateTime>,
        'Name' => '<string>',
        'OwnerId' => '<string>',
        'ProfileId' => '<string>',
        'ResourceId' => '<string>',
        'Status' => 'COMPLETE|DELETING|UPDATING|CREATING|DELETED|FAILED',
        'StatusMessage' => '<string>',
    ],
]

Result Details

Members

ProfileAssociation

Type: ProfileAssociation structure

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.

Errors

ResourceNotFoundException:
The resource you are associating is not found.
ResourceExistsException:
The resource you are trying to associate, has already been associated.
LimitExceededException:
The request caused one or more limits to be exceeded.
InvalidParameterException:
One or more parameters in this request are not valid.
ThrottlingException:
The request was throttled. Try again in a few minutes.
ValidationException:
You have provided an invalid command.
AccessDeniedException:
The current account doesn't have the IAM permissions required to perform the specified operation.
ConflictException:
The request you submitted conflicts with an existing request.

AssociateResourceToProfile

$result = $client->associateResourceToProfile([/* ... */]);
$promise = $client->associateResourceToProfileAsync([/* ... */]);

Associates a DNS reource configuration to a Route 53 Profile.

Parameter Syntax

$result = $client->associateResourceToProfile([
    'Name' => '<string>', // REQUIRED
    'ProfileId' => '<string>', // REQUIRED
    'ResourceArn' => '<string>', // REQUIRED
    'ResourceProperties' => '<string>',
]);

Parameter Details

Members

Name

Required: Yes
Type: string

Name for the resource association.

ProfileId

Required: Yes
Type: string

ID of the Profile.

ResourceArn

Required: Yes
Type: string

Amazon resource number, ARN, of the DNS resource.

ResourceProperties

Type: 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.

Result Syntax

[
    'ProfileResourceAssociation' => [
        'CreationTime' => <DateTime>,
        'Id' => '<string>',
        'ModificationTime' => <DateTime>,
        'Name' => '<string>',
        'OwnerId' => '<string>',
        'ProfileId' => '<string>',
        'ResourceArn' => '<string>',
        'ResourceProperties' => '<string>',
        'ResourceType' => '<string>',
        'Status' => 'COMPLETE|DELETING|UPDATING|CREATING|DELETED|FAILED',
        'StatusMessage' => '<string>',
    ],
]

Result Details

Members

ProfileResourceAssociation

Type: ProfileResourceAssociation structure

Infromation about the AssociateResourceToProfile, including a status message.

Errors

ResourceNotFoundException:
The resource you are associating is not found.
LimitExceededException:
The request caused one or more limits to be exceeded.
InternalServiceErrorException:
An internal server error occured. Retry your request.
InvalidParameterException:
One or more parameters in this request are not valid.
ThrottlingException:
The request was throttled. Try again in a few minutes.
ValidationException:
You have provided an invalid command.
AccessDeniedException:
The current account doesn't have the IAM permissions required to perform the specified operation.
ConflictException:
The request you submitted conflicts with an existing request.

CreateProfile

$result = $client->createProfile([/* ... */]);
$promise = $client->createProfileAsync([/* ... */]);

Creates an empty Route 53 Profile.

Parameter Syntax

$result = $client->createProfile([
    'ClientToken' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members

ClientToken

Required: Yes
Type: string

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.

Name

Required: Yes
Type: string

A name for the Profile.

Tags

Type: Array of Tag structures

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

Result Syntax

[
    'Profile' => [
        'Arn' => '<string>',
        'ClientToken' => '<string>',
        'CreationTime' => <DateTime>,
        'Id' => '<string>',
        'ModificationTime' => <DateTime>,
        'Name' => '<string>',
        'OwnerId' => '<string>',
        'ShareStatus' => 'NOT_SHARED|SHARED_WITH_ME|SHARED_BY_ME',
        'Status' => 'COMPLETE|DELETING|UPDATING|CREATING|DELETED|FAILED',
        'StatusMessage' => '<string>',
    ],
]

Result Details

Members

Profile

Type: Profile structure

The Profile that you just created.

Errors

LimitExceededException:
The request caused one or more limits to be exceeded.
InvalidParameterException:
One or more parameters in this request are not valid.
ThrottlingException:
The request was throttled. Try again in a few minutes.
ValidationException:
You have provided an invalid command.
AccessDeniedException:
The current account doesn't have the IAM permissions required to perform the specified operation.

DeleteProfile

$result = $client->deleteProfile([/* ... */]);
$promise = $client->deleteProfileAsync([/* ... */]);

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

Parameter Syntax

$result = $client->deleteProfile([
    'ProfileId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ProfileId

Required: Yes
Type: string

The ID of the Profile that you want to delete.

Result Syntax

[
    'Profile' => [
        'Arn' => '<string>',
        'ClientToken' => '<string>',
        'CreationTime' => <DateTime>,
        'Id' => '<string>',
        'ModificationTime' => <DateTime>,
        'Name' => '<string>',
        'OwnerId' => '<string>',
        'ShareStatus' => 'NOT_SHARED|SHARED_WITH_ME|SHARED_BY_ME',
        'Status' => 'COMPLETE|DELETING|UPDATING|CREATING|DELETED|FAILED',
        'StatusMessage' => '<string>',
    ],
]

Result Details

Members

Profile

Type: Profile structure

Information about the DeleteProfile request, including the status of the request.

Errors

ResourceNotFoundException:
The resource you are associating is not found.
ThrottlingException:
The request was throttled. Try again in a few minutes.
ValidationException:
You have provided an invalid command.
AccessDeniedException:
The current account doesn't have the IAM permissions required to perform the specified operation.
ConflictException:
The request you submitted conflicts with an existing request.

DisassociateProfile

$result = $client->disassociateProfile([/* ... */]);
$promise = $client->disassociateProfileAsync([/* ... */]);

Dissociates a specified Route 53 Profile from the specified VPC.

Parameter Syntax

$result = $client->disassociateProfile([
    'ProfileId' => '<string>', // REQUIRED
    'ResourceId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ProfileId

Required: Yes
Type: string

ID of the Profile.

ResourceId

Required: Yes
Type: string

The ID of the VPC.

Result Syntax

[
    'ProfileAssociation' => [
        'CreationTime' => <DateTime>,
        'Id' => '<string>',
        'ModificationTime' => <DateTime>,
        'Name' => '<string>',
        'OwnerId' => '<string>',
        'ProfileId' => '<string>',
        'ResourceId' => '<string>',
        'Status' => 'COMPLETE|DELETING|UPDATING|CREATING|DELETED|FAILED',
        'StatusMessage' => '<string>',
    ],
]

Result Details

Members

ProfileAssociation

Type: ProfileAssociation structure

Information about the DisassociateProfile request.

Errors

ResourceNotFoundException:
The resource you are associating is not found.
LimitExceededException:
The request caused one or more limits to be exceeded.
InvalidParameterException:
One or more parameters in this request are not valid.
ThrottlingException:
The request was throttled. Try again in a few minutes.
ValidationException:
You have provided an invalid command.
AccessDeniedException:
The current account doesn't have the IAM permissions required to perform the specified operation.

DisassociateResourceFromProfile

$result = $client->disassociateResourceFromProfile([/* ... */]);
$promise = $client->disassociateResourceFromProfileAsync([/* ... */]);

Dissoaciated a specified resource, from the Route 53 Profile.

Parameter Syntax

$result = $client->disassociateResourceFromProfile([
    'ProfileId' => '<string>', // REQUIRED
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

ProfileId

Required: Yes
Type: string

The ID of the Profile.

ResourceArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the resource.

Result Syntax

[
    'ProfileResourceAssociation' => [
        'CreationTime' => <DateTime>,
        'Id' => '<string>',
        'ModificationTime' => <DateTime>,
        'Name' => '<string>',
        'OwnerId' => '<string>',
        'ProfileId' => '<string>',
        'ResourceArn' => '<string>',
        'ResourceProperties' => '<string>',
        'ResourceType' => '<string>',
        'Status' => 'COMPLETE|DELETING|UPDATING|CREATING|DELETED|FAILED',
        'StatusMessage' => '<string>',
    ],
]

Result Details

Members

ProfileResourceAssociation

Type: ProfileResourceAssociation structure

Information about the DisassociateResourceFromProfile request, including the status of the request.

Errors

ResourceNotFoundException:
The resource you are associating is not found.
LimitExceededException:
The request caused one or more limits to be exceeded.
InternalServiceErrorException:
An internal server error occured. Retry your request.
InvalidParameterException:
One or more parameters in this request are not valid.
ThrottlingException:
The request was throttled. Try again in a few minutes.
ValidationException:
You have provided an invalid command.
AccessDeniedException:
The current account doesn't have the IAM permissions required to perform the specified operation.
ConflictException:
The request you submitted conflicts with an existing request.

GetProfile

$result = $client->getProfile([/* ... */]);
$promise = $client->getProfileAsync([/* ... */]);

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

Parameter Syntax

$result = $client->getProfile([
    'ProfileId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ProfileId

Required: Yes
Type: string

ID of the Profile.

Result Syntax

[
    'Profile' => [
        'Arn' => '<string>',
        'ClientToken' => '<string>',
        'CreationTime' => <DateTime>,
        'Id' => '<string>',
        'ModificationTime' => <DateTime>,
        'Name' => '<string>',
        'OwnerId' => '<string>',
        'ShareStatus' => 'NOT_SHARED|SHARED_WITH_ME|SHARED_BY_ME',
        'Status' => 'COMPLETE|DELETING|UPDATING|CREATING|DELETED|FAILED',
        'StatusMessage' => '<string>',
    ],
]

Result Details

Members

Profile

Type: Profile structure

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

Errors

ResourceNotFoundException:
The resource you are associating is not found.
ThrottlingException:
The request was throttled. Try again in a few minutes.
ValidationException:
You have provided an invalid command.
AccessDeniedException:
The current account doesn't have the IAM permissions required to perform the specified operation.

GetProfileAssociation

$result = $client->getProfileAssociation([/* ... */]);
$promise = $client->getProfileAssociationAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getProfileAssociation([
    'ProfileAssociationId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ProfileAssociationId

Required: Yes
Type: string

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

Result Syntax

[
    'ProfileAssociation' => [
        'CreationTime' => <DateTime>,
        'Id' => '<string>',
        'ModificationTime' => <DateTime>,
        'Name' => '<string>',
        'OwnerId' => '<string>',
        'ProfileId' => '<string>',
        'ResourceId' => '<string>',
        'Status' => 'COMPLETE|DELETING|UPDATING|CREATING|DELETED|FAILED',
        'StatusMessage' => '<string>',
    ],
]

Result Details

Members

ProfileAssociation

Type: ProfileAssociation structure

Information about the Profile association that you specified in a GetProfileAssociation request.

Errors

ResourceNotFoundException:
The resource you are associating is not found.
ThrottlingException:
The request was throttled. Try again in a few minutes.
ValidationException:
You have provided an invalid command.
AccessDeniedException:
The current account doesn't have the IAM permissions required to perform the specified operation.

GetProfileResourceAssociation

$result = $client->getProfileResourceAssociation([/* ... */]);
$promise = $client->getProfileResourceAssociationAsync([/* ... */]);

Returns information about a specified Route 53 Profile resource association.

Parameter Syntax

$result = $client->getProfileResourceAssociation([
    'ProfileResourceAssociationId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ProfileResourceAssociationId

Required: Yes
Type: string

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

Result Syntax

[
    'ProfileResourceAssociation' => [
        'CreationTime' => <DateTime>,
        'Id' => '<string>',
        'ModificationTime' => <DateTime>,
        'Name' => '<string>',
        'OwnerId' => '<string>',
        'ProfileId' => '<string>',
        'ResourceArn' => '<string>',
        'ResourceProperties' => '<string>',
        'ResourceType' => '<string>',
        'Status' => 'COMPLETE|DELETING|UPDATING|CREATING|DELETED|FAILED',
        'StatusMessage' => '<string>',
    ],
]

Result Details

Members

ProfileResourceAssociation

Type: ProfileResourceAssociation structure

Information about the Profile resource association that you specified in a GetProfileResourceAssociation request.

Errors

ResourceNotFoundException:
The resource you are associating is not found.
InvalidParameterException:
One or more parameters in this request are not valid.
ThrottlingException:
The request was throttled. Try again in a few minutes.
ValidationException:
You have provided an invalid command.
AccessDeniedException:
The current account doesn't have the IAM permissions required to perform the specified operation.

ListProfileAssociations

$result = $client->listProfileAssociations([/* ... */]);
$promise = $client->listProfileAssociationsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listProfileAssociations([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ProfileId' => '<string>',
    'ResourceId' => '<string>',
]);

Parameter Details

Members

MaxResults

Type: int

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

Type: 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

Type: string

ID of the Profile.

ResourceId

Type: string

ID of the VPC.

Result Syntax

[
    'NextToken' => '<string>',
    'ProfileAssociations' => [
        [
            'CreationTime' => <DateTime>,
            'Id' => '<string>',
            'ModificationTime' => <DateTime>,
            'Name' => '<string>',
            'OwnerId' => '<string>',
            'ProfileId' => '<string>',
            'ResourceId' => '<string>',
            'Status' => 'COMPLETE|DELETING|UPDATING|CREATING|DELETED|FAILED',
            'StatusMessage' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: 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

Type: Array of ProfileAssociation structures

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

Errors

InvalidParameterException:
One or more parameters in this request are not valid.
ThrottlingException:
The request was throttled. Try again in a few minutes.
ValidationException:
You have provided an invalid command.
AccessDeniedException:
The current account doesn't have the IAM permissions required to perform the specified operation.
InvalidNextTokenException:
The NextToken you provided isn;t valid.

ListProfileResourceAssociations

$result = $client->listProfileResourceAssociations([/* ... */]);
$promise = $client->listProfileResourceAssociationsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listProfileResourceAssociations([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ProfileId' => '<string>', // REQUIRED
    'ResourceType' => '<string>',
]);

Parameter Details

Members

MaxResults

Type: int

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

NextToken

Type: string

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

ProfileId

Required: Yes
Type: string

The ID of the Profile.

ResourceType

Type: string

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

Result Syntax

[
    'NextToken' => '<string>',
    'ProfileResourceAssociations' => [
        [
            'CreationTime' => <DateTime>,
            'Id' => '<string>',
            'ModificationTime' => <DateTime>,
            'Name' => '<string>',
            'OwnerId' => '<string>',
            'ProfileId' => '<string>',
            'ResourceArn' => '<string>',
            'ResourceProperties' => '<string>',
            'ResourceType' => '<string>',
            'Status' => 'COMPLETE|DELETING|UPDATING|CREATING|DELETED|FAILED',
            'StatusMessage' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: 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

Type: Array of ProfileResourceAssociation structures

Information about the profile resource association that you specified in a GetProfileResourceAssociation request.

Errors

ResourceNotFoundException:
The resource you are associating is not found.
InternalServiceErrorException:
An internal server error occured. Retry your request.
InvalidParameterException:
One or more parameters in this request are not valid.
ThrottlingException:
The request was throttled. Try again in a few minutes.
ValidationException:
You have provided an invalid command.
AccessDeniedException:
The current account doesn't have the IAM permissions required to perform the specified operation.
InvalidNextTokenException:
The NextToken you provided isn;t valid.

ListProfiles

$result = $client->listProfiles([/* ... */]);
$promise = $client->listProfilesAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listProfiles([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

MaxResults

Type: int

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

NextToken

Type: string

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

Result Syntax

[
    'NextToken' => '<string>',
    'ProfileSummaries' => [
        [
            'Arn' => '<string>',
            'Id' => '<string>',
            'Name' => '<string>',
            'ShareStatus' => 'NOT_SHARED|SHARED_WITH_ME|SHARED_BY_ME',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: 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

Type: Array of ProfileSummary structures

Summary information about the Profiles.

Errors

InvalidParameterException:
One or more parameters in this request are not valid.
ThrottlingException:
The request was throttled. Try again in a few minutes.
ValidationException:
You have provided an invalid command.
AccessDeniedException:
The current account doesn't have the IAM permissions required to perform the specified operation.
InvalidNextTokenException:
The NextToken you provided isn;t valid.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Lists the tags that you associated with the specified resource.

Parameter Syntax

$result = $client->listTagsForResource([
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

ResourceArn

Required: Yes
Type: string

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

Result Syntax

[
    'Tags' => ['<string>', ...],
]

Result Details

Members

Tags

Required: Yes
Type: Associative array of custom strings keys (TagKey) to strings

The tags that are associated with the resource that you specified in the ListTagsForResource request.

Errors

ResourceNotFoundException:
The resource you are associating is not found.
ThrottlingException:
The request was throttled. Try again in a few minutes.
ValidationException:
You have provided an invalid command.
AccessDeniedException:
The current account doesn't have the IAM permissions required to perform the specified operation.
ConflictException:
The request you submitted conflicts with an existing request.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Adds one or more tags to a specified resource.

Parameter Syntax

$result = $client->tagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

ResourceArn

Required: Yes
Type: string

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

Tags

Required: Yes
Type: Associative array of custom strings keys (TagKey) to strings

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:
The resource you are associating is not found.
ThrottlingException:
The request was throttled. Try again in a few minutes.
ValidationException:
You have provided an invalid command.
AccessDeniedException:
The current account doesn't have the IAM permissions required to perform the specified operation.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes one or more tags from a specified resource.

Parameter Syntax

$result = $client->untagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'TagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

ResourceArn

Required: Yes
Type: string

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

TagKeys

Required: Yes
Type: Array of strings

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:
The resource you are associating is not found.
ThrottlingException:
The request was throttled. Try again in a few minutes.
ValidationException:
You have provided an invalid command.
AccessDeniedException:
The current account doesn't have the IAM permissions required to perform the specified operation.
ConflictException:
The request you submitted conflicts with an existing request.

UpdateProfileResourceAssociation

$result = $client->updateProfileResourceAssociation([/* ... */]);
$promise = $client->updateProfileResourceAssociationAsync([/* ... */]);

Updates the specified Route 53 Profile resourse association.

Parameter Syntax

$result = $client->updateProfileResourceAssociation([
    'Name' => '<string>',
    'ProfileResourceAssociationId' => '<string>', // REQUIRED
    'ResourceProperties' => '<string>',
]);

Parameter Details

Members

Name

Type: string

Name of the resource association.

ProfileResourceAssociationId

Required: Yes
Type: string

ID of the resource association.

ResourceProperties

Type: 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.

Result Syntax

[
    'ProfileResourceAssociation' => [
        'CreationTime' => <DateTime>,
        'Id' => '<string>',
        'ModificationTime' => <DateTime>,
        'Name' => '<string>',
        'OwnerId' => '<string>',
        'ProfileId' => '<string>',
        'ResourceArn' => '<string>',
        'ResourceProperties' => '<string>',
        'ResourceType' => '<string>',
        'Status' => 'COMPLETE|DELETING|UPDATING|CREATING|DELETED|FAILED',
        'StatusMessage' => '<string>',
    ],
]

Result Details

Members

ProfileResourceAssociation

Type: ProfileResourceAssociation structure

Information about the UpdateProfileResourceAssociation request, including a status message.

Errors

ResourceNotFoundException:
The resource you are associating is not found.
LimitExceededException:
The request caused one or more limits to be exceeded.
InternalServiceErrorException:
An internal server error occured. Retry your request.
InvalidParameterException:
One or more parameters in this request are not valid.
ThrottlingException:
The request was throttled. Try again in a few minutes.
ValidationException:
You have provided an invalid command.
AccessDeniedException:
The current account doesn't have the IAM permissions required to perform the specified operation.
ConflictException:
The request you submitted conflicts with an existing request.

Type: string

The parameter field name for the invalid parameter exception.

Message

Required: Yes
Type: string

LimitExceededException

Description

The request caused one or more limits to be exceeded.

Members

Message

Type: string

ResourceType

Type: string

The resource type that caused the limits to be exceeded.

Profile

Description

A complex type that includes settings for a Route 53 Profile.

Members

Arn

Type: string

The Amazon Resource Name (ARN) of the Profile.

ClientToken

Type: string

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

CreationTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

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

Id

Type: string

ID of the Profile.

ModificationTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

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

Name

Type: string

Name of the Profile.

OwnerId

Type: string

Amazon Web Services account ID of the Profile owner.

ShareStatus

Type: string

Sharing status for the Profile.

Status

Type: string

The status for the Profile.

StatusMessage

Type: string

Status message that includes additiona information about the Profile.

ProfileAssociation

Description

An association between a Route 53 Profile and a VPC.

Members

CreationTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

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

Id

Type: string

ID of the Profile association.

ModificationTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

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

Name

Type: string

Name of the Profile association.

OwnerId

Type: string

Amazon Web Services account ID of the Profile association owner.

ProfileId

Type: string

ID of the Profile.

ResourceId

Type: string

The Amazon Resource Name (ARN) of the VPC.

Status

Type: string

Status of the Profile association.

StatusMessage

Type: string

Additional information about the Profile association.

ProfileResourceAssociation

Description

The association between a Route 53 Profile and resources.

Members

CreationTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

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

Id

Type: string

ID of the Profile resource association.

ModificationTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

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

Name

Type: string

Name of the Profile resource association.

OwnerId

Type: string

Amazon Web Services account ID of the Profile resource association owner.

ProfileId

Type: string

Profile ID of the Profile that the resources are associated with.

ResourceArn

Type: string

The Amazon Resource Name (ARN) of the resource association.

ResourceProperties

Type: string

If the DNS resource is a DNS Firewall rule group, this indicates the priority.

ResourceType

Type: string

Resource type, such as a private hosted zone, or DNS Firewall rule group.

Status

Type: string

Status of the Profile resource association.

StatusMessage

Type: string

Additional information about the Profile resource association.

ProfileSummary

Description

Summary information about a Route 53 Profile.

Members

Arn

Type: string

The Amazon Resource Name (ARN) of the Profile.

Id

Type: string

ID of the Profile.

Name

Type: string

Name of the Profile.

ShareStatus

Type: string

Share status of the Profile.

ResourceExistsException

Description

The resource you are trying to associate, has already been associated.

Members

Message

Type: string

ResourceType

Type: string

The resource type that caused the resource exists exception.

ResourceNotFoundException

Description

The resource you are associating is not found.

Members

Message

Type: string

ResourceType

Type: string

The resource type that caused the resource not found exception.

ThrottlingException

Description

The request was throttled. Try again in a few minutes.

Members

Message

Type: string

ValidationException

Description

You have provided an invalid command.

Members

Message

Type: string

Route 53 Profiles 2018-05-10

Operation Summary

Paginators

Operations

AssociateProfile

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

AssociateResourceToProfile

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateProfile

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DeleteProfile

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DisassociateProfile

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DisassociateResourceFromProfile

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

GetProfile

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

GetProfileAssociation

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

GetProfileResourceAssociation

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

ListProfileAssociations

Parameter Syntax

Parameter Details

Members