CreateRule

$result = $client->createRule([/* ... */]);
$promise = $client->createRuleAsync([/* ... */]);

Creates a Recycle Bin retention rule. You can create two types of retention rules:

• Tag-level retention rules - These retention rules use resource tags to identify the resources to protect. For each retention rule, you specify one or more tag key and value pairs. Resources (of the specified type) that have at least one of these tag key and value pairs are automatically retained in the Recycle Bin upon deletion. Use this type of retention rule to protect specific resources in your account based on their tags.

• Region-level retention rules - These retention rules, by default, apply to all of the resources (of the specified type) in the Region, even if the resources are not tagged. However, you can specify exclusion tags to exclude resources that have specific tags. Use this type of retention rule to protect all resources of a specific type in a Region.

For more information, see Create Recycle Bin retention rules in the Amazon EBS User Guide.

Parameter Syntax

$result = $client->createRule([
    'Description' => '<string>',
    'ExcludeResourceTags' => [
        [
            'ResourceTagKey' => '<string>', // REQUIRED
            'ResourceTagValue' => '<string>',
        ],
        // ...
    ],
    'LockConfiguration' => [
        'UnlockDelay' => [ // REQUIRED
            'UnlockDelayUnit' => 'DAYS', // REQUIRED
            'UnlockDelayValue' => <integer>, // REQUIRED
        ],
    ],
    'ResourceTags' => [
        [
            'ResourceTagKey' => '<string>', // REQUIRED
            'ResourceTagValue' => '<string>',
        ],
        // ...
    ],
    'ResourceType' => 'EBS_SNAPSHOT|EC2_IMAGE', // REQUIRED
    'RetentionPeriod' => [ // REQUIRED
        'RetentionPeriodUnit' => 'DAYS', // REQUIRED
        'RetentionPeriodValue' => <integer>, // REQUIRED
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'Description' => '<string>',
    'ExcludeResourceTags' => [
        [
            'ResourceTagKey' => '<string>',
            'ResourceTagValue' => '<string>',
        ],
        // ...
    ],
    'Identifier' => '<string>',
    'LockConfiguration' => [
        'UnlockDelay' => [
            'UnlockDelayUnit' => 'DAYS',
            'UnlockDelayValue' => <integer>,
        ],
    ],
    'LockState' => 'locked|pending_unlock|unlocked',
    'ResourceTags' => [
        [
            'ResourceTagKey' => '<string>',
            'ResourceTagValue' => '<string>',
        ],
        // ...
    ],
    'ResourceType' => 'EBS_SNAPSHOT|EC2_IMAGE',
    'RetentionPeriod' => [
        'RetentionPeriodUnit' => 'DAYS',
        'RetentionPeriodValue' => <integer>,
    ],
    'RuleArn' => '<string>',
    'Status' => 'pending|available',
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

One or more of the parameters in the request is not valid.

ServiceQuotaExceededException:

The request would cause a service quota for the number of tags per resource to be exceeded.

InternalServerException:

The service could not respond to the request due to an internal problem.

DeleteRule

$result = $client->deleteRule([/* ... */]);
$promise = $client->deleteRuleAsync([/* ... */]);

Deletes a Recycle Bin retention rule. For more information, see Delete Recycle Bin retention rules in the Amazon Elastic Compute Cloud User Guide.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

The service could not respond to the request due to an internal problem.

ResourceNotFoundException:

The specified resource was not found.

ValidationException:

One or more of the parameters in the request is not valid.

ConflictException:

The specified retention rule lock request can't be completed.

GetRule

$result = $client->getRule([/* ... */]);
$promise = $client->getRuleAsync([/* ... */]);

Gets information about a Recycle Bin retention rule.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Description' => '<string>',
    'ExcludeResourceTags' => [
        [
            'ResourceTagKey' => '<string>',
            'ResourceTagValue' => '<string>',
        ],
        // ...
    ],
    'Identifier' => '<string>',
    'LockConfiguration' => [
        'UnlockDelay' => [
            'UnlockDelayUnit' => 'DAYS',
            'UnlockDelayValue' => <integer>,
        ],
    ],
    'LockEndTime' => <DateTime>,
    'LockState' => 'locked|pending_unlock|unlocked',
    'ResourceTags' => [
        [
            'ResourceTagKey' => '<string>',
            'ResourceTagValue' => '<string>',
        ],
        // ...
    ],
    'ResourceType' => 'EBS_SNAPSHOT|EC2_IMAGE',
    'RetentionPeriod' => [
        'RetentionPeriodUnit' => 'DAYS',
        'RetentionPeriodValue' => <integer>,
    ],
    'RuleArn' => '<string>',
    'Status' => 'pending|available',
]

Result Details

Errors

ValidationException:

One or more of the parameters in the request is not valid.

InternalServerException:

The service could not respond to the request due to an internal problem.

ResourceNotFoundException:

The specified resource was not found.

ListRules

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

Lists the Recycle Bin retention rules in the Region.

Parameter Syntax

$result = $client->listRules([
    'ExcludeResourceTags' => [
        [
            'ResourceTagKey' => '<string>', // REQUIRED
            'ResourceTagValue' => '<string>',
        ],
        // ...
    ],
    'LockState' => 'locked|pending_unlock|unlocked',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ResourceTags' => [
        [
            'ResourceTagKey' => '<string>', // REQUIRED
            'ResourceTagValue' => '<string>',
        ],
        // ...
    ],
    'ResourceType' => 'EBS_SNAPSHOT|EC2_IMAGE', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'Rules' => [
        [
            'Description' => '<string>',
            'Identifier' => '<string>',
            'LockState' => 'locked|pending_unlock|unlocked',
            'RetentionPeriod' => [
                'RetentionPeriodUnit' => 'DAYS',
                'RetentionPeriodValue' => <integer>,
            ],
            'RuleArn' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

One or more of the parameters in the request is not valid.

InternalServerException:

The service could not respond to the request due to an internal problem.

ListTagsForResource

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

Lists the tags assigned to a retention rule.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

One or more of the parameters in the request is not valid.

InternalServerException:

The service could not respond to the request due to an internal problem.

ResourceNotFoundException:

The specified resource was not found.

LockRule

$result = $client->lockRule([/* ... */]);
$promise = $client->lockRuleAsync([/* ... */]);

Locks a Region-level retention rule. A locked retention rule can't be modified or deleted.

Parameter Syntax

$result = $client->lockRule([
    'Identifier' => '<string>', // REQUIRED
    'LockConfiguration' => [ // REQUIRED
        'UnlockDelay' => [ // REQUIRED
            'UnlockDelayUnit' => 'DAYS', // REQUIRED
            'UnlockDelayValue' => <integer>, // REQUIRED
        ],
    ],
]);

Parameter Details

Result Syntax

[
    'Description' => '<string>',
    'ExcludeResourceTags' => [
        [
            'ResourceTagKey' => '<string>',
            'ResourceTagValue' => '<string>',
        ],
        // ...
    ],
    'Identifier' => '<string>',
    'LockConfiguration' => [
        'UnlockDelay' => [
            'UnlockDelayUnit' => 'DAYS',
            'UnlockDelayValue' => <integer>,
        ],
    ],
    'LockState' => 'locked|pending_unlock|unlocked',
    'ResourceTags' => [
        [
            'ResourceTagKey' => '<string>',
            'ResourceTagValue' => '<string>',
        ],
        // ...
    ],
    'ResourceType' => 'EBS_SNAPSHOT|EC2_IMAGE',
    'RetentionPeriod' => [
        'RetentionPeriodUnit' => 'DAYS',
        'RetentionPeriodValue' => <integer>,
    ],
    'RuleArn' => '<string>',
    'Status' => 'pending|available',
]

Result Details

Errors

InternalServerException:

The service could not respond to the request due to an internal problem.

ResourceNotFoundException:

The specified resource was not found.

ValidationException:

One or more of the parameters in the request is not valid.

ConflictException:

The specified retention rule lock request can't be completed.

TagResource

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

Assigns tags to the specified retention rule.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

One or more of the parameters in the request is not valid.

InternalServerException:

The service could not respond to the request due to an internal problem.

ResourceNotFoundException:

The specified resource was not found.

ServiceQuotaExceededException:

The request would cause a service quota for the number of tags per resource to be exceeded.

UnlockRule

$result = $client->unlockRule([/* ... */]);
$promise = $client->unlockRuleAsync([/* ... */]);

Unlocks a retention rule. After a retention rule is unlocked, it can be modified or deleted only after the unlock delay period expires.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Description' => '<string>',
    'ExcludeResourceTags' => [
        [
            'ResourceTagKey' => '<string>',
            'ResourceTagValue' => '<string>',
        ],
        // ...
    ],
    'Identifier' => '<string>',
    'LockConfiguration' => [
        'UnlockDelay' => [
            'UnlockDelayUnit' => 'DAYS',
            'UnlockDelayValue' => <integer>,
        ],
    ],
    'LockEndTime' => <DateTime>,
    'LockState' => 'locked|pending_unlock|unlocked',
    'ResourceTags' => [
        [
            'ResourceTagKey' => '<string>',
            'ResourceTagValue' => '<string>',
        ],
        // ...
    ],
    'ResourceType' => 'EBS_SNAPSHOT|EC2_IMAGE',
    'RetentionPeriod' => [
        'RetentionPeriodUnit' => 'DAYS',
        'RetentionPeriodValue' => <integer>,
    ],
    'RuleArn' => '<string>',
    'Status' => 'pending|available',
]

Result Details

Errors

InternalServerException:

The service could not respond to the request due to an internal problem.

ResourceNotFoundException:

The specified resource was not found.

ValidationException:

One or more of the parameters in the request is not valid.

ConflictException:

The specified retention rule lock request can't be completed.

UntagResource

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

Unassigns a tag from a retention rule.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

One or more of the parameters in the request is not valid.

InternalServerException:

The service could not respond to the request due to an internal problem.

ResourceNotFoundException:

The specified resource was not found.

UpdateRule

$result = $client->updateRule([/* ... */]);
$promise = $client->updateRuleAsync([/* ... */]);

Updates an existing Recycle Bin retention rule. You can update a retention rule's description, resource tags, and retention period at any time after creation. You can't update a retention rule's resource type after creation. For more information, see Update Recycle Bin retention rules in the Amazon Elastic Compute Cloud User Guide.

Parameter Syntax

$result = $client->updateRule([
    'Description' => '<string>',
    'ExcludeResourceTags' => [
        [
            'ResourceTagKey' => '<string>', // REQUIRED
            'ResourceTagValue' => '<string>',
        ],
        // ...
    ],
    'Identifier' => '<string>', // REQUIRED
    'ResourceTags' => [
        [
            'ResourceTagKey' => '<string>', // REQUIRED
            'ResourceTagValue' => '<string>',
        ],
        // ...
    ],
    'ResourceType' => 'EBS_SNAPSHOT|EC2_IMAGE',
    'RetentionPeriod' => [
        'RetentionPeriodUnit' => 'DAYS', // REQUIRED
        'RetentionPeriodValue' => <integer>, // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'Description' => '<string>',
    'ExcludeResourceTags' => [
        [
            'ResourceTagKey' => '<string>',
            'ResourceTagValue' => '<string>',
        ],
        // ...
    ],
    'Identifier' => '<string>',
    'LockEndTime' => <DateTime>,
    'LockState' => 'locked|pending_unlock|unlocked',
    'ResourceTags' => [
        [
            'ResourceTagKey' => '<string>',
            'ResourceTagValue' => '<string>',
        ],
        // ...
    ],
    'ResourceType' => 'EBS_SNAPSHOT|EC2_IMAGE',
    'RetentionPeriod' => [
        'RetentionPeriodUnit' => 'DAYS',
        'RetentionPeriodValue' => <integer>,
    ],
    'RuleArn' => '<string>',
    'Status' => 'pending|available',
]

Result Details

Errors

ValidationException:

One or more of the parameters in the request is not valid.

InternalServerException:

The service could not respond to the request due to an internal problem.

ResourceNotFoundException:

The specified resource was not found.

ConflictException:

The specified retention rule lock request can't be completed.

ServiceQuotaExceededException:

The request would cause a service quota for the number of tags per resource to be exceeded.