{ "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.s3control#AWSS3ControlServiceV20180820": { "type": "service", "version": "2018-08-20", "operations": [ { "target": "com.amazonaws.s3control#AssociateAccessGrantsIdentityCenter" }, { "target": "com.amazonaws.s3control#CreateAccessGrant" }, { "target": "com.amazonaws.s3control#CreateAccessGrantsInstance" }, { "target": "com.amazonaws.s3control#CreateAccessGrantsLocation" }, { "target": "com.amazonaws.s3control#CreateAccessPoint" }, { "target": "com.amazonaws.s3control#CreateAccessPointForObjectLambda" }, { "target": "com.amazonaws.s3control#CreateBucket" }, { "target": "com.amazonaws.s3control#CreateJob" }, { "target": "com.amazonaws.s3control#CreateMultiRegionAccessPoint" }, { "target": "com.amazonaws.s3control#CreateStorageLensGroup" }, { "target": "com.amazonaws.s3control#DeleteAccessGrant" }, { "target": "com.amazonaws.s3control#DeleteAccessGrantsInstance" }, { "target": "com.amazonaws.s3control#DeleteAccessGrantsInstanceResourcePolicy" }, { "target": "com.amazonaws.s3control#DeleteAccessGrantsLocation" }, { "target": "com.amazonaws.s3control#DeleteAccessPoint" }, { "target": "com.amazonaws.s3control#DeleteAccessPointForObjectLambda" }, { "target": "com.amazonaws.s3control#DeleteAccessPointPolicy" }, { "target": "com.amazonaws.s3control#DeleteAccessPointPolicyForObjectLambda" }, { "target": "com.amazonaws.s3control#DeleteAccessPointScope" }, { "target": "com.amazonaws.s3control#DeleteBucket" }, { "target": "com.amazonaws.s3control#DeleteBucketLifecycleConfiguration" }, { "target": "com.amazonaws.s3control#DeleteBucketPolicy" }, { "target": "com.amazonaws.s3control#DeleteBucketReplication" }, { "target": "com.amazonaws.s3control#DeleteBucketTagging" }, { "target": "com.amazonaws.s3control#DeleteJobTagging" }, { "target": "com.amazonaws.s3control#DeleteMultiRegionAccessPoint" }, { "target": "com.amazonaws.s3control#DeletePublicAccessBlock" }, { "target": "com.amazonaws.s3control#DeleteStorageLensConfiguration" }, { "target": "com.amazonaws.s3control#DeleteStorageLensConfigurationTagging" }, { "target": "com.amazonaws.s3control#DeleteStorageLensGroup" }, { "target": "com.amazonaws.s3control#DescribeJob" }, { "target": "com.amazonaws.s3control#DescribeMultiRegionAccessPointOperation" }, { "target": "com.amazonaws.s3control#DissociateAccessGrantsIdentityCenter" }, { "target": "com.amazonaws.s3control#GetAccessGrant" }, { "target": "com.amazonaws.s3control#GetAccessGrantsInstance" }, { "target": "com.amazonaws.s3control#GetAccessGrantsInstanceForPrefix" }, { "target": "com.amazonaws.s3control#GetAccessGrantsInstanceResourcePolicy" }, { "target": "com.amazonaws.s3control#GetAccessGrantsLocation" }, { "target": "com.amazonaws.s3control#GetAccessPoint" }, { "target": "com.amazonaws.s3control#GetAccessPointConfigurationForObjectLambda" }, { "target": "com.amazonaws.s3control#GetAccessPointForObjectLambda" }, { "target": "com.amazonaws.s3control#GetAccessPointPolicy" }, { "target": "com.amazonaws.s3control#GetAccessPointPolicyForObjectLambda" }, { "target": "com.amazonaws.s3control#GetAccessPointPolicyStatus" }, { "target": "com.amazonaws.s3control#GetAccessPointPolicyStatusForObjectLambda" }, { "target": "com.amazonaws.s3control#GetAccessPointScope" }, { "target": "com.amazonaws.s3control#GetBucket" }, { "target": "com.amazonaws.s3control#GetBucketLifecycleConfiguration" }, { "target": "com.amazonaws.s3control#GetBucketPolicy" }, { "target": "com.amazonaws.s3control#GetBucketReplication" }, { "target": "com.amazonaws.s3control#GetBucketTagging" }, { "target": "com.amazonaws.s3control#GetBucketVersioning" }, { "target": "com.amazonaws.s3control#GetDataAccess" }, { "target": "com.amazonaws.s3control#GetJobTagging" }, { "target": "com.amazonaws.s3control#GetMultiRegionAccessPoint" }, { "target": "com.amazonaws.s3control#GetMultiRegionAccessPointPolicy" }, { "target": "com.amazonaws.s3control#GetMultiRegionAccessPointPolicyStatus" }, { "target": "com.amazonaws.s3control#GetMultiRegionAccessPointRoutes" }, { "target": "com.amazonaws.s3control#GetPublicAccessBlock" }, { "target": "com.amazonaws.s3control#GetStorageLensConfiguration" }, { "target": "com.amazonaws.s3control#GetStorageLensConfigurationTagging" }, { "target": "com.amazonaws.s3control#GetStorageLensGroup" }, { "target": "com.amazonaws.s3control#ListAccessGrants" }, { "target": "com.amazonaws.s3control#ListAccessGrantsInstances" }, { "target": "com.amazonaws.s3control#ListAccessGrantsLocations" }, { "target": "com.amazonaws.s3control#ListAccessPoints" }, { "target": "com.amazonaws.s3control#ListAccessPointsForDirectoryBuckets" }, { "target": "com.amazonaws.s3control#ListAccessPointsForObjectLambda" }, { "target": "com.amazonaws.s3control#ListCallerAccessGrants" }, { "target": "com.amazonaws.s3control#ListJobs" }, { "target": "com.amazonaws.s3control#ListMultiRegionAccessPoints" }, { "target": "com.amazonaws.s3control#ListRegionalBuckets" }, { "target": "com.amazonaws.s3control#ListStorageLensConfigurations" }, { "target": "com.amazonaws.s3control#ListStorageLensGroups" }, { "target": "com.amazonaws.s3control#ListTagsForResource" }, { "target": "com.amazonaws.s3control#PutAccessGrantsInstanceResourcePolicy" }, { "target": "com.amazonaws.s3control#PutAccessPointConfigurationForObjectLambda" }, { "target": "com.amazonaws.s3control#PutAccessPointPolicy" }, { "target": "com.amazonaws.s3control#PutAccessPointPolicyForObjectLambda" }, { "target": "com.amazonaws.s3control#PutAccessPointScope" }, { "target": "com.amazonaws.s3control#PutBucketLifecycleConfiguration" }, { "target": "com.amazonaws.s3control#PutBucketPolicy" }, { "target": "com.amazonaws.s3control#PutBucketReplication" }, { "target": "com.amazonaws.s3control#PutBucketTagging" }, { "target": "com.amazonaws.s3control#PutBucketVersioning" }, { "target": "com.amazonaws.s3control#PutJobTagging" }, { "target": "com.amazonaws.s3control#PutMultiRegionAccessPointPolicy" }, { "target": "com.amazonaws.s3control#PutPublicAccessBlock" }, { "target": "com.amazonaws.s3control#PutStorageLensConfiguration" }, { "target": "com.amazonaws.s3control#PutStorageLensConfigurationTagging" }, { "target": "com.amazonaws.s3control#SubmitMultiRegionAccessPointRoutes" }, { "target": "com.amazonaws.s3control#TagResource" }, { "target": "com.amazonaws.s3control#UntagResource" }, { "target": "com.amazonaws.s3control#UpdateAccessGrantsLocation" }, { "target": "com.amazonaws.s3control#UpdateJobPriority" }, { "target": "com.amazonaws.s3control#UpdateJobStatus" }, { "target": "com.amazonaws.s3control#UpdateStorageLensGroup" } ], "traits": { "aws.api#service": { "sdkId": "S3 Control", "arnNamespace": "s3", "cloudFormationName": "S3Control", "cloudTrailEventSource": "s3control.amazonaws.com", "docId": "s3control-2018-08-20", "endpointPrefix": "s3-control" }, "aws.auth#sigv4": { "name": "s3" }, "aws.protocols#restXml": {}, "smithy.api#documentation": "
Amazon Web Services S3 Control provides access to Amazon S3 control plane actions.
", "smithy.api#title": "AWS S3 Control", "smithy.api#xmlNamespace": { "uri": "http://awss3control.amazonaws.com/doc/2018-08-20/" }, "smithy.rules#clientContextParams": { "UseArnRegion": { "documentation": "Enables this client to use an ARN's region when constructing an endpoint instead of the client's configured region.", "type": "boolean" } }, "smithy.rules#endpointBdd": { "version": "1.1", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "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" }, "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" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" }, "AccountId": { "required": false, "documentation": "The Account ID used to send the request. This is an optional parameter that will be set automatically for operations that require it.", "type": "string" }, "RequiresAccountId": { "required": false, "documentation": "Internal parameter for operations that require account id host prefix.", "type": "boolean" }, "OutpostId": { "required": false, "documentation": "The Outpost ID. Some operations have an optional OutpostId which should be used in endpoint construction.", "type": "string" }, "Bucket": { "required": false, "documentation": "The S3 bucket used to send the request. This is an optional parameter that will be set automatically for operations that are scoped to an S3 bucket.", "type": "string" }, "AccessPointName": { "required": false, "documentation": "The S3 AccessPointName used to send the request. This is an optional parameter that will be set automatically for operations that are scoped to an S3 AccessPoint.", "type": "string" }, "UseArnRegion": { "builtIn": "AWS::S3Control::UseArnRegion", "required": false, "documentation": "When an Access Point ARN is provided and this flag is enabled, the SDK MUST use the ARN's region when constructing the endpoint instead of the client's configured region.", "type": "boolean" }, "ResourceArn": { "required": false, "documentation": "The resource ARN included in the request. Only set on TagResource, UntagResourceand ListTagsForResource", "type": "string" }, "UseS3ExpressControlEndpoint": { "required": false, "documentation": "Internal parameter to indicate whether S3Express operation should use control plane, (ex. ListDirectoryAccessPoints)", "type": "boolean" } }, "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "partitionResult" }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "partitionResult" }, "name" ] }, "aws-cn" ] }, { "fn": "isSet", "argv": [ { "ref": "OutpostId" } ] }, { "fn": "isValidHostLabel", "argv": [ { "ref": "OutpostId" }, false ] }, { "fn": "isSet", "argv": [ { "ref": "ResourceArn" } ] }, { "fn": "aws.parseArn", "argv": [ { "ref": "ResourceArn" } ], "assign": "resourceArn" }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "resourceArn" }, "service" ] }, "s3express" ] }, { "fn": "aws.partition", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "resourceArn" }, "region" ] } ], "assign": "arnPartition_ssa_3" }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "arnPartition_ssa_3" }, "name" ] }, { "fn": "getAttr", "argv": [ { "ref": "partitionResult" }, "name" ] } ] }, { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "coalesce", "argv": [ { "ref": "UseS3ExpressControlEndpoint" }, false ] }, true ] }, { "fn": "parseURL", "argv": [ { "ref": "Endpoint" } ], "assign": "url" }, { "fn": "isSet", "argv": [ { "ref": "AccessPointName" } ] }, { "fn": "stringEquals", "argv": [ { "fn": "coalesce", "argv": [ { "fn": "substring", "argv": [ { "ref": "AccessPointName" }, 0, 7, true ] }, "" ] }, "--xa-s3" ] }, { "fn": "substring", "argv": [ { "ref": "AccessPointName" }, 7, 15, true ] }, { "fn": "stringEquals", "argv": [ { "fn": "coalesce", "argv": [ { "fn": "substring", "argv": [ { "ref": "AccessPointName" }, 15, 17, true ] }, "" ] }, "--" ] }, { "fn": "substring", "argv": [ { "ref": "AccessPointName" }, 7, 16, true ] }, { "fn": "stringEquals", "argv": [ { "ref": "Region" }, "snow" ] }, { "fn": "aws.parseArn", "argv": [ { "ref": "AccessPointName" } ], "assign": "accessPointArn" }, { "fn": "getAttr", "argv": [ { "ref": "accessPointArn" }, "resourceId[0]" ], "assign": "arnType_ssa_1" }, { "fn": "isSet", "argv": [ { "ref": "Bucket" } ] }, { "fn": "aws.parseArn", "argv": [ { "ref": "Bucket" } ], "assign": "bucketArn" }, { "fn": "getAttr", "argv": [ { "ref": "bucketArn" }, "resourceId[0]" ], "assign": "arnType_ssa_2" }, { "fn": "stringEquals", "argv": [ { "ref": "arnType_ssa_2" }, "" ] }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "bucketArn" }, "service" ] }, "s3-outposts" ] }, { "fn": "getAttr", "argv": [ { "ref": "bucketArn" }, "resourceId[1]" ], "assign": "outpostId_ssa_2" }, { "fn": "stringEquals", "argv": [ { "fn": "coalesce", "argv": [ { "fn": "substring", "argv": [ { "ref": "AccessPointName" }, 16, 18, true ] }, "" ] }, "--" ] }, { "fn": "stringEquals", "argv": [ { "ref": "arnType_ssa_1" }, "" ] }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "accessPointArn" }, "service" ] }, "s3-outposts" ] }, { "fn": "getAttr", "argv": [ { "ref": "accessPointArn" }, "resourceId[1]" ], "assign": "outpostId_ssa_1" }, { "fn": "isSet", "argv": [ { "ref": "AccountId" } ] }, { "fn": "isValidHostLabel", "argv": [ { "ref": "AccountId" }, false ] }, { "fn": "booleanEquals", "argv": [ { "fn": "coalesce", "argv": [ { "ref": "RequiresAccountId" }, false ] }, true ] }, { "fn": "stringEquals", "argv": [ { "ref": "AccountId" }, { "fn": "getAttr", "argv": [ { "ref": "accessPointArn" }, "accountId" ] } ] }, { "fn": "isValidHostLabel", "argv": [ { "ref": "Region" }, true ] }, { "fn": "stringEquals", "argv": [ { "ref": "AccountId" }, { "fn": "getAttr", "argv": [ { "ref": "bucketArn" }, "accountId" ] } ] }, { "fn": "booleanEquals", "argv": [ { "fn": "coalesce", "argv": [ { "ref": "UseArnRegion" }, true ] }, true ] }, { "fn": "isValidHostLabel", "argv": [ { "ref": "outpostId_ssa_2" }, false ] }, { "fn": "stringEquals", "argv": [ { "ref": "Region" }, { "fn": "getAttr", "argv": [ { "ref": "accessPointArn" }, "region" ] } ] }, { "fn": "stringEquals", "argv": [ { "ref": "Region" }, { "fn": "getAttr", "argv": [ { "ref": "bucketArn" }, "region" ] } ] }, { "fn": "aws.partition", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "bucketArn" }, "region" ] } ], "assign": "arnPartition_ssa_2" }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "arnPartition_ssa_2" }, "name" ] }, { "fn": "getAttr", "argv": [ { "ref": "partitionResult" }, "name" ] } ] }, { "fn": "isValidHostLabel", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "bucketArn" }, "region" ] }, true ] }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "bucketArn" }, "accountId" ] }, "" ] }, { "fn": "isValidHostLabel", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "bucketArn" }, "accountId" ] }, false ] }, { "fn": "isValidHostLabel", "argv": [ { "ref": "outpostId_ssa_1" }, false ] }, { "fn": "aws.partition", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "accessPointArn" }, "region" ] } ], "assign": "arnPartition_ssa_1" }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "arnPartition_ssa_1" }, "name" ] }, { "fn": "getAttr", "argv": [ { "ref": "partitionResult" }, "name" ] } ] }, { "fn": "isValidHostLabel", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "accessPointArn" }, "region" ] }, true ] }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "accessPointArn" }, "accountId" ] }, "" ] }, { "fn": "isValidHostLabel", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "accessPointArn" }, "accountId" ] }, false ] }, { "fn": "substring", "argv": [ { "ref": "AccessPointName" }, 7, 20, true ] }, { "fn": "stringEquals", "argv": [ { "fn": "coalesce", "argv": [ { "fn": "substring", "argv": [ { "ref": "AccessPointName" }, 20, 22, true ] }, "" ] }, "--" ] }, { "fn": "substring", "argv": [ { "ref": "AccessPointName" }, 7, 21, true ] }, { "fn": "stringEquals", "argv": [ { "fn": "coalesce", "argv": [ { "fn": "substring", "argv": [ { "ref": "AccessPointName" }, 21, 23, true ] }, "" ] }, "--" ] }, { "fn": "getAttr", "argv": [ { "ref": "accessPointArn" }, "resourceId[2]" ], "assign": "outpostType_ssa_1" }, { "fn": "getAttr", "argv": [ { "ref": "accessPointArn" }, "resourceId[3]" ] }, { "fn": "stringEquals", "argv": [ { "ref": "outpostType_ssa_1" }, "accesspoint" ] }, { "fn": "substring", "argv": [ { "ref": "AccessPointName" }, 7, 27, true ] }, { "fn": "stringEquals", "argv": [ { "fn": "coalesce", "argv": [ { "fn": "substring", "argv": [ { "ref": "AccessPointName" }, 27, 29, true ] }, "" ] }, "--" ] }, { "fn": "getAttr", "argv": [ { "ref": "bucketArn" }, "resourceId[2]" ], "assign": "outpostType_ssa_2" }, { "fn": "getAttr", "argv": [ { "ref": "bucketArn" }, "resourceId[3]" ] }, { "fn": "stringEquals", "argv": [ { "ref": "outpostType_ssa_2" }, "bucket" ] }, { "fn": "stringEquals", "argv": [ { "ref": "Region" }, { "fn": "getAttr", "argv": [ { "ref": "resourceArn" }, "region" ] } ] } ], "results": [ { "conditions": [], "error": "Partition does not support FIPS", "type": "error" }, { "conditions": [], "error": "AccountId is required but not set", "type": "error" }, { "conditions": [], "error": "AccountId must only contain a-z, A-Z, 0-9 and `-`.", "type": "error" }, { "conditions": [], "error": "OutpostId must only contain a-z, A-Z, 0-9 and `-`.", "type": "error" }, { "conditions": [], "error": "Invalid Configuration: DualStack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": "{url#scheme}://{url#authority}{url#path}", "properties": { "authSchemes": [ { "disableDoubleEncoding": true, "name": "sigv4", "signingName": "s3-outposts", "signingRegion": "{Region}" } ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://s3-outposts-fips.{Region}.{partitionResult#dualStackDnsSuffix}", "properties": { "authSchemes": [ { "disableDoubleEncoding": true, "name": "sigv4", "signingName": "s3-outposts", "signingRegion": "{Region}" } ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://s3-outposts-fips.{Region}.{partitionResult#dnsSuffix}", "properties": { "authSchemes": [ { "disableDoubleEncoding": true, "name": "sigv4", "signingName": "s3-outposts", "signingRegion": "{Region}" } ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://s3-outposts.{Region}.{partitionResult#dualStackDnsSuffix}", "properties": { "authSchemes": [ { "disableDoubleEncoding": true, "name": "sigv4", "signingName": "s3-outposts", "signingRegion": "{Region}" } ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://s3-outposts.{Region}.{partitionResult#dnsSuffix}", "properties": { "authSchemes": [ { "disableDoubleEncoding": true, "name": "sigv4", "signingName": "s3-outposts", "signingRegion": "{Region}" } ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Invalid region: region was not a valid DNS name.", "type": "error" }, { "conditions": [], "error": "Invalid configuration: region from ARN `{resourceArn#region}` does not match client region `{Region}` and UseArnRegion is `false`", "type": "error" }, { "conditions": [], "error": "S3Express does not support Dual-stack.", "type": "error" }, { "conditions": [], "endpoint": { "url": "{url#scheme}://{url#authority}", "properties": { "authSchemes": [ { "disableDoubleEncoding": true, "name": "sigv4", "signingName": "s3express", "signingRegion": "{Region}" } ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://s3express-control-fips.{Region}.{partitionResult#dnsSuffix}", "properties": { "authSchemes": [ { "disableDoubleEncoding": true, "name": "sigv4", "signingName": "s3express", "signingRegion": "{Region}" } ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://s3express-control.{Region}.{partitionResult#dnsSuffix}", "properties": { "authSchemes": [ { "disableDoubleEncoding": true, "name": "sigv4", "signingName": "s3express", "signingRegion": "{Region}" } ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Client was configured for partition `{partitionResult#name}` but ARN has `{arnPartition_ssa_3#name}`", "type": "error" }, { "conditions": [], "error": "Unrecognized S3Express Access Point name format.", "type": "error" }, { "conditions": [], "error": "S3 Snow does not support DualStack", "type": "error" }, { "conditions": [], "error": "S3 Snow does not support FIPS", "type": "error" }, { "conditions": [], "endpoint": { "url": "{url#scheme}://{url#authority}", "properties": { "authSchemes": [ { "disableDoubleEncoding": true, "name": "sigv4", "signingName": "s3", "signingRegion": "{Region}" } ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Invalid configuration: region from ARN `{accessPointArn#region}` does not match client region `{Region}` and UseArnRegion is `false`", "type": "error" }, { "conditions": [], "error": "Invalid ARN: the accountId specified in the ARN (`{accessPointArn#accountId}`) does not match the parameter (`{AccountId}`)", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://s3-outposts-fips.{accessPointArn#region}.{arnPartition_ssa_1#dualStackDnsSuffix}", "properties": { "authSchemes": [ { "disableDoubleEncoding": true, "name": "sigv4", "signingName": "s3-outposts", "signingRegion": "{accessPointArn#region}" } ] }, "headers": { "x-amz-account-id": [ "{accessPointArn#accountId}" ], "x-amz-outpost-id": [ "{outpostId_ssa_1}" ] } }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://s3-outposts-fips.{accessPointArn#region}.{arnPartition_ssa_1#dnsSuffix}", "properties": { "authSchemes": [ { "disableDoubleEncoding": true, "name": "sigv4", "signingName": "s3-outposts", "signingRegion": "{accessPointArn#region}" } ] }, "headers": { "x-amz-account-id": [ "{accessPointArn#accountId}" ], "x-amz-outpost-id": [ "{outpostId_ssa_1}" ] } }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://s3-outposts.{accessPointArn#region}.{arnPartition_ssa_1#dualStackDnsSuffix}", "properties": { "authSchemes": [ { "disableDoubleEncoding": true, "name": "sigv4", "signingName": "s3-outposts", "signingRegion": "{accessPointArn#region}" } ] }, "headers": { "x-amz-account-id": [ "{accessPointArn#accountId}" ], "x-amz-outpost-id": [ "{outpostId_ssa_1}" ] } }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "{url#scheme}://{url#authority}{url#path}", "properties": { "authSchemes": [ { "disableDoubleEncoding": true, "name": "sigv4", "signingName": "s3-outposts", "signingRegion": "{accessPointArn#region}" } ] }, "headers": { "x-amz-account-id": [ "{accessPointArn#accountId}" ], "x-amz-outpost-id": [ "{outpostId_ssa_1}" ] } }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://s3-outposts.{accessPointArn#region}.{arnPartition_ssa_1#dnsSuffix}", "properties": { "authSchemes": [ { "disableDoubleEncoding": true, "name": "sigv4", "signingName": "s3-outposts", "signingRegion": "{accessPointArn#region}" } ] }, "headers": { "x-amz-account-id": [ "{accessPointArn#accountId}" ], "x-amz-outpost-id": [ "{outpostId_ssa_1}" ] } }, "type": "endpoint" }, { "conditions": [], "error": "Expected an outpost type `accesspoint`, found `{outpostType_ssa_1}`", "type": "error" }, { "conditions": [], "error": "Invalid ARN: expected an access point name", "type": "error" }, { "conditions": [], "error": "Invalid ARN: Expected a 4-component resource", "type": "error" }, { "conditions": [], "error": "Invalid ARN: The account id may only contain a-z, A-Z, 0-9 and `-`. Found: `{accessPointArn#accountId}`", "type": "error" }, { "conditions": [], "error": "Invalid ARN: missing account ID", "type": "error" }, { "conditions": [], "error": "Invalid region in ARN: `{accessPointArn#region}` (invalid DNS name)", "type": "error" }, { "conditions": [], "error": "Client was configured for partition `{partitionResult#name}` but ARN has `{arnPartition_ssa_1#name}`", "type": "error" }, { "conditions": [], "error": "Invalid ARN: The outpost Id must only contain a-z, A-Z, 0-9 and `-`., found: `{outpostId_ssa_1}`", "type": "error" }, { "conditions": [], "error": "Invalid ARN: The Outpost Id was not set", "type": "error" }, { "conditions": [], "error": "Invalid ARN: No ARN type specified", "type": "error" }, { "conditions": [], "error": "Invalid configuration: region from ARN `{bucketArn#region}` does not match client region `{Region}` and UseArnRegion is `false`", "type": "error" }, { "conditions": [], "error": "Invalid ARN: the accountId specified in the ARN (`{bucketArn#accountId}`) does not match the parameter (`{AccountId}`)", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://s3-outposts-fips.{bucketArn#region}.{arnPartition_ssa_2#dualStackDnsSuffix}", "properties": { "authSchemes": [ { "disableDoubleEncoding": true, "name": "sigv4", "signingName": "s3-outposts", "signingRegion": "{bucketArn#region}" } ] }, "headers": { "x-amz-account-id": [ "{bucketArn#accountId}" ], "x-amz-outpost-id": [ "{outpostId_ssa_2}" ] } }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://s3-outposts-fips.{bucketArn#region}.{arnPartition_ssa_2#dnsSuffix}", "properties": { "authSchemes": [ { "disableDoubleEncoding": true, "name": "sigv4", "signingName": "s3-outposts", "signingRegion": "{bucketArn#region}" } ] }, "headers": { "x-amz-account-id": [ "{bucketArn#accountId}" ], "x-amz-outpost-id": [ "{outpostId_ssa_2}" ] } }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://s3-outposts.{bucketArn#region}.{arnPartition_ssa_2#dualStackDnsSuffix}", "properties": { "authSchemes": [ { "disableDoubleEncoding": true, "name": "sigv4", "signingName": "s3-outposts", "signingRegion": "{bucketArn#region}" } ] }, "headers": { "x-amz-account-id": [ "{bucketArn#accountId}" ], "x-amz-outpost-id": [ "{outpostId_ssa_2}" ] } }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "{url#scheme}://{url#authority}{url#path}", "properties": { "authSchemes": [ { "disableDoubleEncoding": true, "name": "sigv4", "signingName": "s3-outposts", "signingRegion": "{bucketArn#region}" } ] }, "headers": { "x-amz-account-id": [ "{bucketArn#accountId}" ], "x-amz-outpost-id": [ "{outpostId_ssa_2}" ] } }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://s3-outposts.{bucketArn#region}.{arnPartition_ssa_2#dnsSuffix}", "properties": { "authSchemes": [ { "disableDoubleEncoding": true, "name": "sigv4", "signingName": "s3-outposts", "signingRegion": "{bucketArn#region}" } ] }, "headers": { "x-amz-account-id": [ "{bucketArn#accountId}" ], "x-amz-outpost-id": [ "{outpostId_ssa_2}" ] } }, "type": "endpoint" }, { "conditions": [], "error": "Invalid ARN: Expected an outpost type `bucket`, found `{outpostType_ssa_2}`", "type": "error" }, { "conditions": [], "error": "Invalid ARN: expected a bucket name", "type": "error" }, { "conditions": [], "error": "Invalid ARN: The account id may only contain a-z, A-Z, 0-9 and `-`. Found: `{bucketArn#accountId}`", "type": "error" }, { "conditions": [], "error": "Invalid region in ARN: `{bucketArn#region}` (invalid DNS name)", "type": "error" }, { "conditions": [], "error": "Client was configured for partition `{partitionResult#name}` but ARN has `{arnPartition_ssa_2#name}`", "type": "error" }, { "conditions": [], "error": "Invalid ARN: The outpost Id must only contain a-z, A-Z, 0-9 and `-`., found: `{outpostId_ssa_2}`", "type": "error" }, { "conditions": [], "endpoint": { "url": "{url#scheme}://{AccountId}.{url#authority}{url#path}", "properties": { "authSchemes": [ { "disableDoubleEncoding": true, "name": "sigv4", "signingName": "s3", "signingRegion": "{Region}" } ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "{url#scheme}://{url#authority}{url#path}", "properties": { "authSchemes": [ { "disableDoubleEncoding": true, "name": "sigv4", "signingName": "s3", "signingRegion": "{Region}" } ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://{AccountId}.s3-control-fips.dualstack.{Region}.{partitionResult#dnsSuffix}", "properties": { "authSchemes": [ { "disableDoubleEncoding": true, "name": "sigv4", "signingName": "s3", "signingRegion": "{Region}" } ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://s3-control-fips.dualstack.{Region}.{partitionResult#dnsSuffix}", "properties": { "authSchemes": [ { "disableDoubleEncoding": true, "name": "sigv4", "signingName": "s3", "signingRegion": "{Region}" } ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://{AccountId}.s3-control-fips.{Region}.{partitionResult#dnsSuffix}", "properties": { "authSchemes": [ { "disableDoubleEncoding": true, "name": "sigv4", "signingName": "s3", "signingRegion": "{Region}" } ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://s3-control-fips.{Region}.{partitionResult#dnsSuffix}", "properties": { "authSchemes": [ { "disableDoubleEncoding": true, "name": "sigv4", "signingName": "s3", "signingRegion": "{Region}" } ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://{AccountId}.s3-control.dualstack.{Region}.{partitionResult#dnsSuffix}", "properties": { "authSchemes": [ { "disableDoubleEncoding": true, "name": "sigv4", "signingName": "s3", "signingRegion": "{Region}" } ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://s3-control.dualstack.{Region}.{partitionResult#dnsSuffix}", "properties": { "authSchemes": [ { "disableDoubleEncoding": true, "name": "sigv4", "signingName": "s3", "signingRegion": "{Region}" } ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://{AccountId}.s3-control.{Region}.{partitionResult#dnsSuffix}", "properties": { "authSchemes": [ { "disableDoubleEncoding": true, "name": "sigv4", "signingName": "s3", "signingRegion": "{Region}" } ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://s3-control.{Region}.{partitionResult#dnsSuffix}", "properties": { "authSchemes": [ { "disableDoubleEncoding": true, "name": "sigv4", "signingName": "s3", "signingRegion": "{Region}" } ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Region must be set", "type": "error" } ], "root": 2, "nodeCount": 428, "nodes": "/////wAAAAH/////AAAAAAAAAAMF9eE+AAAAAQAAABsAAAAEAAAACwAAAAUAAAAGAAAADAAAABcAAAAGAAAADwAAAAcAAAAIAAAAFQAAABEAAAAIAAAAFwAAAAkF9eE+AAAAGAAAAAoF9eE+AAAAGQAAAAsF9eEmAAAAGgX14SYAAAAMAAAAGwAAAA0F9eEmAAAAHAAAAA4F9eElAAAAJwX14TMAAAAPAAAAKAAAABAF9eEzAAAAKgX14TMF9eEnAAAAFgAAABIF9eEmAAAAHgX14SYAAAATAAAAHwAAABQF9eEmAAAAIAAAABUF9eElAAAAJwX14SQAAAAWAAAAKQX14SQAAAFOAAAADwAAABgAAAAZAAAAFQAAAYQAAAAZAAAAFwAAABoF9eE+AAAAGAAAAX8F9eE+AAAAAgAAANYAAAAcAAAABAAAAMkAAAAdAAAABgAAAB4AAAAhAAAABwAAAB8AAAAhAAAACAAAACAAAAAhAAAACQAAAMIAAAAhAAAACwAAAE0AAAAiAAAADAAAACQAAAAjAAAADQAAAKkAAABQAAAADQX14Q0AAAAlAAAADwAAACYAAAAoAAAAEAX14Q0AAAAnAAAAFQAAADwAAAAoAAAAFwAAACkAAAC8AAAAGAAAACoAAAC8AAAAGQAAACsF9eEmAAAAGgX14SYAAAAsAAAAGwAAAC0F9eEmAAAAHAAAAC4F9eElAAAAIQAAAC8AAAAwAAAAJgAAADAAAAEpAAAAJwAAADMAAAAxAAAAKAAAADIF9eEzAAAAKgAAADQF9eEnAAAAKAAAADQF9eEzAAAAKwAAADUF9eEzAAAALAAAADYF9eEyAAAALQAAADcF9eExAAAALgX14SEAAAA4AAAALwAAADkF9eEwAAAAPwAAADoF9eEfAAAAQAAAADsF9eEvAAAAQQX14SsF9eEuAAAAFgAAAD0F9eEmAAAAHgX14SYAAAA+AAAAHwAAAD8F9eEmAAAAIAAAAEAF9eElAAAAIQAAAEEAAABCAAAAJAAAAEIAAAFEAAAAJwAAAEQAAABDAAAAKQAAAEQAAAFOAAAAMAAAAEUF9eEkAAAAMQAAAEYF9eEkAAAAMgAAAEcF9eEjAAAAMwAAAEgF9eEiAAAANAX14SEAAABJAAAANQAAAEoF9eEgAAAAOgAAAEsF9eEfAAAAOwAAAEwF9eEeAAAAPAX14RoF9eEdAAAADAAAALUAAABOAAAADQAAAKgAAABPAAAADgAAAH4AAABQAAAADwAAAFEAAABTAAAAEAAAAKsAAABSAAAAFQAAAG0AAABTAAAAFwAAAFQAAABVAAAAGAAAAFsAAABVAAAAIQAAAFcAAABWAAAAIwAAAXsAAABZAAAAIgAAAFgAAAF9AAAAIwAAAFoAAABZAAAAJQX14T0F9eELAAAAJQX14TwF9eELAAAAGQAAAFwF9eEmAAAAGgX14SYAAABdAAAAGwAAAF4F9eEmAAAAHAAAAF8F9eElAAAAIQAAAGAAAABhAAAAJgAAAGEAAAEpAAAAJwAAAGQAAABiAAAAKAAAAGMF9eEzAAAAKgAAAGUF9eEnAAAAKAAAAGUF9eEzAAAAKwAAAGYF9eEzAAAALAAAAGcF9eEyAAAALQAAAGgF9eExAAAALgX14SEAAABpAAAALwAAAGoF9eEwAAAAPwAAAGsF9eEfAAAAQAAAAGwF9eEvAAAAQQX14S0F9eEuAAAAFgAAAG4F9eEmAAAAHgX14SYAAABvAAAAHwAAAHAF9eEmAAAAIAAAAHEF9eElAAAAIQAAAHIAAABzAAAAJAAAAHMAAAFEAAAAJwAAAHUAAAB0AAAAKQAAAHUAAAFOAAAAMAAAAHYF9eEkAAAAMQAAAHcF9eEkAAAAMgAAAHgF9eEjAAAAMwAAAHkF9eEiAAAANAX14SEAAAB6AAAANQAAAHsF9eEgAAAAOgAAAHwF9eEfAAAAOwAAAH0F9eEeAAAAPAX14RwF9eEdAAAADwAAAIAAAAB/AAAAFAX14RUAAACDAAAAEAX14Q4AAACBAAAAFAX14RUAAACCAAAAFQAAAJcAAACDAAAAFwAAAIQAAAEdAAAAGAAAAIUAAAEdAAAAGQAAAIYF9eEmAAAAGgX14SYAAACHAAAAGwAAAIgF9eEmAAAAHAAAAIkF9eElAAAAIQAAAIoAAACLAAAAJgAAAIsAAAEpAAAAJwAAAI4AAACMAAAAKAAAAI0F9eEzAAAAKgAAAI8F9eEnAAAAKAAAAI8F9eEzAAAAKwAAAJAF9eEzAAAALAAAAJEF9eEyAAAALQAAAJIF9eExAAAALgX14SEAAACTAAAALwAAAJQF9eEwAAAAPwAAAJUF9eEfAAAAQAAAAJYF9eEvAAAAQQX14SwF9eEuAAAAFgAAAJgF9eEmAAAAHgX14SYAAACZAAAAHwAAAJoF9eEmAAAAIAAAAJsF9eElAAAAIQAAAJwAAACdAAAAJAAAAJ0AAAFEAAAAJwAAAJ8AAACeAAAAKQAAAJ8AAAFOAAAAMAAAAKAF9eEkAAAAMQAAAKEF9eEkAAAAMgAAAKIF9eEjAAAAMwAAAKMF9eEiAAAANAX14SEAAACkAAAANQAAAKUF9eEgAAAAOgAAAKYF9eEfAAAAOwAAAKcF9eEeAAAAPAX14RsF9eEdAAAADgX14Q4AAACpAAAADwAAAKoF9eEQAAAAEAAAAKsF9eEQAAAAEQAAAKwAAACtAAAAEgX14RAAAACtAAAAEwAAAK4AAACvAAAAHQX14RAAAACvAAAANgAAALAAAACxAAAANwX14RAAAACxAAAAOAAAALIAAACzAAAAOQX14RAAAACzAAAAPQAAALQF9eESAAAAPgX14RAF9eESAAAADQX14QUAAAC2AAAADgAAAXIAAAC3AAAADwAAALgAAAC6AAAAEAX14QUAAAC5AAAAFQAAAYQAAAC6AAAAFwAAALsAAAC8AAAAGAAAAX8AAAC8AAAAIQAAAL4AAAC9AAAAIwAAAXsAAADAAAAAIgAAAL8AAAF9AAAAIwAAAMEAAADAAAAAJQX14TsF9eELAAAAJQX14ToF9eELAAAACgAAAMMF9eERAAAACwAAAMUAAADEAAAADAAAAYwAAADHAAAADAAAAZQAAADGAAAADgAAAZIAAADHAAAAJwX14RAAAADIAAAAQgX14RAF9eEMAAAABQAAAMoAAAGXAAAACwAAANAAAADLAAAADAAAAMwAAADSAAAAIQAAAM4AAADNAAAAIwX14QIAAADPAAAAIgAAAM8F9eEDAAAAJQX14QkF9eELAAAADAAAAaoAAADRAAAADgAAAaYAAADSAAAAIQAAANQAAADTAAAAIwX14QIAAADVAAAAIgAAANUF9eEDAAAAJQX14QoF9eELAAAAAwX14QEAAADXAAAABAAAAZYAAADYAAAABgAAANkAAADcAAAABwAAANoAAADcAAAACAAAANsAAADcAAAACQAAAYkAAADcAAAACwAAAQgAAADdAAAADAAAAN8AAADeAAAADQAAAVkAAAELAAAADQX14Q0AAADgAAAADwAAAOEAAADjAAAAEAX14Q0AAADiAAAAFQAAAPcAAADjAAAAFwAAAOQAAAFsAAAAGAAAAOUAAAFsAAAAGQAAAOYF9eEmAAAAGgX14SYAAADnAAAAGwAAAOgF9eEmAAAAHAAAAOkF9eElAAAAIQAAAOoAAADrAAAAJgAAAOsAAAEpAAAAJwAAAO4AAADsAAAAKAAAAO0F9eEzAAAAKgAAAO8F9eEnAAAAKAAAAO8F9eEzAAAAKwAAAPAF9eEzAAAALAAAAPEF9eEyAAAALQAAAPIF9eExAAAALgX14SEAAADzAAAALwAAAPQF9eEwAAAAPwAAAPUF9eEfAAAAQAAAAPYF9eEvAAAAQQX14SkF9eEuAAAAFgAAAPgF9eEmAAAAHgX14SYAAAD5AAAAHwAAAPoF9eEmAAAAIAAAAPsF9eElAAAAIQAAAPwAAAD9AAAAJAAAAP0AAAFEAAAAJwAAAP8AAAD+AAAAKQAAAP8AAAFOAAAAMAAAAQAF9eEkAAAAMQAAAQEF9eEkAAAAMgAAAQIF9eEjAAAAMwAAAQMF9eEiAAAANAX14SEAAAEEAAAANQAAAQUF9eEgAAAAOgAAAQYF9eEfAAAAOwAAAQcF9eEeAAAAPAX14RgF9eEdAAAADAAAAWUAAAEJAAAADQAAAVgAAAEKAAAADgAAARYAAAELAAAADwAAAQwAAAEOAAAAEAAAAVsAAAENAAAAFQAAAT4AAAEOAAAAFwAAAQ8AAAEQAAAAGAAAASMAAAEQAAAAIQAAARIAAAERAAAAIwAAAXsAAAEUAAAAIgAAARMAAAF9AAAAIwAAARUAAAEUAAAAJQX14TkF9eELAAAAJQX14TgF9eELAAAADwAAARgAAAEXAAAAFAX14RQAAAEbAAAAEAX14Q4AAAEZAAAAFAX14RQAAAEaAAAAFQAAAT4AAAEbAAAAFwAAARwAAAEdAAAAGAAAASMAAAEdAAAAIQAAAR8AAAEeAAAAIwAAAXsAAAEhAAAAIgAAASAAAAF9AAAAIwAAASIAAAEhAAAAJQX14TUF9eELAAAAJQX14TQF9eELAAAAGQAAASQF9eEmAAAAGgX14SYAAAElAAAAGwAAASYF9eEmAAAAHAAAAScF9eElAAAAIQAAASgAAAEyAAAAJgAAATIAAAEpAAAAJwAAASwAAAEqAAAAKAAAASsF9eEzAAAAKgAAAS0F9eEnAAAAKAAAAS0F9eEzAAAAKwAAAS4F9eEzAAAALAAAAS8F9eEyAAAALQAAATAF9eExAAAALgX14SEAAAExAAAALwX14SgF9eEwAAAAJwAAATUAAAEzAAAAKAAAATQF9eEzAAAAKgAAATYF9eEnAAAAKAAAATYF9eEzAAAAKwAAATcF9eEzAAAALAAAATgF9eEyAAAALQAAATkF9eExAAAALgX14SEAAAE6AAAALwAAATsF9eEwAAAAPwAAATwF9eEfAAAAQAAAAT0F9eEvAAAAQQX14SoF9eEuAAAAFgAAAT8F9eEmAAAAHgX14SYAAAFAAAAAHwAAAUEF9eEmAAAAIAAAAUIF9eElAAAAIQAAAUMAAAFMAAAAJAAAAUwAAAFEAAAAJwAAAUYAAAFFAAAAKQAAAUYAAAFOAAAAMAAAAUcF9eEkAAAAMQAAAUgF9eEkAAAAMgAAAUkF9eEjAAAAMwAAAUoF9eEiAAAANAX14SEAAAFLAAAANQX14RcF9eEgAAAAJwAAAU8AAAFNAAAAKQAAAU8AAAFOAAAAMAX14RYF9eEkAAAAMAAAAVAF9eEkAAAAMQAAAVEF9eEkAAAAMgAAAVIF9eEjAAAAMwAAAVMF9eEiAAAANAX14SEAAAFUAAAANQAAAVUF9eEgAAAAOgAAAVYF9eEfAAAAOwAAAVcF9eEeAAAAPAX14RkF9eEdAAAADgX14Q4AAAFZAAAADwAAAVoF9eEPAAAAEAAAAVsF9eEPAAAAEQAAAVwAAAFdAAAAEgX14Q8AAAFdAAAAEwAAAV4AAAFfAAAAHQX14Q8AAAFfAAAANgAAAWAAAAFhAAAANwX14Q8AAAFhAAAAOAAAAWIAAAFjAAAAOQX14Q8AAAFjAAAAPQAAAWQF9eESAAAAPgX14Q8F9eESAAAADQX14QUAAAFmAAAADgAAAXIAAAFnAAAADwAAAWgAAAFqAAAAEAX14QUAAAFpAAAAFQAAAYQAAAFqAAAAFwAAAWsAAAFsAAAAGAAAAX8AAAFsAAAAIQAAAW4AAAFtAAAAIwAAAXsAAAFwAAAAIgAAAW8AAAF9AAAAIwAAAXEAAAFwAAAAJQX14TcF9eELAAAAJQX14TYF9eELAAAADwAAAXQAAAFzAAAAFAX14RMAAAF3AAAAEAX14QUAAAF1AAAAFAX14RMAAAF2AAAAFQAAAYQAAAF3AAAAFwAAAXgAAAF5AAAAGAAAAX8AAAF5AAAAIQAAAXwAAAF6AAAAIwAAAXsAAAF+AAAAJQX14QIF9eELAAAAIgAAAX4AAAF9AAAAJQX14QMF9eELAAAAJQX14QUF9eELAAAAGQAAAYAF9eEmAAAAGgX14SYAAAGBAAAAGwAAAYIF9eEmAAAAHAAAAYMF9eElAAAAKAX14QUF9eEzAAAAFgAAAYUF9eEmAAAAHgX14SYAAAGGAAAAHwAAAYcF9eEmAAAAIAAAAYgF9eElAAAAMAX14QUF9eEkAAAACgAAAYoF9eERAAAACwAAAY4AAAGLAAAADAAAAYwAAAGQAAAAJwX14Q0AAAGNAAAAQgX14Q0F9eEMAAAADAAAAZQAAAGPAAAADgAAAZIAAAGQAAAAJwX14Q8AAAGRAAAAQgX14Q8F9eEMAAAAJwX14Q4AAAGTAAAAQgX14Q4F9eEMAAAAJwX14QUAAAGVAAAAQgX14QUF9eEMAAAABQAAAZoAAAGXAAAAIQAAAZkAAAGYAAAAIwX14QIF9eEEAAAAIgX14QQF9eEDAAAACwAAAaAAAAGbAAAADAAAAZwAAAGiAAAAIQAAAZ4AAAGdAAAAIwX14QIAAAGfAAAAIgAAAZ8F9eEDAAAAJQX14QcF9eELAAAADAAAAaoAAAGhAAAADgAAAaYAAAGiAAAAIQAAAaQAAAGjAAAAIwX14QIAAAGlAAAAIgAAAaUF9eEDAAAAJQX14QgF9eELAAAAIQAAAagAAAGnAAAAIwX14QIAAAGpAAAAIgAAAakF9eEDAAAAJQX14QYF9eELAAAAIQAAAawAAAGrAAAAIwX14QIF9eEFAAAAIgX14QUF9eED" }, "smithy.rules#endpointRuleSet": { "version": "1.0", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "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" }, "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" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" }, "AccountId": { "required": false, "documentation": "The Account ID used to send the request. This is an optional parameter that will be set automatically for operations that require it.", "type": "string" }, "RequiresAccountId": { "required": false, "documentation": "Internal parameter for operations that require account id host prefix.", "type": "boolean" }, "OutpostId": { "required": false, "documentation": "The Outpost ID. Some operations have an optional OutpostId which should be used in endpoint construction.", "type": "string" }, "Bucket": { "required": false, "documentation": "The S3 bucket used to send the request. This is an optional parameter that will be set automatically for operations that are scoped to an S3 bucket.", "type": "string" }, "AccessPointName": { "required": false, "documentation": "The S3 AccessPointName used to send the request. This is an optional parameter that will be set automatically for operations that are scoped to an S3 AccessPoint.", "type": "string" }, "UseArnRegion": { "builtIn": "AWS::S3Control::UseArnRegion", "required": false, "documentation": "When an Access Point ARN is provided and this flag is enabled, the SDK MUST use the ARN's region when constructing the endpoint instead of the client's configured region.", "type": "boolean" }, "ResourceArn": { "required": false, "documentation": "The resource ARN included in the request. Only set on TagResource, UntagResourceand ListTagsForResource", "type": "string" }, "UseS3ExpressControlEndpoint": { "required": false, "documentation": "Internal parameter to indicate whether S3Express operation should use control plane, (ex. ListDirectoryAccessPoints)", "type": "boolean" } }, "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Region" } ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "partitionResult" }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "partitionResult" }, "name" ] }, "aws-cn" ] } ], "error": "Partition does not support FIPS", "type": "error" }, { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "OutpostId" } ] } ], "rules": [ { "conditions": [ { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "partitionResult" } ], "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "RequiresAccountId" } ] }, { "fn": "booleanEquals", "argv": [ { "ref": "RequiresAccountId" }, true ] }, { "fn": "not", "argv": [ { "fn": "isSet", "argv": [ { "ref": "AccountId" } ] } ] } ], "error": "AccountId is required but not set", "type": "error" }, { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "AccountId" } ] }, { "fn": "not", "argv": [ { "fn": "isValidHostLabel", "argv": [ { "ref": "AccountId" }, false ] } ] } ], "error": "AccountId must only contain a-z, A-Z, 0-9 and `-`.", "type": "error" }, { "conditions": [ { "fn": "not", "argv": [ { "fn": "isValidHostLabel", "argv": [ { "ref": "OutpostId" }, false ] } ] } ], "error": "OutpostId must only contain a-z, A-Z, 0-9 and `-`.", "type": "error" }, { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "error": "Invalid Configuration: DualStack and custom endpoint are not supported", "type": "error" }, { "conditions": [ { "fn": "isValidHostLabel", "argv": [ { "ref": "Region" }, true ] } ], "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] }, { "fn": "parseURL", "argv": [ { "ref": "Endpoint" } ], "assign": "url" } ], "endpoint": { "url": "{url#scheme}://{url#authority}{url#path}", "properties": { "authSchemes": [ { "disableDoubleEncoding": true, "name": "sigv4", "signingName": "s3-outposts", "signingRegion": "{Region}" } ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "endpoint": { "url": "https://s3-outposts-fips.{Region}.{partitionResult#dualStackDnsSuffix}", "properties": { "authSchemes": [ { "disableDoubleEncoding": true, "name": "sigv4", "signingName": "s3-outposts", "signingRegion": "{Region}" } ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "endpoint": { "url": "https://s3-outposts-fips.{Region}.{partitionResult#dnsSuffix}", "properties": { "authSchemes": [ { "disableDoubleEncoding": true, "name": "sigv4", "signingName": "s3-outposts", "signingRegion": "{Region}" } ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "endpoint": { "url": "https://s3-outposts.{Region}.{partitionResult#dualStackDnsSuffix}", "properties": { "authSchemes": [ { "disableDoubleEncoding": true, "name": "sigv4", "signingName": "s3-outposts", "signingRegion": "{Region}" } ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://s3-outposts.{Region}.{partitionResult#dnsSuffix}", "properties": { "authSchemes": [ { "disableDoubleEncoding": true, "name": "sigv4", "signingName": "s3-outposts", "signingRegion": "{Region}" } ] }, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "Invalid region: region was not a valid DNS name.", "type": "error" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "ResourceArn" } ] }, { "fn": "aws.parseArn", "argv": [ { "ref": "ResourceArn" } ], "assign": "resourceArn" }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "resourceArn" }, "service" ] }, "s3express" ] } ], "rules": [ { "conditions": [ { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "partitionResult" } ], "rules": [ { "conditions": [ { "fn": "aws.partition", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "resourceArn" }, "region" ] } ], "assign": "arnPartition" } ], "rules": [ { "conditions": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "arnPartition" }, "name" ] }, { "fn": "getAttr", "argv": [ { "ref": "partitionResult" }, "name" ] } ] } ], "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "UseArnRegion" } ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseArnRegion" }, false ] }, { "fn": "not", "argv": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "resourceArn" }, "region" ] }, "{Region}" ] } ] } ], "error": "Invalid configuration: region from ARN `{resourceArn#region}` does not match client region `{Region}` and UseArnRegion is `false`", "type": "error" }, { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "error": "Invalid Configuration: DualStack and custom endpoint are not supported", "type": "error" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "error": "S3Express does not support Dual-stack.", "type": "error" }, { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] }, { "fn": "parseURL", "argv": [ { "ref": "Endpoint" } ], "assign": "url" } ], "endpoint": { "url": "{url#scheme}://{url#authority}", "properties": { "authSchemes": [ { "disableDoubleEncoding": true, "name": "sigv4", "signingName": "s3express", "signingRegion": "{Region}" } ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "endpoint": { "url": "https://s3express-control-fips.{Region}.{partitionResult#dnsSuffix}", "properties": { "authSchemes": [ { "disableDoubleEncoding": true, "name": "sigv4", "signingName": "s3express", "signingRegion": "{Region}" } ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://s3express-control.{Region}.{partitionResult#dnsSuffix}", "properties": { "authSchemes": [ { "disableDoubleEncoding": true, "name": "sigv4", "signingName": "s3express", "signingRegion": "{Region}" } ] }, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "Client was configured for partition `{partitionResult#name}` but ARN has `{arnPartition#name}`", "type": "error" } ], "type": "tree" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "AccessPointName" } ] }, { "fn": "substring", "argv": [ { "ref": "AccessPointName" }, 0, 7, true ], "assign": "accessPointSuffix" }, { "fn": "stringEquals", "argv": [ { "ref": "accessPointSuffix" }, "--xa-s3" ] } ], "rules": [ { "conditions": [ { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "partitionResult" } ], "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "error": "Invalid Configuration: DualStack and custom endpoint are not supported", "type": "error" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "error": "S3Express does not support Dual-stack.", "type": "error" }, { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] }, { "fn": "parseURL", "argv": [ { "ref": "Endpoint" } ], "assign": "url" } ], "endpoint": { "url": "{url#scheme}://{url#authority}", "properties": { "authSchemes": [ { "disableDoubleEncoding": true, "name": "sigv4", "signingName": "s3express", "signingRegion": "{Region}" } ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "substring", "argv": [ { "ref": "AccessPointName" }, 7, 15, true ], "assign": "s3expressAvailabilityZoneId" }, { "fn": "substring", "argv": [ { "ref": "AccessPointName" }, 15, 17, true ], "assign": "s3expressAvailabilityZoneDelim" }, { "fn": "stringEquals", "argv": [ { "ref": "s3expressAvailabilityZoneDelim" }, "--" ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "endpoint": { "url": "https://s3express-control-fips.{Region}.{partitionResult#dnsSuffix}", "properties": { "authSchemes": [ { "disableDoubleEncoding": true, "name": "sigv4", "signingName": "s3express", "signingRegion": "{Region}" } ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://s3express-control.{Region}.{partitionResult#dnsSuffix}", "properties": { "authSchemes": [ { "disableDoubleEncoding": true, "name": "sigv4", "signingName": "s3express", "signingRegion": "{Region}" } ] }, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [ { "fn": "substring", "argv": [ { "ref": "AccessPointName" }, 7, 16, true ], "assign": "s3expressAvailabilityZoneId" }, { "fn": "substring", "argv": [ { "ref": "AccessPointName" }, 16, 18, true ], "assign": "s3expressAvailabilityZoneDelim" }, { "fn": "stringEquals", "argv": [ { "ref": "s3expressAvailabilityZoneDelim" }, "--" ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "endpoint": { "url": "https://s3express-control-fips.{Region}.{partitionResult#dnsSuffix}", "properties": { "authSchemes": [ { "disableDoubleEncoding": true, "name": "sigv4", "signingName": "s3express", "signingRegion": "{Region}" } ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://s3express-control.{Region}.{partitionResult#dnsSuffix}", "properties": { "authSchemes": [ { "disableDoubleEncoding": true, "name": "sigv4", "signingName": "s3express", "signingRegion": "{Region}" } ] }, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [ { "fn": "substring", "argv": [ { "ref": "AccessPointName" }, 7, 20, true ], "assign": "s3expressAvailabilityZoneId" }, { "fn": "substring", "argv": [ { "ref": "AccessPointName" }, 20, 22, true ], "assign": "s3expressAvailabilityZoneDelim" }, { "fn": "stringEquals", "argv": [ { "ref": "s3expressAvailabilityZoneDelim" }, "--" ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "endpoint": { "url": "https://s3express-control-fips.{Region}.{partitionResult#dnsSuffix}", "properties": { "authSchemes": [ { "disableDoubleEncoding": true, "name": "sigv4", "signingName": "s3express", "signingRegion": "{Region}" } ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://s3express-control.{Region}.{partitionResult#dnsSuffix}", "properties": { "authSchemes": [ { "disableDoubleEncoding": true, "name": "sigv4", "signingName": "s3express", "signingRegion": "{Region}" } ] }, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [ { "fn": "substring", "argv": [ { "ref": "AccessPointName" }, 7, 21, true ], "assign": "s3expressAvailabilityZoneId" }, { "fn": "substring", "argv": [ { "ref": "AccessPointName" }, 21, 23, true ], "assign": "s3expressAvailabilityZoneDelim" }, { "fn": "stringEquals", "argv": [ { "ref": "s3expressAvailabilityZoneDelim" }, "--" ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "endpoint": { "url": "https://s3express-control-fips.{Region}.{partitionResult#dnsSuffix}", "properties": { "authSchemes": [ { "disableDoubleEncoding": true, "name": "sigv4", "signingName": "s3express", "signingRegion": "{Region}" } ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://s3express-control.{Region}.{partitionResult#dnsSuffix}", "properties": { "authSchemes": [ { "disableDoubleEncoding": true, "name": "sigv4", "signingName": "s3express", "signingRegion": "{Region}" } ] }, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [ { "fn": "substring", "argv": [ { "ref": "AccessPointName" }, 7, 27, true ], "assign": "s3expressAvailabilityZoneId" }, { "fn": "substring", "argv": [ { "ref": "AccessPointName" }, 27, 29, true ], "assign": "s3expressAvailabilityZoneDelim" }, { "fn": "stringEquals", "argv": [ { "ref": "s3expressAvailabilityZoneDelim" }, "--" ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "endpoint": { "url": "https://s3express-control-fips.{Region}.{partitionResult#dnsSuffix}", "properties": { "authSchemes": [ { "disableDoubleEncoding": true, "name": "sigv4", "signingName": "s3express", "signingRegion": "{Region}" } ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://s3express-control.{Region}.{partitionResult#dnsSuffix}", "properties": { "authSchemes": [ { "disableDoubleEncoding": true, "name": "sigv4", "signingName": "s3express", "signingRegion": "{Region}" } ] }, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "Unrecognized S3Express Access Point name format.", "type": "error" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "UseS3ExpressControlEndpoint" } ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseS3ExpressControlEndpoint" }, true ] } ], "rules": [ { "conditions": [ { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "partitionResult" } ], "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "error": "Invalid Configuration: DualStack and custom endpoint are not supported", "type": "error" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "error": "S3Express does not support Dual-stack.", "type": "error" }, { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] }, { "fn": "parseURL", "argv": [ { "ref": "Endpoint" } ], "assign": "url" } ], "endpoint": { "url": "{url#scheme}://{url#authority}", "properties": { "authSchemes": [ { "disableDoubleEncoding": true, "name": "sigv4", "signingName": "s3express", "signingRegion": "{Region}" } ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "endpoint": { "url": "https://s3express-control-fips.{Region}.{partitionResult#dnsSuffix}", "properties": { "authSchemes": [ { "disableDoubleEncoding": true, "name": "sigv4", "signingName": "s3express", "signingRegion": "{Region}" } ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://s3express-control.{Region}.{partitionResult#dnsSuffix}", "properties": { "authSchemes": [ { "disableDoubleEncoding": true, "name": "sigv4", "signingName": "s3express", "signingRegion": "{Region}" } ] }, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [ { "fn": "stringEquals", "argv": [ { "ref": "Region" }, "snow" ] }, { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] }, { "fn": "parseURL", "argv": [ { "ref": "Endpoint" } ], "assign": "url" } ], "rules": [ { "conditions": [ { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "partitionResult" } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "error": "S3 Snow does not support DualStack", "type": "error" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "error": "S3 Snow does not support FIPS", "type": "error" }, { "conditions": [], "endpoint": { "url": "{url#scheme}://{url#authority}", "properties": { "authSchemes": [ { "disableDoubleEncoding": true, "name": "sigv4", "signingName": "s3", "signingRegion": "{Region}" } ] }, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "AccessPointName" } ] }, { "fn": "aws.parseArn", "argv": [ { "ref": "AccessPointName" } ], "assign": "accessPointArn" } ], "rules": [ { "conditions": [ { "fn": "getAttr", "argv": [ { "ref": "accessPointArn" }, "resourceId[0]" ], "assign": "arnType" }, { "fn": "not", "argv": [ { "fn": "stringEquals", "argv": [ { "ref": "arnType" }, "" ] } ] } ], "rules": [ { "conditions": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "accessPointArn" }, "service" ] }, "s3-outposts" ] } ], "rules": [ { "conditions": [ { "fn": "getAttr", "argv": [ { "ref": "accessPointArn" }, "resourceId[1]" ], "assign": "outpostId" } ], "rules": [ { "conditions": [ { "fn": "isValidHostLabel", "argv": [ { "ref": "outpostId" }, false ] } ], "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "error": "Invalid Configuration: DualStack and custom endpoint are not supported", "type": "error" }, { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "UseArnRegion" } ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseArnRegion" }, false ] }, { "fn": "not", "argv": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "accessPointArn" }, "region" ] }, "{Region}" ] } ] } ], "error": "Invalid configuration: region from ARN `{accessPointArn#region}` does not match client region `{Region}` and UseArnRegion is `false`", "type": "error" }, { "conditions": [ { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "partitionResult" } ], "rules": [ { "conditions": [ { "fn": "aws.partition", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "accessPointArn" }, "region" ] } ], "assign": "arnPartition" } ], "rules": [ { "conditions": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "arnPartition" }, "name" ] }, { "fn": "getAttr", "argv": [ { "ref": "partitionResult" }, "name" ] } ] } ], "rules": [ { "conditions": [ { "fn": "isValidHostLabel", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "accessPointArn" }, "region" ] }, true ] } ], "rules": [ { "conditions": [ { "fn": "not", "argv": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "accessPointArn" }, "accountId" ] }, "" ] } ] } ], "rules": [ { "conditions": [ { "fn": "isValidHostLabel", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "accessPointArn" }, "accountId" ] }, false ] } ], "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "AccountId" } ] }, { "fn": "not", "argv": [ { "fn": "stringEquals", "argv": [ { "ref": "AccountId" }, "{accessPointArn#accountId}" ] } ] } ], "error": "Invalid ARN: the accountId specified in the ARN (`{accessPointArn#accountId}`) does not match the parameter (`{AccountId}`)", "type": "error" }, { "conditions": [ { "fn": "getAttr", "argv": [ { "ref": "accessPointArn" }, "resourceId[2]" ], "assign": "outpostType" } ], "rules": [ { "conditions": [ { "fn": "getAttr", "argv": [ { "ref": "accessPointArn" }, "resourceId[3]" ], "assign": "accessPointName" } ], "rules": [ { "conditions": [ { "fn": "stringEquals", "argv": [ { "ref": "outpostType" }, "accesspoint" ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "endpoint": { "url": "https://s3-outposts-fips.{accessPointArn#region}.{arnPartition#dualStackDnsSuffix}", "properties": { "authSchemes": [ { "disableDoubleEncoding": true, "name": "sigv4", "signingName": "s3-outposts", "signingRegion": "{accessPointArn#region}" } ] }, "headers": { "x-amz-account-id": [ "{accessPointArn#accountId}" ], "x-amz-outpost-id": [ "{outpostId}" ] } }, "type": "endpoint" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "endpoint": { "url": "https://s3-outposts-fips.{accessPointArn#region}.{arnPartition#dnsSuffix}", "properties": { "authSchemes": [ { "disableDoubleEncoding": true, "name": "sigv4", "signingName": "s3-outposts", "signingRegion": "{accessPointArn#region}" } ] }, "headers": { "x-amz-account-id": [ "{accessPointArn#accountId}" ], "x-amz-outpost-id": [ "{outpostId}" ] } }, "type": "endpoint" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "endpoint": { "url": "https://s3-outposts.{accessPointArn#region}.{arnPartition#dualStackDnsSuffix}", "properties": { "authSchemes": [ { "disableDoubleEncoding": true, "name": "sigv4", "signingName": "s3-outposts", "signingRegion": "{accessPointArn#region}" } ] }, "headers": { "x-amz-account-id": [ "{accessPointArn#accountId}" ], "x-amz-outpost-id": [ "{outpostId}" ] } }, "type": "endpoint" }, { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] }, { "fn": "parseURL", "argv": [ { "ref": "Endpoint" } ], "assign": "url" } ], "endpoint": { "url": "{url#scheme}://{url#authority}{url#path}", "properties": { "authSchemes": [ { "disableDoubleEncoding": true, "name": "sigv4", "signingName": "s3-outposts", "signingRegion": "{accessPointArn#region}" } ] }, "headers": { "x-amz-account-id": [ "{accessPointArn#accountId}" ], "x-amz-outpost-id": [ "{outpostId}" ] } }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://s3-outposts.{accessPointArn#region}.{arnPartition#dnsSuffix}", "properties": { "authSchemes": [ { "disableDoubleEncoding": true, "name": "sigv4", "signingName": "s3-outposts", "signingRegion": "{accessPointArn#region}" } ] }, "headers": { "x-amz-account-id": [ "{accessPointArn#accountId}" ], "x-amz-outpost-id": [ "{outpostId}" ] } }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "Expected an outpost type `accesspoint`, found `{outpostType}`", "type": "error" } ], "type": "tree" }, { "conditions": [], "error": "Invalid ARN: expected an access point name", "type": "error" } ], "type": "tree" }, { "conditions": [], "error": "Invalid ARN: Expected a 4-component resource", "type": "error" } ], "type": "tree" }, { "conditions": [], "error": "Invalid ARN: The account id may only contain a-z, A-Z, 0-9 and `-`. Found: `{accessPointArn#accountId}`", "type": "error" } ], "type": "tree" }, { "conditions": [], "error": "Invalid ARN: missing account ID", "type": "error" } ], "type": "tree" }, { "conditions": [], "error": "Invalid region in ARN: `{accessPointArn#region}` (invalid DNS name)", "type": "error" } ], "type": "tree" }, { "conditions": [], "error": "Client was configured for partition `{partitionResult#name}` but ARN has `{arnPartition#name}`", "type": "error" } ], "type": "tree" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "Invalid ARN: The outpost Id must only contain a-z, A-Z, 0-9 and `-`., found: `{outpostId}`", "type": "error" } ], "type": "tree" }, { "conditions": [], "error": "Invalid ARN: The Outpost Id was not set", "type": "error" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "Invalid ARN: No ARN type specified", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Bucket" } ] }, { "fn": "aws.parseArn", "argv": [ { "ref": "Bucket" } ], "assign": "bucketArn" } ], "rules": [ { "conditions": [ { "fn": "getAttr", "argv": [ { "ref": "bucketArn" }, "resourceId[0]" ], "assign": "arnType" }, { "fn": "not", "argv": [ { "fn": "stringEquals", "argv": [ { "ref": "arnType" }, "" ] } ] } ], "rules": [ { "conditions": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "bucketArn" }, "service" ] }, "s3-outposts" ] } ], "rules": [ { "conditions": [ { "fn": "getAttr", "argv": [ { "ref": "bucketArn" }, "resourceId[1]" ], "assign": "outpostId" } ], "rules": [ { "conditions": [ { "fn": "isValidHostLabel", "argv": [ { "ref": "outpostId" }, false ] } ], "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "error": "Invalid Configuration: DualStack and custom endpoint are not supported", "type": "error" }, { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "UseArnRegion" } ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseArnRegion" }, false ] }, { "fn": "not", "argv": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "bucketArn" }, "region" ] }, "{Region}" ] } ] } ], "error": "Invalid configuration: region from ARN `{bucketArn#region}` does not match client region `{Region}` and UseArnRegion is `false`", "type": "error" }, { "conditions": [ { "fn": "aws.partition", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "bucketArn" }, "region" ] } ], "assign": "arnPartition" } ], "rules": [ { "conditions": [ { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "partitionResult" } ], "rules": [ { "conditions": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "arnPartition" }, "name" ] }, { "fn": "getAttr", "argv": [ { "ref": "partitionResult" }, "name" ] } ] } ], "rules": [ { "conditions": [ { "fn": "isValidHostLabel", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "bucketArn" }, "region" ] }, true ] } ], "rules": [ { "conditions": [ { "fn": "not", "argv": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "bucketArn" }, "accountId" ] }, "" ] } ] } ], "rules": [ { "conditions": [ { "fn": "isValidHostLabel", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "bucketArn" }, "accountId" ] }, false ] } ], "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "AccountId" } ] }, { "fn": "not", "argv": [ { "fn": "stringEquals", "argv": [ { "ref": "AccountId" }, "{bucketArn#accountId}" ] } ] } ], "error": "Invalid ARN: the accountId specified in the ARN (`{bucketArn#accountId}`) does not match the parameter (`{AccountId}`)", "type": "error" }, { "conditions": [ { "fn": "getAttr", "argv": [ { "ref": "bucketArn" }, "resourceId[2]" ], "assign": "outpostType" } ], "rules": [ { "conditions": [ { "fn": "getAttr", "argv": [ { "ref": "bucketArn" }, "resourceId[3]" ], "assign": "bucketName" } ], "rules": [ { "conditions": [ { "fn": "stringEquals", "argv": [ { "ref": "outpostType" }, "bucket" ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "endpoint": { "url": "https://s3-outposts-fips.{bucketArn#region}.{arnPartition#dualStackDnsSuffix}", "properties": { "authSchemes": [ { "disableDoubleEncoding": true, "name": "sigv4", "signingName": "s3-outposts", "signingRegion": "{bucketArn#region}" } ] }, "headers": { "x-amz-account-id": [ "{bucketArn#accountId}" ], "x-amz-outpost-id": [ "{outpostId}" ] } }, "type": "endpoint" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "endpoint": { "url": "https://s3-outposts-fips.{bucketArn#region}.{arnPartition#dnsSuffix}", "properties": { "authSchemes": [ { "disableDoubleEncoding": true, "name": "sigv4", "signingName": "s3-outposts", "signingRegion": "{bucketArn#region}" } ] }, "headers": { "x-amz-account-id": [ "{bucketArn#accountId}" ], "x-amz-outpost-id": [ "{outpostId}" ] } }, "type": "endpoint" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "endpoint": { "url": "https://s3-outposts.{bucketArn#region}.{arnPartition#dualStackDnsSuffix}", "properties": { "authSchemes": [ { "disableDoubleEncoding": true, "name": "sigv4", "signingName": "s3-outposts", "signingRegion": "{bucketArn#region}" } ] }, "headers": { "x-amz-account-id": [ "{bucketArn#accountId}" ], "x-amz-outpost-id": [ "{outpostId}" ] } }, "type": "endpoint" }, { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] }, { "fn": "parseURL", "argv": [ { "ref": "Endpoint" } ], "assign": "url" } ], "endpoint": { "url": "{url#scheme}://{url#authority}{url#path}", "properties": { "authSchemes": [ { "disableDoubleEncoding": true, "name": "sigv4", "signingName": "s3-outposts", "signingRegion": "{bucketArn#region}" } ] }, "headers": { "x-amz-account-id": [ "{bucketArn#accountId}" ], "x-amz-outpost-id": [ "{outpostId}" ] } }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://s3-outposts.{bucketArn#region}.{arnPartition#dnsSuffix}", "properties": { "authSchemes": [ { "disableDoubleEncoding": true, "name": "sigv4", "signingName": "s3-outposts", "signingRegion": "{bucketArn#region}" } ] }, "headers": { "x-amz-account-id": [ "{bucketArn#accountId}" ], "x-amz-outpost-id": [ "{outpostId}" ] } }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "Invalid ARN: Expected an outpost type `bucket`, found `{outpostType}`", "type": "error" } ], "type": "tree" }, { "conditions": [], "error": "Invalid ARN: expected a bucket name", "type": "error" } ], "type": "tree" }, { "conditions": [], "error": "Invalid ARN: Expected a 4-component resource", "type": "error" } ], "type": "tree" }, { "conditions": [], "error": "Invalid ARN: The account id may only contain a-z, A-Z, 0-9 and `-`. Found: `{bucketArn#accountId}`", "type": "error" } ], "type": "tree" }, { "conditions": [], "error": "Invalid ARN: missing account ID", "type": "error" } ], "type": "tree" }, { "conditions": [], "error": "Invalid region in ARN: `{bucketArn#region}` (invalid DNS name)", "type": "error" } ], "type": "tree" }, { "conditions": [], "error": "Client was configured for partition `{partitionResult#name}` but ARN has `{arnPartition#name}`", "type": "error" } ], "type": "tree" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "Invalid ARN: The outpost Id must only contain a-z, A-Z, 0-9 and `-`., found: `{outpostId}`", "type": "error" } ], "type": "tree" }, { "conditions": [], "error": "Invalid ARN: The Outpost Id was not set", "type": "error" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "Invalid ARN: No ARN type specified", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "partitionResult" } ], "rules": [ { "conditions": [ { "fn": "isValidHostLabel", "argv": [ { "ref": "Region" }, true ] } ], "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "RequiresAccountId" } ] }, { "fn": "booleanEquals", "argv": [ { "ref": "RequiresAccountId" }, true ] }, { "fn": "not", "argv": [ { "fn": "isSet", "argv": [ { "ref": "AccountId" } ] } ] } ], "error": "AccountId is required but not set", "type": "error" }, { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "AccountId" } ] }, { "fn": "not", "argv": [ { "fn": "isValidHostLabel", "argv": [ { "ref": "AccountId" }, false ] } ] } ], "error": "AccountId must only contain a-z, A-Z, 0-9 and `-`.", "type": "error" }, { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] }, { "fn": "parseURL", "argv": [ { "ref": "Endpoint" } ], "assign": "url" } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "error": "Invalid Configuration: DualStack and custom endpoint are not supported", "type": "error" }, { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "RequiresAccountId" } ] }, { "fn": "booleanEquals", "argv": [ { "ref": "RequiresAccountId" }, true ] }, { "fn": "isSet", "argv": [ { "ref": "AccountId" } ] } ], "endpoint": { "url": "{url#scheme}://{AccountId}.{url#authority}{url#path}", "properties": { "authSchemes": [ { "disableDoubleEncoding": true, "name": "sigv4", "signingName": "s3", "signingRegion": "{Region}" } ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "{url#scheme}://{url#authority}{url#path}", "properties": { "authSchemes": [ { "disableDoubleEncoding": true, "name": "sigv4", "signingName": "s3", "signingRegion": "{Region}" } ] }, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] }, { "fn": "isSet", "argv": [ { "ref": "RequiresAccountId" } ] }, { "fn": "booleanEquals", "argv": [ { "ref": "RequiresAccountId" }, true ] }, { "fn": "isSet", "argv": [ { "ref": "AccountId" } ] } ], "endpoint": { "url": "https://{AccountId}.s3-control-fips.dualstack.{Region}.{partitionResult#dnsSuffix}", "properties": { "authSchemes": [ { "disableDoubleEncoding": true, "name": "sigv4", "signingName": "s3", "signingRegion": "{Region}" } ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "endpoint": { "url": "https://s3-control-fips.dualstack.{Region}.{partitionResult#dnsSuffix}", "properties": { "authSchemes": [ { "disableDoubleEncoding": true, "name": "sigv4", "signingName": "s3", "signingRegion": "{Region}" } ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, false ] }, { "fn": "isSet", "argv": [ { "ref": "RequiresAccountId" } ] }, { "fn": "booleanEquals", "argv": [ { "ref": "RequiresAccountId" }, true ] }, { "fn": "isSet", "argv": [ { "ref": "AccountId" } ] } ], "endpoint": { "url": "https://{AccountId}.s3-control-fips.{Region}.{partitionResult#dnsSuffix}", "properties": { "authSchemes": [ { "disableDoubleEncoding": true, "name": "sigv4", "signingName": "s3", "signingRegion": "{Region}" } ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, false ] } ], "endpoint": { "url": "https://s3-control-fips.{Region}.{partitionResult#dnsSuffix}", "properties": { "authSchemes": [ { "disableDoubleEncoding": true, "name": "sigv4", "signingName": "s3", "signingRegion": "{Region}" } ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, false ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] }, { "fn": "isSet", "argv": [ { "ref": "RequiresAccountId" } ] }, { "fn": "booleanEquals", "argv": [ { "ref": "RequiresAccountId" }, true ] }, { "fn": "isSet", "argv": [ { "ref": "AccountId" } ] } ], "endpoint": { "url": "https://{AccountId}.s3-control.dualstack.{Region}.{partitionResult#dnsSuffix}", "properties": { "authSchemes": [ { "disableDoubleEncoding": true, "name": "sigv4", "signingName": "s3", "signingRegion": "{Region}" } ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, false ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "endpoint": { "url": "https://s3-control.dualstack.{Region}.{partitionResult#dnsSuffix}", "properties": { "authSchemes": [ { "disableDoubleEncoding": true, "name": "sigv4", "signingName": "s3", "signingRegion": "{Region}" } ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, false ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, false ] }, { "fn": "isSet", "argv": [ { "ref": "RequiresAccountId" } ] }, { "fn": "booleanEquals", "argv": [ { "ref": "RequiresAccountId" }, true ] }, { "fn": "isSet", "argv": [ { "ref": "AccountId" } ] } ], "endpoint": { "url": "https://{AccountId}.s3-control.{Region}.{partitionResult#dnsSuffix}", "properties": { "authSchemes": [ { "disableDoubleEncoding": true, "name": "sigv4", "signingName": "s3", "signingRegion": "{Region}" } ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, false ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, false ] } ], "endpoint": { "url": "https://s3-control.{Region}.{partitionResult#dnsSuffix}", "properties": { "authSchemes": [ { "disableDoubleEncoding": true, "name": "sigv4", "signingName": "s3", "signingRegion": "{Region}" } ] }, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "Invalid region: region was not a valid DNS name.", "type": "error" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "Region must be set", "type": "error" } ] }, "smithy.rules#endpointTests": { "testCases": [ { "documentation": "Vanilla outposts without ARN region + access point ARN@us-west-2", "expect": { "endpoint": { "headers": { "x-amz-account-id": [ "123456789012" ], "x-amz-outpost-id": [ "op-01234567890123456" ] }, "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "s3-outposts", "signingRegion": "us-west-2", "disableDoubleEncoding": true } ] }, "url": "https://s3-outposts.us-west-2.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-west-2" }, "operationName": "GetAccessPoint", "operationParams": { "Name": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", "AccountId": "123456789012" } }, { "builtInParams": { "AWS::Region": "us-west-2" }, "operationName": "DeleteAccessPoint", "operationParams": { "Name": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", "AccountId": "123456789012" } } ], "params": { "AccessPointName": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", "AccountId": "123456789012", "Region": "us-west-2", "RequiresAccountId": true, "UseDualStack": false, "UseFIPS": false } }, { "documentation": "Vanilla outposts with ARN region + access point ARN@us-west-2", "expect": { "endpoint": { "headers": { "x-amz-account-id": [ "123456789012" ], "x-amz-outpost-id": [ "op-01234567890123456" ] }, "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "s3-outposts", "signingRegion": "us-east-1", "disableDoubleEncoding": true } ] }, "url": "https://s3-outposts.us-east-1.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-west-2" }, "operationName": "GetAccessPoint", "operationParams": { "Name": "arn:aws:s3-outposts:us-east-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", "AccountId": "123456789012" } }, { "builtInParams": { "AWS::Region": "us-west-2" }, "operationName": "DeleteAccessPoint", "operationParams": { "Name": "arn:aws:s3-outposts:us-east-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", "AccountId": "123456789012" } } ], "params": { "AccessPointName": "arn:aws:s3-outposts:us-east-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", "AccountId": "123456789012", "Region": "us-west-2", "RequiresAccountId": true, "UseDualStack": false, "UseFIPS": false } }, { "documentation": "accept an access point ARN@us-west-2", "expect": { "endpoint": { "headers": { "x-amz-account-id": [ "123456789012" ], "x-amz-outpost-id": [ "op-01234567890123456" ] }, "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "s3-outposts", "signingRegion": "us-west-2", "disableDoubleEncoding": true } ] }, "url": "https://s3-outposts.us-west-2.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-west-2" }, "operationName": "GetAccessPoint", "operationParams": { "Name": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", "AccountId": "123456789012" } }, { "builtInParams": { "AWS::Region": "us-west-2" }, "operationName": "DeleteAccessPoint", "operationParams": { "Name": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", "AccountId": "123456789012" } } ], "params": { "AccessPointName": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", "AccountId": "123456789012", "Region": "us-west-2", "RequiresAccountId": true, "UseDualStack": false, "UseFIPS": false } }, { "documentation": "vanilla outposts china@cn-north-1", "expect": { "endpoint": { "headers": { "x-amz-account-id": [ "123456789012" ], "x-amz-outpost-id": [ "op-01234567890123456" ] }, "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "s3-outposts", "signingRegion": "cn-north-1", "disableDoubleEncoding": true } ] }, "url": "https://s3-outposts.cn-north-1.amazonaws.com.cn" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "cn-north-1" }, "operationName": "GetAccessPoint", "operationParams": { "Name": "arn:aws-cn:s3-outposts:cn-north-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", "AccountId": "123456789012" } }, { "builtInParams": { "AWS::Region": "cn-north-1" }, "operationName": "DeleteAccessPoint", "operationParams": { "Name": "arn:aws-cn:s3-outposts:cn-north-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", "AccountId": "123456789012" } } ], "params": { "AccessPointName": "arn:aws-cn:s3-outposts:cn-north-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", "AccountId": "123456789012", "Region": "cn-north-1", "RequiresAccountId": true, "UseDualStack": false, "UseFIPS": false } }, { "documentation": "gov region@us-west-2", "expect": { "endpoint": { "headers": { "x-amz-account-id": [ "123456789012" ], "x-amz-outpost-id": [ "op-01234567890123456" ] }, "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "s3-outposts", "signingRegion": "us-west-2", "disableDoubleEncoding": true } ] }, "url": "https://s3-outposts.us-west-2.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-west-2" }, "operationName": "GetAccessPoint", "operationParams": { "Name": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", "AccountId": "123456789012" } }, { "builtInParams": { "AWS::Region": "us-west-2" }, "operationName": "DeleteAccessPoint", "operationParams": { "Name": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", "AccountId": "123456789012" } } ], "params": { "AccessPointName": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", "AccountId": "123456789012", "Region": "us-west-2", "RequiresAccountId": true, "UseDualStack": false, "UseFIPS": false } }, { "documentation": "gov cloud with fips@us-west-2", "expect": { "endpoint": { "headers": { "x-amz-account-id": [ "123456789012" ], "x-amz-outpost-id": [ "op-01234567890123456" ] }, "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "s3-outposts", "signingRegion": "us-west-2", "disableDoubleEncoding": true } ] }, "url": "https://s3-outposts-fips.us-west-2.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-west-2", "AWS::UseFIPS": true }, "operationName": "GetAccessPoint", "operationParams": { "Name": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", "AccountId": "123456789012" } }, { "builtInParams": { "AWS::Region": "us-west-2", "AWS::UseFIPS": true }, "operationName": "DeleteAccessPoint", "operationParams": { "Name": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", "AccountId": "123456789012" } } ], "params": { "AccessPointName": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", "AccountId": "123456789012", "Region": "us-west-2", "RequiresAccountId": true, "UseDualStack": false, "UseFIPS": true } }, { "documentation": "govcloud with fips + arn region@us-gov-west-1", "expect": { "endpoint": { "headers": { "x-amz-account-id": [ "123456789012" ], "x-amz-outpost-id": [ "op-01234567890123456" ] }, "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "s3-outposts", "signingRegion": "us-gov-east-1", "disableDoubleEncoding": true } ] }, "url": "https://s3-outposts-fips.us-gov-east-1.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-gov-west-1", "AWS::UseFIPS": true }, "operationName": "GetAccessPoint", "operationParams": { "Name": "arn:aws-us-gov:s3-outposts:us-gov-east-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", "AccountId": "123456789012" } }, { "builtInParams": { "AWS::Region": "us-gov-west-1", "AWS::UseFIPS": true }, "operationName": "DeleteAccessPoint", "operationParams": { "Name": "arn:aws-us-gov:s3-outposts:us-gov-east-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", "AccountId": "123456789012" } } ], "params": { "AccessPointName": "arn:aws-us-gov:s3-outposts:us-gov-east-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", "AccountId": "123456789012", "Region": "us-gov-west-1", "RequiresAccountId": true, "UseDualStack": false, "UseFIPS": true } }, { "documentation": "gov region@cn-north-1", "expect": { "endpoint": { "headers": { "x-amz-account-id": [ "123456789012" ], "x-amz-outpost-id": [ "op-01234567890123456" ] }, "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "s3-outposts", "signingRegion": "cn-north-1", "disableDoubleEncoding": true } ] }, "url": "https://s3-outposts.cn-north-1.amazonaws.com.cn" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "cn-north-1" }, "operationName": "GetAccessPoint", "operationParams": { "Name": "arn:aws-cn:s3-outposts:cn-north-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", "AccountId": "123456789012" } }, { "builtInParams": { "AWS::Region": "cn-north-1" }, "operationName": "DeleteAccessPoint", "operationParams": { "Name": "arn:aws-cn:s3-outposts:cn-north-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", "AccountId": "123456789012" } } ], "params": { "AccessPointName": "arn:aws-cn:s3-outposts:cn-north-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", "AccountId": "123456789012", "Region": "cn-north-1", "RequiresAccountId": true, "UseDualStack": false, "UseFIPS": false } }, { "documentation": "gov cloud with fips@cn-north-1", "expect": { "error": "Partition does not support FIPS" }, "operationInputs": [ { "builtInParams": { "AWS::Region": "cn-north-1", "AWS::UseFIPS": true }, "operationName": "GetAccessPoint", "operationParams": { "Name": "arn:aws-cn:s3-outposts:cn-north-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", "AccountId": "123456789012" } }, { "builtInParams": { "AWS::Region": "cn-north-1", "AWS::UseFIPS": true }, "operationName": "DeleteAccessPoint", "operationParams": { "Name": "arn:aws-cn:s3-outposts:cn-north-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", "AccountId": "123456789012" } } ], "params": { "AccessPointName": "arn:aws-cn:s3-outposts:cn-north-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", "AccountId": "123456789012", "Region": "cn-north-1", "RequiresAccountId": true, "UseDualStack": false, "UseFIPS": true } }, { "documentation": "govcloud with fips + arn region@us-gov-west-1", "expect": { "endpoint": { "headers": { "x-amz-account-id": [ "123456789012" ], "x-amz-outpost-id": [ "op-01234567890123456" ] }, "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "s3-outposts", "signingRegion": "us-gov-east-1", "disableDoubleEncoding": true } ] }, "url": "https://s3-outposts-fips.us-gov-east-1.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-gov-west-1", "AWS::UseFIPS": true }, "operationName": "GetAccessPoint", "operationParams": { "Name": "arn:aws-us-gov:s3-outposts:us-gov-east-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", "AccountId": "123456789012" } }, { "builtInParams": { "AWS::Region": "us-gov-west-1", "AWS::UseFIPS": true }, "operationName": "DeleteAccessPoint", "operationParams": { "Name": "arn:aws-us-gov:s3-outposts:us-gov-east-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", "AccountId": "123456789012" } } ], "params": { "AccessPointName": "arn:aws-us-gov:s3-outposts:us-gov-east-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", "AccountId": "123456789012", "Region": "us-gov-west-1", "RequiresAccountId": true, "UseDualStack": false, "UseFIPS": true } }, { "documentation": "gov region@af-south-1", "expect": { "endpoint": { "headers": { "x-amz-account-id": [ "123456789012" ], "x-amz-outpost-id": [ "op-01234567890123456" ] }, "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "s3-outposts", "signingRegion": "af-south-1", "disableDoubleEncoding": true } ] }, "url": "https://s3-outposts.af-south-1.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "af-south-1" }, "operationName": "GetAccessPoint", "operationParams": { "Name": "arn:aws:s3-outposts:af-south-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", "AccountId": "123456789012" } }, { "builtInParams": { "AWS::Region": "af-south-1" }, "operationName": "DeleteAccessPoint", "operationParams": { "Name": "arn:aws:s3-outposts:af-south-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", "AccountId": "123456789012" } } ], "params": { "AccessPointName": "arn:aws:s3-outposts:af-south-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", "AccountId": "123456789012", "Region": "af-south-1", "RequiresAccountId": true, "UseDualStack": false, "UseFIPS": false } }, { "documentation": "gov cloud with fips@af-south-1", "expect": { "endpoint": { "headers": { "x-amz-account-id": [ "123456789012" ], "x-amz-outpost-id": [ "op-01234567890123456" ] }, "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "s3-outposts", "signingRegion": "af-south-1", "disableDoubleEncoding": true } ] }, "url": "https://s3-outposts-fips.af-south-1.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "af-south-1", "AWS::UseFIPS": true }, "operationName": "GetAccessPoint", "operationParams": { "Name": "arn:aws:s3-outposts:af-south-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", "AccountId": "123456789012" } }, { "builtInParams": { "AWS::Region": "af-south-1", "AWS::UseFIPS": true }, "operationName": "DeleteAccessPoint", "operationParams": { "Name": "arn:aws:s3-outposts:af-south-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", "AccountId": "123456789012" } } ], "params": { "AccessPointName": "arn:aws:s3-outposts:af-south-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", "AccountId": "123456789012", "Region": "af-south-1", "RequiresAccountId": true, "UseDualStack": false, "UseFIPS": true } }, { "documentation": "govcloud with fips + arn region@us-gov-west-1", "expect": { "endpoint": { "headers": { "x-amz-account-id": [ "123456789012" ], "x-amz-outpost-id": [ "op-01234567890123456" ] }, "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "s3-outposts", "signingRegion": "us-gov-east-1", "disableDoubleEncoding": true } ] }, "url": "https://s3-outposts-fips.us-gov-east-1.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-gov-west-1", "AWS::UseFIPS": true }, "operationName": "GetAccessPoint", "operationParams": { "Name": "arn:aws-us-gov:s3-outposts:us-gov-east-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", "AccountId": "123456789012" } }, { "builtInParams": { "AWS::Region": "us-gov-west-1", "AWS::UseFIPS": true }, "operationName": "DeleteAccessPoint", "operationParams": { "Name": "arn:aws-us-gov:s3-outposts:us-gov-east-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", "AccountId": "123456789012" } } ], "params": { "AccessPointName": "arn:aws-us-gov:s3-outposts:us-gov-east-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", "AccountId": "123456789012", "Region": "us-gov-west-1", "RequiresAccountId": true, "UseDualStack": false, "UseFIPS": true } }, { "documentation": "CreateBucket + OutpostId = outposts endpoint@us-east-2", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "s3-outposts", "signingRegion": "us-east-2", "disableDoubleEncoding": true } ] }, "url": "https://s3-outposts.us-east-2.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-east-2" }, "operationName": "CreateBucket", "operationParams": { "Bucket": "blah", "OutpostId": "123" } } ], "params": { "Bucket": "blah", "OutpostId": "123", "Region": "us-east-2", "RequiresAccountId": false, "UseDualStack": false, "UseFIPS": false } }, { "documentation": "CreateBucket + OutpostId with fips = outposts endpoint@us-east-2", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "s3-outposts", "signingRegion": "us-east-2", "disableDoubleEncoding": true } ] }, "url": "https://s3-outposts-fips.us-east-2.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-east-2", "AWS::UseFIPS": true }, "operationName": "CreateBucket", "operationParams": { "Bucket": "blah", "OutpostId": "123" } } ], "params": { "Bucket": "blah", "OutpostId": "123", "Region": "us-east-2", "RequiresAccountId": false, "UseDualStack": false, "UseFIPS": true } }, { "documentation": "CreateBucket without OutpostId = regular endpoint@us-east-2", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "s3", "signingRegion": "us-east-2", "disableDoubleEncoding": true } ] }, "url": "https://s3-control.us-east-2.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-east-2" }, "operationName": "CreateBucket", "operationParams": { "Bucket": "blah" } } ], "params": { "Bucket": "blah", "Region": "us-east-2", "RequiresAccountId": false, "UseDualStack": false, "UseFIPS": false } }, { "documentation": "ListRegionalBuckets + OutpostId = outposts endpoint@us-east-2", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "s3-outposts", "signingRegion": "us-east-2", "disableDoubleEncoding": true } ] }, "url": "https://s3-outposts.us-east-2.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-east-2" }, "operationName": "ListRegionalBuckets", "operationParams": { "AccountId": "123456789012", "OutpostId": "op-123" } } ], "params": { "AccountId": "123456789012", "OutpostId": "op-123", "Region": "us-east-2", "RequiresAccountId": true, "UseDualStack": false, "UseFIPS": false } }, { "documentation": "ListRegionalBuckets without OutpostId = regular endpoint@us-east-2", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "s3", "signingRegion": "us-east-2", "disableDoubleEncoding": true } ] }, "url": "https://123456789012.s3-control.us-east-2.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-east-2" }, "operationName": "ListRegionalBuckets", "operationParams": { "AccountId": "123456789012" } } ], "params": { "AccountId": "123456789012", "Region": "us-east-2", "RequiresAccountId": true, "UseDualStack": false, "UseFIPS": false } }, { "documentation": "ListRegionalBucket + OutpostId with fips = outposts endpoint@us-east-2", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "s3-outposts", "signingRegion": "us-east-2", "disableDoubleEncoding": true } ] }, "url": "https://s3-outposts-fips.us-east-2.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-east-2", "AWS::UseFIPS": true }, "operationName": "ListRegionalBuckets", "operationParams": { "AccountId": "123456789012", "OutpostId": "op-123" } } ], "params": { "AccountId": "123456789012", "OutpostId": "op-123", "Region": "us-east-2", "RequiresAccountId": true, "UseDualStack": false, "UseFIPS": true } }, { "documentation": "outpost access points support dualstack@us-west-2", "expect": { "endpoint": { "headers": { "x-amz-account-id": [ "123456789012" ], "x-amz-outpost-id": [ "op-01234567890123456" ] }, "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "s3-outposts", "signingRegion": "us-west-2", "disableDoubleEncoding": true } ] }, "url": "https://s3-outposts.us-west-2.api.aws" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-west-2", "AWS::UseDualStack": true }, "operationName": "GetAccessPoint", "operationParams": { "Name": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", "AccountId": "123456789012" } }, { "builtInParams": { "AWS::Region": "us-west-2", "AWS::UseDualStack": true }, "operationName": "DeleteAccessPoint", "operationParams": { "Name": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", "AccountId": "123456789012" } } ], "params": { "AccessPointName": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", "AccountId": "123456789012", "Region": "us-west-2", "RequiresAccountId": true, "UseDualStack": true, "UseFIPS": false } }, { "documentation": "outpost access points support dualstack@af-south-1", "expect": { "endpoint": { "headers": { "x-amz-account-id": [ "123456789012" ], "x-amz-outpost-id": [ "op-01234567890123456" ] }, "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "s3-outposts", "signingRegion": "af-south-1", "disableDoubleEncoding": true } ] }, "url": "https://s3-outposts.af-south-1.api.aws" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "af-south-1", "AWS::UseDualStack": true }, "operationName": "GetAccessPoint", "operationParams": { "Name": "arn:aws:s3-outposts:af-south-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", "AccountId": "123456789012" } }, { "builtInParams": { "AWS::Region": "af-south-1", "AWS::UseDualStack": true }, "operationName": "DeleteAccessPoint", "operationParams": { "Name": "arn:aws:s3-outposts:af-south-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", "AccountId": "123456789012" } } ], "params": { "AccessPointName": "arn:aws:s3-outposts:af-south-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", "AccountId": "123456789012", "Region": "af-south-1", "RequiresAccountId": true, "UseDualStack": true, "UseFIPS": false } }, { "documentation": "outpost access points support fips + dualstack@af-south-1", "expect": { "endpoint": { "headers": { "x-amz-account-id": [ "123456789012" ], "x-amz-outpost-id": [ "op-01234567890123456" ] }, "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "s3-outposts", "signingRegion": "af-south-1", "disableDoubleEncoding": true } ] }, "url": "https://s3-outposts-fips.af-south-1.api.aws" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "af-south-1", "AWS::UseFIPS": true, "AWS::UseDualStack": true }, "operationName": "GetAccessPoint", "operationParams": { "Name": "arn:aws:s3-outposts:af-south-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", "AccountId": "123456789012" } }, { "builtInParams": { "AWS::Region": "af-south-1", "AWS::UseFIPS": true, "AWS::UseDualStack": true }, "operationName": "DeleteAccessPoint", "operationParams": { "Name": "arn:aws:s3-outposts:af-south-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", "AccountId": "123456789012" } } ], "params": { "AccessPointName": "arn:aws:s3-outposts:af-south-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", "AccountId": "123456789012", "Region": "af-south-1", "RequiresAccountId": true, "UseDualStack": true, "UseFIPS": true } }, { "documentation": "invalid ARN: must be include outpost ID@us-west-2", "expect": { "error": "Invalid ARN: The Outpost Id was not set" }, "params": { "AccessPointName": "arn:aws:s3-outposts:us-west-2:123456789012:outpost", "AccountId": "123456789012", "Region": "us-west-2", "RequiresAccountId": true, "UseDualStack": false, "UseFIPS": false } }, { "documentation": "invalid ARN: must specify access point@us-west-2", "expect": { "error": "Invalid ARN: Expected a 4-component resource" }, "params": { "AccessPointName": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456", "Region": "us-west-2", "RequiresAccountId": true, "UseDualStack": false, "UseFIPS": false } }, { "documentation": "invalid ARN@us-west-2", "expect": { "error": "Invalid ARN: Expected a 4-component resource" }, "params": { "AccessPointName": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:myaccesspoint", "Region": "us-west-2", "RequiresAccountId": true, "UseDualStack": false, "UseFIPS": false } }, { "documentation": "when set, AccountId drives AP construction@us-west-2", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "s3", "signingRegion": "us-west-2", "disableDoubleEncoding": true } ] }, "url": "https://myid-1234.s3-control.us-west-2.amazonaws.com" } }, "params": { "AccessPointName": "myaccesspoint", "AccountId": "myid-1234", "Region": "us-west-2", "RequiresAccountId": true, "UseDualStack": false, "UseFIPS": false } }, { "documentation": "Account ID set inline and in ARN but they both match@us-west-2", "expect": { "endpoint": { "headers": { "x-amz-account-id": [ "123456789012" ], "x-amz-outpost-id": [ "op-01234567890123456" ] }, "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "s3-outposts", "signingRegion": "us-west-2", "disableDoubleEncoding": true } ] }, "url": "https://s3-outposts.us-west-2.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-west-2", "AWS::S3Control::UseArnRegion": false }, "operationName": "GetAccessPoint", "operationParams": { "AccountId": "123456789012", "Name": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint" } } ], "params": { "AccessPointName": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", "AccountId": "123456789012", "Region": "us-west-2", "RequiresAccountId": true, "UseArnRegion": false, "UseDualStack": false, "UseFIPS": false } }, { "documentation": "Account ID set inline and in ARN and they do not match@us-west-2", "expect": { "error": "Invalid ARN: the accountId specified in the ARN (`123456789012`) does not match the parameter (`999999999999`)" }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-west-2", "AWS::S3Control::UseArnRegion": false }, "operationName": "GetAccessPoint", "operationParams": { "AccountId": "999999999999", "Name": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint" } } ], "params": { "AccessPointName": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", "AccountId": "999999999999", "Region": "us-west-2", "RequiresAccountId": true, "UseArnRegion": false, "UseDualStack": false, "UseFIPS": false } }, { "documentation": "get access point prefixed with account id using endpoint url@us-west-2", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "s3", "signingRegion": "us-west-2", "disableDoubleEncoding": true } ] }, "url": "https://123456789012.control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-west-2", "SDK::Endpoint": "https://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com" }, "operationName": "GetAccessPoint", "operationParams": { "AccountId": "123456789012", "Name": "apname" } } ], "params": { "AccessPointName": "apname", "AccountId": "123456789012", "Endpoint": "https://control.vpce-1a2b3c4d-5e6f.s3.us-west-2.vpce.amazonaws.com", "Region": "us-west-2", "RequiresAccountId": true, "UseDualStack": false, "UseFIPS": false } }, { "documentation": "endpoint url with s3-outposts@us-west-2", "expect": { "endpoint": { "headers": { "x-amz-account-id": [ "123456789012" ], "x-amz-outpost-id": [ "op-01234567890123456" ] }, "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "s3-outposts", "signingRegion": "us-west-2", "disableDoubleEncoding": true } ] }, "url": "https://beta.example.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-west-2", "SDK::Endpoint": "https://beta.example.com" }, "operationName": "GetAccessPoint", "operationParams": { "Name": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", "AccountId": "123456789012" } } ], "params": { "AccessPointName": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", "AccountId": "123456789012", "Endpoint": "https://beta.example.com", "Region": "us-west-2", "RequiresAccountId": true, "UseDualStack": false, "UseFIPS": false } }, { "documentation": "access point name with a bucket arn@us-west-2", "expect": { "error": "Expected an outpost type `accesspoint`, found `bucket`" }, "params": { "AccessPointName": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:bucket:mybucket", "Endpoint": "beta.example.com", "Region": "us-west-2", "RequiresAccountId": true, "UseDualStack": false, "UseFIPS": false } }, { "documentation": "bucket arn with access point name@us-west-2", "expect": { "error": "Invalid ARN: Expected an outpost type `bucket`, found `accesspoint`" }, "params": { "Bucket": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", "Endpoint": "beta.example.com", "Region": "us-west-2", "RequiresAccountId": true, "UseDualStack": false, "UseFIPS": false } }, { "documentation": "create bucket with outposts@us-west-2", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "s3-outposts", "signingRegion": "us-west-2", "disableDoubleEncoding": true } ] }, "url": "https://beta.example.com" } }, "params": { "Bucket": "bucketname", "Endpoint": "https://beta.example.com", "OutpostId": "op-123", "Region": "us-west-2", "RequiresAccountId": false, "UseDualStack": false, "UseFIPS": false } }, { "documentation": "get bucket with endpoint_url@us-west-2", "expect": { "endpoint": { "headers": { "x-amz-account-id": [ "123456789012" ], "x-amz-outpost-id": [ "op-01234567890123456" ] }, "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "s3-outposts", "signingRegion": "us-west-2", "disableDoubleEncoding": true } ] }, "url": "https://beta.example.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-west-2", "SDK::Endpoint": "https://beta.example.com" }, "operationName": "GetBucket", "operationParams": { "Bucket": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:bucket:mybucket", "AccountId": "123456789012" } } ], "params": { "Bucket": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:bucket:mybucket", "Endpoint": "https://beta.example.com", "Region": "us-west-2", "RequiresAccountId": true, "UseDualStack": false, "UseFIPS": false } }, { "documentation": "ListRegionalBucket + OutpostId endpoint url@us-east-2", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "s3-outposts", "signingRegion": "us-east-2", "disableDoubleEncoding": true } ] }, "url": "https://beta.example.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-east-2", "SDK::Endpoint": "https://beta.example.com" }, "operationName": "ListRegionalBuckets", "operationParams": { "AccountId": "123456789012", "OutpostId": "op-123" } } ], "params": { "AccountId": "123456789012", "Endpoint": "https://beta.example.com", "OutpostId": "op-123", "Region": "us-east-2", "RequiresAccountId": true, "UseDualStack": false, "UseFIPS": false } }, { "documentation": "ListRegionalBucket + OutpostId + fips + endpoint url@us-east-2", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "s3-outposts", "signingRegion": "us-east-2", "disableDoubleEncoding": true } ] }, "url": "https://beta.example.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-east-2", "AWS::UseFIPS": true, "SDK::Endpoint": "https://beta.example.com" }, "operationName": "ListRegionalBuckets", "operationParams": { "AccountId": "123456789012", "OutpostId": "op-123" } } ], "params": { "AccountId": "123456789012", "Endpoint": "https://beta.example.com", "OutpostId": "op-123", "Region": "us-east-2", "RequiresAccountId": true, "UseDualStack": false, "UseFIPS": true } }, { "documentation": "ListRegionalBucket + OutpostId + fips + dualstack@us-east-2", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "s3-outposts", "signingRegion": "us-east-2", "disableDoubleEncoding": true } ] }, "url": "https://s3-outposts-fips.us-east-2.api.aws" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-east-2", "AWS::UseFIPS": true, "AWS::UseDualStack": true }, "operationName": "ListRegionalBuckets", "operationParams": { "AccountId": "123456789012", "OutpostId": "op-123" } } ], "params": { "AccountId": "123456789012", "OutpostId": "op-123", "Region": "us-east-2", "RequiresAccountId": true, "UseDualStack": true, "UseFIPS": true } }, { "documentation": "CreateBucket + OutpostId endpoint url@us-east-2", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "s3-outposts", "signingRegion": "us-east-2", "disableDoubleEncoding": true } ] }, "url": "https://beta.example.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-east-2", "AWS::UseFIPS": true, "SDK::Endpoint": "https://beta.example.com" }, "operationName": "CreateBucket", "operationParams": { "Bucket": "blah", "OutpostId": "123" } } ], "params": { "Bucket": "blah", "Endpoint": "https://beta.example.com", "OutpostId": "123", "Region": "us-east-2", "RequiresAccountId": false, "UseDualStack": false, "UseFIPS": true } }, { "documentation": "dualstack cannot be used with outposts when an endpoint URL is set@us-west-2.", "expect": { "error": "Invalid Configuration: DualStack and custom endpoint are not supported" }, "params": { "AccessPointName": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", "Endpoint": "https://s3-outposts.us-west-2.api.aws", "Region": "us-west-2", "RequiresAccountId": true, "UseDualStack": true, "UseFIPS": false } }, { "documentation": "vanilla bucket arn requires account id@us-west-2", "expect": { "endpoint": { "headers": { "x-amz-account-id": [ "123456789012" ], "x-amz-outpost-id": [ "op-01234567890123456" ] }, "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "s3-outposts", "signingRegion": "us-west-2", "disableDoubleEncoding": true } ] }, "url": "https://s3-outposts.us-west-2.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-west-2" }, "operationName": "CreateAccessPoint", "operationParams": { "Bucket": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:bucket:mybucket", "Name": "apname", "AccountId": "123456789012" } } ], "params": { "Bucket": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:bucket:mybucket", "Region": "us-west-2", "RequiresAccountId": true, "UseDualStack": false, "UseFIPS": false } }, { "documentation": "bucket arn with UseArnRegion = true (arn region supercedes client configured region)@us-west-2", "expect": { "endpoint": { "headers": { "x-amz-account-id": [ "123456789012" ], "x-amz-outpost-id": [ "op-01234567890123456" ] }, "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "s3-outposts", "signingRegion": "us-east-1", "disableDoubleEncoding": true } ] }, "url": "https://s3-outposts.us-east-1.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-west-2" }, "operationName": "GetBucket", "operationParams": { "Bucket": "arn:aws:s3-outposts:us-east-1:123456789012:outpost:op-01234567890123456:bucket:mybucket", "AccountId": "123456789012" } } ], "params": { "Bucket": "arn:aws:s3-outposts:us-east-1:123456789012:outpost:op-01234567890123456:bucket:mybucket", "Region": "us-west-2", "RequiresAccountId": true, "UseDualStack": false, "UseFIPS": false } }, { "documentation": "bucket ARN in gov partition (non-fips)@us-gov-east-1", "expect": { "endpoint": { "headers": { "x-amz-account-id": [ "123456789012" ], "x-amz-outpost-id": [ "op-01234567890123456" ] }, "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "s3-outposts", "signingRegion": "us-gov-east-1", "disableDoubleEncoding": true } ] }, "url": "https://s3-outposts.us-gov-east-1.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-gov-east-1" }, "operationName": "GetBucket", "operationParams": { "Bucket": "arn:aws-us-gov:s3-outposts:us-gov-east-1:123456789012:outpost:op-01234567890123456:bucket:mybucket", "AccountId": "123456789012" } } ], "params": { "Bucket": "arn:aws-us-gov:s3-outposts:us-gov-east-1:123456789012:outpost:op-01234567890123456:bucket:mybucket", "Region": "us-gov-east-1", "RequiresAccountId": true, "UseDualStack": false, "UseFIPS": false } }, { "documentation": "bucket ARN in gov partition with FIPS@us-gov-west-1", "expect": { "endpoint": { "headers": { "x-amz-account-id": [ "123456789012" ], "x-amz-outpost-id": [ "op-01234567890123456" ] }, "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "s3-outposts", "signingRegion": "us-gov-west-1", "disableDoubleEncoding": true } ] }, "url": "https://s3-outposts-fips.us-gov-west-1.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-gov-west-1", "AWS::UseFIPS": true }, "operationName": "GetBucket", "operationParams": { "Bucket": "arn:aws-us-gov:s3-outposts:us-gov-west-1:123456789012:outpost:op-01234567890123456:bucket:mybucket", "AccountId": "123456789012" } } ], "params": { "Bucket": "arn:aws-us-gov:s3-outposts:us-gov-west-1:123456789012:outpost:op-01234567890123456:bucket:mybucket", "Region": "us-gov-west-1", "RequiresAccountId": true, "UseDualStack": false, "UseFIPS": true } }, { "documentation": "bucket ARN in aws partition with FIPS@us-east-2", "expect": { "endpoint": { "headers": { "x-amz-account-id": [ "123456789012" ], "x-amz-outpost-id": [ "op-01234567890123456" ] }, "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "s3-outposts", "signingRegion": "us-east-2", "disableDoubleEncoding": true } ] }, "url": "https://s3-outposts-fips.us-east-2.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-east-2", "AWS::UseFIPS": true }, "operationName": "GetBucket", "operationParams": { "Bucket": "arn:aws:s3-outposts:us-east-2:123456789012:outpost:op-01234567890123456:bucket:mybucket", "AccountId": "123456789012" } } ], "params": { "Bucket": "arn:aws:s3-outposts:us-east-2:123456789012:outpost:op-01234567890123456:bucket:mybucket", "Region": "us-east-2", "RequiresAccountId": true, "UseDualStack": false, "UseFIPS": true } }, { "documentation": "bucket ARN in aws partition with fips + dualstack@us-east-2", "expect": { "endpoint": { "headers": { "x-amz-account-id": [ "123456789012" ], "x-amz-outpost-id": [ "op-01234567890123456" ] }, "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "s3-outposts", "signingRegion": "us-east-2", "disableDoubleEncoding": true } ] }, "url": "https://s3-outposts-fips.us-east-2.api.aws" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-east-2", "AWS::UseFIPS": true, "AWS::UseDualStack": true }, "operationName": "GetBucket", "operationParams": { "Bucket": "arn:aws:s3-outposts:us-east-2:123456789012:outpost:op-01234567890123456:bucket:mybucket", "AccountId": "123456789012" } } ], "params": { "Bucket": "arn:aws:s3-outposts:us-east-2:123456789012:outpost:op-01234567890123456:bucket:mybucket", "Region": "us-east-2", "RequiresAccountId": true, "UseDualStack": true, "UseFIPS": true } }, { "documentation": "vanilla bucket arn requires account id@cn-north-1", "expect": { "endpoint": { "headers": { "x-amz-account-id": [ "123456789012" ], "x-amz-outpost-id": [ "op-01234567890123456" ] }, "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "s3-outposts", "signingRegion": "cn-north-1", "disableDoubleEncoding": true } ] }, "url": "https://s3-outposts.cn-north-1.amazonaws.com.cn" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "cn-north-1" }, "operationName": "CreateAccessPoint", "operationParams": { "Bucket": "arn:aws-cn:s3-outposts:cn-north-1:123456789012:outpost:op-01234567890123456:bucket:mybucket", "Name": "apname", "AccountId": "123456789012" } } ], "params": { "Bucket": "arn:aws-cn:s3-outposts:cn-north-1:123456789012:outpost:op-01234567890123456:bucket:mybucket", "Region": "cn-north-1", "RequiresAccountId": true, "UseDualStack": false, "UseFIPS": false } }, { "documentation": "bucket arn with UseArnRegion = true (arn region supercedes client configured region)@us-west-2", "expect": { "endpoint": { "headers": { "x-amz-account-id": [ "123456789012" ], "x-amz-outpost-id": [ "op-01234567890123456" ] }, "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "s3-outposts", "signingRegion": "us-east-1", "disableDoubleEncoding": true } ] }, "url": "https://s3-outposts.us-east-1.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-west-2" }, "operationName": "GetBucket", "operationParams": { "Bucket": "arn:aws:s3-outposts:us-east-1:123456789012:outpost:op-01234567890123456:bucket:mybucket", "AccountId": "123456789012" } } ], "params": { "Bucket": "arn:aws:s3-outposts:us-east-1:123456789012:outpost:op-01234567890123456:bucket:mybucket", "Region": "us-west-2", "RequiresAccountId": true, "UseDualStack": false, "UseFIPS": false } }, { "documentation": "bucket ARN in gov partition (non-fips)@us-gov-east-1", "expect": { "endpoint": { "headers": { "x-amz-account-id": [ "123456789012" ], "x-amz-outpost-id": [ "op-01234567890123456" ] }, "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "s3-outposts", "signingRegion": "us-gov-east-1", "disableDoubleEncoding": true } ] }, "url": "https://s3-outposts.us-gov-east-1.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-gov-east-1" }, "operationName": "GetBucket", "operationParams": { "Bucket": "arn:aws-us-gov:s3-outposts:us-gov-east-1:123456789012:outpost:op-01234567890123456:bucket:mybucket", "AccountId": "123456789012" } } ], "params": { "Bucket": "arn:aws-us-gov:s3-outposts:us-gov-east-1:123456789012:outpost:op-01234567890123456:bucket:mybucket", "Region": "us-gov-east-1", "RequiresAccountId": true, "UseDualStack": false, "UseFIPS": false } }, { "documentation": "bucket ARN in gov partition with FIPS@us-gov-west-1", "expect": { "endpoint": { "headers": { "x-amz-account-id": [ "123456789012" ], "x-amz-outpost-id": [ "op-01234567890123456" ] }, "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "s3-outposts", "signingRegion": "us-gov-west-1", "disableDoubleEncoding": true } ] }, "url": "https://s3-outposts-fips.us-gov-west-1.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-gov-west-1", "AWS::UseFIPS": true }, "operationName": "GetBucket", "operationParams": { "Bucket": "arn:aws-us-gov:s3-outposts:us-gov-west-1:123456789012:outpost:op-01234567890123456:bucket:mybucket", "AccountId": "123456789012" } } ], "params": { "Bucket": "arn:aws-us-gov:s3-outposts:us-gov-west-1:123456789012:outpost:op-01234567890123456:bucket:mybucket", "Region": "us-gov-west-1", "RequiresAccountId": true, "UseDualStack": false, "UseFIPS": true } }, { "documentation": "bucket ARN in aws partition with FIPS@us-east-2", "expect": { "endpoint": { "headers": { "x-amz-account-id": [ "123456789012" ], "x-amz-outpost-id": [ "op-01234567890123456" ] }, "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "s3-outposts", "signingRegion": "us-east-2", "disableDoubleEncoding": true } ] }, "url": "https://s3-outposts-fips.us-east-2.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-east-2", "AWS::UseFIPS": true }, "operationName": "GetBucket", "operationParams": { "Bucket": "arn:aws:s3-outposts:us-east-2:123456789012:outpost:op-01234567890123456:bucket:mybucket", "AccountId": "123456789012" } } ], "params": { "Bucket": "arn:aws:s3-outposts:us-east-2:123456789012:outpost:op-01234567890123456:bucket:mybucket", "Region": "us-east-2", "RequiresAccountId": true, "UseDualStack": false, "UseFIPS": true } }, { "documentation": "Outposts support dualstack @us-west-2", "expect": { "endpoint": { "headers": { "x-amz-account-id": [ "123456789012" ], "x-amz-outpost-id": [ "op-01234567890123456" ] }, "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "s3-outposts", "signingRegion": "us-west-2", "disableDoubleEncoding": true } ] }, "url": "https://s3-outposts.us-west-2.api.aws" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-west-2", "AWS::UseDualStack": true }, "operationName": "GetBucket", "operationParams": { "Bucket": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:bucket:mybucket", "AccountId": "123456789012" } } ], "params": { "Bucket": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:bucket:mybucket", "Region": "us-west-2", "RequiresAccountId": true, "UseDualStack": true, "UseFIPS": false } }, { "documentation": "vanilla bucket arn requires account id@af-south-1", "expect": { "endpoint": { "headers": { "x-amz-account-id": [ "123456789012" ], "x-amz-outpost-id": [ "op-01234567890123456" ] }, "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "s3-outposts", "signingRegion": "af-south-1", "disableDoubleEncoding": true } ] }, "url": "https://s3-outposts.af-south-1.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "af-south-1" }, "operationName": "CreateAccessPoint", "operationParams": { "Bucket": "arn:aws:s3-outposts:af-south-1:123456789012:outpost:op-01234567890123456:bucket:mybucket", "Name": "apname", "AccountId": "123456789012" } } ], "params": { "Bucket": "arn:aws:s3-outposts:af-south-1:123456789012:outpost:op-01234567890123456:bucket:mybucket", "Region": "af-south-1", "RequiresAccountId": true, "UseDualStack": false, "UseFIPS": false } }, { "documentation": "bucket arn with UseArnRegion = true (arn region supercedes client configured region)@us-west-2", "expect": { "endpoint": { "headers": { "x-amz-account-id": [ "123456789012" ], "x-amz-outpost-id": [ "op-01234567890123456" ] }, "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "s3-outposts", "signingRegion": "us-east-1", "disableDoubleEncoding": true } ] }, "url": "https://s3-outposts.us-east-1.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-west-2" }, "operationName": "GetBucket", "operationParams": { "Bucket": "arn:aws:s3-outposts:us-east-1:123456789012:outpost:op-01234567890123456:bucket:mybucket", "AccountId": "123456789012" } } ], "params": { "Bucket": "arn:aws:s3-outposts:us-east-1:123456789012:outpost:op-01234567890123456:bucket:mybucket", "Region": "us-west-2", "RequiresAccountId": true, "UseDualStack": false, "UseFIPS": false } }, { "documentation": "bucket ARN in gov partition (non-fips)@us-gov-east-1", "expect": { "endpoint": { "headers": { "x-amz-account-id": [ "123456789012" ], "x-amz-outpost-id": [ "op-01234567890123456" ] }, "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "s3-outposts", "signingRegion": "us-gov-east-1", "disableDoubleEncoding": true } ] }, "url": "https://s3-outposts.us-gov-east-1.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-gov-east-1" }, "operationName": "GetBucket", "operationParams": { "Bucket": "arn:aws-us-gov:s3-outposts:us-gov-east-1:123456789012:outpost:op-01234567890123456:bucket:mybucket", "AccountId": "123456789012" } } ], "params": { "Bucket": "arn:aws-us-gov:s3-outposts:us-gov-east-1:123456789012:outpost:op-01234567890123456:bucket:mybucket", "Region": "us-gov-east-1", "RequiresAccountId": true, "UseDualStack": false, "UseFIPS": false } }, { "documentation": "bucket ARN in gov partition with FIPS@us-gov-west-1", "expect": { "endpoint": { "headers": { "x-amz-account-id": [ "123456789012" ], "x-amz-outpost-id": [ "op-01234567890123456" ] }, "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "s3-outposts", "signingRegion": "us-gov-west-1", "disableDoubleEncoding": true } ] }, "url": "https://s3-outposts-fips.us-gov-west-1.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-gov-west-1", "AWS::UseFIPS": true }, "operationName": "GetBucket", "operationParams": { "Bucket": "arn:aws-us-gov:s3-outposts:us-gov-west-1:123456789012:outpost:op-01234567890123456:bucket:mybucket", "AccountId": "123456789012" } } ], "params": { "Bucket": "arn:aws-us-gov:s3-outposts:us-gov-west-1:123456789012:outpost:op-01234567890123456:bucket:mybucket", "Region": "us-gov-west-1", "RequiresAccountId": true, "UseDualStack": false, "UseFIPS": true } }, { "documentation": "bucket ARN in aws partition with FIPS@us-east-2", "expect": { "endpoint": { "headers": { "x-amz-account-id": [ "123456789012" ], "x-amz-outpost-id": [ "op-01234567890123456" ] }, "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "s3-outposts", "signingRegion": "us-east-2", "disableDoubleEncoding": true } ] }, "url": "https://s3-outposts-fips.us-east-2.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-east-2", "AWS::UseFIPS": true }, "operationName": "GetBucket", "operationParams": { "Bucket": "arn:aws:s3-outposts:us-east-2:123456789012:outpost:op-01234567890123456:bucket:mybucket", "AccountId": "123456789012" } } ], "params": { "Bucket": "arn:aws:s3-outposts:us-east-2:123456789012:outpost:op-01234567890123456:bucket:mybucket", "Region": "us-east-2", "RequiresAccountId": true, "UseDualStack": false, "UseFIPS": true } }, { "documentation": "Invalid ARN: missing outpost id and bucket@us-west-2", "expect": { "error": "Invalid ARN: The Outpost Id was not set" }, "params": { "Bucket": "arn:aws:s3-outposts:us-west-2:123456789012:outpost", "Region": "us-west-2", "RequiresAccountId": true, "UseDualStack": false, "UseFIPS": false } }, { "documentation": "Invalid ARN: missing bucket@us-west-2", "expect": { "error": "Invalid ARN: Expected a 4-component resource" }, "params": { "Bucket": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456", "Region": "us-west-2", "RequiresAccountId": true, "UseDualStack": false, "UseFIPS": false } }, { "documentation": "Invalid ARN: missing outpost and bucket ids@us-west-2", "expect": { "error": "Invalid ARN: Expected a 4-component resource" }, "params": { "Bucket": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:bucket", "Region": "us-west-2", "RequiresAccountId": true, "UseDualStack": false, "UseFIPS": false } }, { "documentation": "Invalid ARN: missing bucket id@us-west-2", "expect": { "error": "Invalid ARN: expected a bucket name" }, "params": { "Bucket": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:bucket", "Region": "us-west-2", "RequiresAccountId": true, "UseDualStack": false, "UseFIPS": false } }, { "documentation": "account id inserted into hostname@us-west-2", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "s3", "signingRegion": "us-west-2", "disableDoubleEncoding": true } ] }, "url": "https://1234567890.s3-control.us-west-2.amazonaws.com" } }, "params": { "AccountId": "1234567890", "Region": "us-west-2", "RequiresAccountId": true, "UseDualStack": false, "UseFIPS": false } }, { "documentation": "account id prefix with dualstack@us-east-1", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "s3", "signingRegion": "us-east-1", "disableDoubleEncoding": true } ] }, "url": "https://1234567890.s3-control.dualstack.us-east-1.amazonaws.com" } }, "params": { "AccountId": "1234567890", "Region": "us-east-1", "RequiresAccountId": true, "UseDualStack": true, "UseFIPS": false } }, { "documentation": "account id prefix with fips@us-east-1", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "s3", "signingRegion": "us-east-1", "disableDoubleEncoding": true } ] }, "url": "https://1234567890.s3-control-fips.us-east-1.amazonaws.com" } }, "params": { "AccountId": "1234567890", "Region": "us-east-1", "RequiresAccountId": true, "UseDualStack": false, "UseFIPS": true } }, { "documentation": "custom account id prefix with fips@us-east-1", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "s3", "signingRegion": "us-east-1", "disableDoubleEncoding": true } ] }, "url": "https://123456789012.s3-control-fips.us-east-1.amazonaws.com" } }, "params": { "AccountId": "123456789012", "Region": "us-east-1", "RequiresAccountId": true, "UseDualStack": false, "UseFIPS": true } }, { "documentation": "standard url @ us-east-1", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "s3", "signingRegion": "us-east-1", "disableDoubleEncoding": true } ] }, "url": "https://s3-control.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1" } }, { "documentation": "fips url @ us-east-1", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "s3", "signingRegion": "us-east-1", "disableDoubleEncoding": true } ] }, "url": "https://s3-control-fips.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": true } }, { "documentation": "dualstack url @ us-east-1", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "s3", "signingRegion": "us-east-1", "disableDoubleEncoding": true } ] }, "url": "https://s3-control.dualstack.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseDualStack": true } }, { "documentation": "fips,dualstack url @ us-east-1", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "s3", "signingRegion": "us-east-1", "disableDoubleEncoding": true } ] }, "url": "https://s3-control-fips.dualstack.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseDualStack": true, "UseFIPS": true } }, { "documentation": "standard url @ cn-north-1", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "s3", "signingRegion": "cn-north-1", "disableDoubleEncoding": true } ] }, "url": "https://s3-control.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1" } }, { "documentation": "fips @ cn-north-1", "expect": { "error": "Partition does not support FIPS" }, "params": { "Region": "cn-north-1", "UseDualStack": true, "UseFIPS": true } }, { "documentation": "custom account id prefix @us-east-1", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "s3", "signingRegion": "us-east-1", "disableDoubleEncoding": true } ] }, "url": "https://123456789012.s3-control.us-east-1.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-east-1" }, "operationName": "ListRegionalBuckets", "operationParams": { "AccountId": "123456789012" } } ], "params": { "AccountId": "123456789012", "Region": "us-east-1", "RequiresAccountId": true, "UseDualStack": false, "UseFIPS": false } }, { "documentation": "invalid account id prefix @us-east-1", "expect": { "error": "AccountId must only contain a-z, A-Z, 0-9 and `-`." }, "params": { "AccountId": "/?invalid¬-host*label", "Region": "us-east-1", "RequiresAccountId": true, "UseDualStack": false, "UseFIPS": false } }, { "documentation": "custom account id prefix with fips@us-east-1", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "s3", "signingRegion": "us-east-1", "disableDoubleEncoding": true } ] }, "url": "https://123456789012.s3-control-fips.us-east-1.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-east-1", "AWS::UseFIPS": true }, "operationName": "ListRegionalBuckets", "operationParams": { "AccountId": "123456789012" } } ], "params": { "AccountId": "123456789012", "Region": "us-east-1", "RequiresAccountId": true, "UseDualStack": false, "UseFIPS": true } }, { "documentation": "custom account id prefix with dualstack,fips@us-east-1", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "s3", "signingRegion": "us-east-1", "disableDoubleEncoding": true } ] }, "url": "https://123456789012.s3-control-fips.dualstack.us-east-1.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-east-1", "AWS::UseFIPS": true, "AWS::UseDualStack": true }, "operationName": "ListRegionalBuckets", "operationParams": { "AccountId": "123456789012" } } ], "params": { "AccountId": "123456789012", "Region": "us-east-1", "RequiresAccountId": true, "UseDualStack": true, "UseFIPS": true } }, { "documentation": "custom account id with custom endpoint", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "s3", "signingRegion": "us-east-1", "disableDoubleEncoding": true } ] }, "url": "https://123456789012.example.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-east-1", "SDK::Endpoint": "https://example.com" }, "operationName": "ListRegionalBuckets", "operationParams": { "AccountId": "123456789012" } } ], "params": { "AccountId": "123456789012", "Region": "us-east-1", "RequiresAccountId": true, "Endpoint": "https://example.com" } }, { "documentation": "RequiresAccountId with AccountId unset", "expect": { "error": "AccountId is required but not set" }, "params": { "Region": "us-east-1", "RequiresAccountId": true } }, { "documentation": "RequiresAccountId with AccountId unset and custom endpoint", "expect": { "error": "AccountId is required but not set" }, "params": { "Region": "us-east-1", "Endpoint": "https://beta.example.com", "RequiresAccountId": true } }, { "documentation": "RequiresAccountId with invalid AccountId and custom endpoint", "expect": { "error": "AccountId must only contain a-z, A-Z, 0-9 and `-`." }, "params": { "Region": "us-east-1", "Endpoint": "https://beta.example.com", "AccountId": "/?invalid¬-host*label", "RequiresAccountId": true } }, { "documentation": "account id with custom endpoint, fips", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "s3", "signingRegion": "us-east-1", "disableDoubleEncoding": true } ] }, "url": "https://123456789012.example.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-east-1", "AWS::UseFIPS": true, "SDK::Endpoint": "https://example.com" }, "operationName": "ListRegionalBuckets", "operationParams": { "AccountId": "123456789012" } } ], "params": { "AccountId": "123456789012", "Region": "us-east-1", "RequiresAccountId": true, "Endpoint": "https://example.com", "UseFIPS": true } }, { "documentation": "custom endpoint, fips", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "s3", "signingRegion": "us-east-1", "disableDoubleEncoding": true } ] }, "url": "https://example.com" } }, "params": { "Region": "us-east-1", "Endpoint": "https://example.com", "UseFIPS": true } }, { "documentation": "custom endpoint, fips", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "s3", "signingRegion": "us-east-1", "disableDoubleEncoding": true } ] }, "url": "https://example.com" } }, "params": { "Region": "us-east-1", "Endpoint": "https://example.com", "UseFIPS": true } }, { "documentation": "custom endpoint, DualStack", "expect": { "error": "Invalid Configuration: DualStack and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "Endpoint": "https://example.com", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "region not set", "expect": { "error": "Region must be set" } }, { "documentation": "invalid partition", "expect": { "error": "Invalid region: region was not a valid DNS name." }, "params": { "Region": "invalid-region 42" } }, { "documentation": "ListRegionalBuckets + OutpostId without accountId set.", "expect": { "error": "AccountId is required but not set" }, "params": { "OutpostId": "op-123", "Region": "us-east-2", "RequiresAccountId": true, "UseDualStack": false, "UseFIPS": false } }, { "documentation": "ListRegionalBuckets + OutpostId with invalid accountId set.", "expect": { "error": "AccountId must only contain a-z, A-Z, 0-9 and `-`." }, "params": { "AccountId": "/?invalid¬-host*label", "OutpostId": "op-123", "Region": "us-east-2", "RequiresAccountId": true, "UseDualStack": false, "UseFIPS": false } }, { "documentation": "accesspoint set but missing accountId", "expect": { "error": "AccountId is required but not set" }, "params": { "AccessPointName": "myaccesspoint", "Region": "us-west-2", "RequiresAccountId": true, "UseDualStack": false, "UseFIPS": false } }, { "documentation": "outpost accesspoint ARN with missing accountId", "expect": { "error": "Invalid ARN: missing account ID" }, "params": { "AccessPointName": "arn:aws:s3-outposts:us-west-2::outpost:op-01234567890123456:outpost:op1", "Region": "us-west-2", "RequiresAccountId": true, "UseDualStack": false, "UseFIPS": false } }, { "documentation": "bucket ARN with missing accountId", "expect": { "error": "Invalid ARN: missing account ID" }, "params": { "AccessPointName": "arn:aws:s3-outposts:us-west-2::outpost:op-01234567890123456:bucket:mybucket", "Region": "us-west-2", "RequiresAccountId": true, "UseDualStack": false, "UseFIPS": false } }, { "documentation": "endpoint url with accesspoint (non-arn)", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "s3", "signingRegion": "us-west-2", "disableDoubleEncoding": true } ] }, "url": "https://123456789012.beta.example.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-west-2", "SDK::Endpoint": "https://beta.example.com" }, "operationName": "GetAccessPoint", "operationParams": { "Name": "apname", "AccountId": "123456789012" } } ], "params": { "AccessPointName": "apname", "Endpoint": "https://beta.example.com", "AccountId": "123456789012", "Region": "us-west-2", "RequiresAccountId": true, "UseDualStack": false, "UseFIPS": false } }, { "documentation": "access point name with an accesspoint arn@us-west-2", "expect": { "endpoint": { "headers": { "x-amz-account-id": [ "123456789012" ], "x-amz-outpost-id": [ "op-01234567890123456" ] }, "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "s3-outposts", "signingRegion": "us-west-2", "disableDoubleEncoding": true } ] }, "url": "https://beta.example.com" } }, "params": { "AccessPointName": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", "Endpoint": "https://beta.example.com", "Region": "us-west-2", "RequiresAccountId": true, "UseDualStack": false, "UseFIPS": false } }, { "documentation": "DualStack + Custom endpoint is not supported(non-arn)", "expect": { "error": "Invalid Configuration: DualStack and custom endpoint are not supported" }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-west-2", "AWS::UseDualStack": true, "SDK::Endpoint": "https://beta.example.com" }, "operationName": "GetAccessPoint", "operationParams": { "Name": "apname", "AccountId": "123456789012" } } ], "params": { "AccessPointName": "apname", "Endpoint": "https://beta.example.com", "AccountId": "123456789012", "Region": "us-west-2", "RequiresAccountId": true, "UseDualStack": true, "UseFIPS": false } }, { "documentation": "get bucket with custom endpoint and dualstack is not supported@us-west-2", "expect": { "error": "Invalid Configuration: DualStack and custom endpoint are not supported" }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-west-2", "AWS::UseDualStack": true, "SDK::Endpoint": "https://s3-outposts.us-west-2.api.aws" }, "operationName": "GetBucket", "operationParams": { "Bucket": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:bucket:mybucket", "AccountId": "123456789012" } } ], "params": { "Bucket": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:bucket:mybucket", "Endpoint": "https://s3-outposts.us-west-2.api.aws", "Region": "us-west-2", "RequiresAccountId": true, "UseDualStack": true, "UseFIPS": false } }, { "documentation": "ListRegionalBuckets + OutpostId with fips in CN.", "expect": { "error": "Partition does not support FIPS" }, "operationInputs": [ { "builtInParams": { "AWS::Region": "cn-north-1", "AWS::UseFIPS": true }, "operationName": "ListRegionalBuckets", "operationParams": { "OutpostId": "op-123", "AccountId": "012345678912" } } ], "params": { "AccountId": "012345678912", "OutpostId": "op-123", "Region": "cn-north-1", "RequiresAccountId": true, "UseDualStack": false, "UseFIPS": true } }, { "documentation": "ListRegionalBuckets + invalid OutpostId.", "expect": { "error": "OutpostId must only contain a-z, A-Z, 0-9 and `-`." }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-west-1" }, "operationName": "ListRegionalBuckets", "operationParams": { "OutpostId": "?outpost/invalid+", "AccountId": "012345678912" } } ], "params": { "AccountId": "012345678912", "OutpostId": "?outpost/invalid+", "Region": "us-west-1", "RequiresAccountId": true, "UseDualStack": false, "UseFIPS": false } }, { "documentation": "bucket ARN with mismatched accountId", "expect": { "error": "Invalid ARN: the accountId specified in the ARN (`999999`) does not match the parameter (`012345678912`)" }, "params": { "Bucket": "arn:aws:s3-outposts:us-west-2:999999:outpost:op-01234567890123456:bucket:mybucket", "AccountId": "012345678912", "Region": "us-west-2", "RequiresAccountId": true, "UseDualStack": false, "UseFIPS": false } }, { "documentation": "OutpostId with invalid region", "expect": { "error": "Invalid region: region was not a valid DNS name." }, "params": { "OutpostId": "op-123", "Region": "invalid-region 42", "AccountId": "0123456", "RequiresAccountId": true, "UseDualStack": false, "UseFIPS": false } }, { "documentation": "OutpostId with RequireAccountId unset", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "s3-outposts", "signingRegion": "us-west-2", "disableDoubleEncoding": true } ] }, "url": "https://s3-outposts.us-west-2.amazonaws.com" } }, "params": { "OutpostId": "op-123", "Region": "us-west-2", "UseDualStack": false, "UseFIPS": false } }, { "documentation": "Outpost Accesspoint ARN with arn region and client region mismatch with UseArnRegion=false", "expect": { "error": "Invalid configuration: region from ARN `us-east-1` does not match client region `us-west-2` and UseArnRegion is `false`" }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-west-2", "AWS::S3Control::UseArnRegion": false }, "operationName": "GetAccessPoint", "operationParams": { "Name": "arn:aws:s3-outposts:us-east-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", "AccountId": "123456789012" } }, { "builtInParams": { "AWS::Region": "us-west-2", "AWS::S3Control::UseArnRegion": false }, "operationName": "DeleteAccessPoint", "operationParams": { "Name": "arn:aws:s3-outposts:us-east-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", "AccountId": "123456789012" } } ], "params": { "AccessPointName": "arn:aws:s3-outposts:us-east-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", "AccountId": "123456789012", "Region": "us-west-2", "RequiresAccountId": true, "UseArnRegion": false, "UseDualStack": false, "UseFIPS": false } }, { "documentation": "Outpost Bucket ARN with arn region and client region mismatch with UseArnRegion=false", "expect": { "error": "Invalid configuration: region from ARN `us-east-1` does not match client region `us-west-2` and UseArnRegion is `false`" }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-west-2", "SDK::Endpoint": "https://beta.example.com", "AWS::S3Control::UseArnRegion": false }, "operationName": "GetBucket", "operationParams": { "Bucket": "arn:aws:s3-outposts:us-east-1:123456789012:outpost:op-01234567890123456:bucket:mybucket", "AccountId": "123456789012" } } ], "params": { "Bucket": "arn:aws:s3-outposts:us-east-1:123456789012:outpost:op-01234567890123456:bucket:mybucket", "Endpoint": "https://beta.example.com", "Region": "us-west-2", "RequiresAccountId": true, "UseArnRegion": false, "UseDualStack": false, "UseFIPS": false } }, { "documentation": "Accesspoint ARN with region mismatch and UseArnRegion unset", "expect": { "endpoint": { "headers": { "x-amz-account-id": [ "123456789012" ], "x-amz-outpost-id": [ "op-01234567890123456" ] }, "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "s3-outposts", "signingRegion": "us-east-1", "disableDoubleEncoding": true } ] }, "url": "https://s3-outposts.us-east-1.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-west-2" }, "operationName": "GetAccessPoint", "operationParams": { "Name": "arn:aws:s3-outposts:us-east-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", "AccountId": "123456789012" } }, { "builtInParams": { "AWS::Region": "us-west-2" }, "operationName": "DeleteAccessPoint", "operationParams": { "Name": "arn:aws:s3-outposts:us-east-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", "AccountId": "123456789012" } } ], "params": { "AccessPointName": "arn:aws:s3-outposts:us-east-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", "AccountId": "123456789012", "Region": "us-west-2", "RequiresAccountId": true, "UseDualStack": false, "UseFIPS": false } }, { "documentation": "Bucket ARN with region mismatch and UseArnRegion unset", "expect": { "endpoint": { "headers": { "x-amz-account-id": [ "123456789012" ], "x-amz-outpost-id": [ "op-01234567890123456" ] }, "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "s3-outposts", "signingRegion": "us-east-1", "disableDoubleEncoding": true } ] }, "url": "https://s3-outposts.us-east-1.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-west-2" }, "operationName": "GetBucket", "operationParams": { "Bucket": "arn:aws:s3-outposts:us-east-1:123456789012:outpost:op-01234567890123456:bucket:mybucket", "AccountId": "123456789012" } } ], "params": { "Bucket": "arn:aws:s3-outposts:us-east-1:123456789012:outpost:op-01234567890123456:bucket:mybucket", "Region": "us-west-2", "RequiresAccountId": true, "UseDualStack": false, "UseFIPS": false } }, { "documentation": "Outpost Bucket ARN with partition mismatch with UseArnRegion=true", "expect": { "error": "Client was configured for partition `aws` but ARN has `aws-cn`" }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-west-2", "AWS::S3Control::UseArnRegion": true }, "operationName": "GetBucket", "operationParams": { "Bucket": "arn:aws:s3-outposts:cn-north-1:123456789012:outpost:op-01234567890123456:bucket:mybucket", "AccountId": "123456789012" } } ], "params": { "Bucket": "arn:aws:s3-outposts:cn-north-1:123456789012:outpost:op-01234567890123456:bucket:mybucket", "Region": "us-west-2", "RequiresAccountId": true, "UseArnRegion": true, "UseDualStack": false, "UseFIPS": false } }, { "documentation": "Accesspoint ARN with partition mismatch and UseArnRegion=true", "expect": { "error": "Client was configured for partition `aws` but ARN has `aws-cn`" }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-west-2", "AWS::S3Control::UseArnRegion": true }, "operationName": "GetAccessPoint", "operationParams": { "Name": "arn:aws:s3-outposts:cn-north-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", "AccountId": "123456789012" } }, { "builtInParams": { "AWS::Region": "us-west-2", "AWS::S3Control::UseArnRegion": true }, "operationName": "DeleteAccessPoint", "operationParams": { "Name": "arn:aws:s3-outposts:cn-north-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", "AccountId": "123456789012" } } ], "params": { "AccessPointName": "arn:aws:s3-outposts:cn-north-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", "AccountId": "123456789012", "Region": "us-west-2", "RequiresAccountId": true, "UseDualStack": false, "UseArnRegion": true, "UseFIPS": false } }, { "documentation": "Accesspoint ARN with region mismatch, UseArnRegion=false and custom endpoint", "expect": { "error": "Invalid configuration: region from ARN `cn-north-1` does not match client region `us-west-2` and UseArnRegion is `false`" }, "params": { "AccessPointName": "arn:aws:s3-outposts:cn-north-1:123456789012:outpost:op-01234567890123456:accesspoint:myaccesspoint", "Region": "us-west-2", "Endpoint": "https://example.com", "RequiresAccountId": true, "UseDualStack": false, "UseArnRegion": false, "UseFIPS": false } }, { "documentation": "outpost bucket arn@us-west-2", "expect": { "endpoint": { "headers": { "x-amz-account-id": [ "123456789012" ], "x-amz-outpost-id": [ "op-01234567890123456" ] }, "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "s3-outposts", "signingRegion": "us-west-2", "disableDoubleEncoding": true } ] }, "url": "https://s3-outposts.us-west-2.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-west-2" }, "operationName": "GetBucketVersioning", "operationParams": { "Bucket": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:bucket:mybucket", "AccountId": "123456789012" } }, { "builtInParams": { "AWS::Region": "us-west-2" }, "operationName": "PutBucketVersioning", "operationParams": { "Bucket": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:bucket:mybucket", "AccountId": "123456789012", "VersioningConfiguration": { "Status": "Enabled" } } } ], "params": { "Bucket": "arn:aws:s3-outposts:us-west-2:123456789012:outpost:op-01234567890123456:bucket:mybucket", "Region": "us-west-2", "RequiresAccountId": true, "UseDualStack": false, "UseFIPS": false } }, { "documentation": "S3 Snow Control with bucket", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "s3", "signingRegion": "snow", "disableDoubleEncoding": true } ] }, "url": "https://10.0.1.12:433" } }, "params": { "Region": "snow", "Bucket": "bucketName", "Endpoint": "https://10.0.1.12:433", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "S3 Snow Control without bucket", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "s3", "signingRegion": "snow", "disableDoubleEncoding": true } ] }, "url": "https://10.0.1.12:433" } }, "params": { "Region": "snow", "Endpoint": "https://10.0.1.12:433", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "S3 Snow Control with bucket and without port", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "s3", "signingRegion": "snow", "disableDoubleEncoding": true } ] }, "url": "https://10.0.1.12" } }, "params": { "Region": "snow", "Bucket": "bucketName", "Endpoint": "https://10.0.1.12", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "S3 Snow Control with bucket and with DNS", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "s3", "signingRegion": "snow", "disableDoubleEncoding": true } ] }, "url": "http://s3snow.com" } }, "params": { "Region": "snow", "Bucket": "bucketName", "Endpoint": "http://s3snow.com", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "S3 Snow Control with FIPS enabled", "expect": { "error": "S3 Snow does not support FIPS" }, "params": { "Region": "snow", "Bucket": "bucketName", "Endpoint": "https://10.0.1.12:433", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "S3 Snow Control with Dualstack enabled", "expect": { "error": "S3 Snow does not support DualStack" }, "params": { "Region": "snow", "Bucket": "bucketName", "Endpoint": "https://10.0.1.12:433", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "Tagging on express bucket routed to s3express-control", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "s3express", "signingRegion": "us-east-1", "disableDoubleEncoding": true } ] }, "url": "https://s3express-control.us-east-1.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-east-1" }, "operationName": "TagResource", "operationParams": { "ResourceArn": "arn:aws:s3express:us-east-1:871317572157:bucket/crachlintest--use1-az4--x-s3", "AccountId": "871317572157", "Tags": [] } }, { "builtInParams": { "AWS::Region": "us-east-1" }, "operationName": "UntagResource", "operationParams": { "ResourceArn": "arn:aws:s3express:us-east-1:871317572157:bucket/crachlintest--use1-az4--x-s3", "AccountId": "871317572157", "TagKeys": [] } }, { "builtInParams": { "AWS::Region": "us-east-1" }, "operationName": "ListTagsForResource", "operationParams": { "ResourceArn": "arn:aws:s3express:us-east-1:871317572157:bucket/crachlintest--use1-az4--x-s3", "AccountId": "871317572157" } } ], "params": { "ResourceArn": "arn:aws:s3express:us-east-1:871317572157:bucket/crachlintest--use1-az4--x-s3", "AccountId": "871317572157", "Region": "us-east-1", "RequiresAccountId": true, "UseDualStack": false, "UseFIPS": false } }, { "documentation": "Tagging on express ap routed to s3express-control", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "s3express", "signingRegion": "us-east-1", "disableDoubleEncoding": true } ] }, "url": "https://s3express-control.us-east-1.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-east-1" }, "operationName": "TagResource", "operationParams": { "ResourceArn": "arn:aws:s3express:us-east-1:871317572157:accesspoint/crachlintest--use1-az4--xa-s3", "AccountId": "871317572157", "Tags": [] } }, { "builtInParams": { "AWS::Region": "us-east-1" }, "operationName": "UntagResource", "operationParams": { "ResourceArn": "arn:aws:s3express:us-east-1:871317572157:accesspoint/crachlintest--use1-az4--xa-s3", "AccountId": "871317572157", "TagKeys": [] } }, { "builtInParams": { "AWS::Region": "us-east-1" }, "operationName": "ListTagsForResource", "operationParams": { "ResourceArn": "arn:aws:s3express:us-east-1:871317572157:accesspoint/crachlintest--use1-az4--xa-s3", "AccountId": "871317572157" } } ], "params": { "ResourceArn": "arn:aws:s3express:us-east-1:871317572157:accesspoint/crachlintest--use1-az4--xa-s3", "AccountId": "871317572157", "Region": "us-east-1", "RequiresAccountId": true, "UseDualStack": false, "UseFIPS": false } }, { "documentation": "Tagging on express bucket routed to s3express-control FIPS when FIPS enabled", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "s3express", "signingRegion": "us-east-1", "disableDoubleEncoding": true } ] }, "url": "https://s3express-control-fips.us-east-1.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-east-1", "AWS::UseFIPS": true }, "operationName": "TagResource", "operationParams": { "ResourceArn": "arn:aws:s3express:us-east-1:871317572157:bucket/crachlintest--use1-az4--x-s3", "AccountId": "871317572157", "Tags": [] } }, { "builtInParams": { "AWS::Region": "us-east-1", "AWS::UseFIPS": true }, "operationName": "UntagResource", "operationParams": { "ResourceArn": "arn:aws:s3express:us-east-1:871317572157:bucket/crachlintest--use1-az4--x-s3", "AccountId": "871317572157", "TagKeys": [] } }, { "builtInParams": { "AWS::Region": "us-east-1", "AWS::UseFIPS": true }, "operationName": "ListTagsForResource", "operationParams": { "ResourceArn": "arn:aws:s3express:us-east-1:871317572157:bucket/crachlintest--use1-az4--x-s3", "AccountId": "871317572157" } } ], "params": { "ResourceArn": "arn:aws:s3express:us-east-1:871317572157:bucket/crachlintest--use1-az4--x-s3", "AccountId": "871317572157", "Region": "us-east-1", "RequiresAccountId": true, "UseDualStack": false, "UseFIPS": true } }, { "documentation": "Tagging on express bucket cn routed to s3express-control china endpoint", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "s3express", "signingRegion": "cn-north-1", "disableDoubleEncoding": true } ] }, "url": "https://s3express-control.cn-north-1.amazonaws.com.cn" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "cn-north-1" }, "operationName": "TagResource", "operationParams": { "ResourceArn": "arn:aws-cn:s3express:cn-north-1:871317572157:bucket/crachlintest--use1-az4--x-s3", "AccountId": "871317572157", "Tags": [] } }, { "builtInParams": { "AWS::Region": "cn-north-1" }, "operationName": "UntagResource", "operationParams": { "ResourceArn": "arn:aws-cn:s3express:cn-north-1:871317572157:bucket/crachlintest--use1-az4--x-s3", "AccountId": "871317572157", "TagKeys": [] } }, { "builtInParams": { "AWS::Region": "cn-north-1" }, "operationName": "ListTagsForResource", "operationParams": { "ResourceArn": "arn:aws-cn:s3express:cn-north-1:871317572157:bucket/crachlintest--use1-az4--x-s3", "AccountId": "871317572157" } } ], "params": { "ResourceArn": "arn:aws-cn:s3express:cn-north-1:871317572157:bucket/crachlintest--use1-az4--x-s3", "AccountId": "871317572157", "Region": "cn-north-1", "RequiresAccountId": true, "UseDualStack": false, "UseFIPS": false } }, { "documentation": "Tagging on express bucket cn routed to s3express-control china endpoint with FIPS", "expect": { "error": "Partition does not support FIPS" }, "operationInputs": [ { "builtInParams": { "AWS::Region": "cn-north-1", "AWS::UseFIPS": true }, "operationName": "TagResource", "operationParams": { "ResourceArn": "arn:aws-cn:s3express:cn-north-1:871317572157:bucket/crachlintest--use1-az4--x-s3", "AccountId": "871317572157", "Tags": [] } }, { "builtInParams": { "AWS::Region": "cn-north-1", "AWS::UseFIPS": true }, "operationName": "UntagResource", "operationParams": { "ResourceArn": "arn:aws-cn:s3express:cn-north-1:871317572157:bucket/crachlintest--use1-az4--x-s3", "AccountId": "871317572157", "TagKeys": [] } }, { "builtInParams": { "AWS::Region": "cn-north-1", "AWS::UseFIPS": true }, "operationName": "ListTagsForResource", "operationParams": { "ResourceArn": "arn:aws-cn:s3express:cn-north-1:871317572157:bucket/crachlintest--use1-az4--x-s3", "AccountId": "871317572157" } } ], "params": { "ResourceArn": "arn:aws-cn:s3express:cn-north-1:871317572157:bucket/crachlintest--use1-az4--x-s3", "AccountId": "871317572157", "Region": "cn-north-1", "RequiresAccountId": true, "UseDualStack": false, "UseFIPS": true } }, { "documentation": "Tagging on express bucket with custom endpoint routed to custom endpoint", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "s3express", "signingRegion": "us-east-1", "disableDoubleEncoding": true } ] }, "url": "https://my-endpoint.express-control.s3.aws.dev" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-east-1", "SDK::Endpoint": "https://my-endpoint.express-control.s3.aws.dev" }, "operationName": "TagResource", "operationParams": { "ResourceArn": "arn:aws:s3express:us-east-1:871317572157:bucket/crachlintest--use1-az4--x-s3", "AccountId": "871317572157", "Tags": [] } }, { "builtInParams": { "AWS::Region": "us-east-1", "SDK::Endpoint": "https://my-endpoint.express-control.s3.aws.dev" }, "operationName": "UntagResource", "operationParams": { "ResourceArn": "arn:aws:s3express:us-east-1:871317572157:bucket/crachlintest--use1-az4--x-s3", "AccountId": "871317572157", "TagKeys": [] } }, { "builtInParams": { "AWS::Region": "us-east-1", "SDK::Endpoint": "https://my-endpoint.express-control.s3.aws.dev" }, "operationName": "ListTagsForResource", "operationParams": { "ResourceArn": "arn:aws:s3express:us-east-1:871317572157:bucket/crachlintest--use1-az4--x-s3", "AccountId": "871317572157" } } ], "params": { "ResourceArn": "arn:aws:s3express:us-east-1:871317572157:bucket/crachlintest--use1-az4--x-s3", "Endpoint": "https://my-endpoint.express-control.s3.aws.dev", "AccountId": "871317572157", "Region": "us-east-1", "RequiresAccountId": true, "UseDualStack": false, "UseFIPS": false } }, { "documentation": "Tagging on express access point with custom endpoint routed to custom endpoint", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "s3express", "signingRegion": "us-east-1", "disableDoubleEncoding": true } ] }, "url": "https://my-endpoint.express-control.s3.aws.dev" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-east-1", "SDK::Endpoint": "https://my-endpoint.express-control.s3.aws.dev" }, "operationName": "TagResource", "operationParams": { "ResourceArn": "arn:aws:s3express:us-east-1:871317572157:accesspoint/crachlintest--use1-az4--xa-s3", "AccountId": "871317572157", "Tags": [] } }, { "builtInParams": { "AWS::Region": "us-east-1", "SDK::Endpoint": "https://my-endpoint.express-control.s3.aws.dev" }, "operationName": "UntagResource", "operationParams": { "ResourceArn": "arn:aws:s3express:us-east-1:871317572157:accesspoint/crachlintest--use1-az4--xa-s3", "AccountId": "871317572157", "TagKeys": [] } }, { "builtInParams": { "AWS::Region": "us-east-1", "SDK::Endpoint": "https://my-endpoint.express-control.s3.aws.dev" }, "operationName": "ListTagsForResource", "operationParams": { "ResourceArn": "arn:aws:s3express:us-east-1:871317572157:accesspoint/crachlintest--use1-az4--xa-s3", "AccountId": "871317572157" } } ], "params": { "ResourceArn": "arn:aws:s3express:us-east-1:871317572157:accesspoint/crachlintest--use1-az4--xa-s3", "Endpoint": "https://my-endpoint.express-control.s3.aws.dev", "AccountId": "871317572157", "Region": "us-east-1", "RequiresAccountId": true, "UseDualStack": false, "UseFIPS": false } }, { "documentation": "Tagging on express bucket with dualstack and custom endpoint fails", "expect": { "error": "Invalid Configuration: DualStack and custom endpoint are not supported" }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-east-1", "SDK::Endpoint": "https://my-endpoint.express-control.s3.aws.dev", "AWS::UseDualStack": true }, "operationName": "TagResource", "operationParams": { "ResourceArn": "arn:aws:s3express:us-east-1:871317572157:bucket/crachlintest--use1-az4--x-s3", "AccountId": "871317572157", "Tags": [] } }, { "builtInParams": { "AWS::Region": "us-east-1", "SDK::Endpoint": "https://my-endpoint.express-control.s3.aws.dev", "AWS::UseDualStack": true }, "operationName": "UntagResource", "operationParams": { "ResourceArn": "arn:aws:s3express:us-east-1:871317572157:bucket/crachlintest--use1-az4--x-s3", "AccountId": "871317572157", "TagKeys": [] } }, { "builtInParams": { "AWS::Region": "us-east-1", "SDK::Endpoint": "https://my-endpoint.express-control.s3.aws.dev", "AWS::UseDualStack": true }, "operationName": "ListTagsForResource", "operationParams": { "ResourceArn": "arn:aws:s3express:us-east-1:871317572157:bucket/crachlintest--use1-az4--x-s3", "AccountId": "871317572157" } } ], "params": { "ResourceArn": "arn:aws:s3express:us-east-1:871317572157:bucket/crachlintest--use1-az4--x-s3", "Endpoint": "https://my-endpoint.express-control.s3.aws.dev", "AccountId": "871317572157", "Region": "us-east-1", "RequiresAccountId": true, "UseDualStack": true, "UseFIPS": false } }, { "documentation": "Access Point APIs on express bucket routed to s3express-control", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "s3express", "signingRegion": "us-east-1", "disableDoubleEncoding": true } ] }, "url": "https://s3express-control.us-east-1.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-east-1" }, "operationName": "CreateAccessPoint", "operationParams": { "Name": "myaccesspoint--abcd-ab1--xa-s3", "Bucket": "mybucket--abcd-ab1--x-s3", "AccountId": "871317572157", "Scope": { "Prefixes": [], "Permissions": [] } } }, { "builtInParams": { "AWS::Region": "us-east-1" }, "operationName": "GetAccessPoint", "operationParams": { "Name": "myaccesspoint--abcd-ab1--xa-s3", "AccountId": "871317572157" } }, { "builtInParams": { "AWS::Region": "us-east-1" }, "operationName": "DeleteAccessPoint", "operationParams": { "Name": "myaccesspoint--abcd-ab1--xa-s3", "AccountId": "871317572157" } }, { "builtInParams": { "AWS::Region": "us-east-1" }, "operationName": "PutAccessPointScope", "operationParams": { "Name": "myaccesspoint--abcd-ab1--xa-s3", "AccountId": "871317572157", "Scope": { "Prefixes": [], "Permissions": [] } } }, { "builtInParams": { "AWS::Region": "us-east-1" }, "operationName": "GetAccessPointScope", "operationParams": { "Name": "myaccesspoint--abcd-ab1--xa-s3", "AccountId": "871317572157" } }, { "builtInParams": { "AWS::Region": "us-east-1" }, "operationName": "DeleteAccessPointScope", "operationParams": { "Name": "myaccesspoint--abcd-ab1--xa-s3", "AccountId": "871317572157" } }, { "builtInParams": { "AWS::Region": "us-east-1" }, "operationName": "PutAccessPointPolicy", "operationParams": { "Name": "myaccesspoint--abcd-ab1--xa-s3", "AccountId": "871317572157", "Policy": "my-policy" } }, { "builtInParams": { "AWS::Region": "us-east-1" }, "operationName": "GetAccessPointPolicy", "operationParams": { "Name": "myaccesspoint--abcd-ab1--xa-s3", "AccountId": "871317572157" } }, { "builtInParams": { "AWS::Region": "us-east-1" }, "operationName": "DeleteAccessPointPolicy", "operationParams": { "Name": "myaccesspoint--abcd-ab1--xa-s3", "AccountId": "871317572157" } }, { "builtInParams": { "AWS::Region": "us-east-1" }, "operationName": "GetAccessPointPolicyStatus", "operationParams": { "Name": "myaccesspoint--abcd-ab1--xa-s3", "AccountId": "871317572157" } } ], "params": { "AccountId": "871317572157", "AccessPointName": "myaccesspoint--abcd-ab1--xa-s3", "Region": "us-east-1", "RequiresAccountId": true, "UseDualStack": false, "UseFIPS": false } }, { "documentation": "Access Point APIs on express bucket routed to s3express-control for List", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "s3express", "signingRegion": "us-east-1", "disableDoubleEncoding": true } ] }, "url": "https://s3express-control.us-east-1.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-east-1" }, "operationName": "ListAccessPointsForDirectoryBuckets", "operationParams": { "DirectoryBucket": "mybucket--abcd-ab1--x-s3", "AccountId": "871317572157" } } ], "params": { "AccountId": "871317572157", "Region": "us-east-1", "UseS3ExpressControlEndpoint": true, "RequiresAccountId": true, "UseDualStack": false, "UseFIPS": false } }, { "documentation": "Access Point APIs on express bucket routed to s3express-control for FIPS", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "s3express", "signingRegion": "us-east-1", "disableDoubleEncoding": true } ] }, "url": "https://s3express-control-fips.us-east-1.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-east-1", "AWS::UseFIPS": true }, "operationName": "CreateAccessPoint", "operationParams": { "Name": "myaccesspoint--abcd-ab1--xa-s3", "Bucket": "mybucket--abcd-ab1--x-s3", "AccountId": "871317572157", "Scope": { "Prefixes": [], "Permissions": [] } } }, { "builtInParams": { "AWS::Region": "us-east-1", "AWS::UseFIPS": true }, "operationName": "GetAccessPoint", "operationParams": { "Name": "myaccesspoint--abcd-ab1--xa-s3", "AccountId": "871317572157" } }, { "builtInParams": { "AWS::Region": "us-east-1", "AWS::UseFIPS": true }, "operationName": "DeleteAccessPoint", "operationParams": { "Name": "myaccesspoint--abcd-ab1--xa-s3", "AccountId": "871317572157" } }, { "builtInParams": { "AWS::Region": "us-east-1", "AWS::UseFIPS": true }, "operationName": "PutAccessPointScope", "operationParams": { "Name": "myaccesspoint--abcd-ab1--xa-s3", "AccountId": "871317572157", "Scope": { "Prefixes": [], "Permissions": [] } } }, { "builtInParams": { "AWS::Region": "us-east-1", "AWS::UseFIPS": true }, "operationName": "GetAccessPointScope", "operationParams": { "Name": "myaccesspoint--abcd-ab1--xa-s3", "AccountId": "871317572157" } }, { "builtInParams": { "AWS::Region": "us-east-1", "AWS::UseFIPS": true }, "operationName": "DeleteAccessPointScope", "operationParams": { "Name": "myaccesspoint--abcd-ab1--xa-s3", "AccountId": "871317572157" } }, { "builtInParams": { "AWS::Region": "us-east-1", "AWS::UseFIPS": true }, "operationName": "PutAccessPointPolicy", "operationParams": { "Name": "myaccesspoint--abcd-ab1--xa-s3", "AccountId": "871317572157", "Policy": "my-policy" } }, { "builtInParams": { "AWS::Region": "us-east-1", "AWS::UseFIPS": true }, "operationName": "GetAccessPointPolicy", "operationParams": { "Name": "myaccesspoint--abcd-ab1--xa-s3", "AccountId": "871317572157" } }, { "builtInParams": { "AWS::Region": "us-east-1", "AWS::UseFIPS": true }, "operationName": "DeleteAccessPointPolicy", "operationParams": { "Name": "myaccesspoint--abcd-ab1--xa-s3", "AccountId": "871317572157" } }, { "builtInParams": { "AWS::Region": "us-east-1", "AWS::UseFIPS": true }, "operationName": "GetAccessPointPolicyStatus", "operationParams": { "Name": "myaccesspoint--abcd-ab1--xa-s3", "AccountId": "871317572157" } } ], "params": { "AccountId": "871317572157", "AccessPointName": "myaccesspoint--abcd-ab1--xa-s3", "Region": "us-east-1", "RequiresAccountId": true, "UseDualStack": false, "UseFIPS": true } }, { "documentation": "Access Point APIs on express bucket routed to s3express-control for FIPS for List", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "s3express", "signingRegion": "us-east-1", "disableDoubleEncoding": true } ] }, "url": "https://s3express-control-fips.us-east-1.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-east-1", "AWS::UseFIPS": true }, "operationName": "ListAccessPointsForDirectoryBuckets", "operationParams": { "DirectoryBucket": "mybucket--abcd-ab1--x-s3", "AccountId": "871317572157" } } ], "params": { "AccountId": "871317572157", "Region": "us-east-1", "UseS3ExpressControlEndpoint": true, "RequiresAccountId": true, "UseDualStack": false, "UseFIPS": true } }, { "documentation": "Access Point APIs on express bucket routed to s3express-control for china region", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "s3express", "signingRegion": "cn-north-1", "disableDoubleEncoding": true } ] }, "url": "https://s3express-control.cn-north-1.amazonaws.com.cn" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "cn-north-1" }, "operationName": "CreateAccessPoint", "operationParams": { "Name": "myaccesspoint--abcd-ab1--xa-s3", "Bucket": "mybucket--abcd-ab1--x-s3", "AccountId": "871317572157", "Scope": { "Prefixes": [], "Permissions": [] } } }, { "builtInParams": { "AWS::Region": "cn-north-1" }, "operationName": "GetAccessPoint", "operationParams": { "Name": "myaccesspoint--abcd-ab1--xa-s3", "AccountId": "871317572157" } }, { "builtInParams": { "AWS::Region": "cn-north-1" }, "operationName": "DeleteAccessPoint", "operationParams": { "Name": "myaccesspoint--abcd-ab1--xa-s3", "AccountId": "871317572157" } }, { "builtInParams": { "AWS::Region": "cn-north-1" }, "operationName": "PutAccessPointScope", "operationParams": { "Name": "myaccesspoint--abcd-ab1--xa-s3", "AccountId": "871317572157", "Scope": { "Prefixes": [], "Permissions": [] } } }, { "builtInParams": { "AWS::Region": "cn-north-1" }, "operationName": "GetAccessPointScope", "operationParams": { "Name": "myaccesspoint--abcd-ab1--xa-s3", "AccountId": "871317572157" } }, { "builtInParams": { "AWS::Region": "cn-north-1" }, "operationName": "DeleteAccessPointScope", "operationParams": { "Name": "myaccesspoint--abcd-ab1--xa-s3", "AccountId": "871317572157" } }, { "builtInParams": { "AWS::Region": "cn-north-1" }, "operationName": "PutAccessPointPolicy", "operationParams": { "Name": "myaccesspoint--abcd-ab1--xa-s3", "AccountId": "871317572157", "Policy": "my-policy" } }, { "builtInParams": { "AWS::Region": "cn-north-1" }, "operationName": "GetAccessPointPolicy", "operationParams": { "Name": "myaccesspoint--abcd-ab1--xa-s3", "AccountId": "871317572157" } }, { "builtInParams": { "AWS::Region": "cn-north-1" }, "operationName": "DeleteAccessPointPolicy", "operationParams": { "Name": "myaccesspoint--abcd-ab1--xa-s3", "AccountId": "871317572157" } }, { "builtInParams": { "AWS::Region": "cn-north-1" }, "operationName": "GetAccessPointPolicyStatus", "operationParams": { "Name": "myaccesspoint--abcd-ab1--xa-s3", "AccountId": "871317572157" } } ], "params": { "AccessPointName": "myaccesspoint--abcd-ab1--xa-s3", "AccountId": "871317572157", "Region": "cn-north-1", "RequiresAccountId": true, "UseDualStack": false, "UseFIPS": false } }, { "documentation": "Access Point APIs on express bucket routed to s3express-control for china region for List", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "s3express", "signingRegion": "cn-north-1", "disableDoubleEncoding": true } ] }, "url": "https://s3express-control.cn-north-1.amazonaws.com.cn" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "cn-north-1" }, "operationName": "ListAccessPointsForDirectoryBuckets", "operationParams": { "DirectoryBucket": "mybucket--abcd-ab1--x-s3", "AccountId": "871317572157" } } ], "params": { "AccountId": "871317572157", "Region": "cn-north-1", "UseS3ExpressControlEndpoint": true, "RequiresAccountId": true, "UseDualStack": false, "UseFIPS": false } }, { "documentation": "Error when Access Point APIs on express bucket routed to s3express-control for china and FIPS", "expect": { "error": "Partition does not support FIPS" }, "operationInputs": [ { "builtInParams": { "AWS::Region": "cn-north-1", "AWS::UseFIPS": true }, "operationName": "CreateAccessPoint", "operationParams": { "Name": "myaccesspoint--abcd-ab1--xa-s3", "Bucket": "mybucket--abcd-ab1--x-s3", "AccountId": "871317572157", "Scope": { "Prefixes": [], "Permissions": [] } } }, { "builtInParams": { "AWS::Region": "cn-north-1", "AWS::UseFIPS": true }, "operationName": "GetAccessPoint", "operationParams": { "Name": "myaccesspoint--abcd-ab1--xa-s3", "AccountId": "871317572157" } }, { "builtInParams": { "AWS::Region": "cn-north-1", "AWS::UseFIPS": true }, "operationName": "DeleteAccessPoint", "operationParams": { "Name": "myaccesspoint--abcd-ab1--xa-s3", "AccountId": "871317572157" } }, { "builtInParams": { "AWS::Region": "cn-north-1", "AWS::UseFIPS": true }, "operationName": "ListAccessPointsForDirectoryBuckets", "operationParams": { "DirectoryBucket": "mybucket--abcd-ab1--x-s3", "AccountId": "871317572157" } }, { "builtInParams": { "AWS::Region": "cn-north-1", "AWS::UseFIPS": true }, "operationName": "PutAccessPointScope", "operationParams": { "Name": "myaccesspoint--abcd-ab1--xa-s3", "AccountId": "871317572157", "Scope": { "Prefixes": [], "Permissions": [] } } }, { "builtInParams": { "AWS::Region": "cn-north-1", "AWS::UseFIPS": true }, "operationName": "GetAccessPointScope", "operationParams": { "Name": "myaccesspoint--abcd-ab1--xa-s3", "AccountId": "871317572157" } }, { "builtInParams": { "AWS::Region": "cn-north-1", "AWS::UseFIPS": true }, "operationName": "DeleteAccessPointScope", "operationParams": { "Name": "myaccesspoint--abcd-ab1--xa-s3", "AccountId": "871317572157" } }, { "builtInParams": { "AWS::Region": "cn-north-1", "AWS::UseFIPS": true }, "operationName": "PutAccessPointPolicy", "operationParams": { "Name": "myaccesspoint--abcd-ab1--xa-s3", "AccountId": "871317572157", "Policy": "my-policy" } }, { "builtInParams": { "AWS::Region": "cn-north-1", "AWS::UseFIPS": true }, "operationName": "GetAccessPointPolicy", "operationParams": { "Name": "myaccesspoint--abcd-ab1--xa-s3", "AccountId": "871317572157" } }, { "builtInParams": { "AWS::Region": "cn-north-1", "AWS::UseFIPS": true }, "operationName": "DeleteAccessPointPolicy", "operationParams": { "Name": "myaccesspoint--abcd-ab1--xa-s3", "AccountId": "871317572157" } }, { "builtInParams": { "AWS::Region": "cn-north-1", "AWS::UseFIPS": true }, "operationName": "GetAccessPointPolicyStatus", "operationParams": { "Name": "myaccesspoint--abcd-ab1--xa-s3", "AccountId": "871317572157" } } ], "params": { "AccountId": "871317572157", "Region": "cn-north-1", "RequiresAccountId": true, "UseDualStack": false, "UseFIPS": true } }, { "documentation": "Error Access Point APIs on express bucket routed to s3express-control invalid zone", "expect": { "error": "Unrecognized S3Express Access Point name format." }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-east-1" }, "operationName": "CreateAccessPoint", "operationParams": { "Name": "myaccesspoint-garbage-zone--xa-s3", "Bucket": "mybucket-garbage-zone-garbage-zone", "AccountId": "871317572157", "Scope": { "Prefixes": [], "Permissions": [] } } }, { "builtInParams": { "AWS::Region": "us-east-1" }, "operationName": "GetAccessPoint", "operationParams": { "Name": "myaccesspoint-garbage-zone--xa-s3", "AccountId": "871317572157" } }, { "builtInParams": { "AWS::Region": "us-east-1" }, "operationName": "DeleteAccessPoint", "operationParams": { "Name": "myaccesspoint-garbage-zone--xa-s3", "AccountId": "871317572157" } }, { "builtInParams": { "AWS::Region": "us-east-1" }, "operationName": "PutAccessPointScope", "operationParams": { "Name": "myaccesspoint-garbage-zone--xa-s3", "AccountId": "871317572157", "Scope": { "Prefixes": [], "Permissions": [] } } }, { "builtInParams": { "AWS::Region": "us-east-1" }, "operationName": "GetAccessPointScope", "operationParams": { "Name": "myaccesspoint-garbage-zone--xa-s3", "AccountId": "871317572157" } }, { "builtInParams": { "AWS::Region": "us-east-1" }, "operationName": "DeleteAccessPointScope", "operationParams": { "Name": "myaccesspoint-garbage-zone--xa-s3", "AccountId": "871317572157" } }, { "builtInParams": { "AWS::Region": "us-east-1" }, "operationName": "PutAccessPointPolicy", "operationParams": { "Name": "myaccesspoint-garbage-zone--xa-s3", "AccountId": "871317572157", "Policy": "my-policy" } }, { "builtInParams": { "AWS::Region": "us-east-1" }, "operationName": "GetAccessPointPolicy", "operationParams": { "Name": "myaccesspoint-garbage-zone--xa-s3", "AccountId": "871317572157" } }, { "builtInParams": { "AWS::Region": "us-east-1" }, "operationName": "DeleteAccessPointPolicy", "operationParams": { "Name": "myaccesspoint-garbage-zone--xa-s3", "AccountId": "871317572157" } }, { "builtInParams": { "AWS::Region": "us-east-1" }, "operationName": "GetAccessPointPolicyStatus", "operationParams": { "Name": "myaccesspoint-garbage-zone--xa-s3", "AccountId": "871317572157" } } ], "params": { "AccessPointName": "myaccesspoint-garbage-zone--xa-s3", "AccountId": "871317572157", "Region": "us-east-1", "RequiresAccountId": true, "UseDualStack": false, "UseFIPS": false } }, { "documentation": "Access Point APIs on express bucket routed to custom endpoint if provided", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "s3express", "signingRegion": "us-east-1", "disableDoubleEncoding": true } ] }, "url": "https://my-endpoint.express-control.s3.aws.dev" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-east-1", "SDK::Endpoint": "https://my-endpoint.express-control.s3.aws.dev" }, "operationName": "CreateAccessPoint", "operationParams": { "Name": "myaccesspoint--abcd-ab1--xa-s3", "Bucket": "mybucket--abcd-ab1--x-s3", "AccountId": "871317572157", "Scope": { "Prefixes": [], "Permissions": [] } } }, { "builtInParams": { "AWS::Region": "us-east-1", "SDK::Endpoint": "https://my-endpoint.express-control.s3.aws.dev" }, "operationName": "GetAccessPoint", "operationParams": { "Name": "myaccesspoint--abcd-ab1--xa-s3", "AccountId": "871317572157" } }, { "builtInParams": { "AWS::Region": "us-east-1", "SDK::Endpoint": "https://my-endpoint.express-control.s3.aws.dev" }, "operationName": "DeleteAccessPoint", "operationParams": { "Name": "myaccesspoint--abcd-ab1--xa-s3", "AccountId": "871317572157" } }, { "builtInParams": { "AWS::Region": "us-east-1", "SDK::Endpoint": "https://my-endpoint.express-control.s3.aws.dev" }, "operationName": "PutAccessPointPolicy", "operationParams": { "Name": "myaccesspoint--abcd-ab1--xa-s3", "AccountId": "871317572157", "Policy": "my-policy" } }, { "builtInParams": { "AWS::Region": "us-east-1", "SDK::Endpoint": "https://my-endpoint.express-control.s3.aws.dev" }, "operationName": "GetAccessPointPolicy", "operationParams": { "Name": "myaccesspoint--abcd-ab1--xa-s3", "AccountId": "871317572157" } }, { "builtInParams": { "AWS::Region": "us-east-1", "SDK::Endpoint": "https://my-endpoint.express-control.s3.aws.dev" }, "operationName": "DeleteAccessPointPolicy", "operationParams": { "Name": "myaccesspoint--abcd-ab1--xa-s3", "AccountId": "871317572157" } }, { "builtInParams": { "AWS::Region": "us-east-1", "SDK::Endpoint": "https://my-endpoint.express-control.s3.aws.dev" }, "operationName": "GetAccessPointPolicyStatus", "operationParams": { "Name": "myaccesspoint--abcd-ab1--xa-s3", "AccountId": "871317572157" } } ], "params": { "AccountId": "871317572157", "AccessPointName": "myaccesspoint--abcd-ab1--xa-s3", "Endpoint": "https://my-endpoint.express-control.s3.aws.dev", "Region": "us-east-1", "RequiresAccountId": true, "UseDualStack": false, "UseFIPS": false } }, { "documentation": "Access Point APIs on express bucket routed to custom endpoint if provided for List", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "s3express", "signingRegion": "us-east-1", "disableDoubleEncoding": true } ] }, "url": "https://my-endpoint.express-control.s3.aws.dev" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-east-1", "SDK::Endpoint": "https://my-endpoint.express-control.s3.aws.dev" }, "operationName": "ListAccessPointsForDirectoryBuckets", "operationParams": { "DirectoryBucket": "mybucket--abcd-ab1--x-s3", "AccountId": "871317572157" } } ], "params": { "AccountId": "871317572157", "Region": "us-east-1", "UseS3ExpressControlEndpoint": true, "Endpoint": "https://my-endpoint.express-control.s3.aws.dev", "RequiresAccountId": true, "UseDualStack": false, "UseFIPS": false } }, { "documentation": "Error on Access Point APIs on express bucket for dual stack", "expect": { "error": "S3Express does not support Dual-stack." }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-east-1", "AWS::UseDualStack": true }, "operationName": "CreateAccessPoint", "operationParams": { "Name": "myaccesspoint--abcd-ab1--xa-s3", "Bucket": "mybucket--abcd-ab1--x-s3", "AccountId": "871317572157", "Scope": { "Prefixes": [], "Permissions": [] } } }, { "builtInParams": { "AWS::Region": "us-east-1", "AWS::UseDualStack": true }, "operationName": "GetAccessPoint", "operationParams": { "Name": "myaccesspoint--abcd-ab1--xa-s3", "AccountId": "871317572157" } }, { "builtInParams": { "AWS::Region": "us-east-1", "AWS::UseDualStack": true }, "operationName": "DeleteAccessPoint", "operationParams": { "Name": "myaccesspoint--abcd-ab1--xa-s3", "AccountId": "871317572157" } }, { "builtInParams": { "AWS::Region": "us-east-1", "AWS::UseDualStack": true }, "operationName": "PutAccessPointPolicy", "operationParams": { "Name": "myaccesspoint--abcd-ab1--xa-s3", "AccountId": "871317572157", "Policy": "my-policy" } }, { "builtInParams": { "AWS::Region": "us-east-1", "AWS::UseDualStack": true }, "operationName": "GetAccessPointPolicy", "operationParams": { "Name": "myaccesspoint--abcd-ab1--xa-s3", "AccountId": "871317572157" } }, { "builtInParams": { "AWS::Region": "us-east-1", "AWS::UseDualStack": true }, "operationName": "DeleteAccessPointPolicy", "operationParams": { "Name": "myaccesspoint--abcd-ab1--xa-s3", "AccountId": "871317572157" } }, { "builtInParams": { "AWS::Region": "us-east-1", "AWS::UseDualStack": true }, "operationName": "GetAccessPointPolicyStatus", "operationParams": { "Name": "myaccesspoint--abcd-ab1--xa-s3", "AccountId": "871317572157" } } ], "params": { "AccountId": "871317572157", "AccessPointName": "myaccesspoint--abcd-ab1--xa-s3", "Region": "us-east-1", "RequiresAccountId": true, "UseDualStack": true, "UseFIPS": false } }, { "documentation": "Error Access Point APIs on express bucket for dual stack for List", "expect": { "error": "S3Express does not support Dual-stack." }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-east-1", "AWS::UseDualStack": true }, "operationName": "ListAccessPointsForDirectoryBuckets", "operationParams": { "DirectoryBucket": "mybucket--abcd-ab1--x-s3", "AccountId": "871317572157" } } ], "params": { "AccountId": "871317572157", "Region": "us-east-1", "UseS3ExpressControlEndpoint": true, "RequiresAccountId": true, "UseDualStack": true, "UseFIPS": false } }, { "documentation": "Error on Access Point APIs on express bucket for custom endpoint and dual stack", "expect": { "error": "Invalid Configuration: DualStack and custom endpoint are not supported" }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-east-1", "SDK::Endpoint": "https://my-endpoint.express-control.s3.aws.dev", "AWS::UseDualStack": true }, "operationName": "CreateAccessPoint", "operationParams": { "Name": "myaccesspoint--abcd-ab1--xa-s3", "Bucket": "mybucket--abcd-ab1--x-s3", "AccountId": "871317572157", "Scope": { "Prefixes": [], "Permissions": [] } } }, { "builtInParams": { "AWS::Region": "us-east-1", "SDK::Endpoint": "https://my-endpoint.express-control.s3.aws.dev", "AWS::UseDualStack": true }, "operationName": "GetAccessPoint", "operationParams": { "Name": "myaccesspoint--abcd-ab1--xa-s3", "AccountId": "871317572157" } }, { "builtInParams": { "AWS::Region": "us-east-1", "SDK::Endpoint": "https://my-endpoint.express-control.s3.aws.dev", "AWS::UseDualStack": true }, "operationName": "DeleteAccessPoint", "operationParams": { "Name": "myaccesspoint--abcd-ab1--xa-s3", "AccountId": "871317572157" } }, { "builtInParams": { "AWS::Region": "us-east-1", "SDK::Endpoint": "https://my-endpoint.express-control.s3.aws.dev", "AWS::UseDualStack": true }, "operationName": "PutAccessPointPolicy", "operationParams": { "Name": "myaccesspoint--abcd-ab1--xa-s3", "AccountId": "871317572157", "Policy": "my-policy" } }, { "builtInParams": { "AWS::Region": "us-east-1", "SDK::Endpoint": "https://my-endpoint.express-control.s3.aws.dev", "AWS::UseDualStack": true }, "operationName": "GetAccessPointPolicy", "operationParams": { "Name": "myaccesspoint--abcd-ab1--xa-s3", "AccountId": "871317572157" } }, { "builtInParams": { "AWS::Region": "us-east-1", "SDK::Endpoint": "https://my-endpoint.express-control.s3.aws.dev", "AWS::UseDualStack": true }, "operationName": "DeleteAccessPointPolicy", "operationParams": { "Name": "myaccesspoint--abcd-ab1--xa-s3", "AccountId": "871317572157" } }, { "builtInParams": { "AWS::Region": "us-east-1", "SDK::Endpoint": "https://my-endpoint.express-control.s3.aws.dev", "AWS::UseDualStack": true }, "operationName": "GetAccessPointPolicyStatus", "operationParams": { "Name": "myaccesspoint--abcd-ab1--xa-s3", "AccountId": "871317572157" } } ], "params": { "AccountId": "871317572157", "AccessPointName": "myaccesspoint--abcd-ab1--xa-s3", "Endpoint": "https://my-endpoint.express-control.s3.aws.dev", "Region": "us-east-1", "RequiresAccountId": true, "UseDualStack": true, "UseFIPS": false } }, { "documentation": "Error Access Point APIs on express bucket for custom endpoint and dual stack for List", "expect": { "error": "Invalid Configuration: DualStack and custom endpoint are not supported" }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-east-1", "SDK::Endpoint": "https://my-endpoint.express-control.s3.aws.dev", "AWS::UseDualStack": true }, "operationName": "ListAccessPointsForDirectoryBuckets", "operationParams": { "DirectoryBucket": "mybucket--abcd-ab1--x-s3", "AccountId": "871317572157" } } ], "params": { "AccountId": "871317572157", "Region": "us-east-1", "UseS3ExpressControlEndpoint": true, "Endpoint": "https://my-endpoint.express-control.s3.aws.dev", "RequiresAccountId": true, "UseDualStack": true, "UseFIPS": false } } ], "version": "1.0" } } }, "com.amazonaws.s3control#AbortIncompleteMultipartUpload": { "type": "structure", "members": { "DaysAfterInitiation": { "target": "com.amazonaws.s3control#DaysAfterInitiation", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "Specifies the number of days after which Amazon S3 aborts an incomplete multipart upload to\n the Outposts bucket.
" } } }, "traits": { "smithy.api#documentation": "The container for abort incomplete multipart upload
" } }, "com.amazonaws.s3control#AccessControlTranslation": { "type": "structure", "members": { "Owner": { "target": "com.amazonaws.s3control#OwnerOverride", "traits": { "smithy.api#documentation": "Specifies the replica ownership.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A container for information about access control for replicas.
\nThis is not supported by Amazon S3 on Outposts buckets.
\nThe S3SubPrefix is appended to the location scope creating the grant scope. Use this field to narrow the scope of the grant to a subset of the location scope. This field is required if the location scope is the default location s3:// because you cannot create a grant for all of your S3 data in the Region and must narrow the scope. For example, if the location scope is the default location s3://, the S3SubPrefx can be a s3://. Or the S3SubPrefx can be , so the full grant scope path would be or s3://.
If the S3SubPrefix includes a prefix, append the wildcard character * after the prefix to indicate that you want to include all object key names in the bucket that start with that prefix.
The configuration options of the S3 Access Grants location. It contains the S3SubPrefix field. The grant scope, the data to which you are granting access, is the result of appending the Subprefix field to the scope of the registered location.
The name of this access point.
", "smithy.api#required": {} } }, "NetworkOrigin": { "target": "com.amazonaws.s3control#NetworkOrigin", "traits": { "smithy.api#documentation": "Indicates whether this access point allows access from the public internet. If\n VpcConfiguration is specified for this access point, then\n NetworkOrigin is VPC, and the access point doesn't allow access from\n the public internet. Otherwise, NetworkOrigin is Internet, and\n the access point allows access from the public internet, subject to the access point and bucket access\n policies.
The virtual private cloud (VPC) configuration for this access point, if one exists.
\nThis element is empty if this access point is an Amazon S3 on Outposts access point that is used by other\n Amazon Web Services services.
\nThe name of the bucket associated with this access point.
", "smithy.api#required": {} } }, "AccessPointArn": { "target": "com.amazonaws.s3control#S3AccessPointArn", "traits": { "smithy.api#documentation": "The ARN for the access point.
" } }, "Alias": { "target": "com.amazonaws.s3control#Alias", "traits": { "smithy.api#documentation": "The name or alias of the access point.
" } }, "BucketAccountId": { "target": "com.amazonaws.s3control#AccountId", "traits": { "smithy.api#documentation": "The Amazon Web Services account ID associated with the S3 bucket associated with this access point.
" } }, "DataSourceId": { "target": "com.amazonaws.s3control#DataSourceId", "traits": { "smithy.api#documentation": "A unique identifier for the data source of the access point.
" } }, "DataSourceType": { "target": "com.amazonaws.s3control#DataSourceType", "traits": { "smithy.api#documentation": "The type of the data source that the access point is attached to.
" } } }, "traits": { "smithy.api#documentation": "An access point used to access a bucket.
" } }, "com.amazonaws.s3control#AccessPointBucketName": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 255 } } }, "com.amazonaws.s3control#AccessPointList": { "type": "list", "member": { "target": "com.amazonaws.s3control#AccessPoint", "traits": { "smithy.api#xmlName": "AccessPoint" } } }, "com.amazonaws.s3control#AccessPointName": { "type": "string", "traits": { "smithy.api#length": { "min": 3, "max": 255 } } }, "com.amazonaws.s3control#AccountId": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 64 }, "smithy.api#pattern": "^\\d{12}$" } }, "com.amazonaws.s3control#AccountLevel": { "type": "structure", "members": { "ActivityMetrics": { "target": "com.amazonaws.s3control#ActivityMetrics", "traits": { "smithy.api#documentation": "A container element for S3 Storage Lens activity metrics.
" } }, "BucketLevel": { "target": "com.amazonaws.s3control#BucketLevel", "traits": { "smithy.api#documentation": "A container element for the S3 Storage Lens bucket-level configuration.
", "smithy.api#required": {} } }, "AdvancedCostOptimizationMetrics": { "target": "com.amazonaws.s3control#AdvancedCostOptimizationMetrics", "traits": { "smithy.api#documentation": "A container element for S3 Storage Lens advanced cost-optimization metrics.
" } }, "AdvancedDataProtectionMetrics": { "target": "com.amazonaws.s3control#AdvancedDataProtectionMetrics", "traits": { "smithy.api#documentation": "A container element for S3 Storage Lens advanced data-protection metrics.
" } }, "DetailedStatusCodesMetrics": { "target": "com.amazonaws.s3control#DetailedStatusCodesMetrics", "traits": { "smithy.api#documentation": "A container element for detailed status code metrics.
" } }, "AdvancedPerformanceMetrics": { "target": "com.amazonaws.s3control#AdvancedPerformanceMetrics", "traits": { "smithy.api#documentation": "A container element for S3 Storage Lens advanced performance metrics.
" } }, "StorageLensGroupLevel": { "target": "com.amazonaws.s3control#StorageLensGroupLevel", "traits": { "smithy.api#documentation": "\nA container element for S3 Storage Lens groups metrics.\n
" } } }, "traits": { "smithy.api#documentation": "A container element for the account-level Amazon S3 Storage Lens configuration.
\nYou must enable Storage Lens metrics consistently at both the account level and bucket level, or your request will fail.
\nFor more information about S3 Storage Lens, see Assessing your storage activity and usage with S3 Storage Lens in the Amazon S3 User Guide. For a complete list of S3 Storage Lens metrics, see S3 Storage Lens metrics glossary in the Amazon S3 User Guide.
" } }, "com.amazonaws.s3control#ActivityMetrics": { "type": "structure", "members": { "IsEnabled": { "target": "com.amazonaws.s3control#IsEnabled", "traits": { "smithy.api#default": false, "smithy.api#documentation": "A container that indicates whether activity metrics are enabled.
" } } }, "traits": { "smithy.api#documentation": "The container element for Amazon S3 Storage Lens activity metrics. Activity metrics show details\n about how your storage is requested, such as requests (for example, All requests, Get\n requests, Put requests), bytes uploaded or downloaded, and errors.
\nFor more information about S3 Storage Lens, see Assessing your storage activity and usage with S3 Storage Lens in the Amazon S3 User Guide. For a complete list of S3 Storage Lens metrics, see S3 Storage Lens metrics glossary in the Amazon S3 User Guide.
" } }, "com.amazonaws.s3control#AdvancedCostOptimizationMetrics": { "type": "structure", "members": { "IsEnabled": { "target": "com.amazonaws.s3control#IsEnabled", "traits": { "smithy.api#default": false, "smithy.api#documentation": "A container that indicates whether advanced cost-optimization metrics are\n enabled.
" } } }, "traits": { "smithy.api#documentation": "The container element for Amazon S3 Storage Lens advanced cost-optimization metrics. Advanced\n cost-optimization metrics provide insights that you can use to manage and optimize your\n storage costs, for example, lifecycle rule counts for transitions, expirations, and\n incomplete multipart uploads.
\nFor more information about S3 Storage Lens, see Assessing your storage activity and usage with S3 Storage Lens in the Amazon S3 User Guide. For a complete list of S3 Storage Lens metrics, see S3 Storage Lens metrics glossary in the Amazon S3 User Guide.
" } }, "com.amazonaws.s3control#AdvancedDataProtectionMetrics": { "type": "structure", "members": { "IsEnabled": { "target": "com.amazonaws.s3control#IsEnabled", "traits": { "smithy.api#default": false, "smithy.api#documentation": "A container that indicates whether advanced data-protection metrics are enabled.
" } } }, "traits": { "smithy.api#documentation": "The container element for Amazon S3 Storage Lens advanced data-protection metrics. Advanced\n data-protection metrics provide insights that you can use to perform audits and protect\n your data, for example replication rule counts within and across Regions.
\nFor more information about S3 Storage Lens, see Assessing your storage activity and usage with S3 Storage Lens in the Amazon S3 User Guide. For a complete list of S3 Storage Lens metrics, see S3 Storage Lens metrics glossary in the Amazon S3 User Guide.
" } }, "com.amazonaws.s3control#AdvancedPerformanceMetrics": { "type": "structure", "members": { "IsEnabled": { "target": "com.amazonaws.s3control#IsEnabled", "traits": { "smithy.api#default": false, "smithy.api#documentation": "A container that indicates whether S3 Storage Lens advanced performance metrics are enabled.
" } } }, "traits": { "smithy.api#documentation": "The container element for S3 Storage Lens advanced performance metrics. Advanced\n performance metrics provide insights into application performance, such as request\n efficiency and access patterns. These metrics help you optimize your\n S3 storage for both cost and performance by providing detailed analytics on how your\n applications interact with S3 resources.
\nFor more information about S3 Storage Lens, see Assessing your storage activity and usage with S3 Storage Lens in the Amazon S3 User Guide. For a complete list of S3 Storage Lens metrics, see S3 Storage Lens metrics glossary in the Amazon S3 User Guide.
" } }, "com.amazonaws.s3control#Alias": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 63 }, "smithy.api#pattern": "^[0-9a-z\\\\-]{63}$" } }, "com.amazonaws.s3control#AssociateAccessGrantsIdentityCenter": { "type": "operation", "input": { "target": "com.amazonaws.s3control#AssociateAccessGrantsIdentityCenterRequest" }, "output": { "target": "smithy.api#Unit" }, "traits": { "smithy.api#documentation": "Associate your S3 Access Grants instance with an Amazon Web Services IAM Identity Center instance. Use this action if you want to create access grants for users or groups from your corporate identity directory. First, you must add your corporate identity directory to Amazon Web Services IAM Identity Center. Then, you can associate this IAM Identity Center instance with your S3 Access Grants instance.
\nYou must have the s3:AssociateAccessGrantsIdentityCenter permission to use this operation.
You must also have the following permissions: sso:CreateApplication, sso:PutApplicationGrant, and sso:PutApplicationAuthenticationMethod.
The Amazon Web Services account ID of the S3 Access Grants instance.
", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "AccountId" } } }, "IdentityCenterArn": { "target": "com.amazonaws.s3control#IdentityCenterArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Web Services IAM Identity Center instance that you are associating with your S3 Access Grants instance. An IAM Identity Center instance is your corporate identity directory that you added to the IAM Identity Center. You can use the ListInstances API operation to retrieve a list of your Identity Center instances and their ARNs.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.s3control#AsyncCreationTimestamp": { "type": "timestamp" }, "com.amazonaws.s3control#AsyncErrorDetails": { "type": "structure", "members": { "Code": { "target": "com.amazonaws.s3control#MaxLength1024String", "traits": { "smithy.api#documentation": "A string that uniquely identifies the error condition.
" } }, "Message": { "target": "com.amazonaws.s3control#MaxLength1024String", "traits": { "smithy.api#documentation": "A generic description of the error condition in English.
" } }, "Resource": { "target": "com.amazonaws.s3control#MaxLength1024String", "traits": { "smithy.api#documentation": "The identifier of the resource associated with the error.
" } }, "RequestId": { "target": "com.amazonaws.s3control#MaxLength1024String", "traits": { "smithy.api#documentation": "The ID of the request associated with the error.
" } } }, "traits": { "smithy.api#documentation": "Error details for the failed asynchronous operation.
" } }, "com.amazonaws.s3control#AsyncOperation": { "type": "structure", "members": { "CreationTime": { "target": "com.amazonaws.s3control#AsyncCreationTimestamp", "traits": { "smithy.api#documentation": "The time that the request was sent to the service.
" } }, "Operation": { "target": "com.amazonaws.s3control#AsyncOperationName", "traits": { "smithy.api#documentation": "The specific operation for the asynchronous request.
" } }, "RequestTokenARN": { "target": "com.amazonaws.s3control#AsyncRequestTokenARN", "traits": { "smithy.api#documentation": "The request token associated with the request.
" } }, "RequestParameters": { "target": "com.amazonaws.s3control#AsyncRequestParameters", "traits": { "smithy.api#documentation": "The parameters associated with the request.
" } }, "RequestStatus": { "target": "com.amazonaws.s3control#AsyncRequestStatus", "traits": { "smithy.api#documentation": "The current status of the request.
" } }, "ResponseDetails": { "target": "com.amazonaws.s3control#AsyncResponseDetails", "traits": { "smithy.api#documentation": "The details of the response.
" } } }, "traits": { "smithy.api#documentation": "A container for the information about an asynchronous operation.
" } }, "com.amazonaws.s3control#AsyncOperationName": { "type": "enum", "members": { "CreateMultiRegionAccessPoint": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CreateMultiRegionAccessPoint" } }, "DeleteMultiRegionAccessPoint": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DeleteMultiRegionAccessPoint" } }, "PutMultiRegionAccessPointPolicy": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PutMultiRegionAccessPointPolicy" } } } }, "com.amazonaws.s3control#AsyncRequestParameters": { "type": "structure", "members": { "CreateMultiRegionAccessPointRequest": { "target": "com.amazonaws.s3control#CreateMultiRegionAccessPointInput", "traits": { "smithy.api#documentation": "A container of the parameters for a CreateMultiRegionAccessPoint request.
" } }, "DeleteMultiRegionAccessPointRequest": { "target": "com.amazonaws.s3control#DeleteMultiRegionAccessPointInput", "traits": { "smithy.api#documentation": "A container of the parameters for a DeleteMultiRegionAccessPoint request.
" } }, "PutMultiRegionAccessPointPolicyRequest": { "target": "com.amazonaws.s3control#PutMultiRegionAccessPointPolicyInput", "traits": { "smithy.api#documentation": "A container of the parameters for a PutMultiRegionAccessPoint request.
" } } }, "traits": { "smithy.api#documentation": "A container for the request parameters associated with an asynchronous request.
" } }, "com.amazonaws.s3control#AsyncRequestStatus": { "type": "string" }, "com.amazonaws.s3control#AsyncRequestTokenARN": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1024 }, "smithy.api#pattern": "^arn:.+$" } }, "com.amazonaws.s3control#AsyncResponseDetails": { "type": "structure", "members": { "MultiRegionAccessPointDetails": { "target": "com.amazonaws.s3control#MultiRegionAccessPointsAsyncResponse", "traits": { "smithy.api#documentation": "The details for the Multi-Region Access Point.
" } }, "ErrorDetails": { "target": "com.amazonaws.s3control#AsyncErrorDetails", "traits": { "smithy.api#documentation": "Error details for an asynchronous request.
" } } }, "traits": { "smithy.api#documentation": "A container for the response details that are returned when querying about an\n asynchronous request.
" } }, "com.amazonaws.s3control#AuditContext": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2048 }, "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*$" } }, "com.amazonaws.s3control#AwsLambdaTransformation": { "type": "structure", "members": { "FunctionArn": { "target": "com.amazonaws.s3control#FunctionArnString", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Lambda function.
", "smithy.api#required": {} } }, "FunctionPayload": { "target": "com.amazonaws.s3control#AwsLambdaTransformationPayload", "traits": { "smithy.api#documentation": "Additional JSON that provides supplemental data to the Lambda function used to transform\n objects.
" } } }, "traits": { "smithy.api#documentation": "Lambda function used to transform objects through an Object Lambda Access Point.
" } }, "com.amazonaws.s3control#AwsLambdaTransformationPayload": { "type": "string" }, "com.amazonaws.s3control#AwsOrgArn": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1024 }, "smithy.api#pattern": "^arn:[a-z\\-]+:organizations::\\d{12}:organization\\/o-[a-z0-9]{10,32}$" } }, "com.amazonaws.s3control#BadRequestException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.s3control#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "", "smithy.api#error": "client" } }, "com.amazonaws.s3control#Boolean": { "type": "boolean", "traits": { "smithy.api#default": false } }, "com.amazonaws.s3control#BucketAlreadyExists": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "The requested Outposts bucket name is not available. The bucket namespace is shared by\n all users of the Outposts in this Region. Select a different name and try\n again.
", "smithy.api#error": "client" } }, "com.amazonaws.s3control#BucketAlreadyOwnedByYou": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "The Outposts bucket you tried to create already exists, and you own it.
", "smithy.api#error": "client" } }, "com.amazonaws.s3control#BucketCannedACL": { "type": "enum", "members": { "private": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "private" } }, "public_read": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "public-read" } }, "public_read_write": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "public-read-write" } }, "authenticated_read": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "authenticated-read" } } } }, "com.amazonaws.s3control#BucketIdentifierString": { "type": "string" }, "com.amazonaws.s3control#BucketLevel": { "type": "structure", "members": { "ActivityMetrics": { "target": "com.amazonaws.s3control#ActivityMetrics", "traits": { "smithy.api#documentation": "A container for the bucket-level activity metrics for S3 Storage Lens.
" } }, "PrefixLevel": { "target": "com.amazonaws.s3control#PrefixLevel", "traits": { "smithy.api#documentation": "A container for the prefix-level metrics for S3 Storage Lens.
" } }, "AdvancedCostOptimizationMetrics": { "target": "com.amazonaws.s3control#AdvancedCostOptimizationMetrics", "traits": { "smithy.api#documentation": "A container for bucket-level advanced cost-optimization metrics for S3 Storage Lens.
" } }, "AdvancedDataProtectionMetrics": { "target": "com.amazonaws.s3control#AdvancedDataProtectionMetrics", "traits": { "smithy.api#documentation": "A container for bucket-level advanced data-protection metrics for S3 Storage Lens.
" } }, "DetailedStatusCodesMetrics": { "target": "com.amazonaws.s3control#DetailedStatusCodesMetrics", "traits": { "smithy.api#documentation": "A container for bucket-level detailed status code metrics for S3 Storage Lens.
" } }, "AdvancedPerformanceMetrics": { "target": "com.amazonaws.s3control#AdvancedPerformanceMetrics", "traits": { "smithy.api#documentation": "A container for bucket-level advanced performance metrics for S3 Storage Lens.
" } } }, "traits": { "smithy.api#documentation": "A container for the bucket-level configuration for Amazon S3 Storage Lens.
\nFor more information about S3 Storage Lens, see Assessing your storage activity and usage with S3 Storage Lens in the Amazon S3 User Guide.
" } }, "com.amazonaws.s3control#BucketLocationConstraint": { "type": "enum", "members": { "EU": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EU" } }, "eu_west_1": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "eu-west-1" } }, "us_west_1": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "us-west-1" } }, "us_west_2": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "us-west-2" } }, "ap_south_1": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ap-south-1" } }, "ap_southeast_1": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ap-southeast-1" } }, "ap_southeast_2": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ap-southeast-2" } }, "ap_northeast_1": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ap-northeast-1" } }, "sa_east_1": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "sa-east-1" } }, "cn_north_1": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "cn-north-1" } }, "eu_central_1": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "eu-central-1" } } } }, "com.amazonaws.s3control#BucketName": { "type": "string", "traits": { "smithy.api#length": { "min": 3, "max": 255 } } }, "com.amazonaws.s3control#BucketVersioningStatus": { "type": "enum", "members": { "Enabled": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Enabled" } }, "Suspended": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Suspended" } } } }, "com.amazonaws.s3control#Buckets": { "type": "list", "member": { "target": "com.amazonaws.s3control#S3BucketArnString", "traits": { "smithy.api#xmlName": "Arn" } } }, "com.amazonaws.s3control#CallerAccessGrantsList": { "type": "list", "member": { "target": "com.amazonaws.s3control#ListCallerAccessGrantsEntry", "traits": { "smithy.api#xmlName": "AccessGrant" } } }, "com.amazonaws.s3control#CloudWatchMetrics": { "type": "structure", "members": { "IsEnabled": { "target": "com.amazonaws.s3control#IsEnabled", "traits": { "smithy.api#default": false, "smithy.api#documentation": "A container that indicates whether CloudWatch publishing for S3 Storage Lens metrics is enabled. A\n value of true indicates that CloudWatch publishing for S3 Storage Lens metrics is\n enabled.
A container for enabling Amazon CloudWatch publishing for S3 Storage Lens metrics.
\nFor more information about publishing S3 Storage Lens metrics to CloudWatch, see Monitor\n S3 Storage Lens metrics in CloudWatch in the Amazon S3 User Guide.
" } }, "com.amazonaws.s3control#ComputeObjectChecksumAlgorithm": { "type": "enum", "members": { "CRC32": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CRC32" } }, "CRC32C": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CRC32C" } }, "CRC64NVME": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CRC64NVME" } }, "MD5": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MD5" } }, "SHA1": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SHA1" } }, "SHA256": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SHA256" } }, "SHA512": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SHA512" } }, "XXHASH64": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "XXHASH64" } }, "XXHASH3": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "XXHASH3" } }, "XXHASH128": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "XXHASH128" } } } }, "com.amazonaws.s3control#ComputeObjectChecksumType": { "type": "enum", "members": { "FULL_OBJECT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FULL_OBJECT" } }, "COMPOSITE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "COMPOSITE" } } } }, "com.amazonaws.s3control#ConfigId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^[a-zA-Z0-9\\-\\_]+$" } }, "com.amazonaws.s3control#ConfirmRemoveSelfBucketAccess": { "type": "boolean", "traits": { "smithy.api#default": false } }, "com.amazonaws.s3control#ConfirmationRequired": { "type": "boolean", "traits": { "smithy.api#default": false } }, "com.amazonaws.s3control#ContinuationToken": { "type": "string" }, "com.amazonaws.s3control#CreateAccessGrant": { "type": "operation", "input": { "target": "com.amazonaws.s3control#CreateAccessGrantRequest" }, "output": { "target": "com.amazonaws.s3control#CreateAccessGrantResult" }, "traits": { "smithy.api#documentation": "Creates an access grant that gives a grantee access to your S3 data. The grantee can be an IAM user or role or a directory user, or group. Before you can create a grant, you must have an S3 Access Grants instance in the same Region as the S3 data. You can create an S3 Access Grants instance using the CreateAccessGrantsInstance. You must also have registered at least one S3 data location in your S3 Access Grants instance using CreateAccessGrantsLocation.
\nYou must have the s3:CreateAccessGrant permission to use this operation.
For any directory identity - sso:DescribeInstance and sso:DescribeApplication\n
For directory users - identitystore:DescribeUser\n
For directory groups - identitystore:DescribeGroup\n
The Amazon Web Services account ID of the S3 Access Grants instance.
", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "AccountId" } } }, "AccessGrantsLocationId": { "target": "com.amazonaws.s3control#AccessGrantsLocationId", "traits": { "smithy.api#documentation": "The ID of the registered location to which you are granting access. S3 Access Grants assigns this ID when you register the location. S3 Access Grants assigns the ID default to the default location s3:// and assigns an auto-generated ID to other locations that you register.
If you are passing the default location, you cannot create an access grant for the entire default location. You must also specify a bucket or a bucket and prefix in the Subprefix field.
The configuration options of the grant location. The grant location is the S3 path to the data to which you are granting access. It contains the S3SubPrefix field. The grant scope is the result of appending the subprefix to the location scope of the registered location.
The user, group, or role to which you are granting access. You can grant access to an IAM user or role. If you have added your corporate directory to Amazon Web Services IAM Identity Center and associated your Identity Center instance with your S3 Access Grants instance, the grantee can also be a corporate directory user or group.
", "smithy.api#required": {} } }, "Permission": { "target": "com.amazonaws.s3control#Permission", "traits": { "smithy.api#documentation": "The type of access that you are granting to your S3 data, which can be set to one of the following values:
\n\n READ \u2013 Grant read-only access to the S3 data.
\n WRITE \u2013 Grant write-only access to the S3 data.
\n READWRITE \u2013 Grant both read and write access to the S3 data.
The Amazon Resource Name (ARN) of an Amazon Web Services IAM Identity Center application associated with your Identity Center instance. If an application ARN is included in the request to create an access grant, the grantee can only access the S3 data through this application.
" } }, "S3PrefixType": { "target": "com.amazonaws.s3control#S3PrefixType", "traits": { "smithy.api#documentation": "The type of S3SubPrefix. The only possible value is Object. Pass this value if the access grant scope is an object. Do not pass this value if the access grant scope is a bucket or a bucket and a prefix.
The Amazon Web Services resource tags that you are adding to the access grant. Each tag is a label consisting of a user-defined key and value. Tags can help you manage, identify, organize, search for, and filter resources.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.s3control#CreateAccessGrantResult": { "type": "structure", "members": { "CreatedAt": { "target": "com.amazonaws.s3control#CreationTimestamp", "traits": { "smithy.api#documentation": "The date and time when you created the access grant.
" } }, "AccessGrantId": { "target": "com.amazonaws.s3control#AccessGrantId", "traits": { "smithy.api#documentation": "The ID of the access grant. S3 Access Grants auto-generates this ID when you create the access grant.
" } }, "AccessGrantArn": { "target": "com.amazonaws.s3control#AccessGrantArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the access grant.
" } }, "Grantee": { "target": "com.amazonaws.s3control#Grantee", "traits": { "smithy.api#documentation": "The user, group, or role to which you are granting access. You can grant access to an IAM user or role. If you have added your corporate directory to Amazon Web Services IAM Identity Center and associated your Identity Center instance with your S3 Access Grants instance, the grantee can also be a corporate directory user or group.
" } }, "AccessGrantsLocationId": { "target": "com.amazonaws.s3control#AccessGrantsLocationId", "traits": { "smithy.api#documentation": "The ID of the registered location to which you are granting access. S3 Access Grants assigns this ID when you register the location. S3 Access Grants assigns the ID default to the default location s3:// and assigns an auto-generated ID to other locations that you register.
The configuration options of the grant location. The grant location is the S3 path to the data to which you are granting access.
" } }, "Permission": { "target": "com.amazonaws.s3control#Permission", "traits": { "smithy.api#documentation": "The type of access that you are granting to your S3 data, which can be set to one of the following values:
\n\n READ \u2013 Grant read-only access to the S3 data.
\n WRITE \u2013 Grant write-only access to the S3 data.
\n READWRITE \u2013 Grant both read and write access to the S3 data.
The Amazon Resource Name (ARN) of an Amazon Web Services IAM Identity Center application associated with your Identity Center instance. If the grant includes an application ARN, the grantee can only access the S3 data through this application.
" } }, "GrantScope": { "target": "com.amazonaws.s3control#S3Prefix", "traits": { "smithy.api#documentation": "The S3 path of the data to which you are granting access. It is the result of appending the Subprefix to the location scope.
Creates an S3 Access Grants instance, which serves as a logical grouping for access grants. You can create one S3 Access Grants instance per Region per account.
\nYou must have the s3:CreateAccessGrantsInstance permission to use this operation.
To associate an IAM Identity Center instance with your S3 Access Grants instance, you must also have the sso:DescribeInstance, sso:CreateApplication, sso:PutApplicationGrant, and sso:PutApplicationAuthenticationMethod permissions.
The Amazon Web Services account ID of the S3 Access Grants instance.
", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "AccountId" } } }, "IdentityCenterArn": { "target": "com.amazonaws.s3control#IdentityCenterArn", "traits": { "smithy.api#documentation": "If you would like to associate your S3 Access Grants instance with an Amazon Web Services IAM Identity Center instance, use this field to pass the Amazon Resource Name (ARN) of the Amazon Web Services IAM Identity Center instance that you are associating with your S3 Access Grants instance. An IAM Identity Center instance is your corporate identity directory that you added to the IAM Identity Center. You can use the ListInstances API operation to retrieve a list of your Identity Center instances and their ARNs.
" } }, "Tags": { "target": "com.amazonaws.s3control#TagList", "traits": { "smithy.api#documentation": "The Amazon Web Services resource tags that you are adding to the S3 Access Grants instance. Each tag is a label consisting of a user-defined key and value. Tags can help you manage, identify, organize, search for, and filter resources.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.s3control#CreateAccessGrantsInstanceResult": { "type": "structure", "members": { "CreatedAt": { "target": "com.amazonaws.s3control#CreationTimestamp", "traits": { "smithy.api#documentation": "The date and time when you created the S3 Access Grants instance.
" } }, "AccessGrantsInstanceId": { "target": "com.amazonaws.s3control#AccessGrantsInstanceId", "traits": { "smithy.api#documentation": "The ID of the S3 Access Grants instance. The ID is default. You can have one S3 Access Grants instance per Region per account.
The Amazon Resource Name (ARN) of the Amazon Web Services IAM Identity Center instance that you are associating with your S3 Access Grants instance. An IAM Identity Center instance is your corporate identity directory that you added to the IAM Identity Center. You can use the ListInstances API operation to retrieve a list of your Identity Center instances and their ARNs.
" } }, "IdentityCenterArn": { "target": "com.amazonaws.s3control#IdentityCenterArn", "traits": { "smithy.api#deprecated": { "message": "IdentityCenterArn has been deprecated. Use IdentityCenterInstanceArn or IdentityCenterApplicationArn." }, "smithy.api#documentation": "If you associated your S3 Access Grants instance with an Amazon Web Services IAM Identity Center instance, this field returns the Amazon Resource Name (ARN) of the IAM Identity Center instance application; a subresource of the original Identity Center instance. S3 Access Grants creates this Identity Center application for the specific S3 Access Grants instance.
" } }, "IdentityCenterInstanceArn": { "target": "com.amazonaws.s3control#IdentityCenterArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Web Services IAM Identity Center instance that you are associating with your S3 Access Grants instance. An IAM Identity Center instance is your corporate identity directory that you added to the IAM Identity Center. You can use the ListInstances API operation to retrieve a list of your Identity Center instances and their ARNs.
" } }, "IdentityCenterApplicationArn": { "target": "com.amazonaws.s3control#IdentityCenterApplicationArn", "traits": { "smithy.api#documentation": "If you associated your S3 Access Grants instance with an Amazon Web Services IAM Identity Center instance, this field returns the Amazon Resource Name (ARN) of the IAM Identity Center instance application; a subresource of the original Identity Center instance. S3 Access Grants creates this Identity Center application for the specific S3 Access Grants instance.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.s3control#CreateAccessGrantsLocation": { "type": "operation", "input": { "target": "com.amazonaws.s3control#CreateAccessGrantsLocationRequest" }, "output": { "target": "com.amazonaws.s3control#CreateAccessGrantsLocationResult" }, "traits": { "smithy.api#documentation": "The S3 data location that you would like to register in your S3 Access Grants instance. Your S3 data must be in the same Region as your S3 Access Grants instance. The location can be one of the following:
\nThe default S3 location s3://\n
A bucket - S3://\n
A bucket and prefix - S3://\n
When you register a location, you must include the IAM role that has permission to manage the S3 location that you are registering. Give S3 Access Grants permission to assume this role using a policy. S3 Access Grants assumes this role to manage access to the location and to vend temporary credentials to grantees or client applications.
\nYou must have the s3:CreateAccessGrantsLocation permission to use this operation.
You must also have the following permission for the specified IAM role: iam:PassRole\n
The Amazon Web Services account ID of the S3 Access Grants instance.
", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "AccountId" } } }, "LocationScope": { "target": "com.amazonaws.s3control#S3Prefix", "traits": { "smithy.api#documentation": "The S3 path to the location that you are registering. The location scope can be the default S3 location s3://, the S3 path to a bucket s3://, or the S3 path to a bucket and prefix s3://. A prefix in S3 is a string of characters at the beginning of an object key name used to organize the objects that you store in your S3 buckets. For example, object key names that start with the engineering/ prefix or object key names that start with the marketing/campaigns/ prefix.
The Amazon Resource Name (ARN) of the IAM role for the registered location. S3 Access Grants assumes this role to manage access to the registered location.
", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.s3control#TagList", "traits": { "smithy.api#documentation": "The Amazon Web Services resource tags that you are adding to the S3 Access Grants location. Each tag is a label consisting of a user-defined key and value. Tags can help you manage, identify, organize, search for, and filter resources.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.s3control#CreateAccessGrantsLocationResult": { "type": "structure", "members": { "CreatedAt": { "target": "com.amazonaws.s3control#CreationTimestamp", "traits": { "smithy.api#documentation": "The date and time when you registered the location.
" } }, "AccessGrantsLocationId": { "target": "com.amazonaws.s3control#AccessGrantsLocationId", "traits": { "smithy.api#documentation": "The ID of the registered location to which you are granting access. S3 Access Grants assigns this ID when you register the location. S3 Access Grants assigns the ID default to the default location s3:// and assigns an auto-generated ID to other locations that you register.
The Amazon Resource Name (ARN) of the location you are registering.
" } }, "LocationScope": { "target": "com.amazonaws.s3control#S3Prefix", "traits": { "smithy.api#documentation": "The S3 URI path to the location that you are registering. The location scope can be the default S3 location s3://, the S3 path to a bucket, or the S3 path to a bucket and prefix. A prefix in S3 is a string of characters at the beginning of an object key name used to organize the objects that you store in your S3 buckets. For example, object key names that start with the engineering/ prefix or object key names that start with the marketing/campaigns/ prefix.
The Amazon Resource Name (ARN) of the IAM role for the registered location. S3 Access Grants assumes this role to manage access to the registered location.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.s3control#CreateAccessPoint": { "type": "operation", "input": { "target": "com.amazonaws.s3control#CreateAccessPointRequest" }, "output": { "target": "com.amazonaws.s3control#CreateAccessPointResult" }, "traits": { "smithy.api#documentation": "Creates an access point and associates it to a specified bucket. For more information, see\n Managing\n access to shared datasets with access points or Managing access to\n shared datasets in directory buckets with access points in the\n Amazon S3 User Guide.
\nTo create an access point and attach it to a volume on an Amazon FSx file system, see CreateAndAttachS3AccessPoint in the Amazon FSx API\n Reference.
\n \nS3 on Outposts only supports VPC-style access points.
\nFor more information, see Accessing Amazon S3 on Outposts using\n virtual private cloud (VPC) only access points in the\n Amazon S3 User Guide.
\nAll Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.
The following actions are related to CreateAccessPoint:
\n GetAccessPoint\n
\n\n DeleteAccessPoint\n
\n\n ListAccessPoints\n
\nThis operation is not supported by directory buckets.
\nCreates an Object Lambda Access Point. For more information, see Transforming objects with\n Object Lambda Access Points in the Amazon S3 User Guide.
\nThe following actions are related to\n CreateAccessPointForObjectLambda:
The Amazon Web Services account ID for owner of the specified Object Lambda Access Point.
", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "AccountId" } } }, "Name": { "target": "com.amazonaws.s3control#ObjectLambdaAccessPointName", "traits": { "smithy.api#documentation": "The name you want to assign to this Object Lambda Access Point.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "Configuration": { "target": "com.amazonaws.s3control#ObjectLambdaConfiguration", "traits": { "smithy.api#documentation": "Object Lambda Access Point configuration as a JSON document.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.s3control#CreateAccessPointForObjectLambdaResult": { "type": "structure", "members": { "ObjectLambdaAccessPointArn": { "target": "com.amazonaws.s3control#ObjectLambdaAccessPointArn", "traits": { "smithy.api#documentation": "Specifies the ARN for the Object Lambda Access Point.
" } }, "Alias": { "target": "com.amazonaws.s3control#ObjectLambdaAccessPointAlias", "traits": { "smithy.api#documentation": "The alias of the Object Lambda Access Point.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.s3control#CreateAccessPointRequest": { "type": "structure", "members": { "AccountId": { "target": "com.amazonaws.s3control#AccountId", "traits": { "smithy.api#documentation": "The Amazon Web Services account ID for the account that owns the specified access point.
", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "AccountId" } } }, "Name": { "target": "com.amazonaws.s3control#AccessPointName", "traits": { "smithy.api#documentation": "The name you want to assign to this access point.
\nFor directory buckets, the access point name must consist of a base name that you provide and\n suffix that includes the ZoneID (Amazon Web Services Availability Zone or Local Zone) of your bucket location,\n followed by --xa-s3. For more information, see Managing access to shared datasets in directory buckets with\n access points in the Amazon S3 User Guide.
The name of the bucket that you want to associate this access point with.
\nFor using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.
\nFor using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:. For example, to access the bucket reports through Outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.
If you include this field, Amazon S3 restricts access to this access point to requests from the\n specified virtual private cloud (VPC).
\nThis is required for creating an access point for Amazon S3 on Outposts buckets.
\n The PublicAccessBlock configuration that you want to apply to the access point.\n
The Amazon Web Services account ID associated with the S3 bucket associated with this access point.
\nFor same account access point when your bucket and access point belong to the same account owner, the BucketAccountId is not required. \n For cross-account access point when your bucket and access point are not in the same account, the BucketAccountId is required.\n
For directory buckets, you can filter access control to specific prefixes, API\n operations, or a combination of both. For more information, see Managing access to shared datasets in directory buckets with\n access points in the Amazon S3 User Guide.
\nScope is only supported for access points attached to directory buckets.
\nAn array of tags that you can apply to an access point. Tags are key-value pairs of metadata used to control access to your access points. For more information about tags, see Using tags with Amazon S3. For information about tagging access points, see Using tags for attribute-based access control (ABAC).
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.s3control#CreateAccessPointResult": { "type": "structure", "members": { "AccessPointArn": { "target": "com.amazonaws.s3control#S3AccessPointArn", "traits": { "smithy.api#documentation": "The ARN of the access point.
\nThis is only supported by Amazon S3 on Outposts.
\nThe name or alias of the access point.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.s3control#CreateBucket": { "type": "operation", "input": { "target": "com.amazonaws.s3control#CreateBucketRequest" }, "output": { "target": "com.amazonaws.s3control#CreateBucketResult" }, "errors": [ { "target": "com.amazonaws.s3control#BucketAlreadyExists" }, { "target": "com.amazonaws.s3control#BucketAlreadyOwnedByYou" } ], "traits": { "smithy.api#documentation": "This action creates an Amazon S3 on Outposts bucket. To create an S3 bucket, see Create\n Bucket in the Amazon S3 API Reference.
\nCreates a new Outposts bucket. By creating the bucket, you become the bucket owner. To\n create an Outposts bucket, you must have S3 on Outposts. For more information, see Using\n Amazon S3 on Outposts in Amazon S3 User Guide.
\nNot every string is an acceptable bucket name. For information on bucket naming\n restrictions, see Working with\n Amazon S3 Buckets.
\nS3 on Outposts buckets support:
\nTags
\nLifecycleConfigurations for deleting expired objects
\nFor a complete list of restrictions and Amazon S3 feature limitations on S3 on Outposts, see\n \n Amazon S3 on Outposts Restrictions and Limitations.
\nFor an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts\n endpoint hostname prefix and x-amz-outpost-id in your API request, see the\n Examples section.
The following actions are related to CreateBucket for\n Amazon S3 on Outposts:
\n PutObject\n
\n\n GetBucket\n
\n\n DeleteBucket\n
\n\n CreateAccessPoint\n
\n\n PutAccessPointPolicy\n
\nSpecifies the Region where the bucket will be created. If you are creating a bucket on\n the US East (N. Virginia) Region (us-east-1), you do not need to specify the location.
\nThis is not supported by Amazon S3 on Outposts buckets.
\nThe container for the bucket configuration.
\nThis is not supported by Amazon S3 on Outposts buckets.
\nThe canned ACL to apply to the bucket.
\nThis is not supported by Amazon S3 on Outposts buckets.
\nThe name of the bucket.
", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "Bucket" } } }, "CreateBucketConfiguration": { "target": "com.amazonaws.s3control#CreateBucketConfiguration", "traits": { "smithy.api#documentation": "The configuration information for the bucket.
\nThis is not supported by Amazon S3 on Outposts buckets.
\nAllows grantee the read, write, read ACP, and write ACP permissions on the\n bucket.
\nThis is not supported by Amazon S3 on Outposts buckets.
\nAllows grantee to list the objects in the bucket.
\nThis is not supported by Amazon S3 on Outposts buckets.
\nAllows grantee to read the bucket ACL.
\nThis is not supported by Amazon S3 on Outposts buckets.
\nAllows grantee to create, overwrite, and delete any object in the bucket.
\nThis is not supported by Amazon S3 on Outposts buckets.
\nAllows grantee to write the ACL for the applicable bucket.
\nThis is not supported by Amazon S3 on Outposts buckets.
\nSpecifies whether you want S3 Object Lock to be enabled for the new bucket.
\nThis is not supported by Amazon S3 on Outposts buckets.
\nThe ID of the Outposts where the bucket is being created.
\nThis ID is required by Amazon S3 on Outposts buckets.
\nThe location of the bucket.
", "smithy.api#httpHeader": "Location" } }, "BucketArn": { "target": "com.amazonaws.s3control#S3RegionalBucketArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the bucket.
\nFor using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.
\nFor using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:. For example, to access the bucket reports through Outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.
This operation creates an S3 Batch Operations job.
\nYou can use S3 Batch Operations to perform large-scale batch actions on Amazon S3 objects.\n Batch Operations can run a single action on lists of Amazon S3 objects that you specify. For more\n information, see S3 Batch Operations in the Amazon S3 User Guide.
\nFor information about permissions required to use the Batch Operations, see Granting permissions for S3 Batch Operations in the Amazon S3\n User Guide.
\nRelated actions include:
\n\n DescribeJob\n
\n\n ListJobs\n
\n\n UpdateJobPriority\n
\n\n UpdateJobStatus\n
\n\n JobOperation\n
\nThe Amazon Web Services account ID that creates the job.
", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "AccountId" } } }, "ConfirmationRequired": { "target": "com.amazonaws.s3control#ConfirmationRequired", "traits": { "smithy.api#default": null, "smithy.api#documentation": "Indicates whether confirmation is required before Amazon S3 runs the job. Confirmation is\n only required for jobs created through the Amazon S3 console.
" } }, "Operation": { "target": "com.amazonaws.s3control#JobOperation", "traits": { "smithy.api#documentation": "The action that you want this job to perform on every object listed in the manifest. For\n more information about the available actions, see Operations in the\n Amazon S3 User Guide.
", "smithy.api#required": {} } }, "Report": { "target": "com.amazonaws.s3control#JobReport", "traits": { "smithy.api#documentation": "Configuration parameters for the optional job-completion report.
", "smithy.api#required": {} } }, "ClientRequestToken": { "target": "com.amazonaws.s3control#NonEmptyMaxLength64String", "traits": { "smithy.api#documentation": "An idempotency token to ensure that you don't accidentally submit the same request\n twice. You can use any string up to the maximum length.
", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } }, "Manifest": { "target": "com.amazonaws.s3control#JobManifest", "traits": { "smithy.api#documentation": "Configuration parameters for the manifest.
" } }, "Description": { "target": "com.amazonaws.s3control#NonEmptyMaxLength256String", "traits": { "smithy.api#documentation": "A description for this job. You can use any string within the permitted length.\n Descriptions don't need to be unique and can be used for multiple jobs.
" } }, "Priority": { "target": "com.amazonaws.s3control#JobPriority", "traits": { "smithy.api#default": null, "smithy.api#documentation": "The numerical priority for this job. Higher numbers indicate higher priority.
", "smithy.api#required": {} } }, "RoleArn": { "target": "com.amazonaws.s3control#IAMRoleArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) for the Identity and Access Management (IAM) role that Batch Operations will\n use to run this job's action on every object in the manifest.
", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.s3control#S3TagSet", "traits": { "smithy.api#documentation": "A set of tags to associate with the S3 Batch Operations job. This is an optional parameter.\n
" } }, "ManifestGenerator": { "target": "com.amazonaws.s3control#JobManifestGenerator", "traits": { "smithy.api#documentation": "The attribute container for the ManifestGenerator details. Jobs must be created with\n either a manifest file or a ManifestGenerator, but not both.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.s3control#CreateJobResult": { "type": "structure", "members": { "JobId": { "target": "com.amazonaws.s3control#JobId", "traits": { "smithy.api#documentation": "The ID for this job. Amazon S3 generates this ID automatically and returns it after a\n successful Create Job request.
This operation is not supported by directory buckets.
\nCreates a Multi-Region Access Point and associates it with the specified buckets. For more information\n about creating Multi-Region Access Points, see Creating Multi-Region Access Points in the Amazon S3 User Guide.
\nThis action will always be routed to the US West (Oregon) Region. For more information\n about the restrictions around working with Multi-Region Access Points, see Multi-Region Access Point\n restrictions and limitations in the Amazon S3 User Guide.
\nThis request is asynchronous, meaning that you might receive a response before the\n command has completed. When this request provides a response, it provides a token that you\n can use to monitor the status of the request with\n DescribeMultiRegionAccessPointOperation.
The following actions are related to CreateMultiRegionAccessPoint:
The name of the Multi-Region Access Point associated with this request.
", "smithy.api#required": {} } }, "PublicAccessBlock": { "target": "com.amazonaws.s3control#PublicAccessBlockConfiguration" }, "Regions": { "target": "com.amazonaws.s3control#RegionCreationList", "traits": { "smithy.api#documentation": "The buckets in different Regions that are associated with the Multi-Region Access Point.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A container for the information associated with a CreateMultiRegionAccessPoint request.
" } }, "com.amazonaws.s3control#CreateMultiRegionAccessPointRequest": { "type": "structure", "members": { "AccountId": { "target": "com.amazonaws.s3control#AccountId", "traits": { "smithy.api#documentation": "The Amazon Web Services account ID for the owner of the Multi-Region Access Point. The owner of the Multi-Region Access Point also must own\n the underlying buckets.
", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "AccountId" } } }, "ClientToken": { "target": "com.amazonaws.s3control#MultiRegionAccessPointClientToken", "traits": { "smithy.api#documentation": "An idempotency token used to identify the request and guarantee that requests are\n unique.
", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } }, "Details": { "target": "com.amazonaws.s3control#CreateMultiRegionAccessPointInput", "traits": { "smithy.api#documentation": "A container element containing details about the Multi-Region Access Point.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.s3control#CreateMultiRegionAccessPointResult": { "type": "structure", "members": { "RequestTokenARN": { "target": "com.amazonaws.s3control#AsyncRequestTokenARN", "traits": { "smithy.api#documentation": "The request token associated with the request. You can use this token with DescribeMultiRegionAccessPointOperation to determine the status of asynchronous\n requests.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.s3control#CreateStorageLensGroup": { "type": "operation", "input": { "target": "com.amazonaws.s3control#CreateStorageLensGroupRequest" }, "output": { "target": "smithy.api#Unit" }, "traits": { "smithy.api#documentation": "Creates a new S3 Storage Lens group and associates it with the specified Amazon Web Services account ID. An\n S3 Storage Lens group is a custom grouping of objects based on prefix, suffix, object tags,\n object size, object age, or a combination of these filters. For each Storage Lens group\n that you\u2019ve created, you can also optionally add Amazon Web Services resource tags. For more information\n about S3 Storage Lens groups, see Working with S3 Storage Lens\n groups.
\nTo use this operation, you must have the permission to perform the\n s3:CreateStorageLensGroup action. If you\u2019re trying to create a Storage Lens\n group with Amazon Web Services resource tags, you must also have permission to perform the\n s3:TagResource action. For more information about the required Storage Lens\n Groups permissions, see Setting account permissions to use S3 Storage Lens groups.
For information about Storage Lens groups errors, see List of Amazon S3 Storage\n Lens error codes.
", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, "smithy.api#http": { "method": "POST", "uri": "/v20180820/storagelensgroup", "code": 204 }, "smithy.rules#staticContextParams": { "RequiresAccountId": { "value": true } } } }, "com.amazonaws.s3control#CreateStorageLensGroupRequest": { "type": "structure", "members": { "AccountId": { "target": "com.amazonaws.s3control#AccountId", "traits": { "smithy.api#documentation": "\nThe Amazon Web Services account ID that the Storage Lens group is created from and associated with.\n
", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "AccountId" } } }, "StorageLensGroup": { "target": "com.amazonaws.s3control#StorageLensGroup", "traits": { "smithy.api#documentation": "\nThe Storage Lens group configuration.\n
", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.s3control#TagList", "traits": { "smithy.api#documentation": "\nThe Amazon Web Services resource tags that you're adding to your Storage Lens group. This parameter is optional.\n
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.s3control#CreationDate": { "type": "timestamp" }, "com.amazonaws.s3control#CreationTimestamp": { "type": "timestamp" }, "com.amazonaws.s3control#Credentials": { "type": "structure", "members": { "AccessKeyId": { "target": "com.amazonaws.s3control#AccessKeyId", "traits": { "smithy.api#documentation": "The unique access key ID of the Amazon Web Services STS temporary credential that S3 Access Grants vends to grantees and client applications.
" } }, "SecretAccessKey": { "target": "com.amazonaws.s3control#SecretAccessKey", "traits": { "smithy.api#documentation": "The secret access key of the Amazon Web Services STS temporary credential that S3 Access Grants vends to grantees and client applications.
" } }, "SessionToken": { "target": "com.amazonaws.s3control#SessionToken", "traits": { "smithy.api#documentation": "The Amazon Web Services STS temporary credential that S3 Access Grants vends to grantees and client applications.
" } }, "Expiration": { "target": "com.amazonaws.s3control#Expiration", "traits": { "smithy.api#documentation": "The expiration date and time of the temporary credential that S3 Access Grants vends to grantees and client applications.
" } } }, "traits": { "smithy.api#documentation": "The Amazon Web Services Security Token Service temporary credential that S3 Access Grants vends to grantees and client applications.
", "smithy.api#sensitive": {} } }, "com.amazonaws.s3control#DSSEKMSFilter": { "type": "structure", "members": { "KmsKeyArn": { "target": "com.amazonaws.s3control#NonEmptyKmsKeyArnString", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the customer managed KMS key to use for the filter to return objects that are encrypted by the specified key. For best performance, use keys in the same Region as the S3 Batch Operations job.
" } } }, "traits": { "smithy.api#documentation": "A filter that returns objects that are encrypted by dual-layer server-side encryption with Amazon Web Services Key Management Service (KMS) keys (DSSE-KMS). You can further refine your filtering by optionally providing a KMS Key ARN to filter objects encrypted by a specific key.
" } }, "com.amazonaws.s3control#DataSourceId": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 191 } } }, "com.amazonaws.s3control#DataSourceType": { "type": "string" }, "com.amazonaws.s3control#Date": { "type": "timestamp" }, "com.amazonaws.s3control#Days": { "type": "integer", "traits": { "smithy.api#default": 0 } }, "com.amazonaws.s3control#DaysAfterInitiation": { "type": "integer", "traits": { "smithy.api#default": 0 } }, "com.amazonaws.s3control#DeleteAccessGrant": { "type": "operation", "input": { "target": "com.amazonaws.s3control#DeleteAccessGrantRequest" }, "output": { "target": "smithy.api#Unit" }, "traits": { "smithy.api#documentation": "Deletes the access grant from the S3 Access Grants instance. You cannot undo an access grant deletion and the grantee will no longer have access to the S3 data.
\nYou must have the s3:DeleteAccessGrant permission to use this operation.
The Amazon Web Services account ID of the S3 Access Grants instance.
", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "AccountId" } } }, "AccessGrantId": { "target": "com.amazonaws.s3control#AccessGrantId", "traits": { "smithy.api#documentation": "The ID of the access grant. S3 Access Grants auto-generates this ID when you create the access grant.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.s3control#DeleteAccessGrantsInstance": { "type": "operation", "input": { "target": "com.amazonaws.s3control#DeleteAccessGrantsInstanceRequest" }, "output": { "target": "smithy.api#Unit" }, "traits": { "smithy.api#documentation": "Deletes your S3 Access Grants instance. You must first delete the access grants and locations before S3 Access Grants can delete the instance. See DeleteAccessGrant and DeleteAccessGrantsLocation. If you have associated an IAM Identity Center instance with your S3 Access Grants instance, you must first dissassociate the Identity Center instance from the S3 Access Grants instance before you can delete the S3 Access Grants instance. See AssociateAccessGrantsIdentityCenter and DissociateAccessGrantsIdentityCenter.
\nYou must have the s3:DeleteAccessGrantsInstance permission to use this operation.
The Amazon Web Services account ID of the S3 Access Grants instance.
", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "AccountId" } } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.s3control#DeleteAccessGrantsInstanceResourcePolicy": { "type": "operation", "input": { "target": "com.amazonaws.s3control#DeleteAccessGrantsInstanceResourcePolicyRequest" }, "output": { "target": "smithy.api#Unit" }, "traits": { "smithy.api#documentation": "Deletes the resource policy of the S3 Access Grants instance. The resource policy is used to manage cross-account access to your S3 Access Grants instance. By deleting the resource policy, you delete any cross-account permissions to your S3 Access Grants instance.
\nYou must have the s3:DeleteAccessGrantsInstanceResourcePolicy permission to use this operation.
The Amazon Web Services account ID of the S3 Access Grants instance.
", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "AccountId" } } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.s3control#DeleteAccessGrantsLocation": { "type": "operation", "input": { "target": "com.amazonaws.s3control#DeleteAccessGrantsLocationRequest" }, "output": { "target": "smithy.api#Unit" }, "traits": { "smithy.api#documentation": "Deregisters a location from your S3 Access Grants instance. You can only delete a location registration from an S3 Access Grants instance if there are no grants associated with this location. See Delete a grant for information on how to delete grants. You need to have at least one registered location in your S3 Access Grants instance in order to create access grants.
\nYou must have the s3:DeleteAccessGrantsLocation permission to use this operation.
The Amazon Web Services account ID of the S3 Access Grants instance.
", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "AccountId" } } }, "AccessGrantsLocationId": { "target": "com.amazonaws.s3control#AccessGrantsLocationId", "traits": { "smithy.api#documentation": "The ID of the registered location that you are deregistering from your S3 Access Grants instance. S3 Access Grants assigned this ID when you registered the location. S3 Access Grants assigns the ID default to the default location s3:// and assigns an auto-generated ID to other locations that you register.
Deletes the specified access point.
\nAll Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.
The following actions are related to DeleteAccessPoint:
\n CreateAccessPoint\n
\n\n GetAccessPoint\n
\n\n ListAccessPoints\n
\nThis operation is not supported by directory buckets.
\nDeletes the specified Object Lambda Access Point.
\nThe following actions are related to\n DeleteAccessPointForObjectLambda:
The account ID for the account that owns the specified Object Lambda Access Point.
", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "AccountId" } } }, "Name": { "target": "com.amazonaws.s3control#ObjectLambdaAccessPointName", "traits": { "smithy.api#documentation": "The name of the access point you want to delete.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.s3control#DeleteAccessPointPolicy": { "type": "operation", "input": { "target": "com.amazonaws.s3control#DeleteAccessPointPolicyRequest" }, "output": { "target": "smithy.api#Unit" }, "traits": { "smithy.api#documentation": "Deletes the access point policy for the specified access point.
\n \nAll Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.
The following actions are related to DeleteAccessPointPolicy:
\n PutAccessPointPolicy\n
\n\n GetAccessPointPolicy\n
\nThis operation is not supported by directory buckets.
\nRemoves the resource policy for an Object Lambda Access Point.
\nThe following actions are related to\n DeleteAccessPointPolicyForObjectLambda:
The account ID for the account that owns the specified Object Lambda Access Point.
", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "AccountId" } } }, "Name": { "target": "com.amazonaws.s3control#ObjectLambdaAccessPointName", "traits": { "smithy.api#documentation": "The name of the Object Lambda Access Point you want to delete the policy for.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.s3control#DeleteAccessPointPolicyRequest": { "type": "structure", "members": { "AccountId": { "target": "com.amazonaws.s3control#AccountId", "traits": { "smithy.api#documentation": "The account ID for the account that owns the specified access point.
", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "AccountId" } } }, "Name": { "target": "com.amazonaws.s3control#AccessPointName", "traits": { "smithy.api#documentation": "The name of the access point whose policy you want to delete.
\nFor using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.
\nFor using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the access point accessed in the format arn:aws:s3-outposts:. For example, to access the access point reports-ap through Outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap. The value must be URL encoded.
The Amazon Web Services account ID for the account that owns the specified access point.
", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "AccountId" } } }, "Name": { "target": "com.amazonaws.s3control#AccessPointName", "traits": { "smithy.api#documentation": "The name of the access point you want to delete.
\nFor using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.
\nFor using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the access point accessed in the format arn:aws:s3-outposts:. For example, to access the access point reports-ap through Outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap. The value must be URL encoded.
\n Deletes an existing access point scope for a directory bucket.
\nWhen you delete the scope of an access point, all prefixes and permissions are deleted.
\nTo use this operation, you must have the permission to perform the\n s3express:DeleteAccessPointScope action.
For information about REST API errors, see REST error responses.
", "smithy.api#http": { "method": "DELETE", "uri": "/v20180820/accesspoint/{Name}/scope", "code": 200 }, "smithy.rules#staticContextParams": { "RequiresAccountId": { "value": true }, "UseS3ExpressControlEndpoint": { "value": true } } } }, "com.amazonaws.s3control#DeleteAccessPointScopeRequest": { "type": "structure", "members": { "AccountId": { "target": "com.amazonaws.s3control#AccountId", "traits": { "smithy.api#documentation": "\n The Amazon Web Services account ID that owns the access point with the scope that you want to delete.\n
", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "AccountId" } } }, "Name": { "target": "com.amazonaws.s3control#AccessPointName", "traits": { "smithy.api#documentation": "\n The name of the access point with the scope that you want to delete.\n
", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "AccessPointName" } } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.s3control#DeleteBucket": { "type": "operation", "input": { "target": "com.amazonaws.s3control#DeleteBucketRequest" }, "output": { "target": "smithy.api#Unit" }, "traits": { "smithy.api#documentation": "This action deletes an Amazon S3 on Outposts bucket. To delete an S3 bucket, see DeleteBucket in the Amazon S3 API Reference.
\nDeletes the Amazon S3 on Outposts bucket. All objects (including all object versions and\n delete markers) in the bucket must be deleted before the bucket itself can be deleted. For\n more information, see Using Amazon S3 on Outposts in\n Amazon S3 User Guide.
\nAll Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.
\n Related Resources\n
\n\n CreateBucket\n
\n\n GetBucket\n
\n\n DeleteObject\n
\nThis action deletes an Amazon S3 on Outposts bucket's lifecycle configuration. To delete\n an S3 bucket's lifecycle configuration, see DeleteBucketLifecycle in the Amazon S3 API Reference.
\nDeletes the lifecycle configuration from the specified Outposts bucket.\n Amazon S3 on Outposts removes all the lifecycle configuration rules in the lifecycle subresource\n associated with the bucket. Your objects never expire, and Amazon S3 on Outposts no longer\n automatically deletes any objects on the basis of rules contained in the deleted lifecycle\n configuration. For more information, see Using Amazon S3 on Outposts in\n Amazon S3 User Guide.
\nTo use this operation, you must have permission to perform the\n s3-outposts:PutLifecycleConfiguration action. By default, the bucket owner\n has this permission and the Outposts bucket owner can grant this permission to\n others.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.
For more information about object expiration, see Elements to Describe Lifecycle Actions.
\nRelated actions include:
\nThe account ID of the lifecycle configuration to delete.
", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "AccountId" } } }, "Bucket": { "target": "com.amazonaws.s3control#BucketName", "traits": { "smithy.api#documentation": "Specifies the bucket.
\nFor using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.
\nFor using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:. For example, to access the bucket reports through Outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.
This action deletes an Amazon S3 on Outposts bucket policy. To delete an S3 bucket policy,\n see DeleteBucketPolicy in the Amazon S3 API Reference.
\nThis implementation of the DELETE action uses the policy subresource to delete the\n policy of a specified Amazon S3 on Outposts bucket. If you are using an identity other than the\n root user of the Amazon Web Services account that owns the bucket, the calling identity must have the\n s3-outposts:DeleteBucketPolicy permissions on the specified Outposts bucket\n and belong to the bucket owner's account to use this action. For more information, see\n Using\n Amazon S3 on Outposts in Amazon S3 User Guide.
If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a 403\n Access Denied error. If you have the correct permissions, but you're not using an\n identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not\n Allowed error.
As a security precaution, the root user of the Amazon Web Services account that owns a bucket can\n always use this action, even if the policy explicitly denies the root user the ability\n to perform this action.
\nFor more information about bucket policies, see Using Bucket Policies and User\n Policies.
\nAll Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.
The following actions are related to DeleteBucketPolicy:
\n GetBucketPolicy\n
\n\n PutBucketPolicy\n
\nThe account ID of the Outposts bucket.
", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "AccountId" } } }, "Bucket": { "target": "com.amazonaws.s3control#BucketName", "traits": { "smithy.api#documentation": "Specifies the bucket.
\nFor using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.
\nFor using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:. For example, to access the bucket reports through Outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.
This operation deletes an Amazon S3 on Outposts bucket's replication configuration. To\n delete an S3 bucket's replication configuration, see DeleteBucketReplication in the Amazon S3 API Reference.
\nDeletes the replication configuration from the specified S3 on Outposts bucket.
\nTo use this operation, you must have permissions to perform the\n s3-outposts:PutReplicationConfiguration action. The Outposts bucket owner\n has this permission by default and can grant it to others. For more information about\n permissions, see Setting up IAM with\n S3 on Outposts and Managing access to\n S3 on Outposts buckets in the Amazon S3 User Guide.
It can take a while to propagate PUT or DELETE requests for\n a replication configuration to all S3 on Outposts systems. Therefore, the replication\n configuration that's returned by a GET request soon after a\n PUT or DELETE request might return a more recent result\n than what's on the Outpost. If an Outpost is offline, the delay in updating the\n replication configuration on that Outpost can be significant.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.
For information about S3 replication on Outposts configuration, see Replicating objects for S3 on Outposts in the\n Amazon S3 User Guide.
\nThe following operations are related to DeleteBucketReplication:
\n PutBucketReplication\n
\n\n GetBucketReplication\n
\nThe Amazon Web Services account ID of the Outposts bucket to delete the replication configuration\n for.
", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "AccountId" } } }, "Bucket": { "target": "com.amazonaws.s3control#BucketName", "traits": { "smithy.api#documentation": "Specifies the S3 on Outposts bucket to delete the replication configuration for.
\nFor using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.
\nFor using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:. For example, to access the bucket reports through Outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.
The account ID that owns the Outposts bucket.
", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "AccountId" } } }, "Bucket": { "target": "com.amazonaws.s3control#BucketName", "traits": { "smithy.api#documentation": "Specifies the bucket being deleted.
\nFor using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.
\nFor using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:. For example, to access the bucket reports through Outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.
This action deletes an Amazon S3 on Outposts bucket's tags. To delete an S3 bucket tags,\n see DeleteBucketTagging in the Amazon S3 API Reference.
\nDeletes the tags from the Outposts bucket. For more information, see Using\n Amazon S3 on Outposts in Amazon S3 User Guide.
\nTo use this action, you must have permission to perform the\n PutBucketTagging action. By default, the bucket owner has this permission\n and can grant this permission to others.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.
The following actions are related to DeleteBucketTagging:
\n GetBucketTagging\n
\n\n PutBucketTagging\n
\nThe Amazon Web Services account ID of the Outposts bucket tag set to be removed.
", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "AccountId" } } }, "Bucket": { "target": "com.amazonaws.s3control#BucketName", "traits": { "smithy.api#documentation": "The bucket ARN that has the tag set to be removed.
\nFor using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.
\nFor using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:. For example, to access the bucket reports through Outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.
Removes the entire tag set from the specified S3 Batch Operations job.
\nTo use the\n DeleteJobTagging operation, you must have permission to\n perform the s3:DeleteJobTagging action. For more information, see Controlling\n access and labeling jobs using tags in the\n Amazon S3 User Guide.
Related actions include:
\n\n CreateJob\n
\n\n GetJobTagging\n
\n\n PutJobTagging\n
\nThe Amazon Web Services account ID associated with the S3 Batch Operations job.
", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "AccountId" } } }, "JobId": { "target": "com.amazonaws.s3control#JobId", "traits": { "smithy.api#documentation": "The ID for the S3 Batch Operations job whose tags you want to delete.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.s3control#DeleteJobTaggingResult": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.s3control#DeleteMarkerReplication": { "type": "structure", "members": { "Status": { "target": "com.amazonaws.s3control#DeleteMarkerReplicationStatus", "traits": { "smithy.api#documentation": "Indicates whether to replicate delete markers.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Specifies whether S3 on Outposts replicates delete markers. If you specify a\n Filter element in your replication configuration, you must also include a\n DeleteMarkerReplication element. If your Filter includes a\n Tag element, the DeleteMarkerReplication element's\n Status child element must be set to Disabled, because\n S3 on Outposts does not support replicating delete markers for tag-based rules.
For more information about delete marker replication, see How delete operations affect replication in the\n Amazon S3 User Guide.
" } }, "com.amazonaws.s3control#DeleteMarkerReplicationStatus": { "type": "enum", "members": { "Enabled": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Enabled" } }, "Disabled": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Disabled" } } } }, "com.amazonaws.s3control#DeleteMultiRegionAccessPoint": { "type": "operation", "input": { "target": "com.amazonaws.s3control#DeleteMultiRegionAccessPointRequest" }, "output": { "target": "com.amazonaws.s3control#DeleteMultiRegionAccessPointResult" }, "traits": { "smithy.api#documentation": "This operation is not supported by directory buckets.
\nDeletes a Multi-Region Access Point. This action does not delete the buckets associated with the Multi-Region Access Point,\n only the Multi-Region Access Point itself.
\nThis action will always be routed to the US West (Oregon) Region. For more information\n about the restrictions around working with Multi-Region Access Points, see Multi-Region Access Point\n restrictions and limitations in the Amazon S3 User Guide.
\nThis request is asynchronous, meaning that you might receive a response before the\n command has completed. When this request provides a response, it provides a token that you\n can use to monitor the status of the request with\n DescribeMultiRegionAccessPointOperation.
The following actions are related to DeleteMultiRegionAccessPoint:
The name of the Multi-Region Access Point associated with this request.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A container for the information associated with a DeleteMultiRegionAccessPoint request.
" } }, "com.amazonaws.s3control#DeleteMultiRegionAccessPointRequest": { "type": "structure", "members": { "AccountId": { "target": "com.amazonaws.s3control#AccountId", "traits": { "smithy.api#documentation": "The Amazon Web Services account ID for the owner of the Multi-Region Access Point.
", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "AccountId" } } }, "ClientToken": { "target": "com.amazonaws.s3control#MultiRegionAccessPointClientToken", "traits": { "smithy.api#documentation": "An idempotency token used to identify the request and guarantee that requests are\n unique.
", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } }, "Details": { "target": "com.amazonaws.s3control#DeleteMultiRegionAccessPointInput", "traits": { "smithy.api#documentation": "A container element containing details about the Multi-Region Access Point.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.s3control#DeleteMultiRegionAccessPointResult": { "type": "structure", "members": { "RequestTokenARN": { "target": "com.amazonaws.s3control#AsyncRequestTokenARN", "traits": { "smithy.api#documentation": "The request token associated with the request. You can use this token with DescribeMultiRegionAccessPointOperation to determine the status of asynchronous\n requests.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.s3control#DeletePublicAccessBlock": { "type": "operation", "input": { "target": "com.amazonaws.s3control#DeletePublicAccessBlockRequest" }, "output": { "target": "smithy.api#Unit" }, "traits": { "smithy.api#documentation": "This operation is not supported by directory buckets.
\nRemoves the PublicAccessBlock configuration for an Amazon Web Services account. This\n operation might be restricted when the account is managed by organization-level Block\n Public Access policies. You\u2019ll get an Access Denied (403) error when the account is managed\n by organization-level Block Public Access policies. Organization-level policies override\n account-level settings, preventing direct account-level modifications. For more\n information, see Using Amazon S3 block\n public access.
Related actions include:
\n\n GetPublicAccessBlock\n
\n\n PutPublicAccessBlock\n
\nThe account ID for the Amazon Web Services account whose PublicAccessBlock configuration\n you want to remove.
This operation is not supported by directory buckets.
\nDeletes the Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see Assessing your storage\n activity and usage with Amazon S3 Storage Lens in the\n Amazon S3 User Guide.
\nTo use this action, you must have permission to perform the\n s3:DeleteStorageLensConfiguration action. For more information, see\n Setting permissions to\n use Amazon S3 Storage Lens in the Amazon S3 User Guide.
The ID of the S3 Storage Lens configuration.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "AccountId": { "target": "com.amazonaws.s3control#AccountId", "traits": { "smithy.api#documentation": "The account ID of the requester.
", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "AccountId" } } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.s3control#DeleteStorageLensConfigurationTagging": { "type": "operation", "input": { "target": "com.amazonaws.s3control#DeleteStorageLensConfigurationTaggingRequest" }, "output": { "target": "com.amazonaws.s3control#DeleteStorageLensConfigurationTaggingResult" }, "traits": { "smithy.api#documentation": "This operation is not supported by directory buckets.
\nDeletes the Amazon S3 Storage Lens configuration tags. For more information about S3 Storage Lens, see\n Assessing your\n storage activity and usage with Amazon S3 Storage Lens in the\n Amazon S3 User Guide.
\nTo use this action, you must have permission to perform the\n s3:DeleteStorageLensConfigurationTagging action. For more information,\n see Setting permissions to\n use Amazon S3 Storage Lens in the Amazon S3 User Guide.
The ID of the S3 Storage Lens configuration.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "AccountId": { "target": "com.amazonaws.s3control#AccountId", "traits": { "smithy.api#documentation": "The account ID of the requester.
", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "AccountId" } } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.s3control#DeleteStorageLensConfigurationTaggingResult": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.s3control#DeleteStorageLensGroup": { "type": "operation", "input": { "target": "com.amazonaws.s3control#DeleteStorageLensGroupRequest" }, "output": { "target": "smithy.api#Unit" }, "traits": { "smithy.api#documentation": "\nDeletes an existing S3 Storage Lens group.
\nTo use this operation, you must have the permission to perform the\n s3:DeleteStorageLensGroup action. For more information about the required Storage Lens\n Groups permissions, see Setting account permissions to use S3 Storage Lens groups.
For information about Storage Lens groups errors, see List of Amazon S3 Storage\n Lens error codes.
", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, "smithy.api#http": { "method": "DELETE", "uri": "/v20180820/storagelensgroup/{Name}", "code": 204 }, "smithy.rules#staticContextParams": { "RequiresAccountId": { "value": true } } } }, "com.amazonaws.s3control#DeleteStorageLensGroupRequest": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.s3control#StorageLensGroupName", "traits": { "smithy.api#documentation": "\nThe name of the Storage Lens group that you're trying to delete.\n
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "AccountId": { "target": "com.amazonaws.s3control#AccountId", "traits": { "smithy.api#documentation": "\nThe Amazon Web Services account ID used to create the Storage Lens group that you're trying to delete.\n
", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "AccountId" } } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.s3control#DescribeJob": { "type": "operation", "input": { "target": "com.amazonaws.s3control#DescribeJobRequest" }, "output": { "target": "com.amazonaws.s3control#DescribeJobResult" }, "errors": [ { "target": "com.amazonaws.s3control#BadRequestException" }, { "target": "com.amazonaws.s3control#InternalServiceException" }, { "target": "com.amazonaws.s3control#NotFoundException" }, { "target": "com.amazonaws.s3control#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Retrieves the configuration parameters and status for a Batch Operations job. For more\n information, see S3 Batch Operations in the Amazon S3 User Guide.
\nTo use the DescribeJob operation, you must have permission to perform the s3:DescribeJob action.
Related actions include:
\n\n CreateJob\n
\n\n ListJobs\n
\n\n UpdateJobPriority\n
\n\n UpdateJobStatus\n
\nThe Amazon Web Services account ID associated with the S3 Batch Operations job.
", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "AccountId" } } }, "JobId": { "target": "com.amazonaws.s3control#JobId", "traits": { "smithy.api#documentation": "The ID for the job whose information you want to retrieve.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.s3control#DescribeJobResult": { "type": "structure", "members": { "Job": { "target": "com.amazonaws.s3control#JobDescriptor", "traits": { "smithy.api#documentation": "Contains the configuration parameters and status for the job specified in the\n Describe Job request.
This operation is not supported by directory buckets.
\nRetrieves the status of an asynchronous request to manage a Multi-Region Access Point. For more information\n about managing Multi-Region Access Points and how asynchronous requests work, see Using Multi-Region Access Points in the Amazon S3 User Guide.
\nThe following actions are related to GetMultiRegionAccessPoint:
The Amazon Web Services account ID for the owner of the Multi-Region Access Point.
", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "AccountId" } } }, "RequestTokenARN": { "target": "com.amazonaws.s3control#AsyncRequestTokenARN", "traits": { "smithy.api#documentation": "The request token associated with the request you want to know about. This request token\n is returned as part of the response when you make an asynchronous request. You provide this\n token to query about the status of the asynchronous action.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.s3control#DescribeMultiRegionAccessPointOperationResult": { "type": "structure", "members": { "AsyncOperation": { "target": "com.amazonaws.s3control#AsyncOperation", "traits": { "smithy.api#documentation": "A container element containing the details of the asynchronous operation.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.s3control#Destination": { "type": "structure", "members": { "Account": { "target": "com.amazonaws.s3control#AccountId", "traits": { "smithy.api#documentation": "The destination bucket owner's account ID.
" } }, "Bucket": { "target": "com.amazonaws.s3control#BucketIdentifierString", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the access point for the destination bucket where you want\n S3 on Outposts to store the replication results.
", "smithy.api#required": {} } }, "ReplicationTime": { "target": "com.amazonaws.s3control#ReplicationTime", "traits": { "smithy.api#documentation": "A container that specifies S3 Replication Time Control (S3 RTC) settings, including whether S3 RTC is enabled\n and the time when all objects and operations on objects must be replicated. Must be\n specified together with a Metrics block.
This is not supported by Amazon S3 on Outposts buckets.
\nSpecify this property only in a cross-account scenario (where the source and destination\n bucket owners are not the same), and you want to change replica ownership to the\n Amazon Web Services account that owns the destination bucket. If this property is not specified in the\n replication configuration, the replicas are owned by same Amazon Web Services account that owns the\n source object.
\nThis is not supported by Amazon S3 on Outposts buckets.
\nA container that provides information about encryption. If\n SourceSelectionCriteria is specified, you must specify this element.
This is not supported by Amazon S3 on Outposts buckets.
\nA container that specifies replication metrics-related settings.
" } }, "StorageClass": { "target": "com.amazonaws.s3control#ReplicationStorageClass", "traits": { "smithy.api#documentation": " The storage class to use when replicating objects. All objects stored on S3 on Outposts\n are stored in the OUTPOSTS storage class. S3 on Outposts uses the\n OUTPOSTS storage class to create the object replicas.
Values other than OUTPOSTS aren't supported by Amazon S3 on Outposts.
Specifies information about the replication destination bucket and its settings for an\n S3 on Outposts replication configuration.
" } }, "com.amazonaws.s3control#DetailedStatusCodesMetrics": { "type": "structure", "members": { "IsEnabled": { "target": "com.amazonaws.s3control#IsEnabled", "traits": { "smithy.api#default": false, "smithy.api#documentation": "A container that indicates whether detailed status code metrics are enabled.
" } } }, "traits": { "smithy.api#documentation": "The container element for Amazon S3 Storage Lens detailed status code metrics. Detailed status\n code metrics generate metrics for HTTP status codes, such as 200 OK, 403\n Forbidden, 503 Service Unavailable and others.
For more information about S3 Storage Lens, see Assessing your storage activity and usage with S3 Storage Lens in the Amazon S3 User Guide. For a complete list of S3 Storage Lens metrics, see S3 Storage Lens metrics glossary in the Amazon S3 User Guide.
" } }, "com.amazonaws.s3control#DissociateAccessGrantsIdentityCenter": { "type": "operation", "input": { "target": "com.amazonaws.s3control#DissociateAccessGrantsIdentityCenterRequest" }, "output": { "target": "smithy.api#Unit" }, "traits": { "smithy.api#documentation": "Dissociates the Amazon Web Services IAM Identity Center instance from the S3 Access Grants instance.
\nYou must have the s3:DissociateAccessGrantsIdentityCenter permission to use this operation.
You must have the sso:DeleteApplication permission to use this operation.
The Amazon Web Services account ID of the S3 Access Grants instance.
", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "AccountId" } } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.s3control#DurationSeconds": { "type": "integer", "traits": { "smithy.api#range": { "min": 900, "max": 43200 } } }, "com.amazonaws.s3control#EncryptionConfiguration": { "type": "structure", "members": { "ReplicaKmsKeyID": { "target": "com.amazonaws.s3control#ReplicaKmsKeyID", "traits": { "smithy.api#documentation": "Specifies the ID of the customer managed KMS key that's stored in Key Management Service (KMS)\n for the destination bucket. This ID is either the Amazon Resource Name (ARN) for the\n KMS key or the alias ARN for the KMS key. Amazon S3 uses this KMS key to encrypt\n replica objects. Amazon S3 supports only symmetric encryption KMS keys. For more information,\n see Symmetric encryption\n KMS keys in the Amazon Web Services Key Management Service Developer\n Guide.
" } } }, "traits": { "smithy.api#documentation": "Specifies encryption-related information for an Amazon S3 bucket that is a destination for\n replicated objects. If you're specifying a customer managed KMS key, we recommend using a fully qualified\n KMS key ARN. If you use a KMS key alias instead, then KMS resolves the key within the\n requester\u2019s account. This behavior can result in data that's encrypted with a KMS key\n that belongs to the requester, and not the bucket owner.
\nThis is not supported by Amazon S3 on Outposts buckets.
\nThe details of the last established policy.
" } } }, "traits": { "smithy.api#documentation": "The last established access control policy for a Multi-Region Access Point.
\nWhen you update the policy, the update is first listed as the proposed policy. After the\n update is finished and all Regions have been updated, the proposed policy is listed as the\n established policy. If both policies have the same version number, the proposed policy is\n the established policy.
" } }, "com.amazonaws.s3control#ExceptionMessage": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1024 } } }, "com.amazonaws.s3control#Exclude": { "type": "structure", "members": { "Buckets": { "target": "com.amazonaws.s3control#Buckets", "traits": { "smithy.api#documentation": "A container for the S3 Storage Lens bucket excludes.
" } }, "Regions": { "target": "com.amazonaws.s3control#Regions", "traits": { "smithy.api#documentation": "A container for the S3 Storage Lens Region excludes.
" } } }, "traits": { "smithy.api#documentation": "A container for what Amazon S3 Storage Lens will exclude.
" } }, "com.amazonaws.s3control#ExistingObjectReplication": { "type": "structure", "members": { "Status": { "target": "com.amazonaws.s3control#ExistingObjectReplicationStatus", "traits": { "smithy.api#documentation": "Specifies whether Amazon S3 replicates existing source bucket objects.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "An optional configuration to replicate existing source bucket objects.
\nThis is not supported by Amazon S3 on Outposts buckets.
\nSpecifies the use of SSE-S3 to encrypt generated manifest objects.
", "smithy.api#xmlName": "SSE-S3" } }, "SSEKMS": { "target": "com.amazonaws.s3control#SSEKMSEncryption", "traits": { "smithy.api#documentation": "Configuration details on how SSE-KMS is used to encrypt generated manifest\n objects.
", "smithy.api#xmlName": "SSE-KMS" } } }, "traits": { "smithy.api#documentation": "The encryption configuration to use when storing the generated manifest.
" } }, "com.amazonaws.s3control#GeneratedManifestFormat": { "type": "enum", "members": { "S3InventoryReport_CSV_20211130": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "S3InventoryReport_CSV_20211130" } } } }, "com.amazonaws.s3control#GetAccessGrant": { "type": "operation", "input": { "target": "com.amazonaws.s3control#GetAccessGrantRequest" }, "output": { "target": "com.amazonaws.s3control#GetAccessGrantResult" }, "traits": { "smithy.api#documentation": "Get the details of an access grant from your S3 Access Grants instance.
\nYou must have the s3:GetAccessGrant permission to use this operation.
The Amazon Web Services account ID of the S3 Access Grants instance.
", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "AccountId" } } }, "AccessGrantId": { "target": "com.amazonaws.s3control#AccessGrantId", "traits": { "smithy.api#documentation": "The ID of the access grant. S3 Access Grants auto-generates this ID when you create the access grant.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.s3control#GetAccessGrantResult": { "type": "structure", "members": { "CreatedAt": { "target": "com.amazonaws.s3control#CreationTimestamp", "traits": { "smithy.api#documentation": "The date and time when you created the access grant.
" } }, "AccessGrantId": { "target": "com.amazonaws.s3control#AccessGrantId", "traits": { "smithy.api#documentation": "The ID of the access grant. S3 Access Grants auto-generates this ID when you create the access grant.
" } }, "AccessGrantArn": { "target": "com.amazonaws.s3control#AccessGrantArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the access grant.
" } }, "Grantee": { "target": "com.amazonaws.s3control#Grantee", "traits": { "smithy.api#documentation": "The user, group, or role to which you are granting access. You can grant access to an IAM user or role. If you have added a corporate directory to Amazon Web Services IAM Identity Center and associated this Identity Center instance with the S3 Access Grants instance, the grantee can also be a corporate directory user or group.
" } }, "Permission": { "target": "com.amazonaws.s3control#Permission", "traits": { "smithy.api#documentation": "The type of permission that was granted in the access grant. Can be one of the following values:
\n\n READ \u2013 Grant read-only access to the S3 data.
\n WRITE \u2013 Grant write-only access to the S3 data.
\n READWRITE \u2013 Grant both read and write access to the S3 data.
The ID of the registered location to which you are granting access. S3 Access Grants assigns this ID when you register the location. S3 Access Grants assigns the ID default to the default location s3:// and assigns an auto-generated ID to other locations that you register.
The configuration options of the grant location. The grant location is the S3 path to the data to which you are granting access.
" } }, "GrantScope": { "target": "com.amazonaws.s3control#S3Prefix", "traits": { "smithy.api#documentation": "The S3 path of the data to which you are granting access. It is the result of appending the Subprefix to the location scope.
The Amazon Resource Name (ARN) of an Amazon Web Services IAM Identity Center application associated with your Identity Center instance. If the grant includes an application ARN, the grantee can only access the S3 data through this application.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.s3control#GetAccessGrantsInstance": { "type": "operation", "input": { "target": "com.amazonaws.s3control#GetAccessGrantsInstanceRequest" }, "output": { "target": "com.amazonaws.s3control#GetAccessGrantsInstanceResult" }, "traits": { "smithy.api#documentation": "Retrieves the S3 Access Grants instance for a Region in your account.
\nYou must have the s3:GetAccessGrantsInstance permission to use this operation.
\n GetAccessGrantsInstance is not supported for cross-account access. You can only call the API from the account that owns the S3 Access Grants instance.
Retrieve the S3 Access Grants instance that contains a particular prefix.
\nYou must have the s3:GetAccessGrantsInstanceForPrefix permission for the caller account to use this operation.
The prefix owner account must grant you the following permissions to their S3 Access Grants instance: s3:GetAccessGrantsInstanceForPrefix.
The ID of the Amazon Web Services account that is making this request.
", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "AccountId" } } }, "S3Prefix": { "target": "com.amazonaws.s3control#S3Prefix", "traits": { "smithy.api#documentation": "The S3 prefix of the access grants that you would like to retrieve.
", "smithy.api#httpQuery": "s3prefix", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.s3control#GetAccessGrantsInstanceForPrefixResult": { "type": "structure", "members": { "AccessGrantsInstanceArn": { "target": "com.amazonaws.s3control#AccessGrantsInstanceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the S3 Access Grants instance.
" } }, "AccessGrantsInstanceId": { "target": "com.amazonaws.s3control#AccessGrantsInstanceId", "traits": { "smithy.api#documentation": "The ID of the S3 Access Grants instance. The ID is default. You can have one S3 Access Grants instance per Region per account.
The Amazon Web Services account ID of the S3 Access Grants instance.
", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "AccountId" } } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.s3control#GetAccessGrantsInstanceResourcePolicy": { "type": "operation", "input": { "target": "com.amazonaws.s3control#GetAccessGrantsInstanceResourcePolicyRequest" }, "output": { "target": "com.amazonaws.s3control#GetAccessGrantsInstanceResourcePolicyResult" }, "traits": { "smithy.api#documentation": "Returns the resource policy of the S3 Access Grants instance.
\nYou must have the s3:GetAccessGrantsInstanceResourcePolicy permission to use this operation.
The Amazon Web Services account ID of the S3 Access Grants instance.
", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "AccountId" } } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.s3control#GetAccessGrantsInstanceResourcePolicyResult": { "type": "structure", "members": { "Policy": { "target": "com.amazonaws.s3control#PolicyDocument", "traits": { "smithy.api#documentation": "The resource policy of the S3 Access Grants instance.
" } }, "Organization": { "target": "com.amazonaws.s3control#Organization", "traits": { "smithy.api#documentation": "The Organization of the resource policy of the S3 Access Grants instance.
" } }, "CreatedAt": { "target": "com.amazonaws.s3control#CreationTimestamp", "traits": { "smithy.api#documentation": "The date and time when you created the S3 Access Grants instance resource policy.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.s3control#GetAccessGrantsInstanceResult": { "type": "structure", "members": { "AccessGrantsInstanceArn": { "target": "com.amazonaws.s3control#AccessGrantsInstanceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the S3 Access Grants instance.
" } }, "AccessGrantsInstanceId": { "target": "com.amazonaws.s3control#AccessGrantsInstanceId", "traits": { "smithy.api#documentation": "The ID of the S3 Access Grants instance. The ID is default. You can have one S3 Access Grants instance per Region per account.
If you associated your S3 Access Grants instance with an Amazon Web Services IAM Identity Center instance, this field returns the Amazon Resource Name (ARN) of the IAM Identity Center instance application; a subresource of the original Identity Center instance. S3 Access Grants creates this Identity Center application for the specific S3 Access Grants instance.
" } }, "IdentityCenterInstanceArn": { "target": "com.amazonaws.s3control#IdentityCenterArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Web Services IAM Identity Center instance that you are associating with your S3 Access Grants instance. An IAM Identity Center instance is your corporate identity directory that you added to the IAM Identity Center. You can use the ListInstances API operation to retrieve a list of your Identity Center instances and their ARNs.
" } }, "IdentityCenterApplicationArn": { "target": "com.amazonaws.s3control#IdentityCenterApplicationArn", "traits": { "smithy.api#documentation": "If you associated your S3 Access Grants instance with an Amazon Web Services IAM Identity Center instance, this field returns the Amazon Resource Name (ARN) of the IAM Identity Center instance application; a subresource of the original Identity Center instance. S3 Access Grants creates this Identity Center application for the specific S3 Access Grants instance.
" } }, "CreatedAt": { "target": "com.amazonaws.s3control#CreationTimestamp", "traits": { "smithy.api#documentation": "The date and time when you created the S3 Access Grants instance.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.s3control#GetAccessGrantsLocation": { "type": "operation", "input": { "target": "com.amazonaws.s3control#GetAccessGrantsLocationRequest" }, "output": { "target": "com.amazonaws.s3control#GetAccessGrantsLocationResult" }, "traits": { "smithy.api#documentation": "Retrieves the details of a particular location registered in your S3 Access Grants instance.
\nYou must have the s3:GetAccessGrantsLocation permission to use this operation.
The Amazon Web Services account ID of the S3 Access Grants instance.
", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "AccountId" } } }, "AccessGrantsLocationId": { "target": "com.amazonaws.s3control#AccessGrantsLocationId", "traits": { "smithy.api#documentation": "The ID of the registered location that you are retrieving. S3 Access Grants assigns this ID when you register the location. S3 Access Grants assigns the ID default to the default location s3:// and assigns an auto-generated ID to other locations that you register.
The date and time when you registered the location.
" } }, "AccessGrantsLocationId": { "target": "com.amazonaws.s3control#AccessGrantsLocationId", "traits": { "smithy.api#documentation": "The ID of the registered location to which you are granting access. S3 Access Grants assigns this ID when you register the location. S3 Access Grants assigns the ID default to the default location s3:// and assigns an auto-generated ID to other locations that you register.
The Amazon Resource Name (ARN) of the registered location.
" } }, "LocationScope": { "target": "com.amazonaws.s3control#S3Prefix", "traits": { "smithy.api#documentation": "The S3 URI path to the registered location. The location scope can be the default S3 location s3://, the S3 path to a bucket, or the S3 path to a bucket and prefix. A prefix in S3 is a string of characters at the beginning of an object key name used to organize the objects that you store in your S3 buckets. For example, object key names that start with the engineering/ prefix or object key names that start with the marketing/campaigns/ prefix.
The Amazon Resource Name (ARN) of the IAM role for the registered location. S3 Access Grants assumes this role to manage access to the registered location.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.s3control#GetAccessPoint": { "type": "operation", "input": { "target": "com.amazonaws.s3control#GetAccessPointRequest" }, "output": { "target": "com.amazonaws.s3control#GetAccessPointResult" }, "traits": { "smithy.api#documentation": "Returns configuration information about the specified access point.
\n \nAll Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.
The following actions are related to GetAccessPoint:
\n CreateAccessPoint\n
\n\n DeleteAccessPoint\n
\n\n ListAccessPoints\n
\nThis operation is not supported by directory buckets.
\nReturns configuration for an Object Lambda Access Point.
\nThe following actions are related to\n GetAccessPointConfigurationForObjectLambda:
The account ID for the account that owns the specified Object Lambda Access Point.
", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "AccountId" } } }, "Name": { "target": "com.amazonaws.s3control#ObjectLambdaAccessPointName", "traits": { "smithy.api#documentation": "The name of the Object Lambda Access Point you want to return the configuration for.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.s3control#GetAccessPointConfigurationForObjectLambdaResult": { "type": "structure", "members": { "Configuration": { "target": "com.amazonaws.s3control#ObjectLambdaConfiguration", "traits": { "smithy.api#documentation": "Object Lambda Access Point configuration document.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.s3control#GetAccessPointForObjectLambda": { "type": "operation", "input": { "target": "com.amazonaws.s3control#GetAccessPointForObjectLambdaRequest" }, "output": { "target": "com.amazonaws.s3control#GetAccessPointForObjectLambdaResult" }, "traits": { "smithy.api#documentation": "This operation is not supported by directory buckets.
\nReturns configuration information about the specified Object Lambda Access Point
\nThe following actions are related to GetAccessPointForObjectLambda:
The account ID for the account that owns the specified Object Lambda Access Point.
", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "AccountId" } } }, "Name": { "target": "com.amazonaws.s3control#ObjectLambdaAccessPointName", "traits": { "smithy.api#documentation": "The name of the Object Lambda Access Point.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.s3control#GetAccessPointForObjectLambdaResult": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.s3control#ObjectLambdaAccessPointName", "traits": { "smithy.api#documentation": "The name of the Object Lambda Access Point.
" } }, "PublicAccessBlockConfiguration": { "target": "com.amazonaws.s3control#PublicAccessBlockConfiguration", "traits": { "smithy.api#documentation": "Configuration to block all public access. This setting is turned on and can not be\n edited.
" } }, "CreationDate": { "target": "com.amazonaws.s3control#CreationDate", "traits": { "smithy.api#documentation": "The date and time when the specified Object Lambda Access Point was created.
" } }, "Alias": { "target": "com.amazonaws.s3control#ObjectLambdaAccessPointAlias", "traits": { "smithy.api#documentation": "The alias of the Object Lambda Access Point.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.s3control#GetAccessPointPolicy": { "type": "operation", "input": { "target": "com.amazonaws.s3control#GetAccessPointPolicyRequest" }, "output": { "target": "com.amazonaws.s3control#GetAccessPointPolicyResult" }, "traits": { "smithy.api#documentation": "Returns the access point policy associated with the specified access point.
\nThe following actions are related to GetAccessPointPolicy:
\n PutAccessPointPolicy\n
\nThis operation is not supported by directory buckets.
\nReturns the resource policy for an Object Lambda Access Point.
\nThe following actions are related to\n GetAccessPointPolicyForObjectLambda:
The account ID for the account that owns the specified Object Lambda Access Point.
", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "AccountId" } } }, "Name": { "target": "com.amazonaws.s3control#ObjectLambdaAccessPointName", "traits": { "smithy.api#documentation": "The name of the Object Lambda Access Point.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.s3control#GetAccessPointPolicyForObjectLambdaResult": { "type": "structure", "members": { "Policy": { "target": "com.amazonaws.s3control#ObjectLambdaPolicy", "traits": { "smithy.api#documentation": "Object Lambda Access Point resource policy document.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.s3control#GetAccessPointPolicyRequest": { "type": "structure", "members": { "AccountId": { "target": "com.amazonaws.s3control#AccountId", "traits": { "smithy.api#documentation": "The account ID for the account that owns the specified access point.
", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "AccountId" } } }, "Name": { "target": "com.amazonaws.s3control#AccessPointName", "traits": { "smithy.api#documentation": "The name of the access point whose policy you want to retrieve.
\nFor using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.
\nFor using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the access point accessed in the format arn:aws:s3-outposts:. For example, to access the access point reports-ap through Outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap. The value must be URL encoded.
The access point policy associated with the specified access point.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.s3control#GetAccessPointPolicyStatus": { "type": "operation", "input": { "target": "com.amazonaws.s3control#GetAccessPointPolicyStatusRequest" }, "output": { "target": "com.amazonaws.s3control#GetAccessPointPolicyStatusResult" }, "traits": { "smithy.api#documentation": "This operation is not supported by directory buckets.
\nIndicates whether the specified access point currently has a policy that allows public access.\n For more information about public access through access points, see Managing Data Access with Amazon S3\n access points in the Amazon S3 User Guide.
", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, "smithy.api#http": { "method": "GET", "uri": "/v20180820/accesspoint/{Name}/policyStatus", "code": 200 }, "smithy.rules#staticContextParams": { "RequiresAccountId": { "value": true } } } }, "com.amazonaws.s3control#GetAccessPointPolicyStatusForObjectLambda": { "type": "operation", "input": { "target": "com.amazonaws.s3control#GetAccessPointPolicyStatusForObjectLambdaRequest" }, "output": { "target": "com.amazonaws.s3control#GetAccessPointPolicyStatusForObjectLambdaResult" }, "traits": { "smithy.api#documentation": "This operation is not supported by directory buckets.
\nReturns the status of the resource policy associated with an Object Lambda Access Point.
", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, "smithy.api#http": { "method": "GET", "uri": "/v20180820/accesspointforobjectlambda/{Name}/policyStatus", "code": 200 }, "smithy.rules#staticContextParams": { "RequiresAccountId": { "value": true } } } }, "com.amazonaws.s3control#GetAccessPointPolicyStatusForObjectLambdaRequest": { "type": "structure", "members": { "AccountId": { "target": "com.amazonaws.s3control#AccountId", "traits": { "smithy.api#documentation": "The account ID for the account that owns the specified Object Lambda Access Point.
", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "AccountId" } } }, "Name": { "target": "com.amazonaws.s3control#ObjectLambdaAccessPointName", "traits": { "smithy.api#documentation": "The name of the Object Lambda Access Point.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.s3control#GetAccessPointPolicyStatusForObjectLambdaResult": { "type": "structure", "members": { "PolicyStatus": { "target": "com.amazonaws.s3control#PolicyStatus" } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.s3control#GetAccessPointPolicyStatusRequest": { "type": "structure", "members": { "AccountId": { "target": "com.amazonaws.s3control#AccountId", "traits": { "smithy.api#documentation": "The account ID for the account that owns the specified access point.
", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "AccountId" } } }, "Name": { "target": "com.amazonaws.s3control#AccessPointName", "traits": { "smithy.api#documentation": "The name of the access point whose policy status you want to retrieve.
", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "AccessPointName" } } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.s3control#GetAccessPointPolicyStatusResult": { "type": "structure", "members": { "PolicyStatus": { "target": "com.amazonaws.s3control#PolicyStatus", "traits": { "smithy.api#documentation": "Indicates the current policy status of the specified access point.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.s3control#GetAccessPointRequest": { "type": "structure", "members": { "AccountId": { "target": "com.amazonaws.s3control#AccountId", "traits": { "smithy.api#documentation": "The Amazon Web Services account ID for the account that owns the specified access point.
", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "AccountId" } } }, "Name": { "target": "com.amazonaws.s3control#AccessPointName", "traits": { "smithy.api#documentation": "The name of the access point whose configuration information you want to retrieve.
\nFor using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.
\nFor using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the access point accessed in the format arn:aws:s3-outposts:. For example, to access the access point reports-ap through Outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap. The value must be URL encoded.
The name of the specified access point.
" } }, "Bucket": { "target": "com.amazonaws.s3control#AccessPointBucketName", "traits": { "smithy.api#documentation": "The name of the bucket associated with the specified access point.
" } }, "NetworkOrigin": { "target": "com.amazonaws.s3control#NetworkOrigin", "traits": { "smithy.api#documentation": "Indicates whether this access point allows access from the public internet. If\n VpcConfiguration is specified for this access point, then\n NetworkOrigin is VPC, and the access point doesn't allow access from\n the public internet. Otherwise, NetworkOrigin is Internet, and\n the access point allows access from the public internet, subject to the access point and bucket access\n policies.
This will always be true for an Amazon S3 on Outposts access point
" } }, "VpcConfiguration": { "target": "com.amazonaws.s3control#VpcConfiguration", "traits": { "smithy.api#documentation": "Contains the virtual private cloud (VPC) configuration for the specified access point.
\nThis element is empty if this access point is an Amazon S3 on Outposts access point that is used by other\n Amazon Web Services services.
\nThe date and time when the specified access point was created.
" } }, "Alias": { "target": "com.amazonaws.s3control#Alias", "traits": { "smithy.api#documentation": "The name or alias of the access point.
" } }, "AccessPointArn": { "target": "com.amazonaws.s3control#S3AccessPointArn", "traits": { "smithy.api#documentation": "The ARN of the access point.
" } }, "Endpoints": { "target": "com.amazonaws.s3control#Endpoints", "traits": { "smithy.api#documentation": "The VPC endpoint for the access point.
" } }, "BucketAccountId": { "target": "com.amazonaws.s3control#AccountId", "traits": { "smithy.api#documentation": "The Amazon Web Services account ID associated with the S3 bucket associated with this access point.
" } }, "DataSourceId": { "target": "com.amazonaws.s3control#DataSourceId", "traits": { "smithy.api#documentation": "The unique identifier for the data source of the access point.
" } }, "DataSourceType": { "target": "com.amazonaws.s3control#DataSourceType", "traits": { "smithy.api#documentation": "The type of the data source that the access point is attached to.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.s3control#GetAccessPointScope": { "type": "operation", "input": { "target": "com.amazonaws.s3control#GetAccessPointScopeRequest" }, "output": { "target": "com.amazonaws.s3control#GetAccessPointScopeResult" }, "traits": { "smithy.api#documentation": "\n Returns the access point scope for a directory bucket.
\nTo use this operation, you must have the permission to perform the\n s3express:GetAccessPointScope action.
For information about REST API errors, see REST error responses.
", "smithy.api#http": { "method": "GET", "uri": "/v20180820/accesspoint/{Name}/scope", "code": 200 }, "smithy.rules#staticContextParams": { "RequiresAccountId": { "value": true }, "UseS3ExpressControlEndpoint": { "value": true } } } }, "com.amazonaws.s3control#GetAccessPointScopeRequest": { "type": "structure", "members": { "AccountId": { "target": "com.amazonaws.s3control#AccountId", "traits": { "smithy.api#documentation": "\n The Amazon Web Services account ID that owns the access point with the scope that you want to retrieve.\n
", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "AccountId" } } }, "Name": { "target": "com.amazonaws.s3control#AccessPointName", "traits": { "smithy.api#documentation": "The name of the access point with the scope you want to retrieve.
", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "AccessPointName" } } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.s3control#GetAccessPointScopeResult": { "type": "structure", "members": { "Scope": { "target": "com.amazonaws.s3control#Scope", "traits": { "smithy.api#documentation": "The contents of the access point scope.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.s3control#GetBucket": { "type": "operation", "input": { "target": "com.amazonaws.s3control#GetBucketRequest" }, "output": { "target": "com.amazonaws.s3control#GetBucketResult" }, "traits": { "smithy.api#documentation": "Gets an Amazon S3 on Outposts bucket. For more information, see Using Amazon S3 on Outposts in the\n Amazon S3 User Guide.
\nIf you are using an identity other than the root user of the Amazon Web Services account that owns the\n Outposts bucket, the calling identity must have the s3-outposts:GetBucket\n permissions on the specified Outposts bucket and belong to the Outposts bucket owner's\n account in order to use this action. Only users from Outposts bucket owner account with\n the right permissions can perform actions on an Outposts bucket.
If you don't have s3-outposts:GetBucket permissions or you're not using an\n identity that belongs to the bucket owner's account, Amazon S3 returns a 403 Access\n Denied error.
The following actions are related to GetBucket for Amazon S3 on Outposts:
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.
\n PutObject\n
\n\n CreateBucket\n
\n\n DeleteBucket\n
\nThis action gets an Amazon S3 on Outposts bucket's lifecycle configuration. To get an S3\n bucket's lifecycle configuration, see GetBucketLifecycleConfiguration in the Amazon S3 API Reference.\n
\nReturns the lifecycle configuration information set on the Outposts bucket. For more\n information, see Using Amazon S3 on Outposts and for\n information about lifecycle configuration, see Object Lifecycle\n Management in Amazon S3 User Guide.
\nTo use this action, you must have permission to perform the\n s3-outposts:GetLifecycleConfiguration action. The Outposts bucket owner\n has this permission, by default. The bucket owner can grant this permission to others. For\n more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing\n Access Permissions to Your Amazon S3 Resources.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.
\n GetBucketLifecycleConfiguration has the following special error:
Error code: NoSuchLifecycleConfiguration\n
Description: The lifecycle configuration does not exist.
\nHTTP Status Code: 404 Not Found
\nSOAP Fault Code Prefix: Client
\nThe following actions are related to\n GetBucketLifecycleConfiguration:
The Amazon Web Services account ID of the Outposts bucket.
", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "AccountId" } } }, "Bucket": { "target": "com.amazonaws.s3control#BucketName", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the bucket.
\nFor using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.
\nFor using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:. For example, to access the bucket reports through Outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.
Container for the lifecycle rule of the Outposts bucket.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.s3control#GetBucketPolicy": { "type": "operation", "input": { "target": "com.amazonaws.s3control#GetBucketPolicyRequest" }, "output": { "target": "com.amazonaws.s3control#GetBucketPolicyResult" }, "traits": { "smithy.api#documentation": "This action gets a bucket policy for an Amazon S3 on Outposts bucket. To get a policy for\n an S3 bucket, see GetBucketPolicy in the\n Amazon S3 API Reference.
\nReturns the policy of a specified Outposts bucket. For more information, see Using\n Amazon S3 on Outposts in the Amazon S3 User Guide.
\nIf you are using an identity other than the root user of the Amazon Web Services account that owns the\n bucket, the calling identity must have the GetBucketPolicy permissions on the\n specified bucket and belong to the bucket owner's account in order to use this\n action.
Only users from Outposts bucket owner account with the right permissions can perform\n actions on an Outposts bucket. If you don't have s3-outposts:GetBucketPolicy\n permissions or you're not using an identity that belongs to the bucket owner's account,\n Amazon S3 returns a 403 Access Denied error.
As a security precaution, the root user of the Amazon Web Services account that owns a bucket can\n always use this action, even if the policy explicitly denies the root user the ability\n to perform this action.
\nFor more information about bucket policies, see Using Bucket Policies and User\n Policies.
\nAll Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.
The following actions are related to GetBucketPolicy:
\n GetObject\n
\n\n PutBucketPolicy\n
\n\n DeleteBucketPolicy\n
\nThe Amazon Web Services account ID of the Outposts bucket.
", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "AccountId" } } }, "Bucket": { "target": "com.amazonaws.s3control#BucketName", "traits": { "smithy.api#documentation": "Specifies the bucket.
\nFor using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.
\nFor using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:. For example, to access the bucket reports through Outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.
The policy of the Outposts bucket.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.s3control#GetBucketReplication": { "type": "operation", "input": { "target": "com.amazonaws.s3control#GetBucketReplicationRequest" }, "output": { "target": "com.amazonaws.s3control#GetBucketReplicationResult" }, "traits": { "smithy.api#documentation": "This operation gets an Amazon S3 on Outposts bucket's replication configuration. To get an\n S3 bucket's replication configuration, see GetBucketReplication\n in the Amazon S3 API Reference.
\nReturns the replication configuration of an S3 on Outposts bucket. For more information\n about S3 on Outposts, see Using Amazon S3 on Outposts in the\n Amazon S3 User Guide. For information about S3 replication on Outposts\n configuration, see Replicating objects for\n S3 on Outposts in the Amazon S3 User Guide.
\nIt can take a while to propagate PUT or DELETE requests for\n a replication configuration to all S3 on Outposts systems. Therefore, the replication\n configuration that's returned by a GET request soon after a\n PUT or DELETE request might return a more recent result\n than what's on the Outpost. If an Outpost is offline, the delay in updating the\n replication configuration on that Outpost can be significant.
This action requires permissions for the\n s3-outposts:GetReplicationConfiguration action. The Outposts bucket owner\n has this permission by default and can grant it to others. For more information about\n permissions, see Setting up IAM with\n S3 on Outposts and Managing access to\n S3 on Outposts bucket in the Amazon S3 User Guide.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.
If you include the Filter element in a replication configuration, you must\n also include the DeleteMarkerReplication, Status, and\n Priority elements. The response also returns those elements.
For information about S3 on Outposts replication failure reasons, see Replication failure reasons in the Amazon S3 User Guide.
\nThe following operations are related to GetBucketReplication:
\n PutBucketReplication\n
\nThe Amazon Web Services account ID of the Outposts bucket.
", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "AccountId" } } }, "Bucket": { "target": "com.amazonaws.s3control#BucketName", "traits": { "smithy.api#documentation": "Specifies the bucket to get the replication information for.
\nFor using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.
\nFor using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:. For example, to access the bucket reports through Outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.
A container for one or more replication rules. A replication configuration must have at\n least one rule and you can add up to 100 rules. The maximum size of a replication\n configuration is 128 KB.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.s3control#GetBucketRequest": { "type": "structure", "members": { "AccountId": { "target": "com.amazonaws.s3control#AccountId", "traits": { "smithy.api#documentation": "The Amazon Web Services account ID of the Outposts bucket.
", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "AccountId" } } }, "Bucket": { "target": "com.amazonaws.s3control#BucketName", "traits": { "smithy.api#documentation": "Specifies the bucket.
\nFor using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.
\nFor using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:. For example, to access the bucket reports through Outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.
The Outposts bucket requested.
" } }, "PublicAccessBlockEnabled": { "target": "com.amazonaws.s3control#PublicAccessBlockEnabled", "traits": { "smithy.api#default": false, "smithy.api#documentation": "" } }, "CreationDate": { "target": "com.amazonaws.s3control#CreationDate", "traits": { "smithy.api#documentation": "The creation date of the Outposts bucket.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.s3control#GetBucketTagging": { "type": "operation", "input": { "target": "com.amazonaws.s3control#GetBucketTaggingRequest" }, "output": { "target": "com.amazonaws.s3control#GetBucketTaggingResult" }, "traits": { "smithy.api#documentation": "This action gets an Amazon S3 on Outposts bucket's tags. To get an S3 bucket tags, see\n GetBucketTagging in the Amazon S3 API Reference.
\nReturns the tag set associated with the Outposts bucket. For more information, see\n Using\n Amazon S3 on Outposts in the Amazon S3 User Guide.
\nTo use this action, you must have permission to perform the\n GetBucketTagging action. By default, the bucket owner has this permission\n and can grant this permission to others.
\n GetBucketTagging has the following special error:
Error code: NoSuchTagSetError\n
Description: There is no tag set associated with the bucket.
\nAll Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.
The following actions are related to GetBucketTagging:
\n PutBucketTagging\n
\n\n DeleteBucketTagging\n
\nThe Amazon Web Services account ID of the Outposts bucket.
", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "AccountId" } } }, "Bucket": { "target": "com.amazonaws.s3control#BucketName", "traits": { "smithy.api#documentation": "Specifies the bucket.
\nFor using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.
\nFor using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:. For example, to access the bucket reports through Outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.
The tags set of the Outposts bucket.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.s3control#GetBucketVersioning": { "type": "operation", "input": { "target": "com.amazonaws.s3control#GetBucketVersioningRequest" }, "output": { "target": "com.amazonaws.s3control#GetBucketVersioningResult" }, "traits": { "smithy.api#documentation": "This operation returns the versioning state\n for\n S3 on Outposts\n buckets\n only. To return the versioning state for an S3 bucket, see GetBucketVersioning in the Amazon S3 API Reference.
\nReturns the versioning state for an S3 on Outposts bucket. With\n S3\n Versioning,\n you can save multiple distinct copies of your\n objects\n and recover from unintended user actions and application failures.
\nIf you've never set versioning on your bucket, it has no versioning state. In that case,\n the GetBucketVersioning request does not return a versioning state\n value.
For more information about versioning, see Versioning in the Amazon S3\n User Guide.
\nAll Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.
The following operations are related to GetBucketVersioning for\n S3 on Outposts.
\n PutBucketVersioning\n
\nThe Amazon Web Services account ID of the S3 on Outposts bucket.
", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "AccountId" } } }, "Bucket": { "target": "com.amazonaws.s3control#BucketName", "traits": { "smithy.api#documentation": "The S3 on Outposts bucket to return the versioning state for.
", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "Bucket" } } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.s3control#GetBucketVersioningResult": { "type": "structure", "members": { "Status": { "target": "com.amazonaws.s3control#BucketVersioningStatus", "traits": { "smithy.api#documentation": "The versioning state of the S3 on Outposts bucket.
" } }, "MFADelete": { "target": "com.amazonaws.s3control#MFADeleteStatus", "traits": { "smithy.api#documentation": "Specifies whether MFA delete is enabled in the bucket versioning configuration. This\n element is returned only if the bucket has been configured with MFA delete. If MFA delete\n has never been configured for the bucket, this element is not returned.
", "smithy.api#xmlName": "MfaDelete" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.s3control#GetDataAccess": { "type": "operation", "input": { "target": "com.amazonaws.s3control#GetDataAccessRequest" }, "output": { "target": "com.amazonaws.s3control#GetDataAccessResult" }, "traits": { "smithy.api#documentation": "Returns a temporary access credential from S3 Access Grants to the grantee or client application. The temporary credential is an Amazon Web Services STS token that grants them access to the S3 data. By default, S3 Access Grants searches for a matching grant in the instance of the Amazon Web Services account ID in the request. To also search instances shared with the caller through Amazon Web Services Resource Access Manager (RAM), set the InstanceScope parameter to ALL.
You must have the s3:GetDataAccess permission to use this operation.
The IAM role that S3 Access Grants assumes must have the following permissions specified in the trust policy when registering the location: sts:AssumeRole, for directory users or groups sts:SetContext, and for IAM users or roles sts:SetSourceIdentity.
The Amazon Web Services account ID of the S3 Access Grants instance.
", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "AccountId" } } }, "Target": { "target": "com.amazonaws.s3control#S3Prefix", "traits": { "smithy.api#documentation": "The S3 URI path of the data to which you are requesting temporary access credentials. If the requesting account has an access grant for this data, S3 Access Grants vends temporary access credentials in the response.
", "smithy.api#httpQuery": "target", "smithy.api#required": {} } }, "Permission": { "target": "com.amazonaws.s3control#Permission", "traits": { "smithy.api#documentation": "The type of permission granted to your S3 data, which can be set to one of the following values:
\n\n READ \u2013 Grant read-only access to the S3 data.
\n WRITE \u2013 Grant write-only access to the S3 data.
\n READWRITE \u2013 Grant both read and write access to the S3 data.
The session duration, in seconds, of the temporary access credential that S3 Access Grants vends to the grantee or client application. The default value is 1 hour, but the grantee can specify a range from 900 seconds (15 minutes) up to 43200 seconds (12 hours). If the grantee requests a value higher than this maximum, the operation fails.
", "smithy.api#httpQuery": "durationSeconds" } }, "Privilege": { "target": "com.amazonaws.s3control#Privilege", "traits": { "smithy.api#documentation": "The scope of the temporary access credential that S3 Access Grants vends to the grantee or client application.
\n\n Default \u2013 The scope of the returned temporary access token is the scope of the grant that is closest to the target scope.
\n Minimal \u2013 The scope of the returned temporary access token is the same as the requested target scope as long as the requested scope is the same as or a subset of the grant scope.
The type of Target. The only possible value is Object. Pass this value if the target data that you would like to access is a path to an object. Do not pass this value if the target data is a bucket or a bucket and a prefix.
The context to identify the job or query associated with the credential request. This information will be displayed in CloudTrail log in your account.
", "smithy.api#httpQuery": "auditContext" } }, "InstanceScope": { "target": "com.amazonaws.s3control#InstanceScope", "traits": { "smithy.api#documentation": "The scope of S3 Access Grants instances to search for a grant matching the requested S3 URI path.
\n\n SELF \u2013 Searches only the instance of the Amazon Web Services account ID in the request.
\n ALL \u2013 Searches the instance of the Amazon Web Services account ID in the request and all instances shared with the caller's account through Amazon Web Services Resource Access Manager (RAM).
The temporary credential token that S3 Access Grants vends.
" } }, "MatchedGrantTarget": { "target": "com.amazonaws.s3control#S3Prefix", "traits": { "smithy.api#documentation": "The S3 URI path of the data to which you are being granted temporary access credentials.
" } }, "Grantee": { "target": "com.amazonaws.s3control#Grantee", "traits": { "smithy.api#documentation": "The user, group, or role that was granted access to the S3 location scope. For directory identities, this API also returns the grants of the IAM role used for the identity-aware request. For more information on identity-aware sessions, see Granting permissions to use identity-aware console sessions.\n
" } }, "MatchedInstanceArn": { "target": "com.amazonaws.s3control#AccessGrantsInstanceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the S3 Access Grants instance containing the grant that matched the requested S3 URI path.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.s3control#GetJobTagging": { "type": "operation", "input": { "target": "com.amazonaws.s3control#GetJobTaggingRequest" }, "output": { "target": "com.amazonaws.s3control#GetJobTaggingResult" }, "errors": [ { "target": "com.amazonaws.s3control#InternalServiceException" }, { "target": "com.amazonaws.s3control#NotFoundException" }, { "target": "com.amazonaws.s3control#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Returns the tags on an S3 Batch Operations job.
\nTo use the\n GetJobTagging operation, you must have permission to\n perform the s3:GetJobTagging action. For more information, see Controlling\n access and labeling jobs using tags in the\n Amazon S3 User Guide.
Related actions include:
\n\n CreateJob\n
\n\n PutJobTagging\n
\n\n DeleteJobTagging\n
\nThe Amazon Web Services account ID associated with the S3 Batch Operations job.
", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "AccountId" } } }, "JobId": { "target": "com.amazonaws.s3control#JobId", "traits": { "smithy.api#documentation": "The ID for the S3 Batch Operations job whose tags you want to retrieve.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.s3control#GetJobTaggingResult": { "type": "structure", "members": { "Tags": { "target": "com.amazonaws.s3control#S3TagSet", "traits": { "smithy.api#documentation": "The set of tags associated with the S3 Batch Operations job.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.s3control#GetMultiRegionAccessPoint": { "type": "operation", "input": { "target": "com.amazonaws.s3control#GetMultiRegionAccessPointRequest" }, "output": { "target": "com.amazonaws.s3control#GetMultiRegionAccessPointResult" }, "traits": { "smithy.api#documentation": "This operation is not supported by directory buckets.
\nReturns configuration information about the specified Multi-Region Access Point.
\nThis action will always be routed to the US West (Oregon) Region. For more information\n about the restrictions around working with Multi-Region Access Points, see Multi-Region Access Point\n restrictions and limitations in the Amazon S3 User Guide.
\nThe following actions are related to GetMultiRegionAccessPoint:
This operation is not supported by directory buckets.
\nReturns the access control policy of the specified Multi-Region Access Point.
\nThis action will always be routed to the US West (Oregon) Region. For more information\n about the restrictions around working with Multi-Region Access Points, see Multi-Region Access Point\n restrictions and limitations in the Amazon S3 User Guide.
\nThe following actions are related to\n GetMultiRegionAccessPointPolicy:
The Amazon Web Services account ID for the owner of the Multi-Region Access Point.
", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "AccountId" } } }, "Name": { "target": "com.amazonaws.s3control#MultiRegionAccessPointName", "traits": { "smithy.api#documentation": "Specifies the Multi-Region Access Point. The name of the Multi-Region Access Point is different from the alias. For more\n information about the distinction between the name and the alias of an Multi-Region Access Point, see Rules for naming Amazon S3 Multi-Region Access Points in the\n Amazon S3 User Guide.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.s3control#GetMultiRegionAccessPointPolicyResult": { "type": "structure", "members": { "Policy": { "target": "com.amazonaws.s3control#MultiRegionAccessPointPolicyDocument", "traits": { "smithy.api#documentation": "The policy associated with the specified Multi-Region Access Point.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.s3control#GetMultiRegionAccessPointPolicyStatus": { "type": "operation", "input": { "target": "com.amazonaws.s3control#GetMultiRegionAccessPointPolicyStatusRequest" }, "output": { "target": "com.amazonaws.s3control#GetMultiRegionAccessPointPolicyStatusResult" }, "traits": { "smithy.api#documentation": "This operation is not supported by directory buckets.
\nIndicates whether the specified Multi-Region Access Point has an access control policy that allows public\n access.
\nThis action will always be routed to the US West (Oregon) Region. For more information\n about the restrictions around working with Multi-Region Access Points, see Multi-Region Access Point\n restrictions and limitations in the Amazon S3 User Guide.
\nThe following actions are related to\n GetMultiRegionAccessPointPolicyStatus:
The Amazon Web Services account ID for the owner of the Multi-Region Access Point.
", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "AccountId" } } }, "Name": { "target": "com.amazonaws.s3control#MultiRegionAccessPointName", "traits": { "smithy.api#documentation": "Specifies the Multi-Region Access Point. The name of the Multi-Region Access Point is different from the alias. For more\n information about the distinction between the name and the alias of an Multi-Region Access Point, see Rules for naming Amazon S3 Multi-Region Access Points in the\n Amazon S3 User Guide.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.s3control#GetMultiRegionAccessPointPolicyStatusResult": { "type": "structure", "members": { "Established": { "target": "com.amazonaws.s3control#PolicyStatus" } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.s3control#GetMultiRegionAccessPointRequest": { "type": "structure", "members": { "AccountId": { "target": "com.amazonaws.s3control#AccountId", "traits": { "smithy.api#documentation": "The Amazon Web Services account ID for the owner of the Multi-Region Access Point.
", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "AccountId" } } }, "Name": { "target": "com.amazonaws.s3control#MultiRegionAccessPointName", "traits": { "smithy.api#documentation": "The name of the Multi-Region Access Point whose configuration information you want to receive. The name of\n the Multi-Region Access Point is different from the alias. For more information about the distinction between\n the name and the alias of an Multi-Region Access Point, see Rules for naming Amazon S3 Multi-Region Access Points in the\n Amazon S3 User Guide.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.s3control#GetMultiRegionAccessPointResult": { "type": "structure", "members": { "AccessPoint": { "target": "com.amazonaws.s3control#MultiRegionAccessPointReport", "traits": { "smithy.api#documentation": "A container element containing the details of the requested Multi-Region Access Point.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.s3control#GetMultiRegionAccessPointRoutes": { "type": "operation", "input": { "target": "com.amazonaws.s3control#GetMultiRegionAccessPointRoutesRequest" }, "output": { "target": "com.amazonaws.s3control#GetMultiRegionAccessPointRoutesResult" }, "traits": { "smithy.api#documentation": "This operation is not supported by directory buckets.
\nReturns the routing configuration for a Multi-Region Access Point, indicating which Regions are active or\n passive.
\nTo obtain routing control changes and failover requests, use the Amazon S3 failover control\n infrastructure endpoints in these five Amazon Web Services Regions:
\n\n us-east-1\n
\n us-west-2\n
\n ap-southeast-2\n
\n ap-northeast-1\n
\n eu-west-1\n
The Amazon Web Services account ID for the owner of the Multi-Region Access Point.
", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "AccountId" } } }, "Mrap": { "target": "com.amazonaws.s3control#MultiRegionAccessPointId", "traits": { "smithy.api#documentation": "The Multi-Region Access Point ARN.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.s3control#GetMultiRegionAccessPointRoutesResult": { "type": "structure", "members": { "Mrap": { "target": "com.amazonaws.s3control#MultiRegionAccessPointId", "traits": { "smithy.api#documentation": "The Multi-Region Access Point ARN.
" } }, "Routes": { "target": "com.amazonaws.s3control#RouteList", "traits": { "smithy.api#documentation": "The different routes that make up the route configuration. Active routes return a value\n of 100, and passive routes return a value of 0.
This operation is not supported by directory buckets.
\nRetrieves the PublicAccessBlock configuration for an Amazon Web Services account. This\n operation returns the effective account-level configuration, which may inherit from\n organization-level policies. For more information, see Using Amazon S3 block\n public access.
Related actions include:
\n\n PutPublicAccessBlock\n
\nThe PublicAccessBlock configuration currently in effect for this\n Amazon Web Services account.
The account ID for the Amazon Web Services account whose PublicAccessBlock configuration\n you want to retrieve.
This operation is not supported by directory buckets.
\nGets the Amazon S3 Storage Lens configuration. For more information, see Assessing your storage\n activity and usage with Amazon S3 Storage Lens in the\n Amazon S3 User Guide. For a complete list of S3 Storage Lens metrics, see S3 Storage Lens metrics glossary in the Amazon S3 User Guide.
\nTo use this action, you must have permission to perform the\n s3:GetStorageLensConfiguration action. For more information, see Setting permissions to use Amazon S3 Storage Lens in the\n Amazon S3 User Guide.
The ID of the Amazon S3 Storage Lens configuration.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "AccountId": { "target": "com.amazonaws.s3control#AccountId", "traits": { "smithy.api#documentation": "The account ID of the requester.
", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "AccountId" } } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.s3control#GetStorageLensConfigurationResult": { "type": "structure", "members": { "StorageLensConfiguration": { "target": "com.amazonaws.s3control#StorageLensConfiguration", "traits": { "smithy.api#documentation": "The S3 Storage Lens configuration requested.
", "smithy.api#httpPayload": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.s3control#GetStorageLensConfigurationTagging": { "type": "operation", "input": { "target": "com.amazonaws.s3control#GetStorageLensConfigurationTaggingRequest" }, "output": { "target": "com.amazonaws.s3control#GetStorageLensConfigurationTaggingResult" }, "traits": { "smithy.api#documentation": "This operation is not supported by directory buckets.
\nGets the tags of Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see\n Assessing your\n storage activity and usage with Amazon S3 Storage Lens in the\n Amazon S3 User Guide.
\nTo use this action, you must have permission to perform the\n s3:GetStorageLensConfigurationTagging action. For more information, see\n Setting permissions to\n use Amazon S3 Storage Lens in the Amazon S3 User Guide.
The ID of the Amazon S3 Storage Lens configuration.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "AccountId": { "target": "com.amazonaws.s3control#AccountId", "traits": { "smithy.api#documentation": "The account ID of the requester.
", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "AccountId" } } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.s3control#GetStorageLensConfigurationTaggingResult": { "type": "structure", "members": { "Tags": { "target": "com.amazonaws.s3control#StorageLensTags", "traits": { "smithy.api#documentation": "The tags of S3 Storage Lens configuration requested.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.s3control#GetStorageLensGroup": { "type": "operation", "input": { "target": "com.amazonaws.s3control#GetStorageLensGroupRequest" }, "output": { "target": "com.amazonaws.s3control#GetStorageLensGroupResult" }, "traits": { "smithy.api#documentation": "\nRetrieves the Storage Lens group configuration details.
\nTo use this operation, you must have the permission to perform the\n s3:GetStorageLensGroup action. For more information about the required Storage Lens\n Groups permissions, see Setting account permissions to use S3 Storage Lens groups.
For information about Storage Lens groups errors, see List of Amazon S3 Storage\n Lens error codes.
", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, "smithy.api#http": { "method": "GET", "uri": "/v20180820/storagelensgroup/{Name}", "code": 200 }, "smithy.rules#staticContextParams": { "RequiresAccountId": { "value": true } } } }, "com.amazonaws.s3control#GetStorageLensGroupRequest": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.s3control#StorageLensGroupName", "traits": { "smithy.api#documentation": "\nThe name of the Storage Lens group that you're trying to retrieve the configuration details for.\n
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "AccountId": { "target": "com.amazonaws.s3control#AccountId", "traits": { "smithy.api#documentation": "\nThe Amazon Web Services account ID associated with the Storage Lens group that you're trying to retrieve the details for.\n
", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "AccountId" } } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.s3control#GetStorageLensGroupResult": { "type": "structure", "members": { "StorageLensGroup": { "target": "com.amazonaws.s3control#StorageLensGroup", "traits": { "smithy.api#documentation": "\nThe name of the Storage Lens group that you're trying to retrieve the configuration details for.\n
", "smithy.api#httpPayload": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.s3control#GrantFullControl": { "type": "string" }, "com.amazonaws.s3control#GrantRead": { "type": "string" }, "com.amazonaws.s3control#GrantReadACP": { "type": "string" }, "com.amazonaws.s3control#GrantWrite": { "type": "string" }, "com.amazonaws.s3control#GrantWriteACP": { "type": "string" }, "com.amazonaws.s3control#Grantee": { "type": "structure", "members": { "GranteeType": { "target": "com.amazonaws.s3control#GranteeType", "traits": { "smithy.api#documentation": "The type of the grantee to which access has been granted. It can be one of the following values:
\n\n IAM - An IAM user or role.
\n DIRECTORY_USER - Your corporate directory user. You can use this option if you have added your corporate identity directory to IAM Identity Center and associated the IAM Identity Center instance with your S3 Access Grants instance.
\n DIRECTORY_GROUP - Your corporate directory group. You can use this option if you have added your corporate identity directory to IAM Identity Center and associated the IAM Identity Center instance with your S3 Access Grants instance.
The unique identifier of the Grantee. If the grantee type is IAM, the identifier is the IAM Amazon Resource Name (ARN) of the user or role. If the grantee type is a directory user or group, the identifier is 128-bit universally unique identifier (UUID) in the format a1b2c3d4-5678-90ab-cdef-EXAMPLE11111. You can obtain this UUID from your Amazon Web Services IAM Identity Center instance.
The user, group, or role to which you are granting access. You can grant access to an IAM user or role. If you have added your corporate directory to Amazon Web Services IAM Identity Center and associated your Identity Center instance with your S3 Access Grants instance, the grantee can also be a corporate directory user or group.
" } }, "com.amazonaws.s3control#GranteeIdentifier": { "type": "string" }, "com.amazonaws.s3control#GranteeType": { "type": "enum", "members": { "DIRECTORY_USER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DIRECTORY_USER" } }, "DIRECTORY_GROUP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DIRECTORY_GROUP" } }, "IAM": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IAM" } } } }, "com.amazonaws.s3control#IAMRoleArn": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2048 }, "smithy.api#pattern": "^arn:[^:]+:iam::\\d{12}:role/" } }, "com.amazonaws.s3control#ID": { "type": "string" }, "com.amazonaws.s3control#IdempotencyException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.s3control#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "", "smithy.api#error": "client" } }, "com.amazonaws.s3control#IdentityCenterApplicationArn": { "type": "string", "traits": { "smithy.api#length": { "min": 10, "max": 1224 }, "smithy.api#pattern": "^arn:[^:]+:sso::\\d{12}:application/.*$" } }, "com.amazonaws.s3control#IdentityCenterArn": { "type": "string", "traits": { "smithy.api#length": { "min": 10, "max": 1224 }, "smithy.api#pattern": "^arn:[^:]+:sso::(\\d{12}){0,1}:instance/.*$" } }, "com.amazonaws.s3control#Include": { "type": "structure", "members": { "Buckets": { "target": "com.amazonaws.s3control#Buckets", "traits": { "smithy.api#documentation": "A container for the S3 Storage Lens bucket includes.
" } }, "Regions": { "target": "com.amazonaws.s3control#Regions", "traits": { "smithy.api#documentation": "A container for the S3 Storage Lens Region includes.
" } } }, "traits": { "smithy.api#documentation": "A container for what Amazon S3 Storage Lens configuration includes.
" } }, "com.amazonaws.s3control#InstanceScope": { "type": "enum", "members": { "SELF": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SELF" } }, "ALL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ALL" } } } }, "com.amazonaws.s3control#IntAccessTiers": { "type": "structure", "members": { "IsEnabled": { "target": "com.amazonaws.s3control#IsEnabled", "traits": { "smithy.api#default": false, "smithy.api#documentation": "A container that indicates whether S3 Storage Lens Intelligent-Tiering access tier metrics are enabled.
" } } }, "traits": { "smithy.api#documentation": "The container for S3 Storage Lens Intelligent-Tiering access tier metrics.\n When enabled, S3 Storage Lens produces metrics for each individual S3 Intelligent-Tiering access tier\n instead of reporting a single aggregate value for the INTELLIGENT_TIERING storage class.
\nFor more information about S3 Storage Lens, see Assessing your storage activity and usage with S3 Storage Lens in the Amazon S3 User Guide. For a complete list of S3 Storage Lens metrics, see S3 Storage Lens metrics glossary in the Amazon S3 User Guide.
" } }, "com.amazonaws.s3control#InternalServiceException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.s3control#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "", "smithy.api#error": "server" } }, "com.amazonaws.s3control#InvalidNextTokenException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.s3control#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "", "smithy.api#error": "client" } }, "com.amazonaws.s3control#InvalidRequestException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.s3control#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "", "smithy.api#error": "client" } }, "com.amazonaws.s3control#IsEnabled": { "type": "boolean", "traits": { "smithy.api#default": false } }, "com.amazonaws.s3control#IsPublic": { "type": "boolean", "traits": { "smithy.api#default": false } }, "com.amazonaws.s3control#JobArn": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1024 }, "smithy.api#pattern": "^arn:[^:]+:s3:[a-zA-Z0-9\\-]+:\\d{12}:job\\/" } }, "com.amazonaws.s3control#JobCreationTime": { "type": "timestamp" }, "com.amazonaws.s3control#JobDescriptor": { "type": "structure", "members": { "JobId": { "target": "com.amazonaws.s3control#JobId", "traits": { "smithy.api#documentation": "The ID for the specified job.
" } }, "ConfirmationRequired": { "target": "com.amazonaws.s3control#ConfirmationRequired", "traits": { "smithy.api#default": null, "smithy.api#documentation": "Indicates whether confirmation is required before Amazon S3 begins running the specified job.\n Confirmation is required only for jobs created through the Amazon S3 console.
" } }, "Description": { "target": "com.amazonaws.s3control#NonEmptyMaxLength256String", "traits": { "smithy.api#documentation": "The description for this job, if one was provided in this job's Create Job\n request.
The Amazon Resource Name (ARN) for this job.
" } }, "Status": { "target": "com.amazonaws.s3control#JobStatus", "traits": { "smithy.api#documentation": "The current status of the specified job.
" } }, "Manifest": { "target": "com.amazonaws.s3control#JobManifest", "traits": { "smithy.api#documentation": "The configuration information for the specified job's manifest object.
" } }, "Operation": { "target": "com.amazonaws.s3control#JobOperation", "traits": { "smithy.api#documentation": "The operation that the specified job is configured to run on the objects listed in the\n manifest.
" } }, "Priority": { "target": "com.amazonaws.s3control#JobPriority", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "The priority of the specified job.
" } }, "ProgressSummary": { "target": "com.amazonaws.s3control#JobProgressSummary", "traits": { "smithy.api#documentation": "Describes the total number of tasks that the specified job has run, the number of tasks\n that succeeded, and the number of tasks that failed.
" } }, "StatusUpdateReason": { "target": "com.amazonaws.s3control#JobStatusUpdateReason", "traits": { "smithy.api#documentation": "The reason for updating the job.
" } }, "FailureReasons": { "target": "com.amazonaws.s3control#JobFailureList", "traits": { "smithy.api#documentation": "If the specified job failed, this field contains information describing the\n failure.
" } }, "Report": { "target": "com.amazonaws.s3control#JobReport", "traits": { "smithy.api#documentation": "Contains the configuration information for the job-completion report if you requested\n one in the Create Job request.
A timestamp indicating when this job was created.
" } }, "TerminationDate": { "target": "com.amazonaws.s3control#JobTerminationDate", "traits": { "smithy.api#documentation": "A timestamp indicating when this job terminated. A job's termination date is the date\n and time when it succeeded, failed, or was canceled.
" } }, "RoleArn": { "target": "com.amazonaws.s3control#IAMRoleArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) for the Identity and Access Management (IAM) role assigned to run the tasks\n for this job.
" } }, "SuspendedDate": { "target": "com.amazonaws.s3control#SuspendedDate", "traits": { "smithy.api#documentation": "The timestamp when this job was suspended, if it has been suspended.
" } }, "SuspendedCause": { "target": "com.amazonaws.s3control#SuspendedCause", "traits": { "smithy.api#documentation": "The reason why the specified job was suspended. A job is only suspended if you create it\n through the Amazon S3 console. When you create the job, it enters the Suspended\n state to await confirmation before running. After you confirm the job, it automatically\n exits the Suspended state.
The manifest generator that was used to generate a job manifest for this job.
" } }, "GeneratedManifestDescriptor": { "target": "com.amazonaws.s3control#S3GeneratedManifestDescriptor", "traits": { "smithy.api#documentation": "The attribute of the JobDescriptor containing details about the job's generated\n manifest.
" } } }, "traits": { "smithy.api#documentation": "A container element for the job configuration and status information returned by a\n Describe Job request.
The failure code, if any, for the specified job.
" } }, "FailureReason": { "target": "com.amazonaws.s3control#JobFailureReason", "traits": { "smithy.api#documentation": "The failure reason, if any, for the specified job.
" } } }, "traits": { "smithy.api#documentation": "If this job failed, this element indicates why the job failed.
" } }, "com.amazonaws.s3control#JobFailureCode": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 } } }, "com.amazonaws.s3control#JobFailureList": { "type": "list", "member": { "target": "com.amazonaws.s3control#JobFailure" } }, "com.amazonaws.s3control#JobFailureReason": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 } } }, "com.amazonaws.s3control#JobId": { "type": "string", "traits": { "smithy.api#length": { "min": 5, "max": 36 }, "smithy.api#pattern": "^[a-zA-Z0-9\\-\\_]+$" } }, "com.amazonaws.s3control#JobListDescriptor": { "type": "structure", "members": { "JobId": { "target": "com.amazonaws.s3control#JobId", "traits": { "smithy.api#documentation": "The ID for the specified job.
" } }, "Description": { "target": "com.amazonaws.s3control#NonEmptyMaxLength256String", "traits": { "smithy.api#documentation": "The user-specified description that was included in the specified job's Create\n Job request.
The operation that the specified job is configured to run on every object listed in the\n manifest.
" } }, "Priority": { "target": "com.amazonaws.s3control#JobPriority", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "The current priority for the specified job.
" } }, "Status": { "target": "com.amazonaws.s3control#JobStatus", "traits": { "smithy.api#documentation": "The specified job's current status.
" } }, "CreationTime": { "target": "com.amazonaws.s3control#JobCreationTime", "traits": { "smithy.api#documentation": "A timestamp indicating when the specified job was created.
" } }, "TerminationDate": { "target": "com.amazonaws.s3control#JobTerminationDate", "traits": { "smithy.api#documentation": "A timestamp indicating when the specified job terminated. A job's termination date is\n the date and time when it succeeded, failed, or was canceled.
" } }, "ProgressSummary": { "target": "com.amazonaws.s3control#JobProgressSummary", "traits": { "smithy.api#documentation": "Describes the total number of tasks that the specified job has run, the number of tasks\n that succeeded, and the number of tasks that failed.
" } } }, "traits": { "smithy.api#documentation": "Contains the configuration and status information for a single job retrieved as part of\n a job list.
" } }, "com.amazonaws.s3control#JobListDescriptorList": { "type": "list", "member": { "target": "com.amazonaws.s3control#JobListDescriptor" } }, "com.amazonaws.s3control#JobManifest": { "type": "structure", "members": { "Spec": { "target": "com.amazonaws.s3control#JobManifestSpec", "traits": { "smithy.api#documentation": "Describes the format of the specified job's manifest. If the manifest is in CSV format,\n also describes the columns contained within the manifest.
", "smithy.api#required": {} } }, "Location": { "target": "com.amazonaws.s3control#JobManifestLocation", "traits": { "smithy.api#documentation": "Contains the information required to locate the specified job's manifest. Manifests\n can't be imported from directory buckets. For more information, see Directory buckets.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Contains the configuration information for a job's manifest.
" } }, "com.amazonaws.s3control#JobManifestFieldList": { "type": "list", "member": { "target": "com.amazonaws.s3control#JobManifestFieldName" } }, "com.amazonaws.s3control#JobManifestFieldName": { "type": "enum", "members": { "Ignore": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Ignore" } }, "Bucket": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Bucket" } }, "Key": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Key" } }, "VersionId": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "VersionId" } } } }, "com.amazonaws.s3control#JobManifestFormat": { "type": "enum", "members": { "S3BatchOperations_CSV_20180820": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "S3BatchOperations_CSV_20180820" } }, "S3InventoryReport_CSV_20161130": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "S3InventoryReport_CSV_20161130" } } } }, "com.amazonaws.s3control#JobManifestGenerator": { "type": "union", "members": { "S3JobManifestGenerator": { "target": "com.amazonaws.s3control#S3JobManifestGenerator", "traits": { "smithy.api#documentation": "The S3 job ManifestGenerator's configuration details.
" } } }, "traits": { "smithy.api#documentation": "Configures the type of the job's ManifestGenerator.
" } }, "com.amazonaws.s3control#JobManifestGeneratorFilter": { "type": "structure", "members": { "EligibleForReplication": { "target": "com.amazonaws.s3control#Boolean", "traits": { "smithy.api#default": null, "smithy.api#documentation": "Include objects in the generated manifest only if they are eligible for replication\n according to the Replication configuration on the source bucket.
" } }, "CreatedAfter": { "target": "com.amazonaws.s3control#ObjectCreationTime", "traits": { "smithy.api#documentation": "If provided, the generated manifest includes only source bucket objects that were\n created after this time.
" } }, "CreatedBefore": { "target": "com.amazonaws.s3control#ObjectCreationTime", "traits": { "smithy.api#documentation": "If provided, the generated manifest includes only source bucket objects that were\n created before this time.
" } }, "ObjectReplicationStatuses": { "target": "com.amazonaws.s3control#ReplicationStatusFilterList", "traits": { "smithy.api#documentation": "If provided, the generated manifest includes only source bucket objects that have one of\n the specified Replication statuses.
" } }, "KeyNameConstraint": { "target": "com.amazonaws.s3control#KeyNameConstraint", "traits": { "smithy.api#documentation": "If provided, the generated manifest includes only source bucket objects whose object\n keys match the string constraints specified for MatchAnyPrefix,\n MatchAnySuffix, and MatchAnySubstring.
If provided, the generated manifest includes only source bucket objects whose file size\n is greater than the specified number of bytes.
" } }, "ObjectSizeLessThanBytes": { "target": "com.amazonaws.s3control#ObjectSizeLessThanBytes", "traits": { "smithy.api#default": null, "smithy.api#documentation": "If provided, the generated manifest includes only source bucket objects whose file size\n is less than the specified number of bytes.
" } }, "MatchAnyStorageClass": { "target": "com.amazonaws.s3control#StorageClassList", "traits": { "smithy.api#documentation": "If provided, the generated manifest includes only source bucket objects that are stored\n with the specified storage class.
" } }, "MatchAnyObjectEncryption": { "target": "com.amazonaws.s3control#ObjectEncryptionFilterList", "traits": { "smithy.api#documentation": "If provided, the generated object list includes only source bucket objects with the indicated server-side encryption type (SSE-S3, SSE-KMS, DSSE-KMS, SSE-C, or NOT-SSE).
" } } }, "traits": { "smithy.api#documentation": "The filter used to describe a set of objects for the job's manifest.
" } }, "com.amazonaws.s3control#JobManifestLocation": { "type": "structure", "members": { "ObjectArn": { "target": "com.amazonaws.s3control#S3KeyArnString", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) for a manifest object.
\nWhen you're using XML requests, you must \nreplace special characters (such as carriage returns) in object keys with their equivalent XML entity codes. \nFor more information, see \n XML-related object key constraints in the Amazon S3 User Guide.
\nThe optional version ID to identify a specific version of the manifest object.
" } }, "ETag": { "target": "com.amazonaws.s3control#NonEmptyMaxLength1024String", "traits": { "smithy.api#documentation": "The ETag for the specified manifest object.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Contains the information required to locate a manifest object. Manifests can't be\n imported from directory buckets. For more information, see Directory\n buckets.
" } }, "com.amazonaws.s3control#JobManifestSpec": { "type": "structure", "members": { "Format": { "target": "com.amazonaws.s3control#JobManifestFormat", "traits": { "smithy.api#documentation": "Indicates which of the available formats the specified manifest uses.
", "smithy.api#required": {} } }, "Fields": { "target": "com.amazonaws.s3control#JobManifestFieldList", "traits": { "smithy.api#documentation": "If the specified manifest object is in the S3BatchOperations_CSV_20180820\n format, this element describes which columns contain the required data.
Describes the format of a manifest. If the manifest is in CSV format, also describes the\n columns contained within the manifest.
" } }, "com.amazonaws.s3control#JobNumberOfTasksFailed": { "type": "long", "traits": { "smithy.api#default": 0, "smithy.api#range": { "min": 0 } } }, "com.amazonaws.s3control#JobNumberOfTasksSucceeded": { "type": "long", "traits": { "smithy.api#default": 0, "smithy.api#range": { "min": 0 } } }, "com.amazonaws.s3control#JobOperation": { "type": "structure", "members": { "LambdaInvoke": { "target": "com.amazonaws.s3control#LambdaInvokeOperation", "traits": { "smithy.api#documentation": "Directs the specified job to invoke an Lambda function on every object in the\n manifest.
" } }, "S3PutObjectCopy": { "target": "com.amazonaws.s3control#S3CopyObjectOperation", "traits": { "smithy.api#documentation": "Directs the specified job to run a PUT Copy object call on every object in the\n manifest.
" } }, "S3PutObjectAcl": { "target": "com.amazonaws.s3control#S3SetObjectAclOperation", "traits": { "smithy.api#documentation": "Directs the specified job to run a PutObjectAcl call on every object in the\n manifest.
This functionality is not supported by directory buckets.
\nDirects the specified job to run a PUT Object tagging call on every object in the\n manifest.
\nThis functionality is not supported by directory buckets.
\nDirects the specified job to execute a DELETE Object tagging call on every object in the\n manifest.
\nThis functionality is not supported by directory buckets.
\nDirects the specified job to initiate restore requests for every archived object in the\n manifest.
\nThis functionality is not supported by directory buckets.
\nDirects the specified job to invoke ReplicateObject on every object in the\n job's manifest.
This functionality is not supported by directory buckets.
\nDirects the specified job to compute checksum values for every object in the manifest.
" } }, "S3UpdateObjectEncryption": { "target": "com.amazonaws.s3control#S3UpdateObjectEncryptionOperation", "traits": { "smithy.api#documentation": "Updates the server-side encryption type of an existing encrypted\n object in a general purpose bucket. You can use the UpdateObjectEncryption\n operation to change encrypted objects from server-side encryption with\n Amazon S3 managed keys (SSE-S3) to server-side encryption with Key Management Service (KMS) \n keys (SSE-KMS), or to apply S3 Bucket Keys. You can also use the \n UpdateObjectEncryption operation to change the customer-managed\n KMS key used to encrypt your data so that you can comply with custom \n key-rotation standards.
The operation that you want this job to perform on every object listed in the manifest.\n For more information about the available operations, see Operations in the\n Amazon S3 User Guide.
" } }, "com.amazonaws.s3control#JobPriority": { "type": "integer", "traits": { "smithy.api#default": 0, "smithy.api#range": { "min": 0, "max": 2147483647 } } }, "com.amazonaws.s3control#JobProgressSummary": { "type": "structure", "members": { "TotalNumberOfTasks": { "target": "com.amazonaws.s3control#JobTotalNumberOfTasks", "traits": { "smithy.api#default": null, "smithy.api#documentation": "" } }, "NumberOfTasksSucceeded": { "target": "com.amazonaws.s3control#JobNumberOfTasksSucceeded", "traits": { "smithy.api#default": null, "smithy.api#documentation": "" } }, "NumberOfTasksFailed": { "target": "com.amazonaws.s3control#JobNumberOfTasksFailed", "traits": { "smithy.api#default": null, "smithy.api#documentation": "" } }, "Timers": { "target": "com.amazonaws.s3control#JobTimers", "traits": { "smithy.api#documentation": "The JobTimers attribute of a job's progress summary.
" } } }, "traits": { "smithy.api#documentation": "Describes the total number of tasks that the specified job has started, the number of\n tasks that succeeded, and the number of tasks that failed.
" } }, "com.amazonaws.s3control#JobReport": { "type": "structure", "members": { "Bucket": { "target": "com.amazonaws.s3control#S3BucketArnString", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) for the bucket where specified job-completion report will\n be stored.
\n\n Directory buckets - Directory buckets aren't supported \n as a location for Batch Operations to store job completion reports.
\nThe format of the specified job-completion report.
" } }, "Enabled": { "target": "com.amazonaws.s3control#Boolean", "traits": { "smithy.api#default": false, "smithy.api#documentation": "Indicates whether the specified job will generate a job-completion report.
", "smithy.api#required": {} } }, "Prefix": { "target": "com.amazonaws.s3control#ReportPrefixString", "traits": { "smithy.api#documentation": "An optional prefix to describe where in the specified bucket the job-completion report\n will be stored. Amazon S3 stores the job-completion report at\n .
Indicates whether the job-completion report will include details of all tasks or only\n failed tasks.
" } }, "ExpectedBucketOwner": { "target": "com.amazonaws.s3control#AccountId", "traits": { "smithy.api#documentation": "Lists the Amazon Web Services account ID that owns the target bucket, where the completion report is received.
" } } }, "traits": { "smithy.api#documentation": "Contains the configuration parameters for a job-completion report.
" } }, "com.amazonaws.s3control#JobReportFormat": { "type": "enum", "members": { "Report_CSV_20180820": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Report_CSV_20180820" } } } }, "com.amazonaws.s3control#JobReportScope": { "type": "enum", "members": { "AllTasks": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AllTasks" } }, "FailedTasksOnly": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FailedTasksOnly" } } } }, "com.amazonaws.s3control#JobStatus": { "type": "enum", "members": { "Active": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Active" } }, "Cancelled": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Cancelled" } }, "Cancelling": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Cancelling" } }, "Complete": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Complete" } }, "Completing": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Completing" } }, "Failed": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Failed" } }, "Failing": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Failing" } }, "New": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "New" } }, "Paused": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Paused" } }, "Pausing": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Pausing" } }, "Preparing": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Preparing" } }, "Ready": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Ready" } }, "Suspended": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Suspended" } } } }, "com.amazonaws.s3control#JobStatusException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.s3control#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "", "smithy.api#error": "client" } }, "com.amazonaws.s3control#JobStatusList": { "type": "list", "member": { "target": "com.amazonaws.s3control#JobStatus" } }, "com.amazonaws.s3control#JobStatusUpdateReason": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 } } }, "com.amazonaws.s3control#JobTerminationDate": { "type": "timestamp" }, "com.amazonaws.s3control#JobTimeInStateSeconds": { "type": "long", "traits": { "smithy.api#default": 0, "smithy.api#range": { "min": 0 } } }, "com.amazonaws.s3control#JobTimers": { "type": "structure", "members": { "ElapsedTimeInActiveSeconds": { "target": "com.amazonaws.s3control#JobTimeInStateSeconds", "traits": { "smithy.api#default": null, "smithy.api#documentation": "Indicates the elapsed time in seconds the job has been in the Active job state.
" } } }, "traits": { "smithy.api#documentation": "Provides timing details for the job.
" } }, "com.amazonaws.s3control#JobTotalNumberOfTasks": { "type": "long", "traits": { "smithy.api#default": 0, "smithy.api#range": { "min": 0 } } }, "com.amazonaws.s3control#KeyNameConstraint": { "type": "structure", "members": { "MatchAnyPrefix": { "target": "com.amazonaws.s3control#NonEmptyMaxLength1024StringList", "traits": { "smithy.api#documentation": "If provided, the generated manifest includes objects where the specified string appears\n at the start of the object key string. Each KeyNameConstraint filter accepts an array of strings with a length of 1 string.
" } }, "MatchAnySuffix": { "target": "com.amazonaws.s3control#NonEmptyMaxLength1024StringList", "traits": { "smithy.api#documentation": "If provided, the generated manifest includes objects where the specified string appears\n at the end of the object key string. Each KeyNameConstraint filter accepts an array of strings with a length of 1 string.
" } }, "MatchAnySubstring": { "target": "com.amazonaws.s3control#NonEmptyMaxLength1024StringList", "traits": { "smithy.api#documentation": "If provided, the generated manifest includes objects where the specified string appears\n anywhere within the object key string. Each KeyNameConstraint filter accepts an array of strings with a length of 1 string.
" } } }, "traits": { "smithy.api#documentation": "If provided, the generated manifest includes only source bucket objects whose object\n keys match the string constraints specified for MatchAnyPrefix,\n MatchAnySuffix, and MatchAnySubstring.
The Amazon Resource Name (ARN) for the Lambda function that the specified job will\n invoke on every object in the manifest.
" } }, "InvocationSchemaVersion": { "target": "com.amazonaws.s3control#NonEmptyMaxLength64String", "traits": { "smithy.api#documentation": "Specifies the schema version for the payload that Batch Operations sends when invoking\n an Lambda function. Version 1.0 is the default. Version\n 2.0 is required when you use Batch Operations to invoke Lambda functions that act on directory buckets, or if you need to specify\n UserArguments. For more information, see Automate object processing in Amazon S3 directory buckets with S3 Batch Operations and\n Lambda in the Amazon Web Services Storage Blog.
Ensure that your Lambda function code expects\n InvocationSchemaVersion\n 2.0 and uses bucket name rather than bucket ARN. If the\n InvocationSchemaVersion does not match what your Lambda\n function expects, your function might not work as expected.
\n Directory buckets - To initiate Amazon Web Services Lambda function to perform custom actions on objects in directory buckets, you must specify 2.0.
Key-value pairs that are passed in the payload that Batch Operations sends when invoking\n an Lambda function. You must specify InvocationSchemaVersion\n 2.0 for LambdaInvoke operations that include\n UserArguments. For more information, see Automate object processing in Amazon S3 directory buckets with S3 Batch Operations and\n Lambda in the Amazon Web Services Storage Blog.
Contains the configuration parameters for a Lambda Invoke operation.
A lifecycle rule for individual objects in an Outposts bucket.
" } } }, "traits": { "smithy.api#documentation": "The container for the Outposts bucket lifecycle configuration.
" } }, "com.amazonaws.s3control#LifecycleExpiration": { "type": "structure", "members": { "Date": { "target": "com.amazonaws.s3control#Date", "traits": { "smithy.api#documentation": "Indicates at what date the object is to be deleted. Should be in GMT ISO 8601\n format.
" } }, "Days": { "target": "com.amazonaws.s3control#Days", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "Indicates the lifetime, in days, of the objects that are subject to the rule. The value\n must be a non-zero positive integer.
" } }, "ExpiredObjectDeleteMarker": { "target": "com.amazonaws.s3control#ExpiredObjectDeleteMarker", "traits": { "smithy.api#default": false, "smithy.api#documentation": "Indicates whether Amazon S3 will remove a delete marker with no noncurrent versions. If set\n to true, the delete marker will be expired. If set to false, the policy takes no action.\n This cannot be specified with Days or Date in a Lifecycle Expiration Policy. To learn more about delete markers, see Working with delete markers.
" } } }, "traits": { "smithy.api#documentation": "The container of the Outposts bucket lifecycle expiration.
" } }, "com.amazonaws.s3control#LifecycleRule": { "type": "structure", "members": { "Expiration": { "target": "com.amazonaws.s3control#LifecycleExpiration", "traits": { "smithy.api#documentation": "Specifies the expiration for the lifecycle of the object in the form of date, days and,\n whether the object has a delete marker.
" } }, "ID": { "target": "com.amazonaws.s3control#ID", "traits": { "smithy.api#documentation": "Unique identifier for the rule. The value cannot be longer than 255 characters.
" } }, "Filter": { "target": "com.amazonaws.s3control#LifecycleRuleFilter", "traits": { "smithy.api#documentation": "The container for the filter of lifecycle rule.
" } }, "Status": { "target": "com.amazonaws.s3control#ExpirationStatus", "traits": { "smithy.api#documentation": "If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is not\n currently being applied.
", "smithy.api#required": {} } }, "Transitions": { "target": "com.amazonaws.s3control#TransitionList", "traits": { "smithy.api#documentation": "Specifies when an Amazon S3 object transitions to a specified storage class.
\nThis is not supported by Amazon S3 on Outposts buckets.
\nSpecifies the transition rule for the lifecycle rule that describes when noncurrent\n objects transition to a specific storage class. If your bucket is versioning-enabled (or\n versioning is suspended), you can set this action to request that Amazon S3 transition\n noncurrent object versions to a specific storage class at a set period in the object's\n lifetime.
\nThis is not supported by Amazon S3 on Outposts buckets.
\nThe noncurrent version expiration of the lifecycle rule.
" } }, "AbortIncompleteMultipartUpload": { "target": "com.amazonaws.s3control#AbortIncompleteMultipartUpload", "traits": { "smithy.api#documentation": "Specifies the days since the initiation of an incomplete multipart upload that Amazon S3\n waits before permanently removing all parts of the upload. For more information, see \n Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Configuration in\n the Amazon S3 User Guide.
" } } }, "traits": { "smithy.api#documentation": "The container for the Outposts bucket lifecycle rule.
" } }, "com.amazonaws.s3control#LifecycleRuleAndOperator": { "type": "structure", "members": { "Prefix": { "target": "com.amazonaws.s3control#Prefix", "traits": { "smithy.api#documentation": "Prefix identifying one or more objects to which the rule applies.
" } }, "Tags": { "target": "com.amazonaws.s3control#S3TagSet", "traits": { "smithy.api#documentation": "All of these tags must exist in the object's tag set in order for the rule to\n apply.
" } }, "ObjectSizeGreaterThan": { "target": "com.amazonaws.s3control#ObjectSizeGreaterThanBytes", "traits": { "smithy.api#default": null, "smithy.api#documentation": "The non-inclusive minimum object size for the lifecycle rule. Setting this property to 7 means the rule applies to objects with a size that is greater than 7.
" } }, "ObjectSizeLessThan": { "target": "com.amazonaws.s3control#ObjectSizeLessThanBytes", "traits": { "smithy.api#default": null, "smithy.api#documentation": "The non-inclusive maximum object size for the lifecycle rule. Setting this property to 77 means the rule applies to objects with a size that is less than 77.
" } } }, "traits": { "smithy.api#documentation": "The container for the Outposts bucket lifecycle rule and operator.
" } }, "com.amazonaws.s3control#LifecycleRuleFilter": { "type": "structure", "members": { "Prefix": { "target": "com.amazonaws.s3control#Prefix", "traits": { "smithy.api#documentation": "Prefix identifying one or more objects to which the rule applies.
\nWhen you're using XML requests, you must \nreplace special characters (such as carriage returns) in object keys with their equivalent XML entity codes. \nFor more information, see \n XML-related object key constraints in the Amazon S3 User Guide.
\nThe container for the AND condition for the lifecycle rule.
Minimum object size to which the rule applies.
" } }, "ObjectSizeLessThan": { "target": "com.amazonaws.s3control#ObjectSizeLessThanBytes", "traits": { "smithy.api#default": null, "smithy.api#documentation": "Maximum object size to which the rule applies.
" } } }, "traits": { "smithy.api#documentation": "The container for the filter of the lifecycle rule.
" } }, "com.amazonaws.s3control#LifecycleRules": { "type": "list", "member": { "target": "com.amazonaws.s3control#LifecycleRule", "traits": { "smithy.api#xmlName": "Rule" } } }, "com.amazonaws.s3control#ListAccessGrantEntry": { "type": "structure", "members": { "CreatedAt": { "target": "com.amazonaws.s3control#CreationTimestamp", "traits": { "smithy.api#documentation": "The date and time when you created the S3 Access Grants instance.
" } }, "AccessGrantId": { "target": "com.amazonaws.s3control#AccessGrantId", "traits": { "smithy.api#documentation": "The ID of the access grant. S3 Access Grants auto-generates this ID when you create the access grant.
" } }, "AccessGrantArn": { "target": "com.amazonaws.s3control#AccessGrantArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the access grant.
" } }, "Grantee": { "target": "com.amazonaws.s3control#Grantee", "traits": { "smithy.api#documentation": "The user, group, or role to which you are granting access. You can grant access to an IAM user or role. If you have added your corporate directory to Amazon Web Services IAM Identity Center and associated your Identity Center instance with your S3 Access Grants instance, the grantee can also be a corporate directory user or group.
" } }, "Permission": { "target": "com.amazonaws.s3control#Permission", "traits": { "smithy.api#documentation": "The type of access granted to your S3 data, which can be set to one of the following values:
\n\n READ \u2013 Grant read-only access to the S3 data.
\n WRITE \u2013 Grant write-only access to the S3 data.
\n READWRITE \u2013 Grant both read and write access to the S3 data.
The ID of the registered location to which you are granting access. S3 Access Grants assigns this ID when you register the location. S3 Access Grants assigns the ID default to the default location s3:// and assigns an auto-generated ID to other locations that you register.
The configuration options of the grant location. The grant location is the S3 path to the data to which you are granting access.
" } }, "GrantScope": { "target": "com.amazonaws.s3control#S3Prefix", "traits": { "smithy.api#documentation": "The S3 path of the data to which you are granting access. It is the result of appending the Subprefix to the location scope.
The Amazon Resource Name (ARN) of an Amazon Web Services IAM Identity Center application associated with your Identity Center instance. If the grant includes an application ARN, the grantee can only access the S3 data through this application.
" } } }, "traits": { "smithy.api#documentation": "Information about the access grant.
" } }, "com.amazonaws.s3control#ListAccessGrants": { "type": "operation", "input": { "target": "com.amazonaws.s3control#ListAccessGrantsRequest" }, "output": { "target": "com.amazonaws.s3control#ListAccessGrantsResult" }, "traits": { "smithy.api#documentation": "Returns the list of access grants in your S3 Access Grants instance.
\nYou must have the s3:ListAccessGrants permission to use this operation.
The ID of the S3 Access Grants instance. The ID is default. You can have one S3 Access Grants instance per Region per account.
The Amazon Resource Name (ARN) of the S3 Access Grants instance.
" } }, "CreatedAt": { "target": "com.amazonaws.s3control#CreationTimestamp", "traits": { "smithy.api#documentation": "The date and time when you created the S3 Access Grants instance.
" } }, "IdentityCenterArn": { "target": "com.amazonaws.s3control#IdentityCenterArn", "traits": { "smithy.api#deprecated": { "message": "IdentityCenterArn has been deprecated. Use IdentityCenterInstanceArn or IdentityCenterApplicationArn." }, "smithy.api#documentation": "If you associated your S3 Access Grants instance with an Amazon Web Services IAM Identity Center instance, this field returns the Amazon Resource Name (ARN) of the IAM Identity Center instance application; a subresource of the original Identity Center instance. S3 Access Grants creates this Identity Center application for the specific S3 Access Grants instance.
" } }, "IdentityCenterInstanceArn": { "target": "com.amazonaws.s3control#IdentityCenterArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Web Services IAM Identity Center instance that you are associating with your S3 Access Grants instance. An IAM Identity Center instance is your corporate identity directory that you added to the IAM Identity Center. You can use the ListInstances API operation to retrieve a list of your Identity Center instances and their ARNs.
" } }, "IdentityCenterApplicationArn": { "target": "com.amazonaws.s3control#IdentityCenterApplicationArn", "traits": { "smithy.api#documentation": "If you associated your S3 Access Grants instance with an Amazon Web Services IAM Identity Center instance, this field returns the Amazon Resource Name (ARN) of the IAM Identity Center instance application; a subresource of the original Identity Center instance. S3 Access Grants creates this Identity Center application for the specific S3 Access Grants instance.
" } } }, "traits": { "smithy.api#documentation": "Information about the S3 Access Grants instance.
" } }, "com.amazonaws.s3control#ListAccessGrantsInstances": { "type": "operation", "input": { "target": "com.amazonaws.s3control#ListAccessGrantsInstancesRequest" }, "output": { "target": "com.amazonaws.s3control#ListAccessGrantsInstancesResult" }, "traits": { "smithy.api#documentation": "Returns a list of S3 Access Grants instances. An S3 Access Grants instance serves as a logical grouping for your individual access grants. You can only have one S3 Access Grants instance per Region per account.
\nYou must have the s3:ListAccessGrantsInstances permission to use this operation.
The Amazon Web Services account ID of the S3 Access Grants instance.
", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "AccountId" } } }, "NextToken": { "target": "com.amazonaws.s3control#ContinuationToken", "traits": { "smithy.api#documentation": "A pagination token to request the next page of results. Pass this value into a subsequent List Access Grants Instances request in order to retrieve the next page of results.
The maximum number of access grants that you would like returned in the List Access Grants response. If the results include the pagination token NextToken, make another call using the NextToken to determine if there are more results.
A pagination token to request the next page of results. Pass this value into a subsequent List Access Grants Instances request in order to retrieve the next page of results.
A container for a list of S3 Access Grants instances.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.s3control#ListAccessGrantsLocations": { "type": "operation", "input": { "target": "com.amazonaws.s3control#ListAccessGrantsLocationsRequest" }, "output": { "target": "com.amazonaws.s3control#ListAccessGrantsLocationsResult" }, "traits": { "smithy.api#documentation": "Returns a list of the locations registered in your S3 Access Grants instance.
\nYou must have the s3:ListAccessGrantsLocations permission to use this operation.
The date and time when you registered the location.
" } }, "AccessGrantsLocationId": { "target": "com.amazonaws.s3control#AccessGrantsLocationId", "traits": { "smithy.api#documentation": "The ID of the registered location to which you are granting access. S3 Access Grants assigns this ID when you register the location. S3 Access Grants assigns the ID default to the default location s3:// and assigns an auto-generated ID to other locations that you register.
The Amazon Resource Name (ARN) of the registered location.
" } }, "LocationScope": { "target": "com.amazonaws.s3control#S3Prefix", "traits": { "smithy.api#documentation": "The S3 path to the location that you are registering. The location scope can be the default S3 location s3://, the S3 path to a bucket s3://, or the S3 path to a bucket and prefix s3://. A prefix in S3 is a string of characters at the beginning of an object key name used to organize the objects that you store in your S3 buckets. For example, object key names that start with the engineering/ prefix or object key names that start with the marketing/campaigns/ prefix.
The Amazon Resource Name (ARN) of the IAM role for the registered location. S3 Access Grants assumes this role to manage access to the registered location.
" } } }, "traits": { "smithy.api#documentation": "A container for information about the registered location.
" } }, "com.amazonaws.s3control#ListAccessGrantsLocationsRequest": { "type": "structure", "members": { "AccountId": { "target": "com.amazonaws.s3control#AccountId", "traits": { "smithy.api#documentation": "The Amazon Web Services account ID of the S3 Access Grants instance.
", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "AccountId" } } }, "NextToken": { "target": "com.amazonaws.s3control#ContinuationToken", "traits": { "smithy.api#documentation": "A pagination token to request the next page of results. Pass this value into a subsequent List Access Grants Locations request in order to retrieve the next page of results.
The maximum number of access grants that you would like returned in the List Access Grants response. If the results include the pagination token NextToken, make another call using the NextToken to determine if there are more results.
The S3 path to the location that you are registering. The location scope can be the default S3 location s3://, the S3 path to a bucket s3://, or the S3 path to a bucket and prefix s3://. A prefix in S3 is a string of characters at the beginning of an object key name used to organize the objects that you store in your S3 buckets. For example, object key names that start with the engineering/ prefix or object key names that start with the marketing/campaigns/ prefix.
A pagination token to request the next page of results. Pass this value into a subsequent List Access Grants Locations request in order to retrieve the next page of results.
A container for a list of registered locations in an S3 Access Grants instance.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.s3control#ListAccessGrantsRequest": { "type": "structure", "members": { "AccountId": { "target": "com.amazonaws.s3control#AccountId", "traits": { "smithy.api#documentation": "The Amazon Web Services account ID of the S3 Access Grants instance.
", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "AccountId" } } }, "NextToken": { "target": "com.amazonaws.s3control#ContinuationToken", "traits": { "smithy.api#documentation": "A pagination token to request the next page of results. Pass this value into a subsequent List Access Grants request in order to retrieve the next page of results.
The maximum number of access grants that you would like returned in the List Access Grants response. If the results include the pagination token NextToken, make another call using the NextToken to determine if there are more results.
The type of the grantee to which access has been granted. It can be one of the following values:
\n\n IAM - An IAM user or role.
\n DIRECTORY_USER - Your corporate directory user. You can use this option if you have added your corporate identity directory to IAM Identity Center and associated the IAM Identity Center instance with your S3 Access Grants instance.
\n DIRECTORY_GROUP - Your corporate directory group. You can use this option if you have added your corporate identity directory to IAM Identity Center and associated the IAM Identity Center instance with your S3 Access Grants instance.
The unique identifer of the Grantee. If the grantee type is IAM, the identifier is the IAM Amazon Resource Name (ARN) of the user or role. If the grantee type is a directory user or group, the identifier is 128-bit universally unique identifier (UUID) in the format a1b2c3d4-5678-90ab-cdef-EXAMPLE11111. You can obtain this UUID from your Amazon Web Services IAM Identity Center instance.
The type of permission granted to your S3 data, which can be set to one of the following values:
\n\n READ \u2013 Grant read-only access to the S3 data.
\n WRITE \u2013 Grant write-only access to the S3 data.
\n READWRITE \u2013 Grant both read and write access to the S3 data.
The S3 path of the data to which you are granting access. It is the result of appending the Subprefix to the location scope.
The Amazon Resource Name (ARN) of an Amazon Web Services IAM Identity Center application associated with your Identity Center instance. If the grant includes an application ARN, the grantee can only access the S3 data through this application.
", "smithy.api#httpQuery": "application_arn" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.s3control#ListAccessGrantsResult": { "type": "structure", "members": { "NextToken": { "target": "com.amazonaws.s3control#ContinuationToken", "traits": { "smithy.api#documentation": "A pagination token to request the next page of results. Pass this value into a subsequent List Access Grants request in order to retrieve the next page of results.
A container for a list of grants in an S3 Access Grants instance.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.s3control#ListAccessPoints": { "type": "operation", "input": { "target": "com.amazonaws.s3control#ListAccessPointsRequest" }, "output": { "target": "com.amazonaws.s3control#ListAccessPointsResult" }, "traits": { "smithy.api#documentation": "This operation is not supported by directory buckets.
\nReturns a list of the access points. You can retrieve up to 1,000 access points per call. If the call\n returns more than 1,000 access points (or the number specified in maxResults,\n whichever is less), the response will include a continuation token that you can use to list\n the additional access points.
Returns only access points attached to S3 buckets by default. To return all access points specify\n DataSourceType as ALL.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.
The following actions are related to ListAccessPoints:
\n CreateAccessPoint\n
\n\n DeleteAccessPoint\n
\n\n GetAccessPoint\n
\nReturns a list of the access points that are owned by the Amazon Web Services account and that are associated with the specified directory bucket.
\nTo list access points for general purpose buckets, see ListAccesspoints.
\nTo use this operation, you must have the permission to perform the\n s3express:ListAccessPointsForDirectoryBuckets action.
For information about REST API errors, see REST error responses.
", "smithy.api#http": { "method": "GET", "uri": "/v20180820/accesspointfordirectory", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "AccessPointList", "pageSize": "MaxResults" }, "smithy.rules#staticContextParams": { "RequiresAccountId": { "value": true }, "UseS3ExpressControlEndpoint": { "value": true } } } }, "com.amazonaws.s3control#ListAccessPointsForDirectoryBucketsRequest": { "type": "structure", "members": { "AccountId": { "target": "com.amazonaws.s3control#AccountId", "traits": { "smithy.api#documentation": "The Amazon Web Services account ID that owns the access points.
", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "AccountId" } } }, "DirectoryBucket": { "target": "com.amazonaws.s3control#BucketName", "traits": { "smithy.api#documentation": "The name of the directory bucket associated with the access points you want to list.
", "smithy.api#httpQuery": "directoryBucket" } }, "NextToken": { "target": "com.amazonaws.s3control#NonEmptyMaxLength1024String", "traits": { "smithy.api#documentation": "\n If NextToken is returned, there are more access points available than requested in the maxResults value. The value of NextToken is a\n unique pagination token for each page. Make the call again using the returned token to\n retrieve the next page. Keep all other arguments unchanged. Each pagination token expires\n after 24 hours.\n
The maximum number of access points that you would like returned in the ListAccessPointsForDirectoryBuckets response. If the directory bucket is associated with more than this number of access points, the results include the pagination token NextToken. Make another call using the NextToken to retrieve more results.
Contains identification and configuration information for one or more access points associated with the directory bucket.
" } }, "NextToken": { "target": "com.amazonaws.s3control#NonEmptyMaxLength1024String", "traits": { "smithy.api#documentation": "\n If NextToken is returned, there are more access points available than requested in the maxResults value. The value of NextToken is a\n unique pagination token for each page. Make the call again using the returned token to\n retrieve the next page. Keep all other arguments unchanged. Each pagination token expires\n after 24 hours.\n
This operation is not supported by directory buckets.
\nReturns some or all (up to 1,000) access points associated with the Object Lambda Access Point per call. If there\n are more access points than what can be returned in one call, the response will include a\n continuation token that you can use to list the additional access points.
\nThe following actions are related to\n ListAccessPointsForObjectLambda:
The account ID for the account that owns the specified Object Lambda Access Point.
", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "AccountId" } } }, "NextToken": { "target": "com.amazonaws.s3control#NonEmptyMaxLength1024String", "traits": { "smithy.api#documentation": "If the list has more access points than can be returned in one call to this API, this field\n contains a continuation token that you can provide in subsequent calls to this API to\n retrieve additional access points.
", "smithy.api#httpQuery": "nextToken" } }, "MaxResults": { "target": "com.amazonaws.s3control#MaxResults", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "The maximum number of access points that you want to include in the list. The response may\n contain fewer access points but will never contain more. If there are more than this number of\n access points, then the response will include a continuation token in the NextToken\n field that you can use to retrieve the next page of access points.
Returns list of Object Lambda Access Points.
" } }, "NextToken": { "target": "com.amazonaws.s3control#NonEmptyMaxLength1024String", "traits": { "smithy.api#documentation": "If the list has more access points than can be returned in one call to this API, this field\n contains a continuation token that you can provide in subsequent calls to this API to\n retrieve additional access points.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.s3control#ListAccessPointsRequest": { "type": "structure", "members": { "AccountId": { "target": "com.amazonaws.s3control#AccountId", "traits": { "smithy.api#documentation": "The Amazon Web Services account ID for the account that owns the specified access points.
", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "AccountId" } } }, "Bucket": { "target": "com.amazonaws.s3control#BucketName", "traits": { "smithy.api#documentation": "The name of the bucket whose associated access points you want to list.
\nFor using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.
\nFor using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:. For example, to access the bucket reports through Outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.
A continuation token. If a previous call to ListAccessPoints returned a\n continuation token in the NextToken field, then providing that value here\n causes Amazon S3 to retrieve the next page of results.
The maximum number of access points that you want to include in the list. If the specified\n bucket has more than this number of access points, then the response will include a continuation\n token in the NextToken field that you can use to retrieve the next page of\n access points.
The unique identifier for the data source of the access point.
", "smithy.api#httpQuery": "dataSourceId" } }, "DataSourceType": { "target": "com.amazonaws.s3control#DataSourceType", "traits": { "smithy.api#documentation": "The type of the data source that the access point is attached to. Returns only access points attached to S3 buckets by default. To return all access points specify\n DataSourceType as ALL.
Contains identification and configuration information for one or more access points associated\n with the specified bucket.
" } }, "NextToken": { "target": "com.amazonaws.s3control#NonEmptyMaxLength1024String", "traits": { "smithy.api#documentation": "If the specified bucket has more access points than can be returned in one call to this API,\n this field contains a continuation token that you can provide in subsequent calls to this\n API to retrieve additional access points.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.s3control#ListCallerAccessGrants": { "type": "operation", "input": { "target": "com.amazonaws.s3control#ListCallerAccessGrantsRequest" }, "output": { "target": "com.amazonaws.s3control#ListCallerAccessGrantsResult" }, "traits": { "smithy.api#documentation": "Use this API to list the access grants that grant the caller access to Amazon S3 data through S3 Access Grants. The caller (grantee) can be an Identity and Access Management (IAM) identity or Amazon Web Services Identity Center corporate directory identity. You must pass the Amazon Web Services account of the S3 data owner (grantor) in the request. By default, S3 Access Grants returns grants from the instance of the Amazon Web Services account ID in the request. To return grants from all instances shared with the caller's account through Amazon Web Services Resource Access Manager (RAM), set the InstanceScope parameter to ALL. You can, optionally, narrow the results by GrantScope, using a fragment of the data's S3 path, and S3 Access Grants will return only the grants with a path that contains the path fragment. You can also pass the AllowedByApplication filter in the request, which returns only the grants authorized for applications, whether the application is the caller's Identity Center application or any other application (ALL). For more information, see List the caller's access grants in the Amazon S3 User Guide.
You must have the s3:ListCallerAccessGrants permission to use this operation.
The type of permission granted, which can be one of the following values:
\n\n READ - Grants read-only access to the S3 data.
\n WRITE - Grants write-only access to the S3 data.
\n READWRITE - Grants both read and write access to the S3 data.
The S3 path of the data to which you have been granted access.
" } }, "ApplicationArn": { "target": "com.amazonaws.s3control#IdentityCenterApplicationArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Amazon Web Services IAM Identity Center application associated with your Identity Center instance. If the grant includes an application ARN, the grantee can only access the S3 data through this application.
" } }, "AccessGrantsInstanceArn": { "target": "com.amazonaws.s3control#AccessGrantsInstanceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the S3 Access Grants instance in which the grant was created.
" } } }, "traits": { "smithy.api#documentation": "Part of ListCallerAccessGrantsResult. Each entry includes the\n permission level (READ, WRITE, or READWRITE) and the grant scope of the access grant. Each entry also includes the ARN of the S3 Access Grants instance in which the grant was created. If the grant also includes an application ARN, the grantee can only access the S3 data through this application.
The Amazon Web Services account ID of the S3 Access Grants instance.
", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "AccountId" } } }, "GrantScope": { "target": "com.amazonaws.s3control#S3Prefix", "traits": { "smithy.api#documentation": "The S3 path of the data that you would like to access. Must start with s3://. You can optionally pass only the beginning characters of a path, and S3 Access Grants will search for all applicable grants for the path fragment.
A pagination token to request the next page of results. Pass this value into a subsequent List Caller Access Grants request in order to retrieve the next page of results.
The maximum number of access grants that you would like returned in the List Caller Access Grants response. If the results include the pagination token NextToken, make another call using the NextToken to determine if there are more results.
If this optional parameter is passed in the request, a filter is applied to the results. The results will include only the access grants for the caller's Identity Center application or for any other applications (ALL).
The scope of S3 Access Grants instances to list grants from.
\n\n SELF \u2013 Lists grants from the instance of the Amazon Web Services account ID in the request.
\n ALL \u2013 Lists grants from the instance of the Amazon Web Services account ID in the request and all instances shared with the caller's account through Amazon Web Services Resource Access Manager (RAM).
A pagination token that you can use to request the next page of results. Pass this value into a subsequent List Caller Access Grants request in order to retrieve the next page of results.
A list of the caller's access grants that were created using S3 Access Grants and that grant the caller access to the S3 data of the Amazon Web Services account ID that was specified in the request.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.s3control#ListJobs": { "type": "operation", "input": { "target": "com.amazonaws.s3control#ListJobsRequest" }, "output": { "target": "com.amazonaws.s3control#ListJobsResult" }, "errors": [ { "target": "com.amazonaws.s3control#InternalServiceException" }, { "target": "com.amazonaws.s3control#InvalidNextTokenException" }, { "target": "com.amazonaws.s3control#InvalidRequestException" } ], "traits": { "smithy.api#documentation": "Lists current S3 Batch Operations jobs as well as the jobs that have ended within the last 90\n days for the Amazon Web Services account making the request. For more information, see S3 Batch Operations in the Amazon S3 User Guide.
\nTo use the\n ListJobs operation, you must have permission to\n perform the s3:ListJobs action.
Related actions include:
\n \n\n CreateJob\n
\n\n DescribeJob\n
\n\n UpdateJobPriority\n
\n\n UpdateJobStatus\n
\nThe Amazon Web Services account ID associated with the S3 Batch Operations job.
", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "AccountId" } } }, "JobStatuses": { "target": "com.amazonaws.s3control#JobStatusList", "traits": { "smithy.api#documentation": "The List Jobs request returns jobs that match the statuses listed in this\n element.
A pagination token to request the next page of results. Use the token that Amazon S3 returned\n in the NextToken element of the ListJobsResult from the previous\n List Jobs request.
The maximum number of jobs that Amazon S3 will include in the List Jobs\n response. If there are more jobs than this number, the response will include a pagination\n token in the NextToken field to enable you to retrieve the next page of\n results.
If the List Jobs request produced more than the maximum number of results,\n you can pass this value into a subsequent List Jobs request in order to\n retrieve the next page of results.
The list of current jobs and jobs that have ended within the last 30 days.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.s3control#ListMultiRegionAccessPoints": { "type": "operation", "input": { "target": "com.amazonaws.s3control#ListMultiRegionAccessPointsRequest" }, "output": { "target": "com.amazonaws.s3control#ListMultiRegionAccessPointsResult" }, "traits": { "smithy.api#documentation": "This operation is not supported by directory buckets.
\nReturns a list of the Multi-Region Access Points currently associated with the specified Amazon Web Services account.\n Each call can return up to 100 Multi-Region Access Points, the maximum number of Multi-Region Access Points that can be\n associated with a single account.
\nThis action will always be routed to the US West (Oregon) Region. For more information\n about the restrictions around working with Multi-Region Access Points, see Multi-Region Access Point\n restrictions and limitations in the Amazon S3 User Guide.
\nThe following actions are related to ListMultiRegionAccessPoint:
The Amazon Web Services account ID for the owner of the Multi-Region Access Point.
", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "AccountId" } } }, "NextToken": { "target": "com.amazonaws.s3control#NonEmptyMaxLength1024String", "traits": { "smithy.api#documentation": "Not currently used. Do not use this parameter.
", "smithy.api#httpQuery": "nextToken" } }, "MaxResults": { "target": "com.amazonaws.s3control#MaxResults", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "Not currently used. Do not use this parameter.
", "smithy.api#httpQuery": "maxResults" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.s3control#ListMultiRegionAccessPointsResult": { "type": "structure", "members": { "AccessPoints": { "target": "com.amazonaws.s3control#MultiRegionAccessPointReportList", "traits": { "smithy.api#documentation": "The list of Multi-Region Access Points associated with the user.
" } }, "NextToken": { "target": "com.amazonaws.s3control#NonEmptyMaxLength1024String", "traits": { "smithy.api#documentation": "If the specified bucket has more Multi-Region Access Points than can be returned in one call to this\n action, this field contains a continuation token. You can use this token tin subsequent\n calls to this action to retrieve additional Multi-Region Access Points.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.s3control#ListRegionalBuckets": { "type": "operation", "input": { "target": "com.amazonaws.s3control#ListRegionalBucketsRequest" }, "output": { "target": "com.amazonaws.s3control#ListRegionalBucketsResult" }, "traits": { "smithy.api#documentation": "This operation is not supported by directory buckets.
\nReturns a list of all Outposts buckets in an Outpost that are owned by the authenticated\n sender of the request. For more information, see Using Amazon S3 on Outposts in the\n Amazon S3 User Guide.
\nFor an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts\n endpoint hostname prefix and x-amz-outpost-id in your request, see the Examples section.
The Amazon Web Services account ID of the Outposts bucket.
", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "AccountId" } } }, "NextToken": { "target": "com.amazonaws.s3control#NonEmptyMaxLength1024String", "traits": { "smithy.api#documentation": "", "smithy.api#httpQuery": "nextToken" } }, "MaxResults": { "target": "com.amazonaws.s3control#MaxResults", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "", "smithy.api#httpQuery": "maxResults" } }, "OutpostId": { "target": "com.amazonaws.s3control#NonEmptyMaxLength64String", "traits": { "smithy.api#documentation": "The ID of the Outposts resource.
\nThis ID is required by Amazon S3 on Outposts buckets.
\n\n NextToken is sent when isTruncated is true, which means there\n are more buckets that can be listed. The next list requests to Amazon S3 can be continued with\n this NextToken. NextToken is obfuscated and is not a real\n key.
A container for the S3 Storage Lens configuration ID.
", "smithy.api#required": {} } }, "StorageLensArn": { "target": "com.amazonaws.s3control#StorageLensArn", "traits": { "smithy.api#documentation": "The ARN of the S3 Storage Lens configuration. This property is read-only.
", "smithy.api#required": {} } }, "HomeRegion": { "target": "com.amazonaws.s3control#S3AWSRegion", "traits": { "smithy.api#documentation": "A container for the S3 Storage Lens home Region. Your metrics data is stored and retained in\n your designated S3 Storage Lens home Region.
", "smithy.api#required": {} } }, "IsEnabled": { "target": "com.amazonaws.s3control#IsEnabled", "traits": { "smithy.api#default": false, "smithy.api#documentation": "A container for whether the S3 Storage Lens configuration is enabled. This property is\n required.
" } } }, "traits": { "smithy.api#documentation": "Part of ListStorageLensConfigurationResult. Each entry includes the\n description of the S3 Storage Lens configuration, its home Region, whether it is enabled, its\n Amazon Resource Name (ARN), and config ID.
This operation is not supported by directory buckets.
\nGets a list of Amazon S3 Storage Lens configurations. For more information about S3 Storage Lens, see\n Assessing your\n storage activity and usage with Amazon S3 Storage Lens in the\n Amazon S3 User Guide.
\nTo use this action, you must have permission to perform the\n s3:ListStorageLensConfigurations action. For more information, see\n Setting permissions to\n use Amazon S3 Storage Lens in the Amazon S3 User Guide.
The account ID of the requester.
", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "AccountId" } } }, "NextToken": { "target": "com.amazonaws.s3control#ContinuationToken", "traits": { "smithy.api#documentation": "A pagination token to request the next page of results.
", "smithy.api#httpQuery": "nextToken" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.s3control#ListStorageLensConfigurationsResult": { "type": "structure", "members": { "NextToken": { "target": "com.amazonaws.s3control#ContinuationToken", "traits": { "smithy.api#documentation": "If the request produced more than the maximum number of S3 Storage Lens configuration results,\n you can pass this value into a subsequent request to retrieve the next page of\n results.
" } }, "StorageLensConfigurationList": { "target": "com.amazonaws.s3control#StorageLensConfigurationList", "traits": { "smithy.api#documentation": "A list of S3 Storage Lens configurations.
", "smithy.api#xmlFlattened": {}, "smithy.api#xmlName": "StorageLensConfiguration" } } }, "traits": { "smithy.api#output": {}, "smithy.api#xmlName": "ListStorageLensConfigurationResult" } }, "com.amazonaws.s3control#ListStorageLensGroupEntry": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.s3control#StorageLensGroupName", "traits": { "smithy.api#documentation": "\nContains the name of the Storage Lens group that exists in the specified home Region.\n
", "smithy.api#required": {} } }, "StorageLensGroupArn": { "target": "com.amazonaws.s3control#StorageLensGroupArn", "traits": { "smithy.api#documentation": "\nContains the Amazon Resource Name (ARN) of the Storage Lens group. This property is read-only.\n
", "smithy.api#required": {} } }, "HomeRegion": { "target": "com.amazonaws.s3control#S3AWSRegion", "traits": { "smithy.api#documentation": "\nContains the Amazon Web Services Region where the Storage Lens group was created.\n
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "\nEach entry contains a Storage Lens group that exists in the specified home Region.\n
" } }, "com.amazonaws.s3control#ListStorageLensGroups": { "type": "operation", "input": { "target": "com.amazonaws.s3control#ListStorageLensGroupsRequest" }, "output": { "target": "com.amazonaws.s3control#ListStorageLensGroupsResult" }, "traits": { "smithy.api#documentation": "\nLists all the Storage Lens groups in the specified home Region.\n
\nTo use this operation, you must have the permission to perform the\n s3:ListStorageLensGroups action. For more information about the required Storage Lens\n Groups permissions, see Setting account permissions to use S3 Storage Lens groups.
For information about Storage Lens groups errors, see List of Amazon S3 Storage\n Lens error codes.
", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, "smithy.api#http": { "method": "GET", "uri": "/v20180820/storagelensgroup", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken" }, "smithy.rules#staticContextParams": { "RequiresAccountId": { "value": true } } } }, "com.amazonaws.s3control#ListStorageLensGroupsRequest": { "type": "structure", "members": { "AccountId": { "target": "com.amazonaws.s3control#AccountId", "traits": { "smithy.api#documentation": "\n The Amazon Web Services account ID that owns the Storage Lens groups.\n
", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "AccountId" } } }, "NextToken": { "target": "com.amazonaws.s3control#ContinuationToken", "traits": { "smithy.api#documentation": "The token for the next set of results, or null if there are no more results.\n
\n If NextToken is returned, there are more Storage Lens groups results available. The value of NextToken is a\n unique pagination token for each page. Make the call again using the returned token to\n retrieve the next page. Keep all other arguments unchanged. Each pagination token expires\n after 24 hours.\n
\nThe list of Storage Lens groups that exist in the specified home Region.\n
", "smithy.api#xmlFlattened": {}, "smithy.api#xmlName": "StorageLensGroup" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.s3control#ListTagsForResource": { "type": "operation", "input": { "target": "com.amazonaws.s3control#ListTagsForResourceRequest" }, "output": { "target": "com.amazonaws.s3control#ListTagsForResourceResult" }, "traits": { "smithy.api#documentation": "This operation allows you to list all of the tags for a specified resource. Each tag is a label consisting of a key and value. Tags can help you organize, track costs for, and control access to resources.
\nThis operation is only supported for the following Amazon S3 resources:
\n\n Directory buckets\n
\n\n S3 Access Grants instances, registered locations, and grants.
\nFor general purpose buckets, access points for general purpose buckets, Storage Lens groups, and S3 Access Grants, you must have the s3:ListTagsForResource permission to use this operation.
For directory buckets, you must have the s3express:ListTagsForResource permission to use this operation. For more information about directory buckets policies and permissions, see Identity and Access Management (IAM) for S3 Express One Zone in the Amazon S3 User Guide.
\n Directory buckets - The HTTP Host header syntax is s3express-control.region.amazonaws.com.
For information about S3 Tagging errors, see List of Amazon S3 Tagging error codes.
", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, "smithy.api#http": { "method": "GET", "uri": "/v20180820/tags/{ResourceArn+}", "code": 200 }, "smithy.rules#staticContextParams": { "RequiresAccountId": { "value": true } } } }, "com.amazonaws.s3control#ListTagsForResourceRequest": { "type": "structure", "members": { "AccountId": { "target": "com.amazonaws.s3control#AccountId", "traits": { "smithy.api#documentation": "\nThe Amazon Web Services account ID of the resource owner.\n
", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "AccountId" } } }, "ResourceArn": { "target": "com.amazonaws.s3control#S3ResourceArn", "traits": { "smithy.api#documentation": "\nThe Amazon Resource Name (ARN) of the S3 resource that you want to list tags for. The tagged resource can be a directory bucket, S3 Storage Lens group or S3 Access Grants instance, registered location, or grant.\n
", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "ResourceArn" } } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.s3control#ListTagsForResourceResult": { "type": "structure", "members": { "Tags": { "target": "com.amazonaws.s3control#TagList", "traits": { "smithy.api#documentation": "\nThe Amazon Web Services resource tags that are associated with the resource. \n
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.s3control#Location": { "type": "string" }, "com.amazonaws.s3control#MFA": { "type": "string" }, "com.amazonaws.s3control#MFADelete": { "type": "enum", "members": { "Enabled": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Enabled" } }, "Disabled": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Disabled" } } } }, "com.amazonaws.s3control#MFADeleteStatus": { "type": "enum", "members": { "Enabled": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Enabled" } }, "Disabled": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Disabled" } } } }, "com.amazonaws.s3control#ManifestPrefixString": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 512 } } }, "com.amazonaws.s3control#MatchAnyPrefix": { "type": "list", "member": { "target": "com.amazonaws.s3control#Prefix", "traits": { "smithy.api#xmlName": "Prefix" } } }, "com.amazonaws.s3control#MatchAnySuffix": { "type": "list", "member": { "target": "com.amazonaws.s3control#Suffix", "traits": { "smithy.api#xmlName": "Suffix" } } }, "com.amazonaws.s3control#MatchAnyTag": { "type": "list", "member": { "target": "com.amazonaws.s3control#S3Tag", "traits": { "smithy.api#xmlName": "Tag" } } }, "com.amazonaws.s3control#MatchObjectAge": { "type": "structure", "members": { "DaysGreaterThan": { "target": "com.amazonaws.s3control#ObjectAgeValue", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "\nSpecifies the maximum object age in days. Must be a positive whole number, greater than the minimum object age and less than or equal to 2,147,483,647. \n
" } }, "DaysLessThan": { "target": "com.amazonaws.s3control#ObjectAgeValue", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "\nSpecifies the minimum object age in days. The value must be a positive whole number, greater than 0 and less than or equal to 2,147,483,647.\n
" } } }, "traits": { "smithy.api#documentation": "\n A filter condition that specifies the object age range of included objects in days. Only integers are supported.\n
" } }, "com.amazonaws.s3control#MatchObjectSize": { "type": "structure", "members": { "BytesGreaterThan": { "target": "com.amazonaws.s3control#ObjectSizeValue", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "Specifies the minimum object size in Bytes. The value must be a positive number, greater than\n 0 and less than 50 TB.
" } }, "BytesLessThan": { "target": "com.amazonaws.s3control#ObjectSizeValue", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "Specifies the maximum object size in Bytes. The value must be a positive number, greater than\n the minimum object size and less than 50 TB.
" } } }, "traits": { "smithy.api#documentation": "\nA filter condition that specifies the object size range of included objects in bytes. Only integers are supported.\n
" } }, "com.amazonaws.s3control#MaxLength1024String": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1024 } } }, "com.amazonaws.s3control#MaxResults": { "type": "integer", "traits": { "smithy.api#default": 0, "smithy.api#range": { "min": 0, "max": 1000 } } }, "com.amazonaws.s3control#Metrics": { "type": "structure", "members": { "Status": { "target": "com.amazonaws.s3control#MetricsStatus", "traits": { "smithy.api#documentation": "Specifies whether replication metrics are enabled.
", "smithy.api#required": {} } }, "EventThreshold": { "target": "com.amazonaws.s3control#ReplicationTimeValue", "traits": { "smithy.api#documentation": "A container that specifies the time threshold for emitting the\n s3:Replication:OperationMissedThreshold event.
This is not supported by Amazon S3 on Outposts buckets.
\nA container that specifies replication metrics-related settings.
" } }, "com.amazonaws.s3control#MetricsStatus": { "type": "enum", "members": { "Enabled": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Enabled" } }, "Disabled": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Disabled" } } } }, "com.amazonaws.s3control#MinStorageBytesPercentage": { "type": "double", "traits": { "smithy.api#range": { "min": 1, "max": 100 } } }, "com.amazonaws.s3control#Minutes": { "type": "integer", "traits": { "smithy.api#default": 0 } }, "com.amazonaws.s3control#MultiRegionAccessPointAlias": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 63 }, "smithy.api#pattern": "^[a-z][a-z0-9]*[.]mrap$" } }, "com.amazonaws.s3control#MultiRegionAccessPointClientToken": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 64 }, "smithy.api#pattern": "^\\S+$" } }, "com.amazonaws.s3control#MultiRegionAccessPointId": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 200 }, "smithy.api#pattern": "^[a-zA-Z0-9\\:.-]{3,200}$" } }, "com.amazonaws.s3control#MultiRegionAccessPointName": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 50 }, "smithy.api#pattern": "^[a-z0-9][-a-z0-9]{1,48}[a-z0-9]$" } }, "com.amazonaws.s3control#MultiRegionAccessPointPolicyDocument": { "type": "structure", "members": { "Established": { "target": "com.amazonaws.s3control#EstablishedMultiRegionAccessPointPolicy", "traits": { "smithy.api#documentation": "The last established policy for the Multi-Region Access Point.
" } }, "Proposed": { "target": "com.amazonaws.s3control#ProposedMultiRegionAccessPointPolicy", "traits": { "smithy.api#documentation": "The proposed policy for the Multi-Region Access Point.
" } } }, "traits": { "smithy.api#documentation": "The Multi-Region Access Point access control policy.
\nWhen you update the policy, the update is first listed as the proposed policy. After the\n update is finished and all Regions have been updated, the proposed policy is listed as the\n established policy. If both policies have the same version number, the proposed policy is\n the established policy.
" } }, "com.amazonaws.s3control#MultiRegionAccessPointRegionalResponse": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.s3control#RegionName", "traits": { "smithy.api#documentation": "The name of the Region in the Multi-Region Access Point.
" } }, "RequestStatus": { "target": "com.amazonaws.s3control#AsyncRequestStatus", "traits": { "smithy.api#documentation": "The current status of the Multi-Region Access Point in this Region.
" } } }, "traits": { "smithy.api#documentation": "Status information for a single Multi-Region Access Point Region.
" } }, "com.amazonaws.s3control#MultiRegionAccessPointRegionalResponseList": { "type": "list", "member": { "target": "com.amazonaws.s3control#MultiRegionAccessPointRegionalResponse", "traits": { "smithy.api#xmlName": "Region" } } }, "com.amazonaws.s3control#MultiRegionAccessPointReport": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.s3control#MultiRegionAccessPointName", "traits": { "smithy.api#documentation": "The name of the Multi-Region Access Point.
" } }, "Alias": { "target": "com.amazonaws.s3control#MultiRegionAccessPointAlias", "traits": { "smithy.api#documentation": "The alias for the Multi-Region Access Point. For more information about the distinction between the name\n and the alias of an Multi-Region Access Point, see Rules for naming Amazon S3 Multi-Region Access Points.
" } }, "CreatedAt": { "target": "com.amazonaws.s3control#CreationTimestamp", "traits": { "smithy.api#documentation": "When the Multi-Region Access Point create request was received.
" } }, "PublicAccessBlock": { "target": "com.amazonaws.s3control#PublicAccessBlockConfiguration" }, "Status": { "target": "com.amazonaws.s3control#MultiRegionAccessPointStatus", "traits": { "smithy.api#documentation": "The current status of the Multi-Region Access Point.
\n\n CREATING and DELETING are temporary states that exist while\n the request is propagating and being completed. If a Multi-Region Access Point has a status of\n PARTIALLY_CREATED, you can retry creation or send a request to delete the\n Multi-Region Access Point. If a Multi-Region Access Point has a status of PARTIALLY_DELETED, you can retry a delete\n request to finish the deletion of the Multi-Region Access Point.
A collection of the Regions and buckets associated with the Multi-Region Access Point.
" } } }, "traits": { "smithy.api#documentation": "A collection of statuses for a Multi-Region Access Point in the various Regions it supports.
" } }, "com.amazonaws.s3control#MultiRegionAccessPointReportList": { "type": "list", "member": { "target": "com.amazonaws.s3control#MultiRegionAccessPointReport", "traits": { "smithy.api#xmlName": "AccessPoint" } } }, "com.amazonaws.s3control#MultiRegionAccessPointRoute": { "type": "structure", "members": { "Bucket": { "target": "com.amazonaws.s3control#BucketName", "traits": { "smithy.api#documentation": "The name of the Amazon S3 bucket for which you'll submit a routing configuration change.\n Either the Bucket or the Region value must be provided. If both\n are provided, the bucket must be in the specified Region.
The Amazon Web Services Region to which you'll be submitting a routing configuration change. Either\n the Bucket or the Region value must be provided. If both are\n provided, the bucket must be in the specified Region.
The traffic state for the specified bucket or Amazon Web Services Region.
\nA value of 0 indicates a passive state, which means that no new traffic\n will be routed to the Region.
A value of 100 indicates an active state, which means that traffic will be\n routed to the specified Region.
When the routing configuration for a Region is changed from active to passive, any\n in-progress operations (uploads, copies, deletes, and so on) to the formerly active Region\n will continue to run to until a final success or failure status is reached.
\nIf all Regions in the routing configuration are designated as passive, you'll receive an\n InvalidRequest error.
A structure for a Multi-Region Access Point that indicates where Amazon S3 traffic can be routed. Routes can be\n either active or passive. Active routes can process Amazon S3 requests through the Multi-Region Access Point, but\n passive routes are not eligible to process Amazon S3 requests.
\nEach route contains the Amazon S3 bucket name and the Amazon Web Services Region that the bucket is located\n in. The route also includes the TrafficDialPercentage value, which shows\n whether the bucket and Region are active (indicated by a value of 100) or\n passive (indicated by a value of 0).
A collection of status information for the different Regions that a Multi-Region Access Point\n supports.
" } } }, "traits": { "smithy.api#documentation": "The Multi-Region Access Point details that are returned when querying about an asynchronous request.
" } }, "com.amazonaws.s3control#NetworkOrigin": { "type": "enum", "members": { "Internet": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Internet" } }, "VPC": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "VPC" } } } }, "com.amazonaws.s3control#NoSuchPublicAccessBlockConfiguration": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.s3control#NoSuchPublicAccessBlockConfigurationMessage" } }, "traits": { "smithy.api#documentation": "Amazon S3 throws this exception if you make a GetPublicAccessBlock request\n against an account that doesn't have a PublicAccessBlockConfiguration\n set.
Specifies the number of days an object is noncurrent before Amazon S3 can perform the\n associated action. For information about the noncurrent days calculations, see How\n Amazon S3 Calculates When an Object Became Noncurrent in the\n Amazon S3 User Guide.
" } }, "NewerNoncurrentVersions": { "target": "com.amazonaws.s3control#NoncurrentVersionCount", "traits": { "smithy.api#default": null, "smithy.api#documentation": "Specifies how many noncurrent versions S3 on Outposts will retain. If there are this many\n more recent noncurrent versions, S3 on Outposts will take the associated action. For more\n information about noncurrent versions, see Lifecycle configuration\n elements in the Amazon S3 User Guide.
" } } }, "traits": { "smithy.api#documentation": "The container of the noncurrent version expiration.
" } }, "com.amazonaws.s3control#NoncurrentVersionTransition": { "type": "structure", "members": { "NoncurrentDays": { "target": "com.amazonaws.s3control#Days", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "Specifies the number of days an object is noncurrent before Amazon S3 can perform the\n associated action. For information about the noncurrent days calculations, see How\n Amazon S3 Calculates How Long an Object Has Been Noncurrent in the\n Amazon S3 User Guide.
" } }, "StorageClass": { "target": "com.amazonaws.s3control#TransitionStorageClass", "traits": { "smithy.api#documentation": "The class of storage used to store the object.
" } } }, "traits": { "smithy.api#documentation": "The container for the noncurrent version transition.
" } }, "com.amazonaws.s3control#NoncurrentVersionTransitionList": { "type": "list", "member": { "target": "com.amazonaws.s3control#NoncurrentVersionTransition", "traits": { "smithy.api#xmlName": "NoncurrentVersionTransition" } } }, "com.amazonaws.s3control#NotFoundException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.s3control#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "", "smithy.api#error": "client" } }, "com.amazonaws.s3control#NotSSEFilter": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "A filter that returns objects that aren't server-side encrypted.
" } }, "com.amazonaws.s3control#ObjectAgeValue": { "type": "integer", "traits": { "smithy.api#default": 0 } }, "com.amazonaws.s3control#ObjectCreationTime": { "type": "timestamp" }, "com.amazonaws.s3control#ObjectEncryption": { "type": "structure", "members": { "SSEKMS": { "target": "com.amazonaws.s3control#S3UpdateObjectEncryptionSSEKMS", "traits": { "smithy.api#documentation": "Specifies to update the object encryption type to server-side encryption\n with Key Management Service (KMS) keys (SSE-KMS).
", "smithy.api#xmlName": "SSE-KMS" } } }, "traits": { "smithy.api#documentation": "The updated server-side encryption type for this object. The\n UpdateObjectEncryption operation supports the\n SSE-KMS encryption type.
Valid Values: SSEKMS\n
Filters for objects that are encrypted by server-side encryption with Amazon S3 managed keys (SSE-S3).
", "smithy.api#xmlName": "SSE-S3" } }, "SSEKMS": { "target": "com.amazonaws.s3control#SSEKMSFilter", "traits": { "smithy.api#documentation": "Filters for objects that are encrypted by server-side encryption with Amazon Web Services Key Management Service (KMS) keys (SSE-KMS).
", "smithy.api#xmlName": "SSE-KMS" } }, "DSSEKMS": { "target": "com.amazonaws.s3control#DSSEKMSFilter", "traits": { "smithy.api#documentation": "Filters for objects that are encrypted by dual-layer server-side encryption with Amazon Web Services Key Management Service (KMS) keys (DSSE-KMS).
", "smithy.api#xmlName": "DSSE-KMS" } }, "SSEC": { "target": "com.amazonaws.s3control#SSECFilter", "traits": { "smithy.api#documentation": "Filters for objects that are encrypted by server-side encryption with customer-provided keys (SSE-C).
", "smithy.api#xmlName": "SSE-C" } }, "NOTSSE": { "target": "com.amazonaws.s3control#NotSSEFilter", "traits": { "smithy.api#documentation": "Filters for objects that are not encrypted by server-side encryption.
", "smithy.api#xmlName": "NOT-SSE" } } }, "traits": { "smithy.api#documentation": "An optional filter for the S3JobManifestGenerator that identifies the subset of objects by encryption type.
" } }, "com.amazonaws.s3control#ObjectEncryptionFilterList": { "type": "list", "member": { "target": "com.amazonaws.s3control#ObjectEncryptionFilter", "traits": { "smithy.api#xmlName": "ObjectEncryption" } }, "traits": { "smithy.api#length": { "min": 1, "max": 1 } } }, "com.amazonaws.s3control#ObjectLambdaAccessPoint": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.s3control#ObjectLambdaAccessPointName", "traits": { "smithy.api#documentation": "The name of the Object Lambda Access Point.
", "smithy.api#required": {} } }, "ObjectLambdaAccessPointArn": { "target": "com.amazonaws.s3control#ObjectLambdaAccessPointArn", "traits": { "smithy.api#documentation": "Specifies the ARN for the Object Lambda Access Point.
" } }, "Alias": { "target": "com.amazonaws.s3control#ObjectLambdaAccessPointAlias", "traits": { "smithy.api#documentation": "The alias of the Object Lambda Access Point.
" } } }, "traits": { "smithy.api#documentation": "An access point with an attached Lambda function used to access transformed data from an Amazon S3\n bucket.
" } }, "com.amazonaws.s3control#ObjectLambdaAccessPointAlias": { "type": "structure", "members": { "Value": { "target": "com.amazonaws.s3control#ObjectLambdaAccessPointAliasValue", "traits": { "smithy.api#documentation": "The alias value of the Object Lambda Access Point.
" } }, "Status": { "target": "com.amazonaws.s3control#ObjectLambdaAccessPointAliasStatus", "traits": { "smithy.api#documentation": "The status of the Object Lambda Access Point alias. If the status is PROVISIONING, the Object Lambda Access Point\n is provisioning the alias and the alias is not ready for use yet. If the status is\n READY, the Object Lambda Access Point alias is successfully provisioned and ready for\n use.
The alias of an Object Lambda Access Point. For more information, see How to use a\n bucket-style alias for your S3 bucket Object Lambda Access Point.
" } }, "com.amazonaws.s3control#ObjectLambdaAccessPointAliasStatus": { "type": "enum", "members": { "PROVISIONING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PROVISIONING" } }, "READY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "READY" } } }, "traits": { "smithy.api#length": { "min": 2, "max": 16 } } }, "com.amazonaws.s3control#ObjectLambdaAccessPointAliasValue": { "type": "string", "traits": { "smithy.api#length": { "min": 3, "max": 63 }, "smithy.api#pattern": "^[0-9a-z\\\\-]{3,63}$" } }, "com.amazonaws.s3control#ObjectLambdaAccessPointArn": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2048 }, "smithy.api#pattern": "^arn:[^:]+:s3-object-lambda:[^:]*:\\d{12}:accesspoint/" } }, "com.amazonaws.s3control#ObjectLambdaAccessPointList": { "type": "list", "member": { "target": "com.amazonaws.s3control#ObjectLambdaAccessPoint", "traits": { "smithy.api#xmlName": "ObjectLambdaAccessPoint" } } }, "com.amazonaws.s3control#ObjectLambdaAccessPointName": { "type": "string", "traits": { "smithy.api#length": { "min": 3, "max": 45 }, "smithy.api#pattern": "^[a-z0-9]([a-z0-9\\-]*[a-z0-9])?$" } }, "com.amazonaws.s3control#ObjectLambdaAllowedFeature": { "type": "enum", "members": { "GetObjectRange": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "GetObject-Range" } }, "GetObjectPartNumber": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "GetObject-PartNumber" } }, "HeadObjectRange": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "HeadObject-Range" } }, "HeadObjectPartNumber": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "HeadObject-PartNumber" } } } }, "com.amazonaws.s3control#ObjectLambdaAllowedFeaturesList": { "type": "list", "member": { "target": "com.amazonaws.s3control#ObjectLambdaAllowedFeature", "traits": { "smithy.api#xmlName": "AllowedFeature" } } }, "com.amazonaws.s3control#ObjectLambdaConfiguration": { "type": "structure", "members": { "SupportingAccessPoint": { "target": "com.amazonaws.s3control#ObjectLambdaSupportingAccessPointArn", "traits": { "smithy.api#documentation": "Standard access point associated with the Object Lambda Access Point.
", "smithy.api#required": {} } }, "CloudWatchMetricsEnabled": { "target": "com.amazonaws.s3control#Boolean", "traits": { "smithy.api#default": false, "smithy.api#documentation": "A container for whether the CloudWatch metrics configuration is enabled.
" } }, "AllowedFeatures": { "target": "com.amazonaws.s3control#ObjectLambdaAllowedFeaturesList", "traits": { "smithy.api#documentation": "A container for allowed features. Valid inputs are GetObject-Range,\n GetObject-PartNumber, HeadObject-Range, and\n HeadObject-PartNumber.
A container for transformation configurations for an Object Lambda Access Point.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A configuration used when creating an Object Lambda Access Point.
" } }, "com.amazonaws.s3control#ObjectLambdaContentTransformation": { "type": "union", "members": { "AwsLambda": { "target": "com.amazonaws.s3control#AwsLambdaTransformation", "traits": { "smithy.api#documentation": "A container for an Lambda function.
" } } }, "traits": { "smithy.api#documentation": "A container for AwsLambdaTransformation.
" } }, "com.amazonaws.s3control#ObjectLambdaPolicy": { "type": "string" }, "com.amazonaws.s3control#ObjectLambdaSupportingAccessPointArn": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2048 }, "smithy.api#pattern": "^arn:[^:]+:s3:[^:]*:\\d{12}:accesspoint/" } }, "com.amazonaws.s3control#ObjectLambdaTransformationConfiguration": { "type": "structure", "members": { "Actions": { "target": "com.amazonaws.s3control#ObjectLambdaTransformationConfigurationActionsList", "traits": { "smithy.api#documentation": "A container for the action of an Object Lambda Access Point configuration. Valid inputs are\n GetObject, ListObjects, HeadObject, and\n ListObjectsV2.
A container for the content transformation of an Object Lambda Access Point configuration.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A configuration used when creating an Object Lambda Access Point transformation.
" } }, "com.amazonaws.s3control#ObjectLambdaTransformationConfigurationAction": { "type": "enum", "members": { "GetObject": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "GetObject" } }, "HeadObject": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "HeadObject" } }, "ListObjects": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ListObjects" } }, "ListObjectsV2": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ListObjectsV2" } } } }, "com.amazonaws.s3control#ObjectLambdaTransformationConfigurationActionsList": { "type": "list", "member": { "target": "com.amazonaws.s3control#ObjectLambdaTransformationConfigurationAction", "traits": { "smithy.api#xmlName": "Action" } } }, "com.amazonaws.s3control#ObjectLambdaTransformationConfigurationsList": { "type": "list", "member": { "target": "com.amazonaws.s3control#ObjectLambdaTransformationConfiguration", "traits": { "smithy.api#xmlName": "TransformationConfiguration" } } }, "com.amazonaws.s3control#ObjectLockEnabledForBucket": { "type": "boolean", "traits": { "smithy.api#default": false } }, "com.amazonaws.s3control#ObjectSizeGreaterThanBytes": { "type": "long", "traits": { "smithy.api#default": 0 } }, "com.amazonaws.s3control#ObjectSizeLessThanBytes": { "type": "long", "traits": { "smithy.api#default": 0 } }, "com.amazonaws.s3control#ObjectSizeValue": { "type": "long", "traits": { "smithy.api#default": 0 } }, "com.amazonaws.s3control#OperationName": { "type": "enum", "members": { "LambdaInvoke": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LambdaInvoke" } }, "S3PutObjectCopy": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "S3PutObjectCopy" } }, "S3PutObjectAcl": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "S3PutObjectAcl" } }, "S3PutObjectTagging": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "S3PutObjectTagging" } }, "S3DeleteObjectTagging": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "S3DeleteObjectTagging" } }, "S3InitiateRestoreObject": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "S3InitiateRestoreObject" } }, "S3PutObjectLegalHold": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "S3PutObjectLegalHold" } }, "S3PutObjectRetention": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "S3PutObjectRetention" } }, "S3ReplicateObject": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "S3ReplicateObject" } }, "S3ComputeObjectChecksum": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "S3ComputeObjectChecksum" } }, "S3UpdateObjectEncryption": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "S3UpdateObjectEncryption" } } } }, "com.amazonaws.s3control#Organization": { "type": "string", "traits": { "smithy.api#length": { "min": 12, "max": 34 }, "smithy.api#pattern": "^o-[a-z0-9]{10,32}$" } }, "com.amazonaws.s3control#OutputSchemaVersion": { "type": "enum", "members": { "V_1": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "V_1" } } } }, "com.amazonaws.s3control#OwnerOverride": { "type": "enum", "members": { "Destination": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Destination" } } } }, "com.amazonaws.s3control#Permission": { "type": "enum", "members": { "READ": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "READ" } }, "WRITE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "WRITE" } }, "READWRITE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "READWRITE" } } } }, "com.amazonaws.s3control#Policy": { "type": "string" }, "com.amazonaws.s3control#PolicyDocument": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 350000 } } }, "com.amazonaws.s3control#PolicyStatus": { "type": "structure", "members": { "IsPublic": { "target": "com.amazonaws.s3control#IsPublic", "traits": { "smithy.api#default": false, "smithy.api#documentation": "", "smithy.api#xmlName": "IsPublic" } } }, "traits": { "smithy.api#documentation": "Indicates whether this access point policy is public. For more information about how Amazon S3\n evaluates policies to determine whether they are public, see The Meaning of \"Public\" in the Amazon S3 User Guide.
" } }, "com.amazonaws.s3control#Prefix": { "type": "string" }, "com.amazonaws.s3control#PrefixLevel": { "type": "structure", "members": { "StorageMetrics": { "target": "com.amazonaws.s3control#PrefixLevelStorageMetrics", "traits": { "smithy.api#documentation": "A container for the prefix-level storage metrics for S3 Storage Lens.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A container for the prefix-level configuration.
" } }, "com.amazonaws.s3control#PrefixLevelStorageMetrics": { "type": "structure", "members": { "IsEnabled": { "target": "com.amazonaws.s3control#IsEnabled", "traits": { "smithy.api#default": false, "smithy.api#documentation": "A container for whether prefix-level storage metrics are enabled.
" } }, "SelectionCriteria": { "target": "com.amazonaws.s3control#SelectionCriteria" } }, "traits": { "smithy.api#documentation": "A container for the prefix-level storage metrics for S3 Storage Lens.
" } }, "com.amazonaws.s3control#PrefixesList": { "type": "list", "member": { "target": "com.amazonaws.s3control#Prefix", "traits": { "smithy.api#xmlName": "Prefix" } } }, "com.amazonaws.s3control#Priority": { "type": "integer", "traits": { "smithy.api#default": 0 } }, "com.amazonaws.s3control#Privilege": { "type": "enum", "members": { "Minimal": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Minimal" } }, "Default": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Default" } } } }, "com.amazonaws.s3control#ProposedMultiRegionAccessPointPolicy": { "type": "structure", "members": { "Policy": { "target": "com.amazonaws.s3control#Policy", "traits": { "smithy.api#documentation": "The details of the proposed policy.
" } } }, "traits": { "smithy.api#documentation": "The proposed access control policy for the Multi-Region Access Point.
\nWhen you update the policy, the update is first listed as the proposed policy. After the\n update is finished and all Regions have been updated, the proposed policy is listed as the\n established policy. If both policies have the same version number, the proposed policy is\n the established policy.
" } }, "com.amazonaws.s3control#PublicAccessBlockConfiguration": { "type": "structure", "members": { "BlockPublicAcls": { "target": "com.amazonaws.s3control#Setting", "traits": { "smithy.api#default": false, "smithy.api#documentation": "Specifies whether Amazon S3 should block public access control lists (ACLs) for buckets in\n this account. Setting this element to TRUE causes the following\n behavior:
\n PutBucketAcl and PutObjectAcl calls fail if the\n specified ACL is public.
PUT Object calls fail if the request includes a public ACL.
\nPUT Bucket calls fail if the request includes a public ACL.
\nEnabling this setting doesn't affect existing policies or ACLs.
\nThis property is not supported for Amazon S3 on Outposts.
", "smithy.api#xmlName": "BlockPublicAcls" } }, "IgnorePublicAcls": { "target": "com.amazonaws.s3control#Setting", "traits": { "smithy.api#default": false, "smithy.api#documentation": "Specifies whether Amazon S3 should ignore public ACLs for buckets in this account. Setting\n this element to TRUE causes Amazon S3 to ignore all public ACLs on buckets in this\n account and any objects that they contain.
Enabling this setting doesn't affect the persistence of any existing ACLs and doesn't\n prevent new public ACLs from being set.
\nThis property is not supported for Amazon S3 on Outposts.
", "smithy.api#xmlName": "IgnorePublicAcls" } }, "BlockPublicPolicy": { "target": "com.amazonaws.s3control#Setting", "traits": { "smithy.api#default": false, "smithy.api#documentation": "Specifies whether Amazon S3 should block public bucket policies for buckets in this account.\n Setting this element to TRUE causes Amazon S3 to reject calls to PUT Bucket policy\n if the specified bucket policy allows public access.
Enabling this setting doesn't affect existing bucket policies.
\nThis property is not supported for Amazon S3 on Outposts.
", "smithy.api#xmlName": "BlockPublicPolicy" } }, "RestrictPublicBuckets": { "target": "com.amazonaws.s3control#Setting", "traits": { "smithy.api#default": false, "smithy.api#documentation": "Specifies whether Amazon S3 should restrict public bucket policies for buckets in this\n account. Setting this element to TRUE restricts access to buckets with public\n policies to only Amazon Web Services service principals and authorized users within this\n account.
Enabling this setting doesn't affect previously stored bucket policies, except that\n public and cross-account access within any public bucket policy, including non-public\n delegation to specific accounts, is blocked.
\nThis property is not supported for Amazon S3 on Outposts.
", "smithy.api#xmlName": "RestrictPublicBuckets" } } }, "traits": { "smithy.api#documentation": "The PublicAccessBlock configuration that you want to apply to this Amazon S3\n account. You can enable the configuration options in any combination. For more information\n about when Amazon S3 considers a bucket or object public, see The Meaning of \"Public\" in the Amazon S3 User Guide.
This data type is not supported for Amazon S3 on Outposts.
" } }, "com.amazonaws.s3control#PublicAccessBlockEnabled": { "type": "boolean", "traits": { "smithy.api#default": false } }, "com.amazonaws.s3control#PutAccessGrantsInstanceResourcePolicy": { "type": "operation", "input": { "target": "com.amazonaws.s3control#PutAccessGrantsInstanceResourcePolicyRequest" }, "output": { "target": "com.amazonaws.s3control#PutAccessGrantsInstanceResourcePolicyResult" }, "traits": { "smithy.api#documentation": "Updates the resource policy of the S3 Access Grants instance.
\nYou must have the s3:PutAccessGrantsInstanceResourcePolicy permission to use this operation.
The Amazon Web Services account ID of the S3 Access Grants instance.
", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "AccountId" } } }, "Policy": { "target": "com.amazonaws.s3control#PolicyDocument", "traits": { "smithy.api#documentation": "The resource policy of the S3 Access Grants instance that you are updating.
", "smithy.api#required": {} } }, "Organization": { "target": "com.amazonaws.s3control#Organization", "traits": { "smithy.api#documentation": "The Organization of the resource policy of the S3 Access Grants instance.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.s3control#PutAccessGrantsInstanceResourcePolicyResult": { "type": "structure", "members": { "Policy": { "target": "com.amazonaws.s3control#PolicyDocument", "traits": { "smithy.api#documentation": "The updated resource policy of the S3 Access Grants instance.
" } }, "Organization": { "target": "com.amazonaws.s3control#Organization", "traits": { "smithy.api#documentation": "The Organization of the resource policy of the S3 Access Grants instance.
" } }, "CreatedAt": { "target": "com.amazonaws.s3control#CreationTimestamp", "traits": { "smithy.api#documentation": "The date and time when you created the S3 Access Grants instance resource policy.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.s3control#PutAccessPointConfigurationForObjectLambda": { "type": "operation", "input": { "target": "com.amazonaws.s3control#PutAccessPointConfigurationForObjectLambdaRequest" }, "output": { "target": "smithy.api#Unit" }, "traits": { "smithy.api#documentation": "This operation is not supported by directory buckets.
\nReplaces configuration for an Object Lambda Access Point.
\nThe following actions are related to\n PutAccessPointConfigurationForObjectLambda:
The account ID for the account that owns the specified Object Lambda Access Point.
", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "AccountId" } } }, "Name": { "target": "com.amazonaws.s3control#ObjectLambdaAccessPointName", "traits": { "smithy.api#documentation": "The name of the Object Lambda Access Point.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "Configuration": { "target": "com.amazonaws.s3control#ObjectLambdaConfiguration", "traits": { "smithy.api#documentation": "Object Lambda Access Point configuration document.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.s3control#PutAccessPointPolicy": { "type": "operation", "input": { "target": "com.amazonaws.s3control#PutAccessPointPolicyRequest" }, "output": { "target": "smithy.api#Unit" }, "traits": { "smithy.api#documentation": "Associates an access policy with the specified access point. Each access point can have only one policy,\n so a request made to this API replaces any existing policy associated with the specified\n access point.
\n \nAll Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.
The following actions are related to PutAccessPointPolicy:
\n GetAccessPointPolicy\n
\nThis operation is not supported by directory buckets.
\nCreates or replaces resource policy for an Object Lambda Access Point. For an example policy, see Creating Object Lambda Access Points in the Amazon S3 User Guide.
\nThe following actions are related to\n PutAccessPointPolicyForObjectLambda:
The account ID for the account that owns the specified Object Lambda Access Point.
", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "AccountId" } } }, "Name": { "target": "com.amazonaws.s3control#ObjectLambdaAccessPointName", "traits": { "smithy.api#documentation": "The name of the Object Lambda Access Point.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "Policy": { "target": "com.amazonaws.s3control#ObjectLambdaPolicy", "traits": { "smithy.api#documentation": "Object Lambda Access Point resource policy document.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.s3control#PutAccessPointPolicyRequest": { "type": "structure", "members": { "AccountId": { "target": "com.amazonaws.s3control#AccountId", "traits": { "smithy.api#documentation": "The Amazon Web Services account ID for owner of the bucket associated with the specified access point.
", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "AccountId" } } }, "Name": { "target": "com.amazonaws.s3control#AccessPointName", "traits": { "smithy.api#documentation": "The name of the access point that you want to associate with the specified policy.
\nFor using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.
\nFor using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the access point accessed in the format arn:aws:s3-outposts:. For example, to access the access point reports-ap through Outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap. The value must be URL encoded.
The policy that you want to apply to the specified access point. For more information about access point\n policies, see Managing data access with Amazon S3\n access points or Managing access to shared datasets in directory buckets with access points in the Amazon S3 User Guide.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.s3control#PutAccessPointScope": { "type": "operation", "input": { "target": "com.amazonaws.s3control#PutAccessPointScopeRequest" }, "output": { "target": "smithy.api#Unit" }, "traits": { "smithy.api#documentation": "Creates or replaces the access point scope for a directory bucket. You can use the access point scope to restrict access to specific prefixes, API operations, or a combination of both.
\nYou can specify any amount of prefixes, but the total length of characters of all prefixes must be less than 256 bytes in size.
\nTo use this operation, you must have the permission to perform the\n s3express:PutAccessPointScope action.
For information about REST API errors, see REST error responses.
", "smithy.api#http": { "method": "PUT", "uri": "/v20180820/accesspoint/{Name}/scope", "code": 200 }, "smithy.rules#staticContextParams": { "RequiresAccountId": { "value": true }, "UseS3ExpressControlEndpoint": { "value": true } } } }, "com.amazonaws.s3control#PutAccessPointScopeRequest": { "type": "structure", "members": { "AccountId": { "target": "com.amazonaws.s3control#AccountId", "traits": { "smithy.api#documentation": "\n The Amazon Web Services account ID that owns the access point with scope that you want to create or replace.\n
", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "AccountId" } } }, "Name": { "target": "com.amazonaws.s3control#AccessPointName", "traits": { "smithy.api#documentation": "The name of the access point with the scope that you want to create or replace.
", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "AccessPointName" } } }, "Scope": { "target": "com.amazonaws.s3control#Scope", "traits": { "smithy.api#documentation": "Object prefixes, API operations, or a combination of both.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.s3control#PutBucketLifecycleConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.s3control#PutBucketLifecycleConfigurationRequest" }, "output": { "target": "smithy.api#Unit" }, "traits": { "smithy.api#documentation": "This action puts a lifecycle configuration to an Amazon S3 on Outposts bucket. To put a\n lifecycle configuration to an S3 bucket, see PutBucketLifecycleConfiguration in the Amazon S3 API Reference.\n
\nCreates a new lifecycle configuration for the S3 on Outposts bucket or replaces an\n existing lifecycle configuration. Outposts buckets only support lifecycle configurations\n that delete/expire objects after a certain period of time and abort incomplete multipart\n uploads.
\n \nAll Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.
The following actions are related to\n PutBucketLifecycleConfiguration:
The Amazon Web Services account ID of the Outposts bucket.
", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "AccountId" } } }, "Bucket": { "target": "com.amazonaws.s3control#BucketName", "traits": { "smithy.api#documentation": "The name of the bucket for which to set the configuration.
", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "Bucket" } } }, "LifecycleConfiguration": { "target": "com.amazonaws.s3control#LifecycleConfiguration", "traits": { "smithy.api#documentation": "Container for lifecycle rules. You can add as many as 1,000 rules.
", "smithy.api#httpPayload": {}, "smithy.api#xmlName": "LifecycleConfiguration" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.s3control#PutBucketPolicy": { "type": "operation", "input": { "target": "com.amazonaws.s3control#PutBucketPolicyRequest" }, "output": { "target": "smithy.api#Unit" }, "traits": { "smithy.api#documentation": "This action puts a bucket policy to an Amazon S3 on Outposts bucket. To put a policy on an\n S3 bucket, see PutBucketPolicy in the\n Amazon S3 API Reference.
\nApplies an Amazon S3 bucket policy to an Outposts bucket. For more information, see Using\n Amazon S3 on Outposts in the Amazon S3 User Guide.
\nIf you are using an identity other than the root user of the Amazon Web Services account that owns the\n Outposts bucket, the calling identity must have the PutBucketPolicy\n permissions on the specified Outposts bucket and belong to the bucket owner's account in\n order to use this action.
If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403\n Access Denied error. If you have the correct permissions, but you're not using an\n identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not\n Allowed error.
As a security precaution, the root user of the Amazon Web Services account that owns a bucket can\n always use this action, even if the policy explicitly denies the root user the ability\n to perform this action.
\nFor more information about bucket policies, see Using Bucket Policies and User\n Policies.
\nAll Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.
The following actions are related to PutBucketPolicy:
\n GetBucketPolicy\n
\n\n DeleteBucketPolicy\n
\nThe Amazon Web Services account ID of the Outposts bucket.
", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "AccountId" } } }, "Bucket": { "target": "com.amazonaws.s3control#BucketName", "traits": { "smithy.api#documentation": "Specifies the bucket.
\nFor using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.
\nFor using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:. For example, to access the bucket reports through Outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.
Set this parameter to true to confirm that you want to remove your permissions to change\n this bucket policy in the future.
\nThis is not supported by Amazon S3 on Outposts buckets.
\nThe bucket policy as a JSON document.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.s3control#PutBucketReplication": { "type": "operation", "input": { "target": "com.amazonaws.s3control#PutBucketReplicationRequest" }, "output": { "target": "smithy.api#Unit" }, "traits": { "smithy.api#documentation": "This action creates an Amazon S3 on Outposts bucket's replication configuration. To create\n an S3 bucket's replication configuration, see PutBucketReplication\n in the Amazon S3 API Reference.
\nCreates a replication configuration or replaces an existing one. For information about\n S3 replication on Outposts configuration, see Replicating objects for\n S3 on Outposts in the Amazon S3 User Guide.
\nIt can take a while to propagate PUT or DELETE requests for\n a replication configuration to all S3 on Outposts systems. Therefore, the replication\n configuration that's returned by a GET request soon after a\n PUT or DELETE request might return a more recent result\n than what's on the Outpost. If an Outpost is offline, the delay in updating the\n replication configuration on that Outpost can be significant.
Specify the replication configuration in the request body. In the replication\n configuration, you provide the following information:
\nThe name of the destination bucket or buckets where you want S3 on Outposts to\n replicate objects
\nThe Identity and Access Management (IAM) role that S3 on Outposts can assume to replicate objects on\n your behalf
\nOther relevant information, such as replication rules
\nA replication configuration must include at least one rule and can contain a maximum of\n 100. Each rule identifies a subset of objects to replicate by filtering the objects in the\n source Outposts bucket. To choose additional subsets of objects to replicate, add a rule\n for each subset.
\nTo specify a subset of the objects in the source Outposts bucket to apply a replication\n rule to, add the Filter element as a child of the Rule element.\n You can filter objects based on an object key prefix, one or more object tags, or both.\n When you add the Filter element in the configuration, you must also add the\n following elements: DeleteMarkerReplication, Status, and\n Priority.
Using PutBucketReplication on Outposts requires that both the source and\n destination buckets must have versioning enabled. For information about enabling versioning\n on a bucket, see Managing S3 Versioning\n for your S3 on Outposts bucket.
For information about S3 on Outposts replication failure reasons, see Replication failure reasons in the Amazon S3 User Guide.
\n\n Handling Replication of Encrypted Objects\n
\nOutposts buckets are encrypted at all times. All the objects in the source Outposts\n bucket are encrypted and can be replicated. Also, all the replicas in the destination\n Outposts bucket are encrypted with the same encryption key as the objects in the source\n Outposts bucket.
\n\n Permissions\n
\nTo create a PutBucketReplication request, you must have\n s3-outposts:PutReplicationConfiguration permissions for the bucket. The\n Outposts bucket owner has this permission by default and can grant it to others. For more\n information about permissions, see Setting up IAM with\n S3 on Outposts and Managing access to\n S3 on Outposts buckets.
To perform this operation, the user or role must also have the\n iam:CreateRole and iam:PassRole permissions. For more\n information, see Granting a user permissions to\n pass a role to an Amazon Web Services service.
All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.
The following operations are related to PutBucketReplication:
\n GetBucketReplication\n
\nThe Amazon Web Services account ID of the Outposts bucket.
", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "AccountId" } } }, "Bucket": { "target": "com.amazonaws.s3control#BucketName", "traits": { "smithy.api#documentation": "Specifies the S3 on Outposts bucket to set the configuration for.
\nFor using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.
\nFor using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:. For example, to access the bucket reports through Outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.
This action puts tags on an Amazon S3 on Outposts bucket. To put tags on an S3 bucket, see\n PutBucketTagging in the Amazon S3 API Reference.
\nSets the tags for an S3 on Outposts bucket. For more information, see Using\n Amazon S3 on Outposts in the Amazon S3 User Guide.
\nUse tags to organize your Amazon Web Services bill to reflect your own cost structure. To do this,\n sign up to get your Amazon Web Services account bill with tag key values included. Then, to see the cost\n of combined resources, organize your billing information according to resources with the\n same tag key values. For example, you can tag several resources with a specific application\n name, and then organize your billing information to see the total cost of that application\n across several services. For more information, see Cost allocation and\n tagging.
\nWithin a bucket, if you add a tag that has the same key as an existing tag, the new\n value overwrites the old value. For more information, see Using cost allocation in Amazon S3\n bucket tags.
\nTo use this action, you must have permissions to perform the\n s3-outposts:PutBucketTagging action. The Outposts bucket owner has this\n permission by default and can grant this permission to others. For more information about\n permissions, see Permissions Related to Bucket Subresource Operations and Managing\n access permissions to your Amazon S3 resources.
\n PutBucketTagging has the following special errors:
Error code: InvalidTagError\n
Description: The tag provided was not a valid tag. This error can occur if\n the tag did not pass input validation. For information about tag restrictions,\n see \n User-Defined Tag Restrictions and \n Amazon Web Services-Generated Cost Allocation Tag Restrictions.
\nError code: MalformedXMLError\n
Description: The XML provided does not match the schema.
\nError code: OperationAbortedError \n
Description: A conflicting conditional action is currently in progress\n against this resource. Try again.
\nError code: InternalError\n
Description: The service was unable to apply the provided tag to the\n bucket.
\nAll Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.
The following actions are related to PutBucketTagging:
\n GetBucketTagging\n
\n\n DeleteBucketTagging\n
\nThe Amazon Web Services account ID of the Outposts bucket.
", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "AccountId" } } }, "Bucket": { "target": "com.amazonaws.s3control#BucketName", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the bucket.
\nFor using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.
\nFor using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:. For example, to access the bucket reports through Outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.
This operation sets the versioning state\n for\n S3 on Outposts\n buckets\n only. To set the versioning state for an S3 bucket, see PutBucketVersioning in the Amazon S3 API Reference.
\nSets the versioning state for an S3 on Outposts bucket. With\n S3\n Versioning,\n you can save multiple distinct copies of your\n objects\n and recover from unintended user actions and application failures.
\nYou can set the versioning state to one of the following:
\n\n Enabled - Enables versioning for the objects in\n the bucket. All objects added to the bucket receive a unique version ID.
\n\n Suspended - Suspends versioning for the objects\n in the bucket. All objects added to the bucket receive the version ID\n null.
If you've never set versioning on your bucket, it has no versioning state. In that case,\n a \n GetBucketVersioning request does not return a versioning state value.
\nWhen you enable S3 Versioning, for each object in your bucket, you have a current\n version and zero or more noncurrent versions. You can configure your bucket S3 Lifecycle\n rules to expire noncurrent versions after a specified time period. For more information,\n see Creating and managing\n a lifecycle configuration for your S3 on Outposts bucket in the Amazon S3\n User Guide.
\nIf you have an object expiration lifecycle configuration in your non-versioned bucket\n and you want to maintain the same permanent delete behavior when you enable versioning, you\n must add a noncurrent expiration policy. The noncurrent expiration lifecycle configuration\n will manage the deletes of the noncurrent object versions in the version-enabled bucket.\n For more information, see Versioning in the Amazon S3\n User Guide.
\nAll Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.
The following operations are related to PutBucketVersioning for\n S3 on Outposts.
\n GetBucketVersioning\n
\nThe Amazon Web Services account ID of the S3 on Outposts bucket.
", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "AccountId" } } }, "Bucket": { "target": "com.amazonaws.s3control#BucketName", "traits": { "smithy.api#documentation": "The S3 on Outposts bucket to set the versioning state for.
", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "Bucket" } } }, "MFA": { "target": "com.amazonaws.s3control#MFA", "traits": { "smithy.api#documentation": "The concatenation of the authentication device's serial number, a space, and the value\n that is displayed on your authentication device.
", "smithy.api#httpHeader": "x-amz-mfa" } }, "VersioningConfiguration": { "target": "com.amazonaws.s3control#VersioningConfiguration", "traits": { "smithy.api#documentation": "The root-level tag for the VersioningConfiguration parameters.
Sets the supplied tag-set on an S3 Batch Operations job.
\nA tag is a key-value pair. You can associate S3 Batch Operations tags with any job by sending\n a PUT request against the tagging subresource that is associated with the job. To modify\n the existing tag set, you can either replace the existing tag set entirely, or make changes\n within the existing tag set by retrieving the existing tag set using GetJobTagging, modify that tag set, and use this operation to replace the tag set\n with the one you modified. For more information, see Controlling\n access and labeling jobs using tags in the Amazon S3 User Guide.
\nIf you send this request with an empty tag set, Amazon S3 deletes the existing\n tag set on the Batch Operations job. If you use this method, you are charged for a Tier\n 1 Request (PUT). For more information, see Amazon S3 pricing.
\nFor deleting existing tags for your Batch Operations job, a DeleteJobTagging request is preferred because it achieves the same\n result without incurring charges.
\nA few things to consider about using tags:
\nAmazon S3 limits the maximum number of tags to 50 tags per job.
\nYou can associate up to 50 tags with a job as long as they have unique\n tag keys.
\nA tag key can be up to 128 Unicode characters in length, and tag values\n can be up to 256 Unicode characters in length.
\nThe key and values are case sensitive.
\nFor tagging-related restrictions related to characters and encodings, see\n User-Defined Tag Restrictions in the Billing and Cost Management User Guide.
\nTo use the\n PutJobTagging operation, you must have permission to\n perform the s3:PutJobTagging action.
Related actions include:
\n\n CreateJob\n
\n\n GetJobTagging\n
\n\n DeleteJobTagging\n
\nThe Amazon Web Services account ID associated with the S3 Batch Operations job.
", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "AccountId" } } }, "JobId": { "target": "com.amazonaws.s3control#JobId", "traits": { "smithy.api#documentation": "The ID for the S3 Batch Operations job whose tags you want to replace.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.s3control#S3TagSet", "traits": { "smithy.api#documentation": "The set of tags to associate with the S3 Batch Operations job.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.s3control#PutJobTaggingResult": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.s3control#PutMultiRegionAccessPointPolicy": { "type": "operation", "input": { "target": "com.amazonaws.s3control#PutMultiRegionAccessPointPolicyRequest" }, "output": { "target": "com.amazonaws.s3control#PutMultiRegionAccessPointPolicyResult" }, "traits": { "smithy.api#documentation": "This operation is not supported by directory buckets.
\nAssociates an access control policy with the specified Multi-Region Access Point. Each Multi-Region Access Point can have only\n one policy, so a request made to this action replaces any existing policy that is\n associated with the specified Multi-Region Access Point.
\nThis action will always be routed to the US West (Oregon) Region. For more information\n about the restrictions around working with Multi-Region Access Points, see Multi-Region Access Point\n restrictions and limitations in the Amazon S3 User Guide.
\nThe following actions are related to\n PutMultiRegionAccessPointPolicy:
The name of the Multi-Region Access Point associated with the request.
", "smithy.api#required": {} } }, "Policy": { "target": "com.amazonaws.s3control#Policy", "traits": { "smithy.api#documentation": "The policy details for the PutMultiRegionAccessPoint request.
A container for the information associated with a PutMultiRegionAccessPoint request.
" } }, "com.amazonaws.s3control#PutMultiRegionAccessPointPolicyRequest": { "type": "structure", "members": { "AccountId": { "target": "com.amazonaws.s3control#AccountId", "traits": { "smithy.api#documentation": "The Amazon Web Services account ID for the owner of the Multi-Region Access Point.
", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "AccountId" } } }, "ClientToken": { "target": "com.amazonaws.s3control#MultiRegionAccessPointClientToken", "traits": { "smithy.api#documentation": "An idempotency token used to identify the request and guarantee that requests are\n unique.
", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } }, "Details": { "target": "com.amazonaws.s3control#PutMultiRegionAccessPointPolicyInput", "traits": { "smithy.api#documentation": "A container element containing the details of the policy for the Multi-Region Access Point.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.s3control#PutMultiRegionAccessPointPolicyResult": { "type": "structure", "members": { "RequestTokenARN": { "target": "com.amazonaws.s3control#AsyncRequestTokenARN", "traits": { "smithy.api#documentation": "The request token associated with the request. You can use this token with DescribeMultiRegionAccessPointOperation to determine the status of asynchronous\n requests.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.s3control#PutPublicAccessBlock": { "type": "operation", "input": { "target": "com.amazonaws.s3control#PutPublicAccessBlockRequest" }, "output": { "target": "smithy.api#Unit" }, "traits": { "smithy.api#documentation": "This operation is not supported by directory buckets.
\nCreates or modifies the PublicAccessBlock configuration for an\n Amazon Web Services account. This operation may be restricted when the account is managed by\n organization-level Block Public Access policies. You might get an Access Denied (403) error\n when the account is managed by organization-level Block Public Access policies.\n Organization-level policies override account-level settings, preventing direct\n account-level modifications. For this operation, users must have the\n s3:PutAccountPublicAccessBlock permission. For more information, see \n Using Amazon S3 block public access.
Related actions include:
\n\n GetPublicAccessBlock\n
\nThe PublicAccessBlock configuration that you want to apply to the specified\n Amazon Web Services account.
The account ID for the Amazon Web Services account whose PublicAccessBlock configuration\n you want to set.
This operation is not supported by directory buckets.
\nPuts an Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see Working with\n Amazon S3 Storage Lens in the Amazon S3 User Guide. For a complete list of S3 Storage Lens metrics, see S3 Storage Lens metrics glossary in the Amazon S3 User Guide.
\nTo use this action, you must have permission to perform the\n s3:PutStorageLensConfiguration action. For more information, see Setting permissions to use Amazon S3 Storage Lens in the\n Amazon S3 User Guide.
The ID of the S3 Storage Lens configuration.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "AccountId": { "target": "com.amazonaws.s3control#AccountId", "traits": { "smithy.api#documentation": "The account ID of the requester.
", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "AccountId" } } }, "StorageLensConfiguration": { "target": "com.amazonaws.s3control#StorageLensConfiguration", "traits": { "smithy.api#documentation": "The S3 Storage Lens configuration.
", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.s3control#StorageLensTags", "traits": { "smithy.api#documentation": "The tag set of the S3 Storage Lens configuration.
\nYou can set up to a maximum of 50 tags.
\nThis operation is not supported by directory buckets.
\nPut or replace tags on an existing Amazon S3 Storage Lens configuration. For more information\n about S3 Storage Lens, see Assessing your storage activity and usage with Amazon S3 Storage Lens in the\n Amazon S3 User Guide.
\nTo use this action, you must have permission to perform the\n s3:PutStorageLensConfigurationTagging action. For more information, see\n Setting permissions to\n use Amazon S3 Storage Lens in the Amazon S3 User Guide.
The ID of the S3 Storage Lens configuration.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "AccountId": { "target": "com.amazonaws.s3control#AccountId", "traits": { "smithy.api#documentation": "The account ID of the requester.
", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "AccountId" } } }, "Tags": { "target": "com.amazonaws.s3control#StorageLensTags", "traits": { "smithy.api#documentation": "The tag set of the S3 Storage Lens configuration.
\nYou can set up to a maximum of 50 tags.
\nThe name of the associated bucket for the Region.
", "smithy.api#required": {} } }, "BucketAccountId": { "target": "com.amazonaws.s3control#AccountId", "traits": { "smithy.api#documentation": "The Amazon Web Services account ID that owns the Amazon S3 bucket that's associated with this\n Multi-Region Access Point.
" } } }, "traits": { "smithy.api#documentation": "A Region that supports a Multi-Region Access Point as well as the associated bucket for the Region.
" } }, "com.amazonaws.s3control#RegionCreationList": { "type": "list", "member": { "target": "com.amazonaws.s3control#Region", "traits": { "smithy.api#xmlName": "Region" } } }, "com.amazonaws.s3control#RegionName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 } } }, "com.amazonaws.s3control#RegionReport": { "type": "structure", "members": { "Bucket": { "target": "com.amazonaws.s3control#BucketName", "traits": { "smithy.api#documentation": "The name of the bucket.
" } }, "Region": { "target": "com.amazonaws.s3control#RegionName", "traits": { "smithy.api#documentation": "The name of the Region.
" } }, "BucketAccountId": { "target": "com.amazonaws.s3control#AccountId", "traits": { "smithy.api#documentation": "The Amazon Web Services account ID that owns the Amazon S3 bucket that's associated with this\n Multi-Region Access Point.
" } } }, "traits": { "smithy.api#documentation": "A combination of a bucket and Region that's part of a Multi-Region Access Point.
" } }, "com.amazonaws.s3control#RegionReportList": { "type": "list", "member": { "target": "com.amazonaws.s3control#RegionReport", "traits": { "smithy.api#xmlName": "Region" } } }, "com.amazonaws.s3control#RegionalBucket": { "type": "structure", "members": { "Bucket": { "target": "com.amazonaws.s3control#BucketName", "traits": { "smithy.api#documentation": "", "smithy.api#required": {} } }, "BucketArn": { "target": "com.amazonaws.s3control#S3RegionalBucketArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) for the regional bucket.
" } }, "PublicAccessBlockEnabled": { "target": "com.amazonaws.s3control#PublicAccessBlockEnabled", "traits": { "smithy.api#default": false, "smithy.api#documentation": "", "smithy.api#required": {} } }, "CreationDate": { "target": "com.amazonaws.s3control#CreationDate", "traits": { "smithy.api#documentation": "The creation date of the regional bucket
", "smithy.api#required": {} } }, "OutpostId": { "target": "com.amazonaws.s3control#NonEmptyMaxLength64String", "traits": { "smithy.api#documentation": "The Outposts ID of the regional bucket.
" } } }, "traits": { "smithy.api#documentation": "The container for the regional bucket.
" } }, "com.amazonaws.s3control#RegionalBucketList": { "type": "list", "member": { "target": "com.amazonaws.s3control#RegionalBucket", "traits": { "smithy.api#xmlName": "RegionalBucket" } } }, "com.amazonaws.s3control#Regions": { "type": "list", "member": { "target": "com.amazonaws.s3control#S3AWSRegion", "traits": { "smithy.api#xmlName": "Region" } } }, "com.amazonaws.s3control#ReplicaKmsKeyID": { "type": "string" }, "com.amazonaws.s3control#ReplicaModifications": { "type": "structure", "members": { "Status": { "target": "com.amazonaws.s3control#ReplicaModificationsStatus", "traits": { "smithy.api#documentation": "Specifies whether S3 on Outposts replicates modifications to object metadata on\n replicas.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A filter that you can use to specify whether replica modification sync is enabled.\n S3 on Outposts replica modification sync can help you keep object metadata synchronized\n between replicas and source objects. By default, S3 on Outposts replicates metadata from the\n source objects to the replicas only. When replica modification sync is enabled,\n S3 on Outposts replicates metadata changes made to the replica copies back to the source\n object, making the replication bidirectional.
\nTo replicate object metadata modifications on replicas, you can specify this element and\n set the Status of this element to Enabled.
You must enable replica modification sync on the source and destination buckets to\n replicate replica metadata changes between the source and the replicas.
\nThe Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that S3 on Outposts assumes\n when replicating objects. For information about S3 replication on Outposts configuration,\n see Setting up\n replication in the Amazon S3 User Guide.
", "smithy.api#required": {} } }, "Rules": { "target": "com.amazonaws.s3control#ReplicationRules", "traits": { "smithy.api#documentation": "A container for one or more replication rules. A replication configuration must have at\n least one rule and can contain an array of 100 rules at the most.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A container for one or more replication rules. A replication configuration must have at\n least one rule and you can add up to 100 rules. The maximum size of a replication\n configuration is 128 KB.
" } }, "com.amazonaws.s3control#ReplicationRule": { "type": "structure", "members": { "ID": { "target": "com.amazonaws.s3control#ID", "traits": { "smithy.api#documentation": "A unique identifier for the rule. The maximum value is 255 characters.
" } }, "Priority": { "target": "com.amazonaws.s3control#Priority", "traits": { "smithy.api#default": null, "smithy.api#documentation": "The priority indicates which rule has precedence whenever two or more replication rules\n conflict. S3 on Outposts attempts to replicate objects according to all replication rules.\n However, if there are two or more rules with the same destination Outposts bucket, then\n objects will be replicated according to the rule with the highest priority. The higher the\n number, the higher the priority.
\nFor more information, see Creating replication\n rules on Outposts in the Amazon S3 User Guide.
" } }, "Prefix": { "target": "com.amazonaws.s3control#Prefix", "traits": { "smithy.api#deprecated": { "message": "Prefix has been deprecated" }, "smithy.api#documentation": "An object key name prefix that identifies the object or objects to which the rule\n applies. The maximum prefix length is 1,024 characters. To include all objects in an\n Outposts bucket, specify an empty string.
\nWhen you're using XML requests, you must \nreplace special characters (such as carriage returns) in object keys with their equivalent XML entity codes. \nFor more information, see \n XML-related object key constraints in the Amazon S3 User Guide.
\nA filter that identifies the subset of objects to which the replication rule applies. A\n Filter element must specify exactly one Prefix,\n Tag, or And child element.
Specifies whether the rule is enabled.
", "smithy.api#required": {} } }, "SourceSelectionCriteria": { "target": "com.amazonaws.s3control#SourceSelectionCriteria", "traits": { "smithy.api#documentation": "A container that describes additional filters for identifying the source Outposts\n objects that you want to replicate. You can choose to enable or disable the replication of\n these objects.
" } }, "ExistingObjectReplication": { "target": "com.amazonaws.s3control#ExistingObjectReplication", "traits": { "smithy.api#documentation": "An optional configuration to replicate existing source bucket objects.
\nThis is not supported by Amazon S3 on Outposts buckets.
\nA container for information about the replication destination and its\n configurations.
", "smithy.api#required": {} } }, "DeleteMarkerReplication": { "target": "com.amazonaws.s3control#DeleteMarkerReplication", "traits": { "smithy.api#documentation": "Specifies whether S3 on Outposts replicates delete markers. If you specify a\n Filter element in your replication configuration, you must also include a\n DeleteMarkerReplication element. If your Filter includes a\n Tag element, the DeleteMarkerReplication element's\n Status child element must be set to Disabled, because\n S3 on Outposts doesn't support replicating delete markers for tag-based rules.
For more information about delete marker replication, see How delete operations affect replication in the\n Amazon S3 User Guide.
" } }, "Bucket": { "target": "com.amazonaws.s3control#BucketIdentifierString", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the access point for the source Outposts bucket that you want\n S3 on Outposts to replicate the objects from.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Specifies which S3 on Outposts objects to replicate and where to store the\n replicas.
" } }, "com.amazonaws.s3control#ReplicationRuleAndOperator": { "type": "structure", "members": { "Prefix": { "target": "com.amazonaws.s3control#Prefix", "traits": { "smithy.api#documentation": "An object key name prefix that identifies the subset of objects that the rule applies\n to.
" } }, "Tags": { "target": "com.amazonaws.s3control#S3TagSet", "traits": { "smithy.api#documentation": "An array of tags that contain key and value pairs.
" } } }, "traits": { "smithy.api#documentation": "A container for specifying rule filters. The filters determine the subset of objects to\n which the rule applies. This element is required only if you specify more than one filter.
\nFor example:
\nIf you specify both a Prefix and a Tag filter, wrap\n these filters in an And element.
If you specify a filter based on multiple tags, wrap the Tag elements\n in an And element.
An object key name prefix that identifies the subset of objects that the rule applies\n to.
\nWhen you're using XML requests, you must \nreplace special characters (such as carriage returns) in object keys with their equivalent XML entity codes. \nFor more information, see \n XML-related object key constraints in the Amazon S3 User Guide.
\nA container for specifying rule filters. The filters determine the subset of objects\n that the rule applies to. This element is required only if you specify more than one\n filter. For example:
\nIf you specify both a Prefix and a Tag filter, wrap\n these filters in an And element.
If you specify a filter based on multiple tags, wrap the Tag elements\n in an And element.
A filter that identifies the subset of objects to which the replication rule applies. A\n Filter element must specify exactly one Prefix,\n Tag, or And child element.
Specifies whether S3 Replication Time Control (S3 RTC) is enabled.
", "smithy.api#required": {} } }, "Time": { "target": "com.amazonaws.s3control#ReplicationTimeValue", "traits": { "smithy.api#documentation": "A container that specifies the time by which replication should be complete for all\n objects and operations on objects.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A container that specifies S3 Replication Time Control (S3 RTC) related information, including whether S3 RTC\n is enabled and the time when all objects and operations on objects must be\n replicated.
\nThis is not supported by Amazon S3 on Outposts buckets.
\nContains an integer that specifies the time period in minutes.
\nValid value: 15
" } } }, "traits": { "smithy.api#documentation": "A container that specifies the time value for S3 Replication Time Control (S3 RTC). This value is also used for\n the replication metrics EventThreshold element.
This is not supported by Amazon S3 on Outposts buckets.
\nThe schema version of the export file.
", "smithy.api#required": {} } }, "AccountId": { "target": "com.amazonaws.s3control#AccountId", "traits": { "smithy.api#documentation": "The account ID of the owner of the S3 Storage Lens metrics export bucket.
", "smithy.api#required": {} } }, "Arn": { "target": "com.amazonaws.s3control#S3BucketArnString", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the bucket. This property is read-only and follows the\n following format: \n arn:aws:s3:us-east-1:example-account-id:bucket/your-destination-bucket-name\n \n
The prefix of the destination bucket where the metrics export will be delivered.
" } }, "Encryption": { "target": "com.amazonaws.s3control#StorageLensDataExportEncryption", "traits": { "smithy.api#documentation": "The container for the type encryption of the metrics exports in this bucket.
" } } }, "traits": { "smithy.api#documentation": "A container for the bucket where the Amazon S3 Storage Lens metrics export files are\n located.
" } }, "com.amazonaws.s3control#S3CannedAccessControlList": { "type": "enum", "members": { "PRIVATE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "private" } }, "PUBLIC_READ": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "public-read" } }, "PUBLIC_READ_WRITE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "public-read-write" } }, "AWS_EXEC_READ": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "aws-exec-read" } }, "AUTHENTICATED_READ": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "authenticated-read" } }, "BUCKET_OWNER_READ": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "bucket-owner-read" } }, "BUCKET_OWNER_FULL_CONTROL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "bucket-owner-full-control" } } } }, "com.amazonaws.s3control#S3ChecksumAlgorithm": { "type": "enum", "members": { "CRC32": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CRC32" } }, "CRC32C": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CRC32C" } }, "SHA1": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SHA1" } }, "SHA256": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SHA256" } }, "CRC64NVME": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CRC64NVME" } }, "SHA512": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SHA512" } }, "MD5": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MD5" } }, "XXHASH64": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "XXHASH64" } }, "XXHASH3": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "XXHASH3" } }, "XXHASH128": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "XXHASH128" } } } }, "com.amazonaws.s3control#S3ComputeObjectChecksumOperation": { "type": "structure", "members": { "ChecksumAlgorithm": { "target": "com.amazonaws.s3control#ComputeObjectChecksumAlgorithm", "traits": { "smithy.api#documentation": "Indicates the algorithm that you want Amazon S3 to use to create the checksum. For more information, see Checking object integrity in the Amazon S3 User Guide.
" } }, "ChecksumType": { "target": "com.amazonaws.s3control#ComputeObjectChecksumType", "traits": { "smithy.api#documentation": "Indicates the checksum type that you want Amazon S3 to use to calculate the object's checksum value. For more information, see Checking object integrity in the Amazon S3 User Guide.
" } } }, "traits": { "smithy.api#documentation": "Directs the specified job to invoke the ComputeObjectChecksum operation on every object listed in the job's manifest.
" } }, "com.amazonaws.s3control#S3ContentLength": { "type": "long", "traits": { "smithy.api#default": 0, "smithy.api#range": { "min": 0 } } }, "com.amazonaws.s3control#S3CopyObjectOperation": { "type": "structure", "members": { "TargetResource": { "target": "com.amazonaws.s3control#S3RegionalOrS3ExpressBucketArnString", "traits": { "smithy.api#documentation": "Specifies the destination bucket\n Amazon Resource Name\n (ARN)\n for the batch copy operation.
\n\n General purpose buckets - For example, to copy objects to a general purpose bucket named\n destinationBucket, set the TargetResource property to\n arn:aws:s3:::destinationBucket.
\n Directory buckets - For example, to copy objects to a directory bucket named\n destinationBucket in the Availability Zone identified by the AZ ID usw2-az1, set the TargetResource property to\n arn:aws:s3express:region:account_id:/bucket/destination_bucket_base_name--usw2-az1--x-s3. A directory bucket as a destination bucket can be in Availability Zone or Local Zone.
Copying objects across different Amazon Web Services Regions isn't supported when the source or destination bucket is in Amazon Web Services Local Zones. The source and destination buckets must have the same parent Amazon Web Services Region. Otherwise, \n you get an HTTP 400 Bad Request error with the error code InvalidRequest.
This functionality is not supported by directory buckets.
\nThis functionality is not supported by directory buckets.
\nSpecifies whether the Batch Operations copy job copies object annotations from the source\n object or skips them. If this property isn't specified, COPY is the default\n behavior.
Valid Values: COPY | EXCLUDE\n
This functionality is not supported by directory buckets.
\nIf you don't provide this parameter, Amazon S3 copies all the metadata from the original\n objects. If you specify an empty set, the new objects will have no tags. Otherwise, Amazon S3\n assigns the supplied tags to the new objects.
" } }, "NewObjectTagging": { "target": "com.amazonaws.s3control#S3TagSet", "traits": { "smithy.api#documentation": "Specifies a list of tags to add to the destination objects after they are copied. \n If NewObjectTagging is not specified, the tags of the source objects are copied to destination objects by default.
\n Directory buckets - Tags aren't supported by directory buckets. \n If your source objects have tags and your destination bucket is a directory bucket, specify an empty tag set in the NewObjectTagging field \n to prevent copying the source object tags to the directory bucket.
If the destination bucket is configured as a website, specifies an optional metadata property for website redirects,\n x-amz-website-redirect-location. Allows webpage redirects if the object copy is\n accessed through a website endpoint.
This functionality is not supported by directory buckets.
\nThis functionality is not supported by directory buckets.
\nSpecify the storage class for the destination objects in a Copy operation.
\n Directory buckets - This functionality is not supported by directory buckets.
\nSpecifies the KMS key ID (Key ID, Key ARN, or Key Alias) to use for object encryption. If the KMS key doesn't exist in the same\n account that's issuing the command, you must use the full Key ARN not the Key ID.
\n\n Directory buckets - If you specify SSEAlgorithm with KMS, you must specify the \n SSEAwsKmsKeyId parameter with the ID (Key ID or Key ARN) of the KMS \n symmetric encryption customer managed key to use. Otherwise, you get an HTTP 400 Bad Request error. The key alias format of the KMS key isn't supported. To encrypt new object copies in a directory bucket with SSE-KMS, you must specify SSE-KMS as the directory bucket's default encryption configuration with a KMS key (specifically, a customer managed key). \n The Amazon Web Services managed key (aws/s3) isn't supported. Your SSE-KMS configuration can only support 1 customer managed key per directory bucket for the lifetime of the bucket. \nAfter you specify a customer managed key for SSE-KMS as the bucket default encryption, you can't override the customer managed key for the bucket's SSE-KMS configuration. \nThen, when you specify server-side encryption settings for new object copies with SSE-KMS, you must make sure the encryption key is the same customer managed key that you specified for the directory bucket's default encryption configuration. \n
Specifies the folder prefix\n that\n you\n want\n the objects to be\n copied\n into. For example, to copy objects into a folder named\n Folder1 in the destination bucket, set the\n TargetKeyPrefix\n property\n to Folder1.
The legal hold status to be applied to all objects in the Batch Operations job.
\nThis functionality is not supported by directory buckets.
\nThe retention mode to be applied to all objects in the Batch Operations job.
\nThis functionality is not supported by directory buckets.
\nThe date when the applied object retention configuration expires on all objects in the\n Batch Operations job.
\nThis functionality is not supported by directory buckets.
\nSpecifies whether Amazon S3 should use an S3 Bucket Key for object encryption with\n server-side encryption using Amazon Web Services KMS (SSE-KMS). Setting this header to true\n causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS.
Specifying this header with an Copy action doesn\u2019t affect\n bucket-level settings for S3 Bucket Key.
\n\n Directory buckets - S3 Bucket Keys aren't supported, when you copy SSE-KMS encrypted objects from general purpose buckets \nto directory buckets, from directory buckets to general purpose buckets, or between directory buckets, through the Copy operation in Batch Operations. In this case, Amazon S3 makes a call to KMS every time a copy request is made for a KMS-encrypted object.
\nIndicates the algorithm\n that\n you want Amazon S3 to use to create the checksum. For more\n information,\n see Checking object\n integrity in the Amazon S3 User Guide.
" } }, "ObjectLockEventHold": { "target": "com.amazonaws.s3control#S3ObjectLockEventHold", "traits": { "smithy.api#documentation": "The event hold status to be applied to all objects in the Batch Operations copy job. Set to\n ON to enable an event hold or OFF to disable it.
This functionality is not supported by directory buckets.
\nThe event hold duration to be applied to all objects in the Batch Operations copy job. The\n duration specifies how long the object remains protected after the event hold is\n released.
\nThis functionality is not supported by directory buckets.
\nContains\n the configuration parameters for a PUT Copy object operation. S3 Batch Operations passes every\n object to the underlying\n CopyObject\n API\n operation. For more information about the parameters for this operation,\n see CopyObject.
Contains no configuration parameters because the DELETE Object tagging\n (DeleteObjectTagging)\n API\n operation\n accepts\n only\n the bucket name and key name as parameters, which are defined in the\n job's manifest.
The format of the generated manifest.
" } }, "Location": { "target": "com.amazonaws.s3control#JobManifestLocation" } }, "traits": { "smithy.api#documentation": "Describes the specified job's generated manifest. Batch Operations jobs created with a\n ManifestGenerator populate details of this descriptor after execution of the\n ManifestGenerator.
" } }, "com.amazonaws.s3control#S3GlacierJobTier": { "type": "enum", "members": { "BULK": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BULK" } }, "STANDARD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "STANDARD" } } } }, "com.amazonaws.s3control#S3Grant": { "type": "structure", "members": { "Grantee": { "target": "com.amazonaws.s3control#S3Grantee", "traits": { "smithy.api#documentation": "" } }, "Permission": { "target": "com.amazonaws.s3control#S3Permission", "traits": { "smithy.api#documentation": "" } } }, "traits": { "smithy.api#documentation": "" } }, "com.amazonaws.s3control#S3GrantList": { "type": "list", "member": { "target": "com.amazonaws.s3control#S3Grant" } }, "com.amazonaws.s3control#S3Grantee": { "type": "structure", "members": { "TypeIdentifier": { "target": "com.amazonaws.s3control#S3GranteeTypeIdentifier", "traits": { "smithy.api#documentation": "" } }, "Identifier": { "target": "com.amazonaws.s3control#NonEmptyMaxLength1024String", "traits": { "smithy.api#documentation": "" } }, "DisplayName": { "target": "com.amazonaws.s3control#NonEmptyMaxLength1024String", "traits": { "smithy.api#documentation": "" } } }, "traits": { "smithy.api#documentation": "" } }, "com.amazonaws.s3control#S3GranteeTypeIdentifier": { "type": "enum", "members": { "CANONICAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "id" } }, "EMAIL_ADDRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "emailAddress" } }, "GROUP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "uri" } } } }, "com.amazonaws.s3control#S3InitiateRestoreObjectOperation": { "type": "structure", "members": { "ExpirationInDays": { "target": "com.amazonaws.s3control#S3ExpirationInDays", "traits": { "smithy.api#default": null, "smithy.api#documentation": "This argument specifies how long the S3 Glacier or S3 Glacier Deep Archive object remains\n available in Amazon S3. S3 Initiate Restore Object jobs that target S3 Glacier and S3 Glacier Deep Archive\n objects require ExpirationInDays set to 1 or greater.
Conversely, do not set ExpirationInDays when creating\n S3 Initiate Restore Object jobs that target S3 Intelligent-Tiering Archive Access and\n Deep Archive Access tier objects. Objects in S3 Intelligent-Tiering archive access tiers are\n not subject to restore expiry, so specifying ExpirationInDays results in\n restore request failure.
S3 Batch Operations jobs can operate either on S3 Glacier and S3 Glacier Deep Archive storage class\n objects or on S3 Intelligent-Tiering Archive Access and Deep Archive Access storage tier\n objects, but not both types in the same job. If you need to restore objects of both types\n you must create separate Batch Operations jobs.
" } }, "GlacierJobTier": { "target": "com.amazonaws.s3control#S3GlacierJobTier", "traits": { "smithy.api#documentation": "S3 Batch Operations supports STANDARD and BULK retrieval tiers, but\n not the EXPEDITED retrieval tier.
Contains the configuration parameters for\n a\n POST Object restore job. S3 Batch Operations passes every object to the\n underlying\n RestoreObject\n API\n operation. For more information about the parameters for this operation,\n see RestoreObject.
The Amazon Web Services account ID that owns the source bucket specified in SourceBucket. If\n provided, the manifest source bucket owner's Amazon Web Services account ID must match this value, else\n the job fails.
The ARN of the source bucket used by the ManifestGenerator.
\n\n Directory buckets - Directory buckets aren't supported \n as the source buckets used by S3JobManifestGenerator to generate the job manifest.
Specifies the location the generated manifest will be written to. Manifests can't be\n written to directory buckets. For more information, see Directory\n buckets.
" } }, "Filter": { "target": "com.amazonaws.s3control#JobManifestGeneratorFilter", "traits": { "smithy.api#documentation": "Specifies rules the S3JobManifestGenerator should use to decide whether an object\n in the source bucket should or should not be included in the generated job manifest.
" } }, "EnableManifestOutput": { "target": "com.amazonaws.s3control#Boolean", "traits": { "smithy.api#default": false, "smithy.api#documentation": "Determines whether or not to write the job's generated manifest to a bucket.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The container for the service that will create the S3 manifest.
" } }, "com.amazonaws.s3control#S3KeyArnString": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2000 }, "smithy.api#pattern": "^arn:[^:]+:s3:" } }, "com.amazonaws.s3control#S3ManifestOutputLocation": { "type": "structure", "members": { "ExpectedManifestBucketOwner": { "target": "com.amazonaws.s3control#AccountId", "traits": { "smithy.api#documentation": "The Account ID that owns the bucket the generated manifest is written to.
" } }, "Bucket": { "target": "com.amazonaws.s3control#S3BucketArnString", "traits": { "smithy.api#documentation": "The bucket ARN the generated manifest should be written to.
\n\n Directory buckets - Directory buckets aren't supported \n as the buckets to store the generated manifest.
\nPrefix identifying one or more objects to which the manifest applies.
" } }, "ManifestEncryption": { "target": "com.amazonaws.s3control#GeneratedManifestEncryption", "traits": { "smithy.api#documentation": "Specifies what encryption should be used when the generated manifest objects are\n written.
" } }, "ManifestFormat": { "target": "com.amazonaws.s3control#GeneratedManifestFormat", "traits": { "smithy.api#documentation": "The format of the generated manifest.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Location details for where the generated manifest should be written.
" } }, "com.amazonaws.s3control#S3MetadataDirective": { "type": "enum", "members": { "COPY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "COPY" } }, "REPLACE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "REPLACE" } } } }, "com.amazonaws.s3control#S3ObjectLockEventHold": { "type": "enum", "members": { "ON": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ON" } }, "OFF": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "OFF" } } } }, "com.amazonaws.s3control#S3ObjectLockEventHoldDuration": { "type": "structure", "members": { "Days": { "target": "com.amazonaws.s3control#S3ObjectLockEventHoldDurationDays", "traits": { "smithy.api#documentation": "The number of days for the event hold duration. The minimum value is 1 and the maximum\n value is 36,500.
" } }, "Years": { "target": "com.amazonaws.s3control#S3ObjectLockEventHoldDurationYears", "traits": { "smithy.api#documentation": "The number of years for the event hold duration. The minimum value is 1 and the maximum\n value is 100.
" } } }, "traits": { "smithy.api#documentation": "Contains the duration configuration for an event hold, specified in either days or\n years.
" } }, "com.amazonaws.s3control#S3ObjectLockEventHoldDurationDays": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 36500 } } }, "com.amazonaws.s3control#S3ObjectLockEventHoldDurationYears": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 100 } } }, "com.amazonaws.s3control#S3ObjectLockLegalHold": { "type": "structure", "members": { "Status": { "target": "com.amazonaws.s3control#S3ObjectLockLegalHoldStatus", "traits": { "smithy.api#documentation": "The Object Lock legal hold status to be applied to all objects in the Batch Operations\n job.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Whether S3 Object Lock legal hold will be applied to objects in an S3 Batch Operations\n job.
" } }, "com.amazonaws.s3control#S3ObjectLockLegalHoldStatus": { "type": "enum", "members": { "OFF": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "OFF" } }, "ON": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ON" } } } }, "com.amazonaws.s3control#S3ObjectLockMode": { "type": "enum", "members": { "COMPLIANCE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "COMPLIANCE" } }, "GOVERNANCE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "GOVERNANCE" } } } }, "com.amazonaws.s3control#S3ObjectLockRetentionEventHold": { "type": "enum", "members": { "ON": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ON" } }, "OFF": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "OFF" } } } }, "com.amazonaws.s3control#S3ObjectLockRetentionEventHoldDuration": { "type": "structure", "members": { "Days": { "target": "com.amazonaws.s3control#S3ObjectLockRetentionEventHoldDurationDays", "traits": { "smithy.api#documentation": "The number of days for the event hold duration. The minimum value is 1 and the maximum\n value is 36,500.
" } }, "Years": { "target": "com.amazonaws.s3control#S3ObjectLockRetentionEventHoldDurationYears", "traits": { "smithy.api#documentation": "The number of years for the event hold duration. The minimum value is 1 and the maximum\n value is 100.
" } } }, "traits": { "smithy.api#documentation": "Contains the duration configuration for an event hold, specified in either days or\n years.
" } }, "com.amazonaws.s3control#S3ObjectLockRetentionEventHoldDurationDays": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 36500 } } }, "com.amazonaws.s3control#S3ObjectLockRetentionEventHoldDurationYears": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 100 } } }, "com.amazonaws.s3control#S3ObjectLockRetentionMode": { "type": "enum", "members": { "COMPLIANCE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "COMPLIANCE" } }, "GOVERNANCE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "GOVERNANCE" } } } }, "com.amazonaws.s3control#S3ObjectMetadata": { "type": "structure", "members": { "CacheControl": { "target": "com.amazonaws.s3control#NonEmptyMaxLength1024String", "traits": { "smithy.api#documentation": "" } }, "ContentDisposition": { "target": "com.amazonaws.s3control#NonEmptyMaxLength1024String", "traits": { "smithy.api#documentation": "" } }, "ContentEncoding": { "target": "com.amazonaws.s3control#NonEmptyMaxLength1024String", "traits": { "smithy.api#documentation": "" } }, "ContentLanguage": { "target": "com.amazonaws.s3control#NonEmptyMaxLength1024String", "traits": { "smithy.api#documentation": "" } }, "UserMetadata": { "target": "com.amazonaws.s3control#S3UserMetadata", "traits": { "smithy.api#documentation": "" } }, "ContentLength": { "target": "com.amazonaws.s3control#S3ContentLength", "traits": { "smithy.api#default": null, "smithy.api#documentation": "\n This member has been deprecated.\n
\n " } }, "ContentMD5": { "target": "com.amazonaws.s3control#NonEmptyMaxLength1024String", "traits": { "smithy.api#documentation": "\n This member has been deprecated.\n
\n " } }, "ContentType": { "target": "com.amazonaws.s3control#NonEmptyMaxLength1024String", "traits": { "smithy.api#documentation": "" } }, "HttpExpiresDate": { "target": "com.amazonaws.s3control#TimeStamp", "traits": { "smithy.api#documentation": "" } }, "RequesterCharged": { "target": "com.amazonaws.s3control#Boolean", "traits": { "smithy.api#default": false, "smithy.api#documentation": "\n This member has been deprecated.\n
\n " } }, "SSEAlgorithm": { "target": "com.amazonaws.s3control#S3SSEAlgorithm", "traits": { "smithy.api#documentation": "The server-side encryption algorithm used when storing objects in Amazon S3.
\n\n Directory buckets - For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) and server-side encryption with KMS keys (SSE-KMS) (KMS). For more\n information, see Protecting data with server-side encryption in the Amazon S3 User Guide. For the Copy operation in Batch Operations, see S3CopyObjectOperation.
Directs the specified job to invoke ReplicateObject on every object in the\n job's manifest.
The date when the applied Object Lock retention will expire on all objects set by the\n Batch Operations job.
" } }, "Mode": { "target": "com.amazonaws.s3control#S3ObjectLockRetentionMode", "traits": { "smithy.api#documentation": "The Object Lock retention mode to be applied to all objects in the Batch Operations\n job.
" } }, "EventHold": { "target": "com.amazonaws.s3control#S3ObjectLockRetentionEventHold", "traits": { "smithy.api#documentation": "The event hold status to be applied to all objects in the Batch Operations job. Set to\n ON to enable an event hold or OFF to disable it.
The event hold duration to be applied to all objects in the Batch Operations job. The duration\n specifies how long the object remains protected after the event hold is released.
" } } }, "traits": { "smithy.api#documentation": "Contains the S3 Object Lock retention mode to be applied to all objects in the\n S3 Batch Operations job. If you don't provide Mode and RetainUntilDate\n data types in your operation, you will remove the retention from your objects. For more\n information, see Using S3 Object Lock retention\n with S3 Batch Operations in the Amazon S3 User Guide.
Contains the configuration parameters for a\n PUT\n Object ACL operation. S3 Batch Operations passes every object to the underlying\n PutObjectAcl\n API\n operation. For more information about the parameters for this operation,\n see PutObjectAcl.
Contains the Object Lock legal hold status to be applied to all objects in the\n Batch Operations job.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Contains the configuration for an S3 Object Lock legal hold operation that an\n S3 Batch Operations job passes\n to\n every object to the underlying\n PutObjectLegalHold\n API\n operation. For more information, see Using S3 Object Lock legal hold\n with S3 Batch Operations in the Amazon S3 User Guide.
This functionality is not supported by directory buckets.
\nIndicates if the action should be applied to objects in the Batch Operations job even if they\n have Object Lock GOVERNANCE type in place.
Contains the Object Lock retention mode to be applied to all objects in the Batch Operations\n job. For more information, see Using S3 Object Lock retention\n with S3 Batch Operations in the Amazon S3 User Guide.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Contains the configuration parameters for the Object Lock retention action for an\n S3 Batch Operations job. Batch Operations passes every object to the underlying\n PutObjectRetention\n API\n operation. For more information, see Using S3 Object Lock retention\n with S3 Batch Operations in the Amazon S3 User Guide.
This functionality is not supported by directory buckets.
\nContains the configuration parameters for a\n PUT\n Object Tagging operation. S3 Batch Operations passes every object to the underlying\n PutObjectTagging\n API\n operation. For more information about the parameters for this operation,\n see PutObjectTagging.
Key of the tag
", "smithy.api#required": {} } }, "Value": { "target": "com.amazonaws.s3control#TagValueString", "traits": { "smithy.api#documentation": "Value of the tag
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A container for a key-value name pair.
" } }, "com.amazonaws.s3control#S3TagSet": { "type": "list", "member": { "target": "com.amazonaws.s3control#S3Tag" } }, "com.amazonaws.s3control#S3UpdateObjectEncryptionOperation": { "type": "structure", "members": { "ObjectEncryption": { "target": "com.amazonaws.s3control#ObjectEncryption", "traits": { "smithy.api#documentation": "The updated server-side encryption type for this S3 object. The\n UpdateObjectEncryption operation supports the\n SSE-KMS encryption type.
With the UpdateObjectEncryption operation, you can atomically\n update the server-side encryption type of an existing object in a general\n purpose bucket without any data movement.
Specifies the Amazon Web Services KMS key Amazon Resource Name (ARN) to use for the\n updated server-side encryption type. Required if UpdateObjectEncryption\n specifies SSEKMS.
Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption\n with server-side encryption using Key Management Service (KMS) keys (SSE-KMS). If this\n value isn't specified, it defaults to false. Setting this value\n to true causes Amazon S3 to use an S3 Bucket Key for update object\n encryption with SSE-KMS.
If SSEKMS is specified for UpdateObjectEncryption,\n this data type specifies the Amazon Web Services KMS key Amazon Resource Name (ARN) to use\n and whether to use an S3 Bucket Key for server-side encryption using \n Key Management Service (KMS) keys (SSE-KMS).
A filter that returns objects that are encrypted by server-side encryption with customer-provided keys (SSE-C).
" } }, "com.amazonaws.s3control#SSEKMS": { "type": "structure", "members": { "KeyId": { "target": "com.amazonaws.s3control#SSEKMSKeyId", "traits": { "smithy.api#documentation": "A container for the ARN of the SSE-KMS encryption. This property is read-only and\n follows the following format: \n arn:aws:kms:us-east-1:example-account-id:key/example-9a73-4afc-8d29-8f5900cef44e\n \n
Specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric encryption\n customer managed key to use for encrypting generated manifest objects.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Configuration for the use of SSE-KMS to encrypt generated manifest objects.
", "smithy.api#xmlName": "SSE-KMS" } }, "com.amazonaws.s3control#SSEKMSFilter": { "type": "structure", "members": { "KmsKeyArn": { "target": "com.amazonaws.s3control#NonEmptyKmsKeyArnString", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the customer managed KMS key to use for the filter to return objects that are encrypted by the specified key. For best performance, use keys in the same Region as the S3 Batch Operations job.
" } }, "BucketKeyEnabled": { "target": "com.amazonaws.s3control#Boolean", "traits": { "smithy.api#default": null, "smithy.api#documentation": "Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using Amazon Web Services Key Management Service (Amazon Web Services KMS) keys (SSE-KMS). If specified, will filter SSE-KMS encrypted objects by S3 Bucket Key status.
" } } }, "traits": { "smithy.api#documentation": "A filter that returns objects that are encrypted by server-side encryption with Amazon Web Services KMS (SSE-KMS).
" } }, "com.amazonaws.s3control#SSEKMSKeyId": { "type": "string" }, "com.amazonaws.s3control#SSES3": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "", "smithy.api#xmlName": "SSE-S3" } }, "com.amazonaws.s3control#SSES3Encryption": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "Configuration for the use of SSE-S3 to encrypt generated manifest objects.
", "smithy.api#xmlName": "SSE-S3" } }, "com.amazonaws.s3control#SSES3Filter": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "A filter that returns objects that are encrypted by server-side encryption with Amazon S3 managed keys (SSE-S3).
" } }, "com.amazonaws.s3control#Scope": { "type": "structure", "members": { "Prefixes": { "target": "com.amazonaws.s3control#PrefixesList", "traits": { "smithy.api#documentation": "You can specify any amount of prefixes, but the total length of characters of all prefixes must be less than 256 bytes in size.
", "smithy.api#xmlName": "Prefixes" } }, "Permissions": { "target": "com.amazonaws.s3control#ScopePermissionList", "traits": { "smithy.api#documentation": "You can include one or more API operations as permissions.
", "smithy.api#xmlName": "Permissions" } } }, "traits": { "smithy.api#documentation": "You can use the access point scope to restrict access to specific prefixes, API operations, or a combination of both.
\nFor more information, see Manage the scope of your access points for directory buckets.
" } }, "com.amazonaws.s3control#ScopePermission": { "type": "enum", "members": { "GetObject": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "GetObject" } }, "GetObjectAttributes": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "GetObjectAttributes" } }, "ListMultipartUploadParts": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ListMultipartUploadParts" } }, "ListBucket": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ListBucket" } }, "ListBucketMultipartUploads": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ListBucketMultipartUploads" } }, "PutObject": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PutObject" } }, "DeleteObject": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DeleteObject" } }, "AbortMultipartUpload": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AbortMultipartUpload" } } } }, "com.amazonaws.s3control#ScopePermissionList": { "type": "list", "member": { "target": "com.amazonaws.s3control#ScopePermission", "traits": { "smithy.api#xmlName": "Permission" } } }, "com.amazonaws.s3control#SecretAccessKey": { "type": "string", "traits": { "smithy.api#sensitive": {} } }, "com.amazonaws.s3control#SelectionCriteria": { "type": "structure", "members": { "Delimiter": { "target": "com.amazonaws.s3control#StorageLensPrefixLevelDelimiter", "traits": { "smithy.api#documentation": "A container for the delimiter of the selection criteria being used.
" } }, "MaxDepth": { "target": "com.amazonaws.s3control#StorageLensPrefixLevelMaxDepth", "traits": { "smithy.api#documentation": "The max depth of the selection criteria
" } }, "MinStorageBytesPercentage": { "target": "com.amazonaws.s3control#MinStorageBytesPercentage", "traits": { "smithy.api#documentation": "The minimum percentage of total bucket storage that a prefix must hold for its metrics to be included.
" } } }, "traits": { "smithy.api#documentation": "" } }, "com.amazonaws.s3control#SessionToken": { "type": "string", "traits": { "smithy.api#sensitive": {} } }, "com.amazonaws.s3control#Setting": { "type": "boolean", "traits": { "smithy.api#default": false } }, "com.amazonaws.s3control#SourceSelectionCriteria": { "type": "structure", "members": { "SseKmsEncryptedObjects": { "target": "com.amazonaws.s3control#SseKmsEncryptedObjects", "traits": { "smithy.api#documentation": "A filter that you can use to select Amazon S3 objects that are encrypted with server-side\n encryption by using Key Management Service (KMS) keys. If you include\n SourceSelectionCriteria in the replication configuration, this element is\n required.
This is not supported by Amazon S3 on Outposts buckets.
\nA filter that you can use to specify whether replica modification sync is enabled.\n S3 on Outposts replica modification sync can help you keep object metadata synchronized\n between replicas and source objects. By default, S3 on Outposts replicates metadata from the\n source objects to the replicas only. When replica modification sync is enabled,\n S3 on Outposts replicates metadata changes made to the replica copies back to the source\n object, making the replication bidirectional.
\nTo replicate object metadata modifications on replicas, you can specify this element and\n set the Status of this element to Enabled.
You must enable replica modification sync on the source and destination buckets to\n replicate replica metadata changes between the source and the replicas.
\nA container that describes additional filters for identifying the source objects that\n you want to replicate. You can choose to enable or disable the replication of these\n objects.
" } }, "com.amazonaws.s3control#SseKmsEncryptedObjects": { "type": "structure", "members": { "Status": { "target": "com.amazonaws.s3control#SseKmsEncryptedObjectsStatus", "traits": { "smithy.api#documentation": "Specifies whether Amazon S3 replicates objects that are created with server-side encryption\n by using an KMS key stored in Key Management Service.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A container for filter information that you can use to select S3 objects that are\n encrypted with Key Management Service (KMS).
\nThis is not supported by Amazon S3 on Outposts buckets.
\nA container for the Amazon Resource Name (ARN) of the Amazon Web Services organization. This property\n is read-only and follows the following format: \n arn:aws:organizations:us-east-1:example-account-id:organization/o-ex2l495dck\n \n
The Amazon Web Services organization for your S3 Storage Lens.
" } }, "com.amazonaws.s3control#StorageLensConfiguration": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.s3control#ConfigId", "traits": { "smithy.api#documentation": "A container for the Amazon S3 Storage Lens configuration ID.
", "smithy.api#required": {} } }, "AccountLevel": { "target": "com.amazonaws.s3control#AccountLevel", "traits": { "smithy.api#documentation": "A container for all the account-level configurations of your S3 Storage Lens\n configuration.
", "smithy.api#required": {} } }, "Include": { "target": "com.amazonaws.s3control#Include", "traits": { "smithy.api#documentation": "A container for what is included in this configuration. This container can only be valid\n if there is no Exclude container submitted, and it's not empty.
A container for what is excluded in this configuration. This container can only be valid\n if there is no Include container submitted, and it's not empty.
A container to specify the properties of your S3 Storage Lens metrics export including, the\n destination, schema and format.
" } }, "ExpandedPrefixesDataExport": { "target": "com.amazonaws.s3control#StorageLensExpandedPrefixesDataExport", "traits": { "smithy.api#documentation": "A container that configures your S3 Storage Lens expanded prefixes metrics report.\n
" } }, "CostAndUsageReportsPublish": { "target": "com.amazonaws.s3control#StorageLensCostAndUsageReportsPublish", "traits": { "smithy.api#documentation": "A container for the configuration used to publish S3 Storage Lens cost data to Amazon Web Services Cost and Usage Reports (Amazon Web Services CUR).
" } }, "IsEnabled": { "target": "com.amazonaws.s3control#IsEnabled", "traits": { "smithy.api#default": false, "smithy.api#documentation": "A container for whether the S3 Storage Lens configuration is enabled.
", "smithy.api#required": {} } }, "AwsOrg": { "target": "com.amazonaws.s3control#StorageLensAwsOrg", "traits": { "smithy.api#documentation": "A container for the Amazon Web Services organization for this S3 Storage Lens configuration.
" } }, "StorageLensArn": { "target": "com.amazonaws.s3control#StorageLensArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the S3 Storage Lens configuration. This property is read-only\n and follows the following format: \n arn:aws:s3:us-east-1:example-account-id:storage-lens/your-dashboard-name\n \n
A container for all prefix delimiters that are used for object keys in this S3 Storage Lens\n configuration. The prefix delimiters determine how S3 Storage Lens counts prefix depth, by\n separating the hierarchical levels in object keys.
\nIf either a prefix delimiter or existing delimiter is undefined, Amazon S3 uses the\n delimiter that\u2019s defined.
\nIf both the prefix delimiter and existing delimiter are undefined, S3 uses /\n as the default delimiter.
When custom delimiters are used, both the prefix delimiter and existing\n delimiter must specify the same special character. Otherwise, your request results\n in an error.
\nA container element for S3 Storage Lens Intelligent-Tiering access tier metrics.
" } } }, "traits": { "smithy.api#documentation": "A container for the Amazon S3 Storage Lens configuration.
" } }, "com.amazonaws.s3control#StorageLensConfigurationList": { "type": "list", "member": { "target": "com.amazonaws.s3control#ListStorageLensConfigurationEntry", "traits": { "smithy.api#xmlName": "StorageLensConfiguration" } } }, "com.amazonaws.s3control#StorageLensCostAndUsageReportsMaxDepth": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 15 } } }, "com.amazonaws.s3control#StorageLensCostAndUsageReportsMinDepth": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 15 } } }, "com.amazonaws.s3control#StorageLensCostAndUsageReportsPrefixLevel": { "type": "structure", "members": { "IsEnabled": { "target": "com.amazonaws.s3control#IsEnabled", "traits": { "smithy.api#default": false, "smithy.api#documentation": "Indicates whether prefix-level cost data publishing to Amazon Web Services CUR is enabled.
", "smithy.api#required": {} } }, "SelectionCriteria": { "target": "com.amazonaws.s3control#StorageLensCostAndUsageReportsSelectionCriteria", "traits": { "smithy.api#documentation": "A container for the selection criteria that determines the prefix depths for\n which cost data is published to Amazon Web Services CUR.
" } } }, "traits": { "smithy.api#documentation": "A container for the prefix-level configuration that determines the prefixes\n for which S3 Storage Lens publishes cost data to Amazon Web Services Cost and Usage Reports (Amazon Web Services CUR).
" } }, "com.amazonaws.s3control#StorageLensCostAndUsageReportsPublish": { "type": "structure", "members": { "PrefixLevel": { "target": "com.amazonaws.s3control#StorageLensCostAndUsageReportsPrefixLevel", "traits": { "smithy.api#documentation": "A container for the prefix-level configuration that determines the prefixes\n for which S3 Storage Lens publishes cost data to Amazon Web Services CUR.
" } } }, "traits": { "smithy.api#documentation": "A container for the configuration used to publish S3 Storage Lens cost data to Amazon Web Services Cost and Usage Reports (Amazon Web Services CUR).
" } }, "com.amazonaws.s3control#StorageLensCostAndUsageReportsSelectionCriteria": { "type": "structure", "members": { "MinDepth": { "target": "com.amazonaws.s3control#StorageLensCostAndUsageReportsMinDepth", "traits": { "smithy.api#documentation": "The minimum prefix depth (inclusive) for which cost data is published\n to Amazon Web Services CUR. You must provide both MinDepth and\n MaxDepth together, or neither. If neither is provided,\n MinDepth defaults to 1.
The maximum prefix depth (inclusive) for which cost data is published\n to Amazon Web Services CUR. You must provide both MinDepth and\n MaxDepth together, or neither. If neither is provided,\n MaxDepth defaults to 3.
A container for the selection criteria used by the S3 Storage Lens Amazon Web Services Cost and Usage Reports (Amazon Web Services CUR)\n publish configuration. The selection criteria specifies the minimum and maximum\n prefix depth (both inclusive) for which cost data is published to\n Amazon Web Services CUR. You must provide both MinDepth and MaxDepth\n together, or neither; MinDepth must be less than or equal to\n MaxDepth, and the difference must not exceed 4. If neither is\n provided, MinDepth defaults to 1 and\n MaxDepth defaults to 3.
A container for the bucket where the S3 Storage Lens metrics export will be located.
\nThis bucket must be located in the same Region as the storage lens configuration.\n
\nA container for enabling Amazon CloudWatch publishing for S3 Storage Lens metrics.
" } }, "StorageLensTableDestination": { "target": "com.amazonaws.s3control#StorageLensTableDestination", "traits": { "smithy.api#documentation": "A container for configuring S3 Storage Lens data exports to read-only S3 table buckets.
" } } }, "traits": { "smithy.api#documentation": "A container to specify the properties of your S3 Storage Lens metrics export, including the\n destination, schema, and format.
" } }, "com.amazonaws.s3control#StorageLensDataExportEncryption": { "type": "structure", "members": { "SSES3": { "target": "com.amazonaws.s3control#SSES3", "traits": { "smithy.api#documentation": "", "smithy.api#xmlName": "SSE-S3" } }, "SSEKMS": { "target": "com.amazonaws.s3control#SSEKMS", "traits": { "smithy.api#documentation": "", "smithy.api#xmlName": "SSE-KMS" } } }, "traits": { "smithy.api#documentation": "A container for the encryption of the S3 Storage Lens metrics exports.
" } }, "com.amazonaws.s3control#StorageLensExpandedPrefixesDataExport": { "type": "structure", "members": { "S3BucketDestination": { "target": "com.amazonaws.s3control#S3BucketDestination" }, "StorageLensTableDestination": { "target": "com.amazonaws.s3control#StorageLensTableDestination", "traits": { "smithy.api#documentation": "A container for the bucket where the S3 Storage Lens metric export files are located. At least one export destination must be specified.
" } } }, "traits": { "smithy.api#documentation": "A container for your S3 Storage Lens expanded prefix metrics report configuration. Unlike the\n default Storage Lens metrics report, the enhanced prefix metrics report includes all\n S3 Storage Lens storage and activity data related to the full list of prefixes in your Storage\n Lens configuration.
" } }, "com.amazonaws.s3control#StorageLensGroup": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.s3control#StorageLensGroupName", "traits": { "smithy.api#documentation": "Contains the name of the Storage Lens group.
", "smithy.api#required": {} } }, "Filter": { "target": "com.amazonaws.s3control#StorageLensGroupFilter", "traits": { "smithy.api#documentation": "Sets the criteria for the Storage Lens group data that is displayed. For multiple filter\n conditions, the AND or OR logical operator is used.
Contains the Amazon Resource Name (ARN) of the Storage Lens group. This property is\n read-only.
" } } }, "traits": { "smithy.api#documentation": "A custom grouping of objects that include filters for prefixes, suffixes, object tags,\n object size, or object age. You can create an S3 Storage Lens group that includes a single\n filter or multiple filter conditions. To specify multiple filter conditions, you use\n AND or OR logical operators.
Contains a list of prefixes. At least one prefix must be specified. Up to 10 prefixes\n are allowed.
" } }, "MatchAnySuffix": { "target": "com.amazonaws.s3control#MatchAnySuffix", "traits": { "smithy.api#documentation": "Contains a list of suffixes. At least one suffix must be specified. Up to 10 suffixes\n are allowed.
" } }, "MatchAnyTag": { "target": "com.amazonaws.s3control#MatchAnyTag", "traits": { "smithy.api#documentation": "Contains the list of object tags. At least one object tag must be specified. Up to 10\n object tags are allowed.
" } }, "MatchObjectAge": { "target": "com.amazonaws.s3control#MatchObjectAge", "traits": { "smithy.api#documentation": " Contains DaysGreaterThan and DaysLessThan to define the\n object age range (minimum and maximum number of days).
Contains BytesGreaterThan and BytesLessThan to define the\n object size range (minimum and maximum number of Bytes).
A logical operator that allows multiple filter conditions to be joined for more complex\n comparisons of Storage Lens group data.
" } }, "com.amazonaws.s3control#StorageLensGroupArn": { "type": "string", "traits": { "smithy.api#length": { "min": 4, "max": 1024 }, "smithy.api#pattern": "^arn:[a-z\\-]+:s3:[a-z0-9\\-]+:\\d{12}:storage\\-lens\\-group\\/" } }, "com.amazonaws.s3control#StorageLensGroupFilter": { "type": "structure", "members": { "MatchAnyPrefix": { "target": "com.amazonaws.s3control#MatchAnyPrefix", "traits": { "smithy.api#documentation": "Contains a list of prefixes. At least one prefix must be specified. Up to 10 prefixes\n are allowed.
" } }, "MatchAnySuffix": { "target": "com.amazonaws.s3control#MatchAnySuffix", "traits": { "smithy.api#documentation": "Contains a list of suffixes. At least one suffix must be specified. Up to 10 suffixes\n are allowed.
" } }, "MatchAnyTag": { "target": "com.amazonaws.s3control#MatchAnyTag", "traits": { "smithy.api#documentation": "Contains the list of S3 object tags. At least one object tag must be specified. Up to\n 10 object tags are allowed.
" } }, "MatchObjectAge": { "target": "com.amazonaws.s3control#MatchObjectAge", "traits": { "smithy.api#documentation": " Contains DaysGreaterThan and DaysLessThan to define the\n object age range (minimum and maximum number of days).
Contains BytesGreaterThan and BytesLessThan to define the\n object size range (minimum and maximum number of Bytes).
A logical operator that allows multiple filter conditions to be joined for more complex\n comparisons of Storage Lens group data. Objects must match all of the listed filter\n conditions that are joined by the And logical operator. Only one of each\n filter condition is allowed.
A single logical operator that allows multiple filter conditions to be joined. Objects\n can match any of the listed filter conditions, which are joined by the Or\n logical operator. Only one of each filter condition is allowed.
The filter element sets the criteria for the Storage Lens group data that is displayed.\n For multiple filter conditions, the AND or OR logical operator is\n used.
Indicates which Storage Lens group ARNs to include or exclude in the Storage Lens group\n aggregation. If this value is left null, then all Storage Lens groups are selected.
" } } }, "traits": { "smithy.api#documentation": "Specifies the Storage Lens groups to include in the Storage Lens group aggregation.\n
" } }, "com.amazonaws.s3control#StorageLensGroupLevelExclude": { "type": "list", "member": { "target": "com.amazonaws.s3control#StorageLensGroupArn", "traits": { "smithy.api#xmlName": "Arn" } } }, "com.amazonaws.s3control#StorageLensGroupLevelInclude": { "type": "list", "member": { "target": "com.amazonaws.s3control#StorageLensGroupArn", "traits": { "smithy.api#xmlName": "Arn" } } }, "com.amazonaws.s3control#StorageLensGroupLevelSelectionCriteria": { "type": "structure", "members": { "Include": { "target": "com.amazonaws.s3control#StorageLensGroupLevelInclude", "traits": { "smithy.api#documentation": "Indicates which Storage Lens group ARNs to include in the Storage Lens group\n aggregation.
" } }, "Exclude": { "target": "com.amazonaws.s3control#StorageLensGroupLevelExclude", "traits": { "smithy.api#documentation": "Indicates which Storage Lens group ARNs to exclude from the Storage Lens group\n aggregation.
" } } }, "traits": { "smithy.api#documentation": "Indicates which Storage Lens group ARNs to include or exclude in the Storage Lens group\n aggregation. You can only attach Storage Lens groups to your Storage Lens dashboard if\n they're included in your Storage Lens group aggregation. If this value is left null, then\n all Storage Lens groups are selected.
" } }, "com.amazonaws.s3control#StorageLensGroupList": { "type": "list", "member": { "target": "com.amazonaws.s3control#ListStorageLensGroupEntry", "traits": { "smithy.api#xmlName": "StorageLensGroup" } } }, "com.amazonaws.s3control#StorageLensGroupName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^[a-zA-Z0-9\\-\\_]+$" } }, "com.amazonaws.s3control#StorageLensGroupOrOperator": { "type": "structure", "members": { "MatchAnyPrefix": { "target": "com.amazonaws.s3control#MatchAnyPrefix", "traits": { "smithy.api#documentation": "Filters objects that match any of the specified prefixes.
" } }, "MatchAnySuffix": { "target": "com.amazonaws.s3control#MatchAnySuffix", "traits": { "smithy.api#documentation": "\nFilters objects that match any of the specified suffixes.\n
" } }, "MatchAnyTag": { "target": "com.amazonaws.s3control#MatchAnyTag", "traits": { "smithy.api#documentation": "\nFilters objects that match any of the specified S3 object tags.\n
" } }, "MatchObjectAge": { "target": "com.amazonaws.s3control#MatchObjectAge", "traits": { "smithy.api#documentation": "\nFilters objects that match the specified object age range.\n
" } }, "MatchObjectSize": { "target": "com.amazonaws.s3control#MatchObjectSize", "traits": { "smithy.api#documentation": "\nFilters objects that match the specified object size range.\n
" } } }, "traits": { "smithy.api#documentation": "A container element for specifying Or rule conditions. The rule conditions\n determine the subset of objects to which the Or rule applies. Objects can\n match any of the listed filter conditions, which are joined by the Or logical\n operator. Only one of each filter condition is allowed.
A container that indicates whether the export to read-only S3 table buckets is enabled\n for your S3 Storage Lens configuration. When set to true, Storage Lens reports are automatically\n exported to tables in addition to other configured destinations.
", "smithy.api#required": {} } }, "Encryption": { "target": "com.amazonaws.s3control#StorageLensDataExportEncryption" } }, "traits": { "smithy.api#documentation": "A container for configuring your S3 Storage Lens reports to export to read-only S3 table\n buckets. This parameter enables you to store your Storage Lens metrics in a structured,\n queryable table format in Apache Iceberg.
\nFor more information about S3 Storage Lens, see Assessing your storage activity and usage with S3 Storage Lens in the Amazon S3 User Guide.
" } }, "com.amazonaws.s3control#StorageLensTag": { "type": "structure", "members": { "Key": { "target": "com.amazonaws.s3control#TagKeyString", "traits": { "smithy.api#documentation": "", "smithy.api#required": {} } }, "Value": { "target": "com.amazonaws.s3control#TagValueString", "traits": { "smithy.api#documentation": "", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "" } }, "com.amazonaws.s3control#StorageLensTags": { "type": "list", "member": { "target": "com.amazonaws.s3control#StorageLensTag", "traits": { "smithy.api#xmlName": "Tag" } } }, "com.amazonaws.s3control#StringForNextToken": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1024 }, "smithy.api#pattern": "^[A-Za-z0-9\\+\\:\\/\\=\\?\\#-_]+$" } }, "com.amazonaws.s3control#SubmitMultiRegionAccessPointRoutes": { "type": "operation", "input": { "target": "com.amazonaws.s3control#SubmitMultiRegionAccessPointRoutesRequest" }, "output": { "target": "com.amazonaws.s3control#SubmitMultiRegionAccessPointRoutesResult" }, "traits": { "smithy.api#documentation": "This operation is not supported by directory buckets.
\nSubmits an updated route configuration for a Multi-Region Access Point. This API operation updates the\n routing status for the specified Regions from active to passive, or from passive to active.\n A value of 0 indicates a passive status, which means that traffic won't be\n routed to the specified Region. A value of 100 indicates an active status,\n which means that traffic will be routed to the specified Region. At least one Region must\n be active at all times.
When the routing configuration is changed, any in-progress operations (uploads, copies,\n deletes, and so on) to formerly active Regions will continue to run to their final\n completion state (success or failure). The routing configurations of any Regions that\n aren\u2019t specified remain unchanged.
\nUpdated routing configurations might not be immediately applied. It can take up to 2\n minutes for your changes to take effect.
\nTo submit routing control changes and failover requests, use the Amazon S3 failover control\n infrastructure endpoints in these five Amazon Web Services Regions:
\n\n us-east-1\n
\n us-west-2\n
\n ap-southeast-2\n
\n ap-northeast-1\n
\n eu-west-1\n
The Amazon Web Services account ID for the owner of the Multi-Region Access Point.
", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "AccountId" } } }, "Mrap": { "target": "com.amazonaws.s3control#MultiRegionAccessPointId", "traits": { "smithy.api#documentation": "The Multi-Region Access Point ARN.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "RouteUpdates": { "target": "com.amazonaws.s3control#RouteList", "traits": { "smithy.api#documentation": "The different routes that make up the new route configuration. Active routes return a\n value of 100, and passive routes return a value of 0.
The key of the key-value pair of a tag added to your Amazon Web Services resource. A tag key can be up to 128 Unicode characters in length and is case-sensitive. System created tags that begin with aws: aren\u2019t supported.\n
\n The value of the key-value pair of a tag added to your Amazon Web Services resource. A tag value can be up to 256 Unicode characters in length and is case-sensitive.\n
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "\n A key-value pair that you use to label your resources. You can add tags to new resources when you create them, or you can add tags to existing resources. Tags can help you organize, track costs for, and control access to resources.\n
" } }, "com.amazonaws.s3control#TagKeyList": { "type": "list", "member": { "target": "com.amazonaws.s3control#TagKeyString" }, "traits": { "smithy.api#length": { "min": 0, "max": 50 } } }, "com.amazonaws.s3control#TagKeyString": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" } }, "com.amazonaws.s3control#TagList": { "type": "list", "member": { "target": "com.amazonaws.s3control#Tag", "traits": { "smithy.api#xmlName": "Tag" } }, "traits": { "smithy.api#length": { "min": 0, "max": 50 } } }, "com.amazonaws.s3control#TagResource": { "type": "operation", "input": { "target": "com.amazonaws.s3control#TagResourceRequest" }, "output": { "target": "com.amazonaws.s3control#TagResourceResult" }, "traits": { "smithy.api#documentation": "Creates a new user-defined tag or updates an existing tag. Each tag is a label consisting of a key and value that is applied to your resource. Tags can help you organize, track costs for, and control access to your resources. You can add up to 50 Amazon Web Services resource tags for each S3 resource.
\nThis operation is only supported for the following Amazon S3 resource:
\n\n Directory buckets\n
\n\n S3 Access Grants instances, registered locations, or grants.
\nFor general purpose buckets, access points for general purpose buckets, Storage Lens groups, and S3 Access Grants, you must have the s3:TagResource permission to use this operation.
For directory buckets, you must have the s3express:TagResource permission to use this operation. For more information about directory buckets policies and permissions, see Identity and Access Management (IAM) for S3 Express One Zone in the Amazon S3 User Guide.
\n Directory buckets - The HTTP Host header syntax is s3express-control.region.amazonaws.com.
For information about S3 Tagging errors, see List of Amazon S3 Tagging error codes.
", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, "smithy.api#http": { "method": "POST", "uri": "/v20180820/tags/{ResourceArn+}", "code": 204 }, "smithy.rules#staticContextParams": { "RequiresAccountId": { "value": true } } } }, "com.amazonaws.s3control#TagResourceRequest": { "type": "structure", "members": { "AccountId": { "target": "com.amazonaws.s3control#AccountId", "traits": { "smithy.api#documentation": "\nThe Amazon Web Services account ID that created the S3 resource that you're trying to add tags to or the requester's account ID. \n
", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "AccountId" } } }, "ResourceArn": { "target": "com.amazonaws.s3control#S3ResourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the S3 resource that you're applying tags to. The tagged resource can be a directory bucket, S3 Storage Lens group or S3 Access Grants instance, registered location, or grant.
", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "ResourceArn" } } }, "Tags": { "target": "com.amazonaws.s3control#TagList", "traits": { "smithy.api#documentation": "\nThe Amazon Web Services resource tags that you want to add to the specified S3 resource. \n
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.s3control#TagResourceResult": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.s3control#TagValueString": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 }, "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" } }, "com.amazonaws.s3control#Tagging": { "type": "structure", "members": { "TagSet": { "target": "com.amazonaws.s3control#S3TagSet", "traits": { "smithy.api#documentation": "A collection for a set of tags.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "" } }, "com.amazonaws.s3control#TimeStamp": { "type": "timestamp" }, "com.amazonaws.s3control#TooManyRequestsException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.s3control#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "", "smithy.api#error": "client" } }, "com.amazonaws.s3control#TooManyTagsException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.s3control#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "Amazon S3 throws this exception if you have too many tags in your tag set.
", "smithy.api#error": "client" } }, "com.amazonaws.s3control#TrafficDialPercentage": { "type": "integer", "traits": { "smithy.api#range": { "min": 0, "max": 100 } } }, "com.amazonaws.s3control#Transition": { "type": "structure", "members": { "Date": { "target": "com.amazonaws.s3control#Date", "traits": { "smithy.api#documentation": "Indicates when objects are transitioned to the specified storage class. The date value\n must be in ISO 8601 format. The time is always midnight UTC.
" } }, "Days": { "target": "com.amazonaws.s3control#Days", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "Indicates the number of days after creation when objects are transitioned to the\n specified storage class. The value must be a positive integer.
" } }, "StorageClass": { "target": "com.amazonaws.s3control#TransitionStorageClass", "traits": { "smithy.api#documentation": "The storage class to which you want the object to transition.
" } } }, "traits": { "smithy.api#documentation": "Specifies when an object transitions to a specified storage class. For more information\n about Amazon S3 Lifecycle configuration rules, see \n Transitioning objects using Amazon S3 Lifecycle in the\n Amazon S3 User Guide.
" } }, "com.amazonaws.s3control#TransitionList": { "type": "list", "member": { "target": "com.amazonaws.s3control#Transition", "traits": { "smithy.api#xmlName": "Transition" } } }, "com.amazonaws.s3control#TransitionStorageClass": { "type": "enum", "members": { "GLACIER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "GLACIER" } }, "STANDARD_IA": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "STANDARD_IA" } }, "ONEZONE_IA": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ONEZONE_IA" } }, "INTELLIGENT_TIERING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INTELLIGENT_TIERING" } }, "DEEP_ARCHIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DEEP_ARCHIVE" } } } }, "com.amazonaws.s3control#UntagResource": { "type": "operation", "input": { "target": "com.amazonaws.s3control#UntagResourceRequest" }, "output": { "target": "com.amazonaws.s3control#UntagResourceResult" }, "traits": { "smithy.api#documentation": "This operation removes the specified user-defined tags from an S3 resource. You can pass one or more tag keys.
\nThis operation is only supported for the following Amazon S3 resources:
\n\n Directory buckets\n
\n\n S3 Access Grants instances, registered locations, and grants.
\nFor general purpose buckets, access points for general purpose buckets, Storage Lens groups, and S3 Access Grants, you must have the s3:UntagResource permission to use this operation.
For directory buckets, you must have the s3express:UntagResource permission to use this operation. For more information about directory buckets policies and permissions, see Identity and Access Management (IAM) for S3 Express One Zone in the Amazon S3 User Guide.
\n Directory buckets - The HTTP Host header syntax is s3express-control.region.amazonaws.com.
For information about S3 Tagging errors, see List of Amazon S3\n Tagging error codes.
", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, "smithy.api#http": { "method": "DELETE", "uri": "/v20180820/tags/{ResourceArn+}", "code": 204 }, "smithy.rules#staticContextParams": { "RequiresAccountId": { "value": true } } } }, "com.amazonaws.s3control#UntagResourceRequest": { "type": "structure", "members": { "AccountId": { "target": "com.amazonaws.s3control#AccountId", "traits": { "smithy.api#documentation": "\n The Amazon Web Services account ID that owns the resource that you're trying to remove the tags from.\n
", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "AccountId" } } }, "ResourceArn": { "target": "com.amazonaws.s3control#S3ResourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the S3 resource that you're removing tags from. The tagged resource can be a directory bucket, S3 Storage Lens group or S3 Access Grants instance, registered location, or grant.
", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "ResourceArn" } } }, "TagKeys": { "target": "com.amazonaws.s3control#TagKeyList", "traits": { "smithy.api#documentation": "\n The array of tag key-value pairs that you're trying to remove from of the S3 resource.\n
", "smithy.api#httpQuery": "tagKeys", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.s3control#UntagResourceResult": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.s3control#UpdateAccessGrantsLocation": { "type": "operation", "input": { "target": "com.amazonaws.s3control#UpdateAccessGrantsLocationRequest" }, "output": { "target": "com.amazonaws.s3control#UpdateAccessGrantsLocationResult" }, "traits": { "smithy.api#documentation": "Updates the IAM role of a registered location in your S3 Access Grants instance.
\nYou must have the s3:UpdateAccessGrantsLocation permission to use this operation.
You must also have the following permission: iam:PassRole\n
The Amazon Web Services account ID of the S3 Access Grants instance.
", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "AccountId" } } }, "AccessGrantsLocationId": { "target": "com.amazonaws.s3control#AccessGrantsLocationId", "traits": { "smithy.api#documentation": "The ID of the registered location that you are updating. S3 Access Grants assigns this ID when you register the location. S3 Access Grants assigns the ID default to the default location s3:// and assigns an auto-generated ID to other locations that you register.
The ID of the registered location to which you are granting access. S3 Access Grants assigned this ID when you registered the location. S3 Access Grants assigns the ID default to the default location s3:// and assigns an auto-generated ID to other locations that you register.
If you are passing the default location, you cannot create an access grant for the entire default location. You must also specify a bucket or a bucket and prefix in the Subprefix field.
The Amazon Resource Name (ARN) of the IAM role for the registered location. S3 Access Grants assumes this role to manage access to the registered location.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.s3control#UpdateAccessGrantsLocationResult": { "type": "structure", "members": { "CreatedAt": { "target": "com.amazonaws.s3control#CreationTimestamp", "traits": { "smithy.api#documentation": "The date and time when you registered the location.
" } }, "AccessGrantsLocationId": { "target": "com.amazonaws.s3control#AccessGrantsLocationId", "traits": { "smithy.api#documentation": "The ID of the registered location to which you are granting access. S3 Access Grants assigned this ID when you registered the location. S3 Access Grants assigns the ID default to the default location s3:// and assigns an auto-generated ID to other locations that you register.
The Amazon Resource Name (ARN) of the registered location that you are updating.
" } }, "LocationScope": { "target": "com.amazonaws.s3control#S3Prefix", "traits": { "smithy.api#documentation": "The S3 URI path of the location that you are updating. You cannot update the scope of the registered location. The location scope can be the default S3 location s3://, the S3 path to a bucket s3://, or the S3 path to a bucket and prefix s3://.
The Amazon Resource Name (ARN) of the IAM role of the registered location. S3 Access Grants assumes this role to manage access to the registered location.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.s3control#UpdateJobPriority": { "type": "operation", "input": { "target": "com.amazonaws.s3control#UpdateJobPriorityRequest" }, "output": { "target": "com.amazonaws.s3control#UpdateJobPriorityResult" }, "errors": [ { "target": "com.amazonaws.s3control#BadRequestException" }, { "target": "com.amazonaws.s3control#InternalServiceException" }, { "target": "com.amazonaws.s3control#NotFoundException" }, { "target": "com.amazonaws.s3control#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Updates an existing S3 Batch Operations job's priority. For more information, see S3 Batch Operations in the Amazon S3 User Guide.
\nTo use the\n UpdateJobPriority operation, you must have permission to\n perform the s3:UpdateJobPriority action.
Related actions include:
\n\n CreateJob\n
\n\n ListJobs\n
\n\n DescribeJob\n
\n\n UpdateJobStatus\n
\nThe Amazon Web Services account ID associated with the S3 Batch Operations job.
", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "AccountId" } } }, "JobId": { "target": "com.amazonaws.s3control#JobId", "traits": { "smithy.api#documentation": "The ID for the job whose priority you want to update.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "Priority": { "target": "com.amazonaws.s3control#JobPriority", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "The priority you want to assign to this job.
", "smithy.api#httpQuery": "priority", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.s3control#UpdateJobPriorityResult": { "type": "structure", "members": { "JobId": { "target": "com.amazonaws.s3control#JobId", "traits": { "smithy.api#documentation": "The ID for the job whose priority Amazon S3 updated.
", "smithy.api#required": {} } }, "Priority": { "target": "com.amazonaws.s3control#JobPriority", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "The new priority assigned to the specified job.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.s3control#UpdateJobStatus": { "type": "operation", "input": { "target": "com.amazonaws.s3control#UpdateJobStatusRequest" }, "output": { "target": "com.amazonaws.s3control#UpdateJobStatusResult" }, "errors": [ { "target": "com.amazonaws.s3control#BadRequestException" }, { "target": "com.amazonaws.s3control#InternalServiceException" }, { "target": "com.amazonaws.s3control#JobStatusException" }, { "target": "com.amazonaws.s3control#NotFoundException" }, { "target": "com.amazonaws.s3control#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Updates the status for the specified job. Use this operation to confirm that you want to\n run a job or to cancel an existing job. For more information, see S3 Batch Operations in the Amazon S3 User Guide.
\nTo use the\n UpdateJobStatus operation, you must have permission to\n perform the s3:UpdateJobStatus action.
Related actions include:
\n\n CreateJob\n
\n\n ListJobs\n
\n\n DescribeJob\n
\n\n UpdateJobStatus\n
\nThe Amazon Web Services account ID associated with the S3 Batch Operations job.
", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "AccountId" } } }, "JobId": { "target": "com.amazonaws.s3control#JobId", "traits": { "smithy.api#documentation": "The ID of the job whose status you want to update.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "RequestedJobStatus": { "target": "com.amazonaws.s3control#RequestedJobStatus", "traits": { "smithy.api#documentation": "The status that you want to move the specified job to.
", "smithy.api#httpQuery": "requestedJobStatus", "smithy.api#required": {} } }, "StatusUpdateReason": { "target": "com.amazonaws.s3control#JobStatusUpdateReason", "traits": { "smithy.api#documentation": "A description of the reason why you want to change the specified job's status. This\n field can be any string up to the maximum length.
", "smithy.api#httpQuery": "statusUpdateReason" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.s3control#UpdateJobStatusResult": { "type": "structure", "members": { "JobId": { "target": "com.amazonaws.s3control#JobId", "traits": { "smithy.api#documentation": "The ID for the job whose status was updated.
" } }, "Status": { "target": "com.amazonaws.s3control#JobStatus", "traits": { "smithy.api#documentation": "The current status for the specified job.
" } }, "StatusUpdateReason": { "target": "com.amazonaws.s3control#JobStatusUpdateReason", "traits": { "smithy.api#documentation": "The reason that the specified job's status was updated.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.s3control#UpdateStorageLensGroup": { "type": "operation", "input": { "target": "com.amazonaws.s3control#UpdateStorageLensGroupRequest" }, "output": { "target": "smithy.api#Unit" }, "traits": { "smithy.api#documentation": "\nUpdates the existing Storage Lens group.
\nTo use this operation, you must have the permission to perform the\n s3:UpdateStorageLensGroup action. For more information about the required Storage Lens\n Groups permissions, see Setting account permissions to use S3 Storage Lens groups.
For information about Storage Lens groups errors, see List of Amazon S3 Storage\n Lens error codes.
", "smithy.api#endpoint": { "hostPrefix": "{AccountId}." }, "smithy.api#http": { "method": "PUT", "uri": "/v20180820/storagelensgroup/{Name}", "code": 204 }, "smithy.rules#staticContextParams": { "RequiresAccountId": { "value": true } } } }, "com.amazonaws.s3control#UpdateStorageLensGroupRequest": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.s3control#StorageLensGroupName", "traits": { "smithy.api#documentation": "\nThe name of the Storage Lens group that you want to update.\n
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "AccountId": { "target": "com.amazonaws.s3control#AccountId", "traits": { "smithy.api#documentation": "\nThe Amazon Web Services account ID of the Storage Lens group owner.\n
", "smithy.api#hostLabel": {}, "smithy.api#httpHeader": "x-amz-account-id", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "AccountId" } } }, "StorageLensGroup": { "target": "com.amazonaws.s3control#StorageLensGroup", "traits": { "smithy.api#documentation": "\nThe JSON file that contains the Storage Lens group configuration.\n
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.s3control#UserArguments": { "type": "map", "key": { "target": "com.amazonaws.s3control#NonEmptyMaxLength64String" }, "value": { "target": "com.amazonaws.s3control#MaxLength1024String" }, "traits": { "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.s3control#VersioningConfiguration": { "type": "structure", "members": { "MFADelete": { "target": "com.amazonaws.s3control#MFADelete", "traits": { "smithy.api#documentation": "Specifies whether MFA delete is enabled or disabled in the bucket versioning\n configuration for the S3 on Outposts bucket.
", "smithy.api#xmlName": "MfaDelete" } }, "Status": { "target": "com.amazonaws.s3control#BucketVersioningStatus", "traits": { "smithy.api#documentation": "Sets the versioning state of the S3 on Outposts bucket.
" } } }, "traits": { "smithy.api#documentation": "Describes the versioning state of an Amazon S3 on Outposts bucket. For more information, see\n PutBucketVersioning.
" } }, "com.amazonaws.s3control#VpcConfiguration": { "type": "structure", "members": { "VpcId": { "target": "com.amazonaws.s3control#VpcId", "traits": { "smithy.api#documentation": "If this field is specified, this access point will only allow connections from the specified VPC\n ID.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The virtual private cloud (VPC) configuration for an access point.
" } }, "com.amazonaws.s3control#VpcId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1024 } } } } }