SDK for PHP 3.x

Client: Aws\Route53RecoveryReadiness\Route53RecoveryReadinessClient
Service ID: route53-recovery-readiness
Version: 2019-12-02

This page describes the parameters and results for the operations of the AWS Route53 Recovery Readiness (2019-12-02), and shows how to use the Aws\Route53RecoveryReadiness\Route53RecoveryReadinessClient object to call the described operations. This documentation is specific to the 2019-12-02 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 */).

CreateCell ( array $params = [] )
Creates a cell in an account.
CreateCrossAccountAuthorization ( array $params = [] )
Creates a cross-account readiness authorization.
CreateReadinessCheck ( array $params = [] )
Creates a readiness check in an account.
CreateRecoveryGroup ( array $params = [] )
Creates a recovery group in an account.
CreateResourceSet ( array $params = [] )
Creates a resource set.
DeleteCell ( array $params = [] )
Delete a cell.
DeleteCrossAccountAuthorization ( array $params = [] )
Deletes cross account readiness authorization.
DeleteReadinessCheck ( array $params = [] )
Deletes a readiness check.
DeleteRecoveryGroup ( array $params = [] )
Deletes a recovery group.
DeleteResourceSet ( array $params = [] )
Deletes a resource set.
GetArchitectureRecommendations ( array $params = [] )
Gets recommendations about architecture designs for improving resiliency for an application, based on a recovery group.
GetCell ( array $params = [] )
Gets information about a cell including cell name, cell Amazon Resource Name (ARN), ARNs of nested cells for this cell, and a list of those cell ARNs with their associated recovery group ARNs.
GetCellReadinessSummary ( array $params = [] )
Gets readiness for a cell.
GetReadinessCheck ( array $params = [] )
Gets details about a readiness check.
GetReadinessCheckResourceStatus ( array $params = [] )
Gets individual readiness status for a readiness check.
GetReadinessCheckStatus ( array $params = [] )
Gets the readiness status for an individual readiness check.
GetRecoveryGroup ( array $params = [] )
Gets details about a recovery group, including a list of the cells that are included in it.
GetRecoveryGroupReadinessSummary ( array $params = [] )
Displays a summary of information about a recovery group's readiness status.
GetResourceSet ( array $params = [] )
Displays the details about a resource set, including a list of the resources in the set.
ListCells ( array $params = [] )
Lists the cells for an account.
ListCrossAccountAuthorizations ( array $params = [] )
Lists the cross-account readiness authorizations that are in place for an account.
ListReadinessChecks ( array $params = [] )
Lists the readiness checks for an account.
ListRecoveryGroups ( array $params = [] )
Lists the recovery groups in an account.
ListResourceSets ( array $params = [] )
Lists the resource sets in an account.
ListRules ( array $params = [] )
Lists all readiness rules, or lists the readiness rules for a specific resource type.
ListTagsForResources ( array $params = [] )
Lists the tags for a resource.
TagResource ( array $params = [] )
Adds a tag to a resource.
UntagResource ( array $params = [] )
Removes a tag from a resource.
UpdateCell ( array $params = [] )
Updates a cell to replace the list of nested cells with a new list of nested cells.
UpdateReadinessCheck ( array $params = [] )
Updates a readiness check.
UpdateRecoveryGroup ( array $params = [] )
Updates a recovery group.
UpdateResourceSet ( array $params = [] )
Updates a resource set.

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:

ListReadinessChecks
ListResourceSets
ListCells
ListRecoveryGroups
ListRules
ListCrossAccountAuthorizations
GetCellReadinessSummary
GetRecoveryGroupReadinessSummary
GetReadinessCheckStatus
GetReadinessCheckResourceStatus

Operations

CreateCell

$result = $client->createCell([/* ... */]);
$promise = $client->createCellAsync([/* ... */]);

Creates a cell in an account.

Parameter Syntax

$result = $client->createCell([
    'CellName' => '<string>', // REQUIRED
    'Cells' => ['<string>', ...],
    'Tags' => ['<string>', ...],
]);

Parameter Details

Members
CellName
Required: Yes
Type: string
Cells
Type: Array of strings
Tags
Type: Associative array of custom strings keys (__string) to strings

A collection of tags associated with a resource.

Result Syntax

[
    'CellArn' => '<string>',
    'CellName' => '<string>',
    'Cells' => ['<string>', ...],
    'ParentReadinessScopes' => ['<string>', ...],
    'Tags' => ['<string>', ...],
]

Result Details

Members
CellArn
Type: string
CellName
Type: string
Cells
Type: Array of strings
ParentReadinessScopes
Type: Array of strings
Tags
Type: Associative array of custom strings keys (__string) to strings

A collection of tags associated with a resource.

Errors

ThrottlingException:

This error does not currently have a description.

ValidationException:

This error does not currently have a description.

InternalServerException:

This error does not currently have a description.

ConflictException:

This error does not currently have a description.

AccessDeniedException:

This error does not currently have a description.

CreateCrossAccountAuthorization

$result = $client->createCrossAccountAuthorization([/* ... */]);
$promise = $client->createCrossAccountAuthorizationAsync([/* ... */]);

Creates a cross-account readiness authorization. This lets you authorize another account to work with Route 53 Application Recovery Controller, for example, to check the readiness status of resources in a separate account.

Parameter Syntax

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

Parameter Details

Members
CrossAccountAuthorization
Required: Yes
Type: string

CrossAccountAuthorization

Result Syntax

[
    'CrossAccountAuthorization' => '<string>',
]

Result Details

Members
CrossAccountAuthorization
Type: string

CrossAccountAuthorization

Errors

ThrottlingException:

This error does not currently have a description.

ValidationException:

This error does not currently have a description.

InternalServerException:

This error does not currently have a description.

ConflictException:

This error does not currently have a description.

AccessDeniedException:

This error does not currently have a description.

CreateReadinessCheck

$result = $client->createReadinessCheck([/* ... */]);
$promise = $client->createReadinessCheckAsync([/* ... */]);

Creates a readiness check in an account. A readiness check monitors a resource set in your application, such as a set of Amazon Aurora instances, that Application Recovery Controller is auditing recovery readiness for. The audits run once every minute on every resource that's associated with a readiness check.

Parameter Syntax

$result = $client->createReadinessCheck([
    'ReadinessCheckName' => '<string>', // REQUIRED
    'ResourceSetName' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...],
]);

Parameter Details

Members
ReadinessCheckName
Required: Yes
Type: string
ResourceSetName
Required: Yes
Type: string
Tags
Type: Associative array of custom strings keys (__string) to strings

A collection of tags associated with a resource.

Result Syntax

[
    'ReadinessCheckArn' => '<string>',
    'ReadinessCheckName' => '<string>',
    'ResourceSet' => '<string>',
    'Tags' => ['<string>', ...],
]

Result Details

Members
ReadinessCheckArn
Type: string
ReadinessCheckName
Type: string
ResourceSet
Type: string
Tags
Type: Associative array of custom strings keys (__string) to strings

A collection of tags associated with a resource.

Errors

ThrottlingException:

This error does not currently have a description.

ValidationException:

This error does not currently have a description.

InternalServerException:

This error does not currently have a description.

ConflictException:

This error does not currently have a description.

AccessDeniedException:

This error does not currently have a description.

CreateRecoveryGroup

$result = $client->createRecoveryGroup([/* ... */]);
$promise = $client->createRecoveryGroupAsync([/* ... */]);

Creates a recovery group in an account. A recovery group corresponds to an application and includes a list of the cells that make up the application.

Parameter Syntax

$result = $client->createRecoveryGroup([
    'Cells' => ['<string>', ...],
    'RecoveryGroupName' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...],
]);

Parameter Details

Members
Cells
Type: Array of strings
RecoveryGroupName
Required: Yes
Type: string
Tags
Type: Associative array of custom strings keys (__string) to strings

A collection of tags associated with a resource.

Result Syntax

[
    'Cells' => ['<string>', ...],
    'RecoveryGroupArn' => '<string>',
    'RecoveryGroupName' => '<string>',
    'Tags' => ['<string>', ...],
]

Result Details

Members
Cells
Type: Array of strings
RecoveryGroupArn
Type: string
RecoveryGroupName
Type: string
Tags
Type: Associative array of custom strings keys (__string) to strings

A collection of tags associated with a resource.

Errors

ThrottlingException:

This error does not currently have a description.

ValidationException:

This error does not currently have a description.

InternalServerException:

This error does not currently have a description.

ConflictException:

This error does not currently have a description.

AccessDeniedException:

This error does not currently have a description.

CreateResourceSet

$result = $client->createResourceSet([/* ... */]);
$promise = $client->createResourceSetAsync([/* ... */]);

Creates a resource set. A resource set is a set of resources of one type that span multiple cells. You can associate a resource set with a readiness check to monitor the resources for failover readiness.

Parameter Syntax

$result = $client->createResourceSet([
    'ResourceSetName' => '<string>', // REQUIRED
    'ResourceSetType' => '<string>', // REQUIRED
    'Resources' => [ // REQUIRED
        [
            'ComponentId' => '<string>',
            'DnsTargetResource' => [
                'DomainName' => '<string>',
                'HostedZoneArn' => '<string>',
                'RecordSetId' => '<string>',
                'RecordType' => '<string>',
                'TargetResource' => [
                    'NLBResource' => [
                        'Arn' => '<string>',
                    ],
                    'R53Resource' => [
                        'DomainName' => '<string>',
                        'RecordSetId' => '<string>',
                    ],
                ],
            ],
            'ReadinessScopes' => ['<string>', ...],
            'ResourceArn' => '<string>',
        ],
        // ...
    ],
    'Tags' => ['<string>', ...],
]);

Parameter Details

Members
ResourceSetName
Required: Yes
Type: string
ResourceSetType
Required: Yes
Type: string
Resources
Required: Yes
Type: Array of Resource structures
Tags
Type: Associative array of custom strings keys (__string) to strings

A collection of tags associated with a resource.

Result Syntax

[
    'ResourceSetArn' => '<string>',
    'ResourceSetName' => '<string>',
    'ResourceSetType' => '<string>',
    'Resources' => [
        [
            'ComponentId' => '<string>',
            'DnsTargetResource' => [
                'DomainName' => '<string>',
                'HostedZoneArn' => '<string>',
                'RecordSetId' => '<string>',
                'RecordType' => '<string>',
                'TargetResource' => [
                    'NLBResource' => [
                        'Arn' => '<string>',
                    ],
                    'R53Resource' => [
                        'DomainName' => '<string>',
                        'RecordSetId' => '<string>',
                    ],
                ],
            ],
            'ReadinessScopes' => ['<string>', ...],
            'ResourceArn' => '<string>',
        ],
        // ...
    ],
    'Tags' => ['<string>', ...],
]

Result Details

Members
ResourceSetArn
Type: string
ResourceSetName
Type: string
ResourceSetType
Type: string
Resources
Type: Array of Resource structures
Tags
Type: Associative array of custom strings keys (__string) to strings

A collection of tags associated with a resource.

Errors

ThrottlingException:

This error does not currently have a description.

ValidationException:

This error does not currently have a description.

InternalServerException:

This error does not currently have a description.

ConflictException:

This error does not currently have a description.

AccessDeniedException:

This error does not currently have a description.

DeleteCell

$result = $client->deleteCell([/* ... */]);
$promise = $client->deleteCellAsync([/* ... */]);

Delete a cell. When successful, the response code is 204, with no response body.

Parameter Syntax

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

Parameter Details

Members
CellName
Required: Yes
Type: string

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:

This error does not currently have a description.

ThrottlingException:

This error does not currently have a description.

ValidationException:

This error does not currently have a description.

InternalServerException:

This error does not currently have a description.

AccessDeniedException:

This error does not currently have a description.

DeleteCrossAccountAuthorization

$result = $client->deleteCrossAccountAuthorization([/* ... */]);
$promise = $client->deleteCrossAccountAuthorizationAsync([/* ... */]);

Deletes cross account readiness authorization.

Parameter Syntax

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

Parameter Details

Members
CrossAccountAuthorization
Required: Yes
Type: string

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ThrottlingException:

This error does not currently have a description.

ValidationException:

This error does not currently have a description.

InternalServerException:

This error does not currently have a description.

AccessDeniedException:

This error does not currently have a description.

DeleteReadinessCheck

$result = $client->deleteReadinessCheck([/* ... */]);
$promise = $client->deleteReadinessCheckAsync([/* ... */]);

Deletes a readiness check.

Parameter Syntax

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

Parameter Details

Members
ReadinessCheckName
Required: Yes
Type: string

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:

This error does not currently have a description.

ThrottlingException:

This error does not currently have a description.

ValidationException:

This error does not currently have a description.

InternalServerException:

This error does not currently have a description.

AccessDeniedException:

This error does not currently have a description.

DeleteRecoveryGroup

$result = $client->deleteRecoveryGroup([/* ... */]);
$promise = $client->deleteRecoveryGroupAsync([/* ... */]);

Deletes a recovery group.

Parameter Syntax

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

Parameter Details

Members
RecoveryGroupName
Required: Yes
Type: string

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:

This error does not currently have a description.

ThrottlingException:

This error does not currently have a description.

ValidationException:

This error does not currently have a description.

InternalServerException:

This error does not currently have a description.

AccessDeniedException:

This error does not currently have a description.

DeleteResourceSet

$result = $client->deleteResourceSet([/* ... */]);
$promise = $client->deleteResourceSetAsync([/* ... */]);

Deletes a resource set.

Parameter Syntax

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

Parameter Details

Members
ResourceSetName
Required: Yes
Type: string

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:

This error does not currently have a description.

ThrottlingException:

This error does not currently have a description.

ValidationException:

This error does not currently have a description.

InternalServerException:

This error does not currently have a description.

AccessDeniedException:

This error does not currently have a description.

GetArchitectureRecommendations

$result = $client->getArchitectureRecommendations([/* ... */]);
$promise = $client->getArchitectureRecommendationsAsync([/* ... */]);

Gets recommendations about architecture designs for improving resiliency for an application, based on a recovery group.

Parameter Syntax

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

Parameter Details

Members
MaxResults
Type: int
NextToken
Type: string
RecoveryGroupName
Required: Yes
Type: string

Result Syntax

[
    'LastAuditTimestamp' => <DateTime>,
    'NextToken' => '<string>',
    'Recommendations' => [
        [
            'RecommendationText' => '<string>',
        ],
        // ...
    ],
]

Result Details

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

The time that a recovery group was last assessed for recommendations, in UTC ISO-8601 format.

NextToken
Type: string
Recommendations
Type: Array of Recommendation structures

Errors

ResourceNotFoundException:

This error does not currently have a description.

ThrottlingException:

This error does not currently have a description.

ValidationException:

This error does not currently have a description.

InternalServerException:

This error does not currently have a description.

AccessDeniedException:

This error does not currently have a description.

GetCell

$result = $client->getCell([/* ... */]);
$promise = $client->getCellAsync([/* ... */]);

Gets information about a cell including cell name, cell Amazon Resource Name (ARN), ARNs of nested cells for this cell, and a list of those cell ARNs with their associated recovery group ARNs.

Parameter Syntax

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

Parameter Details

Members
CellName
Required: Yes
Type: string

Result Syntax

[
    'CellArn' => '<string>',
    'CellName' => '<string>',
    'Cells' => ['<string>', ...],
    'ParentReadinessScopes' => ['<string>', ...],
    'Tags' => ['<string>', ...],
]

Result Details

Members
CellArn
Type: string
CellName
Type: string
Cells
Type: Array of strings
ParentReadinessScopes
Type: Array of strings
Tags
Type: Associative array of custom strings keys (__string) to strings

A collection of tags associated with a resource.

Errors

ResourceNotFoundException:

This error does not currently have a description.

ThrottlingException:

This error does not currently have a description.

ValidationException:

This error does not currently have a description.

InternalServerException:

This error does not currently have a description.

AccessDeniedException:

This error does not currently have a description.

GetCellReadinessSummary

$result = $client->getCellReadinessSummary([/* ... */]);
$promise = $client->getCellReadinessSummaryAsync([/* ... */]);

Gets readiness for a cell. Aggregates the readiness of all the resources that are associated with the cell into a single value.

Parameter Syntax

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

Parameter Details

Members
CellName
Required: Yes
Type: string
MaxResults
Type: int
NextToken
Type: string

Result Syntax

[
    'NextToken' => '<string>',
    'Readiness' => 'READY|NOT_READY|UNKNOWN|NOT_AUTHORIZED',
    'ReadinessChecks' => [
        [
            'Readiness' => 'READY|NOT_READY|UNKNOWN|NOT_AUTHORIZED',
            'ReadinessCheckName' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
Type: string
Readiness
Type: string

The readiness status.

ReadinessChecks
Type: Array of ReadinessCheckSummary structures

Errors

ResourceNotFoundException:

This error does not currently have a description.

ThrottlingException:

This error does not currently have a description.

ValidationException:

This error does not currently have a description.

InternalServerException:

This error does not currently have a description.

AccessDeniedException:

This error does not currently have a description.

GetReadinessCheck

$result = $client->getReadinessCheck([/* ... */]);
$promise = $client->getReadinessCheckAsync([/* ... */]);

Gets details about a readiness check.

Parameter Syntax

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

Parameter Details

Members
ReadinessCheckName
Required: Yes
Type: string

Result Syntax

[
    'ReadinessCheckArn' => '<string>',
    'ReadinessCheckName' => '<string>',
    'ResourceSet' => '<string>',
    'Tags' => ['<string>', ...],
]

Result Details

Members
ReadinessCheckArn
Type: string
ReadinessCheckName
Type: string
ResourceSet
Type: string
Tags
Type: Associative array of custom strings keys (__string) to strings

A collection of tags associated with a resource.

Errors

ResourceNotFoundException:

This error does not currently have a description.

ThrottlingException:

This error does not currently have a description.

ValidationException:

This error does not currently have a description.

InternalServerException:

This error does not currently have a description.

AccessDeniedException:

This error does not currently have a description.

GetReadinessCheckResourceStatus

$result = $client->getReadinessCheckResourceStatus([/* ... */]);
$promise = $client->getReadinessCheckResourceStatusAsync([/* ... */]);

Gets individual readiness status for a readiness check. To see the overall readiness status for a recovery group, that considers the readiness status for all the readiness checks in the recovery group, use GetRecoveryGroupReadinessSummary.

Parameter Syntax

$result = $client->getReadinessCheckResourceStatus([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ReadinessCheckName' => '<string>', // REQUIRED
    'ResourceIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Members
MaxResults
Type: int
NextToken
Type: string
ReadinessCheckName
Required: Yes
Type: string
ResourceIdentifier
Required: Yes
Type: string

Result Syntax

[
    'NextToken' => '<string>',
    'Readiness' => 'READY|NOT_READY|UNKNOWN|NOT_AUTHORIZED',
    'Rules' => [
        [
            'LastCheckedTimestamp' => <DateTime>,
            'Messages' => [
                [
                    'MessageText' => '<string>',
                ],
                // ...
            ],
            'Readiness' => 'READY|NOT_READY|UNKNOWN|NOT_AUTHORIZED',
            'RuleId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
Type: string
Readiness
Type: string

The readiness status.

Rules
Type: Array of RuleResult structures

Errors

ResourceNotFoundException:

This error does not currently have a description.

ThrottlingException:

This error does not currently have a description.

ValidationException:

This error does not currently have a description.

InternalServerException:

This error does not currently have a description.

AccessDeniedException:

This error does not currently have a description.

GetReadinessCheckStatus

$result = $client->getReadinessCheckStatus([/* ... */]);
$promise = $client->getReadinessCheckStatusAsync([/* ... */]);

Gets the readiness status for an individual readiness check. To see the overall readiness status for a recovery group, that considers the readiness status for all the readiness checks in a recovery group, use GetRecoveryGroupReadinessSummary.

Parameter Syntax

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

Parameter Details

Members
MaxResults
Type: int
NextToken
Type: string
ReadinessCheckName
Required: Yes
Type: string

Result Syntax

[
    'Messages' => [
        [
            'MessageText' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
    'Readiness' => 'READY|NOT_READY|UNKNOWN|NOT_AUTHORIZED',
    'Resources' => [
        [
            'ComponentId' => '<string>',
            'LastCheckedTimestamp' => <DateTime>,
            'Readiness' => 'READY|NOT_READY|UNKNOWN|NOT_AUTHORIZED',
            'ResourceArn' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
Messages
Type: Array of Message structures
NextToken
Type: string
Readiness
Type: string

The readiness status.

Resources
Type: Array of ResourceResult structures

Errors

ResourceNotFoundException:

This error does not currently have a description.

ThrottlingException:

This error does not currently have a description.

ValidationException:

This error does not currently have a description.

InternalServerException:

This error does not currently have a description.

AccessDeniedException:

This error does not currently have a description.

GetRecoveryGroup

$result = $client->getRecoveryGroup([/* ... */]);
$promise = $client->getRecoveryGroupAsync([/* ... */]);

Gets details about a recovery group, including a list of the cells that are included in it.

Parameter Syntax

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

Parameter Details

Members
RecoveryGroupName
Required: Yes
Type: string

Result Syntax

[
    'Cells' => ['<string>', ...],
    'RecoveryGroupArn' => '<string>',
    'RecoveryGroupName' => '<string>',
    'Tags' => ['<string>', ...],
]

Result Details

Members
Cells
Type: Array of strings
RecoveryGroupArn
Type: string
RecoveryGroupName
Type: string
Tags
Type: Associative array of custom strings keys (__string) to strings

A collection of tags associated with a resource.

Errors

ResourceNotFoundException:

This error does not currently have a description.

ThrottlingException:

This error does not currently have a description.

ValidationException:

This error does not currently have a description.

InternalServerException:

This error does not currently have a description.

AccessDeniedException:

This error does not currently have a description.

GetRecoveryGroupReadinessSummary

$result = $client->getRecoveryGroupReadinessSummary([/* ... */]);
$promise = $client->getRecoveryGroupReadinessSummaryAsync([/* ... */]);

Displays a summary of information about a recovery group's readiness status. Includes the readiness checks for resources in the recovery group and the readiness status of each one.

Parameter Syntax

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

Parameter Details

Members
MaxResults
Type: int
NextToken
Type: string
RecoveryGroupName
Required: Yes
Type: string

Result Syntax

[
    'NextToken' => '<string>',
    'Readiness' => 'READY|NOT_READY|UNKNOWN|NOT_AUTHORIZED',
    'ReadinessChecks' => [
        [
            'Readiness' => 'READY|NOT_READY|UNKNOWN|NOT_AUTHORIZED',
            'ReadinessCheckName' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
Type: string
Readiness
Type: string

The readiness status.

ReadinessChecks
Type: Array of ReadinessCheckSummary structures

Errors

ResourceNotFoundException:

This error does not currently have a description.

ThrottlingException:

This error does not currently have a description.

ValidationException:

This error does not currently have a description.

InternalServerException:

This error does not currently have a description.

AccessDeniedException:

This error does not currently have a description.

GetResourceSet

$result = $client->getResourceSet([/* ... */]);
$promise = $client->getResourceSetAsync([/* ... */]);

Displays the details about a resource set, including a list of the resources in the set.

Parameter Syntax

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

Parameter Details

Members
ResourceSetName
Required: Yes
Type: string

Result Syntax

[
    'ResourceSetArn' => '<string>',
    'ResourceSetName' => '<string>',
    'ResourceSetType' => '<string>',
    'Resources' => [
        [
            'ComponentId' => '<string>',
            'DnsTargetResource' => [
                'DomainName' => '<string>',
                'HostedZoneArn' => '<string>',
                'RecordSetId' => '<string>',
                'RecordType' => '<string>',
                'TargetResource' => [
                    'NLBResource' => [
                        'Arn' => '<string>',
                    ],
                    'R53Resource' => [
                        'DomainName' => '<string>',
                        'RecordSetId' => '<string>',
                    ],
                ],
            ],
            'ReadinessScopes' => ['<string>', ...],
            'ResourceArn' => '<string>',
        ],
        // ...
    ],
    'Tags' => ['<string>', ...],
]

Result Details

Members
ResourceSetArn
Type: string
ResourceSetName
Type: string
ResourceSetType
Type: string
Resources
Type: Array of Resource structures
Tags
Type: Associative array of custom strings keys (__string) to strings

A collection of tags associated with a resource.

Errors

ResourceNotFoundException:

This error does not currently have a description.

ThrottlingException:

This error does not currently have a description.

ValidationException:

This error does not currently have a description.

InternalServerException:

This error does not currently have a description.

AccessDeniedException:

This error does not currently have a description.

ListCells

$result = $client->listCells([/* ... */]);
$promise = $client->listCellsAsync([/* ... */]);

Lists the cells for an account.

Parameter Syntax

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

Parameter Details

Members
MaxResults
Type: int
NextToken
Type: string

Result Syntax

[
    'Cells' => [
        [
            'CellArn' => '<string>',
            'CellName' => '<string>',
            'Cells' => ['<string>', ...],
            'ParentReadinessScopes' => ['<string>', ...],
            'Tags' => ['<string>', ...],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
Cells
Type: Array of CellOutput structures
NextToken
Type: string

Errors

ThrottlingException:

This error does not currently have a description.

ValidationException:

This error does not currently have a description.

InternalServerException:

This error does not currently have a description.

AccessDeniedException:

This error does not currently have a description.

ListCrossAccountAuthorizations

$result = $client->listCrossAccountAuthorizations([/* ... */]);
$promise = $client->listCrossAccountAuthorizationsAsync([/* ... */]);

Lists the cross-account readiness authorizations that are in place for an account.

Parameter Syntax

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

Parameter Details

Members
MaxResults
Type: int
NextToken
Type: string

Result Syntax

[
    'CrossAccountAuthorizations' => ['<string>', ...],
    'NextToken' => '<string>',
]

Result Details

Members
CrossAccountAuthorizations
Type: Array of strings
NextToken
Type: string

Errors

ThrottlingException:

This error does not currently have a description.

ValidationException:

This error does not currently have a description.

InternalServerException:

This error does not currently have a description.

AccessDeniedException:

This error does not currently have a description.

ListReadinessChecks

$result = $client->listReadinessChecks([/* ... */]);
$promise = $client->listReadinessChecksAsync([/* ... */]);

Lists the readiness checks for an account.

Parameter Syntax

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

Parameter Details

Members
MaxResults
Type: int
NextToken
Type: string

Result Syntax

[
    'NextToken' => '<string>',
    'ReadinessChecks' => [
        [
            'ReadinessCheckArn' => '<string>',
            'ReadinessCheckName' => '<string>',
            'ResourceSet' => '<string>',
            'Tags' => ['<string>', ...],
        ],
        // ...
    ],
]

Result Details

Members
NextToken
Type: string
ReadinessChecks
Type: Array of ReadinessCheckOutput structures

Errors

ThrottlingException:

This error does not currently have a description.

ValidationException:

This error does not currently have a description.

InternalServerException:

This error does not currently have a description.

AccessDeniedException:

This error does not currently have a description.

ListRecoveryGroups

$result = $client->listRecoveryGroups([/* ... */]);
$promise = $client->listRecoveryGroupsAsync([/* ... */]);

Lists the recovery groups in an account.

Parameter Syntax

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

Parameter Details

Members
MaxResults
Type: int
NextToken
Type: string

Result Syntax

[
    'NextToken' => '<string>',
    'RecoveryGroups' => [
        [
            'Cells' => ['<string>', ...],
            'RecoveryGroupArn' => '<string>',
            'RecoveryGroupName' => '<string>',
            'Tags' => ['<string>', ...],
        ],
        // ...
    ],
]

Result Details

Members
NextToken
Type: string
RecoveryGroups
Type: Array of RecoveryGroupOutput structures

Errors

ThrottlingException:

This error does not currently have a description.

ValidationException:

This error does not currently have a description.

InternalServerException:

This error does not currently have a description.

AccessDeniedException:

This error does not currently have a description.

ListResourceSets

$result = $client->listResourceSets([/* ... */]);
$promise = $client->listResourceSetsAsync([/* ... */]);

Lists the resource sets in an account.

Parameter Syntax

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

Parameter Details

Members
MaxResults
Type: int
NextToken
Type: string

Result Syntax

[
    'NextToken' => '<string>',
    'ResourceSets' => [
        [
            'ResourceSetArn' => '<string>',
            'ResourceSetName' => '<string>',
            'ResourceSetType' => '<string>',
            'Resources' => [
                [
                    'ComponentId' => '<string>',
                    'DnsTargetResource' => [
                        'DomainName' => '<string>',
                        'HostedZoneArn' => '<string>',
                        'RecordSetId' => '<string>',
                        'RecordType' => '<string>',
                        'TargetResource' => [
                            'NLBResource' => [
                                'Arn' => '<string>',
                            ],
                            'R53Resource' => [
                                'DomainName' => '<string>',
                                'RecordSetId' => '<string>',
                            ],
                        ],
                    ],
                    'ReadinessScopes' => ['<string>', ...],
                    'ResourceArn' => '<string>',
                ],
                // ...
            ],
            'Tags' => ['<string>', ...],
        ],
        // ...
    ],
]

Result Details

Members
NextToken
Type: string
ResourceSets
Type: Array of ResourceSetOutput structures

Errors

ThrottlingException:

This error does not currently have a description.

ValidationException:

This error does not currently have a description.

InternalServerException:

This error does not currently have a description.

AccessDeniedException:

This error does not currently have a description.

ListRules

$result = $client->listRules([/* ... */]);
$promise = $client->listRulesAsync([/* ... */]);

Lists all readiness rules, or lists the readiness rules for a specific resource type.

Parameter Syntax

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

Parameter Details

Members
MaxResults
Type: int
NextToken
Type: string
ResourceType
Type: string

Result Syntax

[
    'NextToken' => '<string>',
    'Rules' => [
        [
            'ResourceType' => '<string>',
            'RuleDescription' => '<string>',
            'RuleId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
Type: string
Rules
Type: Array of ListRulesOutput structures

Errors

ThrottlingException:

This error does not currently have a description.

ValidationException:

This error does not currently have a description.

InternalServerException:

This error does not currently have a description.

AccessDeniedException:

This error does not currently have a description.

ListTagsForResources

$result = $client->listTagsForResources([/* ... */]);
$promise = $client->listTagsForResourcesAsync([/* ... */]);

Lists the tags for a resource.

Parameter Syntax

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

Parameter Details

Members
ResourceArn
Required: Yes
Type: string

Result Syntax

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

Result Details

Members
Tags
Type: Associative array of custom strings keys (__string) to strings

A collection of tags associated with a resource.

Errors

ResourceNotFoundException:

This error does not currently have a description.

ValidationException:

This error does not currently have a description.

InternalServerException:

This error does not currently have a description.

TagResource

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

Adds a tag to a resource.

Parameter Syntax

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

Parameter Details

Members
ResourceArn
Required: Yes
Type: string
Tags
Required: Yes
Type: Associative array of custom strings keys (__string) to strings

A collection of tags associated with a resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:

This error does not currently have a description.

ValidationException:

This error does not currently have a description.

InternalServerException:

This error does not currently have a description.

UntagResource

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

Removes a tag from a resource.

Parameter Syntax

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

Parameter Details

Members
ResourceArn
Required: Yes
Type: string
TagKeys
Required: Yes
Type: Array of strings

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:

This error does not currently have a description.

ValidationException:

This error does not currently have a description.

InternalServerException:

This error does not currently have a description.

UpdateCell

$result = $client->updateCell([/* ... */]);
$promise = $client->updateCellAsync([/* ... */]);

Updates a cell to replace the list of nested cells with a new list of nested cells.

Parameter Syntax

$result = $client->updateCell([
    'CellName' => '<string>', // REQUIRED
    'Cells' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
CellName
Required: Yes
Type: string
Cells
Required: Yes
Type: Array of strings

Result Syntax

[
    'CellArn' => '<string>',
    'CellName' => '<string>',
    'Cells' => ['<string>', ...],
    'ParentReadinessScopes' => ['<string>', ...],
    'Tags' => ['<string>', ...],
]

Result Details

Members
CellArn
Type: string
CellName
Type: string
Cells
Type: Array of strings
ParentReadinessScopes
Type: Array of strings
Tags
Type: Associative array of custom strings keys (__string) to strings

A collection of tags associated with a resource.

Errors

ResourceNotFoundException:

This error does not currently have a description.

ThrottlingException:

This error does not currently have a description.

ValidationException:

This error does not currently have a description.

InternalServerException:

This error does not currently have a description.

AccessDeniedException:

This error does not currently have a description.

UpdateReadinessCheck

$result = $client->updateReadinessCheck([/* ... */]);
$promise = $client->updateReadinessCheckAsync([/* ... */]);

Updates a readiness check.

Parameter Syntax

$result = $client->updateReadinessCheck([
    'ReadinessCheckName' => '<string>', // REQUIRED
    'ResourceSetName' => '<string>', // REQUIRED
]);

Parameter Details

Members
ReadinessCheckName
Required: Yes
Type: string
ResourceSetName
Required: Yes
Type: string

Result Syntax

[
    'ReadinessCheckArn' => '<string>',
    'ReadinessCheckName' => '<string>',
    'ResourceSet' => '<string>',
    'Tags' => ['<string>', ...],
]

Result Details

Members
ReadinessCheckArn
Type: string
ReadinessCheckName
Type: string
ResourceSet
Type: string
Tags
Type: Associative array of custom strings keys (__string) to strings

A collection of tags associated with a resource.

Errors

ResourceNotFoundException:

This error does not currently have a description.

ThrottlingException:

This error does not currently have a description.

ValidationException:

This error does not currently have a description.

InternalServerException:

This error does not currently have a description.

AccessDeniedException:

This error does not currently have a description.

UpdateRecoveryGroup

$result = $client->updateRecoveryGroup([/* ... */]);
$promise = $client->updateRecoveryGroupAsync([/* ... */]);

Updates a recovery group.

Parameter Syntax

$result = $client->updateRecoveryGroup([
    'Cells' => ['<string>', ...], // REQUIRED
    'RecoveryGroupName' => '<string>', // REQUIRED
]);

Parameter Details

Members
Cells
Required: Yes
Type: Array of strings
RecoveryGroupName
Required: Yes
Type: string

Result Syntax

[
    'Cells' => ['<string>', ...],
    'RecoveryGroupArn' => '<string>',
    'RecoveryGroupName' => '<string>',
    'Tags' => ['<string>', ...],
]

Result Details

Members
Cells
Type: Array of strings
RecoveryGroupArn
Type: string
RecoveryGroupName
Type: string
Tags
Type: Associative array of custom strings keys (__string) to strings

A collection of tags associated with a resource.

Errors

ResourceNotFoundException:

This error does not currently have a description.

ThrottlingException:

This error does not currently have a description.

ValidationException:

This error does not currently have a description.

InternalServerException:

This error does not currently have a description.

AccessDeniedException:

This error does not currently have a description.

UpdateResourceSet

$result = $client->updateResourceSet([/* ... */]);
$promise = $client->updateResourceSetAsync([/* ... */]);

Updates a resource set.

Parameter Syntax

$result = $client->updateResourceSet([
    'ResourceSetName' => '<string>', // REQUIRED
    'ResourceSetType' => '<string>', // REQUIRED
    'Resources' => [ // REQUIRED
        [
            'ComponentId' => '<string>',
            'DnsTargetResource' => [
                'DomainName' => '<string>',
                'HostedZoneArn' => '<string>',
                'RecordSetId' => '<string>',
                'RecordType' => '<string>',
                'TargetResource' => [
                    'NLBResource' => [
                        'Arn' => '<string>',
                    ],
                    'R53Resource' => [
                        'DomainName' => '<string>',
                        'RecordSetId' => '<string>',
                    ],
                ],
            ],
            'ReadinessScopes' => ['<string>', ...],
            'ResourceArn' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Members
ResourceSetName
Required: Yes
Type: string
ResourceSetType
Required: Yes
Type: string
Resources
Required: Yes
Type: Array of Resource structures

Result Syntax

[
    'ResourceSetArn' => '<string>',
    'ResourceSetName' => '<string>',
    'ResourceSetType' => '<string>',
    'Resources' => [
        [
            'ComponentId' => '<string>',
            'DnsTargetResource' => [
                'DomainName' => '<string>',
                'HostedZoneArn' => '<string>',
                'RecordSetId' => '<string>',
                'RecordType' => '<string>',
                'TargetResource' => [
                    'NLBResource' => [
                        'Arn' => '<string>',
                    ],
                    'R53Resource' => [
                        'DomainName' => '<string>',
                        'RecordSetId' => '<string>',
                    ],
                ],
            ],
            'ReadinessScopes' => ['<string>', ...],
            'ResourceArn' => '<string>',
        ],
        // ...
    ],
    'Tags' => ['<string>', ...],
]

Result Details

Members
ResourceSetArn
Type: string
ResourceSetName
Type: string
ResourceSetType
Type: string
Resources
Type: Array of Resource structures
Tags
Type: Associative array of custom strings keys (__string) to strings

A collection of tags associated with a resource.

Errors

ResourceNotFoundException:

This error does not currently have a description.

ThrottlingException:

This error does not currently have a description.

ValidationException:

This error does not currently have a description.

InternalServerException:

This error does not currently have a description.

AccessDeniedException:

This error does not currently have a description.

Shapes

AccessDeniedException

Members
Message
Type: string

CellOutput

Description

Information about a cell.

Members
CellArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) for the cell.

CellName
Required: Yes
Type: string

The name of the cell.

Cells
Required: Yes
Type: Array of strings

A list of cell ARNs.

ParentReadinessScopes
Required: Yes
Type: Array of strings

The readiness scope for the cell, which can be a cell Amazon Resource Name (ARN) or a recovery group ARN. This is a list but currently can have only one element.

Tags
Type: Associative array of custom strings keys (__string) to strings

Tags on the resources.

ConflictException

Members
Message
Type: string

DNSTargetResource

Description

A component for DNS/routing control readiness checks and architecture checks.

Members
DomainName
Type: string

The domain name that acts as an ingress point to a portion of the customer application.

HostedZoneArn
Type: string

The hosted zone Amazon Resource Name (ARN) that contains the DNS record with the provided name of the target resource.

RecordSetId
Type: string

The Route 53 record set ID that uniquely identifies a DNS record, given a name and a type.

RecordType
Type: string

The type of DNS record of the target resource.

TargetResource
Type: TargetResource structure

The target resource of the DNS target resource.

InternalServerException

Members
Message
Type: string

ListRulesOutput

Description

Readiness rule information, including the resource type, rule ID, and rule description.

Members
ResourceType
Required: Yes
Type: string

The resource type that the readiness rule applies to.

RuleDescription
Required: Yes
Type: string

The description of a readiness rule.

RuleId
Required: Yes
Type: string

The ID for the readiness rule.

Message

Description

Information relating to readiness check status.

Members
MessageText
Type: string

The text of a readiness check message.

NLBResource

Description

The Network Load Balancer resource that a DNS target resource points to.

Members
Arn
Type: string

The Network Load Balancer resource Amazon Resource Name (ARN).

R53ResourceRecord

Description

The Route 53 resource that a DNS target resource record points to.

Members
DomainName
Type: string

The DNS target domain name.

RecordSetId
Type: string

The Route 53 Resource Record Set ID.

ReadinessCheckOutput

Description

A readiness check.

Members
ReadinessCheckArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) associated with a readiness check.

ReadinessCheckName
Type: string

Name of a readiness check.

ResourceSet
Required: Yes
Type: string

Name of the resource set to be checked.

Tags
Type: Associative array of custom strings keys (__string) to strings

A collection of tags associated with a resource.

ReadinessCheckSummary

Description

Summary of all readiness check statuses in a recovery group, paginated in GetRecoveryGroupReadinessSummary and GetCellReadinessSummary.

Members
Readiness
Type: string

The readiness status of this readiness check.

ReadinessCheckName
Type: string

The name of a readiness check.

Recommendation

Description

Recommendations that are provided to make an application more recovery resilient.

Members
RecommendationText
Required: Yes
Type: string

Text of the recommendations that are provided to make an application more recovery resilient.

RecoveryGroupOutput

Description

A representation of the application, typically containing multiple cells.

Members
Cells
Required: Yes
Type: Array of strings

A list of a cell's Amazon Resource Names (ARNs).

RecoveryGroupArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) for the recovery group.

RecoveryGroupName
Required: Yes
Type: string

The name of the recovery group.

Tags
Type: Associative array of custom strings keys (__string) to strings

The tags associated with the recovery group.

Resource

Description

The resource element of a resource set.

Members
ComponentId
Type: string

The component identifier of the resource, generated when DNS target resource is used.

DnsTargetResource
Type: DNSTargetResource structure

The DNS target resource.

ReadinessScopes
Type: Array of strings

A list of recovery group Amazon Resource Names (ARNs) and cell ARNs that this resource is contained within.

ResourceArn
Type: string

The Amazon Resource Name (ARN) of the Amazon Web Services resource.

ResourceNotFoundException

Members
Message
Type: string

ResourceResult

Description

The result of a successful Resource request, with status for an individual resource.

Members
ComponentId
Type: string

The component id of the resource.

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

The time (UTC) that the resource was last checked for readiness, in ISO-8601 format.

Readiness
Required: Yes
Type: string

The readiness of a resource.

ResourceArn
Type: string

The Amazon Resource Name (ARN) of the resource.

ResourceSetOutput

Description

A collection of resources of the same type.

Members
ResourceSetArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) for the resource set.

ResourceSetName
Required: Yes
Type: string

The name of the resource set.

ResourceSetType
Required: Yes
Type: string

The resource type of the resources in the resource set. Enter one of the following values for resource type:

AWS::ApiGateway::Stage, AWS::ApiGatewayV2::Stage, AWS::AutoScaling::AutoScalingGroup, AWS::CloudWatch::Alarm, AWS::EC2::CustomerGateway, AWS::DynamoDB::Table, AWS::EC2::Volume, AWS::ElasticLoadBalancing::LoadBalancer, AWS::ElasticLoadBalancingV2::LoadBalancer, AWS::Lambda::Function, AWS::MSK::Cluster, AWS::RDS::DBCluster, AWS::Route53::HealthCheck, AWS::SQS::Queue, AWS::SNS::Topic, AWS::SNS::Subscription, AWS::EC2::VPC, AWS::EC2::VPNConnection, AWS::EC2::VPNGateway, AWS::Route53RecoveryReadiness::DNSTargetResource

Resources
Required: Yes
Type: Array of Resource structures

A list of resource objects.

Tags
Type: Associative array of custom strings keys (__string) to strings

A collection of tags associated with a resource.

RuleResult

Description

The result of a successful Rule request, with status for an individual rule.

Members
LastCheckedTimestamp
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the resource was last checked for readiness, in ISO-8601 format, UTC.

Messages
Required: Yes
Type: Array of Message structures

Details about the resource's readiness.

Readiness
Required: Yes
Type: string

The readiness at rule level.

RuleId
Required: Yes
Type: string

The identifier of the rule.

TargetResource

Description

The target resource that the Route 53 record points to.

Members
NLBResource
Type: NLBResource structure

The Network Load Balancer Resource.

R53Resource
Type: R53ResourceRecord structure

The Route 53 resource.

ThrottlingException

Members
Message
Type: string

ValidationException

Members
Message
Type: string