{ "smithy": "2.0", "metadata": { "suppressions": [ { "id": "HttpMethodSemantics", "namespace": "*" }, { "id": "HttpResponseCodeSemantics", "namespace": "*" }, { "id": "PaginatedTrait", "namespace": "*" }, { "id": "HttpHeaderTrait", "namespace": "*" }, { "id": "HttpUriConflict", "namespace": "*" }, { "id": "Service", "namespace": "*" } ] }, "shapes": { "com.amazonaws.rbin#AmazonRecycleBin": { "type": "service", "version": "2021-06-15", "operations": [ { "target": "com.amazonaws.rbin#CreateRule" }, { "target": "com.amazonaws.rbin#DeleteRule" }, { "target": "com.amazonaws.rbin#GetRule" }, { "target": "com.amazonaws.rbin#ListRules" }, { "target": "com.amazonaws.rbin#ListTagsForResource" }, { "target": "com.amazonaws.rbin#LockRule" }, { "target": "com.amazonaws.rbin#TagResource" }, { "target": "com.amazonaws.rbin#UnlockRule" }, { "target": "com.amazonaws.rbin#UntagResource" }, { "target": "com.amazonaws.rbin#UpdateRule" } ], "traits": { "aws.api#service": { "sdkId": "rbin", "arnNamespace": "rbin", "cloudFormationName": "Rbin", "cloudTrailEventSource": "rbin.amazonaws.com", "endpointPrefix": "rbin" }, "aws.auth#sigv4": { "name": "rbin" }, "aws.protocols#restJson1": {}, "smithy.api#documentation": "
This is the Recycle Bin API Reference. This documentation provides \n descriptions and syntax for each of the actions and data types in Recycle Bin.
\nRecycle Bin is a resource recovery feature that enables you to restore accidentally deleted \n EBS volumes, EBS snapshots, and EBS-backed AMIs. When using Recycle Bin, if your resources are \n deleted, they are retained in the Recycle Bin for a time period that you specify.
\nYou can restore a resource from the Recycle Bin at any time before its retention period \n expires. After you restore a resource from the Recycle Bin, the resource is removed from the \n Recycle Bin, and you can then use it in the same way you use any other resource of that type \n in your account. If the retention period expires and the resource is not restored, the resource \n is permanently deleted from the Recycle Bin and is no longer available for recovery. For more \n information about Recycle Bin, see \n Recycle Bin in the Amazon Elastic Compute Cloud User Guide.
", "smithy.api#title": "Amazon Recycle Bin", "smithy.rules#endpointBdd": { "version": "1.1", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" } }, "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] }, { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "results": [ { "conditions": [], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://rbin-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://rbin-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://rbin.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://rbin.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "root": 2, "nodeCount": 13, "nodes": "/////wAAAAH/////AAAAAAAAAAwAAAADAAAAAQAAAAQF9eELAAAAAgAAAAUF9eELAAAAAwAAAAgAAAAGAAAABAAAAAcF9eEKAAAABQX14QgF9eEJAAAABAAAAAoAAAAJAAAABgX14QYF9eEHAAAABQAAAAsF9eEFAAAABgX14QQF9eEFAAAAAwX14QEAAAANAAAABAX14QIF9eED" }, "smithy.rules#endpointRuleSet": { "version": "1.0", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" } }, "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Region" } ] } ], "rules": [ { "conditions": [ { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] } ] }, { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://rbin-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://rbin-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://rbin.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } ], "type": "tree" }, { "conditions": [], "endpoint": { "url": "https://rbin.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ] }, "smithy.rules#endpointTests": { "testCases": [ { "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://rbin.af-south-1.amazonaws.com" } }, "params": { "Region": "af-south-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://rbin.ap-east-1.amazonaws.com" } }, "params": { "Region": "ap-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://rbin.ap-northeast-1.amazonaws.com" } }, "params": { "Region": "ap-northeast-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://rbin.ap-northeast-2.amazonaws.com" } }, "params": { "Region": "ap-northeast-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://rbin.ap-northeast-3.amazonaws.com" } }, "params": { "Region": "ap-northeast-3", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://rbin.ap-south-1.amazonaws.com" } }, "params": { "Region": "ap-south-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://rbin.ap-southeast-1.amazonaws.com" } }, "params": { "Region": "ap-southeast-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://rbin.ap-southeast-2.amazonaws.com" } }, "params": { "Region": "ap-southeast-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://rbin.ca-central-1.amazonaws.com" } }, "params": { "Region": "ca-central-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://rbin.eu-central-1.amazonaws.com" } }, "params": { "Region": "eu-central-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://rbin.eu-north-1.amazonaws.com" } }, "params": { "Region": "eu-north-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://rbin.eu-south-1.amazonaws.com" } }, "params": { "Region": "eu-south-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://rbin.eu-west-1.amazonaws.com" } }, "params": { "Region": "eu-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://rbin.eu-west-2.amazonaws.com" } }, "params": { "Region": "eu-west-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://rbin.eu-west-3.amazonaws.com" } }, "params": { "Region": "eu-west-3", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://rbin.me-south-1.amazonaws.com" } }, "params": { "Region": "me-south-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://rbin.sa-east-1.amazonaws.com" } }, "params": { "Region": "sa-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://rbin.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://rbin.us-east-2.amazonaws.com" } }, "params": { "Region": "us-east-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://rbin.us-west-1.amazonaws.com" } }, "params": { "Region": "us-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://rbin.us-west-2.amazonaws.com" } }, "params": { "Region": "us-west-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://rbin-fips.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://rbin-fips.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://rbin.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://rbin-fips.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://rbin-fips.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://rbin.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://rbin.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://rbin-fips.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://rbin-fips.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://rbin.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://rbin.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://rbin-fips.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://rbin.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://rbin-fips.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://rbin.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips enabled and dualstack disabled", "expect": { "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips disabled and dualstack enabled", "expect": { "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true, "Endpoint": "https://example.com" } }, { "documentation": "Missing region", "expect": { "error": "Invalid Configuration: Missing Region" } } ], "version": "1.0" } } }, "com.amazonaws.rbin#ConflictException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.rbin#ErrorMessage" }, "Reason": { "target": "com.amazonaws.rbin#ConflictExceptionReason", "traits": { "smithy.api#documentation": "The reason for the exception.
" } } }, "traits": { "smithy.api#documentation": "The specified retention rule lock request can't be completed.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.rbin#ConflictExceptionReason": { "type": "enum", "members": { "INVALID_RULE_STATE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID_RULE_STATE" } } } }, "com.amazonaws.rbin#CreateRule": { "type": "operation", "input": { "target": "com.amazonaws.rbin#CreateRuleRequest" }, "output": { "target": "com.amazonaws.rbin#CreateRuleResponse" }, "errors": [ { "target": "com.amazonaws.rbin#InternalServerException" }, { "target": "com.amazonaws.rbin#ServiceQuotaExceededException" }, { "target": "com.amazonaws.rbin#ValidationException" } ], "traits": { "smithy.api#documentation": "Creates a Recycle Bin retention rule. You can create two types of retention rules:
\n\n Tag-level retention rules - These retention rules use \n resource tags to identify the resources to protect. For each retention rule, you specify one or \n more tag key and value pairs. Resources (of the specified type) that have at least one of these \n tag key and value pairs are automatically retained in the Recycle Bin upon deletion. Use this \n type of retention rule to protect specific resources in your account based on their tags.
\n\n Region-level retention rules - These retention rules, \n by default, apply to all of the resources (of the specified type) in the Region, even if the \n resources are not tagged. However, you can specify exclusion tags to exclude resources that have \n specific tags. Use this type of retention rule to protect all resources of a specific type in a \n Region.
\nFor more information, see \n Create Recycle Bin retention rules in the Amazon EBS User Guide.
", "smithy.api#http": { "method": "POST", "uri": "/rules", "code": 201 } } }, "com.amazonaws.rbin#CreateRuleRequest": { "type": "structure", "members": { "RetentionPeriod": { "target": "com.amazonaws.rbin#RetentionPeriod", "traits": { "smithy.api#documentation": "Information about the retention period for which the retention rule is to \n retain resources.
", "smithy.api#required": {} } }, "Description": { "target": "com.amazonaws.rbin#Description", "traits": { "smithy.api#documentation": "The retention rule description.
" } }, "Tags": { "target": "com.amazonaws.rbin#TagList", "traits": { "smithy.api#documentation": "Information about the tags to assign to the retention rule.
" } }, "ResourceType": { "target": "com.amazonaws.rbin#ResourceType", "traits": { "smithy.api#documentation": "The resource type to be retained by the retention rule. Currently, only EBS volumes, EBS snapshots, and EBS-backed AMIs \n are supported.
\nTo retain EBS volumes, specify EBS_VOLUME.
To retain EBS snapshots, specify EBS_SNAPSHOT\n
To retain EBS-backed AMIs, specify EC2_IMAGE.
[Tag-level retention rules only] Specifies the resource tags to use to identify resources that are to be retained by a \n tag-level retention rule. For tag-level retention rules, only deleted resources, of the specified resource type, that \n have one or more of the specified tag key and value pairs are retained. If a resource is deleted, but it does not have \n any of the specified tag key and value pairs, it is immediately deleted without being retained by the retention rule.
\nYou can add the same tag key and value pair to a maximum or five retention rules.
\nTo create a Region-level retention rule, omit this parameter. A Region-level retention rule \n does not have any resource tags specified. It retains all deleted resources of the specified \n resource type in the Region in which the rule is created, even if the resources are not tagged.
" } }, "LockConfiguration": { "target": "com.amazonaws.rbin#LockConfiguration", "traits": { "smithy.api#documentation": "Information about the retention rule lock configuration.
" } }, "ExcludeResourceTags": { "target": "com.amazonaws.rbin#ExcludeResourceTags", "traits": { "smithy.api#documentation": "[Region-level retention rules only] Specifies the exclusion tags to use to identify resources that are to be excluded, \nor ignored, by a Region-level retention rule. Resources that have any of these tags are not retained by the retention rule \nupon deletion.
\nYou can't specify exclusion tags for tag-level retention rules.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.rbin#CreateRuleResponse": { "type": "structure", "members": { "Identifier": { "target": "com.amazonaws.rbin#RuleIdentifier", "traits": { "smithy.api#documentation": "The unique ID of the retention rule.
" } }, "RetentionPeriod": { "target": "com.amazonaws.rbin#RetentionPeriod" }, "Description": { "target": "com.amazonaws.rbin#Description", "traits": { "smithy.api#documentation": "The retention rule description.
" } }, "Tags": { "target": "com.amazonaws.rbin#TagList", "traits": { "smithy.api#documentation": "Information about the tags assigned to the retention rule.
" } }, "ResourceType": { "target": "com.amazonaws.rbin#ResourceType", "traits": { "smithy.api#documentation": "The resource type retained by the retention rule.
" } }, "ResourceTags": { "target": "com.amazonaws.rbin#ResourceTags", "traits": { "smithy.api#documentation": "[Tag-level retention rules only] Information about the resource tags used to identify resources that are retained by the retention \n rule.
" } }, "Status": { "target": "com.amazonaws.rbin#RuleStatus", "traits": { "smithy.api#documentation": "The state of the retention rule. Only retention rules that are in the available \n state retain resources.
Information about the retention rule lock configuration.
" } }, "LockState": { "target": "com.amazonaws.rbin#LockState", "traits": { "smithy.api#documentation": "[Region-level retention rules only] The lock state for the retention rule.
\n\n locked - The retention rule is locked and can't be modified or deleted.
\n pending_unlock - The retention rule has been unlocked but it is still within \n the unlock delay period. The retention rule can be modified or deleted only after the unlock \n delay period has expired.
\n unlocked - The retention rule is unlocked and it can be modified or deleted by \n any user with the required permissions.
\n null - The retention rule has never been locked. Once a retention rule has \n been locked, it can transition between the locked and unlocked states \n only; it can never transition back to null.
The Amazon Resource Name (ARN) of the retention rule.
" } }, "ExcludeResourceTags": { "target": "com.amazonaws.rbin#ExcludeResourceTags", "traits": { "smithy.api#documentation": "[Region-level retention rules only] Information about the exclusion tags used to identify resources that are to be \nexcluded, or ignored, by the retention rule.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.rbin#DeleteRule": { "type": "operation", "input": { "target": "com.amazonaws.rbin#DeleteRuleRequest" }, "output": { "target": "com.amazonaws.rbin#DeleteRuleResponse" }, "errors": [ { "target": "com.amazonaws.rbin#ConflictException" }, { "target": "com.amazonaws.rbin#InternalServerException" }, { "target": "com.amazonaws.rbin#ResourceNotFoundException" }, { "target": "com.amazonaws.rbin#ValidationException" } ], "traits": { "smithy.api#documentation": "Deletes a Recycle Bin retention rule. For more information, see \n Delete Recycle Bin retention rules in the Amazon Elastic Compute Cloud User Guide.
", "smithy.api#http": { "method": "DELETE", "uri": "/rules/{Identifier}", "code": 204 } } }, "com.amazonaws.rbin#DeleteRuleRequest": { "type": "structure", "members": { "Identifier": { "target": "com.amazonaws.rbin#RuleIdentifier", "traits": { "smithy.api#documentation": "The unique ID of the retention rule.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.rbin#DeleteRuleResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.rbin#Description": { "type": "string", "traits": { "smithy.api#pattern": "^[\\S ]{0,255}$" } }, "com.amazonaws.rbin#ErrorMessage": { "type": "string" }, "com.amazonaws.rbin#ExcludeResourceTags": { "type": "list", "member": { "target": "com.amazonaws.rbin#ResourceTag" }, "traits": { "smithy.api#length": { "min": 0, "max": 5 } } }, "com.amazonaws.rbin#GetRule": { "type": "operation", "input": { "target": "com.amazonaws.rbin#GetRuleRequest" }, "output": { "target": "com.amazonaws.rbin#GetRuleResponse" }, "errors": [ { "target": "com.amazonaws.rbin#InternalServerException" }, { "target": "com.amazonaws.rbin#ResourceNotFoundException" }, { "target": "com.amazonaws.rbin#ValidationException" } ], "traits": { "smithy.api#documentation": "Gets information about a Recycle Bin retention rule.
", "smithy.api#http": { "method": "GET", "uri": "/rules/{Identifier}", "code": 200 } } }, "com.amazonaws.rbin#GetRuleRequest": { "type": "structure", "members": { "Identifier": { "target": "com.amazonaws.rbin#RuleIdentifier", "traits": { "smithy.api#documentation": "The unique ID of the retention rule.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.rbin#GetRuleResponse": { "type": "structure", "members": { "Identifier": { "target": "com.amazonaws.rbin#RuleIdentifier", "traits": { "smithy.api#documentation": "The unique ID of the retention rule.
" } }, "Description": { "target": "com.amazonaws.rbin#Description", "traits": { "smithy.api#documentation": "The retention rule description.
" } }, "ResourceType": { "target": "com.amazonaws.rbin#ResourceType", "traits": { "smithy.api#documentation": "The resource type retained by the retention rule.
" } }, "RetentionPeriod": { "target": "com.amazonaws.rbin#RetentionPeriod", "traits": { "smithy.api#documentation": "Information about the retention period for which the retention rule is to \n retain resources.
" } }, "ResourceTags": { "target": "com.amazonaws.rbin#ResourceTags", "traits": { "smithy.api#documentation": "[Tag-level retention rules only] Information about the resource tags used to identify resources that are retained by the retention \n rule.
" } }, "Status": { "target": "com.amazonaws.rbin#RuleStatus", "traits": { "smithy.api#documentation": "The state of the retention rule. Only retention rules that are in the available \n state retain resources.
Information about the retention rule lock configuration.
" } }, "LockState": { "target": "com.amazonaws.rbin#LockState", "traits": { "smithy.api#documentation": "[Region-level retention rules only] The lock state for the retention rule.
\n\n locked - The retention rule is locked and can't be modified or deleted.
\n pending_unlock - The retention rule has been unlocked but it is still within \n the unlock delay period. The retention rule can be modified or deleted only after the unlock \n delay period has expired.
\n unlocked - The retention rule is unlocked and it can be modified or deleted by \n any user with the required permissions.
\n null - The retention rule has never been locked. Once a retention rule has \n been locked, it can transition between the locked and unlocked states \n only; it can never transition back to null.
The date and time at which the unlock delay is set to expire. Only returned \n for retention rules that have been unlocked and that are still within the unlock \n delay period.
" } }, "RuleArn": { "target": "com.amazonaws.rbin#RuleArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the retention rule.
" } }, "ExcludeResourceTags": { "target": "com.amazonaws.rbin#ExcludeResourceTags", "traits": { "smithy.api#documentation": "[Region-level retention rules only] Information about the exclusion tags used to identify resources that are to be \nexcluded, or ignored, by the retention rule.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.rbin#InternalServerException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.rbin#ErrorMessage" } }, "traits": { "smithy.api#documentation": "The service could not respond to the request due to an internal problem.
", "smithy.api#error": "server", "smithy.api#httpError": 500 } }, "com.amazonaws.rbin#ListRules": { "type": "operation", "input": { "target": "com.amazonaws.rbin#ListRulesRequest" }, "output": { "target": "com.amazonaws.rbin#ListRulesResponse" }, "errors": [ { "target": "com.amazonaws.rbin#InternalServerException" }, { "target": "com.amazonaws.rbin#ValidationException" } ], "traits": { "smithy.api#documentation": "Lists the Recycle Bin retention rules in the Region.
", "smithy.api#http": { "method": "POST", "uri": "/list-rules", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "Rules", "pageSize": "MaxResults" } } }, "com.amazonaws.rbin#ListRulesRequest": { "type": "structure", "members": { "MaxResults": { "target": "com.amazonaws.rbin#MaxResults", "traits": { "smithy.api#documentation": "The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned NextToken value.
The token for the next page of results.
" } }, "ResourceType": { "target": "com.amazonaws.rbin#ResourceType", "traits": { "smithy.api#documentation": "The resource type retained by the retention rule. Only retention rules that retain \n the specified resource type are listed. Currently, only EBS volumes, EBS snapshots, and EBS-backed AMIs are supported.
\nTo list retention rules that retain EBS volumes, specify EBS_VOLUME.
To list retention rules that retain EBS snapshots, specify EBS_SNAPSHOT.
To list retention rules that retain EBS-backed AMIs, specify EC2_IMAGE.
[Tag-level retention rules only] Information about the resource tags used to identify resources that are retained by the retention \n rule.
" } }, "LockState": { "target": "com.amazonaws.rbin#LockState", "traits": { "smithy.api#documentation": "The lock state of the retention rules to list. Only retention rules with the specified \n lock state are returned.
" } }, "ExcludeResourceTags": { "target": "com.amazonaws.rbin#ExcludeResourceTags", "traits": { "smithy.api#documentation": "[Region-level retention rules only] Information about the exclusion tags used to identify resources that are to be \nexcluded, or ignored, by the retention rule.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.rbin#ListRulesResponse": { "type": "structure", "members": { "Rules": { "target": "com.amazonaws.rbin#RuleSummaryList", "traits": { "smithy.api#documentation": "Information about the retention rules.
" } }, "NextToken": { "target": "com.amazonaws.rbin#NextToken", "traits": { "smithy.api#documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Lists the tags assigned to a retention rule.
", "smithy.api#http": { "method": "GET", "uri": "/tags/{ResourceArn}", "code": 200 } } }, "com.amazonaws.rbin#ListTagsForResourceRequest": { "type": "structure", "members": { "ResourceArn": { "target": "com.amazonaws.rbin#RuleArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the retention rule.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.rbin#ListTagsForResourceResponse": { "type": "structure", "members": { "Tags": { "target": "com.amazonaws.rbin#TagList", "traits": { "smithy.api#documentation": "Information about the tags assigned to the retention rule.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.rbin#LockConfiguration": { "type": "structure", "members": { "UnlockDelay": { "target": "com.amazonaws.rbin#UnlockDelay", "traits": { "smithy.api#documentation": "Information about the retention rule unlock delay.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Information about a retention rule lock configuration.
" } }, "com.amazonaws.rbin#LockRule": { "type": "operation", "input": { "target": "com.amazonaws.rbin#LockRuleRequest" }, "output": { "target": "com.amazonaws.rbin#LockRuleResponse" }, "errors": [ { "target": "com.amazonaws.rbin#ConflictException" }, { "target": "com.amazonaws.rbin#InternalServerException" }, { "target": "com.amazonaws.rbin#ResourceNotFoundException" }, { "target": "com.amazonaws.rbin#ValidationException" } ], "traits": { "smithy.api#documentation": "Locks a Region-level retention rule. A locked retention rule can't be modified or \n deleted.
\nYou can't lock tag-level retention rules, or Region-level retention rules that \n have exclusion tags.
\nThe unique ID of the retention rule.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "LockConfiguration": { "target": "com.amazonaws.rbin#LockConfiguration", "traits": { "smithy.api#documentation": "Information about the retention rule lock configuration.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.rbin#LockRuleResponse": { "type": "structure", "members": { "Identifier": { "target": "com.amazonaws.rbin#RuleIdentifier", "traits": { "smithy.api#documentation": "The unique ID of the retention rule.
" } }, "Description": { "target": "com.amazonaws.rbin#Description", "traits": { "smithy.api#documentation": "The retention rule description.
" } }, "ResourceType": { "target": "com.amazonaws.rbin#ResourceType", "traits": { "smithy.api#documentation": "The resource type retained by the retention rule.
" } }, "RetentionPeriod": { "target": "com.amazonaws.rbin#RetentionPeriod" }, "ResourceTags": { "target": "com.amazonaws.rbin#ResourceTags", "traits": { "smithy.api#documentation": "[Tag-level retention rules only] Information about the resource tags used to identify resources that are retained by the retention \n rule.
" } }, "Status": { "target": "com.amazonaws.rbin#RuleStatus", "traits": { "smithy.api#documentation": "The state of the retention rule. Only retention rules that are in the available \n state retain resources.
Information about the retention rule lock configuration.
" } }, "LockState": { "target": "com.amazonaws.rbin#LockState", "traits": { "smithy.api#documentation": "[Region-level retention rules only] The lock state for the retention rule.
\n\n locked - The retention rule is locked and can't be modified or deleted.
\n pending_unlock - The retention rule has been unlocked but it is still within \n the unlock delay period. The retention rule can be modified or deleted only after the unlock \n delay period has expired.
\n unlocked - The retention rule is unlocked and it can be modified or deleted by \n any user with the required permissions.
\n null - The retention rule has never been locked. Once a retention rule has \n been locked, it can transition between the locked and unlocked states \n only; it can never transition back to null.
The Amazon Resource Name (ARN) of the retention rule.
" } }, "ExcludeResourceTags": { "target": "com.amazonaws.rbin#ExcludeResourceTags", "traits": { "smithy.api#documentation": "[Region-level retention rules only] Information about the exclusion tags used to identify resources that are to be \nexcluded, or ignored, by the retention rule.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.rbin#LockState": { "type": "enum", "members": { "LOCKED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "locked" } }, "PENDING_UNLOCK": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "pending_unlock" } }, "UNLOCKED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "unlocked" } } } }, "com.amazonaws.rbin#MaxResults": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 1000 } } }, "com.amazonaws.rbin#NextToken": { "type": "string", "traits": { "smithy.api#pattern": "^[A-Za-z0-9+/=]{1,2048}$" } }, "com.amazonaws.rbin#ResourceNotFoundException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.rbin#ErrorMessage" }, "Reason": { "target": "com.amazonaws.rbin#ResourceNotFoundExceptionReason", "traits": { "smithy.api#documentation": "The reason for the exception.
" } } }, "traits": { "smithy.api#documentation": "The specified resource was not found.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.rbin#ResourceNotFoundExceptionReason": { "type": "enum", "members": { "RULE_NOT_FOUND": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RULE_NOT_FOUND" } } } }, "com.amazonaws.rbin#ResourceTag": { "type": "structure", "members": { "ResourceTagKey": { "target": "com.amazonaws.rbin#ResourceTagKey", "traits": { "smithy.api#documentation": "The tag key.
", "smithy.api#required": {} } }, "ResourceTagValue": { "target": "com.amazonaws.rbin#ResourceTagValue", "traits": { "smithy.api#documentation": "The tag value.
" } } }, "traits": { "smithy.api#documentation": "[Tag-level retention rules only] Information about the resource tags used to identify resources that are retained by the retention \n rule.
" } }, "com.amazonaws.rbin#ResourceTagKey": { "type": "string", "traits": { "smithy.api#pattern": "^[\\S\\s]{1,128}$" } }, "com.amazonaws.rbin#ResourceTagValue": { "type": "string", "traits": { "smithy.api#pattern": "^[\\S\\s]{0,256}$" } }, "com.amazonaws.rbin#ResourceTags": { "type": "list", "member": { "target": "com.amazonaws.rbin#ResourceTag" }, "traits": { "smithy.api#length": { "min": 0, "max": 50 } } }, "com.amazonaws.rbin#ResourceType": { "type": "enum", "members": { "EBS_SNAPSHOT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EBS_SNAPSHOT" } }, "EC2_IMAGE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EC2_IMAGE" } }, "EBS_VOLUME": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EBS_VOLUME" } } } }, "com.amazonaws.rbin#RetentionPeriod": { "type": "structure", "members": { "RetentionPeriodValue": { "target": "com.amazonaws.rbin#RetentionPeriodValue", "traits": { "smithy.api#documentation": "The period value for which the retention rule is to retain resources, measured in days. \n The supported retention periods are:
\nEBS volumes: 1 - 7 days
\nEBS snapshots and EBS-backed AMIs: 1 - 365 days
\nThe unit of time in which the retention period is measured. Currently, only DAYS \n is supported.
Information about the retention period for which the retention rule is to \n retain resources.
" } }, "com.amazonaws.rbin#RetentionPeriodUnit": { "type": "enum", "members": { "DAYS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DAYS" } } } }, "com.amazonaws.rbin#RetentionPeriodValue": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 3650 } } }, "com.amazonaws.rbin#RuleArn": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1011 }, "smithy.api#pattern": "^arn:\\S+:rbin:[a-z\\-0-9]{0,63}:[0-9]{12}:rule/[0-9a-zA-Z]{11}{0,1011}$" } }, "com.amazonaws.rbin#RuleIdentifier": { "type": "string", "traits": { "smithy.api#pattern": "^[0-9a-zA-Z]{11}$" } }, "com.amazonaws.rbin#RuleStatus": { "type": "enum", "members": { "PENDING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "pending" } }, "AVAILABLE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "available" } } } }, "com.amazonaws.rbin#RuleSummary": { "type": "structure", "members": { "Identifier": { "target": "com.amazonaws.rbin#RuleIdentifier", "traits": { "smithy.api#documentation": "The unique ID of the retention rule.
" } }, "Description": { "target": "com.amazonaws.rbin#Description", "traits": { "smithy.api#documentation": "The retention rule description.
" } }, "RetentionPeriod": { "target": "com.amazonaws.rbin#RetentionPeriod", "traits": { "smithy.api#documentation": "Information about the retention period for which the retention rule is to \n retain resources.
" } }, "LockState": { "target": "com.amazonaws.rbin#LockState", "traits": { "smithy.api#documentation": "[Region-level retention rules only] The lock state for the retention rule.
\n\n locked - The retention rule is locked and can't be modified or deleted.
\n pending_unlock - The retention rule has been unlocked but it is still within \n the unlock delay period. The retention rule can be modified or deleted only after the unlock \n delay period has expired.
\n unlocked - The retention rule is unlocked and it can be modified or deleted by \n any user with the required permissions.
\n null - The retention rule has never been locked. Once a retention rule has \n been locked, it can transition between the locked and unlocked states \n only; it can never transition back to null.
The Amazon Resource Name (ARN) of the retention rule.
" } } }, "traits": { "smithy.api#documentation": "Information about a Recycle Bin retention rule.
" } }, "com.amazonaws.rbin#RuleSummaryList": { "type": "list", "member": { "target": "com.amazonaws.rbin#RuleSummary" } }, "com.amazonaws.rbin#ServiceQuotaExceededException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.rbin#ErrorMessage" }, "Reason": { "target": "com.amazonaws.rbin#ServiceQuotaExceededExceptionReason", "traits": { "smithy.api#documentation": "The reason for the exception.
" } } }, "traits": { "smithy.api#documentation": "The request would cause a service quota for the number of tags per resource to be exceeded.
", "smithy.api#error": "client", "smithy.api#httpError": 402 } }, "com.amazonaws.rbin#ServiceQuotaExceededExceptionReason": { "type": "enum", "members": { "SERVICE_QUOTA_EXCEEDED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SERVICE_QUOTA_EXCEEDED" } } } }, "com.amazonaws.rbin#Tag": { "type": "structure", "members": { "Key": { "target": "com.amazonaws.rbin#TagKey", "traits": { "smithy.api#documentation": "The tag key.
", "smithy.api#required": {} } }, "Value": { "target": "com.amazonaws.rbin#TagValue", "traits": { "smithy.api#documentation": "The tag value.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Information about the tags to assign to the retention rule.
" } }, "com.amazonaws.rbin#TagKey": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" } }, "com.amazonaws.rbin#TagKeyList": { "type": "list", "member": { "target": "com.amazonaws.rbin#TagKey" }, "traits": { "smithy.api#length": { "min": 0, "max": 200 } } }, "com.amazonaws.rbin#TagList": { "type": "list", "member": { "target": "com.amazonaws.rbin#Tag" }, "traits": { "smithy.api#length": { "min": 0, "max": 200 } } }, "com.amazonaws.rbin#TagResource": { "type": "operation", "input": { "target": "com.amazonaws.rbin#TagResourceRequest" }, "output": { "target": "com.amazonaws.rbin#TagResourceResponse" }, "errors": [ { "target": "com.amazonaws.rbin#InternalServerException" }, { "target": "com.amazonaws.rbin#ResourceNotFoundException" }, { "target": "com.amazonaws.rbin#ServiceQuotaExceededException" }, { "target": "com.amazonaws.rbin#ValidationException" } ], "traits": { "smithy.api#documentation": "Assigns tags to the specified retention rule.
", "smithy.api#http": { "method": "POST", "uri": "/tags/{ResourceArn}", "code": 201 } } }, "com.amazonaws.rbin#TagResourceRequest": { "type": "structure", "members": { "ResourceArn": { "target": "com.amazonaws.rbin#RuleArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the retention rule.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.rbin#TagList", "traits": { "smithy.api#documentation": "Information about the tags to assign to the retention rule.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.rbin#TagResourceResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.rbin#TagValue": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 }, "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" } }, "com.amazonaws.rbin#TimeStamp": { "type": "timestamp" }, "com.amazonaws.rbin#UnlockDelay": { "type": "structure", "members": { "UnlockDelayValue": { "target": "com.amazonaws.rbin#UnlockDelayValue", "traits": { "smithy.api#documentation": "The unlock delay period, measured in the unit specified for \n UnlockDelayUnit.
", "smithy.api#required": {} } }, "UnlockDelayUnit": { "target": "com.amazonaws.rbin#UnlockDelayUnit", "traits": { "smithy.api#documentation": "The unit of time in which to measure the unlock delay. Currently, the unlock delay can \n be measured only in days.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Information about the retention rule unlock delay. The unlock delay is the period after which \n a retention rule can be modified or edited after it has been unlocked by a user with the required \n permissions. The retention rule can't be modified or deleted during the unlock delay.
" } }, "com.amazonaws.rbin#UnlockDelayUnit": { "type": "enum", "members": { "DAYS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DAYS" } } } }, "com.amazonaws.rbin#UnlockDelayValue": { "type": "integer", "traits": { "smithy.api#range": { "min": 7, "max": 30 } } }, "com.amazonaws.rbin#UnlockRule": { "type": "operation", "input": { "target": "com.amazonaws.rbin#UnlockRuleRequest" }, "output": { "target": "com.amazonaws.rbin#UnlockRuleResponse" }, "errors": [ { "target": "com.amazonaws.rbin#ConflictException" }, { "target": "com.amazonaws.rbin#InternalServerException" }, { "target": "com.amazonaws.rbin#ResourceNotFoundException" }, { "target": "com.amazonaws.rbin#ValidationException" } ], "traits": { "smithy.api#documentation": "Unlocks a retention rule. After a retention rule is unlocked, it can be modified or deleted \n only after the unlock delay period expires.
", "smithy.api#http": { "method": "PATCH", "uri": "/rules/{Identifier}/unlock", "code": 200 } } }, "com.amazonaws.rbin#UnlockRuleRequest": { "type": "structure", "members": { "Identifier": { "target": "com.amazonaws.rbin#RuleIdentifier", "traits": { "smithy.api#documentation": "The unique ID of the retention rule.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.rbin#UnlockRuleResponse": { "type": "structure", "members": { "Identifier": { "target": "com.amazonaws.rbin#RuleIdentifier", "traits": { "smithy.api#documentation": "The unique ID of the retention rule.
" } }, "Description": { "target": "com.amazonaws.rbin#Description", "traits": { "smithy.api#documentation": "The retention rule description.
" } }, "ResourceType": { "target": "com.amazonaws.rbin#ResourceType", "traits": { "smithy.api#documentation": "The resource type retained by the retention rule.
" } }, "RetentionPeriod": { "target": "com.amazonaws.rbin#RetentionPeriod" }, "ResourceTags": { "target": "com.amazonaws.rbin#ResourceTags", "traits": { "smithy.api#documentation": "[Tag-level retention rules only] Information about the resource tags used to identify resources that are retained by the retention \n rule.
" } }, "Status": { "target": "com.amazonaws.rbin#RuleStatus", "traits": { "smithy.api#documentation": "The state of the retention rule. Only retention rules that are in the available \n state retain resources.
Information about the retention rule lock configuration.
" } }, "LockState": { "target": "com.amazonaws.rbin#LockState", "traits": { "smithy.api#documentation": "[Region-level retention rules only] The lock state for the retention rule.
\n\n locked - The retention rule is locked and can't be modified or deleted.
\n pending_unlock - The retention rule has been unlocked but it is still within \n the unlock delay period. The retention rule can be modified or deleted only after the unlock \n delay period has expired.
\n unlocked - The retention rule is unlocked and it can be modified or deleted by \n any user with the required permissions.
\n null - The retention rule has never been locked. Once a retention rule has \n been locked, it can transition between the locked and unlocked states \n only; it can never transition back to null.
The date and time at which the unlock delay is set to expire. Only returned \n for retention rules that have been unlocked and that are still within the unlock \n delay period.
" } }, "RuleArn": { "target": "com.amazonaws.rbin#RuleArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the retention rule.
" } }, "ExcludeResourceTags": { "target": "com.amazonaws.rbin#ExcludeResourceTags", "traits": { "smithy.api#documentation": "[Region-level retention rules only] Information about the exclusion tags used to identify resources that are to be \nexcluded, or ignored, by the retention rule.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.rbin#UntagResource": { "type": "operation", "input": { "target": "com.amazonaws.rbin#UntagResourceRequest" }, "output": { "target": "com.amazonaws.rbin#UntagResourceResponse" }, "errors": [ { "target": "com.amazonaws.rbin#InternalServerException" }, { "target": "com.amazonaws.rbin#ResourceNotFoundException" }, { "target": "com.amazonaws.rbin#ValidationException" } ], "traits": { "smithy.api#documentation": "Unassigns a tag from a retention rule.
", "smithy.api#http": { "method": "DELETE", "uri": "/tags/{ResourceArn}", "code": 204 } } }, "com.amazonaws.rbin#UntagResourceRequest": { "type": "structure", "members": { "ResourceArn": { "target": "com.amazonaws.rbin#RuleArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the retention rule.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "TagKeys": { "target": "com.amazonaws.rbin#TagKeyList", "traits": { "smithy.api#documentation": "The tag keys of the tags to unassign. All tags that have the specified tag key are unassigned.
", "smithy.api#httpQuery": "tagKeys", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.rbin#UntagResourceResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.rbin#UpdateRule": { "type": "operation", "input": { "target": "com.amazonaws.rbin#UpdateRuleRequest" }, "output": { "target": "com.amazonaws.rbin#UpdateRuleResponse" }, "errors": [ { "target": "com.amazonaws.rbin#ConflictException" }, { "target": "com.amazonaws.rbin#InternalServerException" }, { "target": "com.amazonaws.rbin#ResourceNotFoundException" }, { "target": "com.amazonaws.rbin#ServiceQuotaExceededException" }, { "target": "com.amazonaws.rbin#ValidationException" } ], "traits": { "smithy.api#documentation": "Updates an existing Recycle Bin retention rule. You can update a retention rule's description, \n resource tags, and retention period at any time after creation. You can't update a retention rule's \n resource type after creation. For more information, see \n Update Recycle Bin retention rules in the Amazon Elastic Compute Cloud User Guide.
", "smithy.api#http": { "method": "PATCH", "uri": "/rules/{Identifier}", "code": 200 } } }, "com.amazonaws.rbin#UpdateRuleRequest": { "type": "structure", "members": { "Identifier": { "target": "com.amazonaws.rbin#RuleIdentifier", "traits": { "smithy.api#documentation": "The unique ID of the retention rule.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "RetentionPeriod": { "target": "com.amazonaws.rbin#RetentionPeriod", "traits": { "smithy.api#documentation": "Information about the retention period for which the retention rule is to \n retain resources.
" } }, "Description": { "target": "com.amazonaws.rbin#Description", "traits": { "smithy.api#documentation": "The retention rule description.
" } }, "ResourceType": { "target": "com.amazonaws.rbin#ResourceType", "traits": { "smithy.api#documentation": "This parameter is currently not supported. You can't update a retention rule's resource type \n after creation.
\n[Tag-level retention rules only] Specifies the resource tags to use to identify resources that are to be retained by a \n tag-level retention rule. For tag-level retention rules, only deleted resources, of the specified resource type, that \n have one or more of the specified tag key and value pairs are retained. If a resource is deleted, but it does not have \n any of the specified tag key and value pairs, it is immediately deleted without being retained by the retention rule.
\nYou can add the same tag key and value pair to a maximum or five retention rules.
\nTo create a Region-level retention rule, omit this parameter. A Region-level retention rule \n does not have any resource tags specified. It retains all deleted resources of the specified \n resource type in the Region in which the rule is created, even if the resources are not tagged.
" } }, "ExcludeResourceTags": { "target": "com.amazonaws.rbin#ExcludeResourceTags", "traits": { "smithy.api#documentation": "[Region-level retention rules only] Specifies the exclusion tags to use to identify resources that are to be excluded, \nor ignored, by a Region-level retention rule. Resources that have any of these tags are not retained by the retention rule \nupon deletion.
\nYou can't specify exclusion tags for tag-level retention rules.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.rbin#UpdateRuleResponse": { "type": "structure", "members": { "Identifier": { "target": "com.amazonaws.rbin#RuleIdentifier", "traits": { "smithy.api#documentation": "The unique ID of the retention rule.
" } }, "RetentionPeriod": { "target": "com.amazonaws.rbin#RetentionPeriod" }, "Description": { "target": "com.amazonaws.rbin#Description", "traits": { "smithy.api#documentation": "The retention rule description.
" } }, "ResourceType": { "target": "com.amazonaws.rbin#ResourceType", "traits": { "smithy.api#documentation": "The resource type retained by the retention rule.
" } }, "ResourceTags": { "target": "com.amazonaws.rbin#ResourceTags", "traits": { "smithy.api#documentation": "[Tag-level retention rules only] Information about the resource tags used to identify resources that are retained by the retention \n rule.
" } }, "Status": { "target": "com.amazonaws.rbin#RuleStatus", "traits": { "smithy.api#documentation": "The state of the retention rule. Only retention rules that are in the available \n state retain resources.
[Region-level retention rules only] The lock state for the retention rule.
\n\n locked - The retention rule is locked and can't be modified or deleted.
\n pending_unlock - The retention rule has been unlocked but it is still within \n the unlock delay period. The retention rule can be modified or deleted only after the unlock \n delay period has expired.
\n unlocked - The retention rule is unlocked and it can be modified or deleted by \n any user with the required permissions.
\n null - The retention rule has never been locked. Once a retention rule has \n been locked, it can transition between the locked and unlocked states \n only; it can never transition back to null.
The date and time at which the unlock delay is set to expire. Only returned \n for retention rules that have been unlocked and that are still within the unlock \n delay period.
" } }, "RuleArn": { "target": "com.amazonaws.rbin#RuleArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the retention rule.
" } }, "ExcludeResourceTags": { "target": "com.amazonaws.rbin#ExcludeResourceTags", "traits": { "smithy.api#documentation": "[Region-level retention rules only] Information about the exclusion tags used to identify resources that are to be \nexcluded, or ignored, by the retention rule.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.rbin#ValidationException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.rbin#ErrorMessage" }, "Reason": { "target": "com.amazonaws.rbin#ValidationExceptionReason", "traits": { "smithy.api#documentation": "The reason for the exception.
" } } }, "traits": { "smithy.api#documentation": "One or more of the parameters in the request is not valid.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.rbin#ValidationExceptionReason": { "type": "enum", "members": { "INVALID_PAGE_TOKEN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID_PAGE_TOKEN" } }, "INVALID_PARAMETER_VALUE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID_PARAMETER_VALUE" } } } } } }