CreateCluster

$result = $client->createCluster([/* ... */]);
$promise = $client->createClusterAsync([/* ... */]);

Create a new cluster. A cluster is a set of redundant Regional endpoints against which you can run API calls to update or get the state of one or more routing controls. Each cluster has a name, status, Amazon Resource Name (ARN), and an array of the five cluster endpoints (one for each supported Amazon Web Services Region) that you can use with API calls to the cluster data plane.

Parameter Syntax

$result = $client->createCluster([
    'ClientToken' => '<string>',
    'ClusterName' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'Cluster' => [
        'ClusterArn' => '<string>',
        'ClusterEndpoints' => [
            [
                'Endpoint' => '<string>',
                'Region' => '<string>',
            ],
            // ...
        ],
        'Name' => '<string>',
        'Owner' => '<string>',
        'Status' => 'PENDING|DEPLOYED|PENDING_DELETION',
    ],
]

Result Details

Errors

ValidationException:

400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you might have used parameters together incorrectly.

InternalServerException:

500 response - InternalServiceError. Temporary service error. Retry the request.

ServiceQuotaExceededException:

402 response - You attempted to create more resources than the service allows based on service quotas.

AccessDeniedException:

403 response - You do not have sufficient access to perform this action.

ResourceNotFoundException:

404 response - MalformedQueryString. The query string contains a syntax error or resource not found.

ThrottlingException:

429 response - LimitExceededException or TooManyRequestsException.

ConflictException:

409 response - ConflictException. You might be using a predefined variable.

CreateControlPanel

$result = $client->createControlPanel([/* ... */]);
$promise = $client->createControlPanelAsync([/* ... */]);

Creates a new control panel. A control panel represents a group of routing controls that can be changed together in a single transaction. You can use a control panel to centrally view the operational status of applications across your organization, and trigger multi-app failovers in a single transaction, for example, to fail over an Availability Zone or Amazon Web Services Region.

Parameter Syntax

$result = $client->createControlPanel([
    'ClientToken' => '<string>',
    'ClusterArn' => '<string>', // REQUIRED
    'ControlPanelName' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'ControlPanel' => [
        'ClusterArn' => '<string>',
        'ControlPanelArn' => '<string>',
        'DefaultControlPanel' => true || false,
        'Name' => '<string>',
        'Owner' => '<string>',
        'RoutingControlCount' => <integer>,
        'Status' => 'PENDING|DEPLOYED|PENDING_DELETION',
    ],
]

Result Details

Errors

ValidationException:

400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you might have used parameters together incorrectly.

InternalServerException:

500 response - InternalServiceError. Temporary service error. Retry the request.

ServiceQuotaExceededException:

402 response - You attempted to create more resources than the service allows based on service quotas.

AccessDeniedException:

403 response - You do not have sufficient access to perform this action.

ResourceNotFoundException:

404 response - MalformedQueryString. The query string contains a syntax error or resource not found.

ThrottlingException:

429 response - LimitExceededException or TooManyRequestsException.

ConflictException:

409 response - ConflictException. You might be using a predefined variable.

CreateRoutingControl

$result = $client->createRoutingControl([/* ... */]);
$promise = $client->createRoutingControlAsync([/* ... */]);

Creates a new routing control.

A routing control has one of two states: ON and OFF. You can map the routing control state to the state of an Amazon Route 53 health check, which can be used to control traffic routing.

To get or update the routing control state, see the Recovery Cluster (data plane) API actions for Amazon Route 53 Application Recovery Controller.

Parameter Syntax

$result = $client->createRoutingControl([
    'ClientToken' => '<string>',
    'ClusterArn' => '<string>', // REQUIRED
    'ControlPanelArn' => '<string>',
    'RoutingControlName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'RoutingControl' => [
        'ControlPanelArn' => '<string>',
        'Name' => '<string>',
        'Owner' => '<string>',
        'RoutingControlArn' => '<string>',
        'Status' => 'PENDING|DEPLOYED|PENDING_DELETION',
    ],
]

Result Details

Errors

ValidationException:

400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you might have used parameters together incorrectly.

InternalServerException:

500 response - InternalServiceError. Temporary service error. Retry the request.

ServiceQuotaExceededException:

402 response - You attempted to create more resources than the service allows based on service quotas.

AccessDeniedException:

403 response - You do not have sufficient access to perform this action.

ResourceNotFoundException:

404 response - MalformedQueryString. The query string contains a syntax error or resource not found.

ThrottlingException:

429 response - LimitExceededException or TooManyRequestsException.

ConflictException:

409 response - ConflictException. You might be using a predefined variable.

CreateSafetyRule

$result = $client->createSafetyRule([/* ... */]);
$promise = $client->createSafetyRuleAsync([/* ... */]);

Creates a safety rule in a control panel. Safety rules let you add safeguards around changing routing control states, and for enabling and disabling routing controls, to help prevent unexpected outcomes.

There are two types of safety rules: assertion rules and gating rules.

Assertion rule: An assertion rule enforces that, when you change a routing control state, that a certain criteria is met. For example, the criteria might be that at least one routing control state is On after the transaction so that traffic continues to flow to at least one cell for the application. This ensures that you avoid a fail-open scenario.

Gating rule: A gating rule lets you configure a gating routing control as an overall "on/off" switch for a group of routing controls. Or, you can configure more complex gating scenarios, for example by configuring multiple gating routing controls.

For more information, see Safety rules in the Amazon Route 53 Application Recovery Controller Developer Guide.

Parameter Syntax

$result = $client->createSafetyRule([
    'AssertionRule' => [
        'AssertedControls' => ['<string>', ...], // REQUIRED
        'ControlPanelArn' => '<string>', // REQUIRED
        'Name' => '<string>', // REQUIRED
        'RuleConfig' => [ // REQUIRED
            'Inverted' => true || false, // REQUIRED
            'Threshold' => <integer>, // REQUIRED
            'Type' => 'ATLEAST|AND|OR', // REQUIRED
        ],
        'WaitPeriodMs' => <integer>, // REQUIRED
    ],
    'ClientToken' => '<string>',
    'GatingRule' => [
        'ControlPanelArn' => '<string>', // REQUIRED
        'GatingControls' => ['<string>', ...], // REQUIRED
        'Name' => '<string>', // REQUIRED
        'RuleConfig' => [ // REQUIRED
            'Inverted' => true || false, // REQUIRED
            'Threshold' => <integer>, // REQUIRED
            'Type' => 'ATLEAST|AND|OR', // REQUIRED
        ],
        'TargetControls' => ['<string>', ...], // REQUIRED
        'WaitPeriodMs' => <integer>, // REQUIRED
    ],
    'Tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'AssertionRule' => [
        'AssertedControls' => ['<string>', ...],
        'ControlPanelArn' => '<string>',
        'Name' => '<string>',
        'Owner' => '<string>',
        'RuleConfig' => [
            'Inverted' => true || false,
            'Threshold' => <integer>,
            'Type' => 'ATLEAST|AND|OR',
        ],
        'SafetyRuleArn' => '<string>',
        'Status' => 'PENDING|DEPLOYED|PENDING_DELETION',
        'WaitPeriodMs' => <integer>,
    ],
    'GatingRule' => [
        'ControlPanelArn' => '<string>',
        'GatingControls' => ['<string>', ...],
        'Name' => '<string>',
        'Owner' => '<string>',
        'RuleConfig' => [
            'Inverted' => true || false,
            'Threshold' => <integer>,
            'Type' => 'ATLEAST|AND|OR',
        ],
        'SafetyRuleArn' => '<string>',
        'Status' => 'PENDING|DEPLOYED|PENDING_DELETION',
        'TargetControls' => ['<string>', ...],
        'WaitPeriodMs' => <integer>,
    ],
]

Result Details

Errors

ValidationException:

400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you might have used parameters together incorrectly.

InternalServerException:

500 response - InternalServiceError. Temporary service error. Retry the request.

DeleteCluster

$result = $client->deleteCluster([/* ... */]);
$promise = $client->deleteClusterAsync([/* ... */]);

Delete a cluster.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you might have used parameters together incorrectly.

InternalServerException:

500 response - InternalServiceError. Temporary service error. Retry the request.

AccessDeniedException:

403 response - You do not have sufficient access to perform this action.

ResourceNotFoundException:

404 response - MalformedQueryString. The query string contains a syntax error or resource not found.

ThrottlingException:

429 response - LimitExceededException or TooManyRequestsException.

ConflictException:

409 response - ConflictException. You might be using a predefined variable.

DeleteControlPanel

$result = $client->deleteControlPanel([/* ... */]);
$promise = $client->deleteControlPanelAsync([/* ... */]);

Deletes a control panel.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you might have used parameters together incorrectly.

InternalServerException:

500 response - InternalServiceError. Temporary service error. Retry the request.

AccessDeniedException:

403 response - You do not have sufficient access to perform this action.

ResourceNotFoundException:

404 response - MalformedQueryString. The query string contains a syntax error or resource not found.

ThrottlingException:

429 response - LimitExceededException or TooManyRequestsException.

ConflictException:

409 response - ConflictException. You might be using a predefined variable.

DeleteRoutingControl

$result = $client->deleteRoutingControl([/* ... */]);
$promise = $client->deleteRoutingControlAsync([/* ... */]);

Deletes a routing control.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you might have used parameters together incorrectly.

InternalServerException:

500 response - InternalServiceError. Temporary service error. Retry the request.

AccessDeniedException:

403 response - You do not have sufficient access to perform this action.

ResourceNotFoundException:

404 response - MalformedQueryString. The query string contains a syntax error or resource not found.

ThrottlingException:

429 response - LimitExceededException or TooManyRequestsException.

ConflictException:

409 response - ConflictException. You might be using a predefined variable.

DeleteSafetyRule

$result = $client->deleteSafetyRule([/* ... */]);
$promise = $client->deleteSafetyRuleAsync([/* ... */]);

Deletes a safety rule.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

404 response - MalformedQueryString. The query string contains a syntax error or resource not found.

ValidationException:

400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you might have used parameters together incorrectly.

InternalServerException:

500 response - InternalServiceError. Temporary service error. Retry the request.

DescribeCluster

$result = $client->describeCluster([/* ... */]);
$promise = $client->describeClusterAsync([/* ... */]);

Display the details about a cluster. The response includes the cluster name, endpoints, status, and Amazon Resource Name (ARN).

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Cluster' => [
        'ClusterArn' => '<string>',
        'ClusterEndpoints' => [
            [
                'Endpoint' => '<string>',
                'Region' => '<string>',
            ],
            // ...
        ],
        'Name' => '<string>',
        'Owner' => '<string>',
        'Status' => 'PENDING|DEPLOYED|PENDING_DELETION',
    ],
]

Result Details

Errors

ValidationException:

400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you might have used parameters together incorrectly.

InternalServerException:

500 response - InternalServiceError. Temporary service error. Retry the request.

AccessDeniedException:

403 response - You do not have sufficient access to perform this action.

ResourceNotFoundException:

404 response - MalformedQueryString. The query string contains a syntax error or resource not found.

ThrottlingException:

429 response - LimitExceededException or TooManyRequestsException.

ConflictException:

409 response - ConflictException. You might be using a predefined variable.

DescribeControlPanel

$result = $client->describeControlPanel([/* ... */]);
$promise = $client->describeControlPanelAsync([/* ... */]);

Displays details about a control panel.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'ControlPanel' => [
        'ClusterArn' => '<string>',
        'ControlPanelArn' => '<string>',
        'DefaultControlPanel' => true || false,
        'Name' => '<string>',
        'Owner' => '<string>',
        'RoutingControlCount' => <integer>,
        'Status' => 'PENDING|DEPLOYED|PENDING_DELETION',
    ],
]

Result Details

Errors

ValidationException:

400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you might have used parameters together incorrectly.

InternalServerException:

500 response - InternalServiceError. Temporary service error. Retry the request.

AccessDeniedException:

403 response - You do not have sufficient access to perform this action.

ResourceNotFoundException:

404 response - MalformedQueryString. The query string contains a syntax error or resource not found.

ThrottlingException:

429 response - LimitExceededException or TooManyRequestsException.

ConflictException:

409 response - ConflictException. You might be using a predefined variable.

DescribeRoutingControl

$result = $client->describeRoutingControl([/* ... */]);
$promise = $client->describeRoutingControlAsync([/* ... */]);

Displays details about a routing control. A routing control has one of two states: ON and OFF. You can map the routing control state to the state of an Amazon Route 53 health check, which can be used to control routing.

To get or update the routing control state, see the Recovery Cluster (data plane) API actions for Amazon Route 53 Application Recovery Controller.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'RoutingControl' => [
        'ControlPanelArn' => '<string>',
        'Name' => '<string>',
        'Owner' => '<string>',
        'RoutingControlArn' => '<string>',
        'Status' => 'PENDING|DEPLOYED|PENDING_DELETION',
    ],
]

Result Details

Errors

ValidationException:

400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you might have used parameters together incorrectly.

InternalServerException:

500 response - InternalServiceError. Temporary service error. Retry the request.

AccessDeniedException:

403 response - You do not have sufficient access to perform this action.

ResourceNotFoundException:

404 response - MalformedQueryString. The query string contains a syntax error or resource not found.

ThrottlingException:

429 response - LimitExceededException or TooManyRequestsException.

ConflictException:

409 response - ConflictException. You might be using a predefined variable.

DescribeSafetyRule

$result = $client->describeSafetyRule([/* ... */]);
$promise = $client->describeSafetyRuleAsync([/* ... */]);

Returns information about a safety rule.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'AssertionRule' => [
        'AssertedControls' => ['<string>', ...],
        'ControlPanelArn' => '<string>',
        'Name' => '<string>',
        'Owner' => '<string>',
        'RuleConfig' => [
            'Inverted' => true || false,
            'Threshold' => <integer>,
            'Type' => 'ATLEAST|AND|OR',
        ],
        'SafetyRuleArn' => '<string>',
        'Status' => 'PENDING|DEPLOYED|PENDING_DELETION',
        'WaitPeriodMs' => <integer>,
    ],
    'GatingRule' => [
        'ControlPanelArn' => '<string>',
        'GatingControls' => ['<string>', ...],
        'Name' => '<string>',
        'Owner' => '<string>',
        'RuleConfig' => [
            'Inverted' => true || false,
            'Threshold' => <integer>,
            'Type' => 'ATLEAST|AND|OR',
        ],
        'SafetyRuleArn' => '<string>',
        'Status' => 'PENDING|DEPLOYED|PENDING_DELETION',
        'TargetControls' => ['<string>', ...],
        'WaitPeriodMs' => <integer>,
    ],
]

Result Details

Errors

ValidationException:

400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you might have used parameters together incorrectly.

ResourceNotFoundException:

404 response - MalformedQueryString. The query string contains a syntax error or resource not found.

GetResourcePolicy

$result = $client->getResourcePolicy([/* ... */]);
$promise = $client->getResourcePolicyAsync([/* ... */]);

Get information about the resource policy for a cluster.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

ResourceNotFoundException:

404 response - MalformedQueryString. The query string contains a syntax error or resource not found.

InternalServerException:

500 response - InternalServiceError. Temporary service error. Retry the request.

ListAssociatedRoute53HealthChecks

$result = $client->listAssociatedRoute53HealthChecks([/* ... */]);
$promise = $client->listAssociatedRoute53HealthChecksAsync([/* ... */]);

Returns an array of all Amazon Route 53 health checks associated with a specific routing control.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

ResourceNotFoundException:

404 response - MalformedQueryString. The query string contains a syntax error or resource not found.

ValidationException:

400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you might have used parameters together incorrectly.

InternalServerException:

500 response - InternalServiceError. Temporary service error. Retry the request.

ListClusters

$result = $client->listClusters([/* ... */]);
$promise = $client->listClustersAsync([/* ... */]);

Returns an array of all the clusters in an account.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Clusters' => [
        [
            'ClusterArn' => '<string>',
            'ClusterEndpoints' => [
                [
                    'Endpoint' => '<string>',
                    'Region' => '<string>',
                ],
                // ...
            ],
            'Name' => '<string>',
            'Owner' => '<string>',
            'Status' => 'PENDING|DEPLOYED|PENDING_DELETION',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

404 response - MalformedQueryString. The query string contains a syntax error or resource not found.

ThrottlingException:

429 response - LimitExceededException or TooManyRequestsException.

ValidationException:

400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you might have used parameters together incorrectly.

InternalServerException:

500 response - InternalServiceError. Temporary service error. Retry the request.

AccessDeniedException:

403 response - You do not have sufficient access to perform this action.

ListControlPanels

$result = $client->listControlPanels([/* ... */]);
$promise = $client->listControlPanelsAsync([/* ... */]);

Returns an array of control panels in an account or in a cluster.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'ControlPanels' => [
        [
            'ClusterArn' => '<string>',
            'ControlPanelArn' => '<string>',
            'DefaultControlPanel' => true || false,
            'Name' => '<string>',
            'Owner' => '<string>',
            'RoutingControlCount' => <integer>,
            'Status' => 'PENDING|DEPLOYED|PENDING_DELETION',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

404 response - MalformedQueryString. The query string contains a syntax error or resource not found.

ThrottlingException:

429 response - LimitExceededException or TooManyRequestsException.

ValidationException:

400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you might have used parameters together incorrectly.

InternalServerException:

500 response - InternalServiceError. Temporary service error. Retry the request.

AccessDeniedException:

403 response - You do not have sufficient access to perform this action.

ListRoutingControls

$result = $client->listRoutingControls([/* ... */]);
$promise = $client->listRoutingControlsAsync([/* ... */]);

Returns an array of routing controls for a control panel. A routing control is an Amazon Route 53 Application Recovery Controller construct that has one of two states: ON and OFF. You can map the routing control state to the state of an Amazon Route 53 health check, which can be used to control routing.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'RoutingControls' => [
        [
            'ControlPanelArn' => '<string>',
            'Name' => '<string>',
            'Owner' => '<string>',
            'RoutingControlArn' => '<string>',
            'Status' => 'PENDING|DEPLOYED|PENDING_DELETION',
        ],
        // ...
    ],
]

Result Details

Errors

ResourceNotFoundException:

404 response - MalformedQueryString. The query string contains a syntax error or resource not found.

ThrottlingException:

429 response - LimitExceededException or TooManyRequestsException.

ValidationException:

400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you might have used parameters together incorrectly.

InternalServerException:

500 response - InternalServiceError. Temporary service error. Retry the request.

AccessDeniedException:

403 response - You do not have sufficient access to perform this action.

ListSafetyRules

$result = $client->listSafetyRules([/* ... */]);
$promise = $client->listSafetyRulesAsync([/* ... */]);

List the safety rules (the assertion rules and gating rules) that you've defined for the routing controls in a control panel.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'SafetyRules' => [
        [
            'ASSERTION' => [
                'AssertedControls' => ['<string>', ...],
                'ControlPanelArn' => '<string>',
                'Name' => '<string>',
                'Owner' => '<string>',
                'RuleConfig' => [
                    'Inverted' => true || false,
                    'Threshold' => <integer>,
                    'Type' => 'ATLEAST|AND|OR',
                ],
                'SafetyRuleArn' => '<string>',
                'Status' => 'PENDING|DEPLOYED|PENDING_DELETION',
                'WaitPeriodMs' => <integer>,
            ],
            'GATING' => [
                'ControlPanelArn' => '<string>',
                'GatingControls' => ['<string>', ...],
                'Name' => '<string>',
                'Owner' => '<string>',
                'RuleConfig' => [
                    'Inverted' => true || false,
                    'Threshold' => <integer>,
                    'Type' => 'ATLEAST|AND|OR',
                ],
                'SafetyRuleArn' => '<string>',
                'Status' => 'PENDING|DEPLOYED|PENDING_DELETION',
                'TargetControls' => ['<string>', ...],
                'WaitPeriodMs' => <integer>,
            ],
        ],
        // ...
    ],
]

Result Details

Errors

ResourceNotFoundException:

404 response - MalformedQueryString. The query string contains a syntax error or resource not found.

ThrottlingException:

429 response - LimitExceededException or TooManyRequestsException.

ValidationException:

400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you might have used parameters together incorrectly.

InternalServerException:

500 response - InternalServiceError. Temporary service error. Retry the request.

AccessDeniedException:

403 response - You do not have sufficient access to perform this action.

ListTagsForResource

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

Lists the tags for a resource.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

ResourceNotFoundException:

404 response - MalformedQueryString. The query string contains a syntax error or resource not found.

ValidationException:

400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you might have used parameters together incorrectly.

InternalServerException:

500 response - InternalServiceError. Temporary service error. Retry the request.

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

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

404 response - MalformedQueryString. The query string contains a syntax error or resource not found.

ValidationException:

400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you might have used parameters together incorrectly.

InternalServerException:

500 response - InternalServiceError. Temporary service error. Retry the request.

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

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

404 response - MalformedQueryString. The query string contains a syntax error or resource not found.

ValidationException:

400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you might have used parameters together incorrectly.

InternalServerException:

500 response - InternalServiceError. Temporary service error. Retry the request.

UpdateControlPanel

$result = $client->updateControlPanel([/* ... */]);
$promise = $client->updateControlPanelAsync([/* ... */]);

Updates a control panel. The only update you can make to a control panel is to change the name of the control panel.

Parameter Syntax

$result = $client->updateControlPanel([
    'ControlPanelArn' => '<string>', // REQUIRED
    'ControlPanelName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ControlPanel' => [
        'ClusterArn' => '<string>',
        'ControlPanelArn' => '<string>',
        'DefaultControlPanel' => true || false,
        'Name' => '<string>',
        'Owner' => '<string>',
        'RoutingControlCount' => <integer>,
        'Status' => 'PENDING|DEPLOYED|PENDING_DELETION',
    ],
]

Result Details

Errors

ValidationException:

400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you might have used parameters together incorrectly.

InternalServerException:

500 response - InternalServiceError. Temporary service error. Retry the request.

AccessDeniedException:

403 response - You do not have sufficient access to perform this action.

ResourceNotFoundException:

404 response - MalformedQueryString. The query string contains a syntax error or resource not found.

ThrottlingException:

429 response - LimitExceededException or TooManyRequestsException.

ConflictException:

409 response - ConflictException. You might be using a predefined variable.

UpdateRoutingControl

$result = $client->updateRoutingControl([/* ... */]);
$promise = $client->updateRoutingControlAsync([/* ... */]);

Updates a routing control. You can only update the name of the routing control. To get or update the routing control state, see the Recovery Cluster (data plane) API actions for Amazon Route 53 Application Recovery Controller.

Parameter Syntax

$result = $client->updateRoutingControl([
    'RoutingControlArn' => '<string>', // REQUIRED
    'RoutingControlName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'RoutingControl' => [
        'ControlPanelArn' => '<string>',
        'Name' => '<string>',
        'Owner' => '<string>',
        'RoutingControlArn' => '<string>',
        'Status' => 'PENDING|DEPLOYED|PENDING_DELETION',
    ],
]

Result Details

Errors

ValidationException:

400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you might have used parameters together incorrectly.

InternalServerException:

500 response - InternalServiceError. Temporary service error. Retry the request.

AccessDeniedException:

403 response - You do not have sufficient access to perform this action.

ResourceNotFoundException:

404 response - MalformedQueryString. The query string contains a syntax error or resource not found.

ThrottlingException:

429 response - LimitExceededException or TooManyRequestsException.

ConflictException:

409 response - ConflictException. You might be using a predefined variable.

UpdateSafetyRule

$result = $client->updateSafetyRule([/* ... */]);
$promise = $client->updateSafetyRuleAsync([/* ... */]);

Update a safety rule (an assertion rule or gating rule). You can only update the name and the waiting period for a safety rule. To make other updates, delete the safety rule and create a new one.

Parameter Syntax

$result = $client->updateSafetyRule([
    'AssertionRuleUpdate' => [
        'Name' => '<string>', // REQUIRED
        'SafetyRuleArn' => '<string>', // REQUIRED
        'WaitPeriodMs' => <integer>, // REQUIRED
    ],
    'GatingRuleUpdate' => [
        'Name' => '<string>', // REQUIRED
        'SafetyRuleArn' => '<string>', // REQUIRED
        'WaitPeriodMs' => <integer>, // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'AssertionRule' => [
        'AssertedControls' => ['<string>', ...],
        'ControlPanelArn' => '<string>',
        'Name' => '<string>',
        'Owner' => '<string>',
        'RuleConfig' => [
            'Inverted' => true || false,
            'Threshold' => <integer>,
            'Type' => 'ATLEAST|AND|OR',
        ],
        'SafetyRuleArn' => '<string>',
        'Status' => 'PENDING|DEPLOYED|PENDING_DELETION',
        'WaitPeriodMs' => <integer>,
    ],
    'GatingRule' => [
        'ControlPanelArn' => '<string>',
        'GatingControls' => ['<string>', ...],
        'Name' => '<string>',
        'Owner' => '<string>',
        'RuleConfig' => [
            'Inverted' => true || false,
            'Threshold' => <integer>,
            'Type' => 'ATLEAST|AND|OR',
        ],
        'SafetyRuleArn' => '<string>',
        'Status' => 'PENDING|DEPLOYED|PENDING_DELETION',
        'TargetControls' => ['<string>', ...],
        'WaitPeriodMs' => <integer>,
    ],
]

Result Details

Errors

ResourceNotFoundException:

404 response - MalformedQueryString. The query string contains a syntax error or resource not found.

ValidationException:

400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you might have used parameters together incorrectly.

InternalServerException:

500 response - InternalServiceError. Temporary service error. Retry the request.