AppSync provides API actions for creating and interacting with data sources using GraphQL\n from your application.
", - "smithy.api#title": "AWS AppSync", - "smithy.api#xmlNamespace": { - "uri": "http://appsync.amazonaws.com" - }, - "smithy.rules#endpointRuleSet": { - "version": "1.0", - "parameters": { - "Region": { - "builtIn": "AWS::Region", - "required": false, - "documentation": "The AWS region used to dispatch the request.", - "type": "String" - }, - "UseDualStack": { - "builtIn": "AWS::UseDualStack", - "required": true, - "default": false, - "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", - "type": "Boolean" - }, - "UseFIPS": { - "builtIn": "AWS::UseFIPS", - "required": true, - "default": false, - "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", - "type": "Boolean" - }, - "Endpoint": { - "builtIn": "SDK::Endpoint", - "required": false, - "documentation": "Override the endpoint used to send this request", - "type": "String" - } - }, - "rules": [ + "smithy": "2.0", + "metadata": { + "suppressions": [ { - "conditions": [ + "id": "HttpMethodSemantics", + "namespace": "*" + }, + { + "id": "HttpResponseCodeSemantics", + "namespace": "*" + }, + { + "id": "PaginatedTrait", + "namespace": "*" + }, + { + "id": "HttpHeaderTrait", + "namespace": "*" + }, + { + "id": "HttpUriConflict", + "namespace": "*" + }, + { + "id": "Service", + "namespace": "*" + } + ] + }, + "shapes": { + "com.amazonaws.appsync#AWSDeepdishControlPlaneService": { + "type": "service", + "version": "2017-07-25", + "operations": [ { - "fn": "isSet", - "argv": [ - { - "ref": "Endpoint" - } - ] - } - ], - "rules": [ + "target": "com.amazonaws.appsync#AssociateApi" + }, { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", - "type": "error" + "target": "com.amazonaws.appsync#AssociateMergedGraphqlApi" }, { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" + "target": "com.amazonaws.appsync#AssociateSourceGraphqlApi" }, { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" - }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [ + "target": "com.amazonaws.appsync#CreateApiCache" + }, { - "fn": "isSet", - "argv": [ - { - "ref": "Region" - } - ] - } - ], - "rules": [ + "target": "com.amazonaws.appsync#CreateApiKey" + }, { - "conditions": [ - { - "fn": "aws.partition", - "argv": [ - { - "ref": "Region" - } - ], - "assign": "PartitionResult" - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] + "target": "com.amazonaws.appsync#CreateDataSource" + }, + { + "target": "com.amazonaws.appsync#CreateDomainName" + }, + { + "target": "com.amazonaws.appsync#CreateFunction" + }, + { + "target": "com.amazonaws.appsync#CreateGraphqlApi" + }, + { + "target": "com.amazonaws.appsync#CreateResolver" + }, + { + "target": "com.amazonaws.appsync#CreateType" + }, + { + "target": "com.amazonaws.appsync#DeleteApiCache" + }, + { + "target": "com.amazonaws.appsync#DeleteApiKey" + }, + { + "target": "com.amazonaws.appsync#DeleteDataSource" + }, + { + "target": "com.amazonaws.appsync#DeleteDomainName" + }, + { + "target": "com.amazonaws.appsync#DeleteFunction" + }, + { + "target": "com.amazonaws.appsync#DeleteGraphqlApi" + }, + { + "target": "com.amazonaws.appsync#DeleteResolver" + }, + { + "target": "com.amazonaws.appsync#DeleteType" + }, + { + "target": "com.amazonaws.appsync#DisassociateApi" + }, + { + "target": "com.amazonaws.appsync#DisassociateMergedGraphqlApi" + }, + { + "target": "com.amazonaws.appsync#DisassociateSourceGraphqlApi" + }, + { + "target": "com.amazonaws.appsync#EvaluateCode" + }, + { + "target": "com.amazonaws.appsync#EvaluateMappingTemplate" + }, + { + "target": "com.amazonaws.appsync#FlushApiCache" + }, + { + "target": "com.amazonaws.appsync#GetApiAssociation" + }, + { + "target": "com.amazonaws.appsync#GetApiCache" + }, + { + "target": "com.amazonaws.appsync#GetDataSource" + }, + { + "target": "com.amazonaws.appsync#GetDataSourceIntrospection" + }, + { + "target": "com.amazonaws.appsync#GetDomainName" + }, + { + "target": "com.amazonaws.appsync#GetFunction" + }, + { + "target": "com.amazonaws.appsync#GetGraphqlApi" + }, + { + "target": "com.amazonaws.appsync#GetGraphqlApiEnvironmentVariables" + }, + { + "target": "com.amazonaws.appsync#GetIntrospectionSchema" + }, + { + "target": "com.amazonaws.appsync#GetResolver" + }, + { + "target": "com.amazonaws.appsync#GetSchemaCreationStatus" + }, + { + "target": "com.amazonaws.appsync#GetSourceApiAssociation" + }, + { + "target": "com.amazonaws.appsync#GetType" + }, + { + "target": "com.amazonaws.appsync#ListApiKeys" + }, + { + "target": "com.amazonaws.appsync#ListDataSources" + }, + { + "target": "com.amazonaws.appsync#ListDomainNames" + }, + { + "target": "com.amazonaws.appsync#ListFunctions" + }, + { + "target": "com.amazonaws.appsync#ListGraphqlApis" + }, + { + "target": "com.amazonaws.appsync#ListResolvers" + }, + { + "target": "com.amazonaws.appsync#ListResolversByFunction" + }, + { + "target": "com.amazonaws.appsync#ListSourceApiAssociations" + }, + { + "target": "com.amazonaws.appsync#ListTagsForResource" + }, + { + "target": "com.amazonaws.appsync#ListTypes" + }, + { + "target": "com.amazonaws.appsync#ListTypesByAssociation" + }, + { + "target": "com.amazonaws.appsync#PutGraphqlApiEnvironmentVariables" + }, + { + "target": "com.amazonaws.appsync#StartDataSourceIntrospection" + }, + { + "target": "com.amazonaws.appsync#StartSchemaCreation" + }, + { + "target": "com.amazonaws.appsync#StartSchemaMerge" + }, + { + "target": "com.amazonaws.appsync#TagResource" + }, + { + "target": "com.amazonaws.appsync#UntagResource" + }, + { + "target": "com.amazonaws.appsync#UpdateApiCache" + }, + { + "target": "com.amazonaws.appsync#UpdateApiKey" + }, + { + "target": "com.amazonaws.appsync#UpdateDataSource" + }, + { + "target": "com.amazonaws.appsync#UpdateDomainName" + }, + { + "target": "com.amazonaws.appsync#UpdateFunction" + }, + { + "target": "com.amazonaws.appsync#UpdateGraphqlApi" + }, + { + "target": "com.amazonaws.appsync#UpdateResolver" + }, + { + "target": "com.amazonaws.appsync#UpdateSourceApiAssociation" + }, + { + "target": "com.amazonaws.appsync#UpdateType" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "AppSync", + "arnNamespace": "appsync", + "cloudFormationName": "AppSync", + "cloudTrailEventSource": "appsync.amazonaws.com", + "endpointPrefix": "appsync" + }, + "aws.auth#sigv4": { + "name": "appsync" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "AppSync provides API actions for creating and interacting with data sources using GraphQL\n from your application.
", + "smithy.api#title": "AWS AppSync", + "smithy.api#xmlNamespace": { + "uri": "http://appsync.amazonaws.com" + }, + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" } - ], - "rules": [ + }, + "rules": [ { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, + "conditions": [ { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - true, + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} }, - "supportsDualStack" - ] + "type": "endpoint" } - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://appsync-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" + ], + "type": "tree" }, { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ + "conditions": [ { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - }, - true - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://appsync-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://appsync-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://appsync-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://appsync.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "endpoint": { + "url": "https://appsync.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" }, { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" } - ], - "type": "tree" - }, - { - "conditions": [ + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" + "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appsync.ap-east-1.amazonaws.com" + } }, - true - ] - } - ], - "rules": [ + "params": { + "Region": "ap-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appsync.ap-northeast-1.amazonaws.com" } - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://appsync.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + }, + "params": { + "Region": "ap-northeast-1", + "UseFIPS": false, + "UseDualStack": false } - ], - "type": "tree" }, { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [], - "endpoint": { - "url": "https://appsync.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appsync.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appsync.ap-northeast-3.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appsync.ap-south-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appsync.ap-southeast-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appsync.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appsync.ca-central-1.amazonaws.com" + } + }, + "params": { + "Region": "ca-central-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appsync.eu-central-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-central-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appsync.eu-north-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appsync.eu-south-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appsync.eu-west-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appsync.eu-west-2.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appsync.eu-west-3.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appsync.me-south-1.amazonaws.com" + } + }, + "params": { + "Region": "me-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appsync.sa-east-1.amazonaws.com" + } + }, + "params": { + "Region": "sa-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appsync.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appsync.us-east-2.amazonaws.com" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appsync.us-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appsync.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://appsync-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appsync-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://appsync.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appsync.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appsync.cn-northwest-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-northwest-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://appsync-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appsync-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://appsync.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://appsync-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appsync-fips.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://appsync.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appsync.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appsync-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appsync.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appsync-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://appsync.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } + } + ], + "version": "1.0" } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" } - ] }, - "smithy.rules#endpointTests": { - "testCases": [ - { - "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://appsync.ap-east-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://appsync.ap-northeast-1.amazonaws.com" + "com.amazonaws.appsync#AccessDeniedException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.appsync#String" } - }, - "params": { - "Region": "ap-northeast-1", - "UseFIPS": false, - "UseDualStack": false - } }, - { - "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://appsync.ap-northeast-2.amazonaws.com" + "traits": { + "smithy.api#documentation": "You don't have access to perform this operation on this resource.
", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.appsync#AdditionalAuthenticationProvider": { + "type": "structure", + "members": { + "authenticationType": { + "target": "com.amazonaws.appsync#AuthenticationType", + "traits": { + "smithy.api#documentation": "The authentication type: API key, Identity and Access Management (IAM), OpenID Connect (OIDC),\n Amazon Cognito user pools, or Lambda.
" + } + }, + "openIDConnectConfig": { + "target": "com.amazonaws.appsync#OpenIDConnectConfig", + "traits": { + "smithy.api#documentation": "The OIDC configuration.
" + } + }, + "userPoolConfig": { + "target": "com.amazonaws.appsync#CognitoUserPoolConfig", + "traits": { + "smithy.api#documentation": "The Amazon Cognito user pool configuration.
" + } + }, + "lambdaAuthorizerConfig": { + "target": "com.amazonaws.appsync#LambdaAuthorizerConfig", + "traits": { + "smithy.api#documentation": "Configuration for Lambda function authorization.
" + } } - }, - "params": { - "Region": "ap-northeast-2", - "UseFIPS": false, - "UseDualStack": false - } }, - { - "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://appsync.ap-northeast-3.amazonaws.com" + "traits": { + "smithy.api#documentation": "Describes an additional authentication provider.
" + } + }, + "com.amazonaws.appsync#AdditionalAuthenticationProviders": { + "type": "list", + "member": { + "target": "com.amazonaws.appsync#AdditionalAuthenticationProvider" + } + }, + "com.amazonaws.appsync#ApiAssociation": { + "type": "structure", + "members": { + "domainName": { + "target": "com.amazonaws.appsync#DomainName", + "traits": { + "smithy.api#documentation": "The domain name.
" + } + }, + "apiId": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The API ID.
" + } + }, + "associationStatus": { + "target": "com.amazonaws.appsync#AssociationStatus", + "traits": { + "smithy.api#documentation": "Identifies the status of an association.
\n\n PROCESSING: The API association is being created. You cannot\n modify association requests during processing.
\n\n SUCCESS: The API association was successful. You can modify\n associations after success.
\n\n FAILED: The API association has failed. You can modify\n associations after failure.
\nDetails about the last deployment status.
" + } } - }, - "params": { - "Region": "ap-northeast-3", - "UseFIPS": false, - "UseDualStack": false - } }, - { - "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://appsync.ap-south-1.amazonaws.com" + "traits": { + "smithy.api#documentation": "Describes an ApiAssociation object.
TTL in seconds for cache entries.
\nValid values are 1–3,600 seconds.
" + } + }, + "apiCachingBehavior": { + "target": "com.amazonaws.appsync#ApiCachingBehavior", + "traits": { + "smithy.api#documentation": "Caching behavior.
\n\n FULL_REQUEST_CACHING: All requests are fully cached.
\n\n PER_RESOLVER_CACHING: Individual resolvers that you specify are\n cached.
\nTransit encryption flag when connecting to cache. You cannot update this setting after creation.
" + } + }, + "atRestEncryptionEnabled": { + "target": "com.amazonaws.appsync#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "At-rest encryption flag for cache. You cannot update this setting after creation.
" + } + }, + "type": { + "target": "com.amazonaws.appsync#ApiCacheType", + "traits": { + "smithy.api#documentation": "The cache instance type. Valid values are
\n\n SMALL\n
\n MEDIUM\n
\n LARGE\n
\n XLARGE\n
\n LARGE_2X\n
\n LARGE_4X\n
\n LARGE_8X (not available in all regions)
\n LARGE_12X\n
Historically, instance types were identified by an EC2-style value. As of July 2020, this is deprecated, and the generic identifiers above should be used.
\nThe following legacy instance types are available, but their use is discouraged:
\n\n T2_SMALL: A t2.small instance type.
\n\n T2_MEDIUM: A t2.medium instance type.
\n\n R4_LARGE: A r4.large instance type.
\n\n R4_XLARGE: A r4.xlarge instance type.
\n\n R4_2XLARGE: A r4.2xlarge instance type.
\n\n R4_4XLARGE: A r4.4xlarge instance type.
\n\n R4_8XLARGE: A r4.8xlarge instance type.
\nThe cache instance status.
\n\n AVAILABLE: The instance is available for use.
\n\n CREATING: The instance is currently creating.
\n\n DELETING: The instance is currently deleting.
\n\n MODIFYING: The instance is currently modifying.
\n\n FAILED: The instance has failed creation.
\nControls how cache health metrics will be emitted to CloudWatch. Cache health metrics include:
\nNetworkBandwidthOutAllowanceExceeded: The network packets dropped because the throughput exceeded\n the aggregated bandwidth limit. This is useful for diagnosing bottlenecks in a cache\n configuration.
\nEngineCPUUtilization: The CPU utilization (percentage) allocated to the Redis process. This is\n useful for diagnosing bottlenecks in a cache configuration.
\nMetrics will be recorded by API ID. You can set the value to ENABLED or\n DISABLED.
The ApiCache object.
The API key ID.
" + } + }, + "description": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "A description of the purpose of the API key.
" + } + }, + "expires": { + "target": "com.amazonaws.appsync#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The time after which the API key expires. The date is represented as seconds since the epoch, rounded down\n to the nearest hour.
" + } + }, + "deletes": { + "target": "com.amazonaws.appsync#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The time after which the API key is deleted. The date is represented as seconds since the epoch, rounded\n down to the nearest hour.
" + } } - }, - "params": { - "Region": "eu-central-1", - "UseFIPS": false, - "UseDualStack": false - } }, - { - "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://appsync.eu-north-1.amazonaws.com" + "traits": { + "smithy.api#documentation": "Describes an API key.
\nCustomers invoke AppSync GraphQL API operations with API keys as an identity mechanism.\n There are two key versions:
\n\n da1: We introduced this version at launch in November 2017. These keys\n always expire after 7 days. Amazon DynamoDB TTL manages key expiration. These keys ceased to be valid\n after February 21, 2018, and they should no longer be used.
\n\n ListApiKeys returns the expiration time in milliseconds.
\n CreateApiKey returns the expiration time in milliseconds.
\n UpdateApiKey is not available for this key version.
\n DeleteApiKey deletes the item from the table.
Expiration is stored in DynamoDB as milliseconds. This results in a bug where keys are\n not automatically deleted because DynamoDB expects the TTL to be stored in seconds. As a\n one-time action, we deleted these keys from the table on February 21, 2018.
\n\n da2: We introduced this version in February 2018 when AppSync added support to extend key expiration.
\n\n ListApiKeys returns the expiration time and deletion time in seconds.
\n CreateApiKey returns the expiration time and deletion time in seconds and accepts a\n user-provided expiration time in seconds.
\n UpdateApiKey returns the expiration time and and deletion time in seconds and accepts\n a user-provided expiration time in seconds. Expired API keys are kept for 60 days after the expiration\n time. You can update the key expiration time as long as the key isn't deleted.
\n DeleteApiKey deletes the item from the table.
Expiration is stored in DynamoDB as seconds. After the expiration time, using the key to\n authenticate will fail. However, you can reinstate the key before deletion.
\nDeletion is stored in DynamoDB as seconds. The key is deleted after deletion\n time.
\nThe API key exceeded a limit. Try your request again.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.appsync#ApiKeyValidityOutOfBoundsException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.appsync#String" } - }, - "params": { - "Region": "eu-south-1", - "UseFIPS": false, - "UseDualStack": false - } }, - { - "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://appsync.eu-west-1.amazonaws.com" + "traits": { + "smithy.api#documentation": "The API key expiration must be set to a value between 1 and 365 days from creation (for\n CreateApiKey) or from update (for UpdateApiKey).
The GraphQL API exceeded a limit. Try your request again.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.appsync#AppSyncRuntime": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.appsync#RuntimeName", + "traits": { + "smithy.api#documentation": "The name of the runtime to use. Currently, the only allowed value is\n APPSYNC_JS.
The version of the runtime to use. Currently, the only allowed version is\n 1.0.0.
Describes a runtime used by an Amazon Web Services AppSync pipeline resolver or Amazon Web Services AppSync\n function. Specifies the name and version of the runtime to use. Note that if a runtime is specified, code must\n also be specified.
" + } + }, + "com.amazonaws.appsync#AssociateApi": { + "type": "operation", + "input": { + "target": "com.amazonaws.appsync#AssociateApiRequest" }, - { - "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://appsync.me-south-1.amazonaws.com" - } - }, - "params": { - "Region": "me-south-1", - "UseFIPS": false, - "UseDualStack": false - } + "output": { + "target": "com.amazonaws.appsync#AssociateApiResponse" }, - { - "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://appsync.sa-east-1.amazonaws.com" + "errors": [ + { + "target": "com.amazonaws.appsync#AccessDeniedException" + }, + { + "target": "com.amazonaws.appsync#BadRequestException" + }, + { + "target": "com.amazonaws.appsync#InternalFailureException" + }, + { + "target": "com.amazonaws.appsync#NotFoundException" } - }, - "params": { - "Region": "sa-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://appsync.us-east-1.amazonaws.com" + ], + "traits": { + "smithy.api#documentation": "Maps an endpoint to your custom domain.
", + "smithy.api#http": { + "method": "POST", + "uri": "/v1/domainnames/{domainName}/apiassociation", + "code": 200 } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://appsync.us-east-2.amazonaws.com" + } + }, + "com.amazonaws.appsync#AssociateApiRequest": { + "type": "structure", + "members": { + "domainName": { + "target": "com.amazonaws.appsync#DomainName", + "traits": { + "smithy.api#documentation": "The domain name.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "apiId": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The API ID. Private APIs can not be associated with custom domains.
", + "smithy.api#required": {} + } } - }, - "params": { - "Region": "us-east-2", - "UseFIPS": false, - "UseDualStack": false - } }, - { - "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://appsync.us-west-1.amazonaws.com" + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appsync#AssociateApiResponse": { + "type": "structure", + "members": { + "apiAssociation": { + "target": "com.amazonaws.appsync#ApiAssociation", + "traits": { + "smithy.api#documentation": "The ApiAssociation object.
Creates an association between a Merged API and source API using the source API's identifier.
", + "smithy.api#http": { + "method": "POST", + "uri": "/v1/sourceApis/{sourceApiIdentifier}/mergedApiAssociations", + "code": 200 } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://appsync.cn-north-1.amazonaws.com.cn" + } + }, + "com.amazonaws.appsync#AssociateMergedGraphqlApiRequest": { + "type": "structure", + "members": { + "sourceApiIdentifier": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The identifier of the AppSync Source API. This is generated by the AppSync service. In most cases, source\n APIs (especially in your account) only require the API ID value or ARN of the source API. However, source APIs\n from other accounts (cross-account use cases) strictly require the full resource ARN of the source API.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "mergedApiIdentifier": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged\n APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs\n in other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The description field.
" + } + }, + "sourceApiAssociationConfig": { + "target": "com.amazonaws.appsync#SourceApiAssociationConfig", + "traits": { + "smithy.api#documentation": "The SourceApiAssociationConfig object data.
The SourceApiAssociation object data.
Creates an association between a Merged API and source API using the Merged API's identifier.
", + "smithy.api#http": { + "method": "POST", + "uri": "/v1/mergedApis/{mergedApiIdentifier}/sourceApiAssociations", + "code": 200 } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://appsync-fips.us-gov-east-1.amazonaws.com" + } + }, + "com.amazonaws.appsync#AssociateSourceGraphqlApiRequest": { + "type": "structure", + "members": { + "mergedApiIdentifier": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged\n APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs\n in other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "sourceApiIdentifier": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The identifier of the AppSync Source API. This is generated by the AppSync service. In most cases, source\n APIs (especially in your account) only require the API ID value or ARN of the source API. However, source APIs\n from other accounts (cross-account use cases) strictly require the full resource ARN of the source API.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The description field.
" + } + }, + "sourceApiAssociationConfig": { + "target": "com.amazonaws.appsync#SourceApiAssociationConfig", + "traits": { + "smithy.api#documentation": "The SourceApiAssociationConfig object data.
The SourceApiAssociation object data.
The authorization type that the HTTP endpoint requires.
\n\n AWS_IAM: The authorization type is Signature Version 4\n (SigV4).
\nThe Identity and Access Management (IAM) settings.
" + } } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://appsync-fips.us-isob-east-1.sc2s.sgov.gov" + "traits": { + "smithy.api#documentation": "The authorization configuration in case the HTTP endpoint requires authorization.
" + } + }, + "com.amazonaws.appsync#AuthorizationType": { + "type": "enum", + "members": { + "AWS_IAM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS_IAM" + } } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://appsync.us-isob-east-1.sc2s.sgov.gov" + } + }, + "com.amazonaws.appsync#AwsIamConfig": { + "type": "structure", + "members": { + "signingRegion": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The signing Amazon Web Services Region for IAM authorization.
" + } + }, + "signingServiceName": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The signing service name for IAM authorization.
" + } } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": false - } }, - { - "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" + "traits": { + "smithy.api#documentation": "The Identity and Access Management (IAM) configuration.
" + } + }, + "com.amazonaws.appsync#BadRequestDetail": { + "type": "structure", + "members": { + "codeErrors": { + "target": "com.amazonaws.appsync#CodeErrors", + "traits": { + "smithy.api#documentation": "Contains the list of errors in the request.
" + } } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" - } }, - { - "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" + "traits": { + "smithy.api#documentation": "Provides further details for the reason behind the bad request. For reason type CODE_ERROR, the\n detail will contain a list of code errors.
The request is not well formed. For example, a value is invalid or a required field is missing. Check the\n field values, and then try again.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.appsync#BadRequestReason": { + "type": "enum", + "members": { + "CODE_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CODE_ERROR" + } + } }, - { - "documentation": "For custom endpoint with fips disabled and dualstack enabled", - "expect": { - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true, - "Endpoint": "https://example.com" - } + "traits": { + "smithy.api#documentation": "Provides context for the cause of the bad request. The only supported value is\n CODE_ERROR.
The TTL in seconds for a resolver that has caching activated.
\nValid values are 1–3,600 seconds.
", + "smithy.api#required": {} + } + }, + "cachingKeys": { + "target": "com.amazonaws.appsync#CachingKeys", + "traits": { + "smithy.api#documentation": "The caching keys for a resolver that has caching activated.
\nValid values are entries from the $context.arguments, $context.source, and\n $context.identity maps.
The caching configuration for a resolver that has caching activated.
" } - ], - "version": "1.0" - } - } - }, - "com.amazonaws.appsync#AccessDeniedException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.appsync#String" - } - }, - "traits": { - "smithy.api#documentation": "You don't have access to perform this operation on this resource.
", - "smithy.api#error": "client", - "smithy.api#httpError": 403 - } - }, - "com.amazonaws.appsync#AdditionalAuthenticationProvider": { - "type": "structure", - "members": { - "authenticationType": { - "target": "com.amazonaws.appsync#AuthenticationType", - "traits": { - "smithy.api#documentation": "The authentication type: API key, Identity and Access Management (IAM), OpenID Connect (OIDC),\n Amazon Cognito user pools, or Lambda.
" - } - }, - "openIDConnectConfig": { - "target": "com.amazonaws.appsync#OpenIDConnectConfig", - "traits": { - "smithy.api#documentation": "The OIDC configuration.
" - } - }, - "userPoolConfig": { - "target": "com.amazonaws.appsync#CognitoUserPoolConfig", - "traits": { - "smithy.api#documentation": "The Amazon Cognito user pool configuration.
" - } - }, - "lambdaAuthorizerConfig": { - "target": "com.amazonaws.appsync#LambdaAuthorizerConfig", - "traits": { - "smithy.api#documentation": "Configuration for Lambda function authorization.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Describes an additional authentication provider.
" - } - }, - "com.amazonaws.appsync#AdditionalAuthenticationProviders": { - "type": "list", - "member": { - "target": "com.amazonaws.appsync#AdditionalAuthenticationProvider" - } - }, - "com.amazonaws.appsync#ApiAssociation": { - "type": "structure", - "members": { - "domainName": { - "target": "com.amazonaws.appsync#DomainName", - "traits": { - "smithy.api#documentation": "The domain name.
" - } - }, - "apiId": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The API ID.
" - } - }, - "associationStatus": { - "target": "com.amazonaws.appsync#AssociationStatus", - "traits": { - "smithy.api#documentation": "Identifies the status of an association.
\n\n PROCESSING: The API association is being created. You cannot\n modify association requests during processing.
\n\n SUCCESS: The API association was successful. You can modify\n associations after success.
\n\n FAILED: The API association has failed. You can modify\n associations after failure.
\nDetails about the last deployment status.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Describes an ApiAssociation object.
TTL in seconds for cache entries.
\nValid values are 1–3,600 seconds.
" - } - }, - "apiCachingBehavior": { - "target": "com.amazonaws.appsync#ApiCachingBehavior", - "traits": { - "smithy.api#documentation": "Caching behavior.
\n\n FULL_REQUEST_CACHING: All requests are fully cached.
\n\n PER_RESOLVER_CACHING: Individual resolvers that you specify are\n cached.
\nTransit encryption flag when connecting to cache. You cannot update this setting after creation.
" - } - }, - "atRestEncryptionEnabled": { - "target": "com.amazonaws.appsync#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "At-rest encryption flag for cache. You cannot update this setting after creation.
" - } - }, - "type": { - "target": "com.amazonaws.appsync#ApiCacheType", - "traits": { - "smithy.api#documentation": "The cache instance type. Valid values are
\n\n SMALL\n
\n MEDIUM\n
\n LARGE\n
\n XLARGE\n
\n LARGE_2X\n
\n LARGE_4X\n
\n LARGE_8X (not available in all regions)
\n LARGE_12X\n
Historically, instance types were identified by an EC2-style value. As of July 2020, this is deprecated, and the generic identifiers above should be used.
\nThe following legacy instance types are available, but their use is discouraged:
\n\n T2_SMALL: A t2.small instance type.
\n\n T2_MEDIUM: A t2.medium instance type.
\n\n R4_LARGE: A r4.large instance type.
\n\n R4_XLARGE: A r4.xlarge instance type.
\n\n R4_2XLARGE: A r4.2xlarge instance type.
\n\n R4_4XLARGE: A r4.4xlarge instance type.
\n\n R4_8XLARGE: A r4.8xlarge instance type.
\nThe cache instance status.
\n\n AVAILABLE: The instance is available for use.
\n\n CREATING: The instance is currently creating.
\n\n DELETING: The instance is currently deleting.
\n\n MODIFYING: The instance is currently modifying.
\n\n FAILED: The instance has failed creation.
\nControls how cache health metrics will be emitted to CloudWatch. Cache health metrics include:
\nNetworkBandwidthOutAllowanceExceeded: The network packets dropped because the throughput exceeded\n the aggregated bandwidth limit. This is useful for diagnosing bottlenecks in a cache\n configuration.
\nEngineCPUUtilization: The CPU utilization (percentage) allocated to the Redis process. This is\n useful for diagnosing bottlenecks in a cache configuration.
\nMetrics will be recorded by API ID. You can set the value to ENABLED or\n DISABLED.
The ApiCache object.
The API key ID.
" - } - }, - "description": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "A description of the purpose of the API key.
" - } - }, - "expires": { - "target": "com.amazonaws.appsync#Long", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The time after which the API key expires. The date is represented as seconds since the epoch, rounded down\n to the nearest hour.
" - } - }, - "deletes": { - "target": "com.amazonaws.appsync#Long", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The time after which the API key is deleted. The date is represented as seconds since the epoch, rounded\n down to the nearest hour.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Describes an API key.
\nCustomers invoke AppSync GraphQL API operations with API keys as an identity mechanism.\n There are two key versions:
\n\n da1: We introduced this version at launch in November 2017. These keys\n always expire after 7 days. Amazon DynamoDB TTL manages key expiration. These keys ceased to be valid\n after February 21, 2018, and they should no longer be used.
\n\n ListApiKeys returns the expiration time in milliseconds.
\n CreateApiKey returns the expiration time in milliseconds.
\n UpdateApiKey is not available for this key version.
\n DeleteApiKey deletes the item from the table.
Expiration is stored in DynamoDB as milliseconds. This results in a bug where keys are\n not automatically deleted because DynamoDB expects the TTL to be stored in seconds. As a\n one-time action, we deleted these keys from the table on February 21, 2018.
\n\n da2: We introduced this version in February 2018 when AppSync added support to extend key expiration.
\n\n ListApiKeys returns the expiration time and deletion time in seconds.
\n CreateApiKey returns the expiration time and deletion time in seconds and accepts a\n user-provided expiration time in seconds.
\n UpdateApiKey returns the expiration time and and deletion time in seconds and accepts\n a user-provided expiration time in seconds. Expired API keys are kept for 60 days after the expiration\n time. You can update the key expiration time as long as the key isn't deleted.
\n DeleteApiKey deletes the item from the table.
Expiration is stored in DynamoDB as seconds. After the expiration time, using the key to\n authenticate will fail. However, you can reinstate the key before deletion.
\nDeletion is stored in DynamoDB as seconds. The key is deleted after deletion\n time.
\nThe API key exceeded a limit. Try your request again.
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.appsync#ApiKeyValidityOutOfBoundsException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.appsync#String" - } - }, - "traits": { - "smithy.api#documentation": "The API key expiration must be set to a value between 1 and 365 days from creation (for\n CreateApiKey) or from update (for UpdateApiKey).
The GraphQL API exceeded a limit. Try your request again.
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.appsync#AppSyncRuntime": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.appsync#RuntimeName", - "traits": { - "smithy.api#documentation": "The name of the runtime to use. Currently, the only allowed value is\n APPSYNC_JS.
The version of the runtime to use. Currently, the only allowed version is\n 1.0.0.
Describes a runtime used by an Amazon Web Services AppSync pipeline resolver or Amazon Web Services AppSync\n function. Specifies the name and version of the runtime to use. Note that if a runtime is specified, code must\n also be specified.
" - } - }, - "com.amazonaws.appsync#AssociateApi": { - "type": "operation", - "input": { - "target": "com.amazonaws.appsync#AssociateApiRequest" - }, - "output": { - "target": "com.amazonaws.appsync#AssociateApiResponse" - }, - "errors": [ - { - "target": "com.amazonaws.appsync#AccessDeniedException" - }, - { - "target": "com.amazonaws.appsync#BadRequestException" - }, - { - "target": "com.amazonaws.appsync#InternalFailureException" - }, - { - "target": "com.amazonaws.appsync#NotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "Maps an endpoint to your custom domain.
", - "smithy.api#http": { - "method": "POST", - "uri": "/v1/domainnames/{domainName}/apiassociation", - "code": 200 - } - } - }, - "com.amazonaws.appsync#AssociateApiRequest": { - "type": "structure", - "members": { - "domainName": { - "target": "com.amazonaws.appsync#DomainName", - "traits": { - "smithy.api#documentation": "The domain name.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "apiId": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The API ID. Private APIs can not be associated with custom domains.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appsync#AssociateApiResponse": { - "type": "structure", - "members": { - "apiAssociation": { - "target": "com.amazonaws.appsync#ApiAssociation", - "traits": { - "smithy.api#documentation": "The ApiAssociation object.
Creates an association between a Merged API and source API using the source API's identifier.
", - "smithy.api#http": { - "method": "POST", - "uri": "/v1/sourceApis/{sourceApiIdentifier}/mergedApiAssociations", - "code": 200 - } - } - }, - "com.amazonaws.appsync#AssociateMergedGraphqlApiRequest": { - "type": "structure", - "members": { - "sourceApiIdentifier": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The identifier of the AppSync Source API. This is generated by the AppSync service. In most cases, source\n APIs (especially in your account) only require the API ID value or ARN of the source API. However, source APIs\n from other accounts (cross-account use cases) strictly require the full resource ARN of the source API.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "mergedApiIdentifier": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged\n APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs\n in other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The description field.
" - } - }, - "sourceApiAssociationConfig": { - "target": "com.amazonaws.appsync#SourceApiAssociationConfig", - "traits": { - "smithy.api#documentation": "The SourceApiAssociationConfig object data.
The SourceApiAssociation object data.
Creates an association between a Merged API and source API using the Merged API's identifier.
", - "smithy.api#http": { - "method": "POST", - "uri": "/v1/mergedApis/{mergedApiIdentifier}/sourceApiAssociations", - "code": 200 - } - } - }, - "com.amazonaws.appsync#AssociateSourceGraphqlApiRequest": { - "type": "structure", - "members": { - "mergedApiIdentifier": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged\n APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs\n in other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "sourceApiIdentifier": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The identifier of the AppSync Source API. This is generated by the AppSync service. In most cases, source\n APIs (especially in your account) only require the API ID value or ARN of the source API. However, source APIs\n from other accounts (cross-account use cases) strictly require the full resource ARN of the source API.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The description field.
" - } - }, - "sourceApiAssociationConfig": { - "target": "com.amazonaws.appsync#SourceApiAssociationConfig", - "traits": { - "smithy.api#documentation": "The SourceApiAssociationConfig object data.
The SourceApiAssociation object data.
The authorization type that the HTTP endpoint requires.
\n\n AWS_IAM: The authorization type is Signature Version 4\n (SigV4).
\nThe Identity and Access Management (IAM) settings.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The authorization configuration in case the HTTP endpoint requires authorization.
" - } - }, - "com.amazonaws.appsync#AuthorizationType": { - "type": "enum", - "members": { - "AWS_IAM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AWS_IAM" - } - } - } - }, - "com.amazonaws.appsync#AwsIamConfig": { - "type": "structure", - "members": { - "signingRegion": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The signing Amazon Web Services Region for IAM authorization.
" - } - }, - "signingServiceName": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The signing service name for IAM authorization.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The Identity and Access Management (IAM) configuration.
" - } - }, - "com.amazonaws.appsync#BadRequestDetail": { - "type": "structure", - "members": { - "codeErrors": { - "target": "com.amazonaws.appsync#CodeErrors", - "traits": { - "smithy.api#documentation": "Contains the list of errors in the request.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Provides further details for the reason behind the bad request. For reason type CODE_ERROR, the\n detail will contain a list of code errors.
The request is not well formed. For example, a value is invalid or a required field is missing. Check the\n field values, and then try again.
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.appsync#BadRequestReason": { - "type": "enum", - "members": { - "CODE_ERROR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CODE_ERROR" - } - } - }, - "traits": { - "smithy.api#documentation": "Provides context for the cause of the bad request. The only supported value is\n CODE_ERROR.
The TTL in seconds for a resolver that has caching activated.
\nValid values are 1–3,600 seconds.
", - "smithy.api#required": {} - } - }, - "cachingKeys": { - "target": "com.amazonaws.appsync#CachingKeys", - "traits": { - "smithy.api#documentation": "The caching keys for a resolver that has caching activated.
\nValid values are entries from the $context.arguments, $context.source, and\n $context.identity maps.
The caching configuration for a resolver that has caching activated.
" - } - }, - "com.amazonaws.appsync#CachingKeys": { - "type": "list", - "member": { - "target": "com.amazonaws.appsync#String" - } - }, - "com.amazonaws.appsync#CertificateArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 20, - "max": 2048 - }, - "smithy.api#pattern": "^arn:[a-z-]*:(acm|iam):[a-z0-9-]*:\\d{12}:(certificate|server-certificate)/[0-9A-Za-z_/-]*$" - } - }, - "com.amazonaws.appsync#Code": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 32768 - } - } - }, - "com.amazonaws.appsync#CodeError": { - "type": "structure", - "members": { - "errorType": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The type of code error.
\nExamples include, but aren't limited to: LINT_ERROR, PARSER_ERROR.
A user presentable error.
\nExamples include, but aren't limited to: Parsing error: Unterminated string literal.
The line, column, and span location of the error in the code.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Describes an AppSync error.
" - } - }, - "com.amazonaws.appsync#CodeErrorColumn": { - "type": "integer", - "traits": { - "smithy.api#default": 0 - } - }, - "com.amazonaws.appsync#CodeErrorLine": { - "type": "integer", - "traits": { - "smithy.api#default": 0 - } - }, - "com.amazonaws.appsync#CodeErrorLocation": { - "type": "structure", - "members": { - "line": { - "target": "com.amazonaws.appsync#CodeErrorLine", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The line number in the code. Defaults to 0 if unknown.
The column number in the code. Defaults to 0 if unknown.
The span/length of the error. Defaults to -1 if unknown.
Describes the location of the error in a code sample.
" - } - }, - "com.amazonaws.appsync#CodeErrorSpan": { - "type": "integer", - "traits": { - "smithy.api#default": 0 - } - }, - "com.amazonaws.appsync#CodeErrors": { - "type": "list", - "member": { - "target": "com.amazonaws.appsync#CodeError" - } - }, - "com.amazonaws.appsync#CognitoUserPoolConfig": { - "type": "structure", - "members": { - "userPoolId": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The user pool ID.
", - "smithy.api#required": {} - } - }, - "awsRegion": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The Amazon Web Services Region in which the user pool was created.
", - "smithy.api#required": {} - } - }, - "appIdClientRegex": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "A regular expression for validating the incoming Amazon Cognito user pool app client ID. If this value\n isn't set, no filtering is applied.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Describes an Amazon Cognito user pool configuration.
" - } - }, - "com.amazonaws.appsync#ConcurrentModificationException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.appsync#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "Another modification is in progress at this time and it must complete before you can make your\n change.
", - "smithy.api#error": "client", - "smithy.api#httpError": 409 - } - }, - "com.amazonaws.appsync#ConflictDetectionType": { - "type": "enum", - "members": { - "VERSION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VERSION" - } - }, - "NONE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NONE" - } - } - } - }, - "com.amazonaws.appsync#ConflictHandlerType": { - "type": "enum", - "members": { - "OPTIMISTIC_CONCURRENCY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "OPTIMISTIC_CONCURRENCY" - } - }, - "LAMBDA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LAMBDA" - } - }, - "AUTOMERGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AUTOMERGE" - } - }, - "NONE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NONE" - } - } - } - }, - "com.amazonaws.appsync#Context": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 2, - "max": 28000 - }, - "smithy.api#pattern": "^[\\s\\S]*$" - } - }, - "com.amazonaws.appsync#CreateApiCache": { - "type": "operation", - "input": { - "target": "com.amazonaws.appsync#CreateApiCacheRequest" - }, - "output": { - "target": "com.amazonaws.appsync#CreateApiCacheResponse" - }, - "errors": [ - { - "target": "com.amazonaws.appsync#BadRequestException" - }, - { - "target": "com.amazonaws.appsync#ConcurrentModificationException" - }, - { - "target": "com.amazonaws.appsync#InternalFailureException" - }, - { - "target": "com.amazonaws.appsync#NotFoundException" - }, - { - "target": "com.amazonaws.appsync#UnauthorizedException" - } - ], - "traits": { - "smithy.api#documentation": "Creates a cache for the GraphQL API.
", - "smithy.api#http": { - "method": "POST", - "uri": "/v1/apis/{apiId}/ApiCaches", - "code": 200 - } - } - }, - "com.amazonaws.appsync#CreateApiCacheRequest": { - "type": "structure", - "members": { - "apiId": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The GraphQL API ID.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ttl": { - "target": "com.amazonaws.appsync#Long", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "TTL in seconds for cache entries.
\nValid values are 1–3,600 seconds.
", - "smithy.api#required": {} - } - }, - "transitEncryptionEnabled": { - "target": "com.amazonaws.appsync#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "Transit encryption flag when connecting to cache. You cannot update this setting after creation.
" - } - }, - "atRestEncryptionEnabled": { - "target": "com.amazonaws.appsync#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "At-rest encryption flag for cache. You cannot update this setting after creation.
" - } - }, - "apiCachingBehavior": { - "target": "com.amazonaws.appsync#ApiCachingBehavior", - "traits": { - "smithy.api#documentation": "Caching behavior.
\n\n FULL_REQUEST_CACHING: All requests are fully cached.
\n\n PER_RESOLVER_CACHING: Individual resolvers that you specify are\n cached.
\nThe cache instance type. Valid values are
\n\n SMALL\n
\n MEDIUM\n
\n LARGE\n
\n XLARGE\n
\n LARGE_2X\n
\n LARGE_4X\n
\n LARGE_8X (not available in all regions)
\n LARGE_12X\n
Historically, instance types were identified by an EC2-style value. As of July 2020, this is deprecated, and the generic identifiers above should be used.
\nThe following legacy instance types are available, but their use is discouraged:
\n\n T2_SMALL: A t2.small instance type.
\n\n T2_MEDIUM: A t2.medium instance type.
\n\n R4_LARGE: A r4.large instance type.
\n\n R4_XLARGE: A r4.xlarge instance type.
\n\n R4_2XLARGE: A r4.2xlarge instance type.
\n\n R4_4XLARGE: A r4.4xlarge instance type.
\n\n R4_8XLARGE: A r4.8xlarge instance type.
\nControls how cache health metrics will be emitted to CloudWatch. Cache health metrics include:
\nNetworkBandwidthOutAllowanceExceeded: The network packets dropped because the throughput exceeded\n the aggregated bandwidth limit. This is useful for diagnosing bottlenecks in a cache\n configuration.
\nEngineCPUUtilization: The CPU utilization (percentage) allocated to the Redis process. This is\n useful for diagnosing bottlenecks in a cache configuration.
\nMetrics will be recorded by API ID. You can set the value to ENABLED or\n DISABLED.
Represents the input of a CreateApiCache operation.
The ApiCache object.
Represents the output of a CreateApiCache operation.
Creates a unique key that you can distribute to clients who invoke your API.
", - "smithy.api#http": { - "method": "POST", - "uri": "/v1/apis/{apiId}/apikeys", - "code": 200 - } - } - }, - "com.amazonaws.appsync#CreateApiKeyRequest": { - "type": "structure", - "members": { - "apiId": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The ID for your GraphQL API.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "A description of the purpose of the API key.
" - } - }, - "expires": { - "target": "com.amazonaws.appsync#Long", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "From the creation time, the time after which the API key expires. The date is represented as seconds since\n the epoch, rounded down to the nearest hour. The default value for this parameter is 7 days from creation time.\n For more information, see .
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appsync#CreateApiKeyResponse": { - "type": "structure", - "members": { - "apiKey": { - "target": "com.amazonaws.appsync#ApiKey", - "traits": { - "smithy.api#documentation": "The API key.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appsync#CreateDataSource": { - "type": "operation", - "input": { - "target": "com.amazonaws.appsync#CreateDataSourceRequest" - }, - "output": { - "target": "com.amazonaws.appsync#CreateDataSourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.appsync#BadRequestException" - }, - { - "target": "com.amazonaws.appsync#ConcurrentModificationException" - }, - { - "target": "com.amazonaws.appsync#InternalFailureException" - }, - { - "target": "com.amazonaws.appsync#NotFoundException" - }, - { - "target": "com.amazonaws.appsync#UnauthorizedException" - } - ], - "traits": { - "smithy.api#documentation": "Creates a DataSource object.
The API ID for the GraphQL API for the DataSource.
A user-supplied name for the DataSource.
A description of the DataSource.
The type of the DataSource.
The Identity and Access Management (IAM) service role Amazon Resource Name (ARN) for the data source.\n The system assumes this role when accessing the data source.
" - } - }, - "dynamodbConfig": { - "target": "com.amazonaws.appsync#DynamodbDataSourceConfig", - "traits": { - "smithy.api#documentation": "Amazon DynamoDB settings.
" - } - }, - "lambdaConfig": { - "target": "com.amazonaws.appsync#LambdaDataSourceConfig", - "traits": { - "smithy.api#documentation": "Lambda settings.
" - } - }, - "elasticsearchConfig": { - "target": "com.amazonaws.appsync#ElasticsearchDataSourceConfig", - "traits": { - "smithy.api#documentation": "Amazon OpenSearch Service settings.
\nAs of September 2021, Amazon Elasticsearch service is Amazon OpenSearch Service. This configuration is\n deprecated. For new data sources, use CreateDataSourceRequest$openSearchServiceConfig to\n create an OpenSearch data source.
" - } - }, - "openSearchServiceConfig": { - "target": "com.amazonaws.appsync#OpenSearchServiceDataSourceConfig", - "traits": { - "smithy.api#documentation": "Amazon OpenSearch Service settings.
" - } - }, - "httpConfig": { - "target": "com.amazonaws.appsync#HttpDataSourceConfig", - "traits": { - "smithy.api#documentation": "HTTP endpoint settings.
" - } - }, - "relationalDatabaseConfig": { - "target": "com.amazonaws.appsync#RelationalDatabaseDataSourceConfig", - "traits": { - "smithy.api#documentation": "Relational database settings.
" - } - }, - "eventBridgeConfig": { - "target": "com.amazonaws.appsync#EventBridgeDataSourceConfig", - "traits": { - "smithy.api#documentation": "Amazon EventBridge settings.
" - } - }, - "metricsConfig": { - "target": "com.amazonaws.appsync#DataSourceLevelMetricsConfig", - "traits": { - "smithy.api#documentation": "Enables or disables enhanced data source metrics for specified data sources. Note that\n metricsConfig won't be used unless the dataSourceLevelMetricsBehavior value is set\n to PER_DATA_SOURCE_METRICS. If the dataSourceLevelMetricsBehavior is set to\n FULL_REQUEST_DATA_SOURCE_METRICS instead, metricsConfig will be ignored. However,\n you can still set its value.
\n metricsConfig can be ENABLED or DISABLED.
The DataSource object.
Creates a custom DomainName object.
The domain name.
", - "smithy.api#required": {} - } - }, - "certificateArn": { - "target": "com.amazonaws.appsync#CertificateArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the certificate. This can be an Certificate Manager (ACM) certificate or an Identity and Access Management (IAM) server certificate.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.appsync#Description", - "traits": { - "smithy.api#documentation": "A description of the DomainName.
The configuration for the DomainName.
Creates a Function object.
A function is a reusable entity. You can use multiple functions to compose the resolver logic.
", - "smithy.api#http": { - "method": "POST", - "uri": "/v1/apis/{apiId}/functions", - "code": 200 - } - } - }, - "com.amazonaws.appsync#CreateFunctionRequest": { - "type": "structure", - "members": { - "apiId": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The GraphQL API ID.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "name": { - "target": "com.amazonaws.appsync#ResourceName", - "traits": { - "smithy.api#documentation": "The Function name. The function name does not have to be unique.
The Function description.
The Function\n DataSource name.
The Function request mapping template. Functions support only the 2018-05-29 version of the\n request mapping template.
The Function response mapping template.
The version of the request mapping template. Currently, the supported value is 2018-05-29. Note\n that when using VTL and mapping templates, the functionVersion is required.
The maximum batching size for a resolver.
" - } - }, - "runtime": { - "target": "com.amazonaws.appsync#AppSyncRuntime" - }, - "code": { - "target": "com.amazonaws.appsync#Code", - "traits": { - "smithy.api#documentation": "The function code that contains the request and response functions. When code is used, the\n runtime is required. The runtime value must be APPSYNC_JS.
The Function object.
Creates a GraphqlApi object.
A user-supplied name for the GraphqlApi.
The Amazon CloudWatch Logs configuration.
" - } - }, - "authenticationType": { - "target": "com.amazonaws.appsync#AuthenticationType", - "traits": { - "smithy.api#documentation": "The authentication type: API key, Identity and Access Management (IAM), OpenID Connect (OIDC),\n Amazon Cognito user pools, or Lambda.
", - "smithy.api#required": {} - } - }, - "userPoolConfig": { - "target": "com.amazonaws.appsync#UserPoolConfig", - "traits": { - "smithy.api#documentation": "The Amazon Cognito user pool configuration.
" - } - }, - "openIDConnectConfig": { - "target": "com.amazonaws.appsync#OpenIDConnectConfig", - "traits": { - "smithy.api#documentation": "The OIDC configuration.
" - } - }, - "tags": { - "target": "com.amazonaws.appsync#TagMap", - "traits": { - "smithy.api#documentation": "A TagMap object.
A list of additional authentication providers for the GraphqlApi API.
A flag indicating whether to use X-Ray tracing for the GraphqlApi.
Configuration for Lambda function authorization.
" - } - }, - "visibility": { - "target": "com.amazonaws.appsync#GraphQLApiVisibility", - "traits": { - "smithy.api#documentation": "Sets the value of the GraphQL API to public (GLOBAL) or private (PRIVATE). If no\n value is provided, the visibility will be set to GLOBAL by default. This value cannot be changed\n once the API has been created.
The value that indicates whether the GraphQL API is a standard API (GRAPHQL) or merged API\n (MERGED).
The Identity and Access Management service role ARN for a merged API. The AppSync service assumes this role\n on behalf of the Merged API to validate access to source APIs at runtime and to prompt the\n AUTO_MERGE to update the merged API endpoint with the source API changes automatically.
The owner contact information for an API resource.
\nThis field accepts any string input with a length of 0 - 256 characters.
" - } - }, - "introspectionConfig": { - "target": "com.amazonaws.appsync#GraphQLApiIntrospectionConfig", - "traits": { - "smithy.api#documentation": "Sets the value of the GraphQL API to enable (ENABLED) or disable (DISABLED)\n introspection. If no value is provided, the introspection configuration will be set to ENABLED by\n default. This field will produce an error if the operation attempts to use the introspection feature while this\n field is disabled.
For more information about introspection, see GraphQL\n introspection.
" - } - }, - "queryDepthLimit": { - "target": "com.amazonaws.appsync#QueryDepthLimit", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The maximum depth a query can have in a single request. Depth refers to the amount of nested levels allowed\n in the body of query. The default value is 0 (or unspecified), which indicates there's no depth\n limit. If you set a limit, it can be between 1 and 75 nested levels. This field will\n produce a limit error if the operation falls out of bounds.
Note that fields can still be set to nullable or non-nullable. If a non-nullable field produces an error,\n the error will be thrown upwards to the first nullable field available.
" - } - }, - "resolverCountLimit": { - "target": "com.amazonaws.appsync#ResolverCountLimit", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The maximum number of resolvers that can be invoked in a single request. The default value is 0\n (or unspecified), which will set the limit to 10000. When specified, the limit value can be\n between 1 and 10000. This field will produce a limit error if the operation falls out\n of bounds.
The enhancedMetricsConfig object.
The GraphqlApi.
Creates a Resolver object.
A resolver converts incoming requests into a format that a data source can understand, and converts the data\n source's responses into GraphQL.
", - "smithy.api#http": { - "method": "POST", - "uri": "/v1/apis/{apiId}/types/{typeName}/resolvers", - "code": 200 - } - } - }, - "com.amazonaws.appsync#CreateResolverRequest": { - "type": "structure", - "members": { - "apiId": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The ID for the GraphQL API for which the resolver is being created.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "typeName": { - "target": "com.amazonaws.appsync#ResourceName", - "traits": { - "smithy.api#documentation": "The name of the Type.
The name of the field to attach the resolver to.
", - "smithy.api#required": {} - } - }, - "dataSourceName": { - "target": "com.amazonaws.appsync#ResourceName", - "traits": { - "smithy.api#documentation": "The name of the data source for which the resolver is being created.
" - } - }, - "requestMappingTemplate": { - "target": "com.amazonaws.appsync#MappingTemplate", - "traits": { - "smithy.api#documentation": "The mapping template to use for requests.
\nA resolver uses a request mapping template to convert a GraphQL expression into a format that a data source\n can understand. Mapping templates are written in Apache Velocity Template Language (VTL).
\nVTL request mapping templates are optional when using an Lambda data source. For all other\n data sources, VTL request and response mapping templates are required.
" - } - }, - "responseMappingTemplate": { - "target": "com.amazonaws.appsync#MappingTemplate", - "traits": { - "smithy.api#documentation": "The mapping template to use for responses from the data source.
" - } - }, - "kind": { - "target": "com.amazonaws.appsync#ResolverKind", - "traits": { - "smithy.api#documentation": "The resolver type.
\n\n UNIT: A UNIT resolver type. A UNIT resolver is the default\n resolver type. You can use a UNIT resolver to run a GraphQL query against a single data source.
\n\n PIPELINE: A PIPELINE resolver type. You can use a PIPELINE\n resolver to invoke a series of Function objects in a serial manner. You can use a pipeline\n resolver to run a GraphQL query against multiple data sources.
The PipelineConfig.
The SyncConfig for a resolver attached to a versioned data source.
The caching configuration for the resolver.
" - } - }, - "maxBatchSize": { - "target": "com.amazonaws.appsync#MaxBatchSize", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The maximum batching size for a resolver.
" - } - }, - "runtime": { - "target": "com.amazonaws.appsync#AppSyncRuntime" - }, - "code": { - "target": "com.amazonaws.appsync#Code", - "traits": { - "smithy.api#documentation": "The resolver code that contains the request and response functions. When code is used, the\n runtime is required. The runtime value must be APPSYNC_JS.
Enables or disables enhanced resolver metrics for specified resolvers. Note that metricsConfig\n won't be used unless the resolverLevelMetricsBehavior value is set to\n PER_RESOLVER_METRICS. If the resolverLevelMetricsBehavior is set to\n FULL_REQUEST_RESOLVER_METRICS instead, metricsConfig will be ignored. However, you\n can still set its value.
\n metricsConfig can be ENABLED or DISABLED.
The Resolver object.
Creates a Type object.
The API ID.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "definition": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The type definition, in GraphQL Schema Definition Language (SDL) format.
\nFor more information, see the GraphQL SDL\n documentation.
", - "smithy.api#required": {} - } - }, - "format": { - "target": "com.amazonaws.appsync#TypeDefinitionFormat", - "traits": { - "smithy.api#documentation": "The type format: SDL or JSON.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appsync#CreateTypeResponse": { - "type": "structure", - "members": { - "type": { - "target": "com.amazonaws.appsync#Type", - "traits": { - "smithy.api#documentation": "The Type object.
The data source Amazon Resource Name (ARN).
" - } - }, - "name": { - "target": "com.amazonaws.appsync#ResourceName", - "traits": { - "smithy.api#documentation": "The name of the data source.
" - } - }, - "description": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The description of the data source.
" - } - }, - "type": { - "target": "com.amazonaws.appsync#DataSourceType", - "traits": { - "smithy.api#documentation": "The type of the data source.
\n\n AWS_LAMBDA: The data source is an Lambda\n function.
\n\n AMAZON_DYNAMODB: The data source is an Amazon DynamoDB\n table.
\n\n AMAZON_ELASTICSEARCH: The data source is an Amazon OpenSearch Service\n domain.
\n\n AMAZON_OPENSEARCH_SERVICE: The data source is an Amazon OpenSearch Service domain.
\n\n AMAZON_EVENTBRIDGE: The data source is an Amazon EventBridge\n configuration.
\n\n NONE: There is no data source. Use this type when you want to\n invoke a GraphQL operation without connecting to a data source, such as when you're performing data\n transformation with resolvers or invoking a subscription from a mutation.
\n\n HTTP: The data source is an HTTP endpoint.
\n\n RELATIONAL_DATABASE: The data source is a relational\n database.
\nThe Identity and Access Management (IAM) service role Amazon Resource Name (ARN) for the data source.\n The system assumes this role when accessing the data source.
" - } - }, - "dynamodbConfig": { - "target": "com.amazonaws.appsync#DynamodbDataSourceConfig", - "traits": { - "smithy.api#documentation": "DynamoDB settings.
" - } - }, - "lambdaConfig": { - "target": "com.amazonaws.appsync#LambdaDataSourceConfig", - "traits": { - "smithy.api#documentation": "Lambda settings.
" - } - }, - "elasticsearchConfig": { - "target": "com.amazonaws.appsync#ElasticsearchDataSourceConfig", - "traits": { - "smithy.api#documentation": "Amazon OpenSearch Service settings.
" - } - }, - "openSearchServiceConfig": { - "target": "com.amazonaws.appsync#OpenSearchServiceDataSourceConfig", - "traits": { - "smithy.api#documentation": "Amazon OpenSearch Service settings.
" - } - }, - "httpConfig": { - "target": "com.amazonaws.appsync#HttpDataSourceConfig", - "traits": { - "smithy.api#documentation": "HTTP endpoint settings.
" - } - }, - "relationalDatabaseConfig": { - "target": "com.amazonaws.appsync#RelationalDatabaseDataSourceConfig", - "traits": { - "smithy.api#documentation": "Relational database settings.
" - } - }, - "eventBridgeConfig": { - "target": "com.amazonaws.appsync#EventBridgeDataSourceConfig", - "traits": { - "smithy.api#documentation": "Amazon EventBridge settings.
" - } - }, - "metricsConfig": { - "target": "com.amazonaws.appsync#DataSourceLevelMetricsConfig", - "traits": { - "smithy.api#documentation": "Enables or disables enhanced data source metrics for specified data sources. Note that\n metricsConfig won't be used unless the dataSourceLevelMetricsBehavior value is set\n to PER_DATA_SOURCE_METRICS. If the dataSourceLevelMetricsBehavior is set to\n FULL_REQUEST_DATA_SOURCE_METRICS instead, metricsConfig will be ignored. However,\n you can still set its value.
\n metricsConfig can be ENABLED or DISABLED.
Describes a data source.
" - } - }, - "com.amazonaws.appsync#DataSourceIntrospectionModel": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The name of the model. For example, this could be the name of a single table in a database.
" - } - }, - "fields": { - "target": "com.amazonaws.appsync#DataSourceIntrospectionModelFields", - "traits": { - "smithy.api#documentation": "The DataSourceIntrospectionModelField object data.
The primary key stored as a DataSourceIntrospectionModelIndex object.
The array of DataSourceIntrospectionModelIndex objects.
Contains the output of the SDL that was generated from the introspected types. This is controlled by the\n includeModelsSDL parameter of the GetDataSourceIntrospection operation.
Contains the introspected data that was retrieved from the data source.
" - } - }, - "com.amazonaws.appsync#DataSourceIntrospectionModelField": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The name of the field that was retrieved from the introspected data.
" - } - }, - "type": { - "target": "com.amazonaws.appsync#DataSourceIntrospectionModelFieldType", - "traits": { - "smithy.api#documentation": "The DataSourceIntrospectionModelFieldType object data.
The length value of the introspected field.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Represents the fields that were retrieved from the introspected data.
" - } - }, - "com.amazonaws.appsync#DataSourceIntrospectionModelFieldType": { - "type": "structure", - "members": { - "kind": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "Specifies the classification of data. For example, this could be set to values like Scalar or\n NonNull to indicate a fundamental property of the field.
Valid values include:
\n\n Scalar: Indicates the value is a primitive type (scalar).
\n NonNull: Indicates the field cannot be null.
\n List: Indicates the field contains a list.
The name of the data type that represents the field. For example, String is a valid\n name value.
The DataSourceIntrospectionModelFieldType object data. The type is only present if\n DataSourceIntrospectionModelFieldType.kind is set to NonNull or List.
The type typically contains its own kind and name fields to represent\n the actual type data. For instance, type could contain a kind value of\n Scalar with a name value of String. The values Scalar\n and String will be collectively stored in the values field.
The values of the type field. This field represents the AppSync data type equivalent of the\n introspected field.
Represents the type data for each field retrieved from the introspection.
" - } - }, - "com.amazonaws.appsync#DataSourceIntrospectionModelFieldTypeValues": { - "type": "list", - "member": { - "target": "com.amazonaws.appsync#String" - } - }, - "com.amazonaws.appsync#DataSourceIntrospectionModelFields": { - "type": "list", - "member": { - "target": "com.amazonaws.appsync#DataSourceIntrospectionModelField" - } - }, - "com.amazonaws.appsync#DataSourceIntrospectionModelIndex": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The name of the index.
" - } - }, - "fields": { - "target": "com.amazonaws.appsync#DataSourceIntrospectionModelIndexFields", - "traits": { - "smithy.api#documentation": "The fields of the index.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The index that was retrieved from the introspected data.
" - } - }, - "com.amazonaws.appsync#DataSourceIntrospectionModelIndexFields": { - "type": "list", - "member": { - "target": "com.amazonaws.appsync#String" - } - }, - "com.amazonaws.appsync#DataSourceIntrospectionModelIndexes": { - "type": "list", - "member": { - "target": "com.amazonaws.appsync#DataSourceIntrospectionModelIndex" - } - }, - "com.amazonaws.appsync#DataSourceIntrospectionModels": { - "type": "list", - "member": { - "target": "com.amazonaws.appsync#DataSourceIntrospectionModel" - } - }, - "com.amazonaws.appsync#DataSourceIntrospectionResult": { - "type": "structure", - "members": { - "models": { - "target": "com.amazonaws.appsync#DataSourceIntrospectionModels", - "traits": { - "smithy.api#documentation": "The array of DataSourceIntrospectionModel objects.
Determines the number of types to be returned in a single response before paginating. This value is\n typically taken from nextToken value from the previous response.
Represents the output of a DataSourceIntrospectionResult. This is the populated result of a\n GetDataSourceIntrospection operation.
Deletes an ApiCache object.
The API ID.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Represents the input of a DeleteApiCache operation.
Represents the output of a DeleteApiCache operation.
Deletes an API key.
", - "smithy.api#http": { - "method": "DELETE", - "uri": "/v1/apis/{apiId}/apikeys/{id}", - "code": 200 - } - } - }, - "com.amazonaws.appsync#DeleteApiKeyRequest": { - "type": "structure", - "members": { - "apiId": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The API ID.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "id": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The ID for the API key.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appsync#DeleteApiKeyResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appsync#DeleteDataSource": { - "type": "operation", - "input": { - "target": "com.amazonaws.appsync#DeleteDataSourceRequest" - }, - "output": { - "target": "com.amazonaws.appsync#DeleteDataSourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.appsync#BadRequestException" - }, - { - "target": "com.amazonaws.appsync#ConcurrentModificationException" - }, - { - "target": "com.amazonaws.appsync#InternalFailureException" - }, - { - "target": "com.amazonaws.appsync#NotFoundException" - }, - { - "target": "com.amazonaws.appsync#UnauthorizedException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes a DataSource object.
The API ID.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "name": { - "target": "com.amazonaws.appsync#ResourceName", - "traits": { - "smithy.api#documentation": "The name of the data source.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appsync#DeleteDataSourceResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appsync#DeleteDomainName": { - "type": "operation", - "input": { - "target": "com.amazonaws.appsync#DeleteDomainNameRequest" - }, - "output": { - "target": "com.amazonaws.appsync#DeleteDomainNameResponse" - }, - "errors": [ - { - "target": "com.amazonaws.appsync#AccessDeniedException" - }, - { - "target": "com.amazonaws.appsync#BadRequestException" - }, - { - "target": "com.amazonaws.appsync#ConcurrentModificationException" - }, - { - "target": "com.amazonaws.appsync#InternalFailureException" - }, - { - "target": "com.amazonaws.appsync#NotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes a custom DomainName object.
The domain name.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appsync#DeleteDomainNameResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appsync#DeleteFunction": { - "type": "operation", - "input": { - "target": "com.amazonaws.appsync#DeleteFunctionRequest" - }, - "output": { - "target": "com.amazonaws.appsync#DeleteFunctionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.appsync#BadRequestException" - }, - { - "target": "com.amazonaws.appsync#ConcurrentModificationException" - }, - { - "target": "com.amazonaws.appsync#InternalFailureException" - }, - { - "target": "com.amazonaws.appsync#NotFoundException" - }, - { - "target": "com.amazonaws.appsync#UnauthorizedException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes a Function.
The GraphQL API ID.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "functionId": { - "target": "com.amazonaws.appsync#ResourceName", - "traits": { - "smithy.api#documentation": "The Function ID.
Deletes a GraphqlApi object.
The API ID.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appsync#DeleteGraphqlApiResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appsync#DeleteResolver": { - "type": "operation", - "input": { - "target": "com.amazonaws.appsync#DeleteResolverRequest" - }, - "output": { - "target": "com.amazonaws.appsync#DeleteResolverResponse" - }, - "errors": [ - { - "target": "com.amazonaws.appsync#BadRequestException" - }, - { - "target": "com.amazonaws.appsync#ConcurrentModificationException" - }, - { - "target": "com.amazonaws.appsync#InternalFailureException" - }, - { - "target": "com.amazonaws.appsync#NotFoundException" - }, - { - "target": "com.amazonaws.appsync#UnauthorizedException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes a Resolver object.
The API ID.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "typeName": { - "target": "com.amazonaws.appsync#ResourceName", - "traits": { - "smithy.api#documentation": "The name of the resolver type.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "fieldName": { - "target": "com.amazonaws.appsync#ResourceName", - "traits": { - "smithy.api#documentation": "The resolver field name.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appsync#DeleteResolverResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appsync#DeleteType": { - "type": "operation", - "input": { - "target": "com.amazonaws.appsync#DeleteTypeRequest" - }, - "output": { - "target": "com.amazonaws.appsync#DeleteTypeResponse" - }, - "errors": [ - { - "target": "com.amazonaws.appsync#BadRequestException" - }, - { - "target": "com.amazonaws.appsync#ConcurrentModificationException" - }, - { - "target": "com.amazonaws.appsync#InternalFailureException" - }, - { - "target": "com.amazonaws.appsync#NotFoundException" - }, - { - "target": "com.amazonaws.appsync#UnauthorizedException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes a Type object.
The API ID.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "typeName": { - "target": "com.amazonaws.appsync#ResourceName", - "traits": { - "smithy.api#documentation": "The type name.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appsync#DeleteTypeResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appsync#DeltaSyncConfig": { - "type": "structure", - "members": { - "baseTableTTL": { - "target": "com.amazonaws.appsync#Long", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The number of minutes that an Item is stored in the data source.
" - } - }, - "deltaSyncTableName": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The Delta Sync table name.
" - } - }, - "deltaSyncTableTTL": { - "target": "com.amazonaws.appsync#Long", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The number of minutes that a Delta Sync log entry is stored in the Delta Sync table.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Describes a Delta Sync configuration.
" - } - }, - "com.amazonaws.appsync#Description": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 255 - }, - "smithy.api#pattern": "^.*$" - } - }, - "com.amazonaws.appsync#DisassociateApi": { - "type": "operation", - "input": { - "target": "com.amazonaws.appsync#DisassociateApiRequest" - }, - "output": { - "target": "com.amazonaws.appsync#DisassociateApiResponse" - }, - "errors": [ - { - "target": "com.amazonaws.appsync#AccessDeniedException" - }, - { - "target": "com.amazonaws.appsync#BadRequestException" - }, - { - "target": "com.amazonaws.appsync#ConcurrentModificationException" - }, - { - "target": "com.amazonaws.appsync#InternalFailureException" - }, - { - "target": "com.amazonaws.appsync#NotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "Removes an ApiAssociation object from a custom domain.
The domain name.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appsync#DisassociateApiResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appsync#DisassociateMergedGraphqlApi": { - "type": "operation", - "input": { - "target": "com.amazonaws.appsync#DisassociateMergedGraphqlApiRequest" - }, - "output": { - "target": "com.amazonaws.appsync#DisassociateMergedGraphqlApiResponse" - }, - "errors": [ - { - "target": "com.amazonaws.appsync#BadRequestException" - }, - { - "target": "com.amazonaws.appsync#ConcurrentModificationException" - }, - { - "target": "com.amazonaws.appsync#InternalFailureException" - }, - { - "target": "com.amazonaws.appsync#NotFoundException" - }, - { - "target": "com.amazonaws.appsync#UnauthorizedException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes an association between a Merged API and source API using the source API's identifier and the\n association ID.
", - "smithy.api#http": { - "method": "DELETE", - "uri": "/v1/sourceApis/{sourceApiIdentifier}/mergedApiAssociations/{associationId}", - "code": 200 - } - } - }, - "com.amazonaws.appsync#DisassociateMergedGraphqlApiRequest": { - "type": "structure", - "members": { - "sourceApiIdentifier": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The identifier of the AppSync Source API. This is generated by the AppSync service. In most cases, source\n APIs (especially in your account) only require the API ID value or ARN of the source API. However, source APIs\n from other accounts (cross-account use cases) strictly require the full resource ARN of the source API.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "associationId": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The ID generated by the AppSync service for the source API association.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appsync#DisassociateMergedGraphqlApiResponse": { - "type": "structure", - "members": { - "sourceApiAssociationStatus": { - "target": "com.amazonaws.appsync#SourceApiAssociationStatus", - "traits": { - "smithy.api#documentation": "The state of the source API association.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appsync#DisassociateSourceGraphqlApi": { - "type": "operation", - "input": { - "target": "com.amazonaws.appsync#DisassociateSourceGraphqlApiRequest" - }, - "output": { - "target": "com.amazonaws.appsync#DisassociateSourceGraphqlApiResponse" - }, - "errors": [ - { - "target": "com.amazonaws.appsync#BadRequestException" - }, - { - "target": "com.amazonaws.appsync#ConcurrentModificationException" - }, - { - "target": "com.amazonaws.appsync#InternalFailureException" - }, - { - "target": "com.amazonaws.appsync#NotFoundException" - }, - { - "target": "com.amazonaws.appsync#UnauthorizedException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes an association between a Merged API and source API using the Merged API's identifier and the\n association ID.
", - "smithy.api#http": { - "method": "DELETE", - "uri": "/v1/mergedApis/{mergedApiIdentifier}/sourceApiAssociations/{associationId}", - "code": 200 - } - } - }, - "com.amazonaws.appsync#DisassociateSourceGraphqlApiRequest": { - "type": "structure", - "members": { - "mergedApiIdentifier": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged\n APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs\n in other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "associationId": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The ID generated by the AppSync service for the source API association.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appsync#DisassociateSourceGraphqlApiResponse": { - "type": "structure", - "members": { - "sourceApiAssociationStatus": { - "target": "com.amazonaws.appsync#SourceApiAssociationStatus", - "traits": { - "smithy.api#documentation": "The state of the source API association.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appsync#DomainName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 253 - }, - "smithy.api#pattern": "^(\\*[\\w\\d-]*\\.)?([\\w\\d-]+\\.)+[\\w\\d-]+$" - } - }, - "com.amazonaws.appsync#DomainNameConfig": { - "type": "structure", - "members": { - "domainName": { - "target": "com.amazonaws.appsync#DomainName", - "traits": { - "smithy.api#documentation": "The domain name.
" - } - }, - "description": { - "target": "com.amazonaws.appsync#Description", - "traits": { - "smithy.api#documentation": "A description of the DomainName configuration.
The Amazon Resource Name (ARN) of the certificate. This can be an Certificate Manager (ACM) certificate or an Identity and Access Management (IAM) server certificate.
" - } - }, - "appsyncDomainName": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The domain name that AppSync provides.
" - } - }, - "hostedZoneId": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The ID of your Amazon Route 53 hosted zone.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Describes a configuration for a custom domain.
" - } - }, - "com.amazonaws.appsync#DomainNameConfigs": { - "type": "list", - "member": { - "target": "com.amazonaws.appsync#DomainNameConfig" - } - }, - "com.amazonaws.appsync#DynamodbDataSourceConfig": { - "type": "structure", - "members": { - "tableName": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The table name.
", - "smithy.api#required": {} - } - }, - "awsRegion": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The Amazon Web Services Region.
", - "smithy.api#required": {} - } - }, - "useCallerCredentials": { - "target": "com.amazonaws.appsync#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "Set to TRUE to use Amazon Cognito credentials with this data source.
" - } - }, - "deltaSyncConfig": { - "target": "com.amazonaws.appsync#DeltaSyncConfig", - "traits": { - "smithy.api#documentation": "The DeltaSyncConfig for a versioned data source.
Set to TRUE to use Conflict Detection and Resolution with this data source.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Describes an Amazon DynamoDB data source configuration.
" - } - }, - "com.amazonaws.appsync#ElasticsearchDataSourceConfig": { - "type": "structure", - "members": { - "endpoint": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The endpoint.
", - "smithy.api#required": {} - } - }, - "awsRegion": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The Amazon Web Services Region.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Describes an OpenSearch data source configuration.
\nAs of September 2021, Amazon Elasticsearch service is Amazon OpenSearch Service. This configuration is\n deprecated. For new data sources, use OpenSearchServiceDataSourceConfig to specify an OpenSearch data source.
" - } - }, - "com.amazonaws.appsync#EnhancedMetricsConfig": { - "type": "structure", - "members": { - "resolverLevelMetricsBehavior": { - "target": "com.amazonaws.appsync#ResolverLevelMetricsBehavior", - "traits": { - "smithy.api#documentation": "Controls how resolver metrics will be emitted to CloudWatch. Resolver metrics include:
\nGraphQL errors: The number of GraphQL errors that occurred.
\nRequests: The number of invocations that occurred during a request.
\nLatency: The time to complete a resolver invocation.
\nCache hits: The number of cache hits during a request.
\nCache misses: The number of cache misses during a request.
\nThese metrics can be emitted to CloudWatch per resolver or for all resolvers in the request. Metrics will be\n recorded by API ID and resolver name. resolverLevelMetricsBehavior accepts one of these values at\n a time:
\n FULL_REQUEST_RESOLVER_METRICS: Records and emits metric data for all resolvers in the\n request.
\n PER_RESOLVER_METRICS: Records and emits metric data for resolvers that have the\n metricsConfig value set to ENABLED.
Controls how data source metrics will be emitted to CloudWatch. Data source metrics include:
\nRequests: The number of invocations that occured during a request.
\nLatency: The time to complete a data source invocation.
\nErrors: The number of errors that occurred during a data source invocation.
\nThese metrics can be emitted to CloudWatch per data source or for all data sources in the request. Metrics\n will be recorded by API ID and data source name. dataSourceLevelMetricsBehavior accepts one of\n these values at a time:
\n FULL_REQUEST_DATA_SOURCE_METRICS: Records and emits metric data for all data sources\n in the request.
\n PER_DATA_SOURCE_METRICS: Records and emits metric data for data sources that have the\n metricsConfig value set to ENABLED.
Controls how operation metrics will be emitted to CloudWatch. Operation metrics include:
\nRequests: The number of times a specified GraphQL operation was called.
\nGraphQL errors: The number of GraphQL errors that occurred during a specified GraphQL\n operation.
\nMetrics will be recorded by API ID and operation name. You can set the value to ENABLED or\n DISABLED.
Enables and controls the enhanced metrics feature. Enhanced metrics emit granular data on API usage and\n performance such as AppSync request and error counts, latency, and cache hits/misses. All enhanced metric data\n is sent to your CloudWatch account, and you can configure the types of data that will be sent.
\nEnhanced metrics can be configured at the resolver, data source, and operation levels.\n EnhancedMetricsConfig contains three required parameters, each controlling one of these\n categories:
\n resolverLevelMetricsBehavior: Controls how resolver metrics will be emitted to\n CloudWatch. Resolver metrics include:
GraphQL errors: The number of GraphQL errors that occurred.
\nRequests: The number of invocations that occurred during a request.
\nLatency: The time to complete a resolver invocation.
\nCache hits: The number of cache hits during a request.
\nCache misses: The number of cache misses during a request.
\nThese metrics can be emitted to CloudWatch per resolver or for all resolvers in the request. Metrics\n will be recorded by API ID and resolver name. resolverLevelMetricsBehavior accepts one of\n these values at a time:
\n FULL_REQUEST_RESOLVER_METRICS: Records and emits metric data for all resolvers\n in the request.
\n PER_RESOLVER_METRICS: Records and emits metric data for resolvers that have the\n metricsConfig value set to ENABLED.
\n dataSourceLevelMetricsBehavior: Controls how data source metrics will be emitted to\n CloudWatch. Data source metrics include:
Requests: The number of invocations that occured during a request.
\nLatency: The time to complete a data source invocation.
\nErrors: The number of errors that occurred during a data source invocation.
\nThese metrics can be emitted to CloudWatch per data source or for all data sources in the request.\n Metrics will be recorded by API ID and data source name. dataSourceLevelMetricsBehavior\n accepts one of these values at a time:
\n FULL_REQUEST_DATA_SOURCE_METRICS: Records and emits metric data for all data\n sources in the request.
\n PER_DATA_SOURCE_METRICS: Records and emits metric data for data sources that\n have the metricsConfig value set to ENABLED.
\n operationLevelMetricsConfig: Controls how operation metrics will be emitted to\n CloudWatch. Operation metrics include:
Requests: The number of times a specified GraphQL operation was called.
\nGraphQL errors: The number of GraphQL errors that occurred during a specified GraphQL\n operation.
\nMetrics will be recorded by API ID and operation name. You can set the value to ENABLED\n or DISABLED.
The error payload.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains the list of errors generated. When using JavaScript, this will apply to the request or response\n function evaluation.
" - } - }, - "com.amazonaws.appsync#ErrorMessage": { - "type": "string" - }, - "com.amazonaws.appsync#EvaluateCode": { - "type": "operation", - "input": { - "target": "com.amazonaws.appsync#EvaluateCodeRequest" - }, - "output": { - "target": "com.amazonaws.appsync#EvaluateCodeResponse" - }, - "errors": [ - { - "target": "com.amazonaws.appsync#AccessDeniedException" - }, - { - "target": "com.amazonaws.appsync#BadRequestException" - }, - { - "target": "com.amazonaws.appsync#InternalFailureException" - } - ], - "traits": { - "smithy.api#documentation": "Evaluates the given code and returns the response. The code definition requirements depend on the specified\n runtime. For APPSYNC_JS runtimes, the code defines the request and response functions. The request\n function takes the incoming request after a GraphQL operation is parsed and converts it into a request\n configuration for the selected data source operation. The response function interprets responses from the data\n source and maps it to the shape of the GraphQL field output type.
The error payload.
" - } - }, - "codeErrors": { - "target": "com.amazonaws.appsync#CodeErrors", - "traits": { - "smithy.api#documentation": "Contains the list of CodeError objects.
Contains the list of errors from a code evaluation response.
" - } - }, - "com.amazonaws.appsync#EvaluateCodeRequest": { - "type": "structure", - "members": { - "runtime": { - "target": "com.amazonaws.appsync#AppSyncRuntime", - "traits": { - "smithy.api#documentation": "The runtime to be used when evaluating the code. Currently, only the APPSYNC_JS runtime is\n supported.
The code definition to be evaluated. Note that code and runtime are both required\n for this action. The runtime value must be APPSYNC_JS.
The map that holds all of the contextual information for your resolver invocation. A context is\n required for this action.
The function within the code to be evaluated. If provided, the valid values are request and\n response.
The result of the evaluation operation.
" - } - }, - "error": { - "target": "com.amazonaws.appsync#EvaluateCodeErrorDetail", - "traits": { - "smithy.api#documentation": "Contains the payload of the response error.
" - } - }, - "logs": { - "target": "com.amazonaws.appsync#Logs", - "traits": { - "smithy.api#documentation": "A list of logs that were generated by calls to util.log.info and util.log.error in\n the evaluated code.
Evaluates a given template and returns the response. The mapping template can be a request or response\n template.
\nRequest templates take the incoming request after a GraphQL operation is parsed and convert it into a\n request configuration for the selected data source operation. Response templates interpret responses from the\n data source and map it to the shape of the GraphQL field output type.
\nMapping templates are written in the Apache Velocity Template Language (VTL).
", - "smithy.api#http": { - "method": "POST", - "uri": "/v1/dataplane-evaluatetemplate", - "code": 200 - } - } - }, - "com.amazonaws.appsync#EvaluateMappingTemplateRequest": { - "type": "structure", - "members": { - "template": { - "target": "com.amazonaws.appsync#Template", - "traits": { - "smithy.api#documentation": "The mapping template; this can be a request or response template. A template is required for\n this action.
The map that holds all of the contextual information for your resolver invocation. A context is\n required for this action.
The mapping template; this can be a request or response template.
" - } - }, - "error": { - "target": "com.amazonaws.appsync#ErrorDetail", - "traits": { - "smithy.api#documentation": "The ErrorDetail object.
A list of logs that were generated by calls to util.log.info and util.log.error in\n the evaluated code.
The ARN of the event bus. For more information about event buses, see Amazon EventBridge event\n buses.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Describes an Amazon EventBridge bus data source configuration.
" - } - }, - "com.amazonaws.appsync#FieldLogLevel": { - "type": "enum", - "members": { - "NONE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NONE" - } - }, - "ERROR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ERROR" - } - }, - "ALL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ALL" - } - } - } - }, - "com.amazonaws.appsync#FlushApiCache": { - "type": "operation", - "input": { - "target": "com.amazonaws.appsync#FlushApiCacheRequest" - }, - "output": { - "target": "com.amazonaws.appsync#FlushApiCacheResponse" - }, - "errors": [ - { - "target": "com.amazonaws.appsync#BadRequestException" - }, - { - "target": "com.amazonaws.appsync#ConcurrentModificationException" - }, - { - "target": "com.amazonaws.appsync#InternalFailureException" - }, - { - "target": "com.amazonaws.appsync#NotFoundException" - }, - { - "target": "com.amazonaws.appsync#UnauthorizedException" - } - ], - "traits": { - "smithy.api#documentation": "Flushes an ApiCache object.
The API ID.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Represents the input of a FlushApiCache operation.
Represents the output of a FlushApiCache operation.
A unique ID representing the Function object.
The Amazon Resource Name (ARN) of the Function object.
The name of the Function object.
The Function description.
The name of the DataSource.
The Function request mapping template. Functions support only the 2018-05-29 version of the\n request mapping template.
The Function response mapping template.
The version of the request mapping template. Currently, only the 2018-05-29 version of the template is\n supported.
" - } - }, - "syncConfig": { - "target": "com.amazonaws.appsync#SyncConfig" - }, - "maxBatchSize": { - "target": "com.amazonaws.appsync#MaxBatchSize", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The maximum batching size for a resolver.
" - } - }, - "runtime": { - "target": "com.amazonaws.appsync#AppSyncRuntime" - }, - "code": { - "target": "com.amazonaws.appsync#Code", - "traits": { - "smithy.api#documentation": "The function code that contains the request and response functions. When code is used, the\n runtime is required. The runtime value must be APPSYNC_JS.
A function is a reusable entity. You can use multiple functions to compose the resolver logic.
" - } - }, - "com.amazonaws.appsync#Functions": { - "type": "list", - "member": { - "target": "com.amazonaws.appsync#FunctionConfiguration" - } - }, - "com.amazonaws.appsync#FunctionsIds": { - "type": "list", - "member": { - "target": "com.amazonaws.appsync#String" - } - }, - "com.amazonaws.appsync#GetApiAssociation": { - "type": "operation", - "input": { - "target": "com.amazonaws.appsync#GetApiAssociationRequest" - }, - "output": { - "target": "com.amazonaws.appsync#GetApiAssociationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.appsync#AccessDeniedException" - }, - { - "target": "com.amazonaws.appsync#BadRequestException" - }, - { - "target": "com.amazonaws.appsync#InternalFailureException" - }, - { - "target": "com.amazonaws.appsync#NotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "Retrieves an ApiAssociation object.
The domain name.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appsync#GetApiAssociationResponse": { - "type": "structure", - "members": { - "apiAssociation": { - "target": "com.amazonaws.appsync#ApiAssociation", - "traits": { - "smithy.api#documentation": "The ApiAssociation object.
Retrieves an ApiCache object.
The API ID.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Represents the input of a GetApiCache operation.
The ApiCache object.
Represents the output of a GetApiCache operation.
Retrieves a DataSource object.
Retrieves the record of an existing introspection. If the retrieval is successful, the result of the\n instrospection will also be returned. If the retrieval fails the operation, an error message will be returned\n instead.
", - "smithy.api#http": { - "method": "GET", - "uri": "/v1/datasources/introspections/{introspectionId}", - "code": 200 - } - } - }, - "com.amazonaws.appsync#GetDataSourceIntrospectionRequest": { - "type": "structure", - "members": { - "introspectionId": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The introspection ID. Each introspection contains a unique ID that can be used to reference the\n instrospection record.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "includeModelsSDL": { - "target": "com.amazonaws.appsync#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "A boolean flag that determines whether SDL should be generated for introspected types or not. If set to\n true, each model will contain an sdl property that contains the SDL for that type.\n The SDL only contains the type data and no additional metadata or directives.
Determines the number of types to be returned in a single response before paginating. This value is\n typically taken from nextToken value from the previous response.
The maximum number of introspected types that will be returned in a single response.
", - "smithy.api#httpQuery": "maxResults" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appsync#GetDataSourceIntrospectionResponse": { - "type": "structure", - "members": { - "introspectionId": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The introspection ID. Each introspection contains a unique ID that can be used to reference the\n instrospection record.
" - } - }, - "introspectionStatus": { - "target": "com.amazonaws.appsync#DataSourceIntrospectionStatus", - "traits": { - "smithy.api#documentation": "The status of the introspection during retrieval. By default, when a new instrospection is being retrieved,\n the status will be set to PROCESSING. Once the operation has been completed, the status will\n change to SUCCESS or FAILED depending on how the data was parsed. A\n FAILED operation will return an error and its details as an\n introspectionStatusDetail.
The error detail field. When a FAILED\n introspectionStatus is returned, the introspectionStatusDetail will also return the\n exact error that was generated during the operation.
The DataSourceIntrospectionResult object data.
The API ID.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "name": { - "target": "com.amazonaws.appsync#ResourceName", - "traits": { - "smithy.api#documentation": "The name of the data source.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appsync#GetDataSourceResponse": { - "type": "structure", - "members": { - "dataSource": { - "target": "com.amazonaws.appsync#DataSource", - "traits": { - "smithy.api#documentation": "The DataSource object.
Retrieves a custom DomainName object.
The domain name.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appsync#GetDomainNameResponse": { - "type": "structure", - "members": { - "domainNameConfig": { - "target": "com.amazonaws.appsync#DomainNameConfig", - "traits": { - "smithy.api#documentation": "The configuration for the DomainName.
Get a Function.
The GraphQL API ID.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "functionId": { - "target": "com.amazonaws.appsync#ResourceName", - "traits": { - "smithy.api#documentation": "The Function ID.
The Function object.
Retrieves a GraphqlApi object.
Retrieves the list of environmental variable key-value pairs associated with an API by its ID value.
", - "smithy.api#http": { - "method": "GET", - "uri": "/v1/apis/{apiId}/environmentVariables", - "code": 200 - } - } - }, - "com.amazonaws.appsync#GetGraphqlApiEnvironmentVariablesRequest": { - "type": "structure", - "members": { - "apiId": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The ID of the API from which the environmental variable list will be retrieved.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appsync#GetGraphqlApiEnvironmentVariablesResponse": { - "type": "structure", - "members": { - "environmentVariables": { - "target": "com.amazonaws.appsync#EnvironmentVariableMap", - "traits": { - "smithy.api#documentation": "The payload containing each environmental variable in the \"key\" : \"value\" format.
The API ID for the GraphQL API.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appsync#GetGraphqlApiResponse": { - "type": "structure", - "members": { - "graphqlApi": { - "target": "com.amazonaws.appsync#GraphqlApi", - "traits": { - "smithy.api#documentation": "The GraphqlApi object.
Retrieves the introspection schema for a GraphQL API.
", - "smithy.api#http": { - "method": "GET", - "uri": "/v1/apis/{apiId}/schema", - "code": 200 - } - } - }, - "com.amazonaws.appsync#GetIntrospectionSchemaRequest": { - "type": "structure", - "members": { - "apiId": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The API ID.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "format": { - "target": "com.amazonaws.appsync#OutputType", - "traits": { - "smithy.api#documentation": "The schema format: SDL or JSON.
", - "smithy.api#httpQuery": "format", - "smithy.api#required": {} - } - }, - "includeDirectives": { - "target": "com.amazonaws.appsync#BooleanValue", - "traits": { - "smithy.api#documentation": "A flag that specifies whether the schema introspection should contain directives.
", - "smithy.api#httpQuery": "includeDirectives" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appsync#GetIntrospectionSchemaResponse": { - "type": "structure", - "members": { - "schema": { - "target": "com.amazonaws.appsync#Blob", - "traits": { - "smithy.api#documentation": "The schema, in GraphQL Schema Definition Language (SDL) format.
\nFor more information, see the GraphQL SDL\n documentation.
", - "smithy.api#httpPayload": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appsync#GetResolver": { - "type": "operation", - "input": { - "target": "com.amazonaws.appsync#GetResolverRequest" - }, - "output": { - "target": "com.amazonaws.appsync#GetResolverResponse" - }, - "errors": [ - { - "target": "com.amazonaws.appsync#ConcurrentModificationException" - }, - { - "target": "com.amazonaws.appsync#NotFoundException" - }, - { - "target": "com.amazonaws.appsync#UnauthorizedException" - } - ], - "traits": { - "smithy.api#documentation": "Retrieves a Resolver object.
The API ID.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "typeName": { - "target": "com.amazonaws.appsync#ResourceName", - "traits": { - "smithy.api#documentation": "The resolver type name.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "fieldName": { - "target": "com.amazonaws.appsync#ResourceName", - "traits": { - "smithy.api#documentation": "The resolver field name.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appsync#GetResolverResponse": { - "type": "structure", - "members": { - "resolver": { - "target": "com.amazonaws.appsync#Resolver", - "traits": { - "smithy.api#documentation": "The Resolver object.
Retrieves the current status of a schema creation operation.
", - "smithy.api#http": { - "method": "GET", - "uri": "/v1/apis/{apiId}/schemacreation", - "code": 200 - } - } - }, - "com.amazonaws.appsync#GetSchemaCreationStatusRequest": { - "type": "structure", - "members": { - "apiId": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The API ID.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appsync#GetSchemaCreationStatusResponse": { - "type": "structure", - "members": { - "status": { - "target": "com.amazonaws.appsync#SchemaStatus", - "traits": { - "smithy.api#documentation": "The current state of the schema (PROCESSING, FAILED, SUCCESS, or NOT_APPLICABLE). When the schema is in the\n ACTIVE state, you can add data.
" - } - }, - "details": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "Detailed information about the status of the schema creation operation.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appsync#GetSourceApiAssociation": { - "type": "operation", - "input": { - "target": "com.amazonaws.appsync#GetSourceApiAssociationRequest" - }, - "output": { - "target": "com.amazonaws.appsync#GetSourceApiAssociationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.appsync#BadRequestException" - }, - { - "target": "com.amazonaws.appsync#InternalFailureException" - }, - { - "target": "com.amazonaws.appsync#NotFoundException" - }, - { - "target": "com.amazonaws.appsync#UnauthorizedException" - } - ], - "traits": { - "smithy.api#documentation": "Retrieves a SourceApiAssociation object.
The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged\n APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs\n in other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "associationId": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The ID generated by the AppSync service for the source API association.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appsync#GetSourceApiAssociationResponse": { - "type": "structure", - "members": { - "sourceApiAssociation": { - "target": "com.amazonaws.appsync#SourceApiAssociation", - "traits": { - "smithy.api#documentation": "The SourceApiAssociation object data.
Retrieves a Type object.
The API ID.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "typeName": { - "target": "com.amazonaws.appsync#ResourceName", - "traits": { - "smithy.api#documentation": "The type name.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "format": { - "target": "com.amazonaws.appsync#TypeDefinitionFormat", - "traits": { - "smithy.api#documentation": "The type format: SDL or JSON.
", - "smithy.api#httpQuery": "format", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appsync#GetTypeResponse": { - "type": "structure", - "members": { - "type": { - "target": "com.amazonaws.appsync#Type", - "traits": { - "smithy.api#documentation": "The Type object.
The GraphQL schema is not valid.
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.appsync#GraphqlApi": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.appsync#ResourceName", - "traits": { - "smithy.api#documentation": "The API name.
" - } - }, - "apiId": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The API ID.
" - } - }, - "authenticationType": { - "target": "com.amazonaws.appsync#AuthenticationType", - "traits": { - "smithy.api#documentation": "The authentication type.
" - } - }, - "logConfig": { - "target": "com.amazonaws.appsync#LogConfig", - "traits": { - "smithy.api#documentation": "The Amazon CloudWatch Logs configuration.
" - } - }, - "userPoolConfig": { - "target": "com.amazonaws.appsync#UserPoolConfig", - "traits": { - "smithy.api#documentation": "The Amazon Cognito user pool configuration.
" - } - }, - "openIDConnectConfig": { - "target": "com.amazonaws.appsync#OpenIDConnectConfig", - "traits": { - "smithy.api#documentation": "The OpenID Connect configuration.
" - } - }, - "arn": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN).
" - } - }, - "uris": { - "target": "com.amazonaws.appsync#MapOfStringToString", - "traits": { - "smithy.api#documentation": "The URIs.
" - } - }, - "tags": { - "target": "com.amazonaws.appsync#TagMap", - "traits": { - "smithy.api#documentation": "The tags.
" - } - }, - "additionalAuthenticationProviders": { - "target": "com.amazonaws.appsync#AdditionalAuthenticationProviders", - "traits": { - "smithy.api#documentation": "A list of additional authentication providers for the GraphqlApi API.
A flag indicating whether to use X-Ray tracing for this GraphqlApi.
The ARN of the WAF access control list (ACL) associated with this\n GraphqlApi, if one exists.
Configuration for Lambda function authorization.
" - } - }, - "dns": { - "target": "com.amazonaws.appsync#MapOfStringToString", - "traits": { - "smithy.api#documentation": "The DNS records for the API.
" - } - }, - "visibility": { - "target": "com.amazonaws.appsync#GraphQLApiVisibility", - "traits": { - "smithy.api#documentation": "Sets the value of the GraphQL API to public (GLOBAL) or private (PRIVATE). If no\n value is provided, the visibility will be set to GLOBAL by default. This value cannot be changed\n once the API has been created.
The value that indicates whether the GraphQL API is a standard API (GRAPHQL) or merged API\n (MERGED).
The Identity and Access Management service role ARN for a merged API. The AppSync service assumes this role\n on behalf of the Merged API to validate access to source APIs at runtime and to prompt the\n AUTO_MERGE to update the merged API endpoint with the source API changes automatically.
The account owner of the GraphQL API.
" - } - }, - "ownerContact": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The owner contact information for an API resource.
\nThis field accepts any string input with a length of 0 - 256 characters.
" - } - }, - "introspectionConfig": { - "target": "com.amazonaws.appsync#GraphQLApiIntrospectionConfig", - "traits": { - "smithy.api#documentation": "Sets the value of the GraphQL API to enable (ENABLED) or disable (DISABLED)\n introspection. If no value is provided, the introspection configuration will be set to ENABLED by\n default. This field will produce an error if the operation attempts to use the introspection feature while this\n field is disabled.
For more information about introspection, see GraphQL\n introspection.
" - } - }, - "queryDepthLimit": { - "target": "com.amazonaws.appsync#QueryDepthLimit", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The maximum depth a query can have in a single request. Depth refers to the amount of nested levels allowed\n in the body of query. The default value is 0 (or unspecified), which indicates there's no depth\n limit. If you set a limit, it can be between 1 and 75 nested levels. This field will\n produce a limit error if the operation falls out of bounds.
Note that fields can still be set to nullable or non-nullable. If a non-nullable field produces an error,\n the error will be thrown upwards to the first nullable field available.
" - } - }, - "resolverCountLimit": { - "target": "com.amazonaws.appsync#ResolverCountLimit", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The maximum number of resolvers that can be invoked in a single request. The default value is 0\n (or unspecified), which will set the limit to 10000. When specified, the limit value can be\n between 1 and 10000. This field will produce a limit error if the operation falls out\n of bounds.
The enhancedMetricsConfig object.
Describes a GraphQL API.
" - } - }, - "com.amazonaws.appsync#GraphqlApis": { - "type": "list", - "member": { - "target": "com.amazonaws.appsync#GraphqlApi" - } - }, - "com.amazonaws.appsync#HttpDataSourceConfig": { - "type": "structure", - "members": { - "endpoint": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The HTTP URL endpoint. You can specify either the domain name or IP, and port combination, and the URL\n scheme must be HTTP or HTTPS. If you don't specify the port, AppSync uses the default port 80\n for the HTTP endpoint and port 443 for HTTPS endpoints.
" - } - }, - "authorizationConfig": { - "target": "com.amazonaws.appsync#AuthorizationConfig", - "traits": { - "smithy.api#documentation": "The authorization configuration in case the HTTP endpoint requires authorization.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Describes an HTTP data source configuration.
" - } - }, - "com.amazonaws.appsync#InternalFailureException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.appsync#String" - } - }, - "traits": { - "smithy.api#documentation": "An internal AppSync error occurred. Try your request again.
", - "smithy.api#error": "server", - "smithy.api#httpError": 500 - } - }, - "com.amazonaws.appsync#LambdaAuthorizerConfig": { - "type": "structure", - "members": { - "authorizerResultTtlInSeconds": { - "target": "com.amazonaws.appsync#TTL", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The number of seconds a response should be cached for. The default is 0 seconds, which disables caching. If\n you don't specify a value for authorizerResultTtlInSeconds, the default value is used. The maximum\n value is one hour (3600 seconds). The Lambda function can override this by returning a\n ttlOverride key in its response.
The Amazon Resource Name (ARN) of the Lambda function to be called for authorization. This can\n be a standard Lambda ARN, a version ARN (.../v3), or an alias ARN.
\n Note: This Lambda function must have the following\n resource-based policy assigned to it. When configuring Lambda authorizers in the console, this is\n done for you. To use the Command Line Interface (CLI), run the following:
\n\n aws lambda add-permission --function-name\n \"arn:aws:lambda:us-east-2:111122223333:function:my-function\" --statement-id \"appsync\" --principal\n appsync.amazonaws.com --action lambda:InvokeFunction\n
A regular expression for validation of tokens before the Lambda function is called.
" - } - } - }, - "traits": { - "smithy.api#documentation": "A LambdaAuthorizerConfig specifies how to authorize AppSync API access when\n using the AWS_LAMBDA authorizer mode. Be aware that an AppSync API can have only\n one Lambda authorizer configured at a time.
The Amazon Resource Name (ARN) for the Lambda function to use as the Conflict Handler.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The LambdaConflictHandlerConfig object when configuring LAMBDA as the Conflict\n Handler.
The Amazon Resource Name (ARN) for the Lambda function.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Describes an Lambda data source configuration.
" - } - }, - "com.amazonaws.appsync#LimitExceededException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.appsync#String" - } - }, - "traits": { - "smithy.api#documentation": "The request exceeded a limit. Try your request again.
", - "smithy.api#error": "client", - "smithy.api#httpError": 429 - } - }, - "com.amazonaws.appsync#ListApiKeys": { - "type": "operation", - "input": { - "target": "com.amazonaws.appsync#ListApiKeysRequest" - }, - "output": { - "target": "com.amazonaws.appsync#ListApiKeysResponse" - }, - "errors": [ - { - "target": "com.amazonaws.appsync#BadRequestException" - }, - { - "target": "com.amazonaws.appsync#InternalFailureException" - }, - { - "target": "com.amazonaws.appsync#NotFoundException" - }, - { - "target": "com.amazonaws.appsync#UnauthorizedException" - } - ], - "traits": { - "smithy.api#documentation": "Lists the API keys for a given API.
\nAPI keys are deleted automatically 60 days after they expire. However, they may still be included in the\n response until they have actually been deleted. You can safely call DeleteApiKey to manually\n delete a key before it's automatically deleted.
The API ID.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "nextToken": { - "target": "com.amazonaws.appsync#PaginationToken", - "traits": { - "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which you can use to return the\n next set of items in the list.
", - "smithy.api#httpQuery": "nextToken" - } - }, - "maxResults": { - "target": "com.amazonaws.appsync#MaxResults", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The maximum number of results that you want the request to return.
", - "smithy.api#httpQuery": "maxResults" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appsync#ListApiKeysResponse": { - "type": "structure", - "members": { - "apiKeys": { - "target": "com.amazonaws.appsync#ApiKeys", - "traits": { - "smithy.api#documentation": "The ApiKey objects.
An identifier to pass in the next request to this operation to return the next set of items in the\n list.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appsync#ListDataSources": { - "type": "operation", - "input": { - "target": "com.amazonaws.appsync#ListDataSourcesRequest" - }, - "output": { - "target": "com.amazonaws.appsync#ListDataSourcesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.appsync#BadRequestException" - }, - { - "target": "com.amazonaws.appsync#InternalFailureException" - }, - { - "target": "com.amazonaws.appsync#NotFoundException" - }, - { - "target": "com.amazonaws.appsync#UnauthorizedException" - } - ], - "traits": { - "smithy.api#documentation": "Lists the data sources for a given API.
", - "smithy.api#http": { - "method": "GET", - "uri": "/v1/apis/{apiId}/datasources", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "dataSources", - "pageSize": "maxResults" - } - } - }, - "com.amazonaws.appsync#ListDataSourcesRequest": { - "type": "structure", - "members": { - "apiId": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The API ID.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "nextToken": { - "target": "com.amazonaws.appsync#PaginationToken", - "traits": { - "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which you can use to return the\n next set of items in the list.
", - "smithy.api#httpQuery": "nextToken" - } - }, - "maxResults": { - "target": "com.amazonaws.appsync#MaxResults", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The maximum number of results that you want the request to return.
", - "smithy.api#httpQuery": "maxResults" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appsync#ListDataSourcesResponse": { - "type": "structure", - "members": { - "dataSources": { - "target": "com.amazonaws.appsync#DataSources", - "traits": { - "smithy.api#documentation": "The DataSource objects.
An identifier to pass in the next request to this operation to return the next set of items in the\n list.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appsync#ListDomainNames": { - "type": "operation", - "input": { - "target": "com.amazonaws.appsync#ListDomainNamesRequest" - }, - "output": { - "target": "com.amazonaws.appsync#ListDomainNamesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.appsync#AccessDeniedException" - }, - { - "target": "com.amazonaws.appsync#BadRequestException" - }, - { - "target": "com.amazonaws.appsync#InternalFailureException" - } - ], - "traits": { - "smithy.api#documentation": "Lists multiple custom domain names.
", - "smithy.api#http": { - "method": "GET", - "uri": "/v1/domainnames", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "domainNameConfigs", - "pageSize": "maxResults" - } - } - }, - "com.amazonaws.appsync#ListDomainNamesRequest": { - "type": "structure", - "members": { - "nextToken": { - "target": "com.amazonaws.appsync#PaginationToken", - "traits": { - "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which you can use to return the\n next set of items in the list.
", - "smithy.api#httpQuery": "nextToken" - } - }, - "maxResults": { - "target": "com.amazonaws.appsync#MaxResults", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The maximum number of results that you want the request to return.
", - "smithy.api#httpQuery": "maxResults" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appsync#ListDomainNamesResponse": { - "type": "structure", - "members": { - "domainNameConfigs": { - "target": "com.amazonaws.appsync#DomainNameConfigs", - "traits": { - "smithy.api#documentation": "Lists configurations for multiple domain names.
" - } - }, - "nextToken": { - "target": "com.amazonaws.appsync#PaginationToken", - "traits": { - "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which you can use to return the\n next set of items in the list.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appsync#ListFunctions": { - "type": "operation", - "input": { - "target": "com.amazonaws.appsync#ListFunctionsRequest" - }, - "output": { - "target": "com.amazonaws.appsync#ListFunctionsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.appsync#BadRequestException" - }, - { - "target": "com.amazonaws.appsync#InternalFailureException" - }, - { - "target": "com.amazonaws.appsync#NotFoundException" - }, - { - "target": "com.amazonaws.appsync#UnauthorizedException" - } - ], - "traits": { - "smithy.api#documentation": "List multiple functions.
", - "smithy.api#http": { - "method": "GET", - "uri": "/v1/apis/{apiId}/functions", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "functions", - "pageSize": "maxResults" - } - } - }, - "com.amazonaws.appsync#ListFunctionsRequest": { - "type": "structure", - "members": { - "apiId": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The GraphQL API ID.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "nextToken": { - "target": "com.amazonaws.appsync#PaginationToken", - "traits": { - "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which you can use to return the\n next set of items in the list.
", - "smithy.api#httpQuery": "nextToken" - } - }, - "maxResults": { - "target": "com.amazonaws.appsync#MaxResults", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The maximum number of results that you want the request to return.
", - "smithy.api#httpQuery": "maxResults" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appsync#ListFunctionsResponse": { - "type": "structure", - "members": { - "functions": { - "target": "com.amazonaws.appsync#Functions", - "traits": { - "smithy.api#documentation": "A list of Function objects.
An identifier that was returned from the previous call to this operation, which you can use to return the\n next set of items in the list.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appsync#ListGraphqlApis": { - "type": "operation", - "input": { - "target": "com.amazonaws.appsync#ListGraphqlApisRequest" - }, - "output": { - "target": "com.amazonaws.appsync#ListGraphqlApisResponse" - }, - "errors": [ - { - "target": "com.amazonaws.appsync#BadRequestException" - }, - { - "target": "com.amazonaws.appsync#InternalFailureException" - }, - { - "target": "com.amazonaws.appsync#UnauthorizedException" - } - ], - "traits": { - "smithy.api#documentation": "Lists your GraphQL APIs.
", - "smithy.api#http": { - "method": "GET", - "uri": "/v1/apis", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "graphqlApis", - "pageSize": "maxResults" - } - } - }, - "com.amazonaws.appsync#ListGraphqlApisRequest": { - "type": "structure", - "members": { - "nextToken": { - "target": "com.amazonaws.appsync#PaginationToken", - "traits": { - "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which you can use to return the\n next set of items in the list.
", - "smithy.api#httpQuery": "nextToken" - } - }, - "maxResults": { - "target": "com.amazonaws.appsync#MaxResults", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The maximum number of results that you want the request to return.
", - "smithy.api#httpQuery": "maxResults" - } - }, - "apiType": { - "target": "com.amazonaws.appsync#GraphQLApiType", - "traits": { - "smithy.api#documentation": "The value that indicates whether the GraphQL API is a standard API (GRAPHQL) or merged API\n (MERGED).
The account owner of the GraphQL API.
", - "smithy.api#httpQuery": "owner" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appsync#ListGraphqlApisResponse": { - "type": "structure", - "members": { - "graphqlApis": { - "target": "com.amazonaws.appsync#GraphqlApis", - "traits": { - "smithy.api#documentation": "The GraphqlApi objects.
An identifier to pass in the next request to this operation to return the next set of items in the\n list.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appsync#ListResolvers": { - "type": "operation", - "input": { - "target": "com.amazonaws.appsync#ListResolversRequest" - }, - "output": { - "target": "com.amazonaws.appsync#ListResolversResponse" - }, - "errors": [ - { - "target": "com.amazonaws.appsync#BadRequestException" - }, - { - "target": "com.amazonaws.appsync#InternalFailureException" - }, - { - "target": "com.amazonaws.appsync#NotFoundException" - }, - { - "target": "com.amazonaws.appsync#UnauthorizedException" - } - ], - "traits": { - "smithy.api#documentation": "Lists the resolvers for a given API and type.
", - "smithy.api#http": { - "method": "GET", - "uri": "/v1/apis/{apiId}/types/{typeName}/resolvers", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "resolvers", - "pageSize": "maxResults" - } - } - }, - "com.amazonaws.appsync#ListResolversByFunction": { - "type": "operation", - "input": { - "target": "com.amazonaws.appsync#ListResolversByFunctionRequest" - }, - "output": { - "target": "com.amazonaws.appsync#ListResolversByFunctionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.appsync#BadRequestException" - }, - { - "target": "com.amazonaws.appsync#InternalFailureException" - }, - { - "target": "com.amazonaws.appsync#NotFoundException" - }, - { - "target": "com.amazonaws.appsync#UnauthorizedException" - } - ], - "traits": { - "smithy.api#documentation": "List the resolvers that are associated with a specific function.
", - "smithy.api#http": { - "method": "GET", - "uri": "/v1/apis/{apiId}/functions/{functionId}/resolvers", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "resolvers", - "pageSize": "maxResults" - } - } - }, - "com.amazonaws.appsync#ListResolversByFunctionRequest": { - "type": "structure", - "members": { - "apiId": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The API ID.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "functionId": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The function ID.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "nextToken": { - "target": "com.amazonaws.appsync#PaginationToken", - "traits": { - "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which you can use to return the\n next set of items in the list.
", - "smithy.api#httpQuery": "nextToken" - } - }, - "maxResults": { - "target": "com.amazonaws.appsync#MaxResults", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The maximum number of results that you want the request to return.
", - "smithy.api#httpQuery": "maxResults" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appsync#ListResolversByFunctionResponse": { - "type": "structure", - "members": { - "resolvers": { - "target": "com.amazonaws.appsync#Resolvers", - "traits": { - "smithy.api#documentation": "The list of resolvers.
" - } - }, - "nextToken": { - "target": "com.amazonaws.appsync#PaginationToken", - "traits": { - "smithy.api#documentation": "An identifier that you can use to return the next set of items in the list.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appsync#ListResolversRequest": { - "type": "structure", - "members": { - "apiId": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The API ID.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "typeName": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The type name.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "nextToken": { - "target": "com.amazonaws.appsync#PaginationToken", - "traits": { - "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which you can use to return the\n next set of items in the list.
", - "smithy.api#httpQuery": "nextToken" - } - }, - "maxResults": { - "target": "com.amazonaws.appsync#MaxResults", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The maximum number of results that you want the request to return.
", - "smithy.api#httpQuery": "maxResults" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appsync#ListResolversResponse": { - "type": "structure", - "members": { - "resolvers": { - "target": "com.amazonaws.appsync#Resolvers", - "traits": { - "smithy.api#documentation": "The Resolver objects.
An identifier to pass in the next request to this operation to return the next set of items in the\n list.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appsync#ListSourceApiAssociations": { - "type": "operation", - "input": { - "target": "com.amazonaws.appsync#ListSourceApiAssociationsRequest" - }, - "output": { - "target": "com.amazonaws.appsync#ListSourceApiAssociationsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.appsync#BadRequestException" - }, - { - "target": "com.amazonaws.appsync#InternalFailureException" - }, - { - "target": "com.amazonaws.appsync#NotFoundException" - }, - { - "target": "com.amazonaws.appsync#UnauthorizedException" - } - ], - "traits": { - "smithy.api#documentation": "Lists the SourceApiAssociationSummary data.
The API ID.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "nextToken": { - "target": "com.amazonaws.appsync#PaginationToken", - "traits": { - "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which you can use to return the\n next set of items in the list.
", - "smithy.api#httpQuery": "nextToken" - } - }, - "maxResults": { - "target": "com.amazonaws.appsync#MaxResults", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The maximum number of results that you want the request to return.
", - "smithy.api#httpQuery": "maxResults" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appsync#ListSourceApiAssociationsResponse": { - "type": "structure", - "members": { - "sourceApiAssociationSummaries": { - "target": "com.amazonaws.appsync#SourceApiAssociationSummaryList", - "traits": { - "smithy.api#documentation": "The SourceApiAssociationSummary object data.
An identifier that was returned from the previous call to this operation, which you can use to return the\n next set of items in the list.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appsync#ListTagsForResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.appsync#ListTagsForResourceRequest" - }, - "output": { - "target": "com.amazonaws.appsync#ListTagsForResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.appsync#AccessDeniedException" - }, - { - "target": "com.amazonaws.appsync#BadRequestException" - }, - { - "target": "com.amazonaws.appsync#InternalFailureException" - }, - { - "target": "com.amazonaws.appsync#LimitExceededException" - }, - { - "target": "com.amazonaws.appsync#NotFoundException" - }, - { - "target": "com.amazonaws.appsync#UnauthorizedException" - } - ], - "traits": { - "smithy.api#documentation": "Lists the tags for a resource.
", - "smithy.api#http": { - "method": "GET", - "uri": "/v1/tags/{resourceArn}", - "code": 200 - } - } - }, - "com.amazonaws.appsync#ListTagsForResourceRequest": { - "type": "structure", - "members": { - "resourceArn": { - "target": "com.amazonaws.appsync#ResourceArn", - "traits": { - "smithy.api#documentation": "The GraphqlApi Amazon Resource Name (ARN).
A TagMap object.
Lists the types for a given API.
", - "smithy.api#http": { - "method": "GET", - "uri": "/v1/apis/{apiId}/types", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "types", - "pageSize": "maxResults" - } - } - }, - "com.amazonaws.appsync#ListTypesByAssociation": { - "type": "operation", - "input": { - "target": "com.amazonaws.appsync#ListTypesByAssociationRequest" - }, - "output": { - "target": "com.amazonaws.appsync#ListTypesByAssociationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.appsync#BadRequestException" - }, - { - "target": "com.amazonaws.appsync#ConcurrentModificationException" - }, - { - "target": "com.amazonaws.appsync#InternalFailureException" - }, - { - "target": "com.amazonaws.appsync#NotFoundException" - }, - { - "target": "com.amazonaws.appsync#UnauthorizedException" - } - ], - "traits": { - "smithy.api#documentation": "Lists Type objects by the source API association ID.
The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged\n APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs\n in other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "associationId": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The ID generated by the AppSync service for the source API association.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "format": { - "target": "com.amazonaws.appsync#TypeDefinitionFormat", - "traits": { - "smithy.api#documentation": "The format type.
", - "smithy.api#httpQuery": "format", - "smithy.api#required": {} - } - }, - "nextToken": { - "target": "com.amazonaws.appsync#PaginationToken", - "traits": { - "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which you can use to return the\n next set of items in the list.
", - "smithy.api#httpQuery": "nextToken" - } - }, - "maxResults": { - "target": "com.amazonaws.appsync#MaxResults", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The maximum number of results that you want the request to return.
", - "smithy.api#httpQuery": "maxResults" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appsync#ListTypesByAssociationResponse": { - "type": "structure", - "members": { - "types": { - "target": "com.amazonaws.appsync#TypeList", - "traits": { - "smithy.api#documentation": "The Type objects.
An identifier that was returned from the previous call to this operation, which you can use to return the\n next set of items in the list.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appsync#ListTypesRequest": { - "type": "structure", - "members": { - "apiId": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The API ID.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "format": { - "target": "com.amazonaws.appsync#TypeDefinitionFormat", - "traits": { - "smithy.api#documentation": "The type format: SDL or JSON.
", - "smithy.api#httpQuery": "format", - "smithy.api#required": {} - } - }, - "nextToken": { - "target": "com.amazonaws.appsync#PaginationToken", - "traits": { - "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which you can use to return the\n next set of items in the list.
", - "smithy.api#httpQuery": "nextToken" - } - }, - "maxResults": { - "target": "com.amazonaws.appsync#MaxResults", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The maximum number of results that you want the request to return.
", - "smithy.api#httpQuery": "maxResults" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appsync#ListTypesResponse": { - "type": "structure", - "members": { - "types": { - "target": "com.amazonaws.appsync#TypeList", - "traits": { - "smithy.api#documentation": "The Type objects.
An identifier to pass in the next request to this operation to return the next set of items in the\n list.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appsync#LogConfig": { - "type": "structure", - "members": { - "fieldLogLevel": { - "target": "com.amazonaws.appsync#FieldLogLevel", - "traits": { - "smithy.api#documentation": "The field logging level. Values can be NONE, ERROR, or ALL.
\n\n NONE: No field-level logs are captured.
\n\n ERROR: Logs the following information only for the fields that are\n in error:
\nThe error section in the server response.
\nField-level errors.
\nThe generated request/response functions that got resolved for error fields.
\n\n ALL: The following information is logged for all fields in the\n query:
\nField-level tracing information.
\nThe generated request/response functions that got resolved for each field.
\nThe service role that AppSync assumes to publish to CloudWatch logs in your\n account.
", - "smithy.api#required": {} - } - }, - "excludeVerboseContent": { - "target": "com.amazonaws.appsync#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "Set to TRUE to exclude sections that contain information such as headers, context, and evaluated mapping\n templates, regardless of logging level.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The Amazon CloudWatch Logs configuration.
" - } - }, - "com.amazonaws.appsync#Logs": { - "type": "list", - "member": { - "target": "com.amazonaws.appsync#String" - } - }, - "com.amazonaws.appsync#Long": { - "type": "long", - "traits": { - "smithy.api#default": 0 - } - }, - "com.amazonaws.appsync#MapOfStringToString": { - "type": "map", - "key": { - "target": "com.amazonaws.appsync#String" - }, - "value": { - "target": "com.amazonaws.appsync#String" - } - }, - "com.amazonaws.appsync#MappingTemplate": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 65536 - }, - "smithy.api#pattern": "^.*$" - } - }, - "com.amazonaws.appsync#MaxBatchSize": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 0, - "max": 2000 - } - } - }, - "com.amazonaws.appsync#MaxResults": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 0, - "max": 25 - } - } - }, - "com.amazonaws.appsync#MergeType": { - "type": "enum", - "members": { - "MANUAL_MERGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MANUAL_MERGE" - } - }, - "AUTO_MERGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AUTO_MERGE" - } - } - } - }, - "com.amazonaws.appsync#NotFoundException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.appsync#String" - } - }, - "traits": { - "smithy.api#documentation": "The resource specified in the request was not found. Check the resource, and then try again.
", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.appsync#OpenIDConnectConfig": { - "type": "structure", - "members": { - "issuer": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The issuer for the OIDC configuration. The issuer returned by discovery must exactly match the value of\n iss in the ID token.
The client identifier of the relying party at the OpenID identity provider. This identifier is typically\n obtained when the relying party is registered with the OpenID identity provider. You can specify a regular\n expression so that AppSync can validate against multiple client identifiers at a time.
" - } - }, - "iatTTL": { - "target": "com.amazonaws.appsync#Long", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The number of milliseconds that a token is valid after it's issued to a user.
" - } - }, - "authTTL": { - "target": "com.amazonaws.appsync#Long", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The number of milliseconds that a token is valid after being authenticated.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Describes an OpenID Connect (OIDC) configuration.
" - } - }, - "com.amazonaws.appsync#OpenSearchServiceDataSourceConfig": { - "type": "structure", - "members": { - "endpoint": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The endpoint.
", - "smithy.api#required": {} - } - }, - "awsRegion": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The Amazon Web Services Region.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Describes an OpenSearch data source configuration.
" - } - }, - "com.amazonaws.appsync#OperationLevelMetricsConfig": { - "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.appsync#OutputType": { - "type": "enum", - "members": { - "SDL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SDL" - } - }, - "JSON": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "JSON" - } - } - } - }, - "com.amazonaws.appsync#Ownership": { - "type": "enum", - "members": { - "CURRENT_ACCOUNT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CURRENT_ACCOUNT" - } - }, - "OTHER_ACCOUNTS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "OTHER_ACCOUNTS" - } - } - } - }, - "com.amazonaws.appsync#PaginationToken": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 65536 - }, - "smithy.api#pattern": "^[\\\\S]+$" - } - }, - "com.amazonaws.appsync#PipelineConfig": { - "type": "structure", - "members": { - "functions": { - "target": "com.amazonaws.appsync#FunctionsIds", - "traits": { - "smithy.api#documentation": "A list of Function objects.
The pipeline configuration for a resolver of kind PIPELINE.
Creates a list of environmental variables in an API by its ID value.
\nWhen creating an environmental variable, it must follow the constraints below:
\nBoth JavaScript and VTL templates support environmental variables.
\nEnvironmental variables are not evaluated before function invocation.
\nEnvironmental variables only support string values.
\nAny defined value in an environmental variable is considered a string literal and not\n expanded.
\nVariable evaluations should ideally be performed in the function code.
\nWhen creating an environmental variable key-value pair, it must follow the additional constraints\n below:
\nKeys must begin with a letter.
\nKeys must be at least two characters long.
\nKeys can only contain letters, numbers, and the underscore character (_).
\nValues can be up to 512 characters long.
\nYou can configure up to 50 key-value pairs in a GraphQL API.
\nYou can create a list of environmental variables by adding it to the environmentVariables\n payload as a list in the format {\"key1\":\"value1\",\"key2\":\"value2\", …}. Note that each call of the\n PutGraphqlApiEnvironmentVariables action will result in the overwriting of the existing\n environmental variable list of that API. This means the existing environmental variables will be lost. To avoid\n this, you must include all existing and new environmental variables in the list each time you call this\n action.
The ID of the API to which the environmental variable list will be written.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "environmentVariables": { - "target": "com.amazonaws.appsync#EnvironmentVariableMap", - "traits": { - "smithy.api#documentation": "The list of environmental variables to add to the API.
\nWhen creating an environmental variable key-value pair, it must follow the additional constraints\n below:
\nKeys must begin with a letter.
\nKeys must be at least two characters long.
\nKeys can only contain letters, numbers, and the underscore character (_).
\nValues can be up to 512 characters long.
\nYou can configure up to 50 key-value pairs in a GraphQL API.
\nYou can create a list of environmental variables by adding it to the environmentVariables\n payload as a list in the format {\"key1\":\"value1\",\"key2\":\"value2\", …}. Note that each call of the\n PutGraphqlApiEnvironmentVariables action will result in the overwriting of the existing\n environmental variable list of that API. This means the existing environmental variables will be lost. To avoid\n this, you must include all existing and new environmental variables in the list each time you call this\n action.
The payload containing each environmental variable in the \"key\" : \"value\" format.
The resource ARN of the RDS cluster.
", - "smithy.api#required": {} - } - }, - "secretArn": { - "target": "com.amazonaws.appsync#RdsDataApiConfigSecretArn", - "traits": { - "smithy.api#documentation": "The secret's ARN that was obtained from Secrets Manager. A secret consists of secret information, the secret\n value, plus metadata about the secret. A secret value can be a string or binary. It typically includes the ARN,\n secret name and description, policies, tags, encryption key from the Key Management Service, and key rotation\n data.
", - "smithy.api#required": {} - } - }, - "databaseName": { - "target": "com.amazonaws.appsync#RdsDataApiConfigDatabaseName", - "traits": { - "smithy.api#documentation": "The name of the database in the cluster.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Contains the metadata required to introspect the RDS cluster.
" - } - }, - "com.amazonaws.appsync#RdsDataApiConfigDatabaseName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - } - } - }, - "com.amazonaws.appsync#RdsDataApiConfigResourceArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 20, - "max": 2048 - }, - "smithy.api#pattern": "^arn:[a-z-]*:rds:[a-z0-9-]*:\\d{12}:cluster:[0-9A-Za-z_/-]*$" - } - }, - "com.amazonaws.appsync#RdsDataApiConfigSecretArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 20, - "max": 2048 - }, - "smithy.api#pattern": "^arn:[a-z-]*:secretsmanager:[a-z0-9-]*:\\d{12}:secret:[0-9A-Za-z_/+=.@!-]*$" - } - }, - "com.amazonaws.appsync#RdsHttpEndpointConfig": { - "type": "structure", - "members": { - "awsRegion": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "Amazon Web Services Region for Amazon RDS HTTP endpoint.
" - } - }, - "dbClusterIdentifier": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "Amazon RDS cluster Amazon Resource Name (ARN).
" - } - }, - "databaseName": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "Logical database name.
" - } - }, - "schema": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "Logical schema name.
" - } - }, - "awsSecretStoreArn": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "Amazon Web Services secret store Amazon Resource Name (ARN) for database credentials.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The Amazon Relational Database Service (Amazon RDS) HTTP endpoint configuration.
" - } - }, - "com.amazonaws.appsync#RelationalDatabaseDataSourceConfig": { - "type": "structure", - "members": { - "relationalDatabaseSourceType": { - "target": "com.amazonaws.appsync#RelationalDatabaseSourceType", - "traits": { - "smithy.api#documentation": "Source type for the relational database.
\n\n RDS_HTTP_ENDPOINT: The relational database source type is an\n Amazon Relational Database Service (Amazon RDS) HTTP endpoint.
\nAmazon RDS HTTP endpoint settings.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Describes a relational database data source configuration.
" - } - }, - "com.amazonaws.appsync#RelationalDatabaseSourceType": { - "type": "enum", - "members": { - "RDS_HTTP_ENDPOINT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RDS_HTTP_ENDPOINT" - } - } - } - }, - "com.amazonaws.appsync#Resolver": { - "type": "structure", - "members": { - "typeName": { - "target": "com.amazonaws.appsync#ResourceName", - "traits": { - "smithy.api#documentation": "The resolver type name.
" - } - }, - "fieldName": { - "target": "com.amazonaws.appsync#ResourceName", - "traits": { - "smithy.api#documentation": "The resolver field name.
" - } - }, - "dataSourceName": { - "target": "com.amazonaws.appsync#ResourceName", - "traits": { - "smithy.api#documentation": "The resolver data source name.
" - } - }, - "resolverArn": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The resolver Amazon Resource Name (ARN).
" - } - }, - "requestMappingTemplate": { - "target": "com.amazonaws.appsync#MappingTemplate", - "traits": { - "smithy.api#documentation": "The request mapping template.
" - } - }, - "responseMappingTemplate": { - "target": "com.amazonaws.appsync#MappingTemplate", - "traits": { - "smithy.api#documentation": "The response mapping template.
" - } - }, - "kind": { - "target": "com.amazonaws.appsync#ResolverKind", - "traits": { - "smithy.api#documentation": "The resolver type.
\n\n UNIT: A UNIT resolver type. A UNIT resolver is the default\n resolver type. You can use a UNIT resolver to run a GraphQL query against a single data source.
\n\n PIPELINE: A PIPELINE resolver type. You can use a PIPELINE\n resolver to invoke a series of Function objects in a serial manner. You can use a pipeline\n resolver to run a GraphQL query against multiple data sources.
The PipelineConfig.
The SyncConfig for a resolver attached to a versioned data source.
The caching configuration for the resolver.
" - } - }, - "maxBatchSize": { - "target": "com.amazonaws.appsync#MaxBatchSize", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The maximum batching size for a resolver.
" - } - }, - "runtime": { - "target": "com.amazonaws.appsync#AppSyncRuntime" - }, - "code": { - "target": "com.amazonaws.appsync#Code", - "traits": { - "smithy.api#documentation": "The resolver code that contains the request and response functions. When code is used, the\n runtime is required. The runtime value must be APPSYNC_JS.
Enables or disables enhanced resolver metrics for specified resolvers. Note that metricsConfig\n won't be used unless the resolverLevelMetricsBehavior value is set to\n PER_RESOLVER_METRICS. If the resolverLevelMetricsBehavior is set to\n FULL_REQUEST_RESOLVER_METRICS instead, metricsConfig will be ignored. However, you\n can still set its value.
\n metricsConfig can be ENABLED or DISABLED.
Describes a resolver.
" - } - }, - "com.amazonaws.appsync#ResolverCountLimit": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 0, - "max": 10000 - } - } - }, - "com.amazonaws.appsync#ResolverKind": { - "type": "enum", - "members": { - "UNIT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UNIT" - } - }, - "PIPELINE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PIPELINE" - } - } - } - }, - "com.amazonaws.appsync#ResolverLevelMetricsBehavior": { - "type": "enum", - "members": { - "FULL_REQUEST_RESOLVER_METRICS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FULL_REQUEST_RESOLVER_METRICS" - } - }, - "PER_RESOLVER_METRICS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PER_RESOLVER_METRICS" - } - } - } - }, - "com.amazonaws.appsync#ResolverLevelMetricsConfig": { - "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.appsync#Resolvers": { - "type": "list", - "member": { - "target": "com.amazonaws.appsync#Resolver" - } - }, - "com.amazonaws.appsync#ResourceArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 70, - "max": 75 - }, - "smithy.api#pattern": "^arn:aws:appsync:[A-Za-z0-9_/.-]{0,63}:\\d{12}:apis/[0-9A-Za-z_-]{26}$" - } - }, - "com.amazonaws.appsync#ResourceName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 65536 - }, - "smithy.api#pattern": "^[_A-Za-z][_0-9A-Za-z]*$" - } - }, - "com.amazonaws.appsync#RuntimeName": { - "type": "enum", - "members": { - "APPSYNC_JS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "APPSYNC_JS" - } - } - } - }, - "com.amazonaws.appsync#SchemaStatus": { - "type": "enum", - "members": { - "Processing": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PROCESSING" - } - }, - "Active": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACTIVE" - } - }, - "Deleting": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETING" - } - }, - "Failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - }, - "Success": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SUCCESS" - } - }, - "NotApplicable": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NOT_APPLICABLE" - } - } - } - }, - "com.amazonaws.appsync#SourceApiAssociation": { - "type": "structure", - "members": { - "associationId": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The ID generated by the AppSync service for the source API association.
" - } - }, - "associationArn": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the source API association.
" - } - }, - "sourceApiId": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The ID of the AppSync source API.
" - } - }, - "sourceApiArn": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AppSync source API.
" - } - }, - "mergedApiArn": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AppSync Merged API.
" - } - }, - "mergedApiId": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The ID of the AppSync Merged API.
" - } - }, - "description": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The description field.
" - } - }, - "sourceApiAssociationConfig": { - "target": "com.amazonaws.appsync#SourceApiAssociationConfig", - "traits": { - "smithy.api#documentation": "The SourceApiAssociationConfig object data.
The state of the source API association.
" - } - }, - "sourceApiAssociationStatusDetail": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The detailed message related to the current state of the source API association.
" - } - }, - "lastSuccessfulMergeDate": { - "target": "com.amazonaws.appsync#Date", - "traits": { - "smithy.api#documentation": "The datetime value of the last successful merge of the source API association. The result will be in UTC\n format and your local time zone.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Describes the configuration of a source API. A source API is a GraphQL API that is linked to a merged API.\n There can be multiple source APIs attached to each merged API. When linked to a merged API, the source API's\n schema, data sources, and resolvers will be combined with other linked source API data to form a new, singular\n API.
\nSource APIs can originate from your account or from other accounts via Amazon Web Services Resource Access\n Manager. For more information about sharing resources from other accounts, see What is Amazon Web Services Resource\n Access Manager? in the Amazon Web Services Resource Access Manager guide.
" - } - }, - "com.amazonaws.appsync#SourceApiAssociationConfig": { - "type": "structure", - "members": { - "mergeType": { - "target": "com.amazonaws.appsync#MergeType", - "traits": { - "smithy.api#documentation": "The property that indicates which merging option is enabled in the source API association.
\nValid merge types are MANUAL_MERGE (default) and AUTO_MERGE. Manual merges are the\n default behavior and require the user to trigger any changes from the source APIs to the merged API manually.\n Auto merges subscribe the merged API to the changes performed on the source APIs so that any change in the\n source APIs are also made to the merged API. Auto merges use MergedApiExecutionRoleArn to perform\n merge operations.
Describes properties used to specify configurations related to a source API.
" - } - }, - "com.amazonaws.appsync#SourceApiAssociationStatus": { - "type": "enum", - "members": { - "MERGE_SCHEDULED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MERGE_SCHEDULED" - } - }, - "MERGE_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MERGE_FAILED" - } - }, - "MERGE_SUCCESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MERGE_SUCCESS" - } - }, - "MERGE_IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MERGE_IN_PROGRESS" - } - }, - "AUTO_MERGE_SCHEDULE_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AUTO_MERGE_SCHEDULE_FAILED" - } - }, - "DELETION_SCHEDULED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETION_SCHEDULED" - } - }, - "DELETION_IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETION_IN_PROGRESS" - } - }, - "DELETION_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETION_FAILED" - } - } - } - }, - "com.amazonaws.appsync#SourceApiAssociationSummary": { - "type": "structure", - "members": { - "associationId": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The ID generated by the AppSync service for the source API association.
" - } - }, - "associationArn": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the source API association.
" - } - }, - "sourceApiId": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The ID of the AppSync source API.
" - } - }, - "sourceApiArn": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AppSync Source API.
" - } - }, - "mergedApiId": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The ID of the AppSync Merged API.
" - } - }, - "mergedApiArn": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AppSync Merged API.
" - } - }, - "description": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The description field.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Describes the ARNs and IDs of associations, Merged APIs, and source APIs.
" - } - }, - "com.amazonaws.appsync#SourceApiAssociationSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.appsync#SourceApiAssociationSummary" - } - }, - "com.amazonaws.appsync#StartDataSourceIntrospection": { - "type": "operation", - "input": { - "target": "com.amazonaws.appsync#StartDataSourceIntrospectionRequest" - }, - "output": { - "target": "com.amazonaws.appsync#StartDataSourceIntrospectionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.appsync#BadRequestException" - }, - { - "target": "com.amazonaws.appsync#InternalFailureException" - }, - { - "target": "com.amazonaws.appsync#NotFoundException" - }, - { - "target": "com.amazonaws.appsync#UnauthorizedException" - } - ], - "traits": { - "smithy.api#documentation": "Creates a new introspection. Returns the introspectionId of the new introspection after its\n creation.
The rdsDataApiConfig object data.
The introspection ID. Each introspection contains a unique ID that can be used to reference the\n instrospection record.
" - } - }, - "introspectionStatus": { - "target": "com.amazonaws.appsync#DataSourceIntrospectionStatus", - "traits": { - "smithy.api#documentation": "The status of the introspection during creation. By default, when a new instrospection has been created, the\n status will be set to PROCESSING. Once the operation has been completed, the status will change to\n SUCCESS or FAILED depending on how the data was parsed. A FAILED\n operation will return an error and its details as an introspectionStatusDetail.
The error detail field. When a FAILED\n introspectionStatus is returned, the introspectionStatusDetail will also return the\n exact error that was generated during the operation.
Adds a new schema to your GraphQL API.
\nThis operation is asynchronous. Use to determine when it has\n completed.
", - "smithy.api#http": { - "method": "POST", - "uri": "/v1/apis/{apiId}/schemacreation", - "code": 200 - } - } - }, - "com.amazonaws.appsync#StartSchemaCreationRequest": { - "type": "structure", - "members": { - "apiId": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The API ID.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "definition": { - "target": "com.amazonaws.appsync#Blob", - "traits": { - "smithy.api#documentation": "The schema definition, in GraphQL schema language format.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appsync#StartSchemaCreationResponse": { - "type": "structure", - "members": { - "status": { - "target": "com.amazonaws.appsync#SchemaStatus", - "traits": { - "smithy.api#documentation": "The current state of the schema (PROCESSING, FAILED, SUCCESS, or NOT_APPLICABLE). When the schema is in the\n ACTIVE state, you can add data.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appsync#StartSchemaMerge": { - "type": "operation", - "input": { - "target": "com.amazonaws.appsync#StartSchemaMergeRequest" - }, - "output": { - "target": "com.amazonaws.appsync#StartSchemaMergeResponse" - }, - "errors": [ - { - "target": "com.amazonaws.appsync#BadRequestException" - }, - { - "target": "com.amazonaws.appsync#ConcurrentModificationException" - }, - { - "target": "com.amazonaws.appsync#InternalFailureException" - }, - { - "target": "com.amazonaws.appsync#NotFoundException" - }, - { - "target": "com.amazonaws.appsync#UnauthorizedException" - } - ], - "traits": { - "smithy.api#documentation": "Initiates a merge operation. Returns a status that shows the result of the merge operation.
", - "smithy.api#http": { - "method": "POST", - "uri": "/v1/mergedApis/{mergedApiIdentifier}/sourceApiAssociations/{associationId}/merge", - "code": 200 - } - } - }, - "com.amazonaws.appsync#StartSchemaMergeRequest": { - "type": "structure", - "members": { - "associationId": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The ID generated by the AppSync service for the source API association.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "mergedApiIdentifier": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged\n APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs\n in other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appsync#StartSchemaMergeResponse": { - "type": "structure", - "members": { - "sourceApiAssociationStatus": { - "target": "com.amazonaws.appsync#SourceApiAssociationStatus", - "traits": { - "smithy.api#documentation": "The state of the source API association.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appsync#String": { - "type": "string" - }, - "com.amazonaws.appsync#SyncConfig": { - "type": "structure", - "members": { - "conflictHandler": { - "target": "com.amazonaws.appsync#ConflictHandlerType", - "traits": { - "smithy.api#documentation": "The Conflict Resolution strategy to perform in the event of a conflict.
\n\n OPTIMISTIC_CONCURRENCY: Resolve conflicts by rejecting mutations\n when versions don't match the latest version at the server.
\n\n AUTOMERGE: Resolve conflicts with the Automerge conflict\n resolution strategy.
\n\n LAMBDA: Resolve conflicts with an Lambda function\n supplied in the LambdaConflictHandlerConfig.
The Conflict Detection strategy to use.
\n\n VERSION: Detect conflicts based on object versions for this\n resolver.
\n\n NONE: Do not detect conflicts when invoking this\n resolver.
\nThe LambdaConflictHandlerConfig when configuring LAMBDA as the Conflict\n Handler.
Describes a Sync configuration for a resolver.
\nSpecifies which Conflict Detection strategy and Resolution strategy to use when the resolver is\n invoked.
" - } - }, - "com.amazonaws.appsync#TTL": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 0, - "max": 3600 - } - } - }, - "com.amazonaws.appsync#TagKey": { - "type": "string", - "traits": { - "smithy.api#documentation": "The key for the tag.
", - "smithy.api#length": { - "min": 1, - "max": 128 - }, - "smithy.api#pattern": "^(?!aws:)[ a-zA-Z+-=._:/]+$" - } - }, - "com.amazonaws.appsync#TagKeyList": { - "type": "list", - "member": { - "target": "com.amazonaws.appsync#TagKey" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.appsync#TagMap": { - "type": "map", - "key": { - "target": "com.amazonaws.appsync#TagKey" - }, - "value": { - "target": "com.amazonaws.appsync#TagValue" - }, - "traits": { - "smithy.api#documentation": "A map with keys of TagKey objects and values of TagValue objects.
Tags a resource with user-supplied tags.
", - "smithy.api#http": { - "method": "POST", - "uri": "/v1/tags/{resourceArn}", - "code": 200 - } - } - }, - "com.amazonaws.appsync#TagResourceRequest": { - "type": "structure", - "members": { - "resourceArn": { - "target": "com.amazonaws.appsync#ResourceArn", - "traits": { - "smithy.api#documentation": "The GraphqlApi Amazon Resource Name (ARN).
A TagMap object.
The value for the tag.
", - "smithy.api#length": { - "min": 0, - "max": 256 - }, - "smithy.api#pattern": "^[\\s\\w+-=\\.:/@]*$" - } - }, - "com.amazonaws.appsync#Template": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 2, - "max": 65536 - }, - "smithy.api#pattern": "^[\\s\\S]*$" - } - }, - "com.amazonaws.appsync#Type": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.appsync#ResourceName", - "traits": { - "smithy.api#documentation": "The type name.
" - } - }, - "description": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The type description.
" - } - }, - "arn": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The type Amazon Resource Name (ARN).
" - } - }, - "definition": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The type definition.
" - } - }, - "format": { - "target": "com.amazonaws.appsync#TypeDefinitionFormat", - "traits": { - "smithy.api#documentation": "The type format: SDL or JSON.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Describes a type.
" - } - }, - "com.amazonaws.appsync#TypeDefinitionFormat": { - "type": "enum", - "members": { - "SDL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SDL" - } - }, - "JSON": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "JSON" - } - } - } - }, - "com.amazonaws.appsync#TypeList": { - "type": "list", - "member": { - "target": "com.amazonaws.appsync#Type" - } - }, - "com.amazonaws.appsync#UnauthorizedException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.appsync#String" - } - }, - "traits": { - "smithy.api#documentation": "You aren't authorized to perform this operation.
", - "smithy.api#error": "client", - "smithy.api#httpError": 401 - } - }, - "com.amazonaws.appsync#UntagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.appsync#UntagResourceRequest" - }, - "output": { - "target": "com.amazonaws.appsync#UntagResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.appsync#AccessDeniedException" - }, - { - "target": "com.amazonaws.appsync#BadRequestException" - }, - { - "target": "com.amazonaws.appsync#InternalFailureException" - }, - { - "target": "com.amazonaws.appsync#LimitExceededException" - }, - { - "target": "com.amazonaws.appsync#NotFoundException" - }, - { - "target": "com.amazonaws.appsync#UnauthorizedException" - } - ], - "traits": { - "smithy.api#documentation": "Untags a resource.
", - "smithy.api#http": { - "method": "DELETE", - "uri": "/v1/tags/{resourceArn}", - "code": 200 - } - } - }, - "com.amazonaws.appsync#UntagResourceRequest": { - "type": "structure", - "members": { - "resourceArn": { - "target": "com.amazonaws.appsync#ResourceArn", - "traits": { - "smithy.api#documentation": "The GraphqlApi Amazon Resource Name (ARN).
A list of TagKey objects.
Updates the cache for the GraphQL API.
", - "smithy.api#http": { - "method": "POST", - "uri": "/v1/apis/{apiId}/ApiCaches/update", - "code": 200 - } - } - }, - "com.amazonaws.appsync#UpdateApiCacheRequest": { - "type": "structure", - "members": { - "apiId": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The GraphQL API ID.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ttl": { - "target": "com.amazonaws.appsync#Long", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "TTL in seconds for cache entries.
\nValid values are 1–3,600 seconds.
", - "smithy.api#required": {} - } - }, - "apiCachingBehavior": { - "target": "com.amazonaws.appsync#ApiCachingBehavior", - "traits": { - "smithy.api#documentation": "Caching behavior.
\n\n FULL_REQUEST_CACHING: All requests are fully cached.
\n\n PER_RESOLVER_CACHING: Individual resolvers that you specify are\n cached.
\nThe cache instance type. Valid values are
\n\n SMALL\n
\n MEDIUM\n
\n LARGE\n
\n XLARGE\n
\n LARGE_2X\n
\n LARGE_4X\n
\n LARGE_8X (not available in all regions)
\n LARGE_12X\n
Historically, instance types were identified by an EC2-style value. As of July 2020, this is deprecated, and the generic identifiers above should be used.
\nThe following legacy instance types are available, but their use is discouraged:
\n\n T2_SMALL: A t2.small instance type.
\n\n T2_MEDIUM: A t2.medium instance type.
\n\n R4_LARGE: A r4.large instance type.
\n\n R4_XLARGE: A r4.xlarge instance type.
\n\n R4_2XLARGE: A r4.2xlarge instance type.
\n\n R4_4XLARGE: A r4.4xlarge instance type.
\n\n R4_8XLARGE: A r4.8xlarge instance type.
\nControls how cache health metrics will be emitted to CloudWatch. Cache health metrics include:
\nNetworkBandwidthOutAllowanceExceeded: The network packets dropped because the throughput exceeded\n the aggregated bandwidth limit. This is useful for diagnosing bottlenecks in a cache\n configuration.
\nEngineCPUUtilization: The CPU utilization (percentage) allocated to the Redis process. This is\n useful for diagnosing bottlenecks in a cache configuration.
\nMetrics will be recorded by API ID. You can set the value to ENABLED or\n DISABLED.
Represents the input of a UpdateApiCache operation.
The ApiCache object.
Represents the output of a UpdateApiCache operation.
Updates an API key. You can update the key as long as it's not deleted.
", - "smithy.api#http": { - "method": "POST", - "uri": "/v1/apis/{apiId}/apikeys/{id}", - "code": 200 - } - } - }, - "com.amazonaws.appsync#UpdateApiKeyRequest": { - "type": "structure", - "members": { - "apiId": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The ID for the GraphQL API.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "id": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The API key ID.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "A description of the purpose of the API key.
" - } - }, - "expires": { - "target": "com.amazonaws.appsync#Long", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "From the update time, the time after which the API key expires. The date is represented as seconds since the\n epoch. For more information, see .
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appsync#UpdateApiKeyResponse": { - "type": "structure", - "members": { - "apiKey": { - "target": "com.amazonaws.appsync#ApiKey", - "traits": { - "smithy.api#documentation": "The API key.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appsync#UpdateDataSource": { - "type": "operation", - "input": { - "target": "com.amazonaws.appsync#UpdateDataSourceRequest" - }, - "output": { - "target": "com.amazonaws.appsync#UpdateDataSourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.appsync#BadRequestException" - }, - { - "target": "com.amazonaws.appsync#ConcurrentModificationException" - }, - { - "target": "com.amazonaws.appsync#InternalFailureException" - }, - { - "target": "com.amazonaws.appsync#NotFoundException" - }, - { - "target": "com.amazonaws.appsync#UnauthorizedException" - } - ], - "traits": { - "smithy.api#documentation": "Updates a DataSource object.
The API ID.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "name": { - "target": "com.amazonaws.appsync#ResourceName", - "traits": { - "smithy.api#documentation": "The new name for the data source.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The new description for the data source.
" - } - }, - "type": { - "target": "com.amazonaws.appsync#DataSourceType", - "traits": { - "smithy.api#documentation": "The new data source type.
", - "smithy.api#required": {} - } - }, - "serviceRoleArn": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The new service role Amazon Resource Name (ARN) for the data source.
" - } - }, - "dynamodbConfig": { - "target": "com.amazonaws.appsync#DynamodbDataSourceConfig", - "traits": { - "smithy.api#documentation": "The new Amazon DynamoDB configuration.
" - } - }, - "lambdaConfig": { - "target": "com.amazonaws.appsync#LambdaDataSourceConfig", - "traits": { - "smithy.api#documentation": "The new Lambda configuration.
" - } - }, - "elasticsearchConfig": { - "target": "com.amazonaws.appsync#ElasticsearchDataSourceConfig", - "traits": { - "smithy.api#documentation": "The new OpenSearch configuration.
\nAs of September 2021, Amazon Elasticsearch service is Amazon OpenSearch Service. This configuration is\n deprecated. Instead, use UpdateDataSourceRequest$openSearchServiceConfig to update an OpenSearch data source.
" - } - }, - "openSearchServiceConfig": { - "target": "com.amazonaws.appsync#OpenSearchServiceDataSourceConfig", - "traits": { - "smithy.api#documentation": "The new OpenSearch configuration.
" - } - }, - "httpConfig": { - "target": "com.amazonaws.appsync#HttpDataSourceConfig", - "traits": { - "smithy.api#documentation": "The new HTTP endpoint configuration.
" - } - }, - "relationalDatabaseConfig": { - "target": "com.amazonaws.appsync#RelationalDatabaseDataSourceConfig", - "traits": { - "smithy.api#documentation": "The new relational database configuration.
" - } - }, - "eventBridgeConfig": { - "target": "com.amazonaws.appsync#EventBridgeDataSourceConfig", - "traits": { - "smithy.api#documentation": "The new Amazon EventBridge settings.
" - } - }, - "metricsConfig": { - "target": "com.amazonaws.appsync#DataSourceLevelMetricsConfig", - "traits": { - "smithy.api#documentation": "Enables or disables enhanced data source metrics for specified data sources. Note that\n metricsConfig won't be used unless the dataSourceLevelMetricsBehavior value is set\n to PER_DATA_SOURCE_METRICS. If the dataSourceLevelMetricsBehavior is set to\n FULL_REQUEST_DATA_SOURCE_METRICS instead, metricsConfig will be ignored. However,\n you can still set its value.
\n metricsConfig can be ENABLED or DISABLED.
The updated DataSource object.
Updates a custom DomainName object.
The domain name.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.appsync#Description", - "traits": { - "smithy.api#documentation": "A description of the DomainName.
The configuration for the DomainName.
Updates a Function object.
The GraphQL API ID.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "name": { - "target": "com.amazonaws.appsync#ResourceName", - "traits": { - "smithy.api#documentation": "The Function name.
The Function description.
The function ID.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "dataSourceName": { - "target": "com.amazonaws.appsync#ResourceName", - "traits": { - "smithy.api#documentation": "The Function\n DataSource name.
The Function request mapping template. Functions support only the 2018-05-29 version of the\n request mapping template.
The Function request mapping template.
The version of the request mapping template. Currently, the supported value is 2018-05-29. Note\n that when using VTL and mapping templates, the functionVersion is required.
The maximum batching size for a resolver.
" - } - }, - "runtime": { - "target": "com.amazonaws.appsync#AppSyncRuntime" - }, - "code": { - "target": "com.amazonaws.appsync#Code", - "traits": { - "smithy.api#documentation": "The function code that contains the request and response functions. When code is used, the\n runtime is required. The runtime value must be APPSYNC_JS.
The Function object.
Updates a GraphqlApi object.
The API ID.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "name": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The new name for the GraphqlApi object.
The Amazon CloudWatch Logs configuration for the GraphqlApi object.
The new authentication type for the GraphqlApi object.
The new Amazon Cognito user pool configuration for the ~GraphqlApi object.
The OpenID Connect configuration for the GraphqlApi object.
A list of additional authentication providers for the GraphqlApi API.
A flag indicating whether to use X-Ray tracing for the GraphqlApi.
Configuration for Lambda function authorization.
" - } - }, - "mergedApiExecutionRoleArn": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The Identity and Access Management service role ARN for a merged API. The AppSync service assumes this role\n on behalf of the Merged API to validate access to source APIs at runtime and to prompt the\n AUTO_MERGE to update the merged API endpoint with the source API changes automatically.
The owner contact information for an API resource.
\nThis field accepts any string input with a length of 0 - 256 characters.
" - } - }, - "introspectionConfig": { - "target": "com.amazonaws.appsync#GraphQLApiIntrospectionConfig", - "traits": { - "smithy.api#documentation": "Sets the value of the GraphQL API to enable (ENABLED) or disable (DISABLED)\n introspection. If no value is provided, the introspection configuration will be set to ENABLED by\n default. This field will produce an error if the operation attempts to use the introspection feature while this\n field is disabled.
For more information about introspection, see GraphQL\n introspection.
" - } - }, - "queryDepthLimit": { - "target": "com.amazonaws.appsync#QueryDepthLimit", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The maximum depth a query can have in a single request. Depth refers to the amount of nested levels allowed\n in the body of query. The default value is 0 (or unspecified), which indicates there's no depth\n limit. If you set a limit, it can be between 1 and 75 nested levels. This field will\n produce a limit error if the operation falls out of bounds.
Note that fields can still be set to nullable or non-nullable. If a non-nullable field produces an error,\n the error will be thrown upwards to the first nullable field available.
" - } - }, - "resolverCountLimit": { - "target": "com.amazonaws.appsync#ResolverCountLimit", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The maximum number of resolvers that can be invoked in a single request. The default value is 0\n (or unspecified), which will set the limit to 10000. When specified, the limit value can be\n between 1 and 10000. This field will produce a limit error if the operation falls out\n of bounds.
The enhancedMetricsConfig object.
The updated GraphqlApi object.
Updates a Resolver object.
The API ID.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "typeName": { - "target": "com.amazonaws.appsync#ResourceName", - "traits": { - "smithy.api#documentation": "The new type name.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "fieldName": { - "target": "com.amazonaws.appsync#ResourceName", - "traits": { - "smithy.api#documentation": "The new field name.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "dataSourceName": { - "target": "com.amazonaws.appsync#ResourceName", - "traits": { - "smithy.api#documentation": "The new data source name.
" - } - }, - "requestMappingTemplate": { - "target": "com.amazonaws.appsync#MappingTemplate", - "traits": { - "smithy.api#documentation": "The new request mapping template.
\nA resolver uses a request mapping template to convert a GraphQL expression into a format that a data source\n can understand. Mapping templates are written in Apache Velocity Template Language (VTL).
\nVTL request mapping templates are optional when using an Lambda data source. For all other\n data sources, VTL request and response mapping templates are required.
" - } - }, - "responseMappingTemplate": { - "target": "com.amazonaws.appsync#MappingTemplate", - "traits": { - "smithy.api#documentation": "The new response mapping template.
" - } - }, - "kind": { - "target": "com.amazonaws.appsync#ResolverKind", - "traits": { - "smithy.api#documentation": "The resolver type.
\n\n UNIT: A UNIT resolver type. A UNIT resolver is the default\n resolver type. You can use a UNIT resolver to run a GraphQL query against a single data source.
\n\n PIPELINE: A PIPELINE resolver type. You can use a PIPELINE\n resolver to invoke a series of Function objects in a serial manner. You can use a pipeline\n resolver to run a GraphQL query against multiple data sources.
The PipelineConfig.
The SyncConfig for a resolver attached to a versioned data source.
The caching configuration for the resolver.
" - } - }, - "maxBatchSize": { - "target": "com.amazonaws.appsync#MaxBatchSize", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The maximum batching size for a resolver.
" - } - }, - "runtime": { - "target": "com.amazonaws.appsync#AppSyncRuntime" - }, - "code": { - "target": "com.amazonaws.appsync#Code", - "traits": { - "smithy.api#documentation": "The resolver code that contains the request and response functions. When code is used, the\n runtime is required. The runtime value must be APPSYNC_JS.
Enables or disables enhanced resolver metrics for specified resolvers. Note that metricsConfig\n won't be used unless the resolverLevelMetricsBehavior value is set to\n PER_RESOLVER_METRICS. If the resolverLevelMetricsBehavior is set to\n FULL_REQUEST_RESOLVER_METRICS instead, metricsConfig will be ignored. However, you\n can still set its value.
\n metricsConfig can be ENABLED or DISABLED.
The updated Resolver object.
Updates some of the configuration choices of a particular source API association.
", - "smithy.api#http": { - "method": "POST", - "uri": "/v1/mergedApis/{mergedApiIdentifier}/sourceApiAssociations/{associationId}", - "code": 200 - } - } - }, - "com.amazonaws.appsync#UpdateSourceApiAssociationRequest": { - "type": "structure", - "members": { - "associationId": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The ID generated by the AppSync service for the source API association.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "mergedApiIdentifier": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged\n APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs\n in other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The description field.
" - } - }, - "sourceApiAssociationConfig": { - "target": "com.amazonaws.appsync#SourceApiAssociationConfig", - "traits": { - "smithy.api#documentation": "The SourceApiAssociationConfig object data.
The SourceApiAssociation object data.
Updates a Type object.
The API ID.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "typeName": { - "target": "com.amazonaws.appsync#ResourceName", - "traits": { - "smithy.api#documentation": "The new type name.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "definition": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The new definition.
" - } - }, - "format": { - "target": "com.amazonaws.appsync#TypeDefinitionFormat", - "traits": { - "smithy.api#documentation": "The new type format: SDL or JSON.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appsync#UpdateTypeResponse": { - "type": "structure", - "members": { - "type": { - "target": "com.amazonaws.appsync#Type", - "traits": { - "smithy.api#documentation": "The updated Type object.
The user pool ID.
", - "smithy.api#required": {} - } - }, - "awsRegion": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "The Amazon Web Services Region in which the user pool was created.
", - "smithy.api#required": {} - } - }, - "defaultAction": { - "target": "com.amazonaws.appsync#DefaultAction", - "traits": { - "smithy.api#documentation": "The action that you want your GraphQL API to take when a request that uses Amazon Cognito user pool\n authentication doesn't match the Amazon Cognito user pool configuration.
", - "smithy.api#required": {} - } - }, - "appIdClientRegex": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "A regular expression for validating the incoming Amazon Cognito user pool app client ID. If this value\n isn't set, no filtering is applied.
" - } + "com.amazonaws.appsync#CertificateArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:[a-z-]*:(acm|iam):[a-z0-9-]*:\\d{12}:(certificate|server-certificate)/[0-9A-Za-z_/-]*$" + } + }, + "com.amazonaws.appsync#Code": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 32768 + } + } + }, + "com.amazonaws.appsync#CodeError": { + "type": "structure", + "members": { + "errorType": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The type of code error.
\nExamples include, but aren't limited to: LINT_ERROR, PARSER_ERROR.
A user presentable error.
\nExamples include, but aren't limited to: Parsing error: Unterminated string literal.
The line, column, and span location of the error in the code.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes an AppSync error.
" + } + }, + "com.amazonaws.appsync#CodeErrorColumn": { + "type": "integer", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.appsync#CodeErrorLine": { + "type": "integer", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.appsync#CodeErrorLocation": { + "type": "structure", + "members": { + "line": { + "target": "com.amazonaws.appsync#CodeErrorLine", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The line number in the code. Defaults to 0 if unknown.
The column number in the code. Defaults to 0 if unknown.
The span/length of the error. Defaults to -1 if unknown.
Describes the location of the error in a code sample.
" + } + }, + "com.amazonaws.appsync#CodeErrorSpan": { + "type": "integer", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.appsync#CodeErrors": { + "type": "list", + "member": { + "target": "com.amazonaws.appsync#CodeError" + } + }, + "com.amazonaws.appsync#CognitoUserPoolConfig": { + "type": "structure", + "members": { + "userPoolId": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The user pool ID.
", + "smithy.api#required": {} + } + }, + "awsRegion": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The Amazon Web Services Region in which the user pool was created.
", + "smithy.api#required": {} + } + }, + "appIdClientRegex": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "A regular expression for validating the incoming Amazon Cognito user pool app client ID. If this value\n isn't set, no filtering is applied.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes an Amazon Cognito user pool configuration.
" + } + }, + "com.amazonaws.appsync#ConcurrentModificationException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.appsync#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "Another modification is in progress at this time and it must complete before you can make your\n change.
", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.appsync#ConflictDetectionType": { + "type": "enum", + "members": { + "VERSION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VERSION" + } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + } + } + }, + "com.amazonaws.appsync#ConflictHandlerType": { + "type": "enum", + "members": { + "OPTIMISTIC_CONCURRENCY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OPTIMISTIC_CONCURRENCY" + } + }, + "LAMBDA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LAMBDA" + } + }, + "AUTOMERGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTOMERGE" + } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + } + } + }, + "com.amazonaws.appsync#Context": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 28000 + }, + "smithy.api#pattern": "^[\\s\\S]*$" + } + }, + "com.amazonaws.appsync#CreateApiCache": { + "type": "operation", + "input": { + "target": "com.amazonaws.appsync#CreateApiCacheRequest" + }, + "output": { + "target": "com.amazonaws.appsync#CreateApiCacheResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appsync#BadRequestException" + }, + { + "target": "com.amazonaws.appsync#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.appsync#InternalFailureException" + }, + { + "target": "com.amazonaws.appsync#NotFoundException" + }, + { + "target": "com.amazonaws.appsync#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a cache for the GraphQL API.
", + "smithy.api#http": { + "method": "POST", + "uri": "/v1/apis/{apiId}/ApiCaches", + "code": 200 + } + } + }, + "com.amazonaws.appsync#CreateApiCacheRequest": { + "type": "structure", + "members": { + "apiId": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The GraphQL API ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ttl": { + "target": "com.amazonaws.appsync#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "TTL in seconds for cache entries.
\nValid values are 1–3,600 seconds.
", + "smithy.api#required": {} + } + }, + "transitEncryptionEnabled": { + "target": "com.amazonaws.appsync#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Transit encryption flag when connecting to cache. You cannot update this setting after creation.
" + } + }, + "atRestEncryptionEnabled": { + "target": "com.amazonaws.appsync#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "At-rest encryption flag for cache. You cannot update this setting after creation.
" + } + }, + "apiCachingBehavior": { + "target": "com.amazonaws.appsync#ApiCachingBehavior", + "traits": { + "smithy.api#documentation": "Caching behavior.
\n\n FULL_REQUEST_CACHING: All requests are fully cached.
\n\n PER_RESOLVER_CACHING: Individual resolvers that you specify are\n cached.
\nThe cache instance type. Valid values are
\n\n SMALL\n
\n MEDIUM\n
\n LARGE\n
\n XLARGE\n
\n LARGE_2X\n
\n LARGE_4X\n
\n LARGE_8X (not available in all regions)
\n LARGE_12X\n
Historically, instance types were identified by an EC2-style value. As of July 2020, this is deprecated, and the generic identifiers above should be used.
\nThe following legacy instance types are available, but their use is discouraged:
\n\n T2_SMALL: A t2.small instance type.
\n\n T2_MEDIUM: A t2.medium instance type.
\n\n R4_LARGE: A r4.large instance type.
\n\n R4_XLARGE: A r4.xlarge instance type.
\n\n R4_2XLARGE: A r4.2xlarge instance type.
\n\n R4_4XLARGE: A r4.4xlarge instance type.
\n\n R4_8XLARGE: A r4.8xlarge instance type.
\nControls how cache health metrics will be emitted to CloudWatch. Cache health metrics include:
\nNetworkBandwidthOutAllowanceExceeded: The network packets dropped because the throughput exceeded\n the aggregated bandwidth limit. This is useful for diagnosing bottlenecks in a cache\n configuration.
\nEngineCPUUtilization: The CPU utilization (percentage) allocated to the Redis process. This is\n useful for diagnosing bottlenecks in a cache configuration.
\nMetrics will be recorded by API ID. You can set the value to ENABLED or\n DISABLED.
Represents the input of a CreateApiCache operation.
The ApiCache object.
Represents the output of a CreateApiCache operation.
Creates a unique key that you can distribute to clients who invoke your API.
", + "smithy.api#http": { + "method": "POST", + "uri": "/v1/apis/{apiId}/apikeys", + "code": 200 + } + } + }, + "com.amazonaws.appsync#CreateApiKeyRequest": { + "type": "structure", + "members": { + "apiId": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The ID for your GraphQL API.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "A description of the purpose of the API key.
" + } + }, + "expires": { + "target": "com.amazonaws.appsync#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "From the creation time, the time after which the API key expires. The date is represented as seconds since\n the epoch, rounded down to the nearest hour. The default value for this parameter is 7 days from creation time.\n For more information, see .
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appsync#CreateApiKeyResponse": { + "type": "structure", + "members": { + "apiKey": { + "target": "com.amazonaws.appsync#ApiKey", + "traits": { + "smithy.api#documentation": "The API key.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appsync#CreateDataSource": { + "type": "operation", + "input": { + "target": "com.amazonaws.appsync#CreateDataSourceRequest" + }, + "output": { + "target": "com.amazonaws.appsync#CreateDataSourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appsync#BadRequestException" + }, + { + "target": "com.amazonaws.appsync#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.appsync#InternalFailureException" + }, + { + "target": "com.amazonaws.appsync#NotFoundException" + }, + { + "target": "com.amazonaws.appsync#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a DataSource object.
The API ID for the GraphQL API for the DataSource.
A user-supplied name for the DataSource.
A description of the DataSource.
The type of the DataSource.
The Identity and Access Management (IAM) service role Amazon Resource Name (ARN) for the data source.\n The system assumes this role when accessing the data source.
" + } + }, + "dynamodbConfig": { + "target": "com.amazonaws.appsync#DynamodbDataSourceConfig", + "traits": { + "smithy.api#documentation": "Amazon DynamoDB settings.
" + } + }, + "lambdaConfig": { + "target": "com.amazonaws.appsync#LambdaDataSourceConfig", + "traits": { + "smithy.api#documentation": "Lambda settings.
" + } + }, + "elasticsearchConfig": { + "target": "com.amazonaws.appsync#ElasticsearchDataSourceConfig", + "traits": { + "smithy.api#documentation": "Amazon OpenSearch Service settings.
\nAs of September 2021, Amazon Elasticsearch service is Amazon OpenSearch Service. This configuration is\n deprecated. For new data sources, use CreateDataSourceRequest$openSearchServiceConfig to\n create an OpenSearch data source.
" + } + }, + "openSearchServiceConfig": { + "target": "com.amazonaws.appsync#OpenSearchServiceDataSourceConfig", + "traits": { + "smithy.api#documentation": "Amazon OpenSearch Service settings.
" + } + }, + "httpConfig": { + "target": "com.amazonaws.appsync#HttpDataSourceConfig", + "traits": { + "smithy.api#documentation": "HTTP endpoint settings.
" + } + }, + "relationalDatabaseConfig": { + "target": "com.amazonaws.appsync#RelationalDatabaseDataSourceConfig", + "traits": { + "smithy.api#documentation": "Relational database settings.
" + } + }, + "eventBridgeConfig": { + "target": "com.amazonaws.appsync#EventBridgeDataSourceConfig", + "traits": { + "smithy.api#documentation": "Amazon EventBridge settings.
" + } + }, + "metricsConfig": { + "target": "com.amazonaws.appsync#DataSourceLevelMetricsConfig", + "traits": { + "smithy.api#documentation": "Enables or disables enhanced data source metrics for specified data sources. Note that\n metricsConfig won't be used unless the dataSourceLevelMetricsBehavior value is set\n to PER_DATA_SOURCE_METRICS. If the dataSourceLevelMetricsBehavior is set to\n FULL_REQUEST_DATA_SOURCE_METRICS instead, metricsConfig will be ignored. However,\n you can still set its value.
\n metricsConfig can be ENABLED or DISABLED.
The DataSource object.
Creates a custom DomainName object.
The domain name.
", + "smithy.api#required": {} + } + }, + "certificateArn": { + "target": "com.amazonaws.appsync#CertificateArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the certificate. This can be an Certificate Manager (ACM) certificate or an Identity and Access Management (IAM) server certificate.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.appsync#Description", + "traits": { + "smithy.api#documentation": "A description of the DomainName.
The configuration for the DomainName.
Creates a Function object.
A function is a reusable entity. You can use multiple functions to compose the resolver logic.
", + "smithy.api#http": { + "method": "POST", + "uri": "/v1/apis/{apiId}/functions", + "code": 200 + } + } + }, + "com.amazonaws.appsync#CreateFunctionRequest": { + "type": "structure", + "members": { + "apiId": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The GraphQL API ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.appsync#ResourceName", + "traits": { + "smithy.api#documentation": "The Function name. The function name does not have to be unique.
The Function description.
The Function\n DataSource name.
The Function request mapping template. Functions support only the 2018-05-29 version of the\n request mapping template.
The Function response mapping template.
The version of the request mapping template. Currently, the supported value is 2018-05-29. Note\n that when using VTL and mapping templates, the functionVersion is required.
The maximum batching size for a resolver.
" + } + }, + "runtime": { + "target": "com.amazonaws.appsync#AppSyncRuntime" + }, + "code": { + "target": "com.amazonaws.appsync#Code", + "traits": { + "smithy.api#documentation": "The function code that contains the request and response functions. When code is used, the\n runtime is required. The runtime value must be APPSYNC_JS.
The Function object.
Creates a GraphqlApi object.
A user-supplied name for the GraphqlApi.
The Amazon CloudWatch Logs configuration.
" + } + }, + "authenticationType": { + "target": "com.amazonaws.appsync#AuthenticationType", + "traits": { + "smithy.api#documentation": "The authentication type: API key, Identity and Access Management (IAM), OpenID Connect (OIDC),\n Amazon Cognito user pools, or Lambda.
", + "smithy.api#required": {} + } + }, + "userPoolConfig": { + "target": "com.amazonaws.appsync#UserPoolConfig", + "traits": { + "smithy.api#documentation": "The Amazon Cognito user pool configuration.
" + } + }, + "openIDConnectConfig": { + "target": "com.amazonaws.appsync#OpenIDConnectConfig", + "traits": { + "smithy.api#documentation": "The OIDC configuration.
" + } + }, + "tags": { + "target": "com.amazonaws.appsync#TagMap", + "traits": { + "smithy.api#documentation": "A TagMap object.
A list of additional authentication providers for the GraphqlApi API.
A flag indicating whether to use X-Ray tracing for the GraphqlApi.
Configuration for Lambda function authorization.
" + } + }, + "visibility": { + "target": "com.amazonaws.appsync#GraphQLApiVisibility", + "traits": { + "smithy.api#documentation": "Sets the value of the GraphQL API to public (GLOBAL) or private (PRIVATE). If no\n value is provided, the visibility will be set to GLOBAL by default. This value cannot be changed\n once the API has been created.
The value that indicates whether the GraphQL API is a standard API (GRAPHQL) or merged API\n (MERGED).
The Identity and Access Management service role ARN for a merged API. The AppSync service assumes this role\n on behalf of the Merged API to validate access to source APIs at runtime and to prompt the\n AUTO_MERGE to update the merged API endpoint with the source API changes automatically.
The owner contact information for an API resource.
\nThis field accepts any string input with a length of 0 - 256 characters.
" + } + }, + "introspectionConfig": { + "target": "com.amazonaws.appsync#GraphQLApiIntrospectionConfig", + "traits": { + "smithy.api#documentation": "Sets the value of the GraphQL API to enable (ENABLED) or disable (DISABLED)\n introspection. If no value is provided, the introspection configuration will be set to ENABLED by\n default. This field will produce an error if the operation attempts to use the introspection feature while this\n field is disabled.
For more information about introspection, see GraphQL\n introspection.
" + } + }, + "queryDepthLimit": { + "target": "com.amazonaws.appsync#QueryDepthLimit", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The maximum depth a query can have in a single request. Depth refers to the amount of nested levels allowed\n in the body of query. The default value is 0 (or unspecified), which indicates there's no depth\n limit. If you set a limit, it can be between 1 and 75 nested levels. This field will\n produce a limit error if the operation falls out of bounds.
Note that fields can still be set to nullable or non-nullable. If a non-nullable field produces an error,\n the error will be thrown upwards to the first nullable field available.
" + } + }, + "resolverCountLimit": { + "target": "com.amazonaws.appsync#ResolverCountLimit", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The maximum number of resolvers that can be invoked in a single request. The default value is 0\n (or unspecified), which will set the limit to 10000. When specified, the limit value can be\n between 1 and 10000. This field will produce a limit error if the operation falls out\n of bounds.
The enhancedMetricsConfig object.
The GraphqlApi.
Creates a Resolver object.
A resolver converts incoming requests into a format that a data source can understand, and converts the data\n source's responses into GraphQL.
", + "smithy.api#http": { + "method": "POST", + "uri": "/v1/apis/{apiId}/types/{typeName}/resolvers", + "code": 200 + } + } + }, + "com.amazonaws.appsync#CreateResolverRequest": { + "type": "structure", + "members": { + "apiId": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The ID for the GraphQL API for which the resolver is being created.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "typeName": { + "target": "com.amazonaws.appsync#ResourceName", + "traits": { + "smithy.api#documentation": "The name of the Type.
The name of the field to attach the resolver to.
", + "smithy.api#required": {} + } + }, + "dataSourceName": { + "target": "com.amazonaws.appsync#ResourceName", + "traits": { + "smithy.api#documentation": "The name of the data source for which the resolver is being created.
" + } + }, + "requestMappingTemplate": { + "target": "com.amazonaws.appsync#MappingTemplate", + "traits": { + "smithy.api#documentation": "The mapping template to use for requests.
\nA resolver uses a request mapping template to convert a GraphQL expression into a format that a data source\n can understand. Mapping templates are written in Apache Velocity Template Language (VTL).
\nVTL request mapping templates are optional when using an Lambda data source. For all other\n data sources, VTL request and response mapping templates are required.
" + } + }, + "responseMappingTemplate": { + "target": "com.amazonaws.appsync#MappingTemplate", + "traits": { + "smithy.api#documentation": "The mapping template to use for responses from the data source.
" + } + }, + "kind": { + "target": "com.amazonaws.appsync#ResolverKind", + "traits": { + "smithy.api#documentation": "The resolver type.
\n\n UNIT: A UNIT resolver type. A UNIT resolver is the default\n resolver type. You can use a UNIT resolver to run a GraphQL query against a single data source.
\n\n PIPELINE: A PIPELINE resolver type. You can use a PIPELINE\n resolver to invoke a series of Function objects in a serial manner. You can use a pipeline\n resolver to run a GraphQL query against multiple data sources.
The PipelineConfig.
The SyncConfig for a resolver attached to a versioned data source.
The caching configuration for the resolver.
" + } + }, + "maxBatchSize": { + "target": "com.amazonaws.appsync#MaxBatchSize", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The maximum batching size for a resolver.
" + } + }, + "runtime": { + "target": "com.amazonaws.appsync#AppSyncRuntime" + }, + "code": { + "target": "com.amazonaws.appsync#Code", + "traits": { + "smithy.api#documentation": "The resolver code that contains the request and response functions. When code is used, the\n runtime is required. The runtime value must be APPSYNC_JS.
Enables or disables enhanced resolver metrics for specified resolvers. Note that metricsConfig\n won't be used unless the resolverLevelMetricsBehavior value is set to\n PER_RESOLVER_METRICS. If the resolverLevelMetricsBehavior is set to\n FULL_REQUEST_RESOLVER_METRICS instead, metricsConfig will be ignored. However, you\n can still set its value.
\n metricsConfig can be ENABLED or DISABLED.
The Resolver object.
Creates a Type object.
The API ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "definition": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The type definition, in GraphQL Schema Definition Language (SDL) format.
\nFor more information, see the GraphQL SDL\n documentation.
", + "smithy.api#required": {} + } + }, + "format": { + "target": "com.amazonaws.appsync#TypeDefinitionFormat", + "traits": { + "smithy.api#documentation": "The type format: SDL or JSON.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appsync#CreateTypeResponse": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.appsync#Type", + "traits": { + "smithy.api#documentation": "The Type object.
The data source Amazon Resource Name (ARN).
" + } + }, + "name": { + "target": "com.amazonaws.appsync#ResourceName", + "traits": { + "smithy.api#documentation": "The name of the data source.
" + } + }, + "description": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The description of the data source.
" + } + }, + "type": { + "target": "com.amazonaws.appsync#DataSourceType", + "traits": { + "smithy.api#documentation": "The type of the data source.
\n\n AWS_LAMBDA: The data source is an Lambda\n function.
\n\n AMAZON_DYNAMODB: The data source is an Amazon DynamoDB\n table.
\n\n AMAZON_ELASTICSEARCH: The data source is an Amazon OpenSearch Service\n domain.
\n\n AMAZON_OPENSEARCH_SERVICE: The data source is an Amazon OpenSearch Service domain.
\n\n AMAZON_EVENTBRIDGE: The data source is an Amazon EventBridge\n configuration.
\n\n NONE: There is no data source. Use this type when you want to\n invoke a GraphQL operation without connecting to a data source, such as when you're performing data\n transformation with resolvers or invoking a subscription from a mutation.
\n\n HTTP: The data source is an HTTP endpoint.
\n\n RELATIONAL_DATABASE: The data source is a relational\n database.
\nThe Identity and Access Management (IAM) service role Amazon Resource Name (ARN) for the data source.\n The system assumes this role when accessing the data source.
" + } + }, + "dynamodbConfig": { + "target": "com.amazonaws.appsync#DynamodbDataSourceConfig", + "traits": { + "smithy.api#documentation": "DynamoDB settings.
" + } + }, + "lambdaConfig": { + "target": "com.amazonaws.appsync#LambdaDataSourceConfig", + "traits": { + "smithy.api#documentation": "Lambda settings.
" + } + }, + "elasticsearchConfig": { + "target": "com.amazonaws.appsync#ElasticsearchDataSourceConfig", + "traits": { + "smithy.api#documentation": "Amazon OpenSearch Service settings.
" + } + }, + "openSearchServiceConfig": { + "target": "com.amazonaws.appsync#OpenSearchServiceDataSourceConfig", + "traits": { + "smithy.api#documentation": "Amazon OpenSearch Service settings.
" + } + }, + "httpConfig": { + "target": "com.amazonaws.appsync#HttpDataSourceConfig", + "traits": { + "smithy.api#documentation": "HTTP endpoint settings.
" + } + }, + "relationalDatabaseConfig": { + "target": "com.amazonaws.appsync#RelationalDatabaseDataSourceConfig", + "traits": { + "smithy.api#documentation": "Relational database settings.
" + } + }, + "eventBridgeConfig": { + "target": "com.amazonaws.appsync#EventBridgeDataSourceConfig", + "traits": { + "smithy.api#documentation": "Amazon EventBridge settings.
" + } + }, + "metricsConfig": { + "target": "com.amazonaws.appsync#DataSourceLevelMetricsConfig", + "traits": { + "smithy.api#documentation": "Enables or disables enhanced data source metrics for specified data sources. Note that\n metricsConfig won't be used unless the dataSourceLevelMetricsBehavior value is set\n to PER_DATA_SOURCE_METRICS. If the dataSourceLevelMetricsBehavior is set to\n FULL_REQUEST_DATA_SOURCE_METRICS instead, metricsConfig will be ignored. However,\n you can still set its value.
\n metricsConfig can be ENABLED or DISABLED.
Describes a data source.
" + } + }, + "com.amazonaws.appsync#DataSourceIntrospectionModel": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The name of the model. For example, this could be the name of a single table in a database.
" + } + }, + "fields": { + "target": "com.amazonaws.appsync#DataSourceIntrospectionModelFields", + "traits": { + "smithy.api#documentation": "The DataSourceIntrospectionModelField object data.
The primary key stored as a DataSourceIntrospectionModelIndex object.
The array of DataSourceIntrospectionModelIndex objects.
Contains the output of the SDL that was generated from the introspected types. This is controlled by the\n includeModelsSDL parameter of the GetDataSourceIntrospection operation.
Contains the introspected data that was retrieved from the data source.
" + } + }, + "com.amazonaws.appsync#DataSourceIntrospectionModelField": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The name of the field that was retrieved from the introspected data.
" + } + }, + "type": { + "target": "com.amazonaws.appsync#DataSourceIntrospectionModelFieldType", + "traits": { + "smithy.api#documentation": "The DataSourceIntrospectionModelFieldType object data.
The length value of the introspected field.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents the fields that were retrieved from the introspected data.
" + } + }, + "com.amazonaws.appsync#DataSourceIntrospectionModelFieldType": { + "type": "structure", + "members": { + "kind": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "Specifies the classification of data. For example, this could be set to values like Scalar or\n NonNull to indicate a fundamental property of the field.
Valid values include:
\n\n Scalar: Indicates the value is a primitive type (scalar).
\n NonNull: Indicates the field cannot be null.
\n List: Indicates the field contains a list.
The name of the data type that represents the field. For example, String is a valid\n name value.
The DataSourceIntrospectionModelFieldType object data. The type is only present if\n DataSourceIntrospectionModelFieldType.kind is set to NonNull or List.
The type typically contains its own kind and name fields to represent\n the actual type data. For instance, type could contain a kind value of\n Scalar with a name value of String. The values Scalar\n and String will be collectively stored in the values field.
The values of the type field. This field represents the AppSync data type equivalent of the\n introspected field.
Represents the type data for each field retrieved from the introspection.
" + } + }, + "com.amazonaws.appsync#DataSourceIntrospectionModelFieldTypeValues": { + "type": "list", + "member": { + "target": "com.amazonaws.appsync#String" + } + }, + "com.amazonaws.appsync#DataSourceIntrospectionModelFields": { + "type": "list", + "member": { + "target": "com.amazonaws.appsync#DataSourceIntrospectionModelField" + } + }, + "com.amazonaws.appsync#DataSourceIntrospectionModelIndex": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The name of the index.
" + } + }, + "fields": { + "target": "com.amazonaws.appsync#DataSourceIntrospectionModelIndexFields", + "traits": { + "smithy.api#documentation": "The fields of the index.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The index that was retrieved from the introspected data.
" + } + }, + "com.amazonaws.appsync#DataSourceIntrospectionModelIndexFields": { + "type": "list", + "member": { + "target": "com.amazonaws.appsync#String" + } + }, + "com.amazonaws.appsync#DataSourceIntrospectionModelIndexes": { + "type": "list", + "member": { + "target": "com.amazonaws.appsync#DataSourceIntrospectionModelIndex" + } + }, + "com.amazonaws.appsync#DataSourceIntrospectionModels": { + "type": "list", + "member": { + "target": "com.amazonaws.appsync#DataSourceIntrospectionModel" + } + }, + "com.amazonaws.appsync#DataSourceIntrospectionResult": { + "type": "structure", + "members": { + "models": { + "target": "com.amazonaws.appsync#DataSourceIntrospectionModels", + "traits": { + "smithy.api#documentation": "The array of DataSourceIntrospectionModel objects.
Determines the number of types to be returned in a single response before paginating. This value is\n typically taken from nextToken value from the previous response.
Represents the output of a DataSourceIntrospectionResult. This is the populated result of a\n GetDataSourceIntrospection operation.
Deletes an ApiCache object.
The API ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Represents the input of a DeleteApiCache operation.
Represents the output of a DeleteApiCache operation.
Deletes an API key.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/v1/apis/{apiId}/apikeys/{id}", + "code": 200 + } + } + }, + "com.amazonaws.appsync#DeleteApiKeyRequest": { + "type": "structure", + "members": { + "apiId": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The API ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The ID for the API key.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appsync#DeleteApiKeyResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appsync#DeleteDataSource": { + "type": "operation", + "input": { + "target": "com.amazonaws.appsync#DeleteDataSourceRequest" + }, + "output": { + "target": "com.amazonaws.appsync#DeleteDataSourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appsync#BadRequestException" + }, + { + "target": "com.amazonaws.appsync#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.appsync#InternalFailureException" + }, + { + "target": "com.amazonaws.appsync#NotFoundException" + }, + { + "target": "com.amazonaws.appsync#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a DataSource object.
The API ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.appsync#ResourceName", + "traits": { + "smithy.api#documentation": "The name of the data source.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appsync#DeleteDataSourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appsync#DeleteDomainName": { + "type": "operation", + "input": { + "target": "com.amazonaws.appsync#DeleteDomainNameRequest" + }, + "output": { + "target": "com.amazonaws.appsync#DeleteDomainNameResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appsync#AccessDeniedException" + }, + { + "target": "com.amazonaws.appsync#BadRequestException" + }, + { + "target": "com.amazonaws.appsync#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.appsync#InternalFailureException" + }, + { + "target": "com.amazonaws.appsync#NotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a custom DomainName object.
The domain name.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appsync#DeleteDomainNameResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appsync#DeleteFunction": { + "type": "operation", + "input": { + "target": "com.amazonaws.appsync#DeleteFunctionRequest" + }, + "output": { + "target": "com.amazonaws.appsync#DeleteFunctionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appsync#BadRequestException" + }, + { + "target": "com.amazonaws.appsync#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.appsync#InternalFailureException" + }, + { + "target": "com.amazonaws.appsync#NotFoundException" + }, + { + "target": "com.amazonaws.appsync#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a Function.
The GraphQL API ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "functionId": { + "target": "com.amazonaws.appsync#ResourceName", + "traits": { + "smithy.api#documentation": "The Function ID.
Deletes a GraphqlApi object.
The API ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appsync#DeleteGraphqlApiResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appsync#DeleteResolver": { + "type": "operation", + "input": { + "target": "com.amazonaws.appsync#DeleteResolverRequest" + }, + "output": { + "target": "com.amazonaws.appsync#DeleteResolverResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appsync#BadRequestException" + }, + { + "target": "com.amazonaws.appsync#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.appsync#InternalFailureException" + }, + { + "target": "com.amazonaws.appsync#NotFoundException" + }, + { + "target": "com.amazonaws.appsync#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a Resolver object.
The API ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "typeName": { + "target": "com.amazonaws.appsync#ResourceName", + "traits": { + "smithy.api#documentation": "The name of the resolver type.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "fieldName": { + "target": "com.amazonaws.appsync#ResourceName", + "traits": { + "smithy.api#documentation": "The resolver field name.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appsync#DeleteResolverResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appsync#DeleteType": { + "type": "operation", + "input": { + "target": "com.amazonaws.appsync#DeleteTypeRequest" + }, + "output": { + "target": "com.amazonaws.appsync#DeleteTypeResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appsync#BadRequestException" + }, + { + "target": "com.amazonaws.appsync#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.appsync#InternalFailureException" + }, + { + "target": "com.amazonaws.appsync#NotFoundException" + }, + { + "target": "com.amazonaws.appsync#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a Type object.
The API ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "typeName": { + "target": "com.amazonaws.appsync#ResourceName", + "traits": { + "smithy.api#documentation": "The type name.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appsync#DeleteTypeResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appsync#DeltaSyncConfig": { + "type": "structure", + "members": { + "baseTableTTL": { + "target": "com.amazonaws.appsync#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The number of minutes that an Item is stored in the data source.
" + } + }, + "deltaSyncTableName": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The Delta Sync table name.
" + } + }, + "deltaSyncTableTTL": { + "target": "com.amazonaws.appsync#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The number of minutes that a Delta Sync log entry is stored in the Delta Sync table.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes a Delta Sync configuration.
" + } + }, + "com.amazonaws.appsync#Description": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + }, + "smithy.api#pattern": "^.*$" + } + }, + "com.amazonaws.appsync#DisassociateApi": { + "type": "operation", + "input": { + "target": "com.amazonaws.appsync#DisassociateApiRequest" + }, + "output": { + "target": "com.amazonaws.appsync#DisassociateApiResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appsync#AccessDeniedException" + }, + { + "target": "com.amazonaws.appsync#BadRequestException" + }, + { + "target": "com.amazonaws.appsync#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.appsync#InternalFailureException" + }, + { + "target": "com.amazonaws.appsync#NotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Removes an ApiAssociation object from a custom domain.
The domain name.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appsync#DisassociateApiResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appsync#DisassociateMergedGraphqlApi": { + "type": "operation", + "input": { + "target": "com.amazonaws.appsync#DisassociateMergedGraphqlApiRequest" + }, + "output": { + "target": "com.amazonaws.appsync#DisassociateMergedGraphqlApiResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appsync#BadRequestException" + }, + { + "target": "com.amazonaws.appsync#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.appsync#InternalFailureException" + }, + { + "target": "com.amazonaws.appsync#NotFoundException" + }, + { + "target": "com.amazonaws.appsync#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes an association between a Merged API and source API using the source API's identifier and the\n association ID.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/v1/sourceApis/{sourceApiIdentifier}/mergedApiAssociations/{associationId}", + "code": 200 + } + } + }, + "com.amazonaws.appsync#DisassociateMergedGraphqlApiRequest": { + "type": "structure", + "members": { + "sourceApiIdentifier": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The identifier of the AppSync Source API. This is generated by the AppSync service. In most cases, source\n APIs (especially in your account) only require the API ID value or ARN of the source API. However, source APIs\n from other accounts (cross-account use cases) strictly require the full resource ARN of the source API.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "associationId": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The ID generated by the AppSync service for the source API association.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appsync#DisassociateMergedGraphqlApiResponse": { + "type": "structure", + "members": { + "sourceApiAssociationStatus": { + "target": "com.amazonaws.appsync#SourceApiAssociationStatus", + "traits": { + "smithy.api#documentation": "The state of the source API association.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appsync#DisassociateSourceGraphqlApi": { + "type": "operation", + "input": { + "target": "com.amazonaws.appsync#DisassociateSourceGraphqlApiRequest" + }, + "output": { + "target": "com.amazonaws.appsync#DisassociateSourceGraphqlApiResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appsync#BadRequestException" + }, + { + "target": "com.amazonaws.appsync#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.appsync#InternalFailureException" + }, + { + "target": "com.amazonaws.appsync#NotFoundException" + }, + { + "target": "com.amazonaws.appsync#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes an association between a Merged API and source API using the Merged API's identifier and the\n association ID.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/v1/mergedApis/{mergedApiIdentifier}/sourceApiAssociations/{associationId}", + "code": 200 + } + } + }, + "com.amazonaws.appsync#DisassociateSourceGraphqlApiRequest": { + "type": "structure", + "members": { + "mergedApiIdentifier": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged\n APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs\n in other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "associationId": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The ID generated by the AppSync service for the source API association.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appsync#DisassociateSourceGraphqlApiResponse": { + "type": "structure", + "members": { + "sourceApiAssociationStatus": { + "target": "com.amazonaws.appsync#SourceApiAssociationStatus", + "traits": { + "smithy.api#documentation": "The state of the source API association.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appsync#DomainName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 253 + }, + "smithy.api#pattern": "^(\\*[\\w\\d-]*\\.)?([\\w\\d-]+\\.)+[\\w\\d-]+$" + } + }, + "com.amazonaws.appsync#DomainNameConfig": { + "type": "structure", + "members": { + "domainName": { + "target": "com.amazonaws.appsync#DomainName", + "traits": { + "smithy.api#documentation": "The domain name.
" + } + }, + "description": { + "target": "com.amazonaws.appsync#Description", + "traits": { + "smithy.api#documentation": "A description of the DomainName configuration.
The Amazon Resource Name (ARN) of the certificate. This can be an Certificate Manager (ACM) certificate or an Identity and Access Management (IAM) server certificate.
" + } + }, + "appsyncDomainName": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The domain name that AppSync provides.
" + } + }, + "hostedZoneId": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The ID of your Amazon Route 53 hosted zone.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes a configuration for a custom domain.
" + } + }, + "com.amazonaws.appsync#DomainNameConfigs": { + "type": "list", + "member": { + "target": "com.amazonaws.appsync#DomainNameConfig" + } + }, + "com.amazonaws.appsync#DynamodbDataSourceConfig": { + "type": "structure", + "members": { + "tableName": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The table name.
", + "smithy.api#required": {} + } + }, + "awsRegion": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The Amazon Web Services Region.
", + "smithy.api#required": {} + } + }, + "useCallerCredentials": { + "target": "com.amazonaws.appsync#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Set to TRUE to use Amazon Cognito credentials with this data source.
" + } + }, + "deltaSyncConfig": { + "target": "com.amazonaws.appsync#DeltaSyncConfig", + "traits": { + "smithy.api#documentation": "The DeltaSyncConfig for a versioned data source.
Set to TRUE to use Conflict Detection and Resolution with this data source.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes an Amazon DynamoDB data source configuration.
" + } + }, + "com.amazonaws.appsync#ElasticsearchDataSourceConfig": { + "type": "structure", + "members": { + "endpoint": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The endpoint.
", + "smithy.api#required": {} + } + }, + "awsRegion": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The Amazon Web Services Region.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Describes an OpenSearch data source configuration.
\nAs of September 2021, Amazon Elasticsearch service is Amazon OpenSearch Service. This configuration is\n deprecated. For new data sources, use OpenSearchServiceDataSourceConfig to specify an OpenSearch data source.
" + } + }, + "com.amazonaws.appsync#EnhancedMetricsConfig": { + "type": "structure", + "members": { + "resolverLevelMetricsBehavior": { + "target": "com.amazonaws.appsync#ResolverLevelMetricsBehavior", + "traits": { + "smithy.api#documentation": "Controls how resolver metrics will be emitted to CloudWatch. Resolver metrics include:
\nGraphQL errors: The number of GraphQL errors that occurred.
\nRequests: The number of invocations that occurred during a request.
\nLatency: The time to complete a resolver invocation.
\nCache hits: The number of cache hits during a request.
\nCache misses: The number of cache misses during a request.
\nThese metrics can be emitted to CloudWatch per resolver or for all resolvers in the request. Metrics will be\n recorded by API ID and resolver name. resolverLevelMetricsBehavior accepts one of these values at\n a time:
\n FULL_REQUEST_RESOLVER_METRICS: Records and emits metric data for all resolvers in the\n request.
\n PER_RESOLVER_METRICS: Records and emits metric data for resolvers that have the\n metricsConfig value set to ENABLED.
Controls how data source metrics will be emitted to CloudWatch. Data source metrics include:
\nRequests: The number of invocations that occured during a request.
\nLatency: The time to complete a data source invocation.
\nErrors: The number of errors that occurred during a data source invocation.
\nThese metrics can be emitted to CloudWatch per data source or for all data sources in the request. Metrics\n will be recorded by API ID and data source name. dataSourceLevelMetricsBehavior accepts one of\n these values at a time:
\n FULL_REQUEST_DATA_SOURCE_METRICS: Records and emits metric data for all data sources\n in the request.
\n PER_DATA_SOURCE_METRICS: Records and emits metric data for data sources that have the\n metricsConfig value set to ENABLED.
Controls how operation metrics will be emitted to CloudWatch. Operation metrics include:
\nRequests: The number of times a specified GraphQL operation was called.
\nGraphQL errors: The number of GraphQL errors that occurred during a specified GraphQL\n operation.
\nMetrics will be recorded by API ID and operation name. You can set the value to ENABLED or\n DISABLED.
Enables and controls the enhanced metrics feature. Enhanced metrics emit granular data on API usage and\n performance such as AppSync request and error counts, latency, and cache hits/misses. All enhanced metric data\n is sent to your CloudWatch account, and you can configure the types of data that will be sent.
\nEnhanced metrics can be configured at the resolver, data source, and operation levels.\n EnhancedMetricsConfig contains three required parameters, each controlling one of these\n categories:
\n resolverLevelMetricsBehavior: Controls how resolver metrics will be emitted to\n CloudWatch. Resolver metrics include:
GraphQL errors: The number of GraphQL errors that occurred.
\nRequests: The number of invocations that occurred during a request.
\nLatency: The time to complete a resolver invocation.
\nCache hits: The number of cache hits during a request.
\nCache misses: The number of cache misses during a request.
\nThese metrics can be emitted to CloudWatch per resolver or for all resolvers in the request. Metrics\n will be recorded by API ID and resolver name. resolverLevelMetricsBehavior accepts one of\n these values at a time:
\n FULL_REQUEST_RESOLVER_METRICS: Records and emits metric data for all resolvers\n in the request.
\n PER_RESOLVER_METRICS: Records and emits metric data for resolvers that have the\n metricsConfig value set to ENABLED.
\n dataSourceLevelMetricsBehavior: Controls how data source metrics will be emitted to\n CloudWatch. Data source metrics include:
Requests: The number of invocations that occured during a request.
\nLatency: The time to complete a data source invocation.
\nErrors: The number of errors that occurred during a data source invocation.
\nThese metrics can be emitted to CloudWatch per data source or for all data sources in the request.\n Metrics will be recorded by API ID and data source name. dataSourceLevelMetricsBehavior\n accepts one of these values at a time:
\n FULL_REQUEST_DATA_SOURCE_METRICS: Records and emits metric data for all data\n sources in the request.
\n PER_DATA_SOURCE_METRICS: Records and emits metric data for data sources that\n have the metricsConfig value set to ENABLED.
\n operationLevelMetricsConfig: Controls how operation metrics will be emitted to\n CloudWatch. Operation metrics include:
Requests: The number of times a specified GraphQL operation was called.
\nGraphQL errors: The number of GraphQL errors that occurred during a specified GraphQL\n operation.
\nMetrics will be recorded by API ID and operation name. You can set the value to ENABLED\n or DISABLED.
The error payload.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the list of errors generated. When using JavaScript, this will apply to the request or response\n function evaluation.
" + } + }, + "com.amazonaws.appsync#ErrorMessage": { + "type": "string" + }, + "com.amazonaws.appsync#EvaluateCode": { + "type": "operation", + "input": { + "target": "com.amazonaws.appsync#EvaluateCodeRequest" + }, + "output": { + "target": "com.amazonaws.appsync#EvaluateCodeResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appsync#AccessDeniedException" + }, + { + "target": "com.amazonaws.appsync#BadRequestException" + }, + { + "target": "com.amazonaws.appsync#InternalFailureException" + } + ], + "traits": { + "smithy.api#documentation": "Evaluates the given code and returns the response. The code definition requirements depend on the specified\n runtime. For APPSYNC_JS runtimes, the code defines the request and response functions. The request\n function takes the incoming request after a GraphQL operation is parsed and converts it into a request\n configuration for the selected data source operation. The response function interprets responses from the data\n source and maps it to the shape of the GraphQL field output type.
The error payload.
" + } + }, + "codeErrors": { + "target": "com.amazonaws.appsync#CodeErrors", + "traits": { + "smithy.api#documentation": "Contains the list of CodeError objects.
Contains the list of errors from a code evaluation response.
" + } + }, + "com.amazonaws.appsync#EvaluateCodeRequest": { + "type": "structure", + "members": { + "runtime": { + "target": "com.amazonaws.appsync#AppSyncRuntime", + "traits": { + "smithy.api#documentation": "The runtime to be used when evaluating the code. Currently, only the APPSYNC_JS runtime is\n supported.
The code definition to be evaluated. Note that code and runtime are both required\n for this action. The runtime value must be APPSYNC_JS.
The map that holds all of the contextual information for your resolver invocation. A context is\n required for this action.
The function within the code to be evaluated. If provided, the valid values are request and\n response.
The result of the evaluation operation.
" + } + }, + "error": { + "target": "com.amazonaws.appsync#EvaluateCodeErrorDetail", + "traits": { + "smithy.api#documentation": "Contains the payload of the response error.
" + } + }, + "logs": { + "target": "com.amazonaws.appsync#Logs", + "traits": { + "smithy.api#documentation": "A list of logs that were generated by calls to util.log.info and util.log.error in\n the evaluated code.
Evaluates a given template and returns the response. The mapping template can be a request or response\n template.
\nRequest templates take the incoming request after a GraphQL operation is parsed and convert it into a\n request configuration for the selected data source operation. Response templates interpret responses from the\n data source and map it to the shape of the GraphQL field output type.
\nMapping templates are written in the Apache Velocity Template Language (VTL).
", + "smithy.api#http": { + "method": "POST", + "uri": "/v1/dataplane-evaluatetemplate", + "code": 200 + } + } + }, + "com.amazonaws.appsync#EvaluateMappingTemplateRequest": { + "type": "structure", + "members": { + "template": { + "target": "com.amazonaws.appsync#Template", + "traits": { + "smithy.api#documentation": "The mapping template; this can be a request or response template. A template is required for\n this action.
The map that holds all of the contextual information for your resolver invocation. A context is\n required for this action.
The mapping template; this can be a request or response template.
" + } + }, + "error": { + "target": "com.amazonaws.appsync#ErrorDetail", + "traits": { + "smithy.api#documentation": "The ErrorDetail object.
A list of logs that were generated by calls to util.log.info and util.log.error in\n the evaluated code.
The ARN of the event bus. For more information about event buses, see Amazon EventBridge event\n buses.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Describes an Amazon EventBridge bus data source configuration.
" + } + }, + "com.amazonaws.appsync#FieldLogLevel": { + "type": "enum", + "members": { + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + }, + "ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ERROR" + } + }, + "ALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL" + } + }, + "INFO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INFO" + } + }, + "DEBUG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEBUG" + } + } + } + }, + "com.amazonaws.appsync#FlushApiCache": { + "type": "operation", + "input": { + "target": "com.amazonaws.appsync#FlushApiCacheRequest" + }, + "output": { + "target": "com.amazonaws.appsync#FlushApiCacheResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appsync#BadRequestException" + }, + { + "target": "com.amazonaws.appsync#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.appsync#InternalFailureException" + }, + { + "target": "com.amazonaws.appsync#NotFoundException" + }, + { + "target": "com.amazonaws.appsync#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Flushes an ApiCache object.
The API ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Represents the input of a FlushApiCache operation.
Represents the output of a FlushApiCache operation.
A unique ID representing the Function object.
The Amazon Resource Name (ARN) of the Function object.
The name of the Function object.
The Function description.
The name of the DataSource.
The Function request mapping template. Functions support only the 2018-05-29 version of the\n request mapping template.
The Function response mapping template.
The version of the request mapping template. Currently, only the 2018-05-29 version of the template is\n supported.
" + } + }, + "syncConfig": { + "target": "com.amazonaws.appsync#SyncConfig" + }, + "maxBatchSize": { + "target": "com.amazonaws.appsync#MaxBatchSize", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The maximum batching size for a resolver.
" + } + }, + "runtime": { + "target": "com.amazonaws.appsync#AppSyncRuntime" + }, + "code": { + "target": "com.amazonaws.appsync#Code", + "traits": { + "smithy.api#documentation": "The function code that contains the request and response functions. When code is used, the\n runtime is required. The runtime value must be APPSYNC_JS.
A function is a reusable entity. You can use multiple functions to compose the resolver logic.
" + } + }, + "com.amazonaws.appsync#Functions": { + "type": "list", + "member": { + "target": "com.amazonaws.appsync#FunctionConfiguration" + } + }, + "com.amazonaws.appsync#FunctionsIds": { + "type": "list", + "member": { + "target": "com.amazonaws.appsync#String" + } + }, + "com.amazonaws.appsync#GetApiAssociation": { + "type": "operation", + "input": { + "target": "com.amazonaws.appsync#GetApiAssociationRequest" + }, + "output": { + "target": "com.amazonaws.appsync#GetApiAssociationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appsync#AccessDeniedException" + }, + { + "target": "com.amazonaws.appsync#BadRequestException" + }, + { + "target": "com.amazonaws.appsync#InternalFailureException" + }, + { + "target": "com.amazonaws.appsync#NotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves an ApiAssociation object.
The domain name.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appsync#GetApiAssociationResponse": { + "type": "structure", + "members": { + "apiAssociation": { + "target": "com.amazonaws.appsync#ApiAssociation", + "traits": { + "smithy.api#documentation": "The ApiAssociation object.
Retrieves an ApiCache object.
The API ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Represents the input of a GetApiCache operation.
The ApiCache object.
Represents the output of a GetApiCache operation.
Retrieves a DataSource object.
Retrieves the record of an existing introspection. If the retrieval is successful, the result of the\n instrospection will also be returned. If the retrieval fails the operation, an error message will be returned\n instead.
", + "smithy.api#http": { + "method": "GET", + "uri": "/v1/datasources/introspections/{introspectionId}", + "code": 200 + } + } + }, + "com.amazonaws.appsync#GetDataSourceIntrospectionRequest": { + "type": "structure", + "members": { + "introspectionId": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The introspection ID. Each introspection contains a unique ID that can be used to reference the\n instrospection record.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "includeModelsSDL": { + "target": "com.amazonaws.appsync#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "A boolean flag that determines whether SDL should be generated for introspected types or not. If set to\n true, each model will contain an sdl property that contains the SDL for that type.\n The SDL only contains the type data and no additional metadata or directives.
Determines the number of types to be returned in a single response before paginating. This value is\n typically taken from nextToken value from the previous response.
The maximum number of introspected types that will be returned in a single response.
", + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appsync#GetDataSourceIntrospectionResponse": { + "type": "structure", + "members": { + "introspectionId": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The introspection ID. Each introspection contains a unique ID that can be used to reference the\n instrospection record.
" + } + }, + "introspectionStatus": { + "target": "com.amazonaws.appsync#DataSourceIntrospectionStatus", + "traits": { + "smithy.api#documentation": "The status of the introspection during retrieval. By default, when a new instrospection is being retrieved,\n the status will be set to PROCESSING. Once the operation has been completed, the status will\n change to SUCCESS or FAILED depending on how the data was parsed. A\n FAILED operation will return an error and its details as an\n introspectionStatusDetail.
The error detail field. When a FAILED\n introspectionStatus is returned, the introspectionStatusDetail will also return the\n exact error that was generated during the operation.
The DataSourceIntrospectionResult object data.
The API ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.appsync#ResourceName", + "traits": { + "smithy.api#documentation": "The name of the data source.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appsync#GetDataSourceResponse": { + "type": "structure", + "members": { + "dataSource": { + "target": "com.amazonaws.appsync#DataSource", + "traits": { + "smithy.api#documentation": "The DataSource object.
Retrieves a custom DomainName object.
The domain name.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appsync#GetDomainNameResponse": { + "type": "structure", + "members": { + "domainNameConfig": { + "target": "com.amazonaws.appsync#DomainNameConfig", + "traits": { + "smithy.api#documentation": "The configuration for the DomainName.
Get a Function.
The GraphQL API ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "functionId": { + "target": "com.amazonaws.appsync#ResourceName", + "traits": { + "smithy.api#documentation": "The Function ID.
The Function object.
Retrieves a GraphqlApi object.
Retrieves the list of environmental variable key-value pairs associated with an API by its ID value.
", + "smithy.api#http": { + "method": "GET", + "uri": "/v1/apis/{apiId}/environmentVariables", + "code": 200 + } + } + }, + "com.amazonaws.appsync#GetGraphqlApiEnvironmentVariablesRequest": { + "type": "structure", + "members": { + "apiId": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The ID of the API from which the environmental variable list will be retrieved.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appsync#GetGraphqlApiEnvironmentVariablesResponse": { + "type": "structure", + "members": { + "environmentVariables": { + "target": "com.amazonaws.appsync#EnvironmentVariableMap", + "traits": { + "smithy.api#documentation": "The payload containing each environmental variable in the \"key\" : \"value\" format.
The API ID for the GraphQL API.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appsync#GetGraphqlApiResponse": { + "type": "structure", + "members": { + "graphqlApi": { + "target": "com.amazonaws.appsync#GraphqlApi", + "traits": { + "smithy.api#documentation": "The GraphqlApi object.
Retrieves the introspection schema for a GraphQL API.
", + "smithy.api#http": { + "method": "GET", + "uri": "/v1/apis/{apiId}/schema", + "code": 200 + } + } + }, + "com.amazonaws.appsync#GetIntrospectionSchemaRequest": { + "type": "structure", + "members": { + "apiId": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The API ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "format": { + "target": "com.amazonaws.appsync#OutputType", + "traits": { + "smithy.api#documentation": "The schema format: SDL or JSON.
", + "smithy.api#httpQuery": "format", + "smithy.api#required": {} + } + }, + "includeDirectives": { + "target": "com.amazonaws.appsync#BooleanValue", + "traits": { + "smithy.api#documentation": "A flag that specifies whether the schema introspection should contain directives.
", + "smithy.api#httpQuery": "includeDirectives" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appsync#GetIntrospectionSchemaResponse": { + "type": "structure", + "members": { + "schema": { + "target": "com.amazonaws.appsync#Blob", + "traits": { + "smithy.api#documentation": "The schema, in GraphQL Schema Definition Language (SDL) format.
\nFor more information, see the GraphQL SDL\n documentation.
", + "smithy.api#httpPayload": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appsync#GetResolver": { + "type": "operation", + "input": { + "target": "com.amazonaws.appsync#GetResolverRequest" + }, + "output": { + "target": "com.amazonaws.appsync#GetResolverResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appsync#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.appsync#NotFoundException" + }, + { + "target": "com.amazonaws.appsync#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves a Resolver object.
The API ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "typeName": { + "target": "com.amazonaws.appsync#ResourceName", + "traits": { + "smithy.api#documentation": "The resolver type name.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "fieldName": { + "target": "com.amazonaws.appsync#ResourceName", + "traits": { + "smithy.api#documentation": "The resolver field name.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appsync#GetResolverResponse": { + "type": "structure", + "members": { + "resolver": { + "target": "com.amazonaws.appsync#Resolver", + "traits": { + "smithy.api#documentation": "The Resolver object.
Retrieves the current status of a schema creation operation.
", + "smithy.api#http": { + "method": "GET", + "uri": "/v1/apis/{apiId}/schemacreation", + "code": 200 + } + } + }, + "com.amazonaws.appsync#GetSchemaCreationStatusRequest": { + "type": "structure", + "members": { + "apiId": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The API ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appsync#GetSchemaCreationStatusResponse": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.appsync#SchemaStatus", + "traits": { + "smithy.api#documentation": "The current state of the schema (PROCESSING, FAILED, SUCCESS, or NOT_APPLICABLE). When the schema is in the\n ACTIVE state, you can add data.
" + } + }, + "details": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "Detailed information about the status of the schema creation operation.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appsync#GetSourceApiAssociation": { + "type": "operation", + "input": { + "target": "com.amazonaws.appsync#GetSourceApiAssociationRequest" + }, + "output": { + "target": "com.amazonaws.appsync#GetSourceApiAssociationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appsync#BadRequestException" + }, + { + "target": "com.amazonaws.appsync#InternalFailureException" + }, + { + "target": "com.amazonaws.appsync#NotFoundException" + }, + { + "target": "com.amazonaws.appsync#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves a SourceApiAssociation object.
The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged\n APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs\n in other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "associationId": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The ID generated by the AppSync service for the source API association.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appsync#GetSourceApiAssociationResponse": { + "type": "structure", + "members": { + "sourceApiAssociation": { + "target": "com.amazonaws.appsync#SourceApiAssociation", + "traits": { + "smithy.api#documentation": "The SourceApiAssociation object data.
Retrieves a Type object.
The API ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "typeName": { + "target": "com.amazonaws.appsync#ResourceName", + "traits": { + "smithy.api#documentation": "The type name.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "format": { + "target": "com.amazonaws.appsync#TypeDefinitionFormat", + "traits": { + "smithy.api#documentation": "The type format: SDL or JSON.
", + "smithy.api#httpQuery": "format", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appsync#GetTypeResponse": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.appsync#Type", + "traits": { + "smithy.api#documentation": "The Type object.
The GraphQL schema is not valid.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.appsync#GraphqlApi": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.appsync#ResourceName", + "traits": { + "smithy.api#documentation": "The API name.
" + } + }, + "apiId": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The API ID.
" + } + }, + "authenticationType": { + "target": "com.amazonaws.appsync#AuthenticationType", + "traits": { + "smithy.api#documentation": "The authentication type.
" + } + }, + "logConfig": { + "target": "com.amazonaws.appsync#LogConfig", + "traits": { + "smithy.api#documentation": "The Amazon CloudWatch Logs configuration.
" + } + }, + "userPoolConfig": { + "target": "com.amazonaws.appsync#UserPoolConfig", + "traits": { + "smithy.api#documentation": "The Amazon Cognito user pool configuration.
" + } + }, + "openIDConnectConfig": { + "target": "com.amazonaws.appsync#OpenIDConnectConfig", + "traits": { + "smithy.api#documentation": "The OpenID Connect configuration.
" + } + }, + "arn": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN).
" + } + }, + "uris": { + "target": "com.amazonaws.appsync#MapOfStringToString", + "traits": { + "smithy.api#documentation": "The URIs.
" + } + }, + "tags": { + "target": "com.amazonaws.appsync#TagMap", + "traits": { + "smithy.api#documentation": "The tags.
" + } + }, + "additionalAuthenticationProviders": { + "target": "com.amazonaws.appsync#AdditionalAuthenticationProviders", + "traits": { + "smithy.api#documentation": "A list of additional authentication providers for the GraphqlApi API.
A flag indicating whether to use X-Ray tracing for this GraphqlApi.
The ARN of the WAF access control list (ACL) associated with this\n GraphqlApi, if one exists.
Configuration for Lambda function authorization.
" + } + }, + "dns": { + "target": "com.amazonaws.appsync#MapOfStringToString", + "traits": { + "smithy.api#documentation": "The DNS records for the API.
" + } + }, + "visibility": { + "target": "com.amazonaws.appsync#GraphQLApiVisibility", + "traits": { + "smithy.api#documentation": "Sets the value of the GraphQL API to public (GLOBAL) or private (PRIVATE). If no\n value is provided, the visibility will be set to GLOBAL by default. This value cannot be changed\n once the API has been created.
The value that indicates whether the GraphQL API is a standard API (GRAPHQL) or merged API\n (MERGED).
The Identity and Access Management service role ARN for a merged API. The AppSync service assumes this role\n on behalf of the Merged API to validate access to source APIs at runtime and to prompt the\n AUTO_MERGE to update the merged API endpoint with the source API changes automatically.
The account owner of the GraphQL API.
" + } + }, + "ownerContact": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The owner contact information for an API resource.
\nThis field accepts any string input with a length of 0 - 256 characters.
" + } + }, + "introspectionConfig": { + "target": "com.amazonaws.appsync#GraphQLApiIntrospectionConfig", + "traits": { + "smithy.api#documentation": "Sets the value of the GraphQL API to enable (ENABLED) or disable (DISABLED)\n introspection. If no value is provided, the introspection configuration will be set to ENABLED by\n default. This field will produce an error if the operation attempts to use the introspection feature while this\n field is disabled.
For more information about introspection, see GraphQL\n introspection.
" + } + }, + "queryDepthLimit": { + "target": "com.amazonaws.appsync#QueryDepthLimit", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The maximum depth a query can have in a single request. Depth refers to the amount of nested levels allowed\n in the body of query. The default value is 0 (or unspecified), which indicates there's no depth\n limit. If you set a limit, it can be between 1 and 75 nested levels. This field will\n produce a limit error if the operation falls out of bounds.
Note that fields can still be set to nullable or non-nullable. If a non-nullable field produces an error,\n the error will be thrown upwards to the first nullable field available.
" + } + }, + "resolverCountLimit": { + "target": "com.amazonaws.appsync#ResolverCountLimit", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The maximum number of resolvers that can be invoked in a single request. The default value is 0\n (or unspecified), which will set the limit to 10000. When specified, the limit value can be\n between 1 and 10000. This field will produce a limit error if the operation falls out\n of bounds.
The enhancedMetricsConfig object.
Describes a GraphQL API.
" + } + }, + "com.amazonaws.appsync#GraphqlApis": { + "type": "list", + "member": { + "target": "com.amazonaws.appsync#GraphqlApi" + } + }, + "com.amazonaws.appsync#HttpDataSourceConfig": { + "type": "structure", + "members": { + "endpoint": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The HTTP URL endpoint. You can specify either the domain name or IP, and port combination, and the URL\n scheme must be HTTP or HTTPS. If you don't specify the port, AppSync uses the default port 80\n for the HTTP endpoint and port 443 for HTTPS endpoints.
" + } + }, + "authorizationConfig": { + "target": "com.amazonaws.appsync#AuthorizationConfig", + "traits": { + "smithy.api#documentation": "The authorization configuration in case the HTTP endpoint requires authorization.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes an HTTP data source configuration.
" + } + }, + "com.amazonaws.appsync#InternalFailureException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.appsync#String" + } + }, + "traits": { + "smithy.api#documentation": "An internal AppSync error occurred. Try your request again.
", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.appsync#LambdaAuthorizerConfig": { + "type": "structure", + "members": { + "authorizerResultTtlInSeconds": { + "target": "com.amazonaws.appsync#TTL", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The number of seconds a response should be cached for. The default is 0 seconds, which disables caching. If\n you don't specify a value for authorizerResultTtlInSeconds, the default value is used. The maximum\n value is one hour (3600 seconds). The Lambda function can override this by returning a\n ttlOverride key in its response.
The Amazon Resource Name (ARN) of the Lambda function to be called for authorization. This can\n be a standard Lambda ARN, a version ARN (.../v3), or an alias ARN.
\n Note: This Lambda function must have the following\n resource-based policy assigned to it. When configuring Lambda authorizers in the console, this is\n done for you. To use the Command Line Interface (CLI), run the following:
\n\n aws lambda add-permission --function-name\n \"arn:aws:lambda:us-east-2:111122223333:function:my-function\" --statement-id \"appsync\" --principal\n appsync.amazonaws.com --action lambda:InvokeFunction\n
A regular expression for validation of tokens before the Lambda function is called.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A LambdaAuthorizerConfig specifies how to authorize AppSync API access when\n using the AWS_LAMBDA authorizer mode. Be aware that an AppSync API can have only\n one Lambda authorizer configured at a time.
The Amazon Resource Name (ARN) for the Lambda function to use as the Conflict Handler.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The LambdaConflictHandlerConfig object when configuring LAMBDA as the Conflict\n Handler.
The Amazon Resource Name (ARN) for the Lambda function.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Describes an Lambda data source configuration.
" + } + }, + "com.amazonaws.appsync#LimitExceededException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.appsync#String" + } + }, + "traits": { + "smithy.api#documentation": "The request exceeded a limit. Try your request again.
", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, + "com.amazonaws.appsync#ListApiKeys": { + "type": "operation", + "input": { + "target": "com.amazonaws.appsync#ListApiKeysRequest" + }, + "output": { + "target": "com.amazonaws.appsync#ListApiKeysResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appsync#BadRequestException" + }, + { + "target": "com.amazonaws.appsync#InternalFailureException" + }, + { + "target": "com.amazonaws.appsync#NotFoundException" + }, + { + "target": "com.amazonaws.appsync#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the API keys for a given API.
\nAPI keys are deleted automatically 60 days after they expire. However, they may still be included in the\n response until they have actually been deleted. You can safely call DeleteApiKey to manually\n delete a key before it's automatically deleted.
The API ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.appsync#PaginationToken", + "traits": { + "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which you can use to return the\n next set of items in the list.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.appsync#MaxResults", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The maximum number of results that you want the request to return.
", + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appsync#ListApiKeysResponse": { + "type": "structure", + "members": { + "apiKeys": { + "target": "com.amazonaws.appsync#ApiKeys", + "traits": { + "smithy.api#documentation": "The ApiKey objects.
An identifier to pass in the next request to this operation to return the next set of items in the\n list.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appsync#ListDataSources": { + "type": "operation", + "input": { + "target": "com.amazonaws.appsync#ListDataSourcesRequest" + }, + "output": { + "target": "com.amazonaws.appsync#ListDataSourcesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appsync#BadRequestException" + }, + { + "target": "com.amazonaws.appsync#InternalFailureException" + }, + { + "target": "com.amazonaws.appsync#NotFoundException" + }, + { + "target": "com.amazonaws.appsync#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the data sources for a given API.
", + "smithy.api#http": { + "method": "GET", + "uri": "/v1/apis/{apiId}/datasources", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "dataSources", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.appsync#ListDataSourcesRequest": { + "type": "structure", + "members": { + "apiId": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The API ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.appsync#PaginationToken", + "traits": { + "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which you can use to return the\n next set of items in the list.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.appsync#MaxResults", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The maximum number of results that you want the request to return.
", + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appsync#ListDataSourcesResponse": { + "type": "structure", + "members": { + "dataSources": { + "target": "com.amazonaws.appsync#DataSources", + "traits": { + "smithy.api#documentation": "The DataSource objects.
An identifier to pass in the next request to this operation to return the next set of items in the\n list.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appsync#ListDomainNames": { + "type": "operation", + "input": { + "target": "com.amazonaws.appsync#ListDomainNamesRequest" + }, + "output": { + "target": "com.amazonaws.appsync#ListDomainNamesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appsync#AccessDeniedException" + }, + { + "target": "com.amazonaws.appsync#BadRequestException" + }, + { + "target": "com.amazonaws.appsync#InternalFailureException" + } + ], + "traits": { + "smithy.api#documentation": "Lists multiple custom domain names.
", + "smithy.api#http": { + "method": "GET", + "uri": "/v1/domainnames", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "domainNameConfigs", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.appsync#ListDomainNamesRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.appsync#PaginationToken", + "traits": { + "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which you can use to return the\n next set of items in the list.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.appsync#MaxResults", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The maximum number of results that you want the request to return.
", + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appsync#ListDomainNamesResponse": { + "type": "structure", + "members": { + "domainNameConfigs": { + "target": "com.amazonaws.appsync#DomainNameConfigs", + "traits": { + "smithy.api#documentation": "Lists configurations for multiple domain names.
" + } + }, + "nextToken": { + "target": "com.amazonaws.appsync#PaginationToken", + "traits": { + "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which you can use to return the\n next set of items in the list.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appsync#ListFunctions": { + "type": "operation", + "input": { + "target": "com.amazonaws.appsync#ListFunctionsRequest" + }, + "output": { + "target": "com.amazonaws.appsync#ListFunctionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appsync#BadRequestException" + }, + { + "target": "com.amazonaws.appsync#InternalFailureException" + }, + { + "target": "com.amazonaws.appsync#NotFoundException" + }, + { + "target": "com.amazonaws.appsync#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "List multiple functions.
", + "smithy.api#http": { + "method": "GET", + "uri": "/v1/apis/{apiId}/functions", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "functions", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.appsync#ListFunctionsRequest": { + "type": "structure", + "members": { + "apiId": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The GraphQL API ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.appsync#PaginationToken", + "traits": { + "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which you can use to return the\n next set of items in the list.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.appsync#MaxResults", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The maximum number of results that you want the request to return.
", + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appsync#ListFunctionsResponse": { + "type": "structure", + "members": { + "functions": { + "target": "com.amazonaws.appsync#Functions", + "traits": { + "smithy.api#documentation": "A list of Function objects.
An identifier that was returned from the previous call to this operation, which you can use to return the\n next set of items in the list.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appsync#ListGraphqlApis": { + "type": "operation", + "input": { + "target": "com.amazonaws.appsync#ListGraphqlApisRequest" + }, + "output": { + "target": "com.amazonaws.appsync#ListGraphqlApisResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appsync#BadRequestException" + }, + { + "target": "com.amazonaws.appsync#InternalFailureException" + }, + { + "target": "com.amazonaws.appsync#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Lists your GraphQL APIs.
", + "smithy.api#http": { + "method": "GET", + "uri": "/v1/apis", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "graphqlApis", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.appsync#ListGraphqlApisRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.appsync#PaginationToken", + "traits": { + "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which you can use to return the\n next set of items in the list.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.appsync#MaxResults", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The maximum number of results that you want the request to return.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "apiType": { + "target": "com.amazonaws.appsync#GraphQLApiType", + "traits": { + "smithy.api#documentation": "The value that indicates whether the GraphQL API is a standard API (GRAPHQL) or merged API\n (MERGED).
The account owner of the GraphQL API.
", + "smithy.api#httpQuery": "owner" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appsync#ListGraphqlApisResponse": { + "type": "structure", + "members": { + "graphqlApis": { + "target": "com.amazonaws.appsync#GraphqlApis", + "traits": { + "smithy.api#documentation": "The GraphqlApi objects.
An identifier to pass in the next request to this operation to return the next set of items in the\n list.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appsync#ListResolvers": { + "type": "operation", + "input": { + "target": "com.amazonaws.appsync#ListResolversRequest" + }, + "output": { + "target": "com.amazonaws.appsync#ListResolversResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appsync#BadRequestException" + }, + { + "target": "com.amazonaws.appsync#InternalFailureException" + }, + { + "target": "com.amazonaws.appsync#NotFoundException" + }, + { + "target": "com.amazonaws.appsync#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the resolvers for a given API and type.
", + "smithy.api#http": { + "method": "GET", + "uri": "/v1/apis/{apiId}/types/{typeName}/resolvers", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "resolvers", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.appsync#ListResolversByFunction": { + "type": "operation", + "input": { + "target": "com.amazonaws.appsync#ListResolversByFunctionRequest" + }, + "output": { + "target": "com.amazonaws.appsync#ListResolversByFunctionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appsync#BadRequestException" + }, + { + "target": "com.amazonaws.appsync#InternalFailureException" + }, + { + "target": "com.amazonaws.appsync#NotFoundException" + }, + { + "target": "com.amazonaws.appsync#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "List the resolvers that are associated with a specific function.
", + "smithy.api#http": { + "method": "GET", + "uri": "/v1/apis/{apiId}/functions/{functionId}/resolvers", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "resolvers", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.appsync#ListResolversByFunctionRequest": { + "type": "structure", + "members": { + "apiId": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The API ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "functionId": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The function ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.appsync#PaginationToken", + "traits": { + "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which you can use to return the\n next set of items in the list.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.appsync#MaxResults", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The maximum number of results that you want the request to return.
", + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appsync#ListResolversByFunctionResponse": { + "type": "structure", + "members": { + "resolvers": { + "target": "com.amazonaws.appsync#Resolvers", + "traits": { + "smithy.api#documentation": "The list of resolvers.
" + } + }, + "nextToken": { + "target": "com.amazonaws.appsync#PaginationToken", + "traits": { + "smithy.api#documentation": "An identifier that you can use to return the next set of items in the list.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appsync#ListResolversRequest": { + "type": "structure", + "members": { + "apiId": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The API ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "typeName": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The type name.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.appsync#PaginationToken", + "traits": { + "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which you can use to return the\n next set of items in the list.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.appsync#MaxResults", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The maximum number of results that you want the request to return.
", + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appsync#ListResolversResponse": { + "type": "structure", + "members": { + "resolvers": { + "target": "com.amazonaws.appsync#Resolvers", + "traits": { + "smithy.api#documentation": "The Resolver objects.
An identifier to pass in the next request to this operation to return the next set of items in the\n list.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appsync#ListSourceApiAssociations": { + "type": "operation", + "input": { + "target": "com.amazonaws.appsync#ListSourceApiAssociationsRequest" + }, + "output": { + "target": "com.amazonaws.appsync#ListSourceApiAssociationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appsync#BadRequestException" + }, + { + "target": "com.amazonaws.appsync#InternalFailureException" + }, + { + "target": "com.amazonaws.appsync#NotFoundException" + }, + { + "target": "com.amazonaws.appsync#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the SourceApiAssociationSummary data.
The API ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.appsync#PaginationToken", + "traits": { + "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which you can use to return the\n next set of items in the list.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.appsync#MaxResults", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The maximum number of results that you want the request to return.
", + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appsync#ListSourceApiAssociationsResponse": { + "type": "structure", + "members": { + "sourceApiAssociationSummaries": { + "target": "com.amazonaws.appsync#SourceApiAssociationSummaryList", + "traits": { + "smithy.api#documentation": "The SourceApiAssociationSummary object data.
An identifier that was returned from the previous call to this operation, which you can use to return the\n next set of items in the list.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appsync#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.appsync#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.appsync#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appsync#AccessDeniedException" + }, + { + "target": "com.amazonaws.appsync#BadRequestException" + }, + { + "target": "com.amazonaws.appsync#InternalFailureException" + }, + { + "target": "com.amazonaws.appsync#LimitExceededException" + }, + { + "target": "com.amazonaws.appsync#NotFoundException" + }, + { + "target": "com.amazonaws.appsync#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the tags for a resource.
", + "smithy.api#http": { + "method": "GET", + "uri": "/v1/tags/{resourceArn}", + "code": 200 + } + } + }, + "com.amazonaws.appsync#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.appsync#ResourceArn", + "traits": { + "smithy.api#documentation": "The GraphqlApi Amazon Resource Name (ARN).
A TagMap object.
Lists the types for a given API.
", + "smithy.api#http": { + "method": "GET", + "uri": "/v1/apis/{apiId}/types", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "types", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.appsync#ListTypesByAssociation": { + "type": "operation", + "input": { + "target": "com.amazonaws.appsync#ListTypesByAssociationRequest" + }, + "output": { + "target": "com.amazonaws.appsync#ListTypesByAssociationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appsync#BadRequestException" + }, + { + "target": "com.amazonaws.appsync#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.appsync#InternalFailureException" + }, + { + "target": "com.amazonaws.appsync#NotFoundException" + }, + { + "target": "com.amazonaws.appsync#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Lists Type objects by the source API association ID.
The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged\n APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs\n in other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "associationId": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The ID generated by the AppSync service for the source API association.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "format": { + "target": "com.amazonaws.appsync#TypeDefinitionFormat", + "traits": { + "smithy.api#documentation": "The format type.
", + "smithy.api#httpQuery": "format", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.appsync#PaginationToken", + "traits": { + "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which you can use to return the\n next set of items in the list.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.appsync#MaxResults", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The maximum number of results that you want the request to return.
", + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appsync#ListTypesByAssociationResponse": { + "type": "structure", + "members": { + "types": { + "target": "com.amazonaws.appsync#TypeList", + "traits": { + "smithy.api#documentation": "The Type objects.
An identifier that was returned from the previous call to this operation, which you can use to return the\n next set of items in the list.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appsync#ListTypesRequest": { + "type": "structure", + "members": { + "apiId": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The API ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "format": { + "target": "com.amazonaws.appsync#TypeDefinitionFormat", + "traits": { + "smithy.api#documentation": "The type format: SDL or JSON.
", + "smithy.api#httpQuery": "format", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.appsync#PaginationToken", + "traits": { + "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which you can use to return the\n next set of items in the list.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.appsync#MaxResults", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The maximum number of results that you want the request to return.
", + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appsync#ListTypesResponse": { + "type": "structure", + "members": { + "types": { + "target": "com.amazonaws.appsync#TypeList", + "traits": { + "smithy.api#documentation": "The Type objects.
An identifier to pass in the next request to this operation to return the next set of items in the\n list.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appsync#LogConfig": { + "type": "structure", + "members": { + "fieldLogLevel": { + "target": "com.amazonaws.appsync#FieldLogLevel", + "traits": { + "smithy.api#documentation": "The field logging level. Values can be NONE, ERROR, INFO, DEBUG, or ALL.
\n\n NONE: No field-level logs are captured.
\n\n ERROR: Logs the following information\n only for the fields that are in the error\n category:
\nThe error section in the server response.
\nField-level errors.
\nThe generated request/response functions that got resolved for error fields.
\n\n INFO: Logs the following information only for the fields that are in the info and error\n categories:
\nInfo-level messages.
\nThe user messages sent through $util.log.info and\n console.log.
Field-level tracing and mapping logs are not shown.
\n\n DEBUG: Logs the following information\n only for the fields that are in the debug, info,\n and error categories:
\nDebug-level messages.
\nThe user messages sent through $util.log.info,\n $util.log.debug, console.log, and\n console.debug.
Field-level tracing and mapping logs are not shown.
\n\n ALL: The following information is logged for all fields in the\n query:
\nField-level tracing information.
\nThe generated request/response functions that were resolved for each\n field.
\nThe service role that AppSync assumes to publish to CloudWatch logs in your\n account.
", + "smithy.api#required": {} + } + }, + "excludeVerboseContent": { + "target": "com.amazonaws.appsync#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Set to TRUE to exclude sections that contain information such as headers, context, and evaluated mapping\n templates, regardless of logging level.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The Amazon CloudWatch Logs configuration.
" + } + }, + "com.amazonaws.appsync#Logs": { + "type": "list", + "member": { + "target": "com.amazonaws.appsync#String" + } + }, + "com.amazonaws.appsync#Long": { + "type": "long", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.appsync#MapOfStringToString": { + "type": "map", + "key": { + "target": "com.amazonaws.appsync#String" + }, + "value": { + "target": "com.amazonaws.appsync#String" + } + }, + "com.amazonaws.appsync#MappingTemplate": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 65536 + }, + "smithy.api#pattern": "^.*$" + } + }, + "com.amazonaws.appsync#MaxBatchSize": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0, + "max": 2000 + } + } + }, + "com.amazonaws.appsync#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0, + "max": 25 + } + } + }, + "com.amazonaws.appsync#MergeType": { + "type": "enum", + "members": { + "MANUAL_MERGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MANUAL_MERGE" + } + }, + "AUTO_MERGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTO_MERGE" + } + } + } + }, + "com.amazonaws.appsync#NotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.appsync#String" + } + }, + "traits": { + "smithy.api#documentation": "The resource specified in the request was not found. Check the resource, and then try again.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.appsync#OpenIDConnectConfig": { + "type": "structure", + "members": { + "issuer": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The issuer for the OIDC configuration. The issuer returned by discovery must exactly match the value of\n iss in the ID token.
The client identifier of the relying party at the OpenID identity provider. This identifier is typically\n obtained when the relying party is registered with the OpenID identity provider. You can specify a regular\n expression so that AppSync can validate against multiple client identifiers at a time.
" + } + }, + "iatTTL": { + "target": "com.amazonaws.appsync#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The number of milliseconds that a token is valid after it's issued to a user.
" + } + }, + "authTTL": { + "target": "com.amazonaws.appsync#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The number of milliseconds that a token is valid after being authenticated.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes an OpenID Connect (OIDC) configuration.
" + } + }, + "com.amazonaws.appsync#OpenSearchServiceDataSourceConfig": { + "type": "structure", + "members": { + "endpoint": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The endpoint.
", + "smithy.api#required": {} + } + }, + "awsRegion": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The Amazon Web Services Region.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Describes an OpenSearch data source configuration.
" + } + }, + "com.amazonaws.appsync#OperationLevelMetricsConfig": { + "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.appsync#OutputType": { + "type": "enum", + "members": { + "SDL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SDL" + } + }, + "JSON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JSON" + } + } + } + }, + "com.amazonaws.appsync#Ownership": { + "type": "enum", + "members": { + "CURRENT_ACCOUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CURRENT_ACCOUNT" + } + }, + "OTHER_ACCOUNTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OTHER_ACCOUNTS" + } + } + } + }, + "com.amazonaws.appsync#PaginationToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 65536 + }, + "smithy.api#pattern": "^[\\\\S]+$" + } + }, + "com.amazonaws.appsync#PipelineConfig": { + "type": "structure", + "members": { + "functions": { + "target": "com.amazonaws.appsync#FunctionsIds", + "traits": { + "smithy.api#documentation": "A list of Function objects.
The pipeline configuration for a resolver of kind PIPELINE.
Creates a list of environmental variables in an API by its ID value.
\nWhen creating an environmental variable, it must follow the constraints below:
\nBoth JavaScript and VTL templates support environmental variables.
\nEnvironmental variables are not evaluated before function invocation.
\nEnvironmental variables only support string values.
\nAny defined value in an environmental variable is considered a string literal and not\n expanded.
\nVariable evaluations should ideally be performed in the function code.
\nWhen creating an environmental variable key-value pair, it must follow the additional constraints\n below:
\nKeys must begin with a letter.
\nKeys must be at least two characters long.
\nKeys can only contain letters, numbers, and the underscore character (_).
\nValues can be up to 512 characters long.
\nYou can configure up to 50 key-value pairs in a GraphQL API.
\nYou can create a list of environmental variables by adding it to the environmentVariables\n payload as a list in the format {\"key1\":\"value1\",\"key2\":\"value2\", …}. Note that each call of the\n PutGraphqlApiEnvironmentVariables action will result in the overwriting of the existing\n environmental variable list of that API. This means the existing environmental variables will be lost. To avoid\n this, you must include all existing and new environmental variables in the list each time you call this\n action.
The ID of the API to which the environmental variable list will be written.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "environmentVariables": { + "target": "com.amazonaws.appsync#EnvironmentVariableMap", + "traits": { + "smithy.api#documentation": "The list of environmental variables to add to the API.
\nWhen creating an environmental variable key-value pair, it must follow the additional constraints\n below:
\nKeys must begin with a letter.
\nKeys must be at least two characters long.
\nKeys can only contain letters, numbers, and the underscore character (_).
\nValues can be up to 512 characters long.
\nYou can configure up to 50 key-value pairs in a GraphQL API.
\nYou can create a list of environmental variables by adding it to the environmentVariables\n payload as a list in the format {\"key1\":\"value1\",\"key2\":\"value2\", …}. Note that each call of the\n PutGraphqlApiEnvironmentVariables action will result in the overwriting of the existing\n environmental variable list of that API. This means the existing environmental variables will be lost. To avoid\n this, you must include all existing and new environmental variables in the list each time you call this\n action.
The payload containing each environmental variable in the \"key\" : \"value\" format.
The resource ARN of the RDS cluster.
", + "smithy.api#required": {} + } + }, + "secretArn": { + "target": "com.amazonaws.appsync#RdsDataApiConfigSecretArn", + "traits": { + "smithy.api#documentation": "The secret's ARN that was obtained from Secrets Manager. A secret consists of secret information, the secret\n value, plus metadata about the secret. A secret value can be a string or binary. It typically includes the ARN,\n secret name and description, policies, tags, encryption key from the Key Management Service, and key rotation\n data.
", + "smithy.api#required": {} + } + }, + "databaseName": { + "target": "com.amazonaws.appsync#RdsDataApiConfigDatabaseName", + "traits": { + "smithy.api#documentation": "The name of the database in the cluster.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the metadata required to introspect the RDS cluster.
" + } + }, + "com.amazonaws.appsync#RdsDataApiConfigDatabaseName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.appsync#RdsDataApiConfigResourceArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:[a-z-]*:rds:[a-z0-9-]*:\\d{12}:cluster:[0-9A-Za-z_/-]*$" + } + }, + "com.amazonaws.appsync#RdsDataApiConfigSecretArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:[a-z-]*:secretsmanager:[a-z0-9-]*:\\d{12}:secret:[0-9A-Za-z_/+=.@!-]*$" + } + }, + "com.amazonaws.appsync#RdsHttpEndpointConfig": { + "type": "structure", + "members": { + "awsRegion": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "Amazon Web Services Region for Amazon RDS HTTP endpoint.
" + } + }, + "dbClusterIdentifier": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "Amazon RDS cluster Amazon Resource Name (ARN).
" + } + }, + "databaseName": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "Logical database name.
" + } + }, + "schema": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "Logical schema name.
" + } + }, + "awsSecretStoreArn": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "Amazon Web Services secret store Amazon Resource Name (ARN) for database credentials.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The Amazon Relational Database Service (Amazon RDS) HTTP endpoint configuration.
" + } + }, + "com.amazonaws.appsync#RelationalDatabaseDataSourceConfig": { + "type": "structure", + "members": { + "relationalDatabaseSourceType": { + "target": "com.amazonaws.appsync#RelationalDatabaseSourceType", + "traits": { + "smithy.api#documentation": "Source type for the relational database.
\n\n RDS_HTTP_ENDPOINT: The relational database source type is an\n Amazon Relational Database Service (Amazon RDS) HTTP endpoint.
\nAmazon RDS HTTP endpoint settings.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes a relational database data source configuration.
" + } + }, + "com.amazonaws.appsync#RelationalDatabaseSourceType": { + "type": "enum", + "members": { + "RDS_HTTP_ENDPOINT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RDS_HTTP_ENDPOINT" + } + } + } + }, + "com.amazonaws.appsync#Resolver": { + "type": "structure", + "members": { + "typeName": { + "target": "com.amazonaws.appsync#ResourceName", + "traits": { + "smithy.api#documentation": "The resolver type name.
" + } + }, + "fieldName": { + "target": "com.amazonaws.appsync#ResourceName", + "traits": { + "smithy.api#documentation": "The resolver field name.
" + } + }, + "dataSourceName": { + "target": "com.amazonaws.appsync#ResourceName", + "traits": { + "smithy.api#documentation": "The resolver data source name.
" + } + }, + "resolverArn": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The resolver Amazon Resource Name (ARN).
" + } + }, + "requestMappingTemplate": { + "target": "com.amazonaws.appsync#MappingTemplate", + "traits": { + "smithy.api#documentation": "The request mapping template.
" + } + }, + "responseMappingTemplate": { + "target": "com.amazonaws.appsync#MappingTemplate", + "traits": { + "smithy.api#documentation": "The response mapping template.
" + } + }, + "kind": { + "target": "com.amazonaws.appsync#ResolverKind", + "traits": { + "smithy.api#documentation": "The resolver type.
\n\n UNIT: A UNIT resolver type. A UNIT resolver is the default\n resolver type. You can use a UNIT resolver to run a GraphQL query against a single data source.
\n\n PIPELINE: A PIPELINE resolver type. You can use a PIPELINE\n resolver to invoke a series of Function objects in a serial manner. You can use a pipeline\n resolver to run a GraphQL query against multiple data sources.
The PipelineConfig.
The SyncConfig for a resolver attached to a versioned data source.
The caching configuration for the resolver.
" + } + }, + "maxBatchSize": { + "target": "com.amazonaws.appsync#MaxBatchSize", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The maximum batching size for a resolver.
" + } + }, + "runtime": { + "target": "com.amazonaws.appsync#AppSyncRuntime" + }, + "code": { + "target": "com.amazonaws.appsync#Code", + "traits": { + "smithy.api#documentation": "The resolver code that contains the request and response functions. When code is used, the\n runtime is required. The runtime value must be APPSYNC_JS.
Enables or disables enhanced resolver metrics for specified resolvers. Note that metricsConfig\n won't be used unless the resolverLevelMetricsBehavior value is set to\n PER_RESOLVER_METRICS. If the resolverLevelMetricsBehavior is set to\n FULL_REQUEST_RESOLVER_METRICS instead, metricsConfig will be ignored. However, you\n can still set its value.
\n metricsConfig can be ENABLED or DISABLED.
Describes a resolver.
" + } + }, + "com.amazonaws.appsync#ResolverCountLimit": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0, + "max": 10000 + } + } + }, + "com.amazonaws.appsync#ResolverKind": { + "type": "enum", + "members": { + "UNIT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNIT" + } + }, + "PIPELINE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PIPELINE" + } + } + } + }, + "com.amazonaws.appsync#ResolverLevelMetricsBehavior": { + "type": "enum", + "members": { + "FULL_REQUEST_RESOLVER_METRICS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FULL_REQUEST_RESOLVER_METRICS" + } + }, + "PER_RESOLVER_METRICS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PER_RESOLVER_METRICS" + } + } + } + }, + "com.amazonaws.appsync#ResolverLevelMetricsConfig": { + "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.appsync#Resolvers": { + "type": "list", + "member": { + "target": "com.amazonaws.appsync#Resolver" + } + }, + "com.amazonaws.appsync#ResourceArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 70, + "max": 75 + }, + "smithy.api#pattern": "^arn:aws:appsync:[A-Za-z0-9_/.-]{0,63}:\\d{12}:apis/[0-9A-Za-z_-]{26}$" + } + }, + "com.amazonaws.appsync#ResourceName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 65536 + }, + "smithy.api#pattern": "^[_A-Za-z][_0-9A-Za-z]*$" + } + }, + "com.amazonaws.appsync#RuntimeName": { + "type": "enum", + "members": { + "APPSYNC_JS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "APPSYNC_JS" + } + } + } + }, + "com.amazonaws.appsync#SchemaStatus": { + "type": "enum", + "members": { + "Processing": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROCESSING" + } + }, + "Active": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "Deleting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "Success": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCESS" + } + }, + "NotApplicable": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_APPLICABLE" + } + } + } + }, + "com.amazonaws.appsync#SourceApiAssociation": { + "type": "structure", + "members": { + "associationId": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The ID generated by the AppSync service for the source API association.
" + } + }, + "associationArn": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the source API association.
" + } + }, + "sourceApiId": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The ID of the AppSync source API.
" + } + }, + "sourceApiArn": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AppSync source API.
" + } + }, + "mergedApiArn": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AppSync Merged API.
" + } + }, + "mergedApiId": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The ID of the AppSync Merged API.
" + } + }, + "description": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The description field.
" + } + }, + "sourceApiAssociationConfig": { + "target": "com.amazonaws.appsync#SourceApiAssociationConfig", + "traits": { + "smithy.api#documentation": "The SourceApiAssociationConfig object data.
The state of the source API association.
" + } + }, + "sourceApiAssociationStatusDetail": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The detailed message related to the current state of the source API association.
" + } + }, + "lastSuccessfulMergeDate": { + "target": "com.amazonaws.appsync#Date", + "traits": { + "smithy.api#documentation": "The datetime value of the last successful merge of the source API association. The result will be in UTC\n format and your local time zone.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the configuration of a source API. A source API is a GraphQL API that is linked to a merged API.\n There can be multiple source APIs attached to each merged API. When linked to a merged API, the source API's\n schema, data sources, and resolvers will be combined with other linked source API data to form a new, singular\n API.
\nSource APIs can originate from your account or from other accounts via Amazon Web Services Resource Access\n Manager. For more information about sharing resources from other accounts, see What is Amazon Web Services Resource\n Access Manager? in the Amazon Web Services Resource Access Manager guide.
" + } + }, + "com.amazonaws.appsync#SourceApiAssociationConfig": { + "type": "structure", + "members": { + "mergeType": { + "target": "com.amazonaws.appsync#MergeType", + "traits": { + "smithy.api#documentation": "The property that indicates which merging option is enabled in the source API association.
\nValid merge types are MANUAL_MERGE (default) and AUTO_MERGE. Manual merges are the\n default behavior and require the user to trigger any changes from the source APIs to the merged API manually.\n Auto merges subscribe the merged API to the changes performed on the source APIs so that any change in the\n source APIs are also made to the merged API. Auto merges use MergedApiExecutionRoleArn to perform\n merge operations.
Describes properties used to specify configurations related to a source API.
" + } + }, + "com.amazonaws.appsync#SourceApiAssociationStatus": { + "type": "enum", + "members": { + "MERGE_SCHEDULED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MERGE_SCHEDULED" + } + }, + "MERGE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MERGE_FAILED" + } + }, + "MERGE_SUCCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MERGE_SUCCESS" + } + }, + "MERGE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MERGE_IN_PROGRESS" + } + }, + "AUTO_MERGE_SCHEDULE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTO_MERGE_SCHEDULE_FAILED" + } + }, + "DELETION_SCHEDULED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETION_SCHEDULED" + } + }, + "DELETION_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETION_IN_PROGRESS" + } + }, + "DELETION_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETION_FAILED" + } + } + } + }, + "com.amazonaws.appsync#SourceApiAssociationSummary": { + "type": "structure", + "members": { + "associationId": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The ID generated by the AppSync service for the source API association.
" + } + }, + "associationArn": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the source API association.
" + } + }, + "sourceApiId": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The ID of the AppSync source API.
" + } + }, + "sourceApiArn": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AppSync Source API.
" + } + }, + "mergedApiId": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The ID of the AppSync Merged API.
" + } + }, + "mergedApiArn": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AppSync Merged API.
" + } + }, + "description": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The description field.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the ARNs and IDs of associations, Merged APIs, and source APIs.
" + } + }, + "com.amazonaws.appsync#SourceApiAssociationSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.appsync#SourceApiAssociationSummary" + } + }, + "com.amazonaws.appsync#StartDataSourceIntrospection": { + "type": "operation", + "input": { + "target": "com.amazonaws.appsync#StartDataSourceIntrospectionRequest" + }, + "output": { + "target": "com.amazonaws.appsync#StartDataSourceIntrospectionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appsync#BadRequestException" + }, + { + "target": "com.amazonaws.appsync#InternalFailureException" + }, + { + "target": "com.amazonaws.appsync#NotFoundException" + }, + { + "target": "com.amazonaws.appsync#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a new introspection. Returns the introspectionId of the new introspection after its\n creation.
The rdsDataApiConfig object data.
The introspection ID. Each introspection contains a unique ID that can be used to reference the\n instrospection record.
" + } + }, + "introspectionStatus": { + "target": "com.amazonaws.appsync#DataSourceIntrospectionStatus", + "traits": { + "smithy.api#documentation": "The status of the introspection during creation. By default, when a new instrospection has been created, the\n status will be set to PROCESSING. Once the operation has been completed, the status will change to\n SUCCESS or FAILED depending on how the data was parsed. A FAILED\n operation will return an error and its details as an introspectionStatusDetail.
The error detail field. When a FAILED\n introspectionStatus is returned, the introspectionStatusDetail will also return the\n exact error that was generated during the operation.
Adds a new schema to your GraphQL API.
\nThis operation is asynchronous. Use to determine when it has\n completed.
", + "smithy.api#http": { + "method": "POST", + "uri": "/v1/apis/{apiId}/schemacreation", + "code": 200 + } + } + }, + "com.amazonaws.appsync#StartSchemaCreationRequest": { + "type": "structure", + "members": { + "apiId": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The API ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "definition": { + "target": "com.amazonaws.appsync#Blob", + "traits": { + "smithy.api#documentation": "The schema definition, in GraphQL schema language format.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appsync#StartSchemaCreationResponse": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.appsync#SchemaStatus", + "traits": { + "smithy.api#documentation": "The current state of the schema (PROCESSING, FAILED, SUCCESS, or NOT_APPLICABLE). When the schema is in the\n ACTIVE state, you can add data.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appsync#StartSchemaMerge": { + "type": "operation", + "input": { + "target": "com.amazonaws.appsync#StartSchemaMergeRequest" + }, + "output": { + "target": "com.amazonaws.appsync#StartSchemaMergeResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appsync#BadRequestException" + }, + { + "target": "com.amazonaws.appsync#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.appsync#InternalFailureException" + }, + { + "target": "com.amazonaws.appsync#NotFoundException" + }, + { + "target": "com.amazonaws.appsync#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Initiates a merge operation. Returns a status that shows the result of the merge operation.
", + "smithy.api#http": { + "method": "POST", + "uri": "/v1/mergedApis/{mergedApiIdentifier}/sourceApiAssociations/{associationId}/merge", + "code": 200 + } + } + }, + "com.amazonaws.appsync#StartSchemaMergeRequest": { + "type": "structure", + "members": { + "associationId": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The ID generated by the AppSync service for the source API association.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "mergedApiIdentifier": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged\n APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs\n in other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appsync#StartSchemaMergeResponse": { + "type": "structure", + "members": { + "sourceApiAssociationStatus": { + "target": "com.amazonaws.appsync#SourceApiAssociationStatus", + "traits": { + "smithy.api#documentation": "The state of the source API association.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appsync#String": { + "type": "string" + }, + "com.amazonaws.appsync#SyncConfig": { + "type": "structure", + "members": { + "conflictHandler": { + "target": "com.amazonaws.appsync#ConflictHandlerType", + "traits": { + "smithy.api#documentation": "The Conflict Resolution strategy to perform in the event of a conflict.
\n\n OPTIMISTIC_CONCURRENCY: Resolve conflicts by rejecting mutations\n when versions don't match the latest version at the server.
\n\n AUTOMERGE: Resolve conflicts with the Automerge conflict\n resolution strategy.
\n\n LAMBDA: Resolve conflicts with an Lambda function\n supplied in the LambdaConflictHandlerConfig.
The Conflict Detection strategy to use.
\n\n VERSION: Detect conflicts based on object versions for this\n resolver.
\n\n NONE: Do not detect conflicts when invoking this\n resolver.
\nThe LambdaConflictHandlerConfig when configuring LAMBDA as the Conflict\n Handler.
Describes a Sync configuration for a resolver.
\nSpecifies which Conflict Detection strategy and Resolution strategy to use when the resolver is\n invoked.
" + } + }, + "com.amazonaws.appsync#TTL": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0, + "max": 3600 + } + } + }, + "com.amazonaws.appsync#TagKey": { + "type": "string", + "traits": { + "smithy.api#documentation": "The key for the tag.
", + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^(?!aws:)[ a-zA-Z+-=._:/]+$" + } + }, + "com.amazonaws.appsync#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.appsync#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.appsync#TagMap": { + "type": "map", + "key": { + "target": "com.amazonaws.appsync#TagKey" + }, + "value": { + "target": "com.amazonaws.appsync#TagValue" + }, + "traits": { + "smithy.api#documentation": "A map with keys of TagKey objects and values of TagValue objects.
Tags a resource with user-supplied tags.
", + "smithy.api#http": { + "method": "POST", + "uri": "/v1/tags/{resourceArn}", + "code": 200 + } + } + }, + "com.amazonaws.appsync#TagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.appsync#ResourceArn", + "traits": { + "smithy.api#documentation": "The GraphqlApi Amazon Resource Name (ARN).
A TagMap object.
The value for the tag.
", + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^[\\s\\w+-=\\.:/@]*$" + } + }, + "com.amazonaws.appsync#Template": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 65536 + }, + "smithy.api#pattern": "^[\\s\\S]*$" + } + }, + "com.amazonaws.appsync#Type": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.appsync#ResourceName", + "traits": { + "smithy.api#documentation": "The type name.
" + } + }, + "description": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The type description.
" + } + }, + "arn": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The type Amazon Resource Name (ARN).
" + } + }, + "definition": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The type definition.
" + } + }, + "format": { + "target": "com.amazonaws.appsync#TypeDefinitionFormat", + "traits": { + "smithy.api#documentation": "The type format: SDL or JSON.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes a type.
" + } + }, + "com.amazonaws.appsync#TypeDefinitionFormat": { + "type": "enum", + "members": { + "SDL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SDL" + } + }, + "JSON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JSON" + } + } + } + }, + "com.amazonaws.appsync#TypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.appsync#Type" + } + }, + "com.amazonaws.appsync#UnauthorizedException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.appsync#String" + } + }, + "traits": { + "smithy.api#documentation": "You aren't authorized to perform this operation.
", + "smithy.api#error": "client", + "smithy.api#httpError": 401 + } + }, + "com.amazonaws.appsync#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.appsync#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.appsync#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appsync#AccessDeniedException" + }, + { + "target": "com.amazonaws.appsync#BadRequestException" + }, + { + "target": "com.amazonaws.appsync#InternalFailureException" + }, + { + "target": "com.amazonaws.appsync#LimitExceededException" + }, + { + "target": "com.amazonaws.appsync#NotFoundException" + }, + { + "target": "com.amazonaws.appsync#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Untags a resource.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/v1/tags/{resourceArn}", + "code": 200 + } + } + }, + "com.amazonaws.appsync#UntagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.appsync#ResourceArn", + "traits": { + "smithy.api#documentation": "The GraphqlApi Amazon Resource Name (ARN).
A list of TagKey objects.
Updates the cache for the GraphQL API.
", + "smithy.api#http": { + "method": "POST", + "uri": "/v1/apis/{apiId}/ApiCaches/update", + "code": 200 + } + } + }, + "com.amazonaws.appsync#UpdateApiCacheRequest": { + "type": "structure", + "members": { + "apiId": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The GraphQL API ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ttl": { + "target": "com.amazonaws.appsync#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "TTL in seconds for cache entries.
\nValid values are 1–3,600 seconds.
", + "smithy.api#required": {} + } + }, + "apiCachingBehavior": { + "target": "com.amazonaws.appsync#ApiCachingBehavior", + "traits": { + "smithy.api#documentation": "Caching behavior.
\n\n FULL_REQUEST_CACHING: All requests are fully cached.
\n\n PER_RESOLVER_CACHING: Individual resolvers that you specify are\n cached.
\nThe cache instance type. Valid values are
\n\n SMALL\n
\n MEDIUM\n
\n LARGE\n
\n XLARGE\n
\n LARGE_2X\n
\n LARGE_4X\n
\n LARGE_8X (not available in all regions)
\n LARGE_12X\n
Historically, instance types were identified by an EC2-style value. As of July 2020, this is deprecated, and the generic identifiers above should be used.
\nThe following legacy instance types are available, but their use is discouraged:
\n\n T2_SMALL: A t2.small instance type.
\n\n T2_MEDIUM: A t2.medium instance type.
\n\n R4_LARGE: A r4.large instance type.
\n\n R4_XLARGE: A r4.xlarge instance type.
\n\n R4_2XLARGE: A r4.2xlarge instance type.
\n\n R4_4XLARGE: A r4.4xlarge instance type.
\n\n R4_8XLARGE: A r4.8xlarge instance type.
\nControls how cache health metrics will be emitted to CloudWatch. Cache health metrics include:
\nNetworkBandwidthOutAllowanceExceeded: The network packets dropped because the throughput exceeded\n the aggregated bandwidth limit. This is useful for diagnosing bottlenecks in a cache\n configuration.
\nEngineCPUUtilization: The CPU utilization (percentage) allocated to the Redis process. This is\n useful for diagnosing bottlenecks in a cache configuration.
\nMetrics will be recorded by API ID. You can set the value to ENABLED or\n DISABLED.
Represents the input of a UpdateApiCache operation.
The ApiCache object.
Represents the output of a UpdateApiCache operation.
Updates an API key. You can update the key as long as it's not deleted.
", + "smithy.api#http": { + "method": "POST", + "uri": "/v1/apis/{apiId}/apikeys/{id}", + "code": 200 + } + } + }, + "com.amazonaws.appsync#UpdateApiKeyRequest": { + "type": "structure", + "members": { + "apiId": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The ID for the GraphQL API.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The API key ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "A description of the purpose of the API key.
" + } + }, + "expires": { + "target": "com.amazonaws.appsync#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "From the update time, the time after which the API key expires. The date is represented as seconds since the\n epoch. For more information, see .
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appsync#UpdateApiKeyResponse": { + "type": "structure", + "members": { + "apiKey": { + "target": "com.amazonaws.appsync#ApiKey", + "traits": { + "smithy.api#documentation": "The API key.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appsync#UpdateDataSource": { + "type": "operation", + "input": { + "target": "com.amazonaws.appsync#UpdateDataSourceRequest" + }, + "output": { + "target": "com.amazonaws.appsync#UpdateDataSourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appsync#BadRequestException" + }, + { + "target": "com.amazonaws.appsync#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.appsync#InternalFailureException" + }, + { + "target": "com.amazonaws.appsync#NotFoundException" + }, + { + "target": "com.amazonaws.appsync#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Updates a DataSource object.
The API ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.appsync#ResourceName", + "traits": { + "smithy.api#documentation": "The new name for the data source.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The new description for the data source.
" + } + }, + "type": { + "target": "com.amazonaws.appsync#DataSourceType", + "traits": { + "smithy.api#documentation": "The new data source type.
", + "smithy.api#required": {} + } + }, + "serviceRoleArn": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The new service role Amazon Resource Name (ARN) for the data source.
" + } + }, + "dynamodbConfig": { + "target": "com.amazonaws.appsync#DynamodbDataSourceConfig", + "traits": { + "smithy.api#documentation": "The new Amazon DynamoDB configuration.
" + } + }, + "lambdaConfig": { + "target": "com.amazonaws.appsync#LambdaDataSourceConfig", + "traits": { + "smithy.api#documentation": "The new Lambda configuration.
" + } + }, + "elasticsearchConfig": { + "target": "com.amazonaws.appsync#ElasticsearchDataSourceConfig", + "traits": { + "smithy.api#documentation": "The new OpenSearch configuration.
\nAs of September 2021, Amazon Elasticsearch service is Amazon OpenSearch Service. This configuration is\n deprecated. Instead, use UpdateDataSourceRequest$openSearchServiceConfig to update an OpenSearch data source.
" + } + }, + "openSearchServiceConfig": { + "target": "com.amazonaws.appsync#OpenSearchServiceDataSourceConfig", + "traits": { + "smithy.api#documentation": "The new OpenSearch configuration.
" + } + }, + "httpConfig": { + "target": "com.amazonaws.appsync#HttpDataSourceConfig", + "traits": { + "smithy.api#documentation": "The new HTTP endpoint configuration.
" + } + }, + "relationalDatabaseConfig": { + "target": "com.amazonaws.appsync#RelationalDatabaseDataSourceConfig", + "traits": { + "smithy.api#documentation": "The new relational database configuration.
" + } + }, + "eventBridgeConfig": { + "target": "com.amazonaws.appsync#EventBridgeDataSourceConfig", + "traits": { + "smithy.api#documentation": "The new Amazon EventBridge settings.
" + } + }, + "metricsConfig": { + "target": "com.amazonaws.appsync#DataSourceLevelMetricsConfig", + "traits": { + "smithy.api#documentation": "Enables or disables enhanced data source metrics for specified data sources. Note that\n metricsConfig won't be used unless the dataSourceLevelMetricsBehavior value is set\n to PER_DATA_SOURCE_METRICS. If the dataSourceLevelMetricsBehavior is set to\n FULL_REQUEST_DATA_SOURCE_METRICS instead, metricsConfig will be ignored. However,\n you can still set its value.
\n metricsConfig can be ENABLED or DISABLED.
The updated DataSource object.
Updates a custom DomainName object.
The domain name.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.appsync#Description", + "traits": { + "smithy.api#documentation": "A description of the DomainName.
The configuration for the DomainName.
Updates a Function object.
The GraphQL API ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.appsync#ResourceName", + "traits": { + "smithy.api#documentation": "The Function name.
The Function description.
The function ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "dataSourceName": { + "target": "com.amazonaws.appsync#ResourceName", + "traits": { + "smithy.api#documentation": "The Function\n DataSource name.
The Function request mapping template. Functions support only the 2018-05-29 version of the\n request mapping template.
The Function request mapping template.
The version of the request mapping template. Currently, the supported value is 2018-05-29. Note\n that when using VTL and mapping templates, the functionVersion is required.
The maximum batching size for a resolver.
" + } + }, + "runtime": { + "target": "com.amazonaws.appsync#AppSyncRuntime" + }, + "code": { + "target": "com.amazonaws.appsync#Code", + "traits": { + "smithy.api#documentation": "The function code that contains the request and response functions. When code is used, the\n runtime is required. The runtime value must be APPSYNC_JS.
The Function object.
Updates a GraphqlApi object.
The API ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The new name for the GraphqlApi object.
The Amazon CloudWatch Logs configuration for the GraphqlApi object.
The new authentication type for the GraphqlApi object.
The new Amazon Cognito user pool configuration for the ~GraphqlApi object.
The OpenID Connect configuration for the GraphqlApi object.
A list of additional authentication providers for the GraphqlApi API.
A flag indicating whether to use X-Ray tracing for the GraphqlApi.
Configuration for Lambda function authorization.
" + } + }, + "mergedApiExecutionRoleArn": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The Identity and Access Management service role ARN for a merged API. The AppSync service assumes this role\n on behalf of the Merged API to validate access to source APIs at runtime and to prompt the\n AUTO_MERGE to update the merged API endpoint with the source API changes automatically.
The owner contact information for an API resource.
\nThis field accepts any string input with a length of 0 - 256 characters.
" + } + }, + "introspectionConfig": { + "target": "com.amazonaws.appsync#GraphQLApiIntrospectionConfig", + "traits": { + "smithy.api#documentation": "Sets the value of the GraphQL API to enable (ENABLED) or disable (DISABLED)\n introspection. If no value is provided, the introspection configuration will be set to ENABLED by\n default. This field will produce an error if the operation attempts to use the introspection feature while this\n field is disabled.
For more information about introspection, see GraphQL\n introspection.
" + } + }, + "queryDepthLimit": { + "target": "com.amazonaws.appsync#QueryDepthLimit", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The maximum depth a query can have in a single request. Depth refers to the amount of nested levels allowed\n in the body of query. The default value is 0 (or unspecified), which indicates there's no depth\n limit. If you set a limit, it can be between 1 and 75 nested levels. This field will\n produce a limit error if the operation falls out of bounds.
Note that fields can still be set to nullable or non-nullable. If a non-nullable field produces an error,\n the error will be thrown upwards to the first nullable field available.
" + } + }, + "resolverCountLimit": { + "target": "com.amazonaws.appsync#ResolverCountLimit", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The maximum number of resolvers that can be invoked in a single request. The default value is 0\n (or unspecified), which will set the limit to 10000. When specified, the limit value can be\n between 1 and 10000. This field will produce a limit error if the operation falls out\n of bounds.
The enhancedMetricsConfig object.
The updated GraphqlApi object.
Updates a Resolver object.
The API ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "typeName": { + "target": "com.amazonaws.appsync#ResourceName", + "traits": { + "smithy.api#documentation": "The new type name.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "fieldName": { + "target": "com.amazonaws.appsync#ResourceName", + "traits": { + "smithy.api#documentation": "The new field name.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "dataSourceName": { + "target": "com.amazonaws.appsync#ResourceName", + "traits": { + "smithy.api#documentation": "The new data source name.
" + } + }, + "requestMappingTemplate": { + "target": "com.amazonaws.appsync#MappingTemplate", + "traits": { + "smithy.api#documentation": "The new request mapping template.
\nA resolver uses a request mapping template to convert a GraphQL expression into a format that a data source\n can understand. Mapping templates are written in Apache Velocity Template Language (VTL).
\nVTL request mapping templates are optional when using an Lambda data source. For all other\n data sources, VTL request and response mapping templates are required.
" + } + }, + "responseMappingTemplate": { + "target": "com.amazonaws.appsync#MappingTemplate", + "traits": { + "smithy.api#documentation": "The new response mapping template.
" + } + }, + "kind": { + "target": "com.amazonaws.appsync#ResolverKind", + "traits": { + "smithy.api#documentation": "The resolver type.
\n\n UNIT: A UNIT resolver type. A UNIT resolver is the default\n resolver type. You can use a UNIT resolver to run a GraphQL query against a single data source.
\n\n PIPELINE: A PIPELINE resolver type. You can use a PIPELINE\n resolver to invoke a series of Function objects in a serial manner. You can use a pipeline\n resolver to run a GraphQL query against multiple data sources.
The PipelineConfig.
The SyncConfig for a resolver attached to a versioned data source.
The caching configuration for the resolver.
" + } + }, + "maxBatchSize": { + "target": "com.amazonaws.appsync#MaxBatchSize", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The maximum batching size for a resolver.
" + } + }, + "runtime": { + "target": "com.amazonaws.appsync#AppSyncRuntime" + }, + "code": { + "target": "com.amazonaws.appsync#Code", + "traits": { + "smithy.api#documentation": "The resolver code that contains the request and response functions. When code is used, the\n runtime is required. The runtime value must be APPSYNC_JS.
Enables or disables enhanced resolver metrics for specified resolvers. Note that metricsConfig\n won't be used unless the resolverLevelMetricsBehavior value is set to\n PER_RESOLVER_METRICS. If the resolverLevelMetricsBehavior is set to\n FULL_REQUEST_RESOLVER_METRICS instead, metricsConfig will be ignored. However, you\n can still set its value.
\n metricsConfig can be ENABLED or DISABLED.
The updated Resolver object.
Updates some of the configuration choices of a particular source API association.
", + "smithy.api#http": { + "method": "POST", + "uri": "/v1/mergedApis/{mergedApiIdentifier}/sourceApiAssociations/{associationId}", + "code": 200 + } + } + }, + "com.amazonaws.appsync#UpdateSourceApiAssociationRequest": { + "type": "structure", + "members": { + "associationId": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The ID generated by the AppSync service for the source API association.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "mergedApiIdentifier": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged\n APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs\n in other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The description field.
" + } + }, + "sourceApiAssociationConfig": { + "target": "com.amazonaws.appsync#SourceApiAssociationConfig", + "traits": { + "smithy.api#documentation": "The SourceApiAssociationConfig object data.
The SourceApiAssociation object data.
Updates a Type object.
The API ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "typeName": { + "target": "com.amazonaws.appsync#ResourceName", + "traits": { + "smithy.api#documentation": "The new type name.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "definition": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The new definition.
" + } + }, + "format": { + "target": "com.amazonaws.appsync#TypeDefinitionFormat", + "traits": { + "smithy.api#documentation": "The new type format: SDL or JSON.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appsync#UpdateTypeResponse": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.appsync#Type", + "traits": { + "smithy.api#documentation": "The updated Type object.
The user pool ID.
", + "smithy.api#required": {} + } + }, + "awsRegion": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The Amazon Web Services Region in which the user pool was created.
", + "smithy.api#required": {} + } + }, + "defaultAction": { + "target": "com.amazonaws.appsync#DefaultAction", + "traits": { + "smithy.api#documentation": "The action that you want your GraphQL API to take when a request that uses Amazon Cognito user pool\n authentication doesn't match the Amazon Cognito user pool configuration.
", + "smithy.api#required": {} + } + }, + "appIdClientRegex": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "A regular expression for validating the incoming Amazon Cognito user pool app client ID. If this value\n isn't set, no filtering is applied.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes an Amazon Cognito user pool configuration.
" + } } - }, - "traits": { - "smithy.api#documentation": "Describes an Amazon Cognito user pool configuration.
" - } } - } } diff --git a/codegen/sdk-codegen/aws-models/bedrock-agent.json b/codegen/sdk-codegen/aws-models/bedrock-agent.json index 1b92d71a7fc6..9d0f318d38b3 100644 --- a/codegen/sdk-codegen/aws-models/bedrock-agent.json +++ b/codegen/sdk-codegen/aws-models/bedrock-agent.json @@ -1,13463 +1,13646 @@ { - "smithy": "2.0", - "shapes": { - "com.amazonaws.bedrockagent#APISchema": { - "type": "union", - "members": { - "s3": { - "target": "com.amazonaws.bedrockagent#S3Identifier", - "traits": { - "smithy.api#documentation": "Contains details about the S3 object containing the OpenAPI schema for the action group. For more information, see Action group OpenAPI schemas.
" - } - }, - "payload": { - "target": "com.amazonaws.bedrockagent#Payload", - "traits": { - "smithy.api#documentation": "The JSON or YAML-formatted payload defining the OpenAPI schema for the action group. For more information, see Action group OpenAPI schemas.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains details about the OpenAPI schema for the action group. For more information, see Action group OpenAPI schemas. You can either include the schema directly in the payload field or you can upload it to an S3 bucket and specify the S3 bucket location in the s3 field.
The request is denied because of missing access permissions.
", - "smithy.api#error": "client", - "smithy.api#httpError": 403 - } - }, - "com.amazonaws.bedrockagent#ActionGroupExecutor": { - "type": "union", - "members": { - "lambda": { - "target": "com.amazonaws.bedrockagent#LambdaArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.
" - } - }, - "customControl": { - "target": "com.amazonaws.bedrockagent#CustomControlMethod", - "traits": { - "smithy.api#documentation": "To return the action group invocation results directly in the InvokeAgent response, specify RETURN_CONTROL.
Contains details about the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user.
" - } - }, - "com.amazonaws.bedrockagent#ActionGroupResource": { - "type": "resource", - "operations": [ - { - "target": "com.amazonaws.bedrockagent#CreateAgentActionGroup" - }, - { - "target": "com.amazonaws.bedrockagent#DeleteAgentActionGroup" - }, - { - "target": "com.amazonaws.bedrockagent#GetAgentActionGroup" - }, - { - "target": "com.amazonaws.bedrockagent#ListAgentActionGroups" - }, - { - "target": "com.amazonaws.bedrockagent#UpdateAgentActionGroup" - } - ] - }, - "com.amazonaws.bedrockagent#ActionGroupSignature": { - "type": "enum", - "members": { - "AMAZON_USERINPUT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AMAZON.UserInput" - } - }, - "AMAZON_CODEINTERPRETER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AMAZON.CodeInterpreter" - } - } - } - }, - "com.amazonaws.bedrockagent#ActionGroupState": { - "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.bedrockagent#ActionGroupSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrockagent#ActionGroupSummary" - }, - "traits": { - "smithy.api#length": { - "max": 10 - } - } - }, - "com.amazonaws.bedrockagent#ActionGroupSummary": { - "type": "structure", - "members": { - "actionGroupId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the action group.
", - "smithy.api#required": {} - } - }, - "actionGroupName": { - "target": "com.amazonaws.bedrockagent#Name", - "traits": { - "smithy.api#documentation": "The name of the action group.
", - "smithy.api#required": {} - } - }, - "actionGroupState": { - "target": "com.amazonaws.bedrockagent#ActionGroupState", - "traits": { - "smithy.api#documentation": "Specifies whether the action group is available for the agent to invoke or not when\n sending an InvokeAgent\n request.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#Description", - "traits": { - "smithy.api#documentation": "The description of the action group.
" - } - }, - "updatedAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the action group was last updated.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Contains details about an action group.
" - } - }, - "com.amazonaws.bedrockagent#Agent": { - "type": "structure", - "members": { - "agentId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the agent.
", - "smithy.api#required": {} - } - }, - "agentName": { - "target": "com.amazonaws.bedrockagent#Name", - "traits": { - "smithy.api#documentation": "The name of the agent.
", - "smithy.api#required": {} - } - }, - "agentArn": { - "target": "com.amazonaws.bedrockagent#AgentArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the agent.
", - "smithy.api#required": {} - } - }, - "agentVersion": { - "target": "com.amazonaws.bedrockagent#DraftVersion", - "traits": { - "smithy.api#documentation": "The version of the agent.
", - "smithy.api#required": {} - } - }, - "clientToken": { - "target": "com.amazonaws.bedrockagent#ClientToken", - "traits": { - "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
" - } - }, - "instruction": { - "target": "com.amazonaws.bedrockagent#Instruction", - "traits": { - "smithy.api#documentation": "Instructions that tell the agent what it should do and how it should interact with users.
" - } - }, - "agentStatus": { - "target": "com.amazonaws.bedrockagent#AgentStatus", - "traits": { - "smithy.api#documentation": "The status of the agent and whether it is ready for use. The following statuses are possible:
\nCREATING – The agent is being created.
\nPREPARING – The agent is being prepared.
\nPREPARED – The agent is prepared and ready to be invoked.
\nNOT_PREPARED – The agent has been created but not yet prepared.
\nFAILED – The agent API operation failed.
\nUPDATING – The agent is being updated.
\nDELETING – The agent is being deleted.
\nThe foundation model used for orchestration by the agent.
" - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#Description", - "traits": { - "smithy.api#documentation": "The description of the agent.
" - } - }, - "idleSessionTTLInSeconds": { - "target": "com.amazonaws.bedrockagent#SessionTTL", - "traits": { - "smithy.api#documentation": "The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.
\nA user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.
", - "smithy.api#required": {} - } - }, - "agentResourceRoleArn": { - "target": "com.amazonaws.bedrockagent#AgentRoleArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.
", - "smithy.api#required": {} - } - }, - "customerEncryptionKeyArn": { - "target": "com.amazonaws.bedrockagent#KmsKeyArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key that encrypts the agent.
" - } - }, - "createdAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the agent was created.
", - "smithy.api#required": {} - } - }, - "updatedAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the agent was last updated.
", - "smithy.api#required": {} - } - }, - "preparedAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the agent was last prepared.
" - } - }, - "failureReasons": { - "target": "com.amazonaws.bedrockagent#FailureReasons", - "traits": { - "smithy.api#documentation": "Contains reasons that the agent-related API that you invoked failed.
" - } - }, - "recommendedActions": { - "target": "com.amazonaws.bedrockagent#RecommendedActions", - "traits": { - "smithy.api#documentation": "Contains recommended actions to take for the agent-related API that you invoked to succeed.
" - } - }, - "promptOverrideConfiguration": { - "target": "com.amazonaws.bedrockagent#PromptOverrideConfiguration", - "traits": { - "smithy.api#documentation": "Contains configurations to override prompt templates in different parts of an agent sequence. For more information, see Advanced prompts.
" - } - }, - "guardrailConfiguration": { - "target": "com.amazonaws.bedrockagent#GuardrailConfiguration", - "traits": { - "smithy.api#documentation": "Details about the guardrail associated with the agent.
" - } - }, - "memoryConfiguration": { - "target": "com.amazonaws.bedrockagent#MemoryConfiguration", - "traits": { - "smithy.api#documentation": "Contains memory configuration for the agent.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains details about an agent.
" - } - }, - "com.amazonaws.bedrockagent#AgentActionGroup": { - "type": "structure", - "members": { - "agentId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the agent to which the action group belongs.
", - "smithy.api#required": {} - } - }, - "agentVersion": { - "target": "com.amazonaws.bedrockagent#Version", - "traits": { - "smithy.api#documentation": "The version of the agent to which the action group belongs.
", - "smithy.api#required": {} - } - }, - "actionGroupId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the action group.
", - "smithy.api#required": {} - } - }, - "actionGroupName": { - "target": "com.amazonaws.bedrockagent#Name", - "traits": { - "smithy.api#documentation": "The name of the action group.
", - "smithy.api#required": {} - } - }, - "clientToken": { - "target": "com.amazonaws.bedrockagent#ClientToken", - "traits": { - "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
" - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#Description", - "traits": { - "smithy.api#documentation": "The description of the action group.
" - } - }, - "createdAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the action group was created.
", - "smithy.api#required": {} - } - }, - "updatedAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the action group was last updated.
", - "smithy.api#required": {} - } - }, - "parentActionSignature": { - "target": "com.amazonaws.bedrockagent#ActionGroupSignature", - "traits": { - "smithy.api#documentation": "If this field is set as AMAZON.UserInput, the agent can request the user for additional information when trying to complete a task. The description, apiSchema, and actionGroupExecutor fields must be blank for this action group.
During orchestration, if the agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an Observation reprompting the user for more information.
" - } - }, - "actionGroupExecutor": { - "target": "com.amazonaws.bedrockagent#ActionGroupExecutor", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user.
" - } - }, - "apiSchema": { - "target": "com.amazonaws.bedrockagent#APISchema", - "traits": { - "smithy.api#documentation": "Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see Action group OpenAPI schemas.
" - } - }, - "functionSchema": { - "target": "com.amazonaws.bedrockagent#FunctionSchema", - "traits": { - "smithy.api#documentation": "Defines functions that each define parameters that the agent needs to invoke from the user. Each function represents an action in an action group.
" - } - }, - "actionGroupState": { - "target": "com.amazonaws.bedrockagent#ActionGroupState", - "traits": { - "smithy.api#documentation": "Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Contains details about an action group.
" - } - }, - "com.amazonaws.bedrockagent#AgentAlias": { - "type": "structure", - "members": { - "agentId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the agent.
", - "smithy.api#required": {} - } - }, - "agentAliasId": { - "target": "com.amazonaws.bedrockagent#AgentAliasId", - "traits": { - "smithy.api#documentation": "The unique identifier of the alias of the agent.
", - "smithy.api#required": {} - } - }, - "agentAliasName": { - "target": "com.amazonaws.bedrockagent#Name", - "traits": { - "smithy.api#documentation": "The name of the alias of the agent.
", - "smithy.api#required": {} - } - }, - "agentAliasArn": { - "target": "com.amazonaws.bedrockagent#AgentAliasArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the alias of the agent.
", - "smithy.api#required": {} - } - }, - "clientToken": { - "target": "com.amazonaws.bedrockagent#ClientToken", - "traits": { - "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
" - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#Description", - "traits": { - "smithy.api#documentation": "The description of the alias of the agent.
" - } - }, - "routingConfiguration": { - "target": "com.amazonaws.bedrockagent#AgentAliasRoutingConfiguration", - "traits": { - "smithy.api#documentation": "Contains details about the routing configuration of the alias.
", - "smithy.api#required": {} - } - }, - "createdAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the alias of the agent was created.
", - "smithy.api#required": {} - } - }, - "updatedAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the alias was last updated.
", - "smithy.api#required": {} - } - }, - "agentAliasHistoryEvents": { - "target": "com.amazonaws.bedrockagent#AgentAliasHistoryEvents", - "traits": { - "smithy.api#documentation": "Contains details about the history of the alias.
" - } - }, - "agentAliasStatus": { - "target": "com.amazonaws.bedrockagent#AgentAliasStatus", - "traits": { - "smithy.api#documentation": "The status of the alias of the agent and whether it is ready for use. The following statuses are possible:
\nCREATING – The agent alias is being created.
\nPREPARED – The agent alias is finished being created or updated and is ready to be invoked.
\nFAILED – The agent alias API operation failed.
\nUPDATING – The agent alias is being updated.
\nDELETING – The agent alias is being deleted.
\nInformation on the failure of Provisioned Throughput assigned to an agent alias.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains details about an alias of an agent.
" - } - }, - "com.amazonaws.bedrockagent#AgentAliasArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 2048 - }, - "smithy.api#pattern": "^arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:agent-alias/[0-9a-zA-Z]{10}/[0-9a-zA-Z]{10}$" - } - }, - "com.amazonaws.bedrockagent#AgentAliasHistoryEvent": { - "type": "structure", - "members": { - "routingConfiguration": { - "target": "com.amazonaws.bedrockagent#AgentAliasRoutingConfiguration", - "traits": { - "smithy.api#documentation": "Contains details about the version of the agent with which the alias is associated.
" - } - }, - "endDate": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The date that the alias stopped being associated to the version in the routingConfiguration object
The date that the alias began being associated to the version in the routingConfiguration object.
Contains details about the history of the alias.
" - } - }, - "com.amazonaws.bedrockagent#AgentAliasHistoryEvents": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrockagent#AgentAliasHistoryEvent" - }, - "traits": { - "smithy.api#length": { - "max": 10 - } - } - }, - "com.amazonaws.bedrockagent#AgentAliasId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 10, - "max": 10 - }, - "smithy.api#pattern": "^(\\bTSTALIASID\\b|[0-9a-zA-Z]+)$" - } - }, - "com.amazonaws.bedrockagent#AgentAliasRoutingConfiguration": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrockagent#AgentAliasRoutingConfigurationListItem" - }, - "traits": { - "smithy.api#length": { - "max": 1 - } - } - }, - "com.amazonaws.bedrockagent#AgentAliasRoutingConfigurationListItem": { - "type": "structure", - "members": { - "agentVersion": { - "target": "com.amazonaws.bedrockagent#Version", - "traits": { - "smithy.api#documentation": "The version of the agent with which the alias is associated.
" - } - }, - "provisionedThroughput": { - "target": "com.amazonaws.bedrockagent#ProvisionedModelIdentifier", - "traits": { - "smithy.api#documentation": "Information on the Provisioned Throughput assigned to an agent alias.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains details about the routing configuration of the alias.
" - } - }, - "com.amazonaws.bedrockagent#AgentAliasStatus": { - "type": "enum", - "members": { - "CREATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATING" - } - }, - "PREPARED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PREPARED" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - }, - "UPDATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UPDATING" - } - }, - "DELETING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETING" - } - } - } - }, - "com.amazonaws.bedrockagent#AgentAliasSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrockagent#AgentAliasSummary" - }, - "traits": { - "smithy.api#length": { - "max": 10 - } - } - }, - "com.amazonaws.bedrockagent#AgentAliasSummary": { - "type": "structure", - "members": { - "agentAliasId": { - "target": "com.amazonaws.bedrockagent#AgentAliasId", - "traits": { - "smithy.api#documentation": "Contains details about
", - "smithy.api#required": {} - } - }, - "agentAliasName": { - "target": "com.amazonaws.bedrockagent#Name", - "traits": { - "smithy.api#documentation": "The name of the alias.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#Description", - "traits": { - "smithy.api#documentation": "The description of the alias.
" - } - }, - "routingConfiguration": { - "target": "com.amazonaws.bedrockagent#AgentAliasRoutingConfiguration", - "traits": { - "smithy.api#documentation": "Contains details about the version of the agent with which the alias is associated.
" - } - }, - "agentAliasStatus": { - "target": "com.amazonaws.bedrockagent#AgentAliasStatus", - "traits": { - "smithy.api#documentation": "The status of the alias.
", - "smithy.api#required": {} - } - }, - "createdAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the alias of the agent was created.
", - "smithy.api#required": {} - } - }, - "updatedAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the alias was last updated.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Contains details about an alias of an agent.
" - } - }, - "com.amazonaws.bedrockagent#AgentArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 2048 - }, - "smithy.api#pattern": "^arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:agent/[0-9a-zA-Z]{10}$" - } - }, - "com.amazonaws.bedrockagent#AgentFlowNodeConfiguration": { - "type": "structure", - "members": { - "agentAliasArn": { - "target": "com.amazonaws.bedrockagent#AgentAliasArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the alias of the agent to invoke.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Defines an agent node in your flow. You specify the agent to invoke at this point in the flow. For more information, see Node types in Amazon Bedrock works in the Amazon Bedrock User Guide.
" - } - }, - "com.amazonaws.bedrockagent#AgentKnowledgeBase": { - "type": "structure", - "members": { - "agentId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the agent with which the knowledge base is associated.
", - "smithy.api#required": {} - } - }, - "agentVersion": { - "target": "com.amazonaws.bedrockagent#Version", - "traits": { - "smithy.api#documentation": "The version of the agent with which the knowledge base is associated.
", - "smithy.api#required": {} - } - }, - "knowledgeBaseId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the association between the agent and the knowledge base.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#Description", - "traits": { - "smithy.api#documentation": "The description of the association between the agent and the knowledge base.
", - "smithy.api#required": {} - } - }, - "createdAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the association between the agent and the knowledge base was created.
", - "smithy.api#required": {} - } - }, - "updatedAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the association between the agent and the knowledge base was last updated.
", - "smithy.api#required": {} - } - }, - "knowledgeBaseState": { - "target": "com.amazonaws.bedrockagent#KnowledgeBaseState", - "traits": { - "smithy.api#documentation": "Specifies whether to use the knowledge base or not when sending an InvokeAgent request.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Contains details about a knowledge base that is associated with an agent.
" - } - }, - "com.amazonaws.bedrockagent#AgentKnowledgeBaseSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrockagent#AgentKnowledgeBaseSummary" - }, - "traits": { - "smithy.api#length": { - "max": 10 - } - } - }, - "com.amazonaws.bedrockagent#AgentKnowledgeBaseSummary": { - "type": "structure", - "members": { - "knowledgeBaseId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the knowledge base associated with an agent.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#Description", - "traits": { - "smithy.api#documentation": "The description of the knowledge base associated with an agent.
" - } - }, - "knowledgeBaseState": { - "target": "com.amazonaws.bedrockagent#KnowledgeBaseState", - "traits": { - "smithy.api#documentation": "Specifies whether the agent uses the knowledge base or not when sending an InvokeAgent request.
", - "smithy.api#required": {} - } - }, - "updatedAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the knowledge base associated with an agent was last updated.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Contains details about a knowledge base associated with an agent.
" - } - }, - "com.amazonaws.bedrockagent#AgentResource": { - "type": "resource", - "operations": [ - { - "target": "com.amazonaws.bedrockagent#CreateAgent" - }, - { - "target": "com.amazonaws.bedrockagent#DeleteAgent" - }, - { - "target": "com.amazonaws.bedrockagent#GetAgent" - }, - { - "target": "com.amazonaws.bedrockagent#ListAgents" - }, - { - "target": "com.amazonaws.bedrockagent#PrepareAgent" - }, - { - "target": "com.amazonaws.bedrockagent#UpdateAgent" - } - ] - }, - "com.amazonaws.bedrockagent#AgentRoleArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 2048 - }, - "smithy.api#pattern": "^arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/.+$" - } - }, - "com.amazonaws.bedrockagent#AgentStatus": { - "type": "enum", - "members": { - "CREATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATING" - } - }, - "PREPARING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PREPARING" - } - }, - "PREPARED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PREPARED" - } - }, - "NOT_PREPARED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NOT_PREPARED" - } - }, - "DELETING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETING" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - }, - "VERSIONING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VERSIONING" - } - }, - "UPDATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UPDATING" - } - } - } - }, - "com.amazonaws.bedrockagent#AgentSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrockagent#AgentSummary" - }, - "traits": { - "smithy.api#length": { - "max": 10 - } - } - }, - "com.amazonaws.bedrockagent#AgentSummary": { - "type": "structure", - "members": { - "agentId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the agent.
", - "smithy.api#required": {} - } - }, - "agentName": { - "target": "com.amazonaws.bedrockagent#Name", - "traits": { - "smithy.api#documentation": "The name of the agent.
", - "smithy.api#required": {} - } - }, - "agentStatus": { - "target": "com.amazonaws.bedrockagent#AgentStatus", - "traits": { - "smithy.api#documentation": "The status of the agent.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#Description", - "traits": { - "smithy.api#documentation": "The description of the agent.
" - } - }, - "updatedAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the agent was last updated.
", - "smithy.api#required": {} - } - }, - "latestAgentVersion": { - "target": "com.amazonaws.bedrockagent#Version", - "traits": { - "smithy.api#documentation": "The latest version of the agent.
" - } - }, - "guardrailConfiguration": { - "target": "com.amazonaws.bedrockagent#GuardrailConfiguration", - "traits": { - "smithy.api#documentation": "Details about the guardrail associated with the agent.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains details about an agent.
" - } - }, - "com.amazonaws.bedrockagent#AgentVersion": { - "type": "structure", - "members": { - "agentId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the agent that the version belongs to.
", - "smithy.api#required": {} - } - }, - "agentName": { - "target": "com.amazonaws.bedrockagent#Name", - "traits": { - "smithy.api#documentation": "The name of the agent that the version belongs to.
", - "smithy.api#required": {} - } - }, - "agentArn": { - "target": "com.amazonaws.bedrockagent#AgentArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the agent that the version belongs to.
", - "smithy.api#required": {} - } - }, - "version": { - "target": "com.amazonaws.bedrockagent#NumericalVersion", - "traits": { - "smithy.api#documentation": "The version number.
", - "smithy.api#required": {} - } - }, - "instruction": { - "target": "com.amazonaws.bedrockagent#Instruction", - "traits": { - "smithy.api#documentation": "The instructions provided to the agent.
" - } - }, - "agentStatus": { - "target": "com.amazonaws.bedrockagent#AgentStatus", - "traits": { - "smithy.api#documentation": "The status of the agent that the version belongs to.
", - "smithy.api#required": {} - } - }, - "foundationModel": { - "target": "com.amazonaws.bedrockagent#ModelIdentifier", - "traits": { - "smithy.api#documentation": "The foundation model that the version invokes.
" - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#Description", - "traits": { - "smithy.api#documentation": "The description of the version.
" - } - }, - "idleSessionTTLInSeconds": { - "target": "com.amazonaws.bedrockagent#SessionTTL", - "traits": { - "smithy.api#documentation": "The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.
\nA user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.
", - "smithy.api#required": {} - } - }, - "agentResourceRoleArn": { - "target": "com.amazonaws.bedrockagent#AgentRoleArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.
", - "smithy.api#required": {} - } - }, - "customerEncryptionKeyArn": { - "target": "com.amazonaws.bedrockagent#KmsKeyArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key that encrypts the agent.
" - } - }, - "createdAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the version was created.
", - "smithy.api#required": {} - } - }, - "updatedAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the version was last updated.
", - "smithy.api#required": {} - } - }, - "failureReasons": { - "target": "com.amazonaws.bedrockagent#FailureReasons", - "traits": { - "smithy.api#documentation": "A list of reasons that the API operation on the version failed.
" - } - }, - "recommendedActions": { - "target": "com.amazonaws.bedrockagent#RecommendedActions", - "traits": { - "smithy.api#documentation": "A list of recommended actions to take for the failed API operation on the version to succeed.
" - } - }, - "promptOverrideConfiguration": { - "target": "com.amazonaws.bedrockagent#PromptOverrideConfiguration", - "traits": { - "smithy.api#documentation": "Contains configurations to override prompt templates in different parts of an agent sequence. For more information, see Advanced prompts.
" - } - }, - "guardrailConfiguration": { - "target": "com.amazonaws.bedrockagent#GuardrailConfiguration", - "traits": { - "smithy.api#documentation": "Details about the guardrail associated with the agent.
" - } - }, - "memoryConfiguration": { - "target": "com.amazonaws.bedrockagent#MemoryConfiguration", - "traits": { - "smithy.api#documentation": "\n Contains details of the memory configuration on the version of the agent. \n
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains details about a version of an agent.
" - } - }, - "com.amazonaws.bedrockagent#AgentVersionSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrockagent#AgentVersionSummary" - }, - "traits": { - "smithy.api#length": { - "max": 10 - } - } - }, - "com.amazonaws.bedrockagent#AgentVersionSummary": { - "type": "structure", - "members": { - "agentName": { - "target": "com.amazonaws.bedrockagent#Name", - "traits": { - "smithy.api#documentation": "The name of the agent to which the version belongs.
", - "smithy.api#required": {} - } - }, - "agentStatus": { - "target": "com.amazonaws.bedrockagent#AgentStatus", - "traits": { - "smithy.api#documentation": "The status of the agent to which the version belongs.
", - "smithy.api#required": {} - } - }, - "agentVersion": { - "target": "com.amazonaws.bedrockagent#Version", - "traits": { - "smithy.api#documentation": "The version of the agent.
", - "smithy.api#required": {} - } - }, - "createdAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the version was created.
", - "smithy.api#required": {} - } - }, - "updatedAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the version was last updated.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#Description", - "traits": { - "smithy.api#documentation": "The description of the version of the agent.
" - } - }, - "guardrailConfiguration": { - "target": "com.amazonaws.bedrockagent#GuardrailConfiguration", - "traits": { - "smithy.api#documentation": "Details about the guardrail associated with the agent.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains details about a version of an agent.
" - } - }, - "com.amazonaws.bedrockagent#AliasResource": { - "type": "resource", - "operations": [ - { - "target": "com.amazonaws.bedrockagent#CreateAgentAlias" - }, - { - "target": "com.amazonaws.bedrockagent#DeleteAgentAlias" - }, - { - "target": "com.amazonaws.bedrockagent#GetAgentAlias" - }, - { - "target": "com.amazonaws.bedrockagent#ListAgentAliases" - }, - { - "target": "com.amazonaws.bedrockagent#UpdateAgentAlias" - } - ] - }, - "com.amazonaws.bedrockagent#AmazonBedrockAgentBuildTimeLambda": { - "type": "service", - "version": "2023-06-05", - "resources": [ - { - "target": "com.amazonaws.bedrockagent#ActionGroupResource" + "smithy": "2.0", + "shapes": { + "com.amazonaws.bedrockagent#APISchema": { + "type": "union", + "members": { + "s3": { + "target": "com.amazonaws.bedrockagent#S3Identifier", + "traits": { + "smithy.api#documentation": "Contains details about the S3 object containing the OpenAPI schema for the action group. For more information, see Action group OpenAPI schemas.
" + } + }, + "payload": { + "target": "com.amazonaws.bedrockagent#Payload", + "traits": { + "smithy.api#documentation": "The JSON or YAML-formatted payload defining the OpenAPI schema for the action group. For more information, see Action group OpenAPI schemas.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about the OpenAPI schema for the action group. For more information, see Action group OpenAPI schemas. You can either include the schema directly in the payload field or you can upload it to an S3 bucket and specify the S3 bucket location in the s3 field.
The request is denied because of missing access permissions.
", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } }, - { - "target": "com.amazonaws.bedrockagent#AliasResource" + "com.amazonaws.bedrockagent#ActionGroupExecutor": { + "type": "union", + "members": { + "lambda": { + "target": "com.amazonaws.bedrockagent#LambdaArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.
" + } + }, + "customControl": { + "target": "com.amazonaws.bedrockagent#CustomControlMethod", + "traits": { + "smithy.api#documentation": "To return the action group invocation results directly in the InvokeAgent response, specify RETURN_CONTROL.
Contains details about the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user.
" + } }, - { - "target": "com.amazonaws.bedrockagent#DataSourceResource" + "com.amazonaws.bedrockagent#ActionGroupResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrockagent#CreateAgentActionGroup" + }, + { + "target": "com.amazonaws.bedrockagent#DeleteAgentActionGroup" + }, + { + "target": "com.amazonaws.bedrockagent#GetAgentActionGroup" + }, + { + "target": "com.amazonaws.bedrockagent#ListAgentActionGroups" + }, + { + "target": "com.amazonaws.bedrockagent#UpdateAgentActionGroup" + } + ] + }, + "com.amazonaws.bedrockagent#ActionGroupSignature": { + "type": "enum", + "members": { + "AMAZON_USERINPUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AMAZON.UserInput" + } + }, + "AMAZON_CODEINTERPRETER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AMAZON.CodeInterpreter" + } + } + } }, - { - "target": "com.amazonaws.bedrockagent#FlowResource" + "com.amazonaws.bedrockagent#ActionGroupState": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } }, - { - "target": "com.amazonaws.bedrockagent#IngestionJobResource" + "com.amazonaws.bedrockagent#ActionGroupSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#ActionGroupSummary" + }, + "traits": { + "smithy.api#length": { + "max": 10 + } + } }, - { - "target": "com.amazonaws.bedrockagent#KnowledgeBaseResource" + "com.amazonaws.bedrockagent#ActionGroupSummary": { + "type": "structure", + "members": { + "actionGroupId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the action group.
", + "smithy.api#required": {} + } + }, + "actionGroupName": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#documentation": "The name of the action group.
", + "smithy.api#required": {} + } + }, + "actionGroupState": { + "target": "com.amazonaws.bedrockagent#ActionGroupState", + "traits": { + "smithy.api#documentation": "Specifies whether the action group is available for the agent to invoke or not when\n sending an InvokeAgent\n request.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "The description of the action group.
" + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the action group was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about an action group.
" + } }, - { - "target": "com.amazonaws.bedrockagent#PromptResource" + "com.amazonaws.bedrockagent#Agent": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the agent.
", + "smithy.api#required": {} + } + }, + "agentName": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#documentation": "The name of the agent.
", + "smithy.api#required": {} + } + }, + "agentArn": { + "target": "com.amazonaws.bedrockagent#AgentArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the agent.
", + "smithy.api#required": {} + } + }, + "agentVersion": { + "target": "com.amazonaws.bedrockagent#DraftVersion", + "traits": { + "smithy.api#documentation": "The version of the agent.
", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagent#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
" + } + }, + "instruction": { + "target": "com.amazonaws.bedrockagent#Instruction", + "traits": { + "smithy.api#documentation": "Instructions that tell the agent what it should do and how it should interact with users.
" + } + }, + "agentStatus": { + "target": "com.amazonaws.bedrockagent#AgentStatus", + "traits": { + "smithy.api#documentation": "The status of the agent and whether it is ready for use. The following statuses are possible:
\nCREATING – The agent is being created.
\nPREPARING – The agent is being prepared.
\nPREPARED – The agent is prepared and ready to be invoked.
\nNOT_PREPARED – The agent has been created but not yet prepared.
\nFAILED – The agent API operation failed.
\nUPDATING – The agent is being updated.
\nDELETING – The agent is being deleted.
\nThe foundation model used for orchestration by the agent.
" + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "The description of the agent.
" + } + }, + "idleSessionTTLInSeconds": { + "target": "com.amazonaws.bedrockagent#SessionTTL", + "traits": { + "smithy.api#documentation": "The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.
\nA user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.
", + "smithy.api#required": {} + } + }, + "agentResourceRoleArn": { + "target": "com.amazonaws.bedrockagent#AgentRoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.
", + "smithy.api#required": {} + } + }, + "customerEncryptionKeyArn": { + "target": "com.amazonaws.bedrockagent#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key that encrypts the agent.
" + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the agent was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the agent was last updated.
", + "smithy.api#required": {} + } + }, + "preparedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the agent was last prepared.
" + } + }, + "failureReasons": { + "target": "com.amazonaws.bedrockagent#FailureReasons", + "traits": { + "smithy.api#documentation": "Contains reasons that the agent-related API that you invoked failed.
" + } + }, + "recommendedActions": { + "target": "com.amazonaws.bedrockagent#RecommendedActions", + "traits": { + "smithy.api#documentation": "Contains recommended actions to take for the agent-related API that you invoked to succeed.
" + } + }, + "promptOverrideConfiguration": { + "target": "com.amazonaws.bedrockagent#PromptOverrideConfiguration", + "traits": { + "smithy.api#documentation": "Contains configurations to override prompt templates in different parts of an agent sequence. For more information, see Advanced prompts.
" + } + }, + "guardrailConfiguration": { + "target": "com.amazonaws.bedrockagent#GuardrailConfiguration", + "traits": { + "smithy.api#documentation": "Details about the guardrail associated with the agent.
" + } + }, + "memoryConfiguration": { + "target": "com.amazonaws.bedrockagent#MemoryConfiguration", + "traits": { + "smithy.api#documentation": "Contains memory configuration for the agent.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about an agent.
" + } }, - { - "target": "com.amazonaws.bedrockagent#TaggingResource" + "com.amazonaws.bedrockagent#AgentActionGroup": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the agent to which the action group belongs.
", + "smithy.api#required": {} + } + }, + "agentVersion": { + "target": "com.amazonaws.bedrockagent#Version", + "traits": { + "smithy.api#documentation": "The version of the agent to which the action group belongs.
", + "smithy.api#required": {} + } + }, + "actionGroupId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the action group.
", + "smithy.api#required": {} + } + }, + "actionGroupName": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#documentation": "The name of the action group.
", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagent#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
" + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "The description of the action group.
" + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the action group was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the action group was last updated.
", + "smithy.api#required": {} + } + }, + "parentActionSignature": { + "target": "com.amazonaws.bedrockagent#ActionGroupSignature", + "traits": { + "smithy.api#documentation": "If this field is set as AMAZON.UserInput, the agent can request the user for additional information when trying to complete a task. The description, apiSchema, and actionGroupExecutor fields must be blank for this action group.
During orchestration, if the agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an Observation reprompting the user for more information.
" + } + }, + "actionGroupExecutor": { + "target": "com.amazonaws.bedrockagent#ActionGroupExecutor", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user.
" + } + }, + "apiSchema": { + "target": "com.amazonaws.bedrockagent#APISchema", + "traits": { + "smithy.api#documentation": "Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see Action group OpenAPI schemas.
" + } + }, + "functionSchema": { + "target": "com.amazonaws.bedrockagent#FunctionSchema", + "traits": { + "smithy.api#documentation": "Defines functions that each define parameters that the agent needs to invoke from the user. Each function represents an action in an action group.
" + } + }, + "actionGroupState": { + "target": "com.amazonaws.bedrockagent#ActionGroupState", + "traits": { + "smithy.api#documentation": "Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about an action group.
" + } }, - { - "target": "com.amazonaws.bedrockagent#VersionResource" - } - ], - "traits": { - "aws.api#service": { - "sdkId": "Bedrock Agent", - "arnNamespace": "bedrock", - "endpointPrefix": "bedrock-agent", - "cloudTrailEventSource": "bedrock.amazonaws.com" - }, - "aws.auth#sigv4": { - "name": "bedrock" - }, - "aws.protocols#restJson1": {}, - "smithy.api#cors": { - "additionalAllowedHeaders": [ - "*", - "content-type", - "x-amz-content-sha256", - "x-amz-user-agent", - "x-amzn-platform-id", - "x-amzn-trace-id" - ], - "additionalExposedHeaders": ["x-amzn-errortype", "x-amzn-requestid", "x-amzn-trace-id"], - "maxAge": 86400 - }, - "smithy.api#documentation": "Describes the API operations for creating and managing Amazon Bedrock agents.
", - "smithy.api#title": "Agents for Amazon Bedrock", - "smithy.rules#endpointRuleSet": { - "version": "1.0", - "parameters": { - "Region": { - "builtIn": "AWS::Region", - "required": false, - "documentation": "The AWS region used to dispatch the request.", - "type": "String" - }, - "UseDualStack": { - "builtIn": "AWS::UseDualStack", - "required": true, - "default": false, - "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", - "type": "Boolean" - }, - "UseFIPS": { - "builtIn": "AWS::UseFIPS", - "required": true, - "default": false, - "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", - "type": "Boolean" - }, - "Endpoint": { - "builtIn": "SDK::Endpoint", - "required": false, - "documentation": "Override the endpoint used to send this request", - "type": "String" - } - }, - "rules": [ - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Endpoint" - } - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] + "com.amazonaws.bedrockagent#AgentAlias": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the agent.
", + "smithy.api#required": {} } - ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", - "type": "error" }, - { - "conditions": [], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" - }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" + "agentAliasId": { + "target": "com.amazonaws.bedrockagent#AgentAliasId", + "traits": { + "smithy.api#documentation": "The unique identifier of the alias of the agent.
", + "smithy.api#required": {} + } + }, + "agentAliasName": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#documentation": "The name of the alias of the agent.
", + "smithy.api#required": {} + } + }, + "agentAliasArn": { + "target": "com.amazonaws.bedrockagent#AgentAliasArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the alias of the agent.
", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagent#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
" + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "The description of the alias of the agent.
" + } + }, + "routingConfiguration": { + "target": "com.amazonaws.bedrockagent#AgentAliasRoutingConfiguration", + "traits": { + "smithy.api#documentation": "Contains details about the routing configuration of the alias.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the alias of the agent was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the alias was last updated.
", + "smithy.api#required": {} + } + }, + "agentAliasHistoryEvents": { + "target": "com.amazonaws.bedrockagent#AgentAliasHistoryEvents", + "traits": { + "smithy.api#documentation": "Contains details about the history of the alias.
" + } + }, + "agentAliasStatus": { + "target": "com.amazonaws.bedrockagent#AgentAliasStatus", + "traits": { + "smithy.api#documentation": "The status of the alias of the agent and whether it is ready for use. The following statuses are possible:
\nCREATING – The agent alias is being created.
\nPREPARED – The agent alias is finished being created or updated and is ready to be invoked.
\nFAILED – The agent alias API operation failed.
\nUPDATING – The agent alias is being updated.
\nDELETING – The agent alias is being deleted.
\nInformation on the failure of Provisioned Throughput assigned to an agent alias.
" } - ], - "type": "tree" } - ], - "type": "tree" }, - { - "conditions": [], - "rules": [ - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Region" - } - ] + "traits": { + "smithy.api#documentation": "Contains details about an alias of an agent.
" + } + }, + "com.amazonaws.bedrockagent#AgentAliasArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:agent-alias/[0-9a-zA-Z]{10}/[0-9a-zA-Z]{10}$" + } + }, + "com.amazonaws.bedrockagent#AgentAliasHistoryEvent": { + "type": "structure", + "members": { + "routingConfiguration": { + "target": "com.amazonaws.bedrockagent#AgentAliasRoutingConfiguration", + "traits": { + "smithy.api#documentation": "Contains details about the version of the agent with which the alias is associated.
" } - ], - "rules": [ - { - "conditions": [ - { - "fn": "aws.partition", - "argv": [ - { - "ref": "Region" - } - ], - "assign": "PartitionResult" - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "rules": [ - { - "conditions": [], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://bedrock-agent-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - }, - true - ] - } - ], - "rules": [ - { - "conditions": [], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://bedrock-agent-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "rules": [ - { - "conditions": [], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://bedrock-agent.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://bedrock-agent.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - } - ], - "type": "tree" + }, + "endDate": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The date that the alias stopped being associated to the version in the routingConfiguration object
The date that the alias began being associated to the version in the routingConfiguration object.
Contains details about the history of the alias.
" } - ] }, - "smithy.rules#endpointTests": { - "testCases": [ - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://bedrock-agent-fips.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://bedrock-agent-fips.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://bedrock-agent.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://bedrock-agent.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://bedrock-agent-fips.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://bedrock-agent-fips.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://bedrock-agent.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://bedrock-agent.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://bedrock-agent-fips.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://bedrock-agent-fips.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://bedrock-agent.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://bedrock-agent.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://bedrock-agent-fips.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://bedrock-agent.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://bedrock-agent-fips.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://bedrock-agent.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with fips enabled and dualstack disabled", - "expect": { - "error": "Invalid Configuration: FIPS and custom endpoint are not supported" - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with fips disabled and dualstack enabled", - "expect": { - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "Missing region", - "expect": { - "error": "Invalid Configuration: Missing Region" - } - } - ], - "version": "1.0" - } - } - }, - "com.amazonaws.bedrockagent#AssociateAgentKnowledgeBase": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#AssociateAgentKnowledgeBaseRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#AssociateAgentKnowledgeBaseResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrockagent#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrockagent#ConflictException" - }, - { - "target": "com.amazonaws.bedrockagent#InternalServerException" - }, - { - "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrockagent#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Associates a knowledge base with an agent. If a knowledge base is associated and its indexState is set to Enabled, the agent queries the knowledge base for information to augment its response to the user.
The unique identifier of the agent with which you want to associate the knowledge base.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "agentVersion": { - "target": "com.amazonaws.bedrockagent#DraftVersion", - "traits": { - "smithy.api#documentation": "The version of the agent with which you want to associate the knowledge base.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "knowledgeBaseId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the knowledge base to associate with the agent.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#Description", - "traits": { - "smithy.api#documentation": "A description of what the agent should use the knowledge base for.
", - "smithy.api#required": {} - } - }, - "knowledgeBaseState": { - "target": "com.amazonaws.bedrockagent#KnowledgeBaseState", - "traits": { - "smithy.api#documentation": "Specifies whether to use the knowledge base or not when sending an InvokeAgent request.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrockagent#AssociateAgentKnowledgeBaseResponse": { - "type": "structure", - "members": { - "agentKnowledgeBase": { - "target": "com.amazonaws.bedrockagent#AgentKnowledgeBase", - "traits": { - "smithy.api#documentation": "Contains details about the knowledge base that has been associated with the agent.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrockagent#BasePromptTemplate": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 100000 - }, - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.bedrockagent#BedrockEmbeddingModelArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 20, - "max": 2048 - }, - "smithy.api#pattern": "^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|([0-9]{12}:provisioned-model/[a-z0-9]{12})))|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|(([0-9a-zA-Z][_-]?)+)$" - } - }, - "com.amazonaws.bedrockagent#BedrockEmbeddingModelConfiguration": { - "type": "structure", - "members": { - "dimensions": { - "target": "com.amazonaws.bedrockagent#Dimensions", - "traits": { - "smithy.api#documentation": "The dimensions details for the vector configuration used on the Bedrock embeddings model.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The vector configuration details for the Bedrock embeddings model.
" - } - }, - "com.amazonaws.bedrockagent#BedrockFoundationModelConfiguration": { - "type": "structure", - "members": { - "modelArn": { - "target": "com.amazonaws.bedrockagent#BedrockModelArn", - "traits": { - "smithy.api#documentation": "The model's ARN.
", - "smithy.api#required": {} - } - }, - "parsingPrompt": { - "target": "com.amazonaws.bedrockagent#ParsingPrompt", - "traits": { - "smithy.api#documentation": "Instructions for interpreting the contents of a document.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Settings for a foundation model used to parse documents for a data source.
" - } - }, - "com.amazonaws.bedrockagent#BedrockModelArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - }, - "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}::foundation-model/([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2})$" - } - }, - "com.amazonaws.bedrockagent#BucketOwnerAccountId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 12, - "max": 12 - }, - "smithy.api#pattern": "^[0-9]{12}$" - } - }, - "com.amazonaws.bedrockagent#ChunkingConfiguration": { - "type": "structure", - "members": { - "chunkingStrategy": { - "target": "com.amazonaws.bedrockagent#ChunkingStrategy", - "traits": { - "smithy.api#documentation": "Knowledge base can split your source data into chunks. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried. You have the following options for chunking your data. If you opt for NONE, then you may want to pre-process your files by splitting them up such that each file corresponds to a chunk.
\n FIXED_SIZE – Amazon Bedrock splits your source data into chunks of the approximate size that you set in the fixedSizeChunkingConfiguration.
\n HIERARCHICAL – Split documents into layers of chunks where the first layer contains large chunks, and the second layer contains smaller chunks derived from the first layer.
\n SEMANTIC – Split documents into chunks based on groups of similar content derived with natural language processing.
\n NONE – Amazon Bedrock treats each file as one chunk. If you choose this option, you may want to pre-process your documents by splitting them into separate files.
Configurations for when you choose fixed-size chunking. If you set the chunkingStrategy as NONE, exclude this field.
Settings for hierarchical document chunking for a data source. Hierarchical chunking splits documents\n into layers of chunks where the first layer contains large chunks, and the second layer contains smaller\n chunks derived from the first layer.
" - } - }, - "semanticChunkingConfiguration": { - "target": "com.amazonaws.bedrockagent#SemanticChunkingConfiguration", - "traits": { - "smithy.api#documentation": "Settings for semantic document chunking for a data source. Semantic chunking splits\n a document into into smaller documents based on groups of similar content derived from the text\n with natural language processing.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Details about how to chunk the documents in the data source. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried.
" - } - }, - "com.amazonaws.bedrockagent#ChunkingStrategy": { - "type": "enum", - "members": { - "FIXED_SIZE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FIXED_SIZE" - } - }, - "NONE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NONE" - } - }, - "HIERARCHICAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HIERARCHICAL" - } - }, - "SEMANTIC": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SEMANTIC" - } - } - } - }, - "com.amazonaws.bedrockagent#ClientToken": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 33, - "max": 256 - }, - "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,256}$" - } - }, - "com.amazonaws.bedrockagent#CollectorFlowNodeConfiguration": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "Defines a collector node in your flow. This node takes an iteration of inputs and consolidates them into an array in the output. For more information, see Node types in Amazon Bedrock works in the Amazon Bedrock User Guide.
" - } - }, - "com.amazonaws.bedrockagent#ColumnName": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 63 - }, - "smithy.api#pattern": "^[a-zA-Z0-9_\\-]+$" - } - }, - "com.amazonaws.bedrockagent#ConditionFlowNodeConfiguration": { - "type": "structure", - "members": { - "conditions": { - "target": "com.amazonaws.bedrockagent#FlowConditions", - "traits": { - "smithy.api#documentation": "An array of conditions. Each member contains the name of a condition and an expression that defines the condition.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Defines a condition node in your flow. You can specify conditions that determine which node comes next in the flow. For more information, see Node types in Amazon Bedrock works in the Amazon Bedrock User Guide.
" - } - }, - "com.amazonaws.bedrockagent#ConflictException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.bedrockagent#NonBlankString" - } - }, - "traits": { - "smithy.api#documentation": "There was a conflict performing an operation.
", - "smithy.api#error": "client", - "smithy.api#httpError": 409 - } - }, - "com.amazonaws.bedrockagent#ConfluenceAuthType": { - "type": "enum", - "members": { - "BASIC": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BASIC" - } - }, - "OAUTH2_CLIENT_CREDENTIALS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "OAUTH2_CLIENT_CREDENTIALS" - } - } - } - }, - "com.amazonaws.bedrockagent#ConfluenceCrawlerConfiguration": { - "type": "structure", - "members": { - "filterConfiguration": { - "target": "com.amazonaws.bedrockagent#CrawlFilterConfiguration", - "traits": { - "smithy.api#documentation": "The configuration of filtering the Confluence content. For example, configuring \n regular expression patterns to include or exclude certain content.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The configuration of the Confluence content. For example, configuring specific \n types of Confluence content.
" - } - }, - "com.amazonaws.bedrockagent#ConfluenceDataSourceConfiguration": { - "type": "structure", - "members": { - "sourceConfiguration": { - "target": "com.amazonaws.bedrockagent#ConfluenceSourceConfiguration", - "traits": { - "smithy.api#documentation": "The endpoint information to connect to your Confluence data source.
", - "smithy.api#required": {} - } - }, - "crawlerConfiguration": { - "target": "com.amazonaws.bedrockagent#ConfluenceCrawlerConfiguration", - "traits": { - "smithy.api#documentation": "The configuration of the Confluence content. For example, configuring \n specific types of Confluence content.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The configuration information to connect to Confluence as your data source.
" - } - }, - "com.amazonaws.bedrockagent#ConfluenceHostType": { - "type": "enum", - "members": { - "SAAS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SAAS" - } - } - } - }, - "com.amazonaws.bedrockagent#ConfluenceSourceConfiguration": { - "type": "structure", - "members": { - "hostUrl": { - "target": "com.amazonaws.bedrockagent#HttpsUrl", - "traits": { - "smithy.api#documentation": "The Confluence host URL or instance URL.
", - "smithy.api#required": {} - } - }, - "hostType": { - "target": "com.amazonaws.bedrockagent#ConfluenceHostType", - "traits": { - "smithy.api#documentation": "The supported host type, whether online/cloud or server/on-premises.
", - "smithy.api#required": {} - } - }, - "authType": { - "target": "com.amazonaws.bedrockagent#ConfluenceAuthType", - "traits": { - "smithy.api#documentation": "The supported authentication type to authenticate and connect to your \n Confluence instance.
", - "smithy.api#required": {} - } - }, - "credentialsSecretArn": { - "target": "com.amazonaws.bedrockagent#SecretArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name of an Secrets Manager secret that \n stores your authentication credentials for your Confluence instance URL. \n For more information on the key-value pairs that must be included in \n your secret, depending on your authentication type, see \n Confluence connection configuration.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "The endpoint information to connect to your Confluence data source.
" - } - }, - "com.amazonaws.bedrockagent#CrawlFilterConfiguration": { - "type": "structure", - "members": { - "type": { - "target": "com.amazonaws.bedrockagent#CrawlFilterConfigurationType", - "traits": { - "smithy.api#documentation": "The type of filtering that you want to apply to certain objects or content of the \n data source. For example, the PATTERN type is regular expression patterns \n you can apply to filter your content.
The configuration of filtering certain objects or content types of the data source.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The configuration of filtering the data source content. For example, \n configuring regular expression patterns to include or exclude certain content.
" - } - }, - "com.amazonaws.bedrockagent#CrawlFilterConfigurationType": { - "type": "enum", - "members": { - "PATTERN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PATTERN" - } - } - } - }, - "com.amazonaws.bedrockagent#CreateAgent": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#CreateAgentRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#CreateAgentResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrockagent#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrockagent#ConflictException" - }, - { - "target": "com.amazonaws.bedrockagent#InternalServerException" - }, - { - "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrockagent#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Creates an agent that orchestrates interactions between foundation models, data sources, software applications, user conversations, and APIs to carry out tasks to help customers.
\nSpecify the following fields for security purposes.
\n\n agentResourceRoleArn – The Amazon Resource Name (ARN) of the role with permissions to invoke API operations on an agent.
(Optional) customerEncryptionKeyArn – The Amazon Resource Name (ARN) of a KMS key to encrypt the creation of the agent.
(Optional) idleSessionTTLinSeconds – Specify the number of seconds for which the agent should maintain session information. After this time expires, the subsequent InvokeAgent request begins a new session.
To enable your agent to retain conversational context across multiple sessions, include a memoryConfiguration object. \n For more information, see Configure memory.
To override the default prompt behavior for agent orchestration and to use advanced prompts, include a promptOverrideConfiguration object. \n For more information, see Advanced prompts.
If you agent fails to be created, the response returns a list of failureReasons alongside a list of recommendedActions for you to troubleshoot.
Creates an action group for an agent. An action group represents the actions that an agent can carry out for the customer by defining the APIs that an agent can call and the logic for calling them.
\nTo allow your agent to request the user for additional information when trying to complete a task, \n add an action group with the parentActionGroupSignature field set to AMAZON.UserInput.
To allow your agent to generate, run, and troubleshoot code when trying to complete a task, \n add an action group with the parentActionGroupSignature field set to AMAZON.CodeInterpreter.
You must leave the description, apiSchema, and actionGroupExecutor fields blank for this action group. During orchestration, if your agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an Observation reprompting the user for more information.
The unique identifier of the agent for which to create the action group.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "agentVersion": { - "target": "com.amazonaws.bedrockagent#DraftVersion", - "traits": { - "smithy.api#documentation": "The version of the agent for which to create the action group.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "actionGroupName": { - "target": "com.amazonaws.bedrockagent#Name", - "traits": { - "smithy.api#documentation": "The name to give the action group.
", - "smithy.api#required": {} - } - }, - "clientToken": { - "target": "com.amazonaws.bedrockagent#ClientToken", - "traits": { - "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
", - "smithy.api#idempotencyToken": {} - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#Description", - "traits": { - "smithy.api#documentation": "A description of the action group.
" - } - }, - "parentActionGroupSignature": { - "target": "com.amazonaws.bedrockagent#ActionGroupSignature", - "traits": { - "smithy.api#documentation": "To allow your agent to request the user for additional information when trying to complete a task, set this field to AMAZON.UserInput. You must leave the description, apiSchema, and actionGroupExecutor fields blank for this action group.
To allow your agent to generate, run, and troubleshoot code when trying to complete a task, set this field to AMAZON.CodeInterpreter. You must leave the description, apiSchema, and actionGroupExecutor fields blank for this action group.
During orchestration, if your agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an Observation reprompting the user for more information.
" - } - }, - "actionGroupExecutor": { - "target": "com.amazonaws.bedrockagent#ActionGroupExecutor", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user.
" - } - }, - "apiSchema": { - "target": "com.amazonaws.bedrockagent#APISchema", - "traits": { - "smithy.api#documentation": "Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see Action group OpenAPI schemas.
" - } - }, - "actionGroupState": { - "target": "com.amazonaws.bedrockagent#ActionGroupState", - "traits": { - "smithy.api#documentation": "Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
" - } - }, - "functionSchema": { - "target": "com.amazonaws.bedrockagent#FunctionSchema", - "traits": { - "smithy.api#documentation": "Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrockagent#CreateAgentActionGroupResponse": { - "type": "structure", - "members": { - "agentActionGroup": { - "target": "com.amazonaws.bedrockagent#AgentActionGroup", - "traits": { - "smithy.api#documentation": "Contains details about the action group that was created.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrockagent#CreateAgentAlias": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#CreateAgentAliasRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#CreateAgentAliasResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrockagent#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrockagent#ConflictException" - }, - { - "target": "com.amazonaws.bedrockagent#InternalServerException" - }, - { - "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrockagent#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Creates an alias of an agent that can be used to deploy the agent.
", - "smithy.api#http": { - "code": 202, - "method": "PUT", - "uri": "/agents/{agentId}/agentaliases/" - }, - "smithy.api#idempotent": {}, - "smithy.api#tags": ["console"] - } - }, - "com.amazonaws.bedrockagent#CreateAgentAliasRequest": { - "type": "structure", - "members": { - "agentId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the agent.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "agentAliasName": { - "target": "com.amazonaws.bedrockagent#Name", - "traits": { - "smithy.api#documentation": "The name of the alias.
", - "smithy.api#required": {} - } - }, - "clientToken": { - "target": "com.amazonaws.bedrockagent#ClientToken", - "traits": { - "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
", - "smithy.api#idempotencyToken": {} - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#Description", - "traits": { - "smithy.api#documentation": "A description of the alias of the agent.
" - } - }, - "routingConfiguration": { - "target": "com.amazonaws.bedrockagent#AgentAliasRoutingConfiguration", - "traits": { - "smithy.api#documentation": "Contains details about the routing configuration of the alias.
" - } - }, - "tags": { - "target": "com.amazonaws.bedrockagent#TagsMap", - "traits": { - "smithy.api#documentation": "Any tags that you want to attach to the alias of the agent.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrockagent#CreateAgentAliasResponse": { - "type": "structure", - "members": { - "agentAlias": { - "target": "com.amazonaws.bedrockagent#AgentAlias", - "traits": { - "smithy.api#documentation": "Contains details about the alias that was created.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrockagent#CreateAgentRequest": { - "type": "structure", - "members": { - "agentName": { - "target": "com.amazonaws.bedrockagent#Name", - "traits": { - "smithy.api#documentation": "A name for the agent that you create.
", - "smithy.api#required": {} - } - }, - "clientToken": { - "target": "com.amazonaws.bedrockagent#ClientToken", - "traits": { - "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
", - "smithy.api#idempotencyToken": {} - } - }, - "instruction": { - "target": "com.amazonaws.bedrockagent#Instruction", - "traits": { - "smithy.api#documentation": "Instructions that tell the agent what it should do and how it should interact with users.
" - } - }, - "foundationModel": { - "target": "com.amazonaws.bedrockagent#ModelIdentifier", - "traits": { - "smithy.api#documentation": "The foundation model to be used for orchestration by the agent you create.
" - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#Description", - "traits": { - "smithy.api#documentation": "A description of the agent.
" - } - }, - "idleSessionTTLInSeconds": { - "target": "com.amazonaws.bedrockagent#SessionTTL", - "traits": { - "smithy.api#documentation": "The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.
\nA user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.
" - } - }, - "agentResourceRoleArn": { - "target": "com.amazonaws.bedrockagent#AgentRoleArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.
" - } - }, - "customerEncryptionKeyArn": { - "target": "com.amazonaws.bedrockagent#KmsKeyArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key with which to encrypt the agent.
" - } - }, - "tags": { - "target": "com.amazonaws.bedrockagent#TagsMap", - "traits": { - "smithy.api#documentation": "Any tags that you want to attach to the agent.
" - } - }, - "promptOverrideConfiguration": { - "target": "com.amazonaws.bedrockagent#PromptOverrideConfiguration", - "traits": { - "smithy.api#documentation": "Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.
" - } - }, - "guardrailConfiguration": { - "target": "com.amazonaws.bedrockagent#GuardrailConfiguration", - "traits": { - "smithy.api#documentation": "The unique Guardrail configuration assigned to the agent when it is created.
" - } - }, - "memoryConfiguration": { - "target": "com.amazonaws.bedrockagent#MemoryConfiguration", - "traits": { - "smithy.api#documentation": "Contains the details of the memory configured for the agent.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrockagent#CreateAgentResponse": { - "type": "structure", - "members": { - "agent": { - "target": "com.amazonaws.bedrockagent#Agent", - "traits": { - "smithy.api#documentation": "Contains details about the agent created.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrockagent#CreateDataSource": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#CreateDataSourceRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#CreateDataSourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrockagent#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrockagent#ConflictException" - }, - { - "target": "com.amazonaws.bedrockagent#InternalServerException" - }, - { - "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrockagent#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Creates a data source connector for a knowledge base.
\nYou can't change the chunkingConfiguration after you create the data source connector.
The unique identifier of the knowledge base to which to add the data source.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "clientToken": { - "target": "com.amazonaws.bedrockagent#ClientToken", - "traits": { - "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
", - "smithy.api#idempotencyToken": {} - } - }, - "name": { - "target": "com.amazonaws.bedrockagent#Name", - "traits": { - "smithy.api#documentation": "The name of the data source.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#Description", - "traits": { - "smithy.api#documentation": "A description of the data source.
" - } - }, - "dataSourceConfiguration": { - "target": "com.amazonaws.bedrockagent#DataSourceConfiguration", - "traits": { - "smithy.api#documentation": "The connection configuration for the data source.
", - "smithy.api#required": {} - } - }, - "dataDeletionPolicy": { - "target": "com.amazonaws.bedrockagent#DataDeletionPolicy", - "traits": { - "smithy.api#documentation": "The data deletion policy for the data source.
\nYou can set the data deletion policy to:
\nDELETE: Deletes all data from your data source that’s converted \n into vector embeddings upon deletion of a knowledge base or data source resource. \n Note that the vector store itself is not deleted, \n only the data. This flag is ignored if an Amazon Web Services account is deleted.
\nRETAIN: Retains all data from your data source that’s converted \n into vector embeddings upon deletion of a knowledge base or data source resource. \n Note that the vector store itself is not deleted \n if you delete a knowledge base or data source resource.
\nContains details about the server-side encryption for the data source.
" - } - }, - "vectorIngestionConfiguration": { - "target": "com.amazonaws.bedrockagent#VectorIngestionConfiguration", - "traits": { - "smithy.api#documentation": "Contains details about how to ingest the documents in the data source.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrockagent#CreateDataSourceResponse": { - "type": "structure", - "members": { - "dataSource": { - "target": "com.amazonaws.bedrockagent#DataSource", - "traits": { - "smithy.api#documentation": "Contains details about the data source.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrockagent#CreateFlow": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#CreateFlowRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#CreateFlowResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrockagent#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrockagent#ConflictException" - }, - { - "target": "com.amazonaws.bedrockagent#InternalServerException" - }, - { - "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrockagent#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Creates a prompt flow that you can use to send an input through various steps to yield an output. Configure nodes, each of which corresponds to a step of the flow, and create connections between the nodes to create paths to different outputs. For more information, see How it works and Create a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
", - "smithy.api#http": { - "code": 201, - "method": "POST", - "uri": "/flows/" - }, - "smithy.api#idempotent": {}, - "smithy.api#tags": ["console"] - } - }, - "com.amazonaws.bedrockagent#CreateFlowAlias": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#CreateFlowAliasRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#CreateFlowAliasResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrockagent#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrockagent#ConflictException" - }, - { - "target": "com.amazonaws.bedrockagent#InternalServerException" - }, - { - "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrockagent#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Creates an alias of a flow for deployment. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
", - "smithy.api#http": { - "code": 201, - "method": "POST", - "uri": "/flows/{flowIdentifier}/aliases" - }, - "smithy.api#idempotent": {}, - "smithy.api#tags": ["console"] - } - }, - "com.amazonaws.bedrockagent#CreateFlowAliasRequest": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.bedrockagent#Name", - "traits": { - "smithy.api#documentation": "A name for the alias.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#Description", - "traits": { - "smithy.api#documentation": "A description for the alias.
" - } - }, - "routingConfiguration": { - "target": "com.amazonaws.bedrockagent#FlowAliasRoutingConfiguration", - "traits": { - "smithy.api#documentation": "Contains information about the version to which to map the alias.
", - "smithy.api#required": {} - } - }, - "flowIdentifier": { - "target": "com.amazonaws.bedrockagent#FlowIdentifier", - "traits": { - "smithy.api#documentation": "The unique identifier of the flow for which to create an alias.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "clientToken": { - "target": "com.amazonaws.bedrockagent#ClientToken", - "traits": { - "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
", - "smithy.api#idempotencyToken": {} - } - }, - "tags": { - "target": "com.amazonaws.bedrockagent#TagsMap", - "traits": { - "aws.cloudformation#cfnMutability": "full", - "smithy.api#documentation": "Any tags that you want to attach to the alias of the flow. For more information, see Tagging resources in Amazon Bedrock.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrockagent#CreateFlowAliasResponse": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.bedrockagent#Name", - "traits": { - "smithy.api#documentation": "The name of the alias.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#Description", - "traits": { - "smithy.api#documentation": "The description of the alias.
" - } - }, - "routingConfiguration": { - "target": "com.amazonaws.bedrockagent#FlowAliasRoutingConfiguration", - "traits": { - "smithy.api#documentation": "Contains information about the version that the alias is mapped to.
", - "smithy.api#required": {} - } - }, - "flowId": { - "target": "com.amazonaws.bedrockagent#FlowId", - "traits": { - "smithy.api#documentation": "The unique identifier of the flow that the alias belongs to.
", - "smithy.api#required": {} - } - }, - "id": { - "target": "com.amazonaws.bedrockagent#FlowAliasId", - "traits": { - "smithy.api#documentation": "The unique identifier of the alias.
", - "smithy.api#required": {} - } - }, - "arn": { - "target": "com.amazonaws.bedrockagent#FlowAliasArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the alias.
", - "smithy.api#required": {} - } - }, - "createdAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the alias was created.
", - "smithy.api#required": {} - } - }, - "updatedAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the alias of the flow was last updated.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrockagent#CreateFlowRequest": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.bedrockagent#FlowName", - "traits": { - "smithy.api#documentation": "A name for the flow.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#FlowDescription", - "traits": { - "smithy.api#documentation": "A description for the flow.
" - } - }, - "executionRoleArn": { - "target": "com.amazonaws.bedrockagent#FlowExecutionRoleArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the service role with permissions to create and manage a flow. For more information, see Create a service role for flows in Amazon Bedrock in the Amazon Bedrock User Guide.
", - "smithy.api#required": {} - } - }, - "customerEncryptionKeyArn": { - "target": "com.amazonaws.bedrockagent#KmsKeyArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key to encrypt the flow.
" - } - }, - "definition": { - "target": "com.amazonaws.bedrockagent#FlowDefinition", - "traits": { - "smithy.api#documentation": "A definition of the nodes and connections between nodes in the flow.
" - } - }, - "clientToken": { - "target": "com.amazonaws.bedrockagent#ClientToken", - "traits": { - "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
", - "smithy.api#idempotencyToken": {} - } - }, - "tags": { - "target": "com.amazonaws.bedrockagent#TagsMap", - "traits": { - "aws.cloudformation#cfnMutability": "full", - "smithy.api#documentation": "Any tags that you want to attach to the flow. For more information, see Tagging resources in Amazon Bedrock.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrockagent#CreateFlowResponse": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.bedrockagent#FlowName", - "traits": { - "smithy.api#documentation": "The name of the flow.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#FlowDescription", - "traits": { - "smithy.api#documentation": "The description of the flow.
" - } - }, - "executionRoleArn": { - "target": "com.amazonaws.bedrockagent#FlowExecutionRoleArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the service role with permissions to create a flow. For more information, see Create a service role for flows in Amazon Bedrock in the Amazon Bedrock User Guide.
", - "smithy.api#required": {} - } - }, - "customerEncryptionKeyArn": { - "target": "com.amazonaws.bedrockagent#KmsKeyArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key that you encrypted the flow with.
" - } - }, - "id": { - "target": "com.amazonaws.bedrockagent#FlowId", - "traits": { - "smithy.api#documentation": "The unique identifier of the flow.
", - "smithy.api#required": {} - } - }, - "arn": { - "target": "com.amazonaws.bedrockagent#FlowArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the flow.
", - "smithy.api#required": {} - } - }, - "status": { - "target": "com.amazonaws.bedrockagent#FlowStatus", - "traits": { - "smithy.api#documentation": "The status of the flow. When you submit this request, the status will be NotPrepared. If creation fails, the status becomes Failed.
The time at which the flow was created.
", - "smithy.api#required": {} - } - }, - "updatedAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the flow was last updated.
", - "smithy.api#required": {} - } - }, - "version": { - "target": "com.amazonaws.bedrockagent#DraftVersion", - "traits": { - "smithy.api#documentation": "The version of the flow. When you create a flow, the version created is the DRAFT version.
A definition of the nodes and connections between nodes in the flow.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrockagent#CreateFlowVersion": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#CreateFlowVersionRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#CreateFlowVersionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrockagent#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrockagent#ConflictException" - }, - { - "target": "com.amazonaws.bedrockagent#InternalServerException" - }, - { - "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrockagent#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Creates a version of the flow that you can deploy. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
", - "smithy.api#http": { - "code": 201, - "method": "POST", - "uri": "/flows/{flowIdentifier}/versions" - }, - "smithy.api#idempotent": {}, - "smithy.api#tags": ["console"] - } - }, - "com.amazonaws.bedrockagent#CreateFlowVersionRequest": { - "type": "structure", - "members": { - "flowIdentifier": { - "target": "com.amazonaws.bedrockagent#FlowIdentifier", - "traits": { - "smithy.api#documentation": "The unique identifier of the flow that you want to create a version of.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#FlowDescription", - "traits": { - "smithy.api#documentation": "A description of the version of the flow.
" - } - }, - "clientToken": { - "target": "com.amazonaws.bedrockagent#ClientToken", - "traits": { - "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
", - "smithy.api#idempotencyToken": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrockagent#CreateFlowVersionResponse": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.bedrockagent#FlowName", - "traits": { - "smithy.api#documentation": "The name of the version.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#FlowDescription", - "traits": { - "smithy.api#documentation": "The description of the version.
" - } - }, - "executionRoleArn": { - "target": "com.amazonaws.bedrockagent#FlowExecutionRoleArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the service role with permissions to create a flow. For more information, see Create a service role for flows in Amazon Bedrock in the Amazon Bedrock User Guide.
", - "smithy.api#required": {} - } - }, - "customerEncryptionKeyArn": { - "target": "com.amazonaws.bedrockagent#KmsKeyArn", - "traits": { - "smithy.api#documentation": "The KMS key that the flow is encrypted with.
" - } - }, - "id": { - "target": "com.amazonaws.bedrockagent#FlowId", - "traits": { - "smithy.api#documentation": "The unique identifier of the flow.
", - "smithy.api#required": {} - } - }, - "arn": { - "target": "com.amazonaws.bedrockagent#FlowArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the flow.
", - "smithy.api#required": {} - } - }, - "status": { - "target": "com.amazonaws.bedrockagent#FlowStatus", - "traits": { - "smithy.api#documentation": "The status of the flow.
", - "smithy.api#required": {} - } - }, - "createdAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the flow was created.
", - "smithy.api#required": {} - } - }, - "version": { - "target": "com.amazonaws.bedrockagent#NumericalVersion", - "traits": { - "smithy.api#documentation": "The version of the flow that was created. Versions are numbered incrementally, starting from 1.
", - "smithy.api#required": {} - } - }, - "definition": { - "target": "com.amazonaws.bedrockagent#FlowDefinition", - "traits": { - "smithy.api#documentation": "A definition of the nodes and connections in the flow.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrockagent#CreateKnowledgeBase": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#CreateKnowledgeBaseRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#CreateKnowledgeBaseResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrockagent#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrockagent#ConflictException" - }, - { - "target": "com.amazonaws.bedrockagent#InternalServerException" - }, - { - "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrockagent#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Creates a knowledge base that contains data sources from which information can be queried and used by LLMs. To create a knowledge base, you must first set up your data sources and configure a supported vector store. For more information, see Set up your data for ingestion.
\nIf you prefer to let Amazon Bedrock create and manage a vector store for you in Amazon OpenSearch Service, use the console. For more information, see Create a knowledge base.
\nProvide the name and an optional description.
Provide the Amazon Resource Name (ARN) with permissions to create a knowledge base in the roleArn field.
Provide the embedding model to use in the embeddingModelArn field in the knowledgeBaseConfiguration object.
Provide the configuration for your vector store in the storageConfiguration object.
For an Amazon OpenSearch Service database, use the opensearchServerlessConfiguration object. For more information, see Create a vector store in Amazon OpenSearch Service.
For an Amazon Aurora database, use the RdsConfiguration object. For more information, see Create a vector store in Amazon Aurora.
For a Pinecone database, use the pineconeConfiguration object. For more information, see Create a vector store in Pinecone.
For a Redis Enterprise Cloud database, use the redisEnterpriseCloudConfiguration object. For more information, see Create a vector store in Redis Enterprise Cloud.
A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
", - "smithy.api#idempotencyToken": {} - } - }, - "name": { - "target": "com.amazonaws.bedrockagent#Name", - "traits": { - "smithy.api#documentation": "A name for the knowledge base.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#Description", - "traits": { - "smithy.api#documentation": "A description of the knowledge base.
" - } - }, - "roleArn": { - "target": "com.amazonaws.bedrockagent#KnowledgeBaseRoleArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.
", - "smithy.api#required": {} - } - }, - "knowledgeBaseConfiguration": { - "target": "com.amazonaws.bedrockagent#KnowledgeBaseConfiguration", - "traits": { - "smithy.api#documentation": "Contains details about the embeddings model used for the knowledge base.
", - "smithy.api#required": {} - } - }, - "storageConfiguration": { - "target": "com.amazonaws.bedrockagent#StorageConfiguration", - "traits": { - "smithy.api#documentation": "Contains details about the configuration of the vector database used for the knowledge base.
", - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.bedrockagent#TagsMap", - "traits": { - "smithy.api#documentation": "Specify the key-value pairs for the tags that you want to attach to your knowledge base in this object.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrockagent#CreateKnowledgeBaseResponse": { - "type": "structure", - "members": { - "knowledgeBase": { - "target": "com.amazonaws.bedrockagent#KnowledgeBase", - "traits": { - "smithy.api#documentation": "Contains details about the knowledge base.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrockagent#CreatePrompt": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#CreatePromptRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#CreatePromptResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrockagent#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrockagent#ConflictException" - }, - { - "target": "com.amazonaws.bedrockagent#InternalServerException" - }, - { - "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrockagent#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Creates a prompt in your prompt library that you can add to a flow. For more information, see Prompt management in Amazon Bedrock, Create a prompt using Prompt management and Prompt flows in Amazon Bedrock in the Amazon Bedrock User Guide.
", - "smithy.api#http": { - "code": 201, - "method": "POST", - "uri": "/prompts/" - }, - "smithy.api#idempotent": {}, - "smithy.api#tags": ["console"] - } - }, - "com.amazonaws.bedrockagent#CreatePromptRequest": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.bedrockagent#PromptName", - "traits": { - "smithy.api#documentation": "A name for the prompt.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#PromptDescription", - "traits": { - "smithy.api#documentation": "A description for the prompt.
" - } - }, - "customerEncryptionKeyArn": { - "target": "com.amazonaws.bedrockagent#KmsKeyArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key to encrypt the prompt.
" - } - }, - "defaultVariant": { - "target": "com.amazonaws.bedrockagent#PromptVariantName", - "traits": { - "smithy.api#documentation": "The name of the default variant for the prompt. This value must match the name field in the relevant PromptVariant object.
A list of objects, each containing details about a variant of the prompt.
" - } - }, - "clientToken": { - "target": "com.amazonaws.bedrockagent#ClientToken", - "traits": { - "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
", - "smithy.api#idempotencyToken": {} - } - }, - "tags": { - "target": "com.amazonaws.bedrockagent#TagsMap", - "traits": { - "aws.cloudformation#cfnMutability": "full", - "smithy.api#documentation": "Any tags that you want to attach to the prompt. For more information, see Tagging resources in Amazon Bedrock.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrockagent#CreatePromptResponse": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.bedrockagent#PromptName", - "traits": { - "smithy.api#documentation": "The name of the prompt.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#PromptDescription", - "traits": { - "smithy.api#documentation": "The description of the prompt.
" - } - }, - "customerEncryptionKeyArn": { - "target": "com.amazonaws.bedrockagent#KmsKeyArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key that you encrypted the prompt with.
" - } - }, - "defaultVariant": { - "target": "com.amazonaws.bedrockagent#PromptVariantName", - "traits": { - "smithy.api#documentation": "The name of the default variant for your prompt.
" - } - }, - "variants": { - "target": "com.amazonaws.bedrockagent#PromptVariantList", - "traits": { - "smithy.api#documentation": "A list of objects, each containing details about a variant of the prompt.
" - } - }, - "id": { - "target": "com.amazonaws.bedrockagent#PromptId", - "traits": { - "smithy.api#documentation": "The unique identifier of the prompt.
", - "smithy.api#required": {} - } - }, - "arn": { - "target": "com.amazonaws.bedrockagent#PromptArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the prompt.
", - "smithy.api#required": {} - } - }, - "version": { - "target": "com.amazonaws.bedrockagent#Version", - "traits": { - "smithy.api#documentation": "The version of the prompt. When you create a prompt, the version created is the DRAFT version.
The time at which the prompt was created.
", - "smithy.api#required": {} - } - }, - "updatedAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the prompt was last updated.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrockagent#CreatePromptVersion": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#CreatePromptVersionRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#CreatePromptVersionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrockagent#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrockagent#ConflictException" - }, - { - "target": "com.amazonaws.bedrockagent#InternalServerException" - }, - { - "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrockagent#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Creates a static snapshot of your prompt that can be deployed to production. For more information, see Deploy prompts using Prompt management by creating versions in the Amazon Bedrock User Guide.
", - "smithy.api#http": { - "code": 201, - "method": "POST", - "uri": "/prompts/{promptIdentifier}/versions" - }, - "smithy.api#idempotent": {}, - "smithy.api#tags": ["console"] - } - }, - "com.amazonaws.bedrockagent#CreatePromptVersionRequest": { - "type": "structure", - "members": { - "promptIdentifier": { - "target": "com.amazonaws.bedrockagent#PromptIdentifier", - "traits": { - "smithy.api#documentation": "The unique identifier of the prompt that you want to create a version of.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#PromptDescription", - "traits": { - "smithy.api#documentation": "A description for the version of the prompt.
" - } - }, - "clientToken": { - "target": "com.amazonaws.bedrockagent#ClientToken", - "traits": { - "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
", - "smithy.api#idempotencyToken": {} - } - }, - "tags": { - "target": "com.amazonaws.bedrockagent#TagsMap", - "traits": { - "aws.cloudformation#cfnMutability": "full", - "smithy.api#documentation": "Any tags that you want to attach to the version of the prompt. For more information, see Tagging resources in Amazon Bedrock.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrockagent#CreatePromptVersionResponse": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.bedrockagent#PromptName", - "traits": { - "smithy.api#documentation": "The name of the prompt.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#PromptDescription", - "traits": { - "smithy.api#documentation": "A description for the version.
" - } - }, - "customerEncryptionKeyArn": { - "target": "com.amazonaws.bedrockagent#KmsKeyArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key to encrypt the version of the prompt.
" - } - }, - "defaultVariant": { - "target": "com.amazonaws.bedrockagent#PromptVariantName", - "traits": { - "smithy.api#documentation": "The name of the default variant for the prompt. This value must match the name field in the relevant PromptVariant object.
A list of objects, each containing details about a variant of the prompt.
" - } - }, - "id": { - "target": "com.amazonaws.bedrockagent#PromptId", - "traits": { - "smithy.api#documentation": "The unique identifier of the prompt.
", - "smithy.api#required": {} - } - }, - "arn": { - "target": "com.amazonaws.bedrockagent#PromptArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the version of the prompt.
", - "smithy.api#required": {} - } - }, - "version": { - "target": "com.amazonaws.bedrockagent#Version", - "traits": { - "smithy.api#documentation": "The version of the prompt that was created. Versions are numbered incrementally, starting from 1.
", - "smithy.api#required": {} - } - }, - "createdAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the prompt was created.
", - "smithy.api#required": {} - } - }, - "updatedAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the prompt was last updated.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrockagent#CreationMode": { - "type": "enum", - "members": { - "DEFAULT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DEFAULT" - } - }, - "OVERRIDDEN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "OVERRIDDEN" - } - } - } - }, - "com.amazonaws.bedrockagent#CustomControlMethod": { - "type": "enum", - "members": { - "RETURN_CONTROL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RETURN_CONTROL" - } - } - } - }, - "com.amazonaws.bedrockagent#CustomTransformationConfiguration": { - "type": "structure", - "members": { - "intermediateStorage": { - "target": "com.amazonaws.bedrockagent#IntermediateStorage", - "traits": { - "smithy.api#documentation": "An S3 bucket path for input and output objects.
", - "smithy.api#required": {} - } - }, - "transformations": { - "target": "com.amazonaws.bedrockagent#Transformations", - "traits": { - "smithy.api#documentation": "A Lambda function that processes documents.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Settings for customizing steps in the data source content ingestion pipeline.
\nYou can configure the data source to process documents with a Lambda function after\n they are parsed and converted into chunks. When you add a post-chunking transformation,\n the service stores chunked documents in an S3 bucket and invokes a Lambda function to process\n them.
\nTo process chunked documents with a Lambda function, define an S3 bucket path for input\n and output objects, and a transformation that specifies the Lambda function to invoke. You can\n use the Lambda function to customize how chunks are split, and the metadata for each chunk.\n
" - } - }, - "com.amazonaws.bedrockagent#DataDeletionPolicy": { - "type": "enum", - "members": { - "RETAIN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RETAIN" - } - }, - "DELETE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETE" - } - } - } - }, - "com.amazonaws.bedrockagent#DataSource": { - "type": "structure", - "members": { - "knowledgeBaseId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the knowledge base to which the data source belongs.
", - "smithy.api#required": {} - } - }, - "dataSourceId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the data source.
", - "smithy.api#required": {} - } - }, - "name": { - "target": "com.amazonaws.bedrockagent#Name", - "traits": { - "smithy.api#documentation": "The name of the data source.
", - "smithy.api#required": {} - } - }, - "status": { - "target": "com.amazonaws.bedrockagent#DataSourceStatus", - "traits": { - "smithy.api#documentation": "The status of the data source. The following statuses are possible:
\nAvailable – The data source has been created and is ready for ingestion into the knowledge base.
\nDeleting – The data source is being deleted.
\nThe description of the data source.
" - } - }, - "dataSourceConfiguration": { - "target": "com.amazonaws.bedrockagent#DataSourceConfiguration", - "traits": { - "smithy.api#documentation": "The connection configuration for the data source.
", - "smithy.api#required": {} - } - }, - "serverSideEncryptionConfiguration": { - "target": "com.amazonaws.bedrockagent#ServerSideEncryptionConfiguration", - "traits": { - "smithy.api#documentation": "Contains details about the configuration of the server-side encryption.
" - } - }, - "vectorIngestionConfiguration": { - "target": "com.amazonaws.bedrockagent#VectorIngestionConfiguration", - "traits": { - "smithy.api#documentation": "Contains details about how to ingest the documents in the data source.
" - } - }, - "dataDeletionPolicy": { - "target": "com.amazonaws.bedrockagent#DataDeletionPolicy", - "traits": { - "smithy.api#documentation": "The data deletion policy for the data source.
" - } - }, - "createdAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the data source was created.
", - "smithy.api#required": {} - } - }, - "updatedAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the data source was last updated.
", - "smithy.api#required": {} - } - }, - "failureReasons": { - "target": "com.amazonaws.bedrockagent#FailureReasons", - "traits": { - "smithy.api#documentation": "The detailed reasons on the failure to delete a data source.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains details about a data source.
" - } - }, - "com.amazonaws.bedrockagent#DataSourceConfiguration": { - "type": "structure", - "members": { - "type": { - "target": "com.amazonaws.bedrockagent#DataSourceType", - "traits": { - "smithy.api#documentation": "The type of data source.
", - "smithy.api#required": {} - } - }, - "s3Configuration": { - "target": "com.amazonaws.bedrockagent#S3DataSourceConfiguration", - "traits": { - "smithy.api#documentation": "The configuration information to connect to Amazon S3 as your data source.
" - } - }, - "webConfiguration": { - "target": "com.amazonaws.bedrockagent#WebDataSourceConfiguration", - "traits": { - "smithy.api#documentation": "The configuration of web URLs to crawl for your data source. \n You should be authorized to crawl the URLs.
\nCrawling web URLs as your data source is in preview release \n and is subject to change.
\nThe configuration information to connect to Confluence as your data source.
\nConfluence data source connector is in preview release and is subject to change.
\nThe configuration information to connect to Salesforce as your data source.
\nSalesforce data source connector is in preview release and is subject to change.
\nThe configuration information to connect to SharePoint as your data source.
\nSharePoint data source connector is in preview release and is subject to change.
\nThe connection configuration for the data source.
" - } - }, - "com.amazonaws.bedrockagent#DataSourceResource": { - "type": "resource", - "operations": [ - { - "target": "com.amazonaws.bedrockagent#CreateDataSource" - }, - { - "target": "com.amazonaws.bedrockagent#DeleteDataSource" - }, - { - "target": "com.amazonaws.bedrockagent#GetDataSource" - }, - { - "target": "com.amazonaws.bedrockagent#ListDataSources" - }, - { - "target": "com.amazonaws.bedrockagent#UpdateDataSource" - } - ] - }, - "com.amazonaws.bedrockagent#DataSourceStatus": { - "type": "enum", - "members": { - "AVAILABLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AVAILABLE" - } - }, - "DELETING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETING" - } - }, - "DELETE_UNSUCCESSFUL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETE_UNSUCCESSFUL" - } - } - } - }, - "com.amazonaws.bedrockagent#DataSourceSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrockagent#DataSourceSummary" - } - }, - "com.amazonaws.bedrockagent#DataSourceSummary": { - "type": "structure", - "members": { - "knowledgeBaseId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the knowledge base to which the data source belongs.
", - "smithy.api#required": {} - } - }, - "dataSourceId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the data source.
", - "smithy.api#required": {} - } - }, - "name": { - "target": "com.amazonaws.bedrockagent#Name", - "traits": { - "smithy.api#documentation": "The name of the data source.
", - "smithy.api#required": {} - } - }, - "status": { - "target": "com.amazonaws.bedrockagent#DataSourceStatus", - "traits": { - "smithy.api#documentation": "The status of the data source.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#Description", - "traits": { - "smithy.api#documentation": "The description of the data source.
" - } - }, - "updatedAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the data source was last updated.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Contains details about a data source.
" - } - }, - "com.amazonaws.bedrockagent#DataSourceType": { - "type": "enum", - "members": { - "S3": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "S3" - } - }, - "WEB": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "WEB" - } - }, - "CONFLUENCE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CONFLUENCE" - } - }, - "SALESFORCE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SALESFORCE" - } - }, - "SHAREPOINT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SHAREPOINT" - } - } - } - }, - "com.amazonaws.bedrockagent#DateTimestamp": { - "type": "timestamp", - "traits": { - "smithy.api#timestampFormat": "date-time" - } - }, - "com.amazonaws.bedrockagent#DeleteAgent": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#DeleteAgentRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#DeleteAgentResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrockagent#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrockagent#ConflictException" - }, - { - "target": "com.amazonaws.bedrockagent#InternalServerException" - }, - { - "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrockagent#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes an agent.
", - "smithy.api#http": { - "code": 202, - "method": "DELETE", - "uri": "/agents/{agentId}/" - }, - "smithy.api#idempotent": {}, - "smithy.api#tags": ["console"] - } - }, - "com.amazonaws.bedrockagent#DeleteAgentActionGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#DeleteAgentActionGroupRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#DeleteAgentActionGroupResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrockagent#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrockagent#ConflictException" - }, - { - "target": "com.amazonaws.bedrockagent#InternalServerException" - }, - { - "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrockagent#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes an action group in an agent.
", - "smithy.api#http": { - "code": 204, - "method": "DELETE", - "uri": "/agents/{agentId}/agentversions/{agentVersion}/actiongroups/{actionGroupId}/" - }, - "smithy.api#idempotent": {}, - "smithy.api#tags": ["console"] - } - }, - "com.amazonaws.bedrockagent#DeleteAgentActionGroupRequest": { - "type": "structure", - "members": { - "agentId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the agent that the action group belongs to.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "agentVersion": { - "target": "com.amazonaws.bedrockagent#DraftVersion", - "traits": { - "smithy.api#documentation": "The version of the agent that the action group belongs to.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "actionGroupId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the action group to delete.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "skipResourceInUseCheck": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "By default, this value is false and deletion is stopped if the resource is in use. If you set it to true, the resource will be deleted even if the resource is in use.
Deletes an alias of an agent.
", - "smithy.api#http": { - "code": 202, - "method": "DELETE", - "uri": "/agents/{agentId}/agentaliases/{agentAliasId}/" - }, - "smithy.api#idempotent": {}, - "smithy.api#tags": ["console"] - } - }, - "com.amazonaws.bedrockagent#DeleteAgentAliasRequest": { - "type": "structure", - "members": { - "agentId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the agent that the alias belongs to.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "agentAliasId": { - "target": "com.amazonaws.bedrockagent#AgentAliasId", - "traits": { - "smithy.api#documentation": "The unique identifier of the alias to delete.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrockagent#DeleteAgentAliasResponse": { - "type": "structure", - "members": { - "agentId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the agent that the alias belongs to.
", - "smithy.api#required": {} - } - }, - "agentAliasId": { - "target": "com.amazonaws.bedrockagent#AgentAliasId", - "traits": { - "smithy.api#documentation": "The unique identifier of the alias that was deleted.
", - "smithy.api#required": {} - } - }, - "agentAliasStatus": { - "target": "com.amazonaws.bedrockagent#AgentAliasStatus", - "traits": { - "smithy.api#documentation": "The status of the alias.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrockagent#DeleteAgentRequest": { - "type": "structure", - "members": { - "agentId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the agent to delete.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "skipResourceInUseCheck": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "By default, this value is false and deletion is stopped if the resource is in use. If you set it to true, the resource will be deleted even if the resource is in use.
The unique identifier of the agent that was deleted.
", - "smithy.api#required": {} - } - }, - "agentStatus": { - "target": "com.amazonaws.bedrockagent#AgentStatus", - "traits": { - "smithy.api#documentation": "The status of the agent.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrockagent#DeleteAgentVersion": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#DeleteAgentVersionRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#DeleteAgentVersionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrockagent#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrockagent#ConflictException" - }, - { - "target": "com.amazonaws.bedrockagent#InternalServerException" - }, - { - "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrockagent#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes a version of an agent.
", - "smithy.api#http": { - "code": 202, - "method": "DELETE", - "uri": "/agents/{agentId}/agentversions/{agentVersion}/" - }, - "smithy.api#idempotent": {}, - "smithy.api#tags": ["console"] - } - }, - "com.amazonaws.bedrockagent#DeleteAgentVersionRequest": { - "type": "structure", - "members": { - "agentId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the agent that the version belongs to.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "agentVersion": { - "target": "com.amazonaws.bedrockagent#NumericalVersion", - "traits": { - "smithy.api#documentation": "The version of the agent to delete.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "skipResourceInUseCheck": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "By default, this value is false and deletion is stopped if the resource is in use. If you set it to true, the resource will be deleted even if the resource is in use.
The unique identifier of the agent that the version belongs to.
", - "smithy.api#required": {} - } - }, - "agentVersion": { - "target": "com.amazonaws.bedrockagent#NumericalVersion", - "traits": { - "smithy.api#documentation": "The version that was deleted.
", - "smithy.api#required": {} - } - }, - "agentStatus": { - "target": "com.amazonaws.bedrockagent#AgentStatus", - "traits": { - "smithy.api#documentation": "The status of the agent version.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrockagent#DeleteDataSource": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#DeleteDataSourceRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#DeleteDataSourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrockagent#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrockagent#ConflictException" - }, - { - "target": "com.amazonaws.bedrockagent#InternalServerException" - }, - { - "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrockagent#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes a data source from a knowledge base.
", - "smithy.api#http": { - "code": 202, - "method": "DELETE", - "uri": "/knowledgebases/{knowledgeBaseId}/datasources/{dataSourceId}" - }, - "smithy.api#idempotent": {}, - "smithy.api#tags": ["console"] - } - }, - "com.amazonaws.bedrockagent#DeleteDataSourceRequest": { - "type": "structure", - "members": { - "knowledgeBaseId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the knowledge base from which to delete the data source.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "dataSourceId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the data source to delete.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrockagent#DeleteDataSourceResponse": { - "type": "structure", - "members": { - "knowledgeBaseId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the knowledge base to which the data source that was deleted belonged.
", - "smithy.api#required": {} - } - }, - "dataSourceId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the data source that was deleted.
", - "smithy.api#required": {} - } - }, - "status": { - "target": "com.amazonaws.bedrockagent#DataSourceStatus", - "traits": { - "smithy.api#documentation": "The status of the data source.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrockagent#DeleteFlow": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#DeleteFlowRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#DeleteFlowResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrockagent#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrockagent#ConflictException" - }, - { - "target": "com.amazonaws.bedrockagent#InternalServerException" - }, - { - "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrockagent#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes a flow.
", - "smithy.api#http": { - "code": 200, - "method": "DELETE", - "uri": "/flows/{flowIdentifier}/" - }, - "smithy.api#idempotent": {}, - "smithy.api#tags": ["console"] - } - }, - "com.amazonaws.bedrockagent#DeleteFlowAlias": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#DeleteFlowAliasRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#DeleteFlowAliasResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrockagent#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrockagent#ConflictException" - }, - { - "target": "com.amazonaws.bedrockagent#InternalServerException" - }, - { - "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrockagent#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes an alias of a flow.
", - "smithy.api#http": { - "code": 200, - "method": "DELETE", - "uri": "/flows/{flowIdentifier}/aliases/{aliasIdentifier}" - }, - "smithy.api#idempotent": {}, - "smithy.api#tags": ["console"] - } - }, - "com.amazonaws.bedrockagent#DeleteFlowAliasRequest": { - "type": "structure", - "members": { - "flowIdentifier": { - "target": "com.amazonaws.bedrockagent#FlowIdentifier", - "traits": { - "smithy.api#documentation": "The unique identifier of the flow that the alias belongs to.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "aliasIdentifier": { - "target": "com.amazonaws.bedrockagent#FlowAliasIdentifier", - "traits": { - "smithy.api#documentation": "The unique identifier of the alias to be deleted.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrockagent#DeleteFlowAliasResponse": { - "type": "structure", - "members": { - "flowId": { - "target": "com.amazonaws.bedrockagent#FlowId", - "traits": { - "smithy.api#documentation": "The unique identifier of the flow that the alias belongs to.
", - "smithy.api#required": {} - } - }, - "id": { - "target": "com.amazonaws.bedrockagent#FlowAliasId", - "traits": { - "smithy.api#documentation": "The unique identifier of the flow.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrockagent#DeleteFlowRequest": { - "type": "structure", - "members": { - "flowIdentifier": { - "target": "com.amazonaws.bedrockagent#FlowIdentifier", - "traits": { - "smithy.api#documentation": "The unique identifier of the flow.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "skipResourceInUseCheck": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "By default, this value is false and deletion is stopped if the resource is in use. If you set it to true, the resource will be deleted even if the resource is in use.
The unique identifier of the flow.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrockagent#DeleteFlowVersion": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#DeleteFlowVersionRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#DeleteFlowVersionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrockagent#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrockagent#ConflictException" - }, - { - "target": "com.amazonaws.bedrockagent#InternalServerException" - }, - { - "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrockagent#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes a version of a flow.
", - "smithy.api#http": { - "code": 200, - "method": "DELETE", - "uri": "/flows/{flowIdentifier}/versions/{flowVersion}/" - }, - "smithy.api#idempotent": {}, - "smithy.api#tags": ["console"] - } - }, - "com.amazonaws.bedrockagent#DeleteFlowVersionRequest": { - "type": "structure", - "members": { - "flowIdentifier": { - "target": "com.amazonaws.bedrockagent#FlowIdentifier", - "traits": { - "smithy.api#documentation": "The unique identifier of the flow whose version that you want to delete
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "flowVersion": { - "target": "com.amazonaws.bedrockagent#NumericalVersion", - "traits": { - "smithy.api#documentation": "The version of the flow that you want to delete.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "skipResourceInUseCheck": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "By default, this value is false and deletion is stopped if the resource is in use. If you set it to true, the resource will be deleted even if the resource is in use.
The unique identifier of the flow.
", - "smithy.api#required": {} - } - }, - "version": { - "target": "com.amazonaws.bedrockagent#NumericalVersion", - "traits": { - "smithy.api#documentation": "The version of the flow being deleted.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrockagent#DeleteKnowledgeBase": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#DeleteKnowledgeBaseRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#DeleteKnowledgeBaseResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrockagent#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrockagent#ConflictException" - }, - { - "target": "com.amazonaws.bedrockagent#InternalServerException" - }, - { - "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrockagent#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes a knowledge base. Before deleting a knowledge base, you should disassociate the knowledge base from any agents that it is associated with by making a DisassociateAgentKnowledgeBase request.
", - "smithy.api#http": { - "code": 202, - "method": "DELETE", - "uri": "/knowledgebases/{knowledgeBaseId}" - }, - "smithy.api#idempotent": {}, - "smithy.api#tags": ["console"] - } - }, - "com.amazonaws.bedrockagent#DeleteKnowledgeBaseRequest": { - "type": "structure", - "members": { - "knowledgeBaseId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the knowledge base to delete.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrockagent#DeleteKnowledgeBaseResponse": { - "type": "structure", - "members": { - "knowledgeBaseId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the knowledge base that was deleted.
", - "smithy.api#required": {} - } - }, - "status": { - "target": "com.amazonaws.bedrockagent#KnowledgeBaseStatus", - "traits": { - "smithy.api#documentation": "The status of the knowledge base and whether it has been successfully deleted.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrockagent#DeletePrompt": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#DeletePromptRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#DeletePromptResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrockagent#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrockagent#ConflictException" - }, - { - "target": "com.amazonaws.bedrockagent#InternalServerException" - }, - { - "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrockagent#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes a prompt or a version of it, depending on whether you include the promptVersion field or not. For more information, see Delete prompts from the Prompt management tool and Delete a version of a prompt from the Prompt management tool in the Amazon Bedrock User Guide.
The unique identifier of the prompt.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "promptVersion": { - "target": "com.amazonaws.bedrockagent#NumericalVersion", - "traits": { - "smithy.api#documentation": "The version of the prompt to delete. To delete the prompt, omit this field.
", - "smithy.api#httpQuery": "promptVersion" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrockagent#DeletePromptResponse": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.bedrockagent#PromptId", - "traits": { - "smithy.api#documentation": "The unique identifier of the prompt that was deleted.
", - "smithy.api#required": {} - } - }, - "version": { - "target": "com.amazonaws.bedrockagent#NumericalVersion", - "traits": { - "smithy.api#documentation": "The version of the prompt that was deleted.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrockagent#Description": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 200 - } - } - }, - "com.amazonaws.bedrockagent#Dimensions": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 0, - "max": 4096 - } - } - }, - "com.amazonaws.bedrockagent#DisassociateAgentKnowledgeBase": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#DisassociateAgentKnowledgeBaseRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#DisassociateAgentKnowledgeBaseResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrockagent#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrockagent#ConflictException" - }, - { - "target": "com.amazonaws.bedrockagent#InternalServerException" - }, - { - "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrockagent#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Disassociates a knowledge base from an agent.
", - "smithy.api#http": { - "code": 204, - "method": "DELETE", - "uri": "/agents/{agentId}/agentversions/{agentVersion}/knowledgebases/{knowledgeBaseId}/" - }, - "smithy.api#idempotent": {}, - "smithy.api#tags": ["console"] - } - }, - "com.amazonaws.bedrockagent#DisassociateAgentKnowledgeBaseRequest": { - "type": "structure", - "members": { - "agentId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the agent from which to disassociate the knowledge base.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "agentVersion": { - "target": "com.amazonaws.bedrockagent#DraftVersion", - "traits": { - "smithy.api#documentation": "The version of the agent from which to disassociate the knowledge base.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "knowledgeBaseId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the knowledge base to disassociate.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrockagent#DisassociateAgentKnowledgeBaseResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrockagent#DraftVersion": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 5, - "max": 5 - }, - "smithy.api#pattern": "^DRAFT$" - } - }, - "com.amazonaws.bedrockagent#EmbeddingModelConfiguration": { - "type": "structure", - "members": { - "bedrockEmbeddingModelConfiguration": { - "target": "com.amazonaws.bedrockagent#BedrockEmbeddingModelConfiguration", - "traits": { - "smithy.api#documentation": "The vector configuration details on the Bedrock embeddings model.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The configuration details for the embeddings model.
" - } - }, - "com.amazonaws.bedrockagent#EnabledMemoryTypes": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrockagent#MemoryType" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1 - } - } - }, - "com.amazonaws.bedrockagent#FailureReason": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 2048 - } - } - }, - "com.amazonaws.bedrockagent#FailureReasons": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrockagent#FailureReason" - }, - "traits": { - "smithy.api#length": { - "max": 2048 - } - } - }, - "com.amazonaws.bedrockagent#FieldName": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 2048 - }, - "smithy.api#pattern": "^.*$" - } - }, - "com.amazonaws.bedrockagent#FilterList": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrockagent#FilterPattern" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 25 - }, - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.bedrockagent#FilterPattern": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1000 - }, - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.bedrockagent#FilteredObjectType": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - }, - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.bedrockagent#FixedSizeChunkingConfiguration": { - "type": "structure", - "members": { - "maxTokens": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "The maximum number of tokens to include in a chunk.
", - "smithy.api#range": { - "min": 1 - }, - "smithy.api#required": {} - } - }, - "overlapPercentage": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "The percentage of overlap between adjacent chunks of a data source.
", - "smithy.api#range": { - "min": 1, - "max": 99 - }, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Configurations for when you choose fixed-size chunking. If you set the chunkingStrategy as NONE, exclude this field.
The version that the alias maps to.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about a version that the alias maps to.
" - } - }, - "com.amazonaws.bedrockagent#FlowAliasSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrockagent#FlowAliasSummary" - }, - "traits": { - "smithy.api#length": { - "max": 10 - } - } - }, - "com.amazonaws.bedrockagent#FlowAliasSummary": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.bedrockagent#Name", - "traits": { - "smithy.api#documentation": "The name of the alias.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#Description", - "traits": { - "smithy.api#documentation": "A description of the alias.
" - } - }, - "routingConfiguration": { - "target": "com.amazonaws.bedrockagent#FlowAliasRoutingConfiguration", - "traits": { - "smithy.api#documentation": "A list of configurations about the versions that the alias maps to. Currently, you can only specify one.
", - "smithy.api#required": {} - } - }, - "flowId": { - "target": "com.amazonaws.bedrockagent#FlowId", - "traits": { - "smithy.api#documentation": "The unique identifier of the flow.
", - "smithy.api#required": {} - } - }, - "id": { - "target": "com.amazonaws.bedrockagent#FlowAliasId", - "traits": { - "smithy.api#documentation": "The unique identifier of the alias of the flow.
", - "smithy.api#required": {} - } - }, - "arn": { - "target": "com.amazonaws.bedrockagent#FlowAliasArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the alias.
", - "smithy.api#required": {} - } - }, - "createdAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the alias was created.
", - "smithy.api#required": {} - } - }, - "updatedAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the alias was last updated.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about an alias of a flow.
\nThis data type is used in the following API operations:
\nA name for the condition that you can reference.
", - "smithy.api#required": {} - } - }, - "expression": { - "target": "com.amazonaws.bedrockagent#FlowConditionExpression", - "traits": { - "smithy.api#documentation": "Defines the condition. You must refer to at least one of the inputs in the condition. For more information, expand the Condition node section in Node types in prompt flows.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Defines a condition in the condition node.
", - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.bedrockagent#FlowConditionExpression": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - }, - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.bedrockagent#FlowConditionName": { - "type": "string", - "traits": { - "smithy.api#pattern": "^[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}$" - } - }, - "com.amazonaws.bedrockagent#FlowConditionalConnectionConfiguration": { - "type": "structure", - "members": { - "condition": { - "target": "com.amazonaws.bedrockagent#FlowConditionName", - "traits": { - "smithy.api#documentation": "The condition that triggers this connection. For more information about how to write conditions, see the Condition node type in the Node types topic in the Amazon Bedrock User Guide.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "The configuration of a connection between a condition node and another node.
" - } - }, - "com.amazonaws.bedrockagent#FlowConditions": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrockagent#FlowCondition" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 5 - }, - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.bedrockagent#FlowConnection": { - "type": "structure", - "members": { - "type": { - "target": "com.amazonaws.bedrockagent#FlowConnectionType", - "traits": { - "smithy.api#documentation": "Whether the source node that the connection begins from is a condition node (Conditional) or not (Data).
A name for the connection that you can reference.
", - "smithy.api#required": {} - } - }, - "source": { - "target": "com.amazonaws.bedrockagent#FlowNodeName", - "traits": { - "smithy.api#documentation": "The node that the connection starts at.
", - "smithy.api#required": {} - } - }, - "target": { - "target": "com.amazonaws.bedrockagent#FlowNodeName", - "traits": { - "smithy.api#documentation": "The node that the connection ends at.
", - "smithy.api#required": {} - } - }, - "configuration": { - "target": "com.amazonaws.bedrockagent#FlowConnectionConfiguration", - "traits": { - "smithy.api#documentation": "The configuration of the connection.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about a connection between two nodes in the flow.
" - } - }, - "com.amazonaws.bedrockagent#FlowConnectionConfiguration": { - "type": "union", - "members": { - "data": { - "target": "com.amazonaws.bedrockagent#FlowDataConnectionConfiguration", - "traits": { - "smithy.api#documentation": "The configuration of a connection originating from a node that isn't a Condition node.
" - } - }, - "conditional": { - "target": "com.amazonaws.bedrockagent#FlowConditionalConnectionConfiguration", - "traits": { - "smithy.api#documentation": "The configuration of a connection originating from a Condition node.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The configuration of the connection.
" - } - }, - "com.amazonaws.bedrockagent#FlowConnectionName": { - "type": "string", - "traits": { - "smithy.api#pattern": "^[a-zA-Z]([_]?[0-9a-zA-Z]){1,100}$" - } - }, - "com.amazonaws.bedrockagent#FlowConnectionType": { - "type": "enum", - "members": { - "DATA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Data" - } - }, - "CONDITIONAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Conditional" - } - } - } - }, - "com.amazonaws.bedrockagent#FlowConnections": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrockagent#FlowConnection" - }, - "traits": { - "smithy.api#length": { - "max": 20 - } - } - }, - "com.amazonaws.bedrockagent#FlowDataConnectionConfiguration": { - "type": "structure", - "members": { - "sourceOutput": { - "target": "com.amazonaws.bedrockagent#FlowNodeOutputName", - "traits": { - "smithy.api#documentation": "The name of the output in the source node that the connection begins from.
", - "smithy.api#required": {} - } - }, - "targetInput": { - "target": "com.amazonaws.bedrockagent#FlowNodeInputName", - "traits": { - "smithy.api#documentation": "The name of the input in the target node that the connection ends at.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "The configuration of a connection originating from a node that isn't a Condition node.
" - } - }, - "com.amazonaws.bedrockagent#FlowDefinition": { - "type": "structure", - "members": { - "nodes": { - "target": "com.amazonaws.bedrockagent#FlowNodes", - "traits": { - "smithy.api#documentation": "An array of node definitions in the flow.
" - } - }, - "connections": { - "target": "com.amazonaws.bedrockagent#FlowConnections", - "traits": { - "smithy.api#documentation": "An array of connection definitions in the flow.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The definition of the nodes and connections between nodes in the flow.
" - } - }, - "com.amazonaws.bedrockagent#FlowDescription": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 200 - } - } - }, - "com.amazonaws.bedrockagent#FlowExecutionRoleArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 2048 - }, - "smithy.api#pattern": "^arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/(service-role/)?.+$" - } - }, - "com.amazonaws.bedrockagent#FlowId": { - "type": "string", - "traits": { - "smithy.api#pattern": "^[0-9a-zA-Z]{10}$" - } - }, - "com.amazonaws.bedrockagent#FlowIdentifier": { - "type": "string", - "traits": { - "smithy.api#pattern": "^(arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10})|([0-9a-zA-Z]{10})$" - } - }, - "com.amazonaws.bedrockagent#FlowName": { - "type": "string", - "traits": { - "smithy.api#pattern": "^([0-9a-zA-Z][_-]?){1,100}$" - } - }, - "com.amazonaws.bedrockagent#FlowNode": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.bedrockagent#FlowNodeName", - "traits": { - "smithy.api#documentation": "A name for the node.
", - "smithy.api#required": {} - } - }, - "type": { - "target": "com.amazonaws.bedrockagent#FlowNodeType", - "traits": { - "smithy.api#documentation": "The type of node. This value must match the name of the key that you provide in the configuration you provide in the FlowNodeConfiguration field.
Contains configurations for the node.
" - } - }, - "inputs": { - "target": "com.amazonaws.bedrockagent#FlowNodeInputs", - "traits": { - "smithy.api#documentation": "An array of objects, each of which contains information about an input into the node.
" - } - }, - "outputs": { - "target": "com.amazonaws.bedrockagent#FlowNodeOutputs", - "traits": { - "smithy.api#documentation": "A list of objects, each of which contains information about an output from the node.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains configurations about a node in the flow.
" - } - }, - "com.amazonaws.bedrockagent#FlowNodeConfiguration": { - "type": "union", - "members": { - "input": { - "target": "com.amazonaws.bedrockagent#InputFlowNodeConfiguration", - "traits": { - "smithy.api#documentation": "Contains configurations for an input flow node in your flow. The first node in the flow. inputs can't be specified for this node.
Contains configurations for an output flow node in your flow. The last node in the flow. outputs can't be specified for this node.
Contains configurations for a knowledge base node in your flow. Queries a knowledge base and returns the retrieved results or generated response.
" - } - }, - "condition": { - "target": "com.amazonaws.bedrockagent#ConditionFlowNodeConfiguration", - "traits": { - "smithy.api#documentation": "Contains configurations for a Condition node in your flow. Defines conditions that lead to different branches of the flow.
" - } - }, - "lex": { - "target": "com.amazonaws.bedrockagent#LexFlowNodeConfiguration", - "traits": { - "smithy.api#documentation": "Contains configurations for a Lex node in your flow. Invokes an Amazon Lex bot to identify the intent of the input and return the intent as the output.
" - } - }, - "prompt": { - "target": "com.amazonaws.bedrockagent#PromptFlowNodeConfiguration", - "traits": { - "smithy.api#documentation": "Contains configurations for a prompt node in your flow. Runs a prompt and generates the model response as the output. You can use a prompt from Prompt management or you can configure one in this node.
" - } - }, - "lambdaFunction": { - "target": "com.amazonaws.bedrockagent#LambdaFunctionFlowNodeConfiguration", - "traits": { - "smithy.api#documentation": "Contains configurations for a Lambda function node in your flow. Invokes an Lambda function.
" - } - }, - "storage": { - "target": "com.amazonaws.bedrockagent#StorageFlowNodeConfiguration", - "traits": { - "smithy.api#documentation": "Contains configurations for a Storage node in your flow. Stores an input in an Amazon S3 location.
" - } - }, - "agent": { - "target": "com.amazonaws.bedrockagent#AgentFlowNodeConfiguration", - "traits": { - "smithy.api#documentation": "Contains configurations for an agent node in your flow. Invokes an alias of an agent and returns the response.
" - } - }, - "retrieval": { - "target": "com.amazonaws.bedrockagent#RetrievalFlowNodeConfiguration", - "traits": { - "smithy.api#documentation": "Contains configurations for a Retrieval node in your flow. Retrieves data from an Amazon S3 location and returns it as the output.
" - } - }, - "iterator": { - "target": "com.amazonaws.bedrockagent#IteratorFlowNodeConfiguration", - "traits": { - "smithy.api#documentation": "Contains configurations for an iterator node in your flow. Takes an input that is an array and iteratively sends each item of the array as an output to the following node. The size of the array is also returned in the output.
\nThe output flow node at the end of the flow iteration will return a response for each member of the array. To return only one response, you can include a collector node downstream from the iterator node.
" - } - }, - "collector": { - "target": "com.amazonaws.bedrockagent#CollectorFlowNodeConfiguration", - "traits": { - "smithy.api#documentation": "Contains configurations for a collector node in your flow. Collects an iteration of inputs and consolidates them into an array of outputs.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains configurations for a node in your flow. For more information, see Node types in Amazon Bedrock works in the Amazon Bedrock User Guide.
" - } - }, - "com.amazonaws.bedrockagent#FlowNodeIODataType": { - "type": "enum", - "members": { - "STRING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "String" - } - }, - "NUMBER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Number" - } - }, - "BOOLEAN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Boolean" - } - }, - "OBJECT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Object" - } - }, - "ARRAY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Array" - } - } - } - }, - "com.amazonaws.bedrockagent#FlowNodeInput": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.bedrockagent#FlowNodeInputName", - "traits": { - "smithy.api#documentation": "A name for the input that you can reference.
", - "smithy.api#required": {} - } - }, - "type": { - "target": "com.amazonaws.bedrockagent#FlowNodeIODataType", - "traits": { - "smithy.api#documentation": "The data type of the input. If the input doesn't match this type at runtime, a validation error will be thrown.
", - "smithy.api#required": {} - } - }, - "expression": { - "target": "com.amazonaws.bedrockagent#FlowNodeInputExpression", - "traits": { - "smithy.api#documentation": "An expression that formats the input for the node. For an explanation of how to create expressions, see Expressions in Prompt flows in Amazon Bedrock.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Contains configurations for an input to a node.
" - } - }, - "com.amazonaws.bedrockagent#FlowNodeInputExpression": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - }, - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.bedrockagent#FlowNodeInputName": { - "type": "string", - "traits": { - "smithy.api#pattern": "^[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}$" - } - }, - "com.amazonaws.bedrockagent#FlowNodeInputs": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrockagent#FlowNodeInput" - }, - "traits": { - "smithy.api#length": { - "max": 5 - } - } - }, - "com.amazonaws.bedrockagent#FlowNodeName": { - "type": "string", - "traits": { - "smithy.api#pattern": "^[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}$" - } - }, - "com.amazonaws.bedrockagent#FlowNodeOutput": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.bedrockagent#FlowNodeOutputName", - "traits": { - "smithy.api#documentation": "A name for the output that you can reference.
", - "smithy.api#required": {} - } - }, - "type": { - "target": "com.amazonaws.bedrockagent#FlowNodeIODataType", - "traits": { - "smithy.api#documentation": "The data type of the output. If the output doesn't match this type at runtime, a validation error will be thrown.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Contains configurations for an output from a node.
" - } - }, - "com.amazonaws.bedrockagent#FlowNodeOutputName": { - "type": "string", - "traits": { - "smithy.api#pattern": "^[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}$" - } - }, - "com.amazonaws.bedrockagent#FlowNodeOutputs": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrockagent#FlowNodeOutput" - }, - "traits": { - "smithy.api#length": { - "max": 5 - } - } - }, - "com.amazonaws.bedrockagent#FlowNodeType": { - "type": "enum", - "members": { - "INPUT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Input" - } - }, - "OUTPUT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Output" - } - }, - "KNOWLEDGE_BASE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "KnowledgeBase" - } - }, - "CONDITION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Condition" - } - }, - "LEX": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Lex" - } - }, - "PROMPT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Prompt" - } - }, - "LAMBDA_FUNCTION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LambdaFunction" - } - }, - "STORAGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Storage" - } - }, - "AGENT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Agent" - } - }, - "RETRIEVAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Retrieval" - } - }, - "ITERATOR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Iterator" - } - }, - "COLLECTOR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Collector" - } - } - } - }, - "com.amazonaws.bedrockagent#FlowNodes": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrockagent#FlowNode" - }, - "traits": { - "smithy.api#length": { - "max": 20 - }, - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.bedrockagent#FlowResource": { - "type": "resource", - "identifiers": { - "flowIdentifier": { - "target": "com.amazonaws.bedrockagent#FlowIdentifier" - } - }, - "create": { - "target": "com.amazonaws.bedrockagent#CreateFlow" - }, - "read": { - "target": "com.amazonaws.bedrockagent#GetFlow" - }, - "update": { - "target": "com.amazonaws.bedrockagent#UpdateFlow" - }, - "delete": { - "target": "com.amazonaws.bedrockagent#DeleteFlow" - }, - "list": { - "target": "com.amazonaws.bedrockagent#ListFlows" - }, - "operations": [ - { - "target": "com.amazonaws.bedrockagent#PrepareFlow" - } - ], - "resources": [ - { - "target": "com.amazonaws.bedrockagent#FlowAliasResource" + "com.amazonaws.bedrockagent#AgentAliasHistoryEvents": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#AgentAliasHistoryEvent" + }, + "traits": { + "smithy.api#length": { + "max": 10 + } + } }, - { - "target": "com.amazonaws.bedrockagent#FlowVersionResource" - } - ], - "traits": { - "aws.cloudformation#cfnResource": { - "name": "Flow" - } - } - }, - "com.amazonaws.bedrockagent#FlowStatus": { - "type": "enum", - "members": { - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Failed" - } - }, - "PREPARED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Prepared" - } - }, - "PREPARING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Preparing" - } - }, - "NOT_PREPARED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NotPrepared" - } - } - } - }, - "com.amazonaws.bedrockagent#FlowSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrockagent#FlowSummary" - }, - "traits": { - "smithy.api#length": { - "max": 10 - } - } - }, - "com.amazonaws.bedrockagent#FlowSummary": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.bedrockagent#FlowName", - "traits": { - "smithy.api#documentation": "The name of the flow.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#FlowDescription", - "traits": { - "smithy.api#documentation": "A description of the flow.
" - } - }, - "id": { - "target": "com.amazonaws.bedrockagent#FlowId", - "traits": { - "smithy.api#documentation": "The unique identifier of the flow.
", - "smithy.api#required": {} - } - }, - "arn": { - "target": "com.amazonaws.bedrockagent#FlowArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the flow.
", - "smithy.api#required": {} - } - }, - "status": { - "target": "com.amazonaws.bedrockagent#FlowStatus", - "traits": { - "smithy.api#documentation": "The status of the flow. The following statuses are possible:
\nNotPrepared – The flow has been created or updated, but hasn't been prepared. If you just created the flow, you can't test it. If you updated the flow, the DRAFT version won't contain the latest changes for testing. Send a PrepareFlow request to package the latest changes into the DRAFT version.
Preparing – The flow is being prepared so that the DRAFT version contains the latest changes for testing.
Prepared – The flow is prepared and the DRAFT version contains the latest changes for testing.
Failed – The last API operation that you invoked on the flow failed. Send a GetFlow request and check the error message in the validations field.
The time at which the flow was created.
", - "smithy.api#required": {} - } - }, - "updatedAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the flow was last updated.
", - "smithy.api#required": {} - } - }, - "version": { - "target": "com.amazonaws.bedrockagent#DraftVersion", - "traits": { - "smithy.api#documentation": "The latest version of the flow.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Contains the definition of a flow.
" - } - }, - "com.amazonaws.bedrockagent#FlowValidation": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.bedrockagent#NonBlankString", - "traits": { - "smithy.api#documentation": "A message describing the validation error.
", - "smithy.api#required": {} - } - }, - "severity": { - "target": "com.amazonaws.bedrockagent#FlowValidationSeverity", - "traits": { - "smithy.api#documentation": "The severity of the issue described in the message.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about validation of the flow.
\nThis data type is used in the following API operations:
\n\n GetFlow response\n
\nThe unique identifier of the flow.
", - "smithy.api#required": {} - } - }, - "arn": { - "target": "com.amazonaws.bedrockagent#FlowArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the flow that the version belongs to.
", - "smithy.api#required": {} - } - }, - "status": { - "target": "com.amazonaws.bedrockagent#FlowStatus", - "traits": { - "smithy.api#documentation": "The status of the flow.
", - "smithy.api#required": {} - } - }, - "createdAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at the version was created.
", - "smithy.api#required": {} - } - }, - "version": { - "target": "com.amazonaws.bedrockagent#NumericalVersion", - "traits": { - "smithy.api#documentation": "The version of the flow.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about a version of a flow.
\nThis data type is used in the following API operations:
\nA name for the function.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#FunctionDescription", - "traits": { - "smithy.api#documentation": "A description of the function and its purpose.
" - } - }, - "parameters": { - "target": "com.amazonaws.bedrockagent#ParameterMap", - "traits": { - "smithy.api#documentation": "The parameters that the agent elicits from the user to fulfill the function.
" - } - }, - "requireConfirmation": { - "target": "com.amazonaws.bedrockagent#RequireConfirmation", - "traits": { - "smithy.api#documentation": "Contains information if user confirmation is required to invoke the function.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Defines parameters that the agent needs to invoke from the user to complete the function. Corresponds to an action in an action group.
\nThis data type is used in the following API operations:
\nA list of functions that each define an action in the action group.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Defines functions that each define parameters that the agent needs to invoke from the user. Each function represents an action in an action group.
\nThis data type is used in the following API operations:
\nGets information about an agent.
", - "smithy.api#http": { - "code": 200, - "method": "GET", - "uri": "/agents/{agentId}/" - }, - "smithy.api#readonly": {}, - "smithy.api#tags": ["console"] - } - }, - "com.amazonaws.bedrockagent#GetAgentActionGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#GetAgentActionGroupRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#GetAgentActionGroupResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrockagent#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrockagent#InternalServerException" - }, - { - "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrockagent#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Gets information about an action group for an agent.
", - "smithy.api#http": { - "code": 200, - "method": "GET", - "uri": "/agents/{agentId}/agentversions/{agentVersion}/actiongroups/{actionGroupId}/" - }, - "smithy.api#readonly": {}, - "smithy.api#tags": ["console"] - } - }, - "com.amazonaws.bedrockagent#GetAgentActionGroupRequest": { - "type": "structure", - "members": { - "agentId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the agent that the action group belongs to.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "agentVersion": { - "target": "com.amazonaws.bedrockagent#Version", - "traits": { - "smithy.api#documentation": "The version of the agent that the action group belongs to.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "actionGroupId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the action group for which to get information.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrockagent#GetAgentActionGroupResponse": { - "type": "structure", - "members": { - "agentActionGroup": { - "target": "com.amazonaws.bedrockagent#AgentActionGroup", - "traits": { - "smithy.api#documentation": "Contains details about the action group.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrockagent#GetAgentAlias": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#GetAgentAliasRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#GetAgentAliasResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrockagent#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrockagent#InternalServerException" - }, - { - "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrockagent#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Gets information about an alias of an agent.
", - "smithy.api#http": { - "code": 200, - "method": "GET", - "uri": "/agents/{agentId}/agentaliases/{agentAliasId}/" - }, - "smithy.api#readonly": {}, - "smithy.api#tags": ["console"] - } - }, - "com.amazonaws.bedrockagent#GetAgentAliasRequest": { - "type": "structure", - "members": { - "agentId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the agent to which the alias to get information belongs.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "agentAliasId": { - "target": "com.amazonaws.bedrockagent#AgentAliasId", - "traits": { - "smithy.api#documentation": "The unique identifier of the alias for which to get information.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrockagent#GetAgentAliasResponse": { - "type": "structure", - "members": { - "agentAlias": { - "target": "com.amazonaws.bedrockagent#AgentAlias", - "traits": { - "smithy.api#documentation": "Contains information about the alias.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrockagent#GetAgentKnowledgeBase": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#GetAgentKnowledgeBaseRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#GetAgentKnowledgeBaseResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrockagent#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrockagent#InternalServerException" - }, - { - "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrockagent#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Gets information about a knowledge base associated with an agent.
", - "smithy.api#http": { - "code": 200, - "method": "GET", - "uri": "/agents/{agentId}/agentversions/{agentVersion}/knowledgebases/{knowledgeBaseId}/" - }, - "smithy.api#readonly": {}, - "smithy.api#tags": ["console"] - } - }, - "com.amazonaws.bedrockagent#GetAgentKnowledgeBaseRequest": { - "type": "structure", - "members": { - "agentId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the agent with which the knowledge base is associated.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "agentVersion": { - "target": "com.amazonaws.bedrockagent#Version", - "traits": { - "smithy.api#documentation": "The version of the agent with which the knowledge base is associated.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "knowledgeBaseId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the knowledge base associated with the agent.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrockagent#GetAgentKnowledgeBaseResponse": { - "type": "structure", - "members": { - "agentKnowledgeBase": { - "target": "com.amazonaws.bedrockagent#AgentKnowledgeBase", - "traits": { - "smithy.api#documentation": "Contains details about a knowledge base attached to an agent.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrockagent#GetAgentRequest": { - "type": "structure", - "members": { - "agentId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the agent.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrockagent#GetAgentResponse": { - "type": "structure", - "members": { - "agent": { - "target": "com.amazonaws.bedrockagent#Agent", - "traits": { - "smithy.api#documentation": "Contains details about the agent.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrockagent#GetAgentVersion": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#GetAgentVersionRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#GetAgentVersionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrockagent#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrockagent#InternalServerException" - }, - { - "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrockagent#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Gets details about a version of an agent.
", - "smithy.api#http": { - "code": 200, - "method": "GET", - "uri": "/agents/{agentId}/agentversions/{agentVersion}/" - }, - "smithy.api#readonly": {}, - "smithy.api#tags": ["console"] - } - }, - "com.amazonaws.bedrockagent#GetAgentVersionRequest": { - "type": "structure", - "members": { - "agentId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the agent.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "agentVersion": { - "target": "com.amazonaws.bedrockagent#NumericalVersion", - "traits": { - "smithy.api#documentation": "The version of the agent.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrockagent#GetAgentVersionResponse": { - "type": "structure", - "members": { - "agentVersion": { - "target": "com.amazonaws.bedrockagent#AgentVersion", - "traits": { - "smithy.api#documentation": "Contains details about the version of the agent.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrockagent#GetDataSource": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#GetDataSourceRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#GetDataSourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrockagent#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrockagent#InternalServerException" - }, - { - "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrockagent#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Gets information about a data source.
", - "smithy.api#http": { - "code": 200, - "method": "GET", - "uri": "/knowledgebases/{knowledgeBaseId}/datasources/{dataSourceId}" - }, - "smithy.api#readonly": {}, - "smithy.api#tags": ["console"] - } - }, - "com.amazonaws.bedrockagent#GetDataSourceRequest": { - "type": "structure", - "members": { - "knowledgeBaseId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the knowledge base that the data source was added to.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "dataSourceId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the data source.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrockagent#GetDataSourceResponse": { - "type": "structure", - "members": { - "dataSource": { - "target": "com.amazonaws.bedrockagent#DataSource", - "traits": { - "smithy.api#documentation": "Contains details about the data source.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrockagent#GetFlow": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#GetFlowRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#GetFlowResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrockagent#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrockagent#InternalServerException" - }, - { - "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrockagent#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Retrieves information about a flow. For more information, see Manage a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
", - "smithy.api#http": { - "code": 200, - "method": "GET", - "uri": "/flows/{flowIdentifier}/" - }, - "smithy.api#readonly": {}, - "smithy.api#tags": ["console"] - } - }, - "com.amazonaws.bedrockagent#GetFlowAlias": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#GetFlowAliasRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#GetFlowAliasResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrockagent#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrockagent#InternalServerException" - }, - { - "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrockagent#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Retrieves information about a flow. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
", - "smithy.api#http": { - "code": 200, - "method": "GET", - "uri": "/flows/{flowIdentifier}/aliases/{aliasIdentifier}" - }, - "smithy.api#readonly": {}, - "smithy.api#tags": ["console"] - } - }, - "com.amazonaws.bedrockagent#GetFlowAliasRequest": { - "type": "structure", - "members": { - "flowIdentifier": { - "target": "com.amazonaws.bedrockagent#FlowIdentifier", - "traits": { - "smithy.api#documentation": "The unique identifier of the flow that the alias belongs to.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "aliasIdentifier": { - "target": "com.amazonaws.bedrockagent#FlowAliasIdentifier", - "traits": { - "smithy.api#documentation": "The unique identifier of the alias for which to retrieve information.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrockagent#GetFlowAliasResponse": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.bedrockagent#Name", - "traits": { - "smithy.api#documentation": "The name of the alias.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#Description", - "traits": { - "smithy.api#documentation": "The description of the flow.
" - } - }, - "routingConfiguration": { - "target": "com.amazonaws.bedrockagent#FlowAliasRoutingConfiguration", - "traits": { - "smithy.api#documentation": "Contains information about the version that the alias is mapped to.
", - "smithy.api#required": {} - } - }, - "flowId": { - "target": "com.amazonaws.bedrockagent#FlowId", - "traits": { - "smithy.api#documentation": "The unique identifier of the flow that the alias belongs to.
", - "smithy.api#required": {} - } - }, - "id": { - "target": "com.amazonaws.bedrockagent#FlowAliasId", - "traits": { - "smithy.api#documentation": "The unique identifier of the alias of the flow.
", - "smithy.api#required": {} - } - }, - "arn": { - "target": "com.amazonaws.bedrockagent#FlowAliasArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the flow.
", - "smithy.api#required": {} - } - }, - "createdAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the flow was created.
", - "smithy.api#required": {} - } - }, - "updatedAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the alias was last updated.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrockagent#GetFlowRequest": { - "type": "structure", - "members": { - "flowIdentifier": { - "target": "com.amazonaws.bedrockagent#FlowIdentifier", - "traits": { - "smithy.api#documentation": "The unique identifier of the flow.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrockagent#GetFlowResponse": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.bedrockagent#FlowName", - "traits": { - "smithy.api#documentation": "The name of the flow.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#FlowDescription", - "traits": { - "smithy.api#documentation": "The description of the flow.
" - } - }, - "executionRoleArn": { - "target": "com.amazonaws.bedrockagent#FlowExecutionRoleArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the service role with permissions to create a flow. For more information, see Create a service row for flows in the Amazon Bedrock User Guide.
", - "smithy.api#required": {} - } - }, - "customerEncryptionKeyArn": { - "target": "com.amazonaws.bedrockagent#KmsKeyArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key that the flow is encrypted with.
" - } - }, - "id": { - "target": "com.amazonaws.bedrockagent#FlowId", - "traits": { - "smithy.api#documentation": "The unique identifier of the flow.
", - "smithy.api#required": {} - } - }, - "arn": { - "target": "com.amazonaws.bedrockagent#FlowArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the flow.
", - "smithy.api#required": {} - } - }, - "status": { - "target": "com.amazonaws.bedrockagent#FlowStatus", - "traits": { - "smithy.api#documentation": "The status of the flow. The following statuses are possible:
\nNotPrepared – The flow has been created or updated, but hasn't been prepared. If you just created the flow, you can't test it. If you updated the flow, the DRAFT version won't contain the latest changes for testing. Send a PrepareFlow request to package the latest changes into the DRAFT version.
Preparing – The flow is being prepared so that the DRAFT version contains the latest changes for testing.
Prepared – The flow is prepared and the DRAFT version contains the latest changes for testing.
Failed – The last API operation that you invoked on the flow failed. Send a GetFlow request and check the error message in the validations field.
The time at which the flow was created.
", - "smithy.api#required": {} - } - }, - "updatedAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the flow was last updated.
", - "smithy.api#required": {} - } - }, - "version": { - "target": "com.amazonaws.bedrockagent#DraftVersion", - "traits": { - "smithy.api#documentation": "The version of the flow for which information was retrieved.
", - "smithy.api#required": {} - } - }, - "definition": { - "target": "com.amazonaws.bedrockagent#FlowDefinition", - "traits": { - "smithy.api#documentation": "The definition of the nodes and connections between the nodes in the flow.
" - } - }, - "validations": { - "target": "com.amazonaws.bedrockagent#FlowValidations", - "traits": { - "smithy.api#documentation": "A list of validation error messages related to the last failed operation on the flow.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrockagent#GetFlowVersion": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#GetFlowVersionRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#GetFlowVersionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrockagent#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrockagent#InternalServerException" - }, - { - "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrockagent#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Retrieves information about a version of a flow. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
", - "smithy.api#http": { - "code": 200, - "method": "GET", - "uri": "/flows/{flowIdentifier}/versions/{flowVersion}/" - }, - "smithy.api#readonly": {}, - "smithy.api#tags": ["console"] - } - }, - "com.amazonaws.bedrockagent#GetFlowVersionRequest": { - "type": "structure", - "members": { - "flowIdentifier": { - "target": "com.amazonaws.bedrockagent#FlowIdentifier", - "traits": { - "smithy.api#documentation": "The unique identifier of the flow for which to get information.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "flowVersion": { - "target": "com.amazonaws.bedrockagent#NumericalVersion", - "traits": { - "smithy.api#documentation": "The version of the flow for which to get information.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrockagent#GetFlowVersionResponse": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.bedrockagent#FlowName", - "traits": { - "smithy.api#documentation": "The name of the version.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#FlowDescription", - "traits": { - "smithy.api#documentation": "The description of the flow.
" - } - }, - "executionRoleArn": { - "target": "com.amazonaws.bedrockagent#FlowExecutionRoleArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the service role with permissions to create a flow. For more information, see Create a service role for flows in Amazon Bedrock in the Amazon Bedrock User Guide.
", - "smithy.api#required": {} - } - }, - "customerEncryptionKeyArn": { - "target": "com.amazonaws.bedrockagent#KmsKeyArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key that the version of the flow is encrypted with.
" - } - }, - "id": { - "target": "com.amazonaws.bedrockagent#FlowId", - "traits": { - "smithy.api#documentation": "The unique identifier of the flow.
", - "smithy.api#required": {} - } - }, - "arn": { - "target": "com.amazonaws.bedrockagent#FlowArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the flow.
", - "smithy.api#required": {} - } - }, - "status": { - "target": "com.amazonaws.bedrockagent#FlowStatus", - "traits": { - "smithy.api#documentation": "The status of the flow.
", - "smithy.api#required": {} - } - }, - "createdAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the flow was created.
", - "smithy.api#required": {} - } - }, - "version": { - "target": "com.amazonaws.bedrockagent#NumericalVersion", - "traits": { - "smithy.api#documentation": "The version of the flow for which information was retrieved.
", - "smithy.api#required": {} - } - }, - "definition": { - "target": "com.amazonaws.bedrockagent#FlowDefinition", - "traits": { - "smithy.api#documentation": "The definition of the nodes and connections between nodes in the flow.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrockagent#GetIngestionJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#GetIngestionJobRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#GetIngestionJobResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrockagent#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrockagent#InternalServerException" - }, - { - "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrockagent#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Gets information about a ingestion job, in which a data source is added to a knowledge base.
", - "smithy.api#http": { - "code": 200, - "method": "GET", - "uri": "/knowledgebases/{knowledgeBaseId}/datasources/{dataSourceId}/ingestionjobs/{ingestionJobId}" - }, - "smithy.api#readonly": {}, - "smithy.api#tags": ["console"] - } - }, - "com.amazonaws.bedrockagent#GetIngestionJobRequest": { - "type": "structure", - "members": { - "knowledgeBaseId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the knowledge base for which the ingestion job applies.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "dataSourceId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the data source in the ingestion job.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ingestionJobId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the ingestion job.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrockagent#GetIngestionJobResponse": { - "type": "structure", - "members": { - "ingestionJob": { - "target": "com.amazonaws.bedrockagent#IngestionJob", - "traits": { - "smithy.api#documentation": "Contains details about the ingestion job.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrockagent#GetKnowledgeBase": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#GetKnowledgeBaseRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#GetKnowledgeBaseResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrockagent#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrockagent#InternalServerException" - }, - { - "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrockagent#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Gets information about a knoweldge base.
", - "smithy.api#http": { - "code": 200, - "method": "GET", - "uri": "/knowledgebases/{knowledgeBaseId}" - }, - "smithy.api#readonly": {}, - "smithy.api#tags": ["console"] - } - }, - "com.amazonaws.bedrockagent#GetKnowledgeBaseRequest": { - "type": "structure", - "members": { - "knowledgeBaseId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the knowledge base for which to get information.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrockagent#GetKnowledgeBaseResponse": { - "type": "structure", - "members": { - "knowledgeBase": { - "target": "com.amazonaws.bedrockagent#KnowledgeBase", - "traits": { - "smithy.api#documentation": "Contains details about the knowledge base.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrockagent#GetPrompt": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#GetPromptRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#GetPromptResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrockagent#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrockagent#InternalServerException" - }, - { - "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrockagent#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Retrieves information about the working draft (DRAFT version) of a prompt or a version of it, depending on whether you include the promptVersion field or not. For more information, see View information about prompts using Prompt management and View information about a version of your prompt in the Amazon Bedrock User Guide.
The unique identifier of the prompt.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "promptVersion": { - "target": "com.amazonaws.bedrockagent#Version", - "traits": { - "smithy.api#documentation": "The version of the prompt about which you want to retrieve information. Omit this field to return information about the working draft of the prompt.
", - "smithy.api#httpQuery": "promptVersion" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrockagent#GetPromptResponse": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.bedrockagent#PromptName", - "traits": { - "smithy.api#documentation": "The name of the prompt.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#PromptDescription", - "traits": { - "smithy.api#documentation": "The descriptino of the prompt.
" - } - }, - "customerEncryptionKeyArn": { - "target": "com.amazonaws.bedrockagent#KmsKeyArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key that the prompt is encrypted with.
" - } - }, - "defaultVariant": { - "target": "com.amazonaws.bedrockagent#PromptVariantName", - "traits": { - "smithy.api#documentation": "The name of the default variant for the prompt. This value must match the name field in the relevant PromptVariant object.
A list of objects, each containing details about a variant of the prompt.
" - } - }, - "id": { - "target": "com.amazonaws.bedrockagent#PromptId", - "traits": { - "smithy.api#documentation": "The unique identifier of the prompt.
", - "smithy.api#required": {} - } - }, - "arn": { - "target": "com.amazonaws.bedrockagent#PromptArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the prompt or the prompt version (if you specified a version in the request).
", - "smithy.api#required": {} - } - }, - "version": { - "target": "com.amazonaws.bedrockagent#Version", - "traits": { - "smithy.api#documentation": "The version of the prompt.
", - "smithy.api#required": {} - } - }, - "createdAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the prompt was created.
", - "smithy.api#required": {} - } - }, - "updatedAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the prompt was last updated.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrockagent#GuardrailConfiguration": { - "type": "structure", - "members": { - "guardrailIdentifier": { - "target": "com.amazonaws.bedrockagent#GuardrailIdentifier", - "traits": { - "smithy.api#documentation": "The unique identifier of the guardrail.
" - } - }, - "guardrailVersion": { - "target": "com.amazonaws.bedrockagent#GuardrailVersion", - "traits": { - "smithy.api#documentation": "The version of the guardrail.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Details about the guardrail associated with an agent.
" - } - }, - "com.amazonaws.bedrockagent#GuardrailIdentifier": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 2048 - }, - "smithy.api#pattern": "^(([a-z0-9]+)|(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+))$" - } - }, - "com.amazonaws.bedrockagent#GuardrailVersion": { - "type": "string", - "traits": { - "smithy.api#pattern": "^(([0-9]{1,8})|(DRAFT))$" - } - }, - "com.amazonaws.bedrockagent#HierarchicalChunkingConfiguration": { - "type": "structure", - "members": { - "levelConfigurations": { - "target": "com.amazonaws.bedrockagent#HierarchicalChunkingLevelConfigurations", - "traits": { - "smithy.api#documentation": "Token settings for each layer.
", - "smithy.api#required": {} - } - }, - "overlapTokens": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "The number of tokens to repeat across chunks in the same layer.
", - "smithy.api#range": { - "min": 1 - }, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Settings for hierarchical document chunking for a data source. Hierarchical chunking splits documents\n into layers of chunks where the first layer contains large chunks, and the second layer contains smaller\n chunks derived from the first layer.
\nYou configure the number of tokens to overlap, or repeat across adjacent chunks. For example,\n if you set overlap tokens to 60, the last 60 tokens in the first chunk are also included at the beginning of\n the second chunk. For each layer, you must also configure the maximum number of tokens in a chunk.
" - } - }, - "com.amazonaws.bedrockagent#HierarchicalChunkingLevelConfiguration": { - "type": "structure", - "members": { - "maxTokens": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "The maximum number of tokens that a chunk can contain in this layer.
", - "smithy.api#range": { - "min": 1, - "max": 8192 - }, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Token settings for a layer in a hierarchical chunking configuration.
" - } - }, - "com.amazonaws.bedrockagent#HierarchicalChunkingLevelConfigurations": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrockagent#HierarchicalChunkingLevelConfiguration" - }, - "traits": { - "smithy.api#length": { - "min": 2, - "max": 2 - } - } - }, - "com.amazonaws.bedrockagent#HttpsUrl": { - "type": "string", - "traits": { - "smithy.api#pattern": "^https://[A-Za-z0-9][^\\s]*$" - } - }, - "com.amazonaws.bedrockagent#Id": { - "type": "string", - "traits": { - "smithy.api#pattern": "^[0-9a-zA-Z]{10}$" - } - }, - "com.amazonaws.bedrockagent#InferenceConfiguration": { - "type": "structure", - "members": { - "temperature": { - "target": "com.amazonaws.bedrockagent#Temperature", - "traits": { - "smithy.api#documentation": "The likelihood of the model selecting higher-probability options while generating a response. A lower value makes the model more likely to choose higher-probability options, while a higher value makes the model more likely to choose lower-probability options.
" - } - }, - "topP": { - "target": "com.amazonaws.bedrockagent#TopP", - "traits": { - "smithy.api#documentation": "While generating a response, the model determines the probability of the following token at each point of generation. The value that you set for Top P determines the number of most-likely candidates from which the model chooses the next token in the sequence. For example, if you set topP to 80, the model only selects the next token from the top 80% of the probability distribution of next tokens.
While generating a response, the model determines the probability of the following token at each point of generation. The value that you set for topK is the number of most-likely candidates from which the model chooses the next token in the sequence. For example, if you set topK to 50, the model selects the next token from among the top 50 most likely choices.
The maximum number of tokens to allow in the generated response.
" - } - }, - "stopSequences": { - "target": "com.amazonaws.bedrockagent#StopSequences", - "traits": { - "smithy.api#documentation": "A list of stop sequences. A stop sequence is a sequence of characters that causes the model to stop generating the response.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains inference parameters to use when the agent invokes a foundation model in the part of the agent sequence defined by the promptType. For more information, see Inference parameters for foundation models.
The unique identifier of the knowledge base to which the data source is being added.
", - "smithy.api#required": {} - } - }, - "dataSourceId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the ingested data source.
", - "smithy.api#required": {} - } - }, - "ingestionJobId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the ingestion job.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#Description", - "traits": { - "smithy.api#documentation": "The description of the ingestion job.
" - } - }, - "status": { - "target": "com.amazonaws.bedrockagent#IngestionJobStatus", - "traits": { - "smithy.api#documentation": "The status of the ingestion job.
", - "smithy.api#required": {} - } - }, - "statistics": { - "target": "com.amazonaws.bedrockagent#IngestionJobStatistics", - "traits": { - "smithy.api#documentation": "Contains statistics about the ingestion job.
" - } - }, - "failureReasons": { - "target": "com.amazonaws.bedrockagent#FailureReasons", - "traits": { - "smithy.api#documentation": "A list of reasons that the ingestion job failed.
" - } - }, - "startedAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the ingestion job started.
", - "smithy.api#required": {} - } - }, - "updatedAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the ingestion job was last updated.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Contains details about an ingestion job, which converts a data source to embeddings for a vector store in knowledge base.
\nThis data type is used in the following API operations:
\nThe attribute by which to filter the results.
", - "smithy.api#required": {} - } - }, - "operator": { - "target": "com.amazonaws.bedrockagent#IngestionJobFilterOperator", - "traits": { - "smithy.api#documentation": "The operation to carry out between the attribute and the values.
", - "smithy.api#required": {} - } - }, - "values": { - "target": "com.amazonaws.bedrockagent#IngestionJobFilterValues", - "traits": { - "smithy.api#documentation": "A list of values for the attribute.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Defines a filter by which to filter the results.
" - } - }, - "com.amazonaws.bedrockagent#IngestionJobFilterAttribute": { - "type": "enum", - "members": { - "STATUS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STATUS" - } - } - } - }, - "com.amazonaws.bedrockagent#IngestionJobFilterOperator": { - "type": "enum", - "members": { - "EQ": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EQ" - } - } - } - }, - "com.amazonaws.bedrockagent#IngestionJobFilterValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - }, - "smithy.api#pattern": "^.*$" - } - }, - "com.amazonaws.bedrockagent#IngestionJobFilterValues": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrockagent#IngestionJobFilterValue" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 10 - } - } - }, - "com.amazonaws.bedrockagent#IngestionJobFilters": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrockagent#IngestionJobFilter" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1 - } - } - }, - "com.amazonaws.bedrockagent#IngestionJobResource": { - "type": "resource", - "operations": [ - { - "target": "com.amazonaws.bedrockagent#GetIngestionJob" - }, - { - "target": "com.amazonaws.bedrockagent#ListIngestionJobs" - }, - { - "target": "com.amazonaws.bedrockagent#StartIngestionJob" - } - ] - }, - "com.amazonaws.bedrockagent#IngestionJobSortBy": { - "type": "structure", - "members": { - "attribute": { - "target": "com.amazonaws.bedrockagent#IngestionJobSortByAttribute", - "traits": { - "smithy.api#documentation": "The attribute by which to sort the results.
", - "smithy.api#required": {} - } - }, - "order": { - "target": "com.amazonaws.bedrockagent#SortOrder", - "traits": { - "smithy.api#documentation": "The order by which to sort the results.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Parameters by which to sort the results.
" - } - }, - "com.amazonaws.bedrockagent#IngestionJobSortByAttribute": { - "type": "enum", - "members": { - "STATUS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STATUS" - } - }, - "STARTED_AT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STARTED_AT" - } - } - } - }, - "com.amazonaws.bedrockagent#IngestionJobStatistics": { - "type": "structure", - "members": { - "numberOfDocumentsScanned": { - "target": "smithy.api#PrimitiveLong", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The total number of source documents that were scanned. Includes new, updated, and unchanged documents.
" - } - }, - "numberOfMetadataDocumentsScanned": { - "target": "smithy.api#PrimitiveLong", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The total number of metadata files that were scanned. Includes new, updated, and unchanged files.
" - } - }, - "numberOfNewDocumentsIndexed": { - "target": "smithy.api#PrimitiveLong", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The number of new source documents in the data source that were successfully indexed.
" - } - }, - "numberOfModifiedDocumentsIndexed": { - "target": "smithy.api#PrimitiveLong", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The number of modified source documents in the data source that were successfully indexed.
" - } - }, - "numberOfMetadataDocumentsModified": { - "target": "smithy.api#PrimitiveLong", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The number of metadata files that were updated or deleted.
" - } - }, - "numberOfDocumentsDeleted": { - "target": "smithy.api#PrimitiveLong", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The number of source documents that was deleted.
" - } - }, - "numberOfDocumentsFailed": { - "target": "smithy.api#PrimitiveLong", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The number of source documents that failed to be ingested.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains the statistics for the ingestion job.
" - } - }, - "com.amazonaws.bedrockagent#IngestionJobStatus": { - "type": "enum", - "members": { - "STARTING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STARTING" - } - }, - "IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IN_PROGRESS" - } - }, - "COMPLETE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COMPLETE" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - } - } - }, - "com.amazonaws.bedrockagent#IngestionJobSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrockagent#IngestionJobSummary" - } - }, - "com.amazonaws.bedrockagent#IngestionJobSummary": { - "type": "structure", - "members": { - "knowledgeBaseId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the knowledge base to which the data source is added.
", - "smithy.api#required": {} - } - }, - "dataSourceId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the data source in the ingestion job.
", - "smithy.api#required": {} - } - }, - "ingestionJobId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the ingestion job.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#Description", - "traits": { - "smithy.api#documentation": "The description of the ingestion job.
" - } - }, - "status": { - "target": "com.amazonaws.bedrockagent#IngestionJobStatus", - "traits": { - "smithy.api#documentation": "The status of the ingestion job.
", - "smithy.api#required": {} - } - }, - "startedAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the ingestion job was started.
", - "smithy.api#required": {} - } - }, - "updatedAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the ingestion job was last updated.
", - "smithy.api#required": {} - } - }, - "statistics": { - "target": "com.amazonaws.bedrockagent#IngestionJobStatistics", - "traits": { - "smithy.api#documentation": "Contains statistics for the ingestion job.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains details about an ingestion job.
" - } - }, - "com.amazonaws.bedrockagent#InputFlowNodeConfiguration": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "Contains configurations for the input flow node for a flow. This node takes the input from flow invocation and passes it to the next node in the data type that you specify.
" - } - }, - "com.amazonaws.bedrockagent#Instruction": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 40, - "max": 4000 - }, - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.bedrockagent#IntermediateStorage": { - "type": "structure", - "members": { - "s3Location": { - "target": "com.amazonaws.bedrockagent#S3Location", - "traits": { - "smithy.api#documentation": "An S3 bucket path.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "A location for storing content from data sources temporarily as it is processed by\n custom components in the ingestion pipeline.
" - } - }, - "com.amazonaws.bedrockagent#InternalServerException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.bedrockagent#NonBlankString" - } - }, - "traits": { - "smithy.api#documentation": "An internal server error occurred. Retry your request.
", - "smithy.api#error": "server", - "smithy.api#httpError": 500 - } - }, - "com.amazonaws.bedrockagent#IteratorFlowNodeConfiguration": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "Contains configurations for an iterator node in a flow. Takes an input that is an array and iteratively sends each item of the array as an output to the following node. The size of the array is also returned in the output.
\nThe output flow node at the end of the flow iteration will return a response for each member of the array. To return only one response, you can include a collector node downstream from the iterator node.
" - } - }, - "com.amazonaws.bedrockagent#KmsKeyArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - }, - "smithy.api#pattern": "^arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$" - } - }, - "com.amazonaws.bedrockagent#KnowledgeBase": { - "type": "structure", - "members": { - "knowledgeBaseId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the knowledge base.
", - "smithy.api#required": {} - } - }, - "name": { - "target": "com.amazonaws.bedrockagent#Name", - "traits": { - "smithy.api#documentation": "The name of the knowledge base.
", - "smithy.api#required": {} - } - }, - "knowledgeBaseArn": { - "target": "com.amazonaws.bedrockagent#KnowledgeBaseArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the knowledge base.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#Description", - "traits": { - "smithy.api#documentation": "The description of the knowledge base.
" - } - }, - "roleArn": { - "target": "com.amazonaws.bedrockagent#KnowledgeBaseRoleArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.
", - "smithy.api#required": {} - } - }, - "knowledgeBaseConfiguration": { - "target": "com.amazonaws.bedrockagent#KnowledgeBaseConfiguration", - "traits": { - "smithy.api#documentation": "Contains details about the embeddings configuration of the knowledge base.
", - "smithy.api#required": {} - } - }, - "storageConfiguration": { - "target": "com.amazonaws.bedrockagent#StorageConfiguration", - "traits": { - "smithy.api#documentation": "Contains details about the storage configuration of the knowledge base.
", - "smithy.api#required": {} - } - }, - "status": { - "target": "com.amazonaws.bedrockagent#KnowledgeBaseStatus", - "traits": { - "smithy.api#documentation": "The status of the knowledge base. The following statuses are possible:
\nCREATING – The knowledge base is being created.
\nACTIVE – The knowledge base is ready to be queried.
\nDELETING – The knowledge base is being deleted.
\nUPDATING – The knowledge base is being updated.
\nFAILED – The knowledge base API operation failed.
\nThe time at which the knowledge base was created.
", - "smithy.api#required": {} - } - }, - "updatedAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the knowledge base was last updated.
", - "smithy.api#required": {} - } - }, - "failureReasons": { - "target": "com.amazonaws.bedrockagent#FailureReasons", - "traits": { - "smithy.api#documentation": "A list of reasons that the API operation on the knowledge base failed.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about a knowledge base.
" - } - }, - "com.amazonaws.bedrockagent#KnowledgeBaseArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 128 - }, - "smithy.api#pattern": "^arn:aws(|-cn|-us-gov):bedrock:[a-zA-Z0-9-]*:[0-9]{12}:knowledge-base/[0-9a-zA-Z]+$" - } - }, - "com.amazonaws.bedrockagent#KnowledgeBaseConfiguration": { - "type": "structure", - "members": { - "type": { - "target": "com.amazonaws.bedrockagent#KnowledgeBaseType", - "traits": { - "smithy.api#documentation": "The type of data that the data source is converted into for the knowledge base.
", - "smithy.api#required": {} - } - }, - "vectorKnowledgeBaseConfiguration": { - "target": "com.amazonaws.bedrockagent#VectorKnowledgeBaseConfiguration", - "traits": { - "smithy.api#documentation": "Contains details about the embeddings model that'sused to convert the data source.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains details about the embeddings configuration of the knowledge base.
" - } - }, - "com.amazonaws.bedrockagent#KnowledgeBaseFlowNodeConfiguration": { - "type": "structure", - "members": { - "knowledgeBaseId": { - "target": "com.amazonaws.bedrockagent#KnowledgeBaseId", - "traits": { - "smithy.api#documentation": "The unique identifier of the knowledge base to query.
", - "smithy.api#required": {} - } - }, - "modelId": { - "target": "com.amazonaws.bedrockagent#ModelIdentifier", - "traits": { - "smithy.api#documentation": "The unique identifier of the model to use to generate a response from the query results. Omit this field if you want to return the retrieved results as an array.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains configurations for a knowledge base node in a flow. This node takes a query as the input and returns, as the output, the retrieved responses directly (as an array) or a response generated based on the retrieved responses. For more information, see Node types in Amazon Bedrock works in the Amazon Bedrock User Guide.
" - } - }, - "com.amazonaws.bedrockagent#KnowledgeBaseId": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 10 - }, - "smithy.api#pattern": "^[0-9a-zA-Z]+$" - } - }, - "com.amazonaws.bedrockagent#KnowledgeBaseResource": { - "type": "resource", - "operations": [ - { - "target": "com.amazonaws.bedrockagent#AssociateAgentKnowledgeBase" - }, - { - "target": "com.amazonaws.bedrockagent#CreateKnowledgeBase" - }, - { - "target": "com.amazonaws.bedrockagent#DeleteKnowledgeBase" - }, - { - "target": "com.amazonaws.bedrockagent#DisassociateAgentKnowledgeBase" - }, - { - "target": "com.amazonaws.bedrockagent#GetAgentKnowledgeBase" - }, - { - "target": "com.amazonaws.bedrockagent#GetKnowledgeBase" - }, - { - "target": "com.amazonaws.bedrockagent#ListAgentKnowledgeBases" - }, - { - "target": "com.amazonaws.bedrockagent#ListKnowledgeBases" - }, - { - "target": "com.amazonaws.bedrockagent#UpdateAgentKnowledgeBase" - }, - { - "target": "com.amazonaws.bedrockagent#UpdateKnowledgeBase" - } - ] - }, - "com.amazonaws.bedrockagent#KnowledgeBaseRoleArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 2048 - }, - "smithy.api#pattern": "^arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/.+$" - } - }, - "com.amazonaws.bedrockagent#KnowledgeBaseState": { - "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.bedrockagent#KnowledgeBaseStatus": { - "type": "enum", - "members": { - "CREATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATING" - } - }, - "ACTIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACTIVE" - } - }, - "DELETING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETING" - } - }, - "UPDATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UPDATING" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - }, - "DELETE_UNSUCCESSFUL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETE_UNSUCCESSFUL" - } - } - } - }, - "com.amazonaws.bedrockagent#KnowledgeBaseStorageType": { - "type": "enum", - "members": { - "OPENSEARCH_SERVERLESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "OPENSEARCH_SERVERLESS" - } - }, - "PINECONE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PINECONE" - } - }, - "REDIS_ENTERPRISE_CLOUD": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "REDIS_ENTERPRISE_CLOUD" - } - }, - "RDS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RDS" - } - }, - "MONGO_DB_ATLAS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MONGO_DB_ATLAS" - } - } - } - }, - "com.amazonaws.bedrockagent#KnowledgeBaseSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrockagent#KnowledgeBaseSummary" - } - }, - "com.amazonaws.bedrockagent#KnowledgeBaseSummary": { - "type": "structure", - "members": { - "knowledgeBaseId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the knowledge base.
", - "smithy.api#required": {} - } - }, - "name": { - "target": "com.amazonaws.bedrockagent#Name", - "traits": { - "smithy.api#documentation": "The name of the knowledge base.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#Description", - "traits": { - "smithy.api#documentation": "The description of the knowledge base.
" - } - }, - "status": { - "target": "com.amazonaws.bedrockagent#KnowledgeBaseStatus", - "traits": { - "smithy.api#documentation": "The status of the knowledge base.
", - "smithy.api#required": {} - } - }, - "updatedAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the knowledge base was last updated.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Contains details about a knowledge base.
" - } - }, - "com.amazonaws.bedrockagent#KnowledgeBaseType": { - "type": "enum", - "members": { - "VECTOR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VECTOR" - } - } - } - }, - "com.amazonaws.bedrockagent#LambdaArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 2048 - }, - "smithy.api#pattern": "^arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}(-gov)?-[a-z]+-\\d{1}:\\d{12}:function:[a-zA-Z0-9-_\\.]+(:(\\$LATEST|[a-zA-Z0-9-_]+))?$" - } - }, - "com.amazonaws.bedrockagent#LambdaFunctionFlowNodeConfiguration": { - "type": "structure", - "members": { - "lambdaArn": { - "target": "com.amazonaws.bedrockagent#LambdaArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Lambda function to invoke.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Contains configurations for a Lambda function node in the flow. You specify the Lambda function to invoke and the inputs into the function. The output is the response that is defined in the Lambda function. For more information, see Node types in Amazon Bedrock works in the Amazon Bedrock User Guide.
" - } - }, - "com.amazonaws.bedrockagent#LexBotAliasArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 78 - }, - "smithy.api#pattern": "^arn:aws(|-us-gov):lex:[a-z]{2}(-gov)?-[a-z]+-\\d{1}:\\d{12}:bot-alias/[0-9a-zA-Z]+/[0-9a-zA-Z]+$" - } - }, - "com.amazonaws.bedrockagent#LexBotLocaleId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.bedrockagent#LexFlowNodeConfiguration": { - "type": "structure", - "members": { - "botAliasArn": { - "target": "com.amazonaws.bedrockagent#LexBotAliasArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Lex bot alias to invoke.
", - "smithy.api#required": {} - } - }, - "localeId": { - "target": "com.amazonaws.bedrockagent#LexBotLocaleId", - "traits": { - "smithy.api#documentation": "The Region to invoke the Amazon Lex bot in.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Contains configurations for a Lex node in the flow. You specify a Amazon Lex bot to invoke. This node takes an utterance as the input and returns as the output the intent identified by the Amazon Lex bot. For more information, see Node types in Amazon Bedrock works in the Amazon Bedrock User Guide.
" - } - }, - "com.amazonaws.bedrockagent#ListAgentActionGroups": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#ListAgentActionGroupsRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#ListAgentActionGroupsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrockagent#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrockagent#InternalServerException" - }, - { - "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrockagent#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Lists the action groups for an agent and information about each one.
", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/agents/{agentId}/agentversions/{agentVersion}/actiongroups/" - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults", - "items": "actionGroupSummaries" - }, - "smithy.api#readonly": {}, - "smithy.api#tags": ["console"] - } - }, - "com.amazonaws.bedrockagent#ListAgentActionGroupsRequest": { - "type": "structure", - "members": { - "agentId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the agent.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "agentVersion": { - "target": "com.amazonaws.bedrockagent#Version", - "traits": { - "smithy.api#documentation": "The version of the agent.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "maxResults": { - "target": "com.amazonaws.bedrockagent#MaxResults", - "traits": { - "smithy.api#documentation": "The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
A list of objects, each of which contains information about an action group.
", - "smithy.api#required": {} - } - }, - "nextToken": { - "target": "com.amazonaws.bedrockagent#NextToken", - "traits": { - "smithy.api#documentation": "If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
Lists the aliases of an agent and information about each one.
", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/agents/{agentId}/agentaliases/" - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults", - "items": "agentAliasSummaries" - }, - "smithy.api#readonly": {}, - "smithy.api#tags": ["console"] - } - }, - "com.amazonaws.bedrockagent#ListAgentAliasesRequest": { - "type": "structure", - "members": { - "agentId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the agent.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "maxResults": { - "target": "com.amazonaws.bedrockagent#MaxResults", - "traits": { - "smithy.api#documentation": "The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
A list of objects, each of which contains information about an alias of the agent.
", - "smithy.api#required": {} - } - }, - "nextToken": { - "target": "com.amazonaws.bedrockagent#NextToken", - "traits": { - "smithy.api#documentation": "If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
Lists knowledge bases associated with an agent and information about each one.
", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/agents/{agentId}/agentversions/{agentVersion}/knowledgebases/" - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults", - "items": "agentKnowledgeBaseSummaries" - }, - "smithy.api#readonly": {}, - "smithy.api#tags": ["console"] - } - }, - "com.amazonaws.bedrockagent#ListAgentKnowledgeBasesRequest": { - "type": "structure", - "members": { - "agentId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the agent for which to return information about knowledge bases associated with it.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "agentVersion": { - "target": "com.amazonaws.bedrockagent#Version", - "traits": { - "smithy.api#documentation": "The version of the agent for which to return information about knowledge bases associated with it.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "maxResults": { - "target": "com.amazonaws.bedrockagent#MaxResults", - "traits": { - "smithy.api#documentation": "The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
A list of objects, each of which contains information about a knowledge base associated with the agent.
", - "smithy.api#required": {} - } - }, - "nextToken": { - "target": "com.amazonaws.bedrockagent#NextToken", - "traits": { - "smithy.api#documentation": "If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
Lists the versions of an agent and information about each version.
", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/agents/{agentId}/agentversions/" - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults", - "items": "agentVersionSummaries" - }, - "smithy.api#readonly": {}, - "smithy.api#tags": ["console"] - } - }, - "com.amazonaws.bedrockagent#ListAgentVersionsRequest": { - "type": "structure", - "members": { - "agentId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the agent.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "maxResults": { - "target": "com.amazonaws.bedrockagent#MaxResults", - "traits": { - "smithy.api#documentation": "The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
A list of objects, each of which contains information about a version of the agent.
", - "smithy.api#required": {} - } - }, - "nextToken": { - "target": "com.amazonaws.bedrockagent#NextToken", - "traits": { - "smithy.api#documentation": "If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
Lists the agents belonging to an account and information about each agent.
", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/agents/" - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults", - "items": "agentSummaries" - }, - "smithy.api#readonly": {}, - "smithy.api#tags": ["console"] - } - }, - "com.amazonaws.bedrockagent#ListAgentsRequest": { - "type": "structure", - "members": { - "maxResults": { - "target": "com.amazonaws.bedrockagent#MaxResults", - "traits": { - "smithy.api#documentation": "The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
A list of objects, each of which contains information about an agent.
", - "smithy.api#required": {} - } - }, - "nextToken": { - "target": "com.amazonaws.bedrockagent#NextToken", - "traits": { - "smithy.api#documentation": "If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
Lists the data sources in a knowledge base and information about each one.
", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/knowledgebases/{knowledgeBaseId}/datasources/" - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults", - "items": "dataSourceSummaries" - }, - "smithy.api#readonly": {}, - "smithy.api#tags": ["console"] - } - }, - "com.amazonaws.bedrockagent#ListDataSourcesRequest": { - "type": "structure", - "members": { - "knowledgeBaseId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the knowledge base for which to return a list of information.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "maxResults": { - "target": "com.amazonaws.bedrockagent#MaxResults", - "traits": { - "smithy.api#documentation": "The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
A list of objects, each of which contains information about a data source.
", - "smithy.api#required": {} - } - }, - "nextToken": { - "target": "com.amazonaws.bedrockagent#NextToken", - "traits": { - "smithy.api#documentation": "If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
Returns a list of aliases for a flow.
", - "smithy.api#http": { - "code": 200, - "method": "GET", - "uri": "/flows/{flowIdentifier}/aliases" - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults", - "items": "flowAliasSummaries" - }, - "smithy.api#readonly": {}, - "smithy.api#tags": ["console"] - } - }, - "com.amazonaws.bedrockagent#ListFlowAliasesRequest": { - "type": "structure", - "members": { - "flowIdentifier": { - "target": "com.amazonaws.bedrockagent#FlowIdentifier", - "traits": { - "smithy.api#documentation": "The unique identifier of the flow for which aliases are being returned.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "maxResults": { - "target": "com.amazonaws.bedrockagent#MaxResults", - "traits": { - "smithy.api#documentation": "The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
A list, each member of which contains information about an alias.
", - "smithy.api#required": {} - } - }, - "nextToken": { - "target": "com.amazonaws.bedrockagent#NextToken", - "traits": { - "smithy.api#documentation": "If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
Returns a list of information about each flow. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
", - "smithy.api#http": { - "code": 200, - "method": "GET", - "uri": "/flows/{flowIdentifier}/versions" - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults", - "items": "flowVersionSummaries" - }, - "smithy.api#readonly": {}, - "smithy.api#tags": ["console"] - } - }, - "com.amazonaws.bedrockagent#ListFlowVersionsRequest": { - "type": "structure", - "members": { - "flowIdentifier": { - "target": "com.amazonaws.bedrockagent#FlowIdentifier", - "traits": { - "smithy.api#documentation": "The unique identifier of the flow.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "maxResults": { - "target": "com.amazonaws.bedrockagent#MaxResults", - "traits": { - "smithy.api#documentation": "The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
A list, each member of which contains information about a flow.
", - "smithy.api#required": {} - } - }, - "nextToken": { - "target": "com.amazonaws.bedrockagent#NextToken", - "traits": { - "smithy.api#documentation": "If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
Returns a list of flows and information about each flow. For more information, see Manage a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
", - "smithy.api#http": { - "code": 200, - "method": "GET", - "uri": "/flows/" - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults", - "items": "flowSummaries" - }, - "smithy.api#readonly": {}, - "smithy.api#tags": ["console"] - } - }, - "com.amazonaws.bedrockagent#ListFlowsRequest": { - "type": "structure", - "members": { - "maxResults": { - "target": "com.amazonaws.bedrockagent#MaxResults", - "traits": { - "smithy.api#documentation": "The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
A list, each member of which contains information about a flow.
", - "smithy.api#required": {} - } - }, - "nextToken": { - "target": "com.amazonaws.bedrockagent#NextToken", - "traits": { - "smithy.api#documentation": "If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
Lists the ingestion jobs for a data source and information about each of them.
", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/knowledgebases/{knowledgeBaseId}/datasources/{dataSourceId}/ingestionjobs/" - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults", - "items": "ingestionJobSummaries" - }, - "smithy.api#readonly": {}, - "smithy.api#tags": ["console"] - } - }, - "com.amazonaws.bedrockagent#ListIngestionJobsRequest": { - "type": "structure", - "members": { - "knowledgeBaseId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the knowledge base for which to return ingestion jobs.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "dataSourceId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the data source for which to return ingestion jobs.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "filters": { - "target": "com.amazonaws.bedrockagent#IngestionJobFilters", - "traits": { - "smithy.api#documentation": "Contains a definition of a filter for which to filter the results.
" - } - }, - "sortBy": { - "target": "com.amazonaws.bedrockagent#IngestionJobSortBy", - "traits": { - "smithy.api#documentation": "Contains details about how to sort the results.
" - } - }, - "maxResults": { - "target": "com.amazonaws.bedrockagent#MaxResults", - "traits": { - "smithy.api#documentation": "The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
A list of objects, each of which contains information about an ingestion job.
", - "smithy.api#required": {} - } - }, - "nextToken": { - "target": "com.amazonaws.bedrockagent#NextToken", - "traits": { - "smithy.api#documentation": "If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
Lists the knowledge bases in an account and information about each of them.
", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/knowledgebases/" - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults", - "items": "knowledgeBaseSummaries" - }, - "smithy.api#readonly": {}, - "smithy.api#tags": ["console"] - } - }, - "com.amazonaws.bedrockagent#ListKnowledgeBasesRequest": { - "type": "structure", - "members": { - "maxResults": { - "target": "com.amazonaws.bedrockagent#MaxResults", - "traits": { - "smithy.api#documentation": "The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
A list of objects, each of which contains information about a knowledge base.
", - "smithy.api#required": {} - } - }, - "nextToken": { - "target": "com.amazonaws.bedrockagent#NextToken", - "traits": { - "smithy.api#documentation": "If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
Returns either information about the working draft (DRAFT version) of each prompt in an account, or information about of all versions of a prompt, depending on whether you include the promptIdentifier field or not. For more information, see View information about prompts using Prompt management in the Amazon Bedrock User Guide.
The unique identifier of the prompt for whose versions you want to return information. Omit this field to list information about all prompts in an account.
", - "smithy.api#httpQuery": "promptIdentifier" - } - }, - "maxResults": { - "target": "com.amazonaws.bedrockagent#MaxResults", - "traits": { - "smithy.api#documentation": "The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
A list, each member of which contains information about a prompt using Prompt management.
", - "smithy.api#required": {} - } - }, - "nextToken": { - "target": "com.amazonaws.bedrockagent#NextToken", - "traits": { - "smithy.api#documentation": "If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
List all the tags for the resource you specify.
", - "smithy.api#http": { - "code": 200, - "method": "GET", - "uri": "/tags/{resourceArn}" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.bedrockagent#ListTagsForResourceRequest": { - "type": "structure", - "members": { - "resourceArn": { - "target": "com.amazonaws.bedrockagent#TaggableResourcesArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource for which to list tags.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrockagent#ListTagsForResourceResponse": { - "type": "structure", - "members": { - "tags": { - "target": "com.amazonaws.bedrockagent#TagsMap", - "traits": { - "smithy.api#documentation": "The key-value pairs for the tags associated with the resource.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrockagent#MaxResults": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 1000 - } - } - }, - "com.amazonaws.bedrockagent#MaximumLength": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 0, - "max": 4096 - } - } - }, - "com.amazonaws.bedrockagent#MemoryConfiguration": { - "type": "structure", - "members": { - "enabledMemoryTypes": { - "target": "com.amazonaws.bedrockagent#EnabledMemoryTypes", - "traits": { - "smithy.api#documentation": "The type of memory that is stored.
", - "smithy.api#required": {} - } - }, - "storageDays": { - "target": "com.amazonaws.bedrockagent#StorageDays", - "traits": { - "smithy.api#default": 30, - "smithy.api#documentation": "The number of days the agent is configured to retain the conversational context.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Details of the memory configuration.
" - } - }, - "com.amazonaws.bedrockagent#MemoryType": { - "type": "enum", - "members": { - "SESSION_SUMMARY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SESSION_SUMMARY" - } - } - } - }, - "com.amazonaws.bedrockagent#Microsoft365TenantId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 36, - "max": 36 - }, - "smithy.api#pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" - } - }, - "com.amazonaws.bedrockagent#ModelIdentifier": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - }, - "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}(([:][a-z0-9-]{1,63}){0,2})?/[a-z0-9]{12})|(:foundation-model/([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2})))|(([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2}))|(([0-9a-zA-Z][_-]?)+)$" - } - }, - "com.amazonaws.bedrockagent#MongoDbAtlasCollectionName": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 63 - }, - "smithy.api#pattern": "^.*$" - } - }, - "com.amazonaws.bedrockagent#MongoDbAtlasConfiguration": { - "type": "structure", - "members": { - "endpoint": { - "target": "com.amazonaws.bedrockagent#MongoDbAtlasEndpoint", - "traits": { - "smithy.api#documentation": "The endpoint URL of your MongoDB Atlas cluster for your knowledge base.
", - "smithy.api#required": {} - } - }, - "databaseName": { - "target": "com.amazonaws.bedrockagent#MongoDbAtlasDatabaseName", - "traits": { - "smithy.api#documentation": "The database name in your MongoDB Atlas cluster for your knowledge base.
", - "smithy.api#required": {} - } - }, - "collectionName": { - "target": "com.amazonaws.bedrockagent#MongoDbAtlasCollectionName", - "traits": { - "smithy.api#documentation": "The collection name of the knowledge base in MongoDB Atlas.
", - "smithy.api#required": {} - } - }, - "vectorIndexName": { - "target": "com.amazonaws.bedrockagent#MongoDbAtlasIndexName", - "traits": { - "smithy.api#documentation": "The name of the MongoDB Atlas vector search index.
", - "smithy.api#required": {} - } - }, - "credentialsSecretArn": { - "target": "com.amazonaws.bedrockagent#SecretArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that contains user credentials for your MongoDB Atlas cluster.
", - "smithy.api#required": {} - } - }, - "fieldMapping": { - "target": "com.amazonaws.bedrockagent#MongoDbAtlasFieldMapping", - "traits": { - "smithy.api#documentation": "Contains the names of the fields to which to map information about the vector store.
", - "smithy.api#required": {} - } - }, - "endpointServiceName": { - "target": "com.amazonaws.bedrockagent#MongoDbAtlasEndpointServiceName", - "traits": { - "smithy.api#documentation": "The name of the VPC endpoint service in your account that is connected to your MongoDB Atlas cluster.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains details about the storage configuration of the knowledge base in MongoDB Atlas.
" - } - }, - "com.amazonaws.bedrockagent#MongoDbAtlasDatabaseName": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 63 - }, - "smithy.api#pattern": "^.*$" - } - }, - "com.amazonaws.bedrockagent#MongoDbAtlasEndpoint": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 2048 - }, - "smithy.api#pattern": "^.*$" - } - }, - "com.amazonaws.bedrockagent#MongoDbAtlasEndpointServiceName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - }, - "smithy.api#pattern": "^(?:arn:aws(?:-us-gov|-cn|-iso|-iso-[a-z])*:.+:.*:\\d+:.+/.+$|[a-zA-Z0-9*]+[a-zA-Z0-9._-]*)$" - } - }, - "com.amazonaws.bedrockagent#MongoDbAtlasFieldMapping": { - "type": "structure", - "members": { - "vectorField": { - "target": "com.amazonaws.bedrockagent#FieldName", - "traits": { - "smithy.api#documentation": "The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
", - "smithy.api#required": {} - } - }, - "textField": { - "target": "com.amazonaws.bedrockagent#FieldName", - "traits": { - "smithy.api#documentation": "The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
", - "smithy.api#required": {} - } - }, - "metadataField": { - "target": "com.amazonaws.bedrockagent#FieldName", - "traits": { - "smithy.api#documentation": "The name of the field in which Amazon Bedrock stores metadata about the vector store.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Contains the names of the fields to which to map information about the vector store.
" - } - }, - "com.amazonaws.bedrockagent#MongoDbAtlasIndexName": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 2048 - }, - "smithy.api#pattern": "^.*$" - } - }, - "com.amazonaws.bedrockagent#Name": { - "type": "string", - "traits": { - "smithy.api#pattern": "^([0-9a-zA-Z][_-]?){1,100}$" - } - }, - "com.amazonaws.bedrockagent#NextToken": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - }, - "smithy.api#pattern": "^\\S*$" - } - }, - "com.amazonaws.bedrockagent#NonBlankString": { - "type": "string", - "traits": { - "smithy.api#pattern": "^[\\s\\S]+$" - } - }, - "com.amazonaws.bedrockagent#NumericalVersion": { - "type": "string", - "traits": { - "smithy.api#pattern": "^[0-9]{1,5}$" - } - }, - "com.amazonaws.bedrockagent#OpenSearchServerlessCollectionArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 2048 - }, - "smithy.api#pattern": "^arn:aws:aoss:[a-z]{2}(-gov)?-[a-z]+-\\d{1}:\\d{12}:collection/[a-z0-9-]{3,32}$" - } - }, - "com.amazonaws.bedrockagent#OpenSearchServerlessConfiguration": { - "type": "structure", - "members": { - "collectionArn": { - "target": "com.amazonaws.bedrockagent#OpenSearchServerlessCollectionArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the OpenSearch Service vector store.
", - "smithy.api#required": {} - } - }, - "vectorIndexName": { - "target": "com.amazonaws.bedrockagent#OpenSearchServerlessIndexName", - "traits": { - "smithy.api#documentation": "The name of the vector store.
", - "smithy.api#required": {} - } - }, - "fieldMapping": { - "target": "com.amazonaws.bedrockagent#OpenSearchServerlessFieldMapping", - "traits": { - "smithy.api#documentation": "Contains the names of the fields to which to map information about the vector store.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Contains details about the storage configuration of the knowledge base in Amazon OpenSearch Service. For more information, see Create a vector index in Amazon OpenSearch Service.
" - } - }, - "com.amazonaws.bedrockagent#OpenSearchServerlessFieldMapping": { - "type": "structure", - "members": { - "vectorField": { - "target": "com.amazonaws.bedrockagent#FieldName", - "traits": { - "smithy.api#documentation": "The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
", - "smithy.api#required": {} - } - }, - "textField": { - "target": "com.amazonaws.bedrockagent#FieldName", - "traits": { - "smithy.api#documentation": "The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
", - "smithy.api#required": {} - } - }, - "metadataField": { - "target": "com.amazonaws.bedrockagent#FieldName", - "traits": { - "smithy.api#documentation": "The name of the field in which Amazon Bedrock stores metadata about the vector store.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Contains the names of the fields to which to map information about the vector store.
" - } - }, - "com.amazonaws.bedrockagent#OpenSearchServerlessIndexName": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 2048 - }, - "smithy.api#pattern": "^.*$" - } - }, - "com.amazonaws.bedrockagent#OutputFlowNodeConfiguration": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "Contains configurations for an output flow node in the flow. You specify the data type expected for the input into the node in the type field and how to return the final output in the expression field.
A description of the parameter. Helps the foundation model determine how to elicit the parameters from the user.
" - } - }, - "type": { - "target": "com.amazonaws.bedrockagent#Type", - "traits": { - "smithy.api#documentation": "The data type of the parameter.
", - "smithy.api#required": {} - } - }, - "required": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#documentation": "Whether the parameter is required for the agent to complete the function for action group invocation.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains details about a parameter in a function for an action group.
\nThis data type is used in the following API operations:
\nThe parsing strategy for the data source.
", - "smithy.api#required": {} - } - }, - "bedrockFoundationModelConfiguration": { - "target": "com.amazonaws.bedrockagent#BedrockFoundationModelConfiguration", - "traits": { - "smithy.api#documentation": "Settings for a foundation model used to parse documents for a data source.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Settings for parsing document contents. By default, the service converts the contents of each\n document into text before splitting it into chunks. To improve processing of PDF files with tables and images,\n you can configure the data source to convert the pages of text into images and use a model to describe the\n contents of each page.
\nTo use a model to parse PDF documents, set the parsing strategy to BEDROCK_FOUNDATION_MODEL and\n specify the model to use by ARN. You can also override the default parsing prompt with instructions for how\n to interpret images and tables in your documents. The following models are supported.
Anthropic Claude 3 Sonnet - anthropic.claude-3-sonnet-20240229-v1:0\n
Anthropic Claude 3 Haiku - anthropic.claude-3-haiku-20240307-v1:0\n
You can get the ARN of a model with the action. Standard model usage\n charges apply for the foundation model parsing strategy.
" - } - }, - "com.amazonaws.bedrockagent#ParsingPrompt": { - "type": "structure", - "members": { - "parsingPromptText": { - "target": "com.amazonaws.bedrockagent#ParsingPromptText", - "traits": { - "smithy.api#documentation": "Instructions for interpreting the contents of a document.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Instructions for interpreting the contents of a document.
" - } - }, - "com.amazonaws.bedrockagent#ParsingPromptText": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10000 - } - } - }, - "com.amazonaws.bedrockagent#ParsingStrategy": { - "type": "enum", - "members": { - "BEDROCK_FOUNDATION_MODEL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BEDROCK_FOUNDATION_MODEL" - } - } - } - }, - "com.amazonaws.bedrockagent#PatternObjectFilter": { - "type": "structure", - "members": { - "objectType": { - "target": "com.amazonaws.bedrockagent#FilteredObjectType", - "traits": { - "smithy.api#documentation": "The supported object type or content type of the data source.
", - "smithy.api#required": {} - } - }, - "inclusionFilters": { - "target": "com.amazonaws.bedrockagent#FilterList", - "traits": { - "smithy.api#documentation": "A list of one or more inclusion regular expression patterns to include certain \n object types that adhere to the pattern. If you specify an inclusion and exclusion \n filter/pattern and both match a document, the exclusion filter takes precedence \n and the document isn’t crawled.
" - } - }, - "exclusionFilters": { - "target": "com.amazonaws.bedrockagent#FilterList", - "traits": { - "smithy.api#documentation": "A list of one or more exclusion regular expression patterns to exclude certain \n object types that adhere to the pattern. If you specify an inclusion and exclusion \n filter/pattern and both match a document, the exclusion filter takes precedence \n and the document isn’t crawled.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The specific filters applied to your data source content. You can filter out or \n include certain content.
" - } - }, - "com.amazonaws.bedrockagent#PatternObjectFilterConfiguration": { - "type": "structure", - "members": { - "filters": { - "target": "com.amazonaws.bedrockagent#PatternObjectFilterList", - "traits": { - "smithy.api#documentation": "The configuration of specific filters applied to your data source content. You can \n filter out or include certain content.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "The configuration of filtering certain objects or content types of the data source.
" - } - }, - "com.amazonaws.bedrockagent#PatternObjectFilterList": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrockagent#PatternObjectFilter" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 25 - }, - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.bedrockagent#Payload": { - "type": "string", - "traits": { - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.bedrockagent#PineconeConfiguration": { - "type": "structure", - "members": { - "connectionString": { - "target": "com.amazonaws.bedrockagent#PineconeConnectionString", - "traits": { - "smithy.api#documentation": "The endpoint URL for your index management page.
", - "smithy.api#required": {} - } - }, - "credentialsSecretArn": { - "target": "com.amazonaws.bedrockagent#SecretArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that is linked to your Pinecone API key.
", - "smithy.api#required": {} - } - }, - "namespace": { - "target": "com.amazonaws.bedrockagent#PineconeNamespace", - "traits": { - "smithy.api#documentation": "The namespace to be used to write new data to your database.
" - } - }, - "fieldMapping": { - "target": "com.amazonaws.bedrockagent#PineconeFieldMapping", - "traits": { - "smithy.api#documentation": "Contains the names of the fields to which to map information about the vector store.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Contains details about the storage configuration of the knowledge base in Pinecone. For more information, see Create a vector index in Pinecone.
" - } - }, - "com.amazonaws.bedrockagent#PineconeConnectionString": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 2048 - }, - "smithy.api#pattern": "^.*$" - } - }, - "com.amazonaws.bedrockagent#PineconeFieldMapping": { - "type": "structure", - "members": { - "textField": { - "target": "com.amazonaws.bedrockagent#FieldName", - "traits": { - "smithy.api#documentation": "The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
", - "smithy.api#required": {} - } - }, - "metadataField": { - "target": "com.amazonaws.bedrockagent#FieldName", - "traits": { - "smithy.api#documentation": "The name of the field in which Amazon Bedrock stores metadata about the vector store.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Contains the names of the fields to which to map information about the vector store.
" - } - }, - "com.amazonaws.bedrockagent#PineconeNamespace": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 2048 - }, - "smithy.api#pattern": "^.*$" - } - }, - "com.amazonaws.bedrockagent#PrepareAgent": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#PrepareAgentRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#PrepareAgentResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrockagent#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrockagent#ConflictException" - }, - { - "target": "com.amazonaws.bedrockagent#InternalServerException" - }, - { - "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrockagent#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Creates a DRAFT version of the agent that can be used for internal testing.
The unique identifier of the agent for which to create a DRAFT version.
The unique identifier of the agent for which the DRAFT version was created.
The status of the DRAFT version and whether it is ready for use.
The version of the agent.
", - "smithy.api#required": {} - } - }, - "preparedAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the DRAFT version of the agent was last prepared.
Prepares the DRAFT version of a flow so that it can be invoked. For more information, see Test a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
The unique identifier of the flow.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrockagent#PrepareFlowResponse": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.bedrockagent#FlowId", - "traits": { - "smithy.api#documentation": "The unique identifier of the flow.
", - "smithy.api#required": {} - } - }, - "status": { - "target": "com.amazonaws.bedrockagent#FlowStatus", - "traits": { - "smithy.api#documentation": "The status of the flow. When you submit this request, the status will be NotPrepared. If preparation succeeds, the status becomes Prepared. If it fails, the status becomes FAILED.
The step in the agent sequence that this prompt configuration applies to.
" - } - }, - "promptCreationMode": { - "target": "com.amazonaws.bedrockagent#CreationMode", - "traits": { - "smithy.api#documentation": "Specifies whether to override the default prompt template for this promptType. Set this value to OVERRIDDEN to use the prompt that you provide in the basePromptTemplate. If you leave it as DEFAULT, the agent uses a default prompt template.
Specifies whether to allow the agent to carry out the step specified in the promptType. If you set this value to DISABLED, the agent skips that step. The default state for each promptType is as follows.
\n PRE_PROCESSING – ENABLED\n
\n ORCHESTRATION – ENABLED\n
\n KNOWLEDGE_BASE_RESPONSE_GENERATION – ENABLED\n
\n POST_PROCESSING – DISABLED\n
Defines the prompt template with which to replace the default prompt template. You can use placeholder variables in the base prompt template to customize the prompt. For more information, see Prompt template placeholder variables. For more information, see Configure the prompt templates.
" - } - }, - "inferenceConfiguration": { - "target": "com.amazonaws.bedrockagent#InferenceConfiguration", - "traits": { - "smithy.api#documentation": "Contains inference parameters to use when the agent invokes a foundation model in the part of the agent sequence defined by the promptType. For more information, see Inference parameters for foundation models.
Specifies whether to override the default parser Lambda function when parsing the raw foundation model output in the part of the agent sequence defined by the promptType. If you set the field as OVERRIDEN, the overrideLambda field in the PromptOverrideConfiguration must be specified with the ARN of a Lambda function.
Contains configurations to override a prompt template in one part of an agent sequence. For more information, see Advanced prompts.
" - } - }, - "com.amazonaws.bedrockagent#PromptConfigurations": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrockagent#PromptConfiguration" - }, - "traits": { - "smithy.api#length": { - "max": 10 - } - } - }, - "com.amazonaws.bedrockagent#PromptDescription": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 200 - } - } - }, - "com.amazonaws.bedrockagent#PromptFlowNodeConfiguration": { - "type": "structure", - "members": { - "sourceConfiguration": { - "target": "com.amazonaws.bedrockagent#PromptFlowNodeSourceConfiguration", - "traits": { - "smithy.api#documentation": "Specifies whether the prompt is from Prompt management or defined inline.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Contains configurations for a prompt node in the flow. You can use a prompt from Prompt management or you can define one in this node. If the prompt contains variables, the inputs into this node will fill in the variables. The output from this node is the response generated by the model. For more information, see Node types in Amazon Bedrock works in the Amazon Bedrock User Guide.
" - } - }, - "com.amazonaws.bedrockagent#PromptFlowNodeInlineConfiguration": { - "type": "structure", - "members": { - "templateType": { - "target": "com.amazonaws.bedrockagent#PromptTemplateType", - "traits": { - "smithy.api#documentation": "The type of prompt template.
", - "smithy.api#required": {} - } - }, - "templateConfiguration": { - "target": "com.amazonaws.bedrockagent#PromptTemplateConfiguration", - "traits": { - "smithy.api#documentation": "Contains a prompt and variables in the prompt that can be replaced with values at runtime.
", - "smithy.api#required": {} - } - }, - "modelId": { - "target": "com.amazonaws.bedrockagent#PromptModelIdentifier", - "traits": { - "smithy.api#documentation": "The unique identifier of the model to run inference with.
", - "smithy.api#required": {} - } - }, - "inferenceConfiguration": { - "target": "com.amazonaws.bedrockagent#PromptInferenceConfiguration", - "traits": { - "smithy.api#documentation": "Contains inference configurations for the prompt.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains configurations for a prompt defined inline in the node.
" - } - }, - "com.amazonaws.bedrockagent#PromptFlowNodeResourceConfiguration": { - "type": "structure", - "members": { - "promptArn": { - "target": "com.amazonaws.bedrockagent#PromptArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the prompt from Prompt management.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Contains configurations for a prompt from Prompt management to use in a node.
" - } - }, - "com.amazonaws.bedrockagent#PromptFlowNodeSourceConfiguration": { - "type": "union", - "members": { - "resource": { - "target": "com.amazonaws.bedrockagent#PromptFlowNodeResourceConfiguration", - "traits": { - "smithy.api#documentation": "Contains configurations for a prompt from Prompt management.
" - } - }, - "inline": { - "target": "com.amazonaws.bedrockagent#PromptFlowNodeInlineConfiguration", - "traits": { - "smithy.api#documentation": "Contains configurations for a prompt that is defined inline
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains configurations for a prompt and whether it is from Prompt management or defined inline.
" - } - }, - "com.amazonaws.bedrockagent#PromptId": { - "type": "string", - "traits": { - "smithy.api#pattern": "^[0-9a-zA-Z]{10}$" - } - }, - "com.amazonaws.bedrockagent#PromptIdentifier": { - "type": "string", - "traits": { - "smithy.api#pattern": "^([0-9a-zA-Z]{10})|(arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:prompt/[0-9a-zA-Z]{10})(?::[0-9]{1,5})?$" - } - }, - "com.amazonaws.bedrockagent#PromptInferenceConfiguration": { - "type": "union", - "members": { - "text": { - "target": "com.amazonaws.bedrockagent#PromptModelInferenceConfiguration", - "traits": { - "smithy.api#documentation": "Contains inference configurations for a text prompt.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains inference configurations for the prompt.
" - } - }, - "com.amazonaws.bedrockagent#PromptInputVariable": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.bedrockagent#PromptInputVariableName", - "traits": { - "smithy.api#documentation": "The name of the variable.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about a variable in the prompt.
" - } - }, - "com.amazonaws.bedrockagent#PromptInputVariableName": { - "type": "string", - "traits": { - "smithy.api#pattern": "^([0-9a-zA-Z][_-]?){1,100}$" - } - }, - "com.amazonaws.bedrockagent#PromptInputVariablesList": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrockagent#PromptInputVariable" - }, - "traits": { - "smithy.api#length": { - "max": 5 - }, - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.bedrockagent#PromptModelIdentifier": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - }, - "smithy.api#pattern": "^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|([0-9]{12}:provisioned-model/[a-z0-9]{12})))|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|(([0-9a-zA-Z][_-]?)+)$" - } - }, - "com.amazonaws.bedrockagent#PromptModelInferenceConfiguration": { - "type": "structure", - "members": { - "temperature": { - "target": "com.amazonaws.bedrockagent#Temperature", - "traits": { - "smithy.api#documentation": "Controls the randomness of the response. Choose a lower value for more predictable outputs and a higher value for more surprising outputs.
" - } - }, - "topP": { - "target": "com.amazonaws.bedrockagent#TopP", - "traits": { - "smithy.api#documentation": "The percentage of most-likely candidates that the model considers for the next token.
" - } - }, - "topK": { - "target": "com.amazonaws.bedrockagent#TopK", - "traits": { - "smithy.api#documentation": "The number of most-likely candidates that the model considers for the next token during generation.
" - } - }, - "maxTokens": { - "target": "com.amazonaws.bedrockagent#MaximumLength", - "traits": { - "smithy.api#documentation": "The maximum number of tokens to return in the response.
" - } - }, - "stopSequences": { - "target": "com.amazonaws.bedrockagent#StopSequences", - "traits": { - "smithy.api#documentation": "A list of strings that define sequences after which the model will stop generating.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains inference configurations related to model inference for a prompt. For more information, see Inference parameters.
" - } - }, - "com.amazonaws.bedrockagent#PromptName": { - "type": "string", - "traits": { - "smithy.api#pattern": "^([0-9a-zA-Z][_-]?){1,100}$" - } - }, - "com.amazonaws.bedrockagent#PromptOverrideConfiguration": { - "type": "structure", - "members": { - "promptConfigurations": { - "target": "com.amazonaws.bedrockagent#PromptConfigurations", - "traits": { - "smithy.api#documentation": "Contains configurations to override a prompt template in one part of an agent sequence. For more information, see Advanced prompts.
", - "smithy.api#required": {} - } - }, - "overrideLambda": { - "target": "com.amazonaws.bedrockagent#LambdaArn", - "traits": { - "smithy.api#documentation": "The ARN of the Lambda function to use when parsing the raw foundation model output in parts of the agent sequence. If you specify this field, at least one of the promptConfigurations must contain a parserMode value that is set to OVERRIDDEN. For more information, see Parser Lambda function in Agents for Amazon Bedrock.
Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.
", - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.bedrockagent#PromptResource": { - "type": "resource", - "identifiers": { - "promptIdentifier": { - "target": "com.amazonaws.bedrockagent#PromptIdentifier" - } - }, - "create": { - "target": "com.amazonaws.bedrockagent#CreatePrompt" - }, - "read": { - "target": "com.amazonaws.bedrockagent#GetPrompt" - }, - "update": { - "target": "com.amazonaws.bedrockagent#UpdatePrompt" - }, - "delete": { - "target": "com.amazonaws.bedrockagent#DeletePrompt" - }, - "list": { - "target": "com.amazonaws.bedrockagent#ListPrompts" - }, - "operations": [ - { - "target": "com.amazonaws.bedrockagent#CreatePromptVersion" - } - ], - "traits": { - "aws.cloudformation#cfnResource": { - "name": "Prompt" - } - } - }, - "com.amazonaws.bedrockagent#PromptState": { - "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.bedrockagent#PromptSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrockagent#PromptSummary" - }, - "traits": { - "smithy.api#length": { - "max": 10 - } - } - }, - "com.amazonaws.bedrockagent#PromptSummary": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.bedrockagent#PromptName", - "traits": { - "smithy.api#documentation": "The name of the prompt.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#PromptDescription", - "traits": { - "smithy.api#documentation": "The description of the prompt.
" - } - }, - "id": { - "target": "com.amazonaws.bedrockagent#PromptId", - "traits": { - "smithy.api#documentation": "The unique identifier of the prompt.
", - "smithy.api#required": {} - } - }, - "arn": { - "target": "com.amazonaws.bedrockagent#PromptArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the prompt or the prompt version (if you specified a version in the request).
", - "smithy.api#required": {} - } - }, - "version": { - "target": "com.amazonaws.bedrockagent#Version", - "traits": { - "smithy.api#documentation": "The version of the prompt that this summary applies to.
", - "smithy.api#required": {} - } - }, - "createdAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the prompt was created.
", - "smithy.api#required": {} - } - }, - "updatedAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the prompt was last updated.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about a prompt in your Prompt management tool.
\nThis data type is used in the following API operations:
\n\n ListPrompts response\n
\nContains configurations for the text in a message for a prompt.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains the message for a prompt. For more information, see Prompt management in Amazon Bedrock.
" - } - }, - "com.amazonaws.bedrockagent#PromptTemplateType": { - "type": "enum", - "members": { - "TEXT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TEXT" - } - } - } - }, - "com.amazonaws.bedrockagent#PromptType": { - "type": "enum", - "members": { - "PRE_PROCESSING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PRE_PROCESSING" - } - }, - "ORCHESTRATION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ORCHESTRATION" - } - }, - "POST_PROCESSING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "POST_PROCESSING" - } - }, - "KNOWLEDGE_BASE_RESPONSE_GENERATION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "KNOWLEDGE_BASE_RESPONSE_GENERATION" - } - } - } - }, - "com.amazonaws.bedrockagent#PromptVariant": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.bedrockagent#PromptVariantName", - "traits": { - "smithy.api#documentation": "The name of the prompt variant.
", - "smithy.api#required": {} - } - }, - "templateType": { - "target": "com.amazonaws.bedrockagent#PromptTemplateType", - "traits": { - "smithy.api#documentation": "The type of prompt template to use.
", - "smithy.api#required": {} - } - }, - "templateConfiguration": { - "target": "com.amazonaws.bedrockagent#PromptTemplateConfiguration", - "traits": { - "smithy.api#documentation": "Contains configurations for the prompt template.
" - } - }, - "modelId": { - "target": "com.amazonaws.bedrockagent#PromptModelIdentifier", - "traits": { - "smithy.api#documentation": "The unique identifier of the model with which to run inference on the prompt.
" - } - }, - "inferenceConfiguration": { - "target": "com.amazonaws.bedrockagent#PromptInferenceConfiguration", - "traits": { - "smithy.api#documentation": "Contains inference configurations for the prompt variant.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains details about a variant of the prompt.
", - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.bedrockagent#PromptVariantList": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrockagent#PromptVariant" - }, - "traits": { - "smithy.api#length": { - "max": 3 - }, - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.bedrockagent#PromptVariantName": { - "type": "string", - "traits": { - "smithy.api#pattern": "^([0-9a-zA-Z][_-]?){1,100}$" - } - }, - "com.amazonaws.bedrockagent#ProvisionedModelIdentifier": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - }, - "smithy.api#pattern": "^((([0-9a-zA-Z][_-]?){1,63})|(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:provisioned-model/[a-z0-9]{12}))$" - } - }, - "com.amazonaws.bedrockagent#RdsArn": { - "type": "string", - "traits": { - "smithy.api#pattern": "^arn:aws(|-cn|-us-gov):rds:[a-zA-Z0-9-]*:[0-9]{12}:cluster:[a-zA-Z0-9-]{1,63}$" - } - }, - "com.amazonaws.bedrockagent#RdsConfiguration": { - "type": "structure", - "members": { - "resourceArn": { - "target": "com.amazonaws.bedrockagent#RdsArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the vector store.
", - "smithy.api#required": {} - } - }, - "credentialsSecretArn": { - "target": "com.amazonaws.bedrockagent#SecretArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that is linked to your Amazon RDS database.
", - "smithy.api#required": {} - } - }, - "databaseName": { - "target": "com.amazonaws.bedrockagent#RdsDatabaseName", - "traits": { - "smithy.api#documentation": "The name of your Amazon RDS database.
", - "smithy.api#required": {} - } - }, - "tableName": { - "target": "com.amazonaws.bedrockagent#RdsTableName", - "traits": { - "smithy.api#documentation": "The name of the table in the database.
", - "smithy.api#required": {} - } - }, - "fieldMapping": { - "target": "com.amazonaws.bedrockagent#RdsFieldMapping", - "traits": { - "smithy.api#documentation": "Contains the names of the fields to which to map information about the vector store.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Contains details about the storage configuration of the knowledge base in Amazon RDS. For more information, see Create a vector index in Amazon RDS.
" - } - }, - "com.amazonaws.bedrockagent#RdsDatabaseName": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 63 - }, - "smithy.api#pattern": "^[a-zA-Z0-9_\\-]+$" - } - }, - "com.amazonaws.bedrockagent#RdsFieldMapping": { - "type": "structure", - "members": { - "primaryKeyField": { - "target": "com.amazonaws.bedrockagent#ColumnName", - "traits": { - "smithy.api#documentation": "The name of the field in which Amazon Bedrock stores the ID for each entry.
", - "smithy.api#required": {} - } - }, - "vectorField": { - "target": "com.amazonaws.bedrockagent#ColumnName", - "traits": { - "smithy.api#documentation": "The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
", - "smithy.api#required": {} - } - }, - "textField": { - "target": "com.amazonaws.bedrockagent#ColumnName", - "traits": { - "smithy.api#documentation": "The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
", - "smithy.api#required": {} - } - }, - "metadataField": { - "target": "com.amazonaws.bedrockagent#ColumnName", - "traits": { - "smithy.api#documentation": "The name of the field in which Amazon Bedrock stores metadata about the vector store.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Contains the names of the fields to which to map information about the vector store.
" - } - }, - "com.amazonaws.bedrockagent#RdsTableName": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 63 - }, - "smithy.api#pattern": "^[a-zA-Z0-9_\\.\\-]+$" - } - }, - "com.amazonaws.bedrockagent#RecommendedAction": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 2048 - } - } - }, - "com.amazonaws.bedrockagent#RecommendedActions": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrockagent#RecommendedAction" - }, - "traits": { - "smithy.api#length": { - "max": 2048 - } - } - }, - "com.amazonaws.bedrockagent#RedisEnterpriseCloudConfiguration": { - "type": "structure", - "members": { - "endpoint": { - "target": "com.amazonaws.bedrockagent#RedisEnterpriseCloudEndpoint", - "traits": { - "smithy.api#documentation": "The endpoint URL of the Redis Enterprise Cloud database.
", - "smithy.api#required": {} - } - }, - "vectorIndexName": { - "target": "com.amazonaws.bedrockagent#RedisEnterpriseCloudIndexName", - "traits": { - "smithy.api#documentation": "The name of the vector index.
", - "smithy.api#required": {} - } - }, - "credentialsSecretArn": { - "target": "com.amazonaws.bedrockagent#SecretArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that is linked to your Redis Enterprise Cloud database.
", - "smithy.api#required": {} - } - }, - "fieldMapping": { - "target": "com.amazonaws.bedrockagent#RedisEnterpriseCloudFieldMapping", - "traits": { - "smithy.api#documentation": "Contains the names of the fields to which to map information about the vector store.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Contains details about the storage configuration of the knowledge base in Redis Enterprise Cloud. For more information, see Create a vector index in Redis Enterprise Cloud.
" - } - }, - "com.amazonaws.bedrockagent#RedisEnterpriseCloudEndpoint": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 2048 - }, - "smithy.api#pattern": "^.*$" - } - }, - "com.amazonaws.bedrockagent#RedisEnterpriseCloudFieldMapping": { - "type": "structure", - "members": { - "vectorField": { - "target": "com.amazonaws.bedrockagent#FieldName", - "traits": { - "smithy.api#documentation": "The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
", - "smithy.api#required": {} - } - }, - "textField": { - "target": "com.amazonaws.bedrockagent#FieldName", - "traits": { - "smithy.api#documentation": "The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
", - "smithy.api#required": {} - } - }, - "metadataField": { - "target": "com.amazonaws.bedrockagent#FieldName", - "traits": { - "smithy.api#documentation": "The name of the field in which Amazon Bedrock stores metadata about the vector store.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Contains the names of the fields to which to map information about the vector store.
" - } - }, - "com.amazonaws.bedrockagent#RedisEnterpriseCloudIndexName": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 2048 - }, - "smithy.api#pattern": "^.*$" - } - }, - "com.amazonaws.bedrockagent#RequireConfirmation": { - "type": "enum", - "members": { - "ENABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ENABLED" - } - }, - "DISABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DISABLED" - } - } - }, - "traits": { - "smithy.api#documentation": "ENUM to check if action requires user confirmation" - } - }, - "com.amazonaws.bedrockagent#ResourceNotFoundException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.bedrockagent#NonBlankString" - } - }, - "traits": { - "smithy.api#documentation": "The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.bedrockagent#RetrievalFlowNodeConfiguration": { - "type": "structure", - "members": { - "serviceConfiguration": { - "target": "com.amazonaws.bedrockagent#RetrievalFlowNodeServiceConfiguration", - "traits": { - "smithy.api#documentation": "Contains configurations for the service to use for retrieving data to return as the output from the node.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Contains configurations for a Retrieval node in a flow. This node retrieves data from the Amazon S3 location that you specify and returns it as the output.
" - } - }, - "com.amazonaws.bedrockagent#RetrievalFlowNodeS3Configuration": { - "type": "structure", - "members": { - "bucketName": { - "target": "com.amazonaws.bedrockagent#S3BucketName", - "traits": { - "smithy.api#documentation": "The name of the Amazon S3 bucket from which to retrieve data.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Contains configurations for the Amazon S3 location from which to retrieve data to return as the output from the node.
" - } - }, - "com.amazonaws.bedrockagent#RetrievalFlowNodeServiceConfiguration": { - "type": "union", - "members": { - "s3": { - "target": "com.amazonaws.bedrockagent#RetrievalFlowNodeS3Configuration", - "traits": { - "smithy.api#documentation": "Contains configurations for the Amazon S3 location from which to retrieve data to return as the output from the node.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains configurations for the service to use for retrieving data to return as the output from the node.
" - } - }, - "com.amazonaws.bedrockagent#S3BucketArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - }, - "smithy.api#pattern": "^arn:aws(|-cn|-us-gov):s3:::[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]$" - } - }, - "com.amazonaws.bedrockagent#S3BucketName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 3, - "max": 63 - }, - "smithy.api#pattern": "^[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]$" - } - }, - "com.amazonaws.bedrockagent#S3BucketUri": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - }, - "smithy.api#pattern": "^s3://.{1,128}$" - } - }, - "com.amazonaws.bedrockagent#S3DataSourceConfiguration": { - "type": "structure", - "members": { - "bucketArn": { - "target": "com.amazonaws.bedrockagent#S3BucketArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the S3 bucket that contains your data.
", - "smithy.api#required": {} - } - }, - "inclusionPrefixes": { - "target": "com.amazonaws.bedrockagent#S3Prefixes", - "traits": { - "smithy.api#documentation": "A list of S3 prefixes to include certain files or content. For more information, \n see Organizing objects using prefixes.
" - } - }, - "bucketOwnerAccountId": { - "target": "com.amazonaws.bedrockagent#BucketOwnerAccountId", - "traits": { - "smithy.api#documentation": "The account ID for the owner of the S3 bucket.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The configuration information to connect to Amazon S3 as your data source.
" - } - }, - "com.amazonaws.bedrockagent#S3Identifier": { - "type": "structure", - "members": { - "s3BucketName": { - "target": "com.amazonaws.bedrockagent#S3BucketName", - "traits": { - "smithy.api#documentation": "The name of the S3 bucket.
" - } - }, - "s3ObjectKey": { - "target": "com.amazonaws.bedrockagent#S3ObjectKey", - "traits": { - "smithy.api#documentation": "The S3 object key for the S3 resource.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The identifier information for an Amazon S3 bucket.
" - } - }, - "com.amazonaws.bedrockagent#S3Location": { - "type": "structure", - "members": { - "uri": { - "target": "com.amazonaws.bedrockagent#S3BucketUri", - "traits": { - "smithy.api#documentation": "The location's URI. For example, s3://my-bucket/chunk-processor/.
An Amazon S3 location.
" - } - }, - "com.amazonaws.bedrockagent#S3ObjectKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - }, - "smithy.api#pattern": "^[\\.\\-\\!\\*\\_\\'\\(\\)a-zA-Z0-9][\\.\\-\\!\\*\\_\\'\\(\\)\\/a-zA-Z0-9]*$" - } - }, - "com.amazonaws.bedrockagent#S3Prefix": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 300 - }, - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.bedrockagent#S3Prefixes": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrockagent#S3Prefix" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1 - } - } - }, - "com.amazonaws.bedrockagent#SalesforceAuthType": { - "type": "enum", - "members": { - "OAUTH2_CLIENT_CREDENTIALS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "OAUTH2_CLIENT_CREDENTIALS" - } - } - } - }, - "com.amazonaws.bedrockagent#SalesforceCrawlerConfiguration": { - "type": "structure", - "members": { - "filterConfiguration": { - "target": "com.amazonaws.bedrockagent#CrawlFilterConfiguration", - "traits": { - "smithy.api#documentation": "The configuration of filtering the Salesforce content. For example, \n configuring regular expression patterns to include or exclude certain \n content.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The configuration of the Salesforce content. For example, configuring \n specific types of Salesforce content.
" - } - }, - "com.amazonaws.bedrockagent#SalesforceDataSourceConfiguration": { - "type": "structure", - "members": { - "sourceConfiguration": { - "target": "com.amazonaws.bedrockagent#SalesforceSourceConfiguration", - "traits": { - "smithy.api#documentation": "The endpoint information to connect to your Salesforce data source.
", - "smithy.api#required": {} - } - }, - "crawlerConfiguration": { - "target": "com.amazonaws.bedrockagent#SalesforceCrawlerConfiguration", - "traits": { - "smithy.api#documentation": "The configuration of the Salesforce content. For example, configuring \n specific types of Salesforce content.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The configuration information to connect to Salesforce as your data source.
" - } - }, - "com.amazonaws.bedrockagent#SalesforceSourceConfiguration": { - "type": "structure", - "members": { - "hostUrl": { - "target": "com.amazonaws.bedrockagent#HttpsUrl", - "traits": { - "smithy.api#documentation": "The Salesforce host URL or instance URL.
", - "smithy.api#required": {} - } - }, - "authType": { - "target": "com.amazonaws.bedrockagent#SalesforceAuthType", - "traits": { - "smithy.api#documentation": "The supported authentication type to authenticate and connect to your \n Salesforce instance.
", - "smithy.api#required": {} - } - }, - "credentialsSecretArn": { - "target": "com.amazonaws.bedrockagent#SecretArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name of an Secrets Manager secret that \n stores your authentication credentials for your Salesforce instance URL. \n For more information on the key-value pairs that must be included in \n your secret, depending on your authentication type, see \n Salesforce connection configuration.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "The endpoint information to connect to your Salesforce data source.
" - } - }, - "com.amazonaws.bedrockagent#SecretArn": { - "type": "string", - "traits": { - "smithy.api#pattern": "^arn:aws(|-cn|-us-gov):secretsmanager:[a-z0-9-]{1,20}:([0-9]{12}|):secret:[a-zA-Z0-9!/_+=.@-]{1,512}$" - } - }, - "com.amazonaws.bedrockagent#SeedUrl": { - "type": "structure", - "members": { - "url": { - "target": "com.amazonaws.bedrockagent#Url", - "traits": { - "smithy.api#documentation": "A seed or starting point URL.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The seed or starting point URL. \n You should be authorized to crawl the URL.
" - } - }, - "com.amazonaws.bedrockagent#SeedUrls": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrockagent#SeedUrl" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.bedrockagent#SemanticChunkingConfiguration": { - "type": "structure", - "members": { - "maxTokens": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "The maximum number of tokens that a chunk can contain.
", - "smithy.api#range": { - "min": 1 - }, - "smithy.api#required": {} - } - }, - "bufferSize": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "The buffer size.
", - "smithy.api#range": { - "min": 0, - "max": 1 - }, - "smithy.api#required": {} - } - }, - "breakpointPercentileThreshold": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "The dissimilarity threshold for splitting chunks.
", - "smithy.api#range": { - "min": 50, - "max": 99 - }, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Settings for semantic document chunking for a data source. Semantic chunking splits\n a document into into smaller documents based on groups of similar content derived from the text\n with natural language processing.
\nWith semantic chunking, each sentence is compared to the next to determine how similar they are.\n You specify a threshold in the form of a percentile, where adjacent sentences that are less similar than\n that percentage of sentence pairs are divided into separate chunks. For example, if you set the threshold to \n 90, then the 10 percent of sentence pairs that are least similar are split. So if you have 101 sentences,\n 100 sentence pairs are compared, and the 10 with the least similarity are split, creating 11 chunks. These\n chunks are further split if they exceed the max token size.
\nYou must also specify a buffer size, which determines whether sentences are compared in isolation, or\n within a moving context window that includes the previous and following sentence. For example, if you set\n the buffer size to 1, the embedding for sentence 10 is derived from sentences 9, 10, and 11\n combined.
The Amazon Resource Name (ARN) of the KMS key used to encrypt the resource.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains the configuration for server-side encryption.
" - } - }, - "com.amazonaws.bedrockagent#ServiceQuotaExceededException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.bedrockagent#NonBlankString" - } - }, - "traits": { - "smithy.api#documentation": "The number of requests exceeds the service quota. Resubmit your request later.
", - "smithy.api#error": "client", - "smithy.api#httpError": 402 - } - }, - "com.amazonaws.bedrockagent#SessionTTL": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 60, - "max": 3600 - } - } - }, - "com.amazonaws.bedrockagent#SharePointAuthType": { - "type": "enum", - "members": { - "OAUTH2_CLIENT_CREDENTIALS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "OAUTH2_CLIENT_CREDENTIALS" - } - } - } - }, - "com.amazonaws.bedrockagent#SharePointCrawlerConfiguration": { - "type": "structure", - "members": { - "filterConfiguration": { - "target": "com.amazonaws.bedrockagent#CrawlFilterConfiguration", - "traits": { - "smithy.api#documentation": "The configuration of filtering the SharePoint content. For example, \n configuring regular expression patterns to include or exclude certain content.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The configuration of the SharePoint content. For example, configuring \n specific types of SharePoint content.
" - } - }, - "com.amazonaws.bedrockagent#SharePointDataSourceConfiguration": { - "type": "structure", - "members": { - "sourceConfiguration": { - "target": "com.amazonaws.bedrockagent#SharePointSourceConfiguration", - "traits": { - "smithy.api#documentation": "The endpoint information to connect to your SharePoint data source.
", - "smithy.api#required": {} - } - }, - "crawlerConfiguration": { - "target": "com.amazonaws.bedrockagent#SharePointCrawlerConfiguration", - "traits": { - "smithy.api#documentation": "The configuration of the SharePoint content. For example, configuring \n specific types of SharePoint content.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The configuration information to connect to SharePoint as your data source.
" - } - }, - "com.amazonaws.bedrockagent#SharePointDomain": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.bedrockagent#SharePointHostType": { - "type": "enum", - "members": { - "ONLINE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ONLINE" - } - } - } - }, - "com.amazonaws.bedrockagent#SharePointSiteUrls": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrockagent#HttpsUrl" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.bedrockagent#SharePointSourceConfiguration": { - "type": "structure", - "members": { - "tenantId": { - "target": "com.amazonaws.bedrockagent#Microsoft365TenantId", - "traits": { - "smithy.api#documentation": "The identifier of your Microsoft 365 tenant.
" - } - }, - "domain": { - "target": "com.amazonaws.bedrockagent#SharePointDomain", - "traits": { - "smithy.api#documentation": "The domain of your SharePoint instance or site URL/URLs.
", - "smithy.api#required": {} - } - }, - "siteUrls": { - "target": "com.amazonaws.bedrockagent#SharePointSiteUrls", - "traits": { - "smithy.api#documentation": "A list of one or more SharePoint site URLs.
", - "smithy.api#required": {} - } - }, - "hostType": { - "target": "com.amazonaws.bedrockagent#SharePointHostType", - "traits": { - "smithy.api#documentation": "The supported host type, whether online/cloud or server/on-premises.
", - "smithy.api#required": {} - } - }, - "authType": { - "target": "com.amazonaws.bedrockagent#SharePointAuthType", - "traits": { - "smithy.api#documentation": "The supported authentication type to authenticate and connect \n to your SharePoint site/sites.
", - "smithy.api#required": {} - } - }, - "credentialsSecretArn": { - "target": "com.amazonaws.bedrockagent#SecretArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name of an Secrets Manager secret that \n stores your authentication credentials for your SharePoint site/sites. \n For more information on the key-value pairs that must be included in \n your secret, depending on your authentication type, see \n SharePoint connection configuration.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "The endpoint information to connect to your SharePoint data source.
" - } - }, - "com.amazonaws.bedrockagent#SortOrder": { - "type": "enum", - "members": { - "ASCENDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ASCENDING" - } - }, - "DESCENDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DESCENDING" - } - } - } - }, - "com.amazonaws.bedrockagent#StartIngestionJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#StartIngestionJobRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#StartIngestionJobResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrockagent#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrockagent#ConflictException" - }, - { - "target": "com.amazonaws.bedrockagent#InternalServerException" - }, - { - "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrockagent#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Begins an ingestion job, in which a data source is added to a knowledge base.
", - "smithy.api#http": { - "code": 202, - "method": "PUT", - "uri": "/knowledgebases/{knowledgeBaseId}/datasources/{dataSourceId}/ingestionjobs/" - }, - "smithy.api#idempotent": {}, - "smithy.api#tags": ["console"] - } - }, - "com.amazonaws.bedrockagent#StartIngestionJobRequest": { - "type": "structure", - "members": { - "knowledgeBaseId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the knowledge base to which to add the data source.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "dataSourceId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the data source to ingest.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "clientToken": { - "target": "com.amazonaws.bedrockagent#ClientToken", - "traits": { - "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
", - "smithy.api#idempotencyToken": {} - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#Description", - "traits": { - "smithy.api#documentation": "A description of the ingestion job.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrockagent#StartIngestionJobResponse": { - "type": "structure", - "members": { - "ingestionJob": { - "target": "com.amazonaws.bedrockagent#IngestionJob", - "traits": { - "smithy.api#documentation": "An object containing information about the ingestion job.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrockagent#StepType": { - "type": "enum", - "members": { - "POST_CHUNKING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "POST_CHUNKING" - } - } - } - }, - "com.amazonaws.bedrockagent#StopSequences": { - "type": "list", - "member": { - "target": "smithy.api#String" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 4 - } - } - }, - "com.amazonaws.bedrockagent#StorageConfiguration": { - "type": "structure", - "members": { - "type": { - "target": "com.amazonaws.bedrockagent#KnowledgeBaseStorageType", - "traits": { - "smithy.api#documentation": "The vector store service in which the knowledge base is stored.
", - "smithy.api#required": {} - } - }, - "opensearchServerlessConfiguration": { - "target": "com.amazonaws.bedrockagent#OpenSearchServerlessConfiguration", - "traits": { - "smithy.api#documentation": "Contains the storage configuration of the knowledge base in Amazon OpenSearch Service.
" - } - }, - "pineconeConfiguration": { - "target": "com.amazonaws.bedrockagent#PineconeConfiguration", - "traits": { - "smithy.api#documentation": "Contains the storage configuration of the knowledge base in Pinecone.
" - } - }, - "redisEnterpriseCloudConfiguration": { - "target": "com.amazonaws.bedrockagent#RedisEnterpriseCloudConfiguration", - "traits": { - "smithy.api#documentation": "Contains the storage configuration of the knowledge base in Redis Enterprise Cloud.
" - } - }, - "rdsConfiguration": { - "target": "com.amazonaws.bedrockagent#RdsConfiguration", - "traits": { - "smithy.api#documentation": "Contains details about the storage configuration of the knowledge base in Amazon RDS. For more information, see Create a vector index in Amazon RDS.
" - } - }, - "mongoDbAtlasConfiguration": { - "target": "com.amazonaws.bedrockagent#MongoDbAtlasConfiguration", - "traits": { - "smithy.api#documentation": "Contains the storage configuration of the knowledge base in MongoDB Atlas.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains the storage configuration of the knowledge base.
" - } - }, - "com.amazonaws.bedrockagent#StorageDays": { - "type": "integer", - "traits": { - "smithy.api#default": 30, - "smithy.api#range": { - "min": 0, - "max": 30 - } - } - }, - "com.amazonaws.bedrockagent#StorageFlowNodeConfiguration": { - "type": "structure", - "members": { - "serviceConfiguration": { - "target": "com.amazonaws.bedrockagent#StorageFlowNodeServiceConfiguration", - "traits": { - "smithy.api#documentation": "Contains configurations for the service to use for storing the input into the node.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Contains configurations for a Storage node in a flow. This node stores the input in an Amazon S3 location that you specify.
" - } - }, - "com.amazonaws.bedrockagent#StorageFlowNodeS3Configuration": { - "type": "structure", - "members": { - "bucketName": { - "target": "com.amazonaws.bedrockagent#S3BucketName", - "traits": { - "smithy.api#documentation": "The name of the Amazon S3 bucket in which to store the input into the node.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Contains configurations for the Amazon S3 location in which to store the input into the node.
" - } - }, - "com.amazonaws.bedrockagent#StorageFlowNodeServiceConfiguration": { - "type": "union", - "members": { - "s3": { - "target": "com.amazonaws.bedrockagent#StorageFlowNodeS3Configuration", - "traits": { - "smithy.api#documentation": "Contains configurations for the Amazon S3 location in which to store the input into the node.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains configurations for the service to use for storing the input into the node.
" - } - }, - "com.amazonaws.bedrockagent#TagKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - }, - "smithy.api#pattern": "^[a-zA-Z0-9\\s._:/=+@-]*$" - } - }, - "com.amazonaws.bedrockagent#TagKeyList": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrockagent#TagKey" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 200 - } - } - }, - "com.amazonaws.bedrockagent#TagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#TagResourceRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#TagResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrockagent#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrockagent#InternalServerException" - }, - { - "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrockagent#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Associate tags with a resource. For more information, see Tagging resources in the Amazon Bedrock User Guide.
", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/tags/{resourceArn}" - } - } - }, - "com.amazonaws.bedrockagent#TagResourceRequest": { - "type": "structure", - "members": { - "resourceArn": { - "target": "com.amazonaws.bedrockagent#TaggableResourcesArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource to tag.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.bedrockagent#TagsMap", - "traits": { - "smithy.api#documentation": "An object containing key-value pairs that define the tags to attach to the resource.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrockagent#TagResourceResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrockagent#TagValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - }, - "smithy.api#pattern": "^[a-zA-Z0-9\\s._:/=+@-]*$" - } - }, - "com.amazonaws.bedrockagent#TaggableResourcesArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 20, - "max": 1011 - }, - "smithy.api#pattern": "(^arn:aws:bedrock:[a-zA-Z0-9-]+:/d{12}:(agent|agent-alias|knowledge-base|flow|prompt)/[A-Z0-9]{10}(?:/[A-Z0-9]{10})?$|^arn:aws:bedrock:[a-zA-Z0-9-]+:/d{12}:flow/([A-Z0-9]{10})/alias/([A-Z0-9]{10})$|^arn:aws:bedrock:[a-zA-Z0-9-]+:/d{12}:prompt/([A-Z0-9]{10})?(?::/d+)?$)" - } - }, - "com.amazonaws.bedrockagent#TaggingResource": { - "type": "resource", - "operations": [ - { - "target": "com.amazonaws.bedrockagent#ListTagsForResource" - }, - { - "target": "com.amazonaws.bedrockagent#TagResource" - }, - { - "target": "com.amazonaws.bedrockagent#UntagResource" - } - ] - }, - "com.amazonaws.bedrockagent#TagsMap": { - "type": "map", - "key": { - "target": "com.amazonaws.bedrockagent#TagKey" - }, - "value": { - "target": "com.amazonaws.bedrockagent#TagValue" - } - }, - "com.amazonaws.bedrockagent#Temperature": { - "type": "float", - "traits": { - "smithy.api#range": { - "min": 0, - "max": 1 - } - } - }, - "com.amazonaws.bedrockagent#TextPrompt": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 200000 - }, - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.bedrockagent#TextPromptTemplateConfiguration": { - "type": "structure", - "members": { - "text": { - "target": "com.amazonaws.bedrockagent#TextPrompt", - "traits": { - "smithy.api#documentation": "The message for the prompt.
", - "smithy.api#required": {} - } - }, - "inputVariables": { - "target": "com.amazonaws.bedrockagent#PromptInputVariablesList", - "traits": { - "smithy.api#documentation": "An array of the variables in the prompt template.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains configurations for a text prompt template. To include a variable, enclose a word in double curly braces as in {{variable}}.
The number of requests exceeds the limit. Resubmit your request later.
", - "smithy.api#error": "client", - "smithy.api#httpError": 429 - } - }, - "com.amazonaws.bedrockagent#TopK": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 0, - "max": 500 - } - } - }, - "com.amazonaws.bedrockagent#TopP": { - "type": "float", - "traits": { - "smithy.api#range": { - "min": 0, - "max": 1 - } - } - }, - "com.amazonaws.bedrockagent#Transformation": { - "type": "structure", - "members": { - "transformationFunction": { - "target": "com.amazonaws.bedrockagent#TransformationFunction", - "traits": { - "smithy.api#documentation": "A Lambda function that processes documents.
", - "smithy.api#required": {} - } - }, - "stepToApply": { - "target": "com.amazonaws.bedrockagent#StepType", - "traits": { - "smithy.api#documentation": "When the service applies the transformation.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "A custom processing step for documents moving through a data source ingestion pipeline. To\n process documents after they have been converted into chunks, set the step to apply to\n POST_CHUNKING.
The Lambda function.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "A Lambda function that processes documents.
" - } - }, - "com.amazonaws.bedrockagent#TransformationLambdaConfiguration": { - "type": "structure", - "members": { - "lambdaArn": { - "target": "com.amazonaws.bedrockagent#LambdaArn", - "traits": { - "smithy.api#documentation": "The function's ARN identifier.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "A Lambda function that processes documents.
" - } - }, - "com.amazonaws.bedrockagent#Transformations": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrockagent#Transformation" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1 - } - } - }, - "com.amazonaws.bedrockagent#Type": { - "type": "enum", - "members": { - "STRING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "string" - } - }, - "NUMBER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "number" - } - }, - "INTEGER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "integer" - } - }, - "BOOLEAN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "boolean" - } - }, - "ARRAY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "array" - } - } - } - }, - "com.amazonaws.bedrockagent#UntagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#UntagResourceRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#UntagResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrockagent#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrockagent#InternalServerException" - }, - { - "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrockagent#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Remove tags from a resource.
", - "smithy.api#http": { - "code": 200, - "method": "DELETE", - "uri": "/tags/{resourceArn}" - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.bedrockagent#UntagResourceRequest": { - "type": "structure", - "members": { - "resourceArn": { - "target": "com.amazonaws.bedrockagent#TaggableResourcesArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource from which to remove tags.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "tagKeys": { - "target": "com.amazonaws.bedrockagent#TagKeyList", - "traits": { - "smithy.api#documentation": "A list of keys of the tags to remove from the resource.
", - "smithy.api#httpQuery": "tagKeys", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrockagent#UntagResourceResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrockagent#UpdateAgent": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#UpdateAgentRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#UpdateAgentResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrockagent#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrockagent#ConflictException" - }, - { - "target": "com.amazonaws.bedrockagent#InternalServerException" - }, - { - "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrockagent#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Updates the configuration of an agent.
", - "smithy.api#http": { - "code": 202, - "method": "PUT", - "uri": "/agents/{agentId}/" - }, - "smithy.api#idempotent": {}, - "smithy.api#tags": ["console"] - } - }, - "com.amazonaws.bedrockagent#UpdateAgentActionGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#UpdateAgentActionGroupRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#UpdateAgentActionGroupResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrockagent#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrockagent#ConflictException" - }, - { - "target": "com.amazonaws.bedrockagent#InternalServerException" - }, - { - "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrockagent#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Updates the configuration for an action group for an agent.
", - "smithy.api#http": { - "code": 200, - "method": "PUT", - "uri": "/agents/{agentId}/agentversions/{agentVersion}/actiongroups/{actionGroupId}/" - }, - "smithy.api#idempotent": {}, - "smithy.api#tags": ["console"] - } - }, - "com.amazonaws.bedrockagent#UpdateAgentActionGroupRequest": { - "type": "structure", - "members": { - "agentId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the agent for which to update the action group.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "agentVersion": { - "target": "com.amazonaws.bedrockagent#DraftVersion", - "traits": { - "smithy.api#documentation": "The unique identifier of the agent version for which to update the action group.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "actionGroupId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the action group.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "actionGroupName": { - "target": "com.amazonaws.bedrockagent#Name", - "traits": { - "smithy.api#documentation": "Specifies a new name for the action group.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#Description", - "traits": { - "smithy.api#documentation": "Specifies a new name for the action group.
" - } - }, - "parentActionGroupSignature": { - "target": "com.amazonaws.bedrockagent#ActionGroupSignature", - "traits": { - "smithy.api#documentation": "To allow your agent to request the user for additional information when trying to complete a task, set this field to AMAZON.UserInput. You must leave the description, apiSchema, and actionGroupExecutor fields blank for this action group.
During orchestration, if your agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an Observation reprompting the user for more information.
" - } - }, - "actionGroupExecutor": { - "target": "com.amazonaws.bedrockagent#ActionGroupExecutor", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.
" - } - }, - "actionGroupState": { - "target": "com.amazonaws.bedrockagent#ActionGroupState", - "traits": { - "smithy.api#documentation": "Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
" - } - }, - "apiSchema": { - "target": "com.amazonaws.bedrockagent#APISchema", - "traits": { - "smithy.api#documentation": "Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see Action group OpenAPI schemas.
" - } - }, - "functionSchema": { - "target": "com.amazonaws.bedrockagent#FunctionSchema", - "traits": { - "smithy.api#documentation": "Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrockagent#UpdateAgentActionGroupResponse": { - "type": "structure", - "members": { - "agentActionGroup": { - "target": "com.amazonaws.bedrockagent#AgentActionGroup", - "traits": { - "smithy.api#documentation": "Contains details about the action group that was updated.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrockagent#UpdateAgentAlias": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#UpdateAgentAliasRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#UpdateAgentAliasResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrockagent#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrockagent#ConflictException" - }, - { - "target": "com.amazonaws.bedrockagent#InternalServerException" - }, - { - "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrockagent#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Updates configurations for an alias of an agent.
", - "smithy.api#http": { - "code": 202, - "method": "PUT", - "uri": "/agents/{agentId}/agentaliases/{agentAliasId}/" - }, - "smithy.api#idempotent": {}, - "smithy.api#tags": ["console"] - } - }, - "com.amazonaws.bedrockagent#UpdateAgentAliasRequest": { - "type": "structure", - "members": { - "agentId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the agent.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "agentAliasId": { - "target": "com.amazonaws.bedrockagent#AgentAliasId", - "traits": { - "smithy.api#documentation": "The unique identifier of the alias.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "agentAliasName": { - "target": "com.amazonaws.bedrockagent#Name", - "traits": { - "smithy.api#documentation": "Specifies a new name for the alias.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#Description", - "traits": { - "smithy.api#documentation": "Specifies a new description for the alias.
" - } - }, - "routingConfiguration": { - "target": "com.amazonaws.bedrockagent#AgentAliasRoutingConfiguration", - "traits": { - "smithy.api#documentation": "Contains details about the routing configuration of the alias.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrockagent#UpdateAgentAliasResponse": { - "type": "structure", - "members": { - "agentAlias": { - "target": "com.amazonaws.bedrockagent#AgentAlias", - "traits": { - "smithy.api#documentation": "Contains details about the alias that was updated.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrockagent#UpdateAgentKnowledgeBase": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#UpdateAgentKnowledgeBaseRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#UpdateAgentKnowledgeBaseResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrockagent#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrockagent#ConflictException" - }, - { - "target": "com.amazonaws.bedrockagent#InternalServerException" - }, - { - "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrockagent#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Updates the configuration for a knowledge base that has been associated with an agent.
", - "smithy.api#http": { - "code": 200, - "method": "PUT", - "uri": "/agents/{agentId}/agentversions/{agentVersion}/knowledgebases/{knowledgeBaseId}/" - }, - "smithy.api#idempotent": {}, - "smithy.api#tags": ["console"] - } - }, - "com.amazonaws.bedrockagent#UpdateAgentKnowledgeBaseRequest": { - "type": "structure", - "members": { - "agentId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the agent associated with the knowledge base that you want to update.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "agentVersion": { - "target": "com.amazonaws.bedrockagent#DraftVersion", - "traits": { - "smithy.api#documentation": "The version of the agent associated with the knowledge base that you want to update.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "knowledgeBaseId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the knowledge base that has been associated with an agent.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#Description", - "traits": { - "smithy.api#documentation": "Specifies a new description for the knowledge base associated with an agent.
" - } - }, - "knowledgeBaseState": { - "target": "com.amazonaws.bedrockagent#KnowledgeBaseState", - "traits": { - "smithy.api#documentation": "Specifies whether the agent uses the knowledge base or not when sending an InvokeAgent request.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrockagent#UpdateAgentKnowledgeBaseResponse": { - "type": "structure", - "members": { - "agentKnowledgeBase": { - "target": "com.amazonaws.bedrockagent#AgentKnowledgeBase", - "traits": { - "smithy.api#documentation": "Contains details about the knowledge base that has been associated with an agent.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrockagent#UpdateAgentRequest": { - "type": "structure", - "members": { - "agentId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the agent.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "agentName": { - "target": "com.amazonaws.bedrockagent#Name", - "traits": { - "smithy.api#documentation": "Specifies a new name for the agent.
", - "smithy.api#required": {} - } - }, - "instruction": { - "target": "com.amazonaws.bedrockagent#Instruction", - "traits": { - "smithy.api#documentation": "Specifies new instructions that tell the agent what it should do and how it should interact with users.
" - } - }, - "foundationModel": { - "target": "com.amazonaws.bedrockagent#ModelIdentifier", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Specifies a new foundation model to be used for orchestration by the agent.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#Description", - "traits": { - "smithy.api#documentation": "Specifies a new description of the agent.
" - } - }, - "idleSessionTTLInSeconds": { - "target": "com.amazonaws.bedrockagent#SessionTTL", - "traits": { - "smithy.api#documentation": "The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.
\nA user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.
" - } - }, - "agentResourceRoleArn": { - "target": "com.amazonaws.bedrockagent#AgentRoleArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.
", - "smithy.api#required": {} - } - }, - "customerEncryptionKeyArn": { - "target": "com.amazonaws.bedrockagent#KmsKeyArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key with which to encrypt the agent.
" - } - }, - "promptOverrideConfiguration": { - "target": "com.amazonaws.bedrockagent#PromptOverrideConfiguration", - "traits": { - "smithy.api#documentation": "Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.
" - } - }, - "guardrailConfiguration": { - "target": "com.amazonaws.bedrockagent#GuardrailConfiguration", - "traits": { - "smithy.api#documentation": "The unique Guardrail configuration assigned to the agent when it is updated.
" - } - }, - "memoryConfiguration": { - "target": "com.amazonaws.bedrockagent#MemoryConfiguration", - "traits": { - "smithy.api#documentation": "Specifies the new memory configuration for the agent.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrockagent#UpdateAgentResponse": { - "type": "structure", - "members": { - "agent": { - "target": "com.amazonaws.bedrockagent#Agent", - "traits": { - "smithy.api#documentation": "Contains details about the agent that was updated.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrockagent#UpdateDataSource": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#UpdateDataSourceRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#UpdateDataSourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrockagent#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrockagent#ConflictException" - }, - { - "target": "com.amazonaws.bedrockagent#InternalServerException" - }, - { - "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrockagent#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Updates the configurations for a data source connector.
\nYou can't change the chunkingConfiguration after you create the data source connector. Specify the existing chunkingConfiguration.
The unique identifier of the knowledge base for the data source.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "dataSourceId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the data source.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "name": { - "target": "com.amazonaws.bedrockagent#Name", - "traits": { - "smithy.api#documentation": "Specifies a new name for the data source.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#Description", - "traits": { - "smithy.api#documentation": "Specifies a new description for the data source.
" - } - }, - "dataSourceConfiguration": { - "target": "com.amazonaws.bedrockagent#DataSourceConfiguration", - "traits": { - "smithy.api#documentation": "The connection configuration for the data source that you want to update.
", - "smithy.api#required": {} - } - }, - "dataDeletionPolicy": { - "target": "com.amazonaws.bedrockagent#DataDeletionPolicy", - "traits": { - "smithy.api#documentation": "The data deletion policy for the data source that you want to update.
" - } - }, - "serverSideEncryptionConfiguration": { - "target": "com.amazonaws.bedrockagent#ServerSideEncryptionConfiguration", - "traits": { - "smithy.api#documentation": "Contains details about server-side encryption of the data source.
" - } - }, - "vectorIngestionConfiguration": { - "target": "com.amazonaws.bedrockagent#VectorIngestionConfiguration", - "traits": { - "smithy.api#documentation": "Contains details about how to ingest the documents in the data source.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrockagent#UpdateDataSourceResponse": { - "type": "structure", - "members": { - "dataSource": { - "target": "com.amazonaws.bedrockagent#DataSource", - "traits": { - "smithy.api#documentation": "Contains details about the data source.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrockagent#UpdateFlow": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#UpdateFlowRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#UpdateFlowResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrockagent#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrockagent#ConflictException" - }, - { - "target": "com.amazonaws.bedrockagent#InternalServerException" - }, - { - "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrockagent#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Modifies a flow. Include both fields that you want to keep and fields that you want to change. For more information, see How it works and Create a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
", - "smithy.api#http": { - "code": 200, - "method": "PUT", - "uri": "/flows/{flowIdentifier}/" - }, - "smithy.api#idempotent": {}, - "smithy.api#tags": ["console"] - } - }, - "com.amazonaws.bedrockagent#UpdateFlowAlias": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#UpdateFlowAliasRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#UpdateFlowAliasResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrockagent#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrockagent#ConflictException" - }, - { - "target": "com.amazonaws.bedrockagent#InternalServerException" - }, - { - "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrockagent#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Modifies the alias of a flow. Include both fields that you want to keep and ones that you want to change. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
", - "smithy.api#http": { - "code": 200, - "method": "PUT", - "uri": "/flows/{flowIdentifier}/aliases/{aliasIdentifier}" - }, - "smithy.api#idempotent": {}, - "smithy.api#tags": ["console"] - } - }, - "com.amazonaws.bedrockagent#UpdateFlowAliasRequest": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.bedrockagent#Name", - "traits": { - "smithy.api#documentation": "The name of the alias.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#Description", - "traits": { - "smithy.api#documentation": "A description for the alias.
" - } - }, - "routingConfiguration": { - "target": "com.amazonaws.bedrockagent#FlowAliasRoutingConfiguration", - "traits": { - "smithy.api#documentation": "Contains information about the version to which to map the alias.
", - "smithy.api#required": {} - } - }, - "flowIdentifier": { - "target": "com.amazonaws.bedrockagent#FlowIdentifier", - "traits": { - "smithy.api#documentation": "The unique identifier of the flow.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "aliasIdentifier": { - "target": "com.amazonaws.bedrockagent#FlowAliasIdentifier", - "traits": { - "smithy.api#documentation": "The unique identifier of the alias.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrockagent#UpdateFlowAliasResponse": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.bedrockagent#Name", - "traits": { - "smithy.api#documentation": "The name of the alias.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#Description", - "traits": { - "smithy.api#documentation": "The description of the flow.
" - } - }, - "routingConfiguration": { - "target": "com.amazonaws.bedrockagent#FlowAliasRoutingConfiguration", - "traits": { - "smithy.api#documentation": "Contains information about the version that the alias is mapped to.
", - "smithy.api#required": {} - } - }, - "flowId": { - "target": "com.amazonaws.bedrockagent#FlowId", - "traits": { - "smithy.api#documentation": "The unique identifier of the flow.
", - "smithy.api#required": {} - } - }, - "id": { - "target": "com.amazonaws.bedrockagent#FlowAliasId", - "traits": { - "smithy.api#documentation": "The unique identifier of the alias.
", - "smithy.api#required": {} - } - }, - "arn": { - "target": "com.amazonaws.bedrockagent#FlowAliasArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the flow.
", - "smithy.api#required": {} - } - }, - "createdAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the flow was created.
", - "smithy.api#required": {} - } - }, - "updatedAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the alias was last updated.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrockagent#UpdateFlowRequest": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.bedrockagent#FlowName", - "traits": { - "smithy.api#documentation": "A name for the flow.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#FlowDescription", - "traits": { - "smithy.api#documentation": "A description for the flow.
" - } - }, - "executionRoleArn": { - "target": "com.amazonaws.bedrockagent#FlowExecutionRoleArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the service role with permissions to create and manage a flow. For more information, see Create a service role for flows in Amazon Bedrock in the Amazon Bedrock User Guide.
", - "smithy.api#required": {} - } - }, - "customerEncryptionKeyArn": { - "target": "com.amazonaws.bedrockagent#KmsKeyArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key to encrypt the flow.
" - } - }, - "definition": { - "target": "com.amazonaws.bedrockagent#FlowDefinition", - "traits": { - "smithy.api#documentation": "A definition of the nodes and the connections between the nodes in the flow.
" - } - }, - "flowIdentifier": { - "target": "com.amazonaws.bedrockagent#FlowIdentifier", - "traits": { - "smithy.api#documentation": "The unique identifier of the flow.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrockagent#UpdateFlowResponse": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.bedrockagent#FlowName", - "traits": { - "smithy.api#documentation": "The name of the flow.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#FlowDescription", - "traits": { - "smithy.api#documentation": "The description of the flow.
" - } - }, - "executionRoleArn": { - "target": "com.amazonaws.bedrockagent#FlowExecutionRoleArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the service role with permissions to create a flow. For more information, see Create a service role for flows in Amazon Bedrock in the Amazon Bedrock User Guide.
", - "smithy.api#required": {} - } - }, - "customerEncryptionKeyArn": { - "target": "com.amazonaws.bedrockagent#KmsKeyArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key that the flow was encrypted with.
" - } - }, - "id": { - "target": "com.amazonaws.bedrockagent#FlowId", - "traits": { - "smithy.api#documentation": "The unique identifier of the flow.
", - "smithy.api#required": {} - } - }, - "arn": { - "target": "com.amazonaws.bedrockagent#FlowArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the flow.
", - "smithy.api#required": {} - } - }, - "status": { - "target": "com.amazonaws.bedrockagent#FlowStatus", - "traits": { - "smithy.api#documentation": "The status of the flow. When you submit this request, the status will be NotPrepared. If updating fails, the status becomes Failed.
The time at which the flow was created.
", - "smithy.api#required": {} - } - }, - "updatedAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the flow was last updated.
", - "smithy.api#required": {} - } - }, - "version": { - "target": "com.amazonaws.bedrockagent#DraftVersion", - "traits": { - "smithy.api#documentation": "The version of the flow. When you update a flow, the version updated is the DRAFT version.
A definition of the nodes and the connections between nodes in the flow.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrockagent#UpdateKnowledgeBase": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#UpdateKnowledgeBaseRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#UpdateKnowledgeBaseResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrockagent#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrockagent#ConflictException" - }, - { - "target": "com.amazonaws.bedrockagent#InternalServerException" - }, - { - "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrockagent#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Updates the configuration of a knowledge base with the fields that you specify. Because all fields will be overwritten, you must include the same values for fields that you want to keep the same.
\nYou can change the following fields:
\n\n name\n
\n description\n
\n roleArn\n
You can't change the knowledgeBaseConfiguration or storageConfiguration fields, so you must specify the same configurations as when you created the knowledge base. You can send a GetKnowledgeBase request and copy the same configurations.
The unique identifier of the knowledge base to update.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "name": { - "target": "com.amazonaws.bedrockagent#Name", - "traits": { - "smithy.api#documentation": "Specifies a new name for the knowledge base.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#Description", - "traits": { - "smithy.api#documentation": "Specifies a new description for the knowledge base.
" - } - }, - "roleArn": { - "target": "com.amazonaws.bedrockagent#KnowledgeBaseRoleArn", - "traits": { - "smithy.api#documentation": "Specifies a different Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.
", - "smithy.api#required": {} - } - }, - "knowledgeBaseConfiguration": { - "target": "com.amazonaws.bedrockagent#KnowledgeBaseConfiguration", - "traits": { - "smithy.api#documentation": "Specifies the configuration for the embeddings model used for the knowledge base. You must use the same configuration as when the knowledge base was created.
", - "smithy.api#required": {} - } - }, - "storageConfiguration": { - "target": "com.amazonaws.bedrockagent#StorageConfiguration", - "traits": { - "smithy.api#documentation": "Specifies the configuration for the vector store used for the knowledge base. You must use the same configuration as when the knowledge base was created.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrockagent#UpdateKnowledgeBaseResponse": { - "type": "structure", - "members": { - "knowledgeBase": { - "target": "com.amazonaws.bedrockagent#KnowledgeBase", - "traits": { - "smithy.api#documentation": "Contains details about the knowledge base.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrockagent#UpdatePrompt": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#UpdatePromptRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#UpdatePromptResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrockagent#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrockagent#ConflictException" - }, - { - "target": "com.amazonaws.bedrockagent#InternalServerException" - }, - { - "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrockagent#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Modifies a prompt in your prompt library. Include both fields that you want to keep and fields that you want to replace. For more information, see Prompt management in Amazon Bedrock and Edit prompts in your prompt library in the Amazon Bedrock User Guide.
", - "smithy.api#http": { - "code": 200, - "method": "PUT", - "uri": "/prompts/{promptIdentifier}/" - }, - "smithy.api#idempotent": {}, - "smithy.api#tags": ["console"] - } - }, - "com.amazonaws.bedrockagent#UpdatePromptRequest": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.bedrockagent#PromptName", - "traits": { - "smithy.api#documentation": "A name for the prompt.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#PromptDescription", - "traits": { - "smithy.api#documentation": "A description for the prompt.
" - } - }, - "customerEncryptionKeyArn": { - "target": "com.amazonaws.bedrockagent#KmsKeyArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key to encrypt the prompt.
" - } - }, - "defaultVariant": { - "target": "com.amazonaws.bedrockagent#PromptVariantName", - "traits": { - "smithy.api#documentation": "The name of the default variant for the prompt. This value must match the name field in the relevant PromptVariant object.
A list of objects, each containing details about a variant of the prompt.
" - } - }, - "promptIdentifier": { - "target": "com.amazonaws.bedrockagent#PromptIdentifier", - "traits": { - "smithy.api#documentation": "The unique identifier of the prompt.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrockagent#UpdatePromptResponse": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.bedrockagent#PromptName", - "traits": { - "smithy.api#documentation": "The name of the prompt.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#PromptDescription", - "traits": { - "smithy.api#documentation": "The description of the prompt.
" - } - }, - "customerEncryptionKeyArn": { - "target": "com.amazonaws.bedrockagent#KmsKeyArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key to encrypt the prompt.
" - } - }, - "defaultVariant": { - "target": "com.amazonaws.bedrockagent#PromptVariantName", - "traits": { - "smithy.api#documentation": "The name of the default variant for the prompt. This value must match the name field in the relevant PromptVariant object.
A list of objects, each containing details about a variant of the prompt.
" - } - }, - "id": { - "target": "com.amazonaws.bedrockagent#PromptId", - "traits": { - "smithy.api#documentation": "The unique identifier of the prompt.
", - "smithy.api#required": {} - } - }, - "arn": { - "target": "com.amazonaws.bedrockagent#PromptArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the prompt.
", - "smithy.api#required": {} - } - }, - "version": { - "target": "com.amazonaws.bedrockagent#Version", - "traits": { - "smithy.api#documentation": "The version of the prompt. When you update a prompt, the version updated is the DRAFT version.
The time at which the prompt was created.
", - "smithy.api#required": {} - } - }, - "updatedAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the prompt was last updated.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrockagent#Url": { - "type": "string", - "traits": { - "smithy.api#pattern": "^https?://[A-Za-z0-9][^\\s]*$" - } - }, - "com.amazonaws.bedrockagent#UrlConfiguration": { - "type": "structure", - "members": { - "seedUrls": { - "target": "com.amazonaws.bedrockagent#SeedUrls", - "traits": { - "smithy.api#documentation": "One or more seed or starting point URLs.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The configuration of web URLs that you want to crawl. \n You should be authorized to crawl the URLs.
" - } - }, - "com.amazonaws.bedrockagent#ValidationException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.bedrockagent#NonBlankString" - }, - "fieldList": { - "target": "com.amazonaws.bedrockagent#ValidationExceptionFieldList", - "traits": { - "smithy.api#documentation": "A list of objects containing fields that caused validation errors and their corresponding validation error messages.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Input validation failed. Check your request parameters and retry the request.
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.bedrockagent#ValidationExceptionField": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.bedrockagent#NonBlankString", - "traits": { - "smithy.api#documentation": "The name of the field.
", - "smithy.api#required": {} - } - }, - "message": { - "target": "com.amazonaws.bedrockagent#NonBlankString", - "traits": { - "smithy.api#documentation": "A message describing why this field failed validation.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Stores information about a field passed inside a request that resulted in an validation error.
" - } - }, - "com.amazonaws.bedrockagent#ValidationExceptionFieldList": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrockagent#ValidationExceptionField" - } - }, - "com.amazonaws.bedrockagent#VectorIngestionConfiguration": { - "type": "structure", - "members": { - "chunkingConfiguration": { - "target": "com.amazonaws.bedrockagent#ChunkingConfiguration", - "traits": { - "smithy.api#documentation": "Details about how to chunk the documents in the data source. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried.
" - } - }, - "customTransformationConfiguration": { - "target": "com.amazonaws.bedrockagent#CustomTransformationConfiguration", - "traits": { - "smithy.api#documentation": "A custom document transformer for parsed data source documents.
" - } - }, - "parsingConfiguration": { - "target": "com.amazonaws.bedrockagent#ParsingConfiguration", - "traits": { - "smithy.api#documentation": "A custom parser for data source documents.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains details about how to ingest the documents in a data source.
" - } - }, - "com.amazonaws.bedrockagent#VectorKnowledgeBaseConfiguration": { - "type": "structure", - "members": { - "embeddingModelArn": { - "target": "com.amazonaws.bedrockagent#BedrockEmbeddingModelArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model used to create vector embeddings for the knowledge base.
", - "smithy.api#required": {} - } - }, - "embeddingModelConfiguration": { - "target": "com.amazonaws.bedrockagent#EmbeddingModelConfiguration", - "traits": { - "smithy.api#documentation": "The embeddings model configuration details for the vector model used in Knowledge Base.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains details about the model used to create vector embeddings for the knowledge base.
" - } - }, - "com.amazonaws.bedrockagent#Version": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 5 - }, - "smithy.api#pattern": "^(DRAFT|[0-9]{0,4}[1-9][0-9]{0,4})$" - } - }, - "com.amazonaws.bedrockagent#VersionResource": { - "type": "resource", - "operations": [ - { - "target": "com.amazonaws.bedrockagent#DeleteAgentVersion" - }, - { - "target": "com.amazonaws.bedrockagent#GetAgentVersion" - }, - { - "target": "com.amazonaws.bedrockagent#ListAgentVersions" - } - ] - }, - "com.amazonaws.bedrockagent#WebCrawlerConfiguration": { - "type": "structure", - "members": { - "crawlerLimits": { - "target": "com.amazonaws.bedrockagent#WebCrawlerLimits", - "traits": { - "smithy.api#documentation": "The configuration of crawl limits for the web URLs.
" - } - }, - "inclusionFilters": { - "target": "com.amazonaws.bedrockagent#FilterList", - "traits": { - "smithy.api#documentation": "A list of one or more inclusion regular expression patterns to include \n certain URLs. If you specify an inclusion and exclusion filter/pattern \n and both match a URL, the exclusion filter takes precedence and the web \n content of the URL isn’t crawled.
" - } - }, - "exclusionFilters": { - "target": "com.amazonaws.bedrockagent#FilterList", - "traits": { - "smithy.api#documentation": "A list of one or more exclusion regular expression patterns to exclude \n certain URLs. If you specify an inclusion and exclusion filter/pattern \n and both match a URL, the exclusion filter takes precedence and the web \n content of the URL isn’t crawled.
" - } - }, - "scope": { - "target": "com.amazonaws.bedrockagent#WebScopeType", - "traits": { - "smithy.api#documentation": "The scope of what is crawled for your URLs.
\nYou can choose to crawl only web pages that belong to the same host or primary \n domain. For example, only web pages that contain the seed URL \n \"https://docs.aws.amazon.com/bedrock/latest/userguide/\" and no other domains. \n You can choose to include sub domains in addition to the host or primary domain. \n For example, web pages that contain \"aws.amazon.com\" can also include sub domain \n \"docs.aws.amazon.com\".
" - } - } - }, - "traits": { - "smithy.api#documentation": "The configuration of web URLs that you want to crawl. \n You should be authorized to crawl the URLs.
" - } - }, - "com.amazonaws.bedrockagent#WebCrawlerLimits": { - "type": "structure", - "members": { - "rateLimit": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "The max rate at which pages are crawled, up to 300 per minute per host.
", - "smithy.api#range": { - "min": 1, - "max": 300 - } - } - } - }, - "traits": { - "smithy.api#documentation": "The rate limits for the URLs that you want to crawl. \n You should be authorized to crawl the URLs.
" - } - }, - "com.amazonaws.bedrockagent#WebDataSourceConfiguration": { - "type": "structure", - "members": { - "sourceConfiguration": { - "target": "com.amazonaws.bedrockagent#WebSourceConfiguration", - "traits": { - "smithy.api#documentation": "The source configuration details for the web data source.
", - "smithy.api#required": {} - } - }, - "crawlerConfiguration": { - "target": "com.amazonaws.bedrockagent#WebCrawlerConfiguration", - "traits": { - "smithy.api#documentation": "The Web Crawler configuration details for the web data source.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The configuration details for the web data source.
" - } - }, - "com.amazonaws.bedrockagent#WebScopeType": { - "type": "enum", - "members": { - "HOST_ONLY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HOST_ONLY" - } - }, - "SUBDOMAINS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SUBDOMAINS" - } - } - } - }, - "com.amazonaws.bedrockagent#WebSourceConfiguration": { - "type": "structure", - "members": { - "urlConfiguration": { - "target": "com.amazonaws.bedrockagent#UrlConfiguration", - "traits": { - "smithy.api#documentation": "The configuration of the URL/URLs.
", - "smithy.api#required": {} - } + "com.amazonaws.bedrockagent#AgentAliasId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 10, + "max": 10 + }, + "smithy.api#pattern": "^(\\bTSTALIASID\\b|[0-9a-zA-Z]+)$" + } + }, + "com.amazonaws.bedrockagent#AgentAliasRoutingConfiguration": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#AgentAliasRoutingConfigurationListItem" + }, + "traits": { + "smithy.api#length": { + "max": 1 + } + } + }, + "com.amazonaws.bedrockagent#AgentAliasRoutingConfigurationListItem": { + "type": "structure", + "members": { + "agentVersion": { + "target": "com.amazonaws.bedrockagent#Version", + "traits": { + "smithy.api#documentation": "The version of the agent with which the alias is associated.
" + } + }, + "provisionedThroughput": { + "target": "com.amazonaws.bedrockagent#ProvisionedModelIdentifier", + "traits": { + "smithy.api#documentation": "Information on the Provisioned Throughput assigned to an agent alias.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about the routing configuration of the alias.
" + } + }, + "com.amazonaws.bedrockagent#AgentAliasStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "PREPARED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PREPARED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + } + } + }, + "com.amazonaws.bedrockagent#AgentAliasSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#AgentAliasSummary" + }, + "traits": { + "smithy.api#length": { + "max": 10 + } + } + }, + "com.amazonaws.bedrockagent#AgentAliasSummary": { + "type": "structure", + "members": { + "agentAliasId": { + "target": "com.amazonaws.bedrockagent#AgentAliasId", + "traits": { + "smithy.api#documentation": "Contains details about
", + "smithy.api#required": {} + } + }, + "agentAliasName": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#documentation": "The name of the alias.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "The description of the alias.
" + } + }, + "routingConfiguration": { + "target": "com.amazonaws.bedrockagent#AgentAliasRoutingConfiguration", + "traits": { + "smithy.api#documentation": "Contains details about the version of the agent with which the alias is associated.
" + } + }, + "agentAliasStatus": { + "target": "com.amazonaws.bedrockagent#AgentAliasStatus", + "traits": { + "smithy.api#documentation": "The status of the alias.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the alias of the agent was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the alias was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about an alias of an agent.
" + } + }, + "com.amazonaws.bedrockagent#AgentArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:agent/[0-9a-zA-Z]{10}$" + } + }, + "com.amazonaws.bedrockagent#AgentFlowNodeConfiguration": { + "type": "structure", + "members": { + "agentAliasArn": { + "target": "com.amazonaws.bedrockagent#AgentAliasArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the alias of the agent to invoke.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Defines an agent node in your flow. You specify the agent to invoke at this point in the flow. For more information, see Node types in Amazon Bedrock works in the Amazon Bedrock User Guide.
" + } + }, + "com.amazonaws.bedrockagent#AgentKnowledgeBase": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the agent with which the knowledge base is associated.
", + "smithy.api#required": {} + } + }, + "agentVersion": { + "target": "com.amazonaws.bedrockagent#Version", + "traits": { + "smithy.api#documentation": "The version of the agent with which the knowledge base is associated.
", + "smithy.api#required": {} + } + }, + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the association between the agent and the knowledge base.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "The description of the association between the agent and the knowledge base.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the association between the agent and the knowledge base was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the association between the agent and the knowledge base was last updated.
", + "smithy.api#required": {} + } + }, + "knowledgeBaseState": { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseState", + "traits": { + "smithy.api#documentation": "Specifies whether to use the knowledge base or not when sending an InvokeAgent request.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about a knowledge base that is associated with an agent.
" + } + }, + "com.amazonaws.bedrockagent#AgentKnowledgeBaseSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#AgentKnowledgeBaseSummary" + }, + "traits": { + "smithy.api#length": { + "max": 10 + } + } + }, + "com.amazonaws.bedrockagent#AgentKnowledgeBaseSummary": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the knowledge base associated with an agent.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "The description of the knowledge base associated with an agent.
" + } + }, + "knowledgeBaseState": { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseState", + "traits": { + "smithy.api#documentation": "Specifies whether the agent uses the knowledge base or not when sending an InvokeAgent request.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the knowledge base associated with an agent was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about a knowledge base associated with an agent.
" + } + }, + "com.amazonaws.bedrockagent#AgentResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrockagent#CreateAgent" + }, + { + "target": "com.amazonaws.bedrockagent#DeleteAgent" + }, + { + "target": "com.amazonaws.bedrockagent#GetAgent" + }, + { + "target": "com.amazonaws.bedrockagent#ListAgents" + }, + { + "target": "com.amazonaws.bedrockagent#PrepareAgent" + }, + { + "target": "com.amazonaws.bedrockagent#UpdateAgent" + } + ] + }, + "com.amazonaws.bedrockagent#AgentRoleArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/.+$" + } + }, + "com.amazonaws.bedrockagent#AgentStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "PREPARING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PREPARING" + } + }, + "PREPARED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PREPARED" + } + }, + "NOT_PREPARED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_PREPARED" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "VERSIONING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VERSIONING" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + } + } + }, + "com.amazonaws.bedrockagent#AgentSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#AgentSummary" + }, + "traits": { + "smithy.api#length": { + "max": 10 + } + } + }, + "com.amazonaws.bedrockagent#AgentSummary": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the agent.
", + "smithy.api#required": {} + } + }, + "agentName": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#documentation": "The name of the agent.
", + "smithy.api#required": {} + } + }, + "agentStatus": { + "target": "com.amazonaws.bedrockagent#AgentStatus", + "traits": { + "smithy.api#documentation": "The status of the agent.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "The description of the agent.
" + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the agent was last updated.
", + "smithy.api#required": {} + } + }, + "latestAgentVersion": { + "target": "com.amazonaws.bedrockagent#Version", + "traits": { + "smithy.api#documentation": "The latest version of the agent.
" + } + }, + "guardrailConfiguration": { + "target": "com.amazonaws.bedrockagent#GuardrailConfiguration", + "traits": { + "smithy.api#documentation": "Details about the guardrail associated with the agent.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about an agent.
" + } + }, + "com.amazonaws.bedrockagent#AgentVersion": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the agent that the version belongs to.
", + "smithy.api#required": {} + } + }, + "agentName": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#documentation": "The name of the agent that the version belongs to.
", + "smithy.api#required": {} + } + }, + "agentArn": { + "target": "com.amazonaws.bedrockagent#AgentArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the agent that the version belongs to.
", + "smithy.api#required": {} + } + }, + "version": { + "target": "com.amazonaws.bedrockagent#NumericalVersion", + "traits": { + "smithy.api#documentation": "The version number.
", + "smithy.api#required": {} + } + }, + "instruction": { + "target": "com.amazonaws.bedrockagent#Instruction", + "traits": { + "smithy.api#documentation": "The instructions provided to the agent.
" + } + }, + "agentStatus": { + "target": "com.amazonaws.bedrockagent#AgentStatus", + "traits": { + "smithy.api#documentation": "The status of the agent that the version belongs to.
", + "smithy.api#required": {} + } + }, + "foundationModel": { + "target": "com.amazonaws.bedrockagent#ModelIdentifier", + "traits": { + "smithy.api#documentation": "The foundation model that the version invokes.
" + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "The description of the version.
" + } + }, + "idleSessionTTLInSeconds": { + "target": "com.amazonaws.bedrockagent#SessionTTL", + "traits": { + "smithy.api#documentation": "The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.
\nA user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.
", + "smithy.api#required": {} + } + }, + "agentResourceRoleArn": { + "target": "com.amazonaws.bedrockagent#AgentRoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.
", + "smithy.api#required": {} + } + }, + "customerEncryptionKeyArn": { + "target": "com.amazonaws.bedrockagent#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key that encrypts the agent.
" + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the version was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the version was last updated.
", + "smithy.api#required": {} + } + }, + "failureReasons": { + "target": "com.amazonaws.bedrockagent#FailureReasons", + "traits": { + "smithy.api#documentation": "A list of reasons that the API operation on the version failed.
" + } + }, + "recommendedActions": { + "target": "com.amazonaws.bedrockagent#RecommendedActions", + "traits": { + "smithy.api#documentation": "A list of recommended actions to take for the failed API operation on the version to succeed.
" + } + }, + "promptOverrideConfiguration": { + "target": "com.amazonaws.bedrockagent#PromptOverrideConfiguration", + "traits": { + "smithy.api#documentation": "Contains configurations to override prompt templates in different parts of an agent sequence. For more information, see Advanced prompts.
" + } + }, + "guardrailConfiguration": { + "target": "com.amazonaws.bedrockagent#GuardrailConfiguration", + "traits": { + "smithy.api#documentation": "Details about the guardrail associated with the agent.
" + } + }, + "memoryConfiguration": { + "target": "com.amazonaws.bedrockagent#MemoryConfiguration", + "traits": { + "smithy.api#documentation": "\n Contains details of the memory configuration on the version of the agent. \n
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about a version of an agent.
" + } + }, + "com.amazonaws.bedrockagent#AgentVersionSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#AgentVersionSummary" + }, + "traits": { + "smithy.api#length": { + "max": 10 + } + } + }, + "com.amazonaws.bedrockagent#AgentVersionSummary": { + "type": "structure", + "members": { + "agentName": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#documentation": "The name of the agent to which the version belongs.
", + "smithy.api#required": {} + } + }, + "agentStatus": { + "target": "com.amazonaws.bedrockagent#AgentStatus", + "traits": { + "smithy.api#documentation": "The status of the agent to which the version belongs.
", + "smithy.api#required": {} + } + }, + "agentVersion": { + "target": "com.amazonaws.bedrockagent#Version", + "traits": { + "smithy.api#documentation": "The version of the agent.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the version was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the version was last updated.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "The description of the version of the agent.
" + } + }, + "guardrailConfiguration": { + "target": "com.amazonaws.bedrockagent#GuardrailConfiguration", + "traits": { + "smithy.api#documentation": "Details about the guardrail associated with the agent.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about a version of an agent.
" + } + }, + "com.amazonaws.bedrockagent#AliasResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrockagent#CreateAgentAlias" + }, + { + "target": "com.amazonaws.bedrockagent#DeleteAgentAlias" + }, + { + "target": "com.amazonaws.bedrockagent#GetAgentAlias" + }, + { + "target": "com.amazonaws.bedrockagent#ListAgentAliases" + }, + { + "target": "com.amazonaws.bedrockagent#UpdateAgentAlias" + } + ] + }, + "com.amazonaws.bedrockagent#AmazonBedrockAgentBuildTimeLambda": { + "type": "service", + "version": "2023-06-05", + "resources": [ + { + "target": "com.amazonaws.bedrockagent#ActionGroupResource" + }, + { + "target": "com.amazonaws.bedrockagent#AgentResource" + }, + { + "target": "com.amazonaws.bedrockagent#AliasResource" + }, + { + "target": "com.amazonaws.bedrockagent#DataSourceResource" + }, + { + "target": "com.amazonaws.bedrockagent#FlowResource" + }, + { + "target": "com.amazonaws.bedrockagent#IngestionJobResource" + }, + { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseResource" + }, + { + "target": "com.amazonaws.bedrockagent#PromptResource" + }, + { + "target": "com.amazonaws.bedrockagent#TaggingResource" + }, + { + "target": "com.amazonaws.bedrockagent#VersionResource" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "Bedrock Agent", + "arnNamespace": "bedrock", + "endpointPrefix": "bedrock-agent", + "cloudTrailEventSource": "bedrock.amazonaws.com" + }, + "aws.auth#sigv4": { + "name": "bedrock" + }, + "aws.protocols#restJson1": {}, + "smithy.api#cors": { + "additionalAllowedHeaders": [ + "*", + "content-type", + "x-amz-content-sha256", + "x-amz-user-agent", + "x-amzn-platform-id", + "x-amzn-trace-id" + ], + "additionalExposedHeaders": [ + "x-amzn-errortype", + "x-amzn-requestid", + "x-amzn-trace-id" + ], + "maxAge": 86400 + }, + "smithy.api#documentation": "Describes the API operations for creating and managing Amazon Bedrock agents.
", + "smithy.api#title": "Agents for Amazon Bedrock", + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://bedrock-agent-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://bedrock-agent-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://bedrock-agent.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://bedrock-agent.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ], + "type": "tree" + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent-fips.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } + } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.bedrockagent#AssociateAgentKnowledgeBase": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#AssociateAgentKnowledgeBaseRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#AssociateAgentKnowledgeBaseResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Associates a knowledge base with an agent. If a knowledge base is associated and its indexState is set to Enabled, the agent queries the knowledge base for information to augment its response to the user.
The unique identifier of the agent with which you want to associate the knowledge base.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "agentVersion": { + "target": "com.amazonaws.bedrockagent#DraftVersion", + "traits": { + "smithy.api#documentation": "The version of the agent with which you want to associate the knowledge base.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the knowledge base to associate with the agent.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "A description of what the agent should use the knowledge base for.
", + "smithy.api#required": {} + } + }, + "knowledgeBaseState": { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseState", + "traits": { + "smithy.api#documentation": "Specifies whether to use the knowledge base or not when sending an InvokeAgent request.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#AssociateAgentKnowledgeBaseResponse": { + "type": "structure", + "members": { + "agentKnowledgeBase": { + "target": "com.amazonaws.bedrockagent#AgentKnowledgeBase", + "traits": { + "smithy.api#documentation": "Contains details about the knowledge base that has been associated with the agent.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#BasePromptTemplate": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100000 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagent#BedrockEmbeddingModelArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|([0-9]{12}:provisioned-model/[a-z0-9]{12})))|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|(([0-9a-zA-Z][_-]?)+)$" + } + }, + "com.amazonaws.bedrockagent#BedrockEmbeddingModelConfiguration": { + "type": "structure", + "members": { + "dimensions": { + "target": "com.amazonaws.bedrockagent#Dimensions", + "traits": { + "smithy.api#documentation": "The dimensions details for the vector configuration used on the Bedrock embeddings model.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The vector configuration details for the Bedrock embeddings model.
" + } + }, + "com.amazonaws.bedrockagent#BedrockFoundationModelConfiguration": { + "type": "structure", + "members": { + "modelArn": { + "target": "com.amazonaws.bedrockagent#BedrockModelArn", + "traits": { + "smithy.api#documentation": "The model's ARN.
", + "smithy.api#required": {} + } + }, + "parsingPrompt": { + "target": "com.amazonaws.bedrockagent#ParsingPrompt", + "traits": { + "smithy.api#documentation": "Instructions for interpreting the contents of a document.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Settings for a foundation model used to parse documents for a data source.
" + } + }, + "com.amazonaws.bedrockagent#BedrockModelArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}::foundation-model/([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2})$" + } + }, + "com.amazonaws.bedrockagent#BucketOwnerAccountId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 12, + "max": 12 + }, + "smithy.api#pattern": "^[0-9]{12}$" + } + }, + "com.amazonaws.bedrockagent#ChunkingConfiguration": { + "type": "structure", + "members": { + "chunkingStrategy": { + "target": "com.amazonaws.bedrockagent#ChunkingStrategy", + "traits": { + "smithy.api#documentation": "Knowledge base can split your source data into chunks. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried. You have the following options for chunking your data. If you opt for NONE, then you may want to pre-process your files by splitting them up such that each file corresponds to a chunk.
\n FIXED_SIZE – Amazon Bedrock splits your source data into chunks of the approximate size that you set in the fixedSizeChunkingConfiguration.
\n HIERARCHICAL – Split documents into layers of chunks where the first layer contains large chunks, and the second layer contains smaller chunks derived from the first layer.
\n SEMANTIC – Split documents into chunks based on groups of similar content derived with natural language processing.
\n NONE – Amazon Bedrock treats each file as one chunk. If you choose this option, you may want to pre-process your documents by splitting them into separate files.
Configurations for when you choose fixed-size chunking. If you set the chunkingStrategy as NONE, exclude this field.
Settings for hierarchical document chunking for a data source. Hierarchical chunking splits documents\n into layers of chunks where the first layer contains large chunks, and the second layer contains smaller\n chunks derived from the first layer.
" + } + }, + "semanticChunkingConfiguration": { + "target": "com.amazonaws.bedrockagent#SemanticChunkingConfiguration", + "traits": { + "smithy.api#documentation": "Settings for semantic document chunking for a data source. Semantic chunking splits\n a document into into smaller documents based on groups of similar content derived from the text\n with natural language processing.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details about how to chunk the documents in the data source. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried.
" + } + }, + "com.amazonaws.bedrockagent#ChunkingStrategy": { + "type": "enum", + "members": { + "FIXED_SIZE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FIXED_SIZE" + } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + }, + "HIERARCHICAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HIERARCHICAL" + } + }, + "SEMANTIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SEMANTIC" + } + } + } + }, + "com.amazonaws.bedrockagent#ClientToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 33, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,256}$" + } + }, + "com.amazonaws.bedrockagent#CollectorFlowNodeConfiguration": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "Defines a collector node in your flow. This node takes an iteration of inputs and consolidates them into an array in the output. For more information, see Node types in Amazon Bedrock works in the Amazon Bedrock User Guide.
" + } + }, + "com.amazonaws.bedrockagent#ColumnName": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_\\-]+$" + } + }, + "com.amazonaws.bedrockagent#ConditionFlowNodeConfiguration": { + "type": "structure", + "members": { + "conditions": { + "target": "com.amazonaws.bedrockagent#FlowConditions", + "traits": { + "smithy.api#documentation": "An array of conditions. Each member contains the name of a condition and an expression that defines the condition.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Defines a condition node in your flow. You can specify conditions that determine which node comes next in the flow. For more information, see Node types in Amazon Bedrock works in the Amazon Bedrock User Guide.
" + } + }, + "com.amazonaws.bedrockagent#ConflictException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.bedrockagent#NonBlankString" + } + }, + "traits": { + "smithy.api#documentation": "There was a conflict performing an operation.
", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.bedrockagent#ConfluenceAuthType": { + "type": "enum", + "members": { + "BASIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BASIC" + } + }, + "OAUTH2_CLIENT_CREDENTIALS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OAUTH2_CLIENT_CREDENTIALS" + } + } + } + }, + "com.amazonaws.bedrockagent#ConfluenceCrawlerConfiguration": { + "type": "structure", + "members": { + "filterConfiguration": { + "target": "com.amazonaws.bedrockagent#CrawlFilterConfiguration", + "traits": { + "smithy.api#documentation": "The configuration of filtering the Confluence content. For example, configuring \n regular expression patterns to include or exclude certain content.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration of the Confluence content. For example, configuring specific \n types of Confluence content.
" + } + }, + "com.amazonaws.bedrockagent#ConfluenceDataSourceConfiguration": { + "type": "structure", + "members": { + "sourceConfiguration": { + "target": "com.amazonaws.bedrockagent#ConfluenceSourceConfiguration", + "traits": { + "smithy.api#documentation": "The endpoint information to connect to your Confluence data source.
", + "smithy.api#required": {} + } + }, + "crawlerConfiguration": { + "target": "com.amazonaws.bedrockagent#ConfluenceCrawlerConfiguration", + "traits": { + "smithy.api#documentation": "The configuration of the Confluence content. For example, configuring \n specific types of Confluence content.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration information to connect to Confluence as your data source.
" + } + }, + "com.amazonaws.bedrockagent#ConfluenceHostType": { + "type": "enum", + "members": { + "SAAS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SAAS" + } + } + } + }, + "com.amazonaws.bedrockagent#ConfluenceSourceConfiguration": { + "type": "structure", + "members": { + "hostUrl": { + "target": "com.amazonaws.bedrockagent#HttpsUrl", + "traits": { + "smithy.api#documentation": "The Confluence host URL or instance URL.
", + "smithy.api#required": {} + } + }, + "hostType": { + "target": "com.amazonaws.bedrockagent#ConfluenceHostType", + "traits": { + "smithy.api#documentation": "The supported host type, whether online/cloud or server/on-premises.
", + "smithy.api#required": {} + } + }, + "authType": { + "target": "com.amazonaws.bedrockagent#ConfluenceAuthType", + "traits": { + "smithy.api#documentation": "The supported authentication type to authenticate and connect to your \n Confluence instance.
", + "smithy.api#required": {} + } + }, + "credentialsSecretArn": { + "target": "com.amazonaws.bedrockagent#SecretArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name of an Secrets Manager secret that \n stores your authentication credentials for your Confluence instance URL. \n For more information on the key-value pairs that must be included in \n your secret, depending on your authentication type, see \n Confluence connection configuration.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The endpoint information to connect to your Confluence data source.
" + } + }, + "com.amazonaws.bedrockagent#CrawlFilterConfiguration": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bedrockagent#CrawlFilterConfigurationType", + "traits": { + "smithy.api#documentation": "The type of filtering that you want to apply to certain objects or content of the \n data source. For example, the PATTERN type is regular expression patterns \n you can apply to filter your content.
The configuration of filtering certain objects or content types of the data source.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration of filtering the data source content. For example, \n configuring regular expression patterns to include or exclude certain content.
" + } + }, + "com.amazonaws.bedrockagent#CrawlFilterConfigurationType": { + "type": "enum", + "members": { + "PATTERN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PATTERN" + } + } + } + }, + "com.amazonaws.bedrockagent#CreateAgent": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#CreateAgentRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#CreateAgentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates an agent that orchestrates interactions between foundation models, data sources, software applications, user conversations, and APIs to carry out tasks to help customers.
\nSpecify the following fields for security purposes.
\n\n agentResourceRoleArn – The Amazon Resource Name (ARN) of the role with permissions to invoke API operations on an agent.
(Optional) customerEncryptionKeyArn – The Amazon Resource Name (ARN) of a KMS key to encrypt the creation of the agent.
(Optional) idleSessionTTLinSeconds – Specify the number of seconds for which the agent should maintain session information. After this time expires, the subsequent InvokeAgent request begins a new session.
To enable your agent to retain conversational context across multiple sessions, include a memoryConfiguration object. \n For more information, see Configure memory.
To override the default prompt behavior for agent orchestration and to use advanced prompts, include a promptOverrideConfiguration object. \n For more information, see Advanced prompts.
If your agent fails to be created, the response returns a list of failureReasons alongside a list of recommendedActions for you to troubleshoot.
The agent instructions will not be honored if your agent has only one knowledge base, uses default prompts, has no action group, and user input is disabled.
\nCreates an action group for an agent. An action group represents the actions that an agent can carry out for the customer by defining the APIs that an agent can call and the logic for calling them.
\nTo allow your agent to request the user for additional information when trying to complete a task, \n add an action group with the parentActionGroupSignature field set to AMAZON.UserInput.
To allow your agent to generate, run, and troubleshoot code when trying to complete a task, \n add an action group with the parentActionGroupSignature field set to AMAZON.CodeInterpreter.
You must leave the description, apiSchema, and actionGroupExecutor fields blank for this action group. During orchestration, if your agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an Observation reprompting the user for more information.
The unique identifier of the agent for which to create the action group.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "agentVersion": { + "target": "com.amazonaws.bedrockagent#DraftVersion", + "traits": { + "smithy.api#documentation": "The version of the agent for which to create the action group.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "actionGroupName": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#documentation": "The name to give the action group.
", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagent#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
", + "smithy.api#idempotencyToken": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "A description of the action group.
" + } + }, + "parentActionGroupSignature": { + "target": "com.amazonaws.bedrockagent#ActionGroupSignature", + "traits": { + "smithy.api#documentation": "To allow your agent to request the user for additional information when trying to complete a task, set this field to AMAZON.UserInput. You must leave the description, apiSchema, and actionGroupExecutor fields blank for this action group.
To allow your agent to generate, run, and troubleshoot code when trying to complete a task, set this field to AMAZON.CodeInterpreter. You must leave the description, apiSchema, and actionGroupExecutor fields blank for this action group.
During orchestration, if your agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an Observation reprompting the user for more information.
" + } + }, + "actionGroupExecutor": { + "target": "com.amazonaws.bedrockagent#ActionGroupExecutor", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user.
" + } + }, + "apiSchema": { + "target": "com.amazonaws.bedrockagent#APISchema", + "traits": { + "smithy.api#documentation": "Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see Action group OpenAPI schemas.
" + } + }, + "actionGroupState": { + "target": "com.amazonaws.bedrockagent#ActionGroupState", + "traits": { + "smithy.api#documentation": "Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
" + } + }, + "functionSchema": { + "target": "com.amazonaws.bedrockagent#FunctionSchema", + "traits": { + "smithy.api#documentation": "Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#CreateAgentActionGroupResponse": { + "type": "structure", + "members": { + "agentActionGroup": { + "target": "com.amazonaws.bedrockagent#AgentActionGroup", + "traits": { + "smithy.api#documentation": "Contains details about the action group that was created.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#CreateAgentAlias": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#CreateAgentAliasRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#CreateAgentAliasResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates an alias of an agent that can be used to deploy the agent.
", + "smithy.api#http": { + "code": 202, + "method": "PUT", + "uri": "/agents/{agentId}/agentaliases/" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#CreateAgentAliasRequest": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the agent.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "agentAliasName": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#documentation": "The name of the alias.
", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagent#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
", + "smithy.api#idempotencyToken": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "A description of the alias of the agent.
" + } + }, + "routingConfiguration": { + "target": "com.amazonaws.bedrockagent#AgentAliasRoutingConfiguration", + "traits": { + "smithy.api#documentation": "Contains details about the routing configuration of the alias.
" + } + }, + "tags": { + "target": "com.amazonaws.bedrockagent#TagsMap", + "traits": { + "smithy.api#documentation": "Any tags that you want to attach to the alias of the agent.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#CreateAgentAliasResponse": { + "type": "structure", + "members": { + "agentAlias": { + "target": "com.amazonaws.bedrockagent#AgentAlias", + "traits": { + "smithy.api#documentation": "Contains details about the alias that was created.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#CreateAgentRequest": { + "type": "structure", + "members": { + "agentName": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#documentation": "A name for the agent that you create.
", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagent#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
", + "smithy.api#idempotencyToken": {} + } + }, + "instruction": { + "target": "com.amazonaws.bedrockagent#Instruction", + "traits": { + "smithy.api#documentation": "Instructions that tell the agent what it should do and how it should interact with users.
" + } + }, + "foundationModel": { + "target": "com.amazonaws.bedrockagent#ModelIdentifier", + "traits": { + "smithy.api#documentation": "The foundation model to be used for orchestration by the agent you create.
" + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "A description of the agent.
" + } + }, + "idleSessionTTLInSeconds": { + "target": "com.amazonaws.bedrockagent#SessionTTL", + "traits": { + "smithy.api#documentation": "The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.
\nA user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.
" + } + }, + "agentResourceRoleArn": { + "target": "com.amazonaws.bedrockagent#AgentRoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.
" + } + }, + "customerEncryptionKeyArn": { + "target": "com.amazonaws.bedrockagent#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key with which to encrypt the agent.
" + } + }, + "tags": { + "target": "com.amazonaws.bedrockagent#TagsMap", + "traits": { + "smithy.api#documentation": "Any tags that you want to attach to the agent.
" + } + }, + "promptOverrideConfiguration": { + "target": "com.amazonaws.bedrockagent#PromptOverrideConfiguration", + "traits": { + "smithy.api#documentation": "Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.
" + } + }, + "guardrailConfiguration": { + "target": "com.amazonaws.bedrockagent#GuardrailConfiguration", + "traits": { + "smithy.api#documentation": "The unique Guardrail configuration assigned to the agent when it is created.
" + } + }, + "memoryConfiguration": { + "target": "com.amazonaws.bedrockagent#MemoryConfiguration", + "traits": { + "smithy.api#documentation": "Contains the details of the memory configured for the agent.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#CreateAgentResponse": { + "type": "structure", + "members": { + "agent": { + "target": "com.amazonaws.bedrockagent#Agent", + "traits": { + "smithy.api#documentation": "Contains details about the agent created.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#CreateDataSource": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#CreateDataSourceRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#CreateDataSourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a data source connector for a knowledge base.
\nYou can't change the chunkingConfiguration after you create the data source connector.
The unique identifier of the knowledge base to which to add the data source.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagent#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
", + "smithy.api#idempotencyToken": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#documentation": "The name of the data source.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "A description of the data source.
" + } + }, + "dataSourceConfiguration": { + "target": "com.amazonaws.bedrockagent#DataSourceConfiguration", + "traits": { + "smithy.api#documentation": "The connection configuration for the data source.
", + "smithy.api#required": {} + } + }, + "dataDeletionPolicy": { + "target": "com.amazonaws.bedrockagent#DataDeletionPolicy", + "traits": { + "smithy.api#documentation": "The data deletion policy for the data source.
\nYou can set the data deletion policy to:
\nDELETE: Deletes all data from your data source that’s converted \n into vector embeddings upon deletion of a knowledge base or data source resource. \n Note that the vector store itself is not deleted, \n only the data. This flag is ignored if an Amazon Web Services account is deleted.
\nRETAIN: Retains all data from your data source that’s converted \n into vector embeddings upon deletion of a knowledge base or data source resource. \n Note that the vector store itself is not deleted \n if you delete a knowledge base or data source resource.
\nContains details about the server-side encryption for the data source.
" + } + }, + "vectorIngestionConfiguration": { + "target": "com.amazonaws.bedrockagent#VectorIngestionConfiguration", + "traits": { + "smithy.api#documentation": "Contains details about how to ingest the documents in the data source.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#CreateDataSourceResponse": { + "type": "structure", + "members": { + "dataSource": { + "target": "com.amazonaws.bedrockagent#DataSource", + "traits": { + "smithy.api#documentation": "Contains details about the data source.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#CreateFlow": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#CreateFlowRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#CreateFlowResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a prompt flow that you can use to send an input through various steps to yield an output. Configure nodes, each of which corresponds to a step of the flow, and create connections between the nodes to create paths to different outputs. For more information, see How it works and Create a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
", + "smithy.api#http": { + "code": 201, + "method": "POST", + "uri": "/flows/" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#CreateFlowAlias": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#CreateFlowAliasRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#CreateFlowAliasResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates an alias of a flow for deployment. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
", + "smithy.api#http": { + "code": 201, + "method": "POST", + "uri": "/flows/{flowIdentifier}/aliases" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#CreateFlowAliasRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#documentation": "A name for the alias.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "A description for the alias.
" + } + }, + "routingConfiguration": { + "target": "com.amazonaws.bedrockagent#FlowAliasRoutingConfiguration", + "traits": { + "smithy.api#documentation": "Contains information about the version to which to map the alias.
", + "smithy.api#required": {} + } + }, + "flowIdentifier": { + "target": "com.amazonaws.bedrockagent#FlowIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the flow for which to create an alias.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagent#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
", + "smithy.api#idempotencyToken": {} + } + }, + "tags": { + "target": "com.amazonaws.bedrockagent#TagsMap", + "traits": { + "aws.cloudformation#cfnMutability": "full", + "smithy.api#documentation": "Any tags that you want to attach to the alias of the flow. For more information, see Tagging resources in Amazon Bedrock.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#CreateFlowAliasResponse": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#documentation": "The name of the alias.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "The description of the alias.
" + } + }, + "routingConfiguration": { + "target": "com.amazonaws.bedrockagent#FlowAliasRoutingConfiguration", + "traits": { + "smithy.api#documentation": "Contains information about the version that the alias is mapped to.
", + "smithy.api#required": {} + } + }, + "flowId": { + "target": "com.amazonaws.bedrockagent#FlowId", + "traits": { + "smithy.api#documentation": "The unique identifier of the flow that the alias belongs to.
", + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.bedrockagent#FlowAliasId", + "traits": { + "smithy.api#documentation": "The unique identifier of the alias.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.bedrockagent#FlowAliasArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the alias.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the alias was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the alias of the flow was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#CreateFlowRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagent#FlowName", + "traits": { + "smithy.api#documentation": "A name for the flow.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#FlowDescription", + "traits": { + "smithy.api#documentation": "A description for the flow.
" + } + }, + "executionRoleArn": { + "target": "com.amazonaws.bedrockagent#FlowExecutionRoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the service role with permissions to create and manage a flow. For more information, see Create a service role for flows in Amazon Bedrock in the Amazon Bedrock User Guide.
", + "smithy.api#required": {} + } + }, + "customerEncryptionKeyArn": { + "target": "com.amazonaws.bedrockagent#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key to encrypt the flow.
" + } + }, + "definition": { + "target": "com.amazonaws.bedrockagent#FlowDefinition", + "traits": { + "smithy.api#documentation": "A definition of the nodes and connections between nodes in the flow.
" + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagent#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
", + "smithy.api#idempotencyToken": {} + } + }, + "tags": { + "target": "com.amazonaws.bedrockagent#TagsMap", + "traits": { + "aws.cloudformation#cfnMutability": "full", + "smithy.api#documentation": "Any tags that you want to attach to the flow. For more information, see Tagging resources in Amazon Bedrock.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#CreateFlowResponse": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagent#FlowName", + "traits": { + "smithy.api#documentation": "The name of the flow.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#FlowDescription", + "traits": { + "smithy.api#documentation": "The description of the flow.
" + } + }, + "executionRoleArn": { + "target": "com.amazonaws.bedrockagent#FlowExecutionRoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the service role with permissions to create a flow. For more information, see Create a service role for flows in Amazon Bedrock in the Amazon Bedrock User Guide.
", + "smithy.api#required": {} + } + }, + "customerEncryptionKeyArn": { + "target": "com.amazonaws.bedrockagent#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key that you encrypted the flow with.
" + } + }, + "id": { + "target": "com.amazonaws.bedrockagent#FlowId", + "traits": { + "smithy.api#documentation": "The unique identifier of the flow.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.bedrockagent#FlowArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the flow.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagent#FlowStatus", + "traits": { + "smithy.api#documentation": "The status of the flow. When you submit this request, the status will be NotPrepared. If creation fails, the status becomes Failed.
The time at which the flow was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the flow was last updated.
", + "smithy.api#required": {} + } + }, + "version": { + "target": "com.amazonaws.bedrockagent#DraftVersion", + "traits": { + "smithy.api#documentation": "The version of the flow. When you create a flow, the version created is the DRAFT version.
A definition of the nodes and connections between nodes in the flow.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#CreateFlowVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#CreateFlowVersionRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#CreateFlowVersionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a version of the flow that you can deploy. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
", + "smithy.api#http": { + "code": 201, + "method": "POST", + "uri": "/flows/{flowIdentifier}/versions" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#CreateFlowVersionRequest": { + "type": "structure", + "members": { + "flowIdentifier": { + "target": "com.amazonaws.bedrockagent#FlowIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the flow that you want to create a version of.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#FlowDescription", + "traits": { + "smithy.api#documentation": "A description of the version of the flow.
" + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagent#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#CreateFlowVersionResponse": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagent#FlowName", + "traits": { + "smithy.api#documentation": "The name of the version.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#FlowDescription", + "traits": { + "smithy.api#documentation": "The description of the version.
" + } + }, + "executionRoleArn": { + "target": "com.amazonaws.bedrockagent#FlowExecutionRoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the service role with permissions to create a flow. For more information, see Create a service role for flows in Amazon Bedrock in the Amazon Bedrock User Guide.
", + "smithy.api#required": {} + } + }, + "customerEncryptionKeyArn": { + "target": "com.amazonaws.bedrockagent#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The KMS key that the flow is encrypted with.
" + } + }, + "id": { + "target": "com.amazonaws.bedrockagent#FlowId", + "traits": { + "smithy.api#documentation": "The unique identifier of the flow.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.bedrockagent#FlowArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the flow.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagent#FlowStatus", + "traits": { + "smithy.api#documentation": "The status of the flow.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the flow was created.
", + "smithy.api#required": {} + } + }, + "version": { + "target": "com.amazonaws.bedrockagent#NumericalVersion", + "traits": { + "smithy.api#documentation": "The version of the flow that was created. Versions are numbered incrementally, starting from 1.
", + "smithy.api#required": {} + } + }, + "definition": { + "target": "com.amazonaws.bedrockagent#FlowDefinition", + "traits": { + "smithy.api#documentation": "A definition of the nodes and connections in the flow.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#CreateKnowledgeBase": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#CreateKnowledgeBaseRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#CreateKnowledgeBaseResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a knowledge base that contains data sources from which information can be queried and used by LLMs. To create a knowledge base, you must first set up your data sources and configure a supported vector store. For more information, see Set up your data for ingestion.
\nIf you prefer to let Amazon Bedrock create and manage a vector store for you in Amazon OpenSearch Service, use the console. For more information, see Create a knowledge base.
\nProvide the name and an optional description.
Provide the Amazon Resource Name (ARN) with permissions to create a knowledge base in the roleArn field.
Provide the embedding model to use in the embeddingModelArn field in the knowledgeBaseConfiguration object.
Provide the configuration for your vector store in the storageConfiguration object.
For an Amazon OpenSearch Service database, use the opensearchServerlessConfiguration object. For more information, see Create a vector store in Amazon OpenSearch Service.
For an Amazon Aurora database, use the RdsConfiguration object. For more information, see Create a vector store in Amazon Aurora.
For a Pinecone database, use the pineconeConfiguration object. For more information, see Create a vector store in Pinecone.
For a Redis Enterprise Cloud database, use the redisEnterpriseCloudConfiguration object. For more information, see Create a vector store in Redis Enterprise Cloud.
A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
", + "smithy.api#idempotencyToken": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#documentation": "A name for the knowledge base.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "A description of the knowledge base.
" + } + }, + "roleArn": { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseRoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.
", + "smithy.api#required": {} + } + }, + "knowledgeBaseConfiguration": { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseConfiguration", + "traits": { + "smithy.api#documentation": "Contains details about the embeddings model used for the knowledge base.
", + "smithy.api#required": {} + } + }, + "storageConfiguration": { + "target": "com.amazonaws.bedrockagent#StorageConfiguration", + "traits": { + "smithy.api#documentation": "Contains details about the configuration of the vector database used for the knowledge base.
", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.bedrockagent#TagsMap", + "traits": { + "smithy.api#documentation": "Specify the key-value pairs for the tags that you want to attach to your knowledge base in this object.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#CreateKnowledgeBaseResponse": { + "type": "structure", + "members": { + "knowledgeBase": { + "target": "com.amazonaws.bedrockagent#KnowledgeBase", + "traits": { + "smithy.api#documentation": "Contains details about the knowledge base.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#CreatePrompt": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#CreatePromptRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#CreatePromptResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a prompt in your prompt library that you can add to a flow. For more information, see Prompt management in Amazon Bedrock, Create a prompt using Prompt management and Prompt flows in Amazon Bedrock in the Amazon Bedrock User Guide.
", + "smithy.api#http": { + "code": 201, + "method": "POST", + "uri": "/prompts/" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#CreatePromptRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagent#PromptName", + "traits": { + "smithy.api#documentation": "A name for the prompt.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#PromptDescription", + "traits": { + "smithy.api#documentation": "A description for the prompt.
" + } + }, + "customerEncryptionKeyArn": { + "target": "com.amazonaws.bedrockagent#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key to encrypt the prompt.
" + } + }, + "defaultVariant": { + "target": "com.amazonaws.bedrockagent#PromptVariantName", + "traits": { + "smithy.api#documentation": "The name of the default variant for the prompt. This value must match the name field in the relevant PromptVariant object.
A list of objects, each containing details about a variant of the prompt.
" + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagent#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
", + "smithy.api#idempotencyToken": {} + } + }, + "tags": { + "target": "com.amazonaws.bedrockagent#TagsMap", + "traits": { + "aws.cloudformation#cfnMutability": "full", + "smithy.api#documentation": "Any tags that you want to attach to the prompt. For more information, see Tagging resources in Amazon Bedrock.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#CreatePromptResponse": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagent#PromptName", + "traits": { + "smithy.api#documentation": "The name of the prompt.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#PromptDescription", + "traits": { + "smithy.api#documentation": "The description of the prompt.
" + } + }, + "customerEncryptionKeyArn": { + "target": "com.amazonaws.bedrockagent#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key that you encrypted the prompt with.
" + } + }, + "defaultVariant": { + "target": "com.amazonaws.bedrockagent#PromptVariantName", + "traits": { + "smithy.api#documentation": "The name of the default variant for your prompt.
" + } + }, + "variants": { + "target": "com.amazonaws.bedrockagent#PromptVariantList", + "traits": { + "smithy.api#documentation": "A list of objects, each containing details about a variant of the prompt.
" + } + }, + "id": { + "target": "com.amazonaws.bedrockagent#PromptId", + "traits": { + "smithy.api#documentation": "The unique identifier of the prompt.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.bedrockagent#PromptArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the prompt.
", + "smithy.api#required": {} + } + }, + "version": { + "target": "com.amazonaws.bedrockagent#Version", + "traits": { + "smithy.api#documentation": "The version of the prompt. When you create a prompt, the version created is the DRAFT version.
The time at which the prompt was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the prompt was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#CreatePromptVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#CreatePromptVersionRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#CreatePromptVersionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a static snapshot of your prompt that can be deployed to production. For more information, see Deploy prompts using Prompt management by creating versions in the Amazon Bedrock User Guide.
", + "smithy.api#http": { + "code": 201, + "method": "POST", + "uri": "/prompts/{promptIdentifier}/versions" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#CreatePromptVersionRequest": { + "type": "structure", + "members": { + "promptIdentifier": { + "target": "com.amazonaws.bedrockagent#PromptIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the prompt that you want to create a version of.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#PromptDescription", + "traits": { + "smithy.api#documentation": "A description for the version of the prompt.
" + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagent#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
", + "smithy.api#idempotencyToken": {} + } + }, + "tags": { + "target": "com.amazonaws.bedrockagent#TagsMap", + "traits": { + "aws.cloudformation#cfnMutability": "full", + "smithy.api#documentation": "Any tags that you want to attach to the version of the prompt. For more information, see Tagging resources in Amazon Bedrock.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#CreatePromptVersionResponse": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagent#PromptName", + "traits": { + "smithy.api#documentation": "The name of the prompt.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#PromptDescription", + "traits": { + "smithy.api#documentation": "A description for the version.
" + } + }, + "customerEncryptionKeyArn": { + "target": "com.amazonaws.bedrockagent#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key to encrypt the version of the prompt.
" + } + }, + "defaultVariant": { + "target": "com.amazonaws.bedrockagent#PromptVariantName", + "traits": { + "smithy.api#documentation": "The name of the default variant for the prompt. This value must match the name field in the relevant PromptVariant object.
A list of objects, each containing details about a variant of the prompt.
" + } + }, + "id": { + "target": "com.amazonaws.bedrockagent#PromptId", + "traits": { + "smithy.api#documentation": "The unique identifier of the prompt.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.bedrockagent#PromptArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the version of the prompt.
", + "smithy.api#required": {} + } + }, + "version": { + "target": "com.amazonaws.bedrockagent#Version", + "traits": { + "smithy.api#documentation": "The version of the prompt that was created. Versions are numbered incrementally, starting from 1.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the prompt was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the prompt was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#CreationMode": { + "type": "enum", + "members": { + "DEFAULT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEFAULT" + } + }, + "OVERRIDDEN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OVERRIDDEN" + } + } + } + }, + "com.amazonaws.bedrockagent#CustomControlMethod": { + "type": "enum", + "members": { + "RETURN_CONTROL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RETURN_CONTROL" + } + } + } + }, + "com.amazonaws.bedrockagent#CustomTransformationConfiguration": { + "type": "structure", + "members": { + "intermediateStorage": { + "target": "com.amazonaws.bedrockagent#IntermediateStorage", + "traits": { + "smithy.api#documentation": "An S3 bucket path for input and output objects.
", + "smithy.api#required": {} + } + }, + "transformations": { + "target": "com.amazonaws.bedrockagent#Transformations", + "traits": { + "smithy.api#documentation": "A Lambda function that processes documents.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Settings for customizing steps in the data source content ingestion pipeline.
\nYou can configure the data source to process documents with a Lambda function after\n they are parsed and converted into chunks. When you add a post-chunking transformation,\n the service stores chunked documents in an S3 bucket and invokes a Lambda function to process\n them.
\nTo process chunked documents with a Lambda function, define an S3 bucket path for input\n and output objects, and a transformation that specifies the Lambda function to invoke. You can\n use the Lambda function to customize how chunks are split, and the metadata for each chunk.\n
" + } + }, + "com.amazonaws.bedrockagent#DataDeletionPolicy": { + "type": "enum", + "members": { + "RETAIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RETAIN" + } + }, + "DELETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE" + } + } + } + }, + "com.amazonaws.bedrockagent#DataSource": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the knowledge base to which the data source belongs.
", + "smithy.api#required": {} + } + }, + "dataSourceId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the data source.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#documentation": "The name of the data source.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagent#DataSourceStatus", + "traits": { + "smithy.api#documentation": "The status of the data source. The following statuses are possible:
\nAvailable – The data source has been created and is ready for ingestion into the knowledge base.
\nDeleting – The data source is being deleted.
\nThe description of the data source.
" + } + }, + "dataSourceConfiguration": { + "target": "com.amazonaws.bedrockagent#DataSourceConfiguration", + "traits": { + "smithy.api#documentation": "The connection configuration for the data source.
", + "smithy.api#required": {} + } + }, + "serverSideEncryptionConfiguration": { + "target": "com.amazonaws.bedrockagent#ServerSideEncryptionConfiguration", + "traits": { + "smithy.api#documentation": "Contains details about the configuration of the server-side encryption.
" + } + }, + "vectorIngestionConfiguration": { + "target": "com.amazonaws.bedrockagent#VectorIngestionConfiguration", + "traits": { + "smithy.api#documentation": "Contains details about how to ingest the documents in the data source.
" + } + }, + "dataDeletionPolicy": { + "target": "com.amazonaws.bedrockagent#DataDeletionPolicy", + "traits": { + "smithy.api#documentation": "The data deletion policy for the data source.
" + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the data source was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the data source was last updated.
", + "smithy.api#required": {} + } + }, + "failureReasons": { + "target": "com.amazonaws.bedrockagent#FailureReasons", + "traits": { + "smithy.api#documentation": "The detailed reasons on the failure to delete a data source.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about a data source.
" + } + }, + "com.amazonaws.bedrockagent#DataSourceConfiguration": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bedrockagent#DataSourceType", + "traits": { + "smithy.api#documentation": "The type of data source.
", + "smithy.api#required": {} + } + }, + "s3Configuration": { + "target": "com.amazonaws.bedrockagent#S3DataSourceConfiguration", + "traits": { + "smithy.api#documentation": "The configuration information to connect to Amazon S3 as your data source.
" + } + }, + "webConfiguration": { + "target": "com.amazonaws.bedrockagent#WebDataSourceConfiguration", + "traits": { + "smithy.api#documentation": "The configuration of web URLs to crawl for your data source. \n You should be authorized to crawl the URLs.
\nCrawling web URLs as your data source is in preview release \n and is subject to change.
\nThe configuration information to connect to Confluence as your data source.
\nConfluence data source connector is in preview release and is subject to change.
\nThe configuration information to connect to Salesforce as your data source.
\nSalesforce data source connector is in preview release and is subject to change.
\nThe configuration information to connect to SharePoint as your data source.
\nSharePoint data source connector is in preview release and is subject to change.
\nThe connection configuration for the data source.
" + } + }, + "com.amazonaws.bedrockagent#DataSourceResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrockagent#CreateDataSource" + }, + { + "target": "com.amazonaws.bedrockagent#DeleteDataSource" + }, + { + "target": "com.amazonaws.bedrockagent#GetDataSource" + }, + { + "target": "com.amazonaws.bedrockagent#ListDataSources" + }, + { + "target": "com.amazonaws.bedrockagent#UpdateDataSource" + } + ] + }, + "com.amazonaws.bedrockagent#DataSourceStatus": { + "type": "enum", + "members": { + "AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "DELETE_UNSUCCESSFUL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_UNSUCCESSFUL" + } + } + } + }, + "com.amazonaws.bedrockagent#DataSourceSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#DataSourceSummary" + } + }, + "com.amazonaws.bedrockagent#DataSourceSummary": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the knowledge base to which the data source belongs.
", + "smithy.api#required": {} + } + }, + "dataSourceId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the data source.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#documentation": "The name of the data source.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagent#DataSourceStatus", + "traits": { + "smithy.api#documentation": "The status of the data source.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "The description of the data source.
" + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the data source was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about a data source.
" + } + }, + "com.amazonaws.bedrockagent#DataSourceType": { + "type": "enum", + "members": { + "S3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "S3" + } + }, + "WEB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WEB" + } + }, + "CONFLUENCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONFLUENCE" + } + }, + "SALESFORCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SALESFORCE" + } + }, + "SHAREPOINT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SHAREPOINT" + } + } + } + }, + "com.amazonaws.bedrockagent#DateTimestamp": { + "type": "timestamp", + "traits": { + "smithy.api#timestampFormat": "date-time" + } + }, + "com.amazonaws.bedrockagent#DeleteAgent": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#DeleteAgentRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#DeleteAgentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes an agent.
", + "smithy.api#http": { + "code": 202, + "method": "DELETE", + "uri": "/agents/{agentId}/" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#DeleteAgentActionGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#DeleteAgentActionGroupRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#DeleteAgentActionGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes an action group in an agent.
", + "smithy.api#http": { + "code": 204, + "method": "DELETE", + "uri": "/agents/{agentId}/agentversions/{agentVersion}/actiongroups/{actionGroupId}/" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#DeleteAgentActionGroupRequest": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the agent that the action group belongs to.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "agentVersion": { + "target": "com.amazonaws.bedrockagent#DraftVersion", + "traits": { + "smithy.api#documentation": "The version of the agent that the action group belongs to.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "actionGroupId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the action group to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "skipResourceInUseCheck": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "By default, this value is false and deletion is stopped if the resource is in use. If you set it to true, the resource will be deleted even if the resource is in use.
Deletes an alias of an agent.
", + "smithy.api#http": { + "code": 202, + "method": "DELETE", + "uri": "/agents/{agentId}/agentaliases/{agentAliasId}/" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#DeleteAgentAliasRequest": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the agent that the alias belongs to.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "agentAliasId": { + "target": "com.amazonaws.bedrockagent#AgentAliasId", + "traits": { + "smithy.api#documentation": "The unique identifier of the alias to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#DeleteAgentAliasResponse": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the agent that the alias belongs to.
", + "smithy.api#required": {} + } + }, + "agentAliasId": { + "target": "com.amazonaws.bedrockagent#AgentAliasId", + "traits": { + "smithy.api#documentation": "The unique identifier of the alias that was deleted.
", + "smithy.api#required": {} + } + }, + "agentAliasStatus": { + "target": "com.amazonaws.bedrockagent#AgentAliasStatus", + "traits": { + "smithy.api#documentation": "The status of the alias.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#DeleteAgentRequest": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the agent to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "skipResourceInUseCheck": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "By default, this value is false and deletion is stopped if the resource is in use. If you set it to true, the resource will be deleted even if the resource is in use.
The unique identifier of the agent that was deleted.
", + "smithy.api#required": {} + } + }, + "agentStatus": { + "target": "com.amazonaws.bedrockagent#AgentStatus", + "traits": { + "smithy.api#documentation": "The status of the agent.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#DeleteAgentVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#DeleteAgentVersionRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#DeleteAgentVersionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a version of an agent.
", + "smithy.api#http": { + "code": 202, + "method": "DELETE", + "uri": "/agents/{agentId}/agentversions/{agentVersion}/" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#DeleteAgentVersionRequest": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the agent that the version belongs to.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "agentVersion": { + "target": "com.amazonaws.bedrockagent#NumericalVersion", + "traits": { + "smithy.api#documentation": "The version of the agent to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "skipResourceInUseCheck": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "By default, this value is false and deletion is stopped if the resource is in use. If you set it to true, the resource will be deleted even if the resource is in use.
The unique identifier of the agent that the version belongs to.
", + "smithy.api#required": {} + } + }, + "agentVersion": { + "target": "com.amazonaws.bedrockagent#NumericalVersion", + "traits": { + "smithy.api#documentation": "The version that was deleted.
", + "smithy.api#required": {} + } + }, + "agentStatus": { + "target": "com.amazonaws.bedrockagent#AgentStatus", + "traits": { + "smithy.api#documentation": "The status of the agent version.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#DeleteDataSource": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#DeleteDataSourceRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#DeleteDataSourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a data source from a knowledge base.
", + "smithy.api#http": { + "code": 202, + "method": "DELETE", + "uri": "/knowledgebases/{knowledgeBaseId}/datasources/{dataSourceId}" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#DeleteDataSourceRequest": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the knowledge base from which to delete the data source.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "dataSourceId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the data source to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#DeleteDataSourceResponse": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the knowledge base to which the data source that was deleted belonged.
", + "smithy.api#required": {} + } + }, + "dataSourceId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the data source that was deleted.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagent#DataSourceStatus", + "traits": { + "smithy.api#documentation": "The status of the data source.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#DeleteFlow": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#DeleteFlowRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#DeleteFlowResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a flow.
", + "smithy.api#http": { + "code": 200, + "method": "DELETE", + "uri": "/flows/{flowIdentifier}/" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#DeleteFlowAlias": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#DeleteFlowAliasRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#DeleteFlowAliasResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes an alias of a flow.
", + "smithy.api#http": { + "code": 200, + "method": "DELETE", + "uri": "/flows/{flowIdentifier}/aliases/{aliasIdentifier}" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#DeleteFlowAliasRequest": { + "type": "structure", + "members": { + "flowIdentifier": { + "target": "com.amazonaws.bedrockagent#FlowIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the flow that the alias belongs to.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "aliasIdentifier": { + "target": "com.amazonaws.bedrockagent#FlowAliasIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the alias to be deleted.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#DeleteFlowAliasResponse": { + "type": "structure", + "members": { + "flowId": { + "target": "com.amazonaws.bedrockagent#FlowId", + "traits": { + "smithy.api#documentation": "The unique identifier of the flow that the alias belongs to.
", + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.bedrockagent#FlowAliasId", + "traits": { + "smithy.api#documentation": "The unique identifier of the flow.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#DeleteFlowRequest": { + "type": "structure", + "members": { + "flowIdentifier": { + "target": "com.amazonaws.bedrockagent#FlowIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the flow.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "skipResourceInUseCheck": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "By default, this value is false and deletion is stopped if the resource is in use. If you set it to true, the resource will be deleted even if the resource is in use.
The unique identifier of the flow.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#DeleteFlowVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#DeleteFlowVersionRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#DeleteFlowVersionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a version of a flow.
", + "smithy.api#http": { + "code": 200, + "method": "DELETE", + "uri": "/flows/{flowIdentifier}/versions/{flowVersion}/" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#DeleteFlowVersionRequest": { + "type": "structure", + "members": { + "flowIdentifier": { + "target": "com.amazonaws.bedrockagent#FlowIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the flow whose version that you want to delete
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "flowVersion": { + "target": "com.amazonaws.bedrockagent#NumericalVersion", + "traits": { + "smithy.api#documentation": "The version of the flow that you want to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "skipResourceInUseCheck": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "By default, this value is false and deletion is stopped if the resource is in use. If you set it to true, the resource will be deleted even if the resource is in use.
The unique identifier of the flow.
", + "smithy.api#required": {} + } + }, + "version": { + "target": "com.amazonaws.bedrockagent#NumericalVersion", + "traits": { + "smithy.api#documentation": "The version of the flow being deleted.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#DeleteKnowledgeBase": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#DeleteKnowledgeBaseRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#DeleteKnowledgeBaseResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a knowledge base. Before deleting a knowledge base, you should disassociate the knowledge base from any agents that it is associated with by making a DisassociateAgentKnowledgeBase request.
", + "smithy.api#http": { + "code": 202, + "method": "DELETE", + "uri": "/knowledgebases/{knowledgeBaseId}" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#DeleteKnowledgeBaseRequest": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the knowledge base to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#DeleteKnowledgeBaseResponse": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the knowledge base that was deleted.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseStatus", + "traits": { + "smithy.api#documentation": "The status of the knowledge base and whether it has been successfully deleted.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#DeletePrompt": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#DeletePromptRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#DeletePromptResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a prompt or a version of it, depending on whether you include the promptVersion field or not. For more information, see Delete prompts from the Prompt management tool and Delete a version of a prompt from the Prompt management tool in the Amazon Bedrock User Guide.
The unique identifier of the prompt.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "promptVersion": { + "target": "com.amazonaws.bedrockagent#NumericalVersion", + "traits": { + "smithy.api#documentation": "The version of the prompt to delete. To delete the prompt, omit this field.
", + "smithy.api#httpQuery": "promptVersion" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#DeletePromptResponse": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.bedrockagent#PromptId", + "traits": { + "smithy.api#documentation": "The unique identifier of the prompt that was deleted.
", + "smithy.api#required": {} + } + }, + "version": { + "target": "com.amazonaws.bedrockagent#NumericalVersion", + "traits": { + "smithy.api#documentation": "The version of the prompt that was deleted.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#Description": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + } + } + }, + "com.amazonaws.bedrockagent#Dimensions": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 4096 + } + } + }, + "com.amazonaws.bedrockagent#DisassociateAgentKnowledgeBase": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#DisassociateAgentKnowledgeBaseRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#DisassociateAgentKnowledgeBaseResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Disassociates a knowledge base from an agent.
", + "smithy.api#http": { + "code": 204, + "method": "DELETE", + "uri": "/agents/{agentId}/agentversions/{agentVersion}/knowledgebases/{knowledgeBaseId}/" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#DisassociateAgentKnowledgeBaseRequest": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the agent from which to disassociate the knowledge base.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "agentVersion": { + "target": "com.amazonaws.bedrockagent#DraftVersion", + "traits": { + "smithy.api#documentation": "The version of the agent from which to disassociate the knowledge base.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the knowledge base to disassociate.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#DisassociateAgentKnowledgeBaseResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#DraftVersion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 5, + "max": 5 + }, + "smithy.api#pattern": "^DRAFT$" + } + }, + "com.amazonaws.bedrockagent#EmbeddingModelConfiguration": { + "type": "structure", + "members": { + "bedrockEmbeddingModelConfiguration": { + "target": "com.amazonaws.bedrockagent#BedrockEmbeddingModelConfiguration", + "traits": { + "smithy.api#documentation": "The vector configuration details on the Bedrock embeddings model.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration details for the embeddings model.
" + } + }, + "com.amazonaws.bedrockagent#EnabledMemoryTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#MemoryType" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.bedrockagent#FailureReason": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + } + } + }, + "com.amazonaws.bedrockagent#FailureReasons": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#FailureReason" + }, + "traits": { + "smithy.api#length": { + "max": 2048 + } + } + }, + "com.amazonaws.bedrockagent#FieldName": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^.*$" + } + }, + "com.amazonaws.bedrockagent#FilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#FilterPattern" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 25 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagent#FilterPattern": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1000 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagent#FilteredObjectType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagent#FixedSizeChunkingConfiguration": { + "type": "structure", + "members": { + "maxTokens": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The maximum number of tokens to include in a chunk.
", + "smithy.api#range": { + "min": 1 + }, + "smithy.api#required": {} + } + }, + "overlapPercentage": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The percentage of overlap between adjacent chunks of a data source.
", + "smithy.api#range": { + "min": 1, + "max": 99 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Configurations for when you choose fixed-size chunking. If you set the chunkingStrategy as NONE, exclude this field.
The version that the alias maps to.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about a version that the alias maps to.
" + } + }, + "com.amazonaws.bedrockagent#FlowAliasSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#FlowAliasSummary" + }, + "traits": { + "smithy.api#length": { + "max": 10 + } + } + }, + "com.amazonaws.bedrockagent#FlowAliasSummary": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#documentation": "The name of the alias.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "A description of the alias.
" + } + }, + "routingConfiguration": { + "target": "com.amazonaws.bedrockagent#FlowAliasRoutingConfiguration", + "traits": { + "smithy.api#documentation": "A list of configurations about the versions that the alias maps to. Currently, you can only specify one.
", + "smithy.api#required": {} + } + }, + "flowId": { + "target": "com.amazonaws.bedrockagent#FlowId", + "traits": { + "smithy.api#documentation": "The unique identifier of the flow.
", + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.bedrockagent#FlowAliasId", + "traits": { + "smithy.api#documentation": "The unique identifier of the alias of the flow.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.bedrockagent#FlowAliasArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the alias.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the alias was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the alias was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about an alias of a flow.
\nThis data type is used in the following API operations:
\nA name for the condition that you can reference.
", + "smithy.api#required": {} + } + }, + "expression": { + "target": "com.amazonaws.bedrockagent#FlowConditionExpression", + "traits": { + "smithy.api#documentation": "Defines the condition. You must refer to at least one of the inputs in the condition. For more information, expand the Condition node section in Node types in prompt flows.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Defines a condition in the condition node.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagent#FlowConditionExpression": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagent#FlowConditionName": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}$" + } + }, + "com.amazonaws.bedrockagent#FlowConditionalConnectionConfiguration": { + "type": "structure", + "members": { + "condition": { + "target": "com.amazonaws.bedrockagent#FlowConditionName", + "traits": { + "smithy.api#documentation": "The condition that triggers this connection. For more information about how to write conditions, see the Condition node type in the Node types topic in the Amazon Bedrock User Guide.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration of a connection between a condition node and another node.
" + } + }, + "com.amazonaws.bedrockagent#FlowConditions": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#FlowCondition" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagent#FlowConnection": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bedrockagent#FlowConnectionType", + "traits": { + "smithy.api#documentation": "Whether the source node that the connection begins from is a condition node (Conditional) or not (Data).
A name for the connection that you can reference.
", + "smithy.api#required": {} + } + }, + "source": { + "target": "com.amazonaws.bedrockagent#FlowNodeName", + "traits": { + "smithy.api#documentation": "The node that the connection starts at.
", + "smithy.api#required": {} + } + }, + "target": { + "target": "com.amazonaws.bedrockagent#FlowNodeName", + "traits": { + "smithy.api#documentation": "The node that the connection ends at.
", + "smithy.api#required": {} + } + }, + "configuration": { + "target": "com.amazonaws.bedrockagent#FlowConnectionConfiguration", + "traits": { + "smithy.api#documentation": "The configuration of the connection.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about a connection between two nodes in the flow.
" + } + }, + "com.amazonaws.bedrockagent#FlowConnectionConfiguration": { + "type": "union", + "members": { + "data": { + "target": "com.amazonaws.bedrockagent#FlowDataConnectionConfiguration", + "traits": { + "smithy.api#documentation": "The configuration of a connection originating from a node that isn't a Condition node.
" + } + }, + "conditional": { + "target": "com.amazonaws.bedrockagent#FlowConditionalConnectionConfiguration", + "traits": { + "smithy.api#documentation": "The configuration of a connection originating from a Condition node.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration of the connection.
" + } + }, + "com.amazonaws.bedrockagent#FlowConnectionName": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z]([_]?[0-9a-zA-Z]){1,100}$" + } + }, + "com.amazonaws.bedrockagent#FlowConnectionType": { + "type": "enum", + "members": { + "DATA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Data" + } + }, + "CONDITIONAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Conditional" + } + } + } + }, + "com.amazonaws.bedrockagent#FlowConnections": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#FlowConnection" + }, + "traits": { + "smithy.api#length": { + "max": 20 + } + } + }, + "com.amazonaws.bedrockagent#FlowDataConnectionConfiguration": { + "type": "structure", + "members": { + "sourceOutput": { + "target": "com.amazonaws.bedrockagent#FlowNodeOutputName", + "traits": { + "smithy.api#documentation": "The name of the output in the source node that the connection begins from.
", + "smithy.api#required": {} + } + }, + "targetInput": { + "target": "com.amazonaws.bedrockagent#FlowNodeInputName", + "traits": { + "smithy.api#documentation": "The name of the input in the target node that the connection ends at.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration of a connection originating from a node that isn't a Condition node.
" + } + }, + "com.amazonaws.bedrockagent#FlowDefinition": { + "type": "structure", + "members": { + "nodes": { + "target": "com.amazonaws.bedrockagent#FlowNodes", + "traits": { + "smithy.api#documentation": "An array of node definitions in the flow.
" + } + }, + "connections": { + "target": "com.amazonaws.bedrockagent#FlowConnections", + "traits": { + "smithy.api#documentation": "An array of connection definitions in the flow.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The definition of the nodes and connections between nodes in the flow.
" + } + }, + "com.amazonaws.bedrockagent#FlowDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + } + } + }, + "com.amazonaws.bedrockagent#FlowExecutionRoleArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/(service-role/)?.+$" + } + }, + "com.amazonaws.bedrockagent#FlowId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[0-9a-zA-Z]{10}$" + } + }, + "com.amazonaws.bedrockagent#FlowIdentifier": { + "type": "string", + "traits": { + "smithy.api#pattern": "^(arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10})|([0-9a-zA-Z]{10})$" + } + }, + "com.amazonaws.bedrockagent#FlowName": { + "type": "string", + "traits": { + "smithy.api#pattern": "^([0-9a-zA-Z][_-]?){1,100}$" + } + }, + "com.amazonaws.bedrockagent#FlowNode": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagent#FlowNodeName", + "traits": { + "smithy.api#documentation": "A name for the node.
", + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.bedrockagent#FlowNodeType", + "traits": { + "smithy.api#documentation": "The type of node. This value must match the name of the key that you provide in the configuration you provide in the FlowNodeConfiguration field.
Contains configurations for the node.
" + } + }, + "inputs": { + "target": "com.amazonaws.bedrockagent#FlowNodeInputs", + "traits": { + "smithy.api#documentation": "An array of objects, each of which contains information about an input into the node.
" + } + }, + "outputs": { + "target": "com.amazonaws.bedrockagent#FlowNodeOutputs", + "traits": { + "smithy.api#documentation": "A list of objects, each of which contains information about an output from the node.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configurations about a node in the flow.
" + } + }, + "com.amazonaws.bedrockagent#FlowNodeConfiguration": { + "type": "union", + "members": { + "input": { + "target": "com.amazonaws.bedrockagent#InputFlowNodeConfiguration", + "traits": { + "smithy.api#documentation": "Contains configurations for an input flow node in your flow. The first node in the flow. inputs can't be specified for this node.
Contains configurations for an output flow node in your flow. The last node in the flow. outputs can't be specified for this node.
Contains configurations for a knowledge base node in your flow. Queries a knowledge base and returns the retrieved results or generated response.
" + } + }, + "condition": { + "target": "com.amazonaws.bedrockagent#ConditionFlowNodeConfiguration", + "traits": { + "smithy.api#documentation": "Contains configurations for a Condition node in your flow. Defines conditions that lead to different branches of the flow.
" + } + }, + "lex": { + "target": "com.amazonaws.bedrockagent#LexFlowNodeConfiguration", + "traits": { + "smithy.api#documentation": "Contains configurations for a Lex node in your flow. Invokes an Amazon Lex bot to identify the intent of the input and return the intent as the output.
" + } + }, + "prompt": { + "target": "com.amazonaws.bedrockagent#PromptFlowNodeConfiguration", + "traits": { + "smithy.api#documentation": "Contains configurations for a prompt node in your flow. Runs a prompt and generates the model response as the output. You can use a prompt from Prompt management or you can configure one in this node.
" + } + }, + "lambdaFunction": { + "target": "com.amazonaws.bedrockagent#LambdaFunctionFlowNodeConfiguration", + "traits": { + "smithy.api#documentation": "Contains configurations for a Lambda function node in your flow. Invokes an Lambda function.
" + } + }, + "storage": { + "target": "com.amazonaws.bedrockagent#StorageFlowNodeConfiguration", + "traits": { + "smithy.api#documentation": "Contains configurations for a Storage node in your flow. Stores an input in an Amazon S3 location.
" + } + }, + "agent": { + "target": "com.amazonaws.bedrockagent#AgentFlowNodeConfiguration", + "traits": { + "smithy.api#documentation": "Contains configurations for an agent node in your flow. Invokes an alias of an agent and returns the response.
" + } + }, + "retrieval": { + "target": "com.amazonaws.bedrockagent#RetrievalFlowNodeConfiguration", + "traits": { + "smithy.api#documentation": "Contains configurations for a Retrieval node in your flow. Retrieves data from an Amazon S3 location and returns it as the output.
" + } + }, + "iterator": { + "target": "com.amazonaws.bedrockagent#IteratorFlowNodeConfiguration", + "traits": { + "smithy.api#documentation": "Contains configurations for an iterator node in your flow. Takes an input that is an array and iteratively sends each item of the array as an output to the following node. The size of the array is also returned in the output.
\nThe output flow node at the end of the flow iteration will return a response for each member of the array. To return only one response, you can include a collector node downstream from the iterator node.
" + } + }, + "collector": { + "target": "com.amazonaws.bedrockagent#CollectorFlowNodeConfiguration", + "traits": { + "smithy.api#documentation": "Contains configurations for a collector node in your flow. Collects an iteration of inputs and consolidates them into an array of outputs.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configurations for a node in your flow. For more information, see Node types in Amazon Bedrock works in the Amazon Bedrock User Guide.
" + } + }, + "com.amazonaws.bedrockagent#FlowNodeIODataType": { + "type": "enum", + "members": { + "STRING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "String" + } + }, + "NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Number" + } + }, + "BOOLEAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Boolean" + } + }, + "OBJECT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Object" + } + }, + "ARRAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Array" + } + } + } + }, + "com.amazonaws.bedrockagent#FlowNodeInput": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagent#FlowNodeInputName", + "traits": { + "smithy.api#documentation": "A name for the input that you can reference.
", + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.bedrockagent#FlowNodeIODataType", + "traits": { + "smithy.api#documentation": "The data type of the input. If the input doesn't match this type at runtime, a validation error will be thrown.
", + "smithy.api#required": {} + } + }, + "expression": { + "target": "com.amazonaws.bedrockagent#FlowNodeInputExpression", + "traits": { + "smithy.api#documentation": "An expression that formats the input for the node. For an explanation of how to create expressions, see Expressions in Prompt flows in Amazon Bedrock.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configurations for an input to a node.
" + } + }, + "com.amazonaws.bedrockagent#FlowNodeInputExpression": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagent#FlowNodeInputName": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}$" + } + }, + "com.amazonaws.bedrockagent#FlowNodeInputs": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#FlowNodeInput" + }, + "traits": { + "smithy.api#length": { + "max": 5 + } + } + }, + "com.amazonaws.bedrockagent#FlowNodeName": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}$" + } + }, + "com.amazonaws.bedrockagent#FlowNodeOutput": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagent#FlowNodeOutputName", + "traits": { + "smithy.api#documentation": "A name for the output that you can reference.
", + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.bedrockagent#FlowNodeIODataType", + "traits": { + "smithy.api#documentation": "The data type of the output. If the output doesn't match this type at runtime, a validation error will be thrown.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configurations for an output from a node.
" + } + }, + "com.amazonaws.bedrockagent#FlowNodeOutputName": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}$" + } + }, + "com.amazonaws.bedrockagent#FlowNodeOutputs": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#FlowNodeOutput" + }, + "traits": { + "smithy.api#length": { + "max": 5 + } + } + }, + "com.amazonaws.bedrockagent#FlowNodeType": { + "type": "enum", + "members": { + "INPUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Input" + } + }, + "OUTPUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Output" + } + }, + "KNOWLEDGE_BASE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KnowledgeBase" + } + }, + "CONDITION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Condition" + } + }, + "LEX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Lex" + } + }, + "PROMPT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Prompt" + } + }, + "LAMBDA_FUNCTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LambdaFunction" + } + }, + "STORAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Storage" + } + }, + "AGENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Agent" + } + }, + "RETRIEVAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Retrieval" + } + }, + "ITERATOR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Iterator" + } + }, + "COLLECTOR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Collector" + } + } + } + }, + "com.amazonaws.bedrockagent#FlowNodes": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#FlowNode" + }, + "traits": { + "smithy.api#length": { + "max": 20 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagent#FlowResource": { + "type": "resource", + "identifiers": { + "flowIdentifier": { + "target": "com.amazonaws.bedrockagent#FlowIdentifier" + } + }, + "create": { + "target": "com.amazonaws.bedrockagent#CreateFlow" + }, + "read": { + "target": "com.amazonaws.bedrockagent#GetFlow" + }, + "update": { + "target": "com.amazonaws.bedrockagent#UpdateFlow" + }, + "delete": { + "target": "com.amazonaws.bedrockagent#DeleteFlow" + }, + "list": { + "target": "com.amazonaws.bedrockagent#ListFlows" + }, + "operations": [ + { + "target": "com.amazonaws.bedrockagent#PrepareFlow" + } + ], + "resources": [ + { + "target": "com.amazonaws.bedrockagent#FlowAliasResource" + }, + { + "target": "com.amazonaws.bedrockagent#FlowVersionResource" + } + ], + "traits": { + "aws.cloudformation#cfnResource": { + "name": "Flow" + } + } + }, + "com.amazonaws.bedrockagent#FlowStatus": { + "type": "enum", + "members": { + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "PREPARED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Prepared" + } + }, + "PREPARING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Preparing" + } + }, + "NOT_PREPARED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NotPrepared" + } + } + } + }, + "com.amazonaws.bedrockagent#FlowSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#FlowSummary" + }, + "traits": { + "smithy.api#length": { + "max": 10 + } + } + }, + "com.amazonaws.bedrockagent#FlowSummary": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagent#FlowName", + "traits": { + "smithy.api#documentation": "The name of the flow.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#FlowDescription", + "traits": { + "smithy.api#documentation": "A description of the flow.
" + } + }, + "id": { + "target": "com.amazonaws.bedrockagent#FlowId", + "traits": { + "smithy.api#documentation": "The unique identifier of the flow.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.bedrockagent#FlowArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the flow.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagent#FlowStatus", + "traits": { + "smithy.api#documentation": "The status of the flow. The following statuses are possible:
\nNotPrepared – The flow has been created or updated, but hasn't been prepared. If you just created the flow, you can't test it. If you updated the flow, the DRAFT version won't contain the latest changes for testing. Send a PrepareFlow request to package the latest changes into the DRAFT version.
Preparing – The flow is being prepared so that the DRAFT version contains the latest changes for testing.
Prepared – The flow is prepared and the DRAFT version contains the latest changes for testing.
Failed – The last API operation that you invoked on the flow failed. Send a GetFlow request and check the error message in the validations field.
The time at which the flow was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the flow was last updated.
", + "smithy.api#required": {} + } + }, + "version": { + "target": "com.amazonaws.bedrockagent#DraftVersion", + "traits": { + "smithy.api#documentation": "The latest version of the flow.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the definition of a flow.
" + } + }, + "com.amazonaws.bedrockagent#FlowValidation": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.bedrockagent#NonBlankString", + "traits": { + "smithy.api#documentation": "A message describing the validation error.
", + "smithy.api#required": {} + } + }, + "severity": { + "target": "com.amazonaws.bedrockagent#FlowValidationSeverity", + "traits": { + "smithy.api#documentation": "The severity of the issue described in the message.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about validation of the flow.
\nThis data type is used in the following API operations:
\n\n GetFlow response\n
\nThe unique identifier of the flow.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.bedrockagent#FlowArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the flow that the version belongs to.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagent#FlowStatus", + "traits": { + "smithy.api#documentation": "The status of the flow.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at the version was created.
", + "smithy.api#required": {} + } + }, + "version": { + "target": "com.amazonaws.bedrockagent#NumericalVersion", + "traits": { + "smithy.api#documentation": "The version of the flow.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about a version of a flow.
\nThis data type is used in the following API operations:
\nA name for the function.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#FunctionDescription", + "traits": { + "smithy.api#documentation": "A description of the function and its purpose.
" + } + }, + "parameters": { + "target": "com.amazonaws.bedrockagent#ParameterMap", + "traits": { + "smithy.api#documentation": "The parameters that the agent elicits from the user to fulfill the function.
" + } + }, + "requireConfirmation": { + "target": "com.amazonaws.bedrockagent#RequireConfirmation", + "traits": { + "smithy.api#documentation": "Contains information if user confirmation is required to invoke the function.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Defines parameters that the agent needs to invoke from the user to complete the function. Corresponds to an action in an action group.
\nThis data type is used in the following API operations:
\nA list of functions that each define an action in the action group.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Defines functions that each define parameters that the agent needs to invoke from the user. Each function represents an action in an action group.
\nThis data type is used in the following API operations:
\nGets information about an agent.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/agents/{agentId}/" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#GetAgentActionGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#GetAgentActionGroupRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#GetAgentActionGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets information about an action group for an agent.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/agents/{agentId}/agentversions/{agentVersion}/actiongroups/{actionGroupId}/" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#GetAgentActionGroupRequest": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the agent that the action group belongs to.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "agentVersion": { + "target": "com.amazonaws.bedrockagent#Version", + "traits": { + "smithy.api#documentation": "The version of the agent that the action group belongs to.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "actionGroupId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the action group for which to get information.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#GetAgentActionGroupResponse": { + "type": "structure", + "members": { + "agentActionGroup": { + "target": "com.amazonaws.bedrockagent#AgentActionGroup", + "traits": { + "smithy.api#documentation": "Contains details about the action group.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#GetAgentAlias": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#GetAgentAliasRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#GetAgentAliasResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets information about an alias of an agent.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/agents/{agentId}/agentaliases/{agentAliasId}/" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#GetAgentAliasRequest": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the agent to which the alias to get information belongs.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "agentAliasId": { + "target": "com.amazonaws.bedrockagent#AgentAliasId", + "traits": { + "smithy.api#documentation": "The unique identifier of the alias for which to get information.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#GetAgentAliasResponse": { + "type": "structure", + "members": { + "agentAlias": { + "target": "com.amazonaws.bedrockagent#AgentAlias", + "traits": { + "smithy.api#documentation": "Contains information about the alias.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#GetAgentKnowledgeBase": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#GetAgentKnowledgeBaseRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#GetAgentKnowledgeBaseResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets information about a knowledge base associated with an agent.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/agents/{agentId}/agentversions/{agentVersion}/knowledgebases/{knowledgeBaseId}/" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#GetAgentKnowledgeBaseRequest": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the agent with which the knowledge base is associated.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "agentVersion": { + "target": "com.amazonaws.bedrockagent#Version", + "traits": { + "smithy.api#documentation": "The version of the agent with which the knowledge base is associated.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the knowledge base associated with the agent.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#GetAgentKnowledgeBaseResponse": { + "type": "structure", + "members": { + "agentKnowledgeBase": { + "target": "com.amazonaws.bedrockagent#AgentKnowledgeBase", + "traits": { + "smithy.api#documentation": "Contains details about a knowledge base attached to an agent.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#GetAgentRequest": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the agent.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#GetAgentResponse": { + "type": "structure", + "members": { + "agent": { + "target": "com.amazonaws.bedrockagent#Agent", + "traits": { + "smithy.api#documentation": "Contains details about the agent.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#GetAgentVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#GetAgentVersionRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#GetAgentVersionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets details about a version of an agent.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/agents/{agentId}/agentversions/{agentVersion}/" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#GetAgentVersionRequest": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the agent.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "agentVersion": { + "target": "com.amazonaws.bedrockagent#NumericalVersion", + "traits": { + "smithy.api#documentation": "The version of the agent.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#GetAgentVersionResponse": { + "type": "structure", + "members": { + "agentVersion": { + "target": "com.amazonaws.bedrockagent#AgentVersion", + "traits": { + "smithy.api#documentation": "Contains details about the version of the agent.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#GetDataSource": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#GetDataSourceRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#GetDataSourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets information about a data source.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/knowledgebases/{knowledgeBaseId}/datasources/{dataSourceId}" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#GetDataSourceRequest": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the knowledge base that the data source was added to.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "dataSourceId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the data source.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#GetDataSourceResponse": { + "type": "structure", + "members": { + "dataSource": { + "target": "com.amazonaws.bedrockagent#DataSource", + "traits": { + "smithy.api#documentation": "Contains details about the data source.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#GetFlow": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#GetFlowRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#GetFlowResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves information about a flow. For more information, see Manage a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/flows/{flowIdentifier}/" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#GetFlowAlias": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#GetFlowAliasRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#GetFlowAliasResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves information about a flow. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/flows/{flowIdentifier}/aliases/{aliasIdentifier}" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#GetFlowAliasRequest": { + "type": "structure", + "members": { + "flowIdentifier": { + "target": "com.amazonaws.bedrockagent#FlowIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the flow that the alias belongs to.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "aliasIdentifier": { + "target": "com.amazonaws.bedrockagent#FlowAliasIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the alias for which to retrieve information.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#GetFlowAliasResponse": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#documentation": "The name of the alias.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "The description of the flow.
" + } + }, + "routingConfiguration": { + "target": "com.amazonaws.bedrockagent#FlowAliasRoutingConfiguration", + "traits": { + "smithy.api#documentation": "Contains information about the version that the alias is mapped to.
", + "smithy.api#required": {} + } + }, + "flowId": { + "target": "com.amazonaws.bedrockagent#FlowId", + "traits": { + "smithy.api#documentation": "The unique identifier of the flow that the alias belongs to.
", + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.bedrockagent#FlowAliasId", + "traits": { + "smithy.api#documentation": "The unique identifier of the alias of the flow.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.bedrockagent#FlowAliasArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the flow.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the flow was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the alias was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#GetFlowRequest": { + "type": "structure", + "members": { + "flowIdentifier": { + "target": "com.amazonaws.bedrockagent#FlowIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the flow.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#GetFlowResponse": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagent#FlowName", + "traits": { + "smithy.api#documentation": "The name of the flow.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#FlowDescription", + "traits": { + "smithy.api#documentation": "The description of the flow.
" + } + }, + "executionRoleArn": { + "target": "com.amazonaws.bedrockagent#FlowExecutionRoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the service role with permissions to create a flow. For more information, see Create a service row for flows in the Amazon Bedrock User Guide.
", + "smithy.api#required": {} + } + }, + "customerEncryptionKeyArn": { + "target": "com.amazonaws.bedrockagent#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key that the flow is encrypted with.
" + } + }, + "id": { + "target": "com.amazonaws.bedrockagent#FlowId", + "traits": { + "smithy.api#documentation": "The unique identifier of the flow.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.bedrockagent#FlowArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the flow.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagent#FlowStatus", + "traits": { + "smithy.api#documentation": "The status of the flow. The following statuses are possible:
\nNotPrepared – The flow has been created or updated, but hasn't been prepared. If you just created the flow, you can't test it. If you updated the flow, the DRAFT version won't contain the latest changes for testing. Send a PrepareFlow request to package the latest changes into the DRAFT version.
Preparing – The flow is being prepared so that the DRAFT version contains the latest changes for testing.
Prepared – The flow is prepared and the DRAFT version contains the latest changes for testing.
Failed – The last API operation that you invoked on the flow failed. Send a GetFlow request and check the error message in the validations field.
The time at which the flow was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the flow was last updated.
", + "smithy.api#required": {} + } + }, + "version": { + "target": "com.amazonaws.bedrockagent#DraftVersion", + "traits": { + "smithy.api#documentation": "The version of the flow for which information was retrieved.
", + "smithy.api#required": {} + } + }, + "definition": { + "target": "com.amazonaws.bedrockagent#FlowDefinition", + "traits": { + "smithy.api#documentation": "The definition of the nodes and connections between the nodes in the flow.
" + } + }, + "validations": { + "target": "com.amazonaws.bedrockagent#FlowValidations", + "traits": { + "smithy.api#documentation": "A list of validation error messages related to the last failed operation on the flow.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#GetFlowVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#GetFlowVersionRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#GetFlowVersionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves information about a version of a flow. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/flows/{flowIdentifier}/versions/{flowVersion}/" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#GetFlowVersionRequest": { + "type": "structure", + "members": { + "flowIdentifier": { + "target": "com.amazonaws.bedrockagent#FlowIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the flow for which to get information.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "flowVersion": { + "target": "com.amazonaws.bedrockagent#NumericalVersion", + "traits": { + "smithy.api#documentation": "The version of the flow for which to get information.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#GetFlowVersionResponse": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagent#FlowName", + "traits": { + "smithy.api#documentation": "The name of the version.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#FlowDescription", + "traits": { + "smithy.api#documentation": "The description of the flow.
" + } + }, + "executionRoleArn": { + "target": "com.amazonaws.bedrockagent#FlowExecutionRoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the service role with permissions to create a flow. For more information, see Create a service role for flows in Amazon Bedrock in the Amazon Bedrock User Guide.
", + "smithy.api#required": {} + } + }, + "customerEncryptionKeyArn": { + "target": "com.amazonaws.bedrockagent#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key that the version of the flow is encrypted with.
" + } + }, + "id": { + "target": "com.amazonaws.bedrockagent#FlowId", + "traits": { + "smithy.api#documentation": "The unique identifier of the flow.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.bedrockagent#FlowArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the flow.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagent#FlowStatus", + "traits": { + "smithy.api#documentation": "The status of the flow.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the flow was created.
", + "smithy.api#required": {} + } + }, + "version": { + "target": "com.amazonaws.bedrockagent#NumericalVersion", + "traits": { + "smithy.api#documentation": "The version of the flow for which information was retrieved.
", + "smithy.api#required": {} + } + }, + "definition": { + "target": "com.amazonaws.bedrockagent#FlowDefinition", + "traits": { + "smithy.api#documentation": "The definition of the nodes and connections between nodes in the flow.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#GetIngestionJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#GetIngestionJobRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#GetIngestionJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets information about a ingestion job, in which a data source is added to a knowledge base.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/knowledgebases/{knowledgeBaseId}/datasources/{dataSourceId}/ingestionjobs/{ingestionJobId}" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#GetIngestionJobRequest": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the knowledge base for which the ingestion job applies.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "dataSourceId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the data source in the ingestion job.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ingestionJobId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the ingestion job.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#GetIngestionJobResponse": { + "type": "structure", + "members": { + "ingestionJob": { + "target": "com.amazonaws.bedrockagent#IngestionJob", + "traits": { + "smithy.api#documentation": "Contains details about the ingestion job.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#GetKnowledgeBase": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#GetKnowledgeBaseRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#GetKnowledgeBaseResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets information about a knoweldge base.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/knowledgebases/{knowledgeBaseId}" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#GetKnowledgeBaseRequest": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the knowledge base for which to get information.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#GetKnowledgeBaseResponse": { + "type": "structure", + "members": { + "knowledgeBase": { + "target": "com.amazonaws.bedrockagent#KnowledgeBase", + "traits": { + "smithy.api#documentation": "Contains details about the knowledge base.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#GetPrompt": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#GetPromptRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#GetPromptResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves information about the working draft (DRAFT version) of a prompt or a version of it, depending on whether you include the promptVersion field or not. For more information, see View information about prompts using Prompt management and View information about a version of your prompt in the Amazon Bedrock User Guide.
The unique identifier of the prompt.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "promptVersion": { + "target": "com.amazonaws.bedrockagent#Version", + "traits": { + "smithy.api#documentation": "The version of the prompt about which you want to retrieve information. Omit this field to return information about the working draft of the prompt.
", + "smithy.api#httpQuery": "promptVersion" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#GetPromptResponse": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagent#PromptName", + "traits": { + "smithy.api#documentation": "The name of the prompt.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#PromptDescription", + "traits": { + "smithy.api#documentation": "The descriptino of the prompt.
" + } + }, + "customerEncryptionKeyArn": { + "target": "com.amazonaws.bedrockagent#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key that the prompt is encrypted with.
" + } + }, + "defaultVariant": { + "target": "com.amazonaws.bedrockagent#PromptVariantName", + "traits": { + "smithy.api#documentation": "The name of the default variant for the prompt. This value must match the name field in the relevant PromptVariant object.
A list of objects, each containing details about a variant of the prompt.
" + } + }, + "id": { + "target": "com.amazonaws.bedrockagent#PromptId", + "traits": { + "smithy.api#documentation": "The unique identifier of the prompt.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.bedrockagent#PromptArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the prompt or the prompt version (if you specified a version in the request).
", + "smithy.api#required": {} + } + }, + "version": { + "target": "com.amazonaws.bedrockagent#Version", + "traits": { + "smithy.api#documentation": "The version of the prompt.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the prompt was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the prompt was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#GuardrailConfiguration": { + "type": "structure", + "members": { + "guardrailIdentifier": { + "target": "com.amazonaws.bedrockagent#GuardrailIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the guardrail.
" + } + }, + "guardrailVersion": { + "target": "com.amazonaws.bedrockagent#GuardrailVersion", + "traits": { + "smithy.api#documentation": "The version of the guardrail.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details about the guardrail associated with an agent.
" + } + }, + "com.amazonaws.bedrockagent#GuardrailIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^(([a-z0-9]+)|(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+))$" + } + }, + "com.amazonaws.bedrockagent#GuardrailVersion": { + "type": "string", + "traits": { + "smithy.api#pattern": "^(([0-9]{1,8})|(DRAFT))$" + } + }, + "com.amazonaws.bedrockagent#HierarchicalChunkingConfiguration": { + "type": "structure", + "members": { + "levelConfigurations": { + "target": "com.amazonaws.bedrockagent#HierarchicalChunkingLevelConfigurations", + "traits": { + "smithy.api#documentation": "Token settings for each layer.
", + "smithy.api#required": {} + } + }, + "overlapTokens": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The number of tokens to repeat across chunks in the same layer.
", + "smithy.api#range": { + "min": 1 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Settings for hierarchical document chunking for a data source. Hierarchical chunking splits documents\n into layers of chunks where the first layer contains large chunks, and the second layer contains smaller\n chunks derived from the first layer.
\nYou configure the number of tokens to overlap, or repeat across adjacent chunks. For example,\n if you set overlap tokens to 60, the last 60 tokens in the first chunk are also included at the beginning of\n the second chunk. For each layer, you must also configure the maximum number of tokens in a chunk.
" + } + }, + "com.amazonaws.bedrockagent#HierarchicalChunkingLevelConfiguration": { + "type": "structure", + "members": { + "maxTokens": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The maximum number of tokens that a chunk can contain in this layer.
", + "smithy.api#range": { + "min": 1, + "max": 8192 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Token settings for a layer in a hierarchical chunking configuration.
" + } + }, + "com.amazonaws.bedrockagent#HierarchicalChunkingLevelConfigurations": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#HierarchicalChunkingLevelConfiguration" + }, + "traits": { + "smithy.api#length": { + "min": 2, + "max": 2 + } + } + }, + "com.amazonaws.bedrockagent#HttpsUrl": { + "type": "string", + "traits": { + "smithy.api#pattern": "^https://[A-Za-z0-9][^\\s]*$" + } + }, + "com.amazonaws.bedrockagent#Id": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[0-9a-zA-Z]{10}$" + } + }, + "com.amazonaws.bedrockagent#InferenceConfiguration": { + "type": "structure", + "members": { + "temperature": { + "target": "com.amazonaws.bedrockagent#Temperature", + "traits": { + "smithy.api#documentation": "The likelihood of the model selecting higher-probability options while generating a response. A lower value makes the model more likely to choose higher-probability options, while a higher value makes the model more likely to choose lower-probability options.
" + } + }, + "topP": { + "target": "com.amazonaws.bedrockagent#TopP", + "traits": { + "smithy.api#documentation": "While generating a response, the model determines the probability of the following token at each point of generation. The value that you set for Top P determines the number of most-likely candidates from which the model chooses the next token in the sequence. For example, if you set topP to 80, the model only selects the next token from the top 80% of the probability distribution of next tokens.
While generating a response, the model determines the probability of the following token at each point of generation. The value that you set for topK is the number of most-likely candidates from which the model chooses the next token in the sequence. For example, if you set topK to 50, the model selects the next token from among the top 50 most likely choices.
The maximum number of tokens to allow in the generated response.
" + } + }, + "stopSequences": { + "target": "com.amazonaws.bedrockagent#StopSequences", + "traits": { + "smithy.api#documentation": "A list of stop sequences. A stop sequence is a sequence of characters that causes the model to stop generating the response.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains inference parameters to use when the agent invokes a foundation model in the part of the agent sequence defined by the promptType. For more information, see Inference parameters for foundation models.
The unique identifier of the knowledge base to which the data source is being added.
", + "smithy.api#required": {} + } + }, + "dataSourceId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the ingested data source.
", + "smithy.api#required": {} + } + }, + "ingestionJobId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the ingestion job.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "The description of the ingestion job.
" + } + }, + "status": { + "target": "com.amazonaws.bedrockagent#IngestionJobStatus", + "traits": { + "smithy.api#documentation": "The status of the ingestion job.
", + "smithy.api#required": {} + } + }, + "statistics": { + "target": "com.amazonaws.bedrockagent#IngestionJobStatistics", + "traits": { + "smithy.api#documentation": "Contains statistics about the ingestion job.
" + } + }, + "failureReasons": { + "target": "com.amazonaws.bedrockagent#FailureReasons", + "traits": { + "smithy.api#documentation": "A list of reasons that the ingestion job failed.
" + } + }, + "startedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the ingestion job started.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the ingestion job was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about an ingestion job, which converts a data source to embeddings for a vector store in knowledge base.
\nThis data type is used in the following API operations:
\nThe attribute by which to filter the results.
", + "smithy.api#required": {} + } + }, + "operator": { + "target": "com.amazonaws.bedrockagent#IngestionJobFilterOperator", + "traits": { + "smithy.api#documentation": "The operation to carry out between the attribute and the values.
", + "smithy.api#required": {} + } + }, + "values": { + "target": "com.amazonaws.bedrockagent#IngestionJobFilterValues", + "traits": { + "smithy.api#documentation": "A list of values for the attribute.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Defines a filter by which to filter the results.
" + } + }, + "com.amazonaws.bedrockagent#IngestionJobFilterAttribute": { + "type": "enum", + "members": { + "STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STATUS" + } + } + } + }, + "com.amazonaws.bedrockagent#IngestionJobFilterOperator": { + "type": "enum", + "members": { + "EQ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EQ" + } + } + } + }, + "com.amazonaws.bedrockagent#IngestionJobFilterValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + }, + "smithy.api#pattern": "^.*$" + } + }, + "com.amazonaws.bedrockagent#IngestionJobFilterValues": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#IngestionJobFilterValue" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.bedrockagent#IngestionJobFilters": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#IngestionJobFilter" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.bedrockagent#IngestionJobResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrockagent#GetIngestionJob" + }, + { + "target": "com.amazonaws.bedrockagent#ListIngestionJobs" + }, + { + "target": "com.amazonaws.bedrockagent#StartIngestionJob" + } + ] + }, + "com.amazonaws.bedrockagent#IngestionJobSortBy": { + "type": "structure", + "members": { + "attribute": { + "target": "com.amazonaws.bedrockagent#IngestionJobSortByAttribute", + "traits": { + "smithy.api#documentation": "The attribute by which to sort the results.
", + "smithy.api#required": {} + } + }, + "order": { + "target": "com.amazonaws.bedrockagent#SortOrder", + "traits": { + "smithy.api#documentation": "The order by which to sort the results.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Parameters by which to sort the results.
" + } + }, + "com.amazonaws.bedrockagent#IngestionJobSortByAttribute": { + "type": "enum", + "members": { + "STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STATUS" + } + }, + "STARTED_AT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STARTED_AT" + } + } + } + }, + "com.amazonaws.bedrockagent#IngestionJobStatistics": { + "type": "structure", + "members": { + "numberOfDocumentsScanned": { + "target": "smithy.api#PrimitiveLong", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The total number of source documents that were scanned. Includes new, updated, and unchanged documents.
" + } + }, + "numberOfMetadataDocumentsScanned": { + "target": "smithy.api#PrimitiveLong", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The total number of metadata files that were scanned. Includes new, updated, and unchanged files.
" + } + }, + "numberOfNewDocumentsIndexed": { + "target": "smithy.api#PrimitiveLong", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The number of new source documents in the data source that were successfully indexed.
" + } + }, + "numberOfModifiedDocumentsIndexed": { + "target": "smithy.api#PrimitiveLong", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The number of modified source documents in the data source that were successfully indexed.
" + } + }, + "numberOfMetadataDocumentsModified": { + "target": "smithy.api#PrimitiveLong", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The number of metadata files that were updated or deleted.
" + } + }, + "numberOfDocumentsDeleted": { + "target": "smithy.api#PrimitiveLong", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The number of source documents that was deleted.
" + } + }, + "numberOfDocumentsFailed": { + "target": "smithy.api#PrimitiveLong", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The number of source documents that failed to be ingested.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the statistics for the ingestion job.
" + } + }, + "com.amazonaws.bedrockagent#IngestionJobStatus": { + "type": "enum", + "members": { + "STARTING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STARTING" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + }, + "COMPLETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETE" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } + } + }, + "com.amazonaws.bedrockagent#IngestionJobSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#IngestionJobSummary" + } + }, + "com.amazonaws.bedrockagent#IngestionJobSummary": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the knowledge base to which the data source is added.
", + "smithy.api#required": {} + } + }, + "dataSourceId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the data source in the ingestion job.
", + "smithy.api#required": {} + } + }, + "ingestionJobId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the ingestion job.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "The description of the ingestion job.
" + } + }, + "status": { + "target": "com.amazonaws.bedrockagent#IngestionJobStatus", + "traits": { + "smithy.api#documentation": "The status of the ingestion job.
", + "smithy.api#required": {} + } + }, + "startedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the ingestion job was started.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the ingestion job was last updated.
", + "smithy.api#required": {} + } + }, + "statistics": { + "target": "com.amazonaws.bedrockagent#IngestionJobStatistics", + "traits": { + "smithy.api#documentation": "Contains statistics for the ingestion job.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about an ingestion job.
" + } + }, + "com.amazonaws.bedrockagent#InputFlowNodeConfiguration": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "Contains configurations for the input flow node for a flow. This node takes the input from flow invocation and passes it to the next node in the data type that you specify.
" + } + }, + "com.amazonaws.bedrockagent#Instruction": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 40, + "max": 4000 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagent#IntermediateStorage": { + "type": "structure", + "members": { + "s3Location": { + "target": "com.amazonaws.bedrockagent#S3Location", + "traits": { + "smithy.api#documentation": "An S3 bucket path.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A location for storing content from data sources temporarily as it is processed by\n custom components in the ingestion pipeline.
" + } + }, + "com.amazonaws.bedrockagent#InternalServerException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.bedrockagent#NonBlankString" + } + }, + "traits": { + "smithy.api#documentation": "An internal server error occurred. Retry your request.
", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.bedrockagent#IteratorFlowNodeConfiguration": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "Contains configurations for an iterator node in a flow. Takes an input that is an array and iteratively sends each item of the array as an output to the following node. The size of the array is also returned in the output.
\nThe output flow node at the end of the flow iteration will return a response for each member of the array. To return only one response, you can include a collector node downstream from the iterator node.
" + } + }, + "com.amazonaws.bedrockagent#KmsKeyArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$" + } + }, + "com.amazonaws.bedrockagent#KnowledgeBase": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the knowledge base.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#documentation": "The name of the knowledge base.
", + "smithy.api#required": {} + } + }, + "knowledgeBaseArn": { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the knowledge base.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "The description of the knowledge base.
" + } + }, + "roleArn": { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseRoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.
", + "smithy.api#required": {} + } + }, + "knowledgeBaseConfiguration": { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseConfiguration", + "traits": { + "smithy.api#documentation": "Contains details about the embeddings configuration of the knowledge base.
", + "smithy.api#required": {} + } + }, + "storageConfiguration": { + "target": "com.amazonaws.bedrockagent#StorageConfiguration", + "traits": { + "smithy.api#documentation": "Contains details about the storage configuration of the knowledge base.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseStatus", + "traits": { + "smithy.api#documentation": "The status of the knowledge base. The following statuses are possible:
\nCREATING – The knowledge base is being created.
\nACTIVE – The knowledge base is ready to be queried.
\nDELETING – The knowledge base is being deleted.
\nUPDATING – The knowledge base is being updated.
\nFAILED – The knowledge base API operation failed.
\nThe time at which the knowledge base was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the knowledge base was last updated.
", + "smithy.api#required": {} + } + }, + "failureReasons": { + "target": "com.amazonaws.bedrockagent#FailureReasons", + "traits": { + "smithy.api#documentation": "A list of reasons that the API operation on the knowledge base failed.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about a knowledge base.
" + } + }, + "com.amazonaws.bedrockagent#KnowledgeBaseArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 128 + }, + "smithy.api#pattern": "^arn:aws(|-cn|-us-gov):bedrock:[a-zA-Z0-9-]*:[0-9]{12}:knowledge-base/[0-9a-zA-Z]+$" + } + }, + "com.amazonaws.bedrockagent#KnowledgeBaseConfiguration": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseType", + "traits": { + "smithy.api#documentation": "The type of data that the data source is converted into for the knowledge base.
", + "smithy.api#required": {} + } + }, + "vectorKnowledgeBaseConfiguration": { + "target": "com.amazonaws.bedrockagent#VectorKnowledgeBaseConfiguration", + "traits": { + "smithy.api#documentation": "Contains details about the embeddings model that'sused to convert the data source.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about the embeddings configuration of the knowledge base.
" + } + }, + "com.amazonaws.bedrockagent#KnowledgeBaseFlowNodeConfiguration": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseId", + "traits": { + "smithy.api#documentation": "The unique identifier of the knowledge base to query.
", + "smithy.api#required": {} + } + }, + "modelId": { + "target": "com.amazonaws.bedrockagent#ModelIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the model to use to generate a response from the query results. Omit this field if you want to return the retrieved results as an array.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configurations for a knowledge base node in a flow. This node takes a query as the input and returns, as the output, the retrieved responses directly (as an array) or a response generated based on the retrieved responses. For more information, see Node types in Amazon Bedrock works in the Amazon Bedrock User Guide.
" + } + }, + "com.amazonaws.bedrockagent#KnowledgeBaseId": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 10 + }, + "smithy.api#pattern": "^[0-9a-zA-Z]+$" + } + }, + "com.amazonaws.bedrockagent#KnowledgeBaseResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrockagent#AssociateAgentKnowledgeBase" + }, + { + "target": "com.amazonaws.bedrockagent#CreateKnowledgeBase" + }, + { + "target": "com.amazonaws.bedrockagent#DeleteKnowledgeBase" + }, + { + "target": "com.amazonaws.bedrockagent#DisassociateAgentKnowledgeBase" + }, + { + "target": "com.amazonaws.bedrockagent#GetAgentKnowledgeBase" + }, + { + "target": "com.amazonaws.bedrockagent#GetKnowledgeBase" + }, + { + "target": "com.amazonaws.bedrockagent#ListAgentKnowledgeBases" + }, + { + "target": "com.amazonaws.bedrockagent#ListKnowledgeBases" + }, + { + "target": "com.amazonaws.bedrockagent#UpdateAgentKnowledgeBase" + }, + { + "target": "com.amazonaws.bedrockagent#UpdateKnowledgeBase" + } + ] + }, + "com.amazonaws.bedrockagent#KnowledgeBaseRoleArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/.+$" + } + }, + "com.amazonaws.bedrockagent#KnowledgeBaseState": { + "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.bedrockagent#KnowledgeBaseStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "DELETE_UNSUCCESSFUL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_UNSUCCESSFUL" + } + } + } + }, + "com.amazonaws.bedrockagent#KnowledgeBaseStorageType": { + "type": "enum", + "members": { + "OPENSEARCH_SERVERLESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OPENSEARCH_SERVERLESS" + } + }, + "PINECONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PINECONE" + } + }, + "REDIS_ENTERPRISE_CLOUD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REDIS_ENTERPRISE_CLOUD" + } + }, + "RDS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RDS" + } + }, + "MONGO_DB_ATLAS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MONGO_DB_ATLAS" + } + } + } + }, + "com.amazonaws.bedrockagent#KnowledgeBaseSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseSummary" + } + }, + "com.amazonaws.bedrockagent#KnowledgeBaseSummary": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the knowledge base.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#documentation": "The name of the knowledge base.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "The description of the knowledge base.
" + } + }, + "status": { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseStatus", + "traits": { + "smithy.api#documentation": "The status of the knowledge base.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the knowledge base was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about a knowledge base.
" + } + }, + "com.amazonaws.bedrockagent#KnowledgeBaseType": { + "type": "enum", + "members": { + "VECTOR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VECTOR" + } + } + } + }, + "com.amazonaws.bedrockagent#LambdaArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}(-gov)?-[a-z]+-\\d{1}:\\d{12}:function:[a-zA-Z0-9-_\\.]+(:(\\$LATEST|[a-zA-Z0-9-_]+))?$" + } + }, + "com.amazonaws.bedrockagent#LambdaFunctionFlowNodeConfiguration": { + "type": "structure", + "members": { + "lambdaArn": { + "target": "com.amazonaws.bedrockagent#LambdaArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Lambda function to invoke.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configurations for a Lambda function node in the flow. You specify the Lambda function to invoke and the inputs into the function. The output is the response that is defined in the Lambda function. For more information, see Node types in Amazon Bedrock works in the Amazon Bedrock User Guide.
" + } + }, + "com.amazonaws.bedrockagent#LexBotAliasArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 78 + }, + "smithy.api#pattern": "^arn:aws(|-us-gov):lex:[a-z]{2}(-gov)?-[a-z]+-\\d{1}:\\d{12}:bot-alias/[0-9a-zA-Z]+/[0-9a-zA-Z]+$" + } + }, + "com.amazonaws.bedrockagent#LexBotLocaleId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.bedrockagent#LexFlowNodeConfiguration": { + "type": "structure", + "members": { + "botAliasArn": { + "target": "com.amazonaws.bedrockagent#LexBotAliasArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Lex bot alias to invoke.
", + "smithy.api#required": {} + } + }, + "localeId": { + "target": "com.amazonaws.bedrockagent#LexBotLocaleId", + "traits": { + "smithy.api#documentation": "The Region to invoke the Amazon Lex bot in.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configurations for a Lex node in the flow. You specify a Amazon Lex bot to invoke. This node takes an utterance as the input and returns as the output the intent identified by the Amazon Lex bot. For more information, see Node types in Amazon Bedrock works in the Amazon Bedrock User Guide.
" + } + }, + "com.amazonaws.bedrockagent#ListAgentActionGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#ListAgentActionGroupsRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#ListAgentActionGroupsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the action groups for an agent and information about each one.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/agents/{agentId}/agentversions/{agentVersion}/actiongroups/" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "actionGroupSummaries" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#ListAgentActionGroupsRequest": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the agent.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "agentVersion": { + "target": "com.amazonaws.bedrockagent#Version", + "traits": { + "smithy.api#documentation": "The version of the agent.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.bedrockagent#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
A list of objects, each of which contains information about an action group.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagent#NextToken", + "traits": { + "smithy.api#documentation": "If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
Lists the aliases of an agent and information about each one.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/agents/{agentId}/agentaliases/" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "agentAliasSummaries" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#ListAgentAliasesRequest": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the agent.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.bedrockagent#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
A list of objects, each of which contains information about an alias of the agent.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagent#NextToken", + "traits": { + "smithy.api#documentation": "If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
Lists knowledge bases associated with an agent and information about each one.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/agents/{agentId}/agentversions/{agentVersion}/knowledgebases/" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "agentKnowledgeBaseSummaries" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#ListAgentKnowledgeBasesRequest": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the agent for which to return information about knowledge bases associated with it.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "agentVersion": { + "target": "com.amazonaws.bedrockagent#Version", + "traits": { + "smithy.api#documentation": "The version of the agent for which to return information about knowledge bases associated with it.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.bedrockagent#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
A list of objects, each of which contains information about a knowledge base associated with the agent.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagent#NextToken", + "traits": { + "smithy.api#documentation": "If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
Lists the versions of an agent and information about each version.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/agents/{agentId}/agentversions/" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "agentVersionSummaries" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#ListAgentVersionsRequest": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the agent.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.bedrockagent#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
A list of objects, each of which contains information about a version of the agent.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagent#NextToken", + "traits": { + "smithy.api#documentation": "If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
Lists the agents belonging to an account and information about each agent.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/agents/" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "agentSummaries" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#ListAgentsRequest": { + "type": "structure", + "members": { + "maxResults": { + "target": "com.amazonaws.bedrockagent#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
A list of objects, each of which contains information about an agent.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagent#NextToken", + "traits": { + "smithy.api#documentation": "If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
Lists the data sources in a knowledge base and information about each one.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/knowledgebases/{knowledgeBaseId}/datasources/" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "dataSourceSummaries" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#ListDataSourcesRequest": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the knowledge base for which to return a list of information.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.bedrockagent#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
A list of objects, each of which contains information about a data source.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagent#NextToken", + "traits": { + "smithy.api#documentation": "If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
Returns a list of aliases for a flow.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/flows/{flowIdentifier}/aliases" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "flowAliasSummaries" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#ListFlowAliasesRequest": { + "type": "structure", + "members": { + "flowIdentifier": { + "target": "com.amazonaws.bedrockagent#FlowIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the flow for which aliases are being returned.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.bedrockagent#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
A list, each member of which contains information about an alias.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagent#NextToken", + "traits": { + "smithy.api#documentation": "If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
Returns a list of information about each flow. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/flows/{flowIdentifier}/versions" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "flowVersionSummaries" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#ListFlowVersionsRequest": { + "type": "structure", + "members": { + "flowIdentifier": { + "target": "com.amazonaws.bedrockagent#FlowIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the flow.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.bedrockagent#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
A list, each member of which contains information about a flow.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagent#NextToken", + "traits": { + "smithy.api#documentation": "If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
Returns a list of flows and information about each flow. For more information, see Manage a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/flows/" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "flowSummaries" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#ListFlowsRequest": { + "type": "structure", + "members": { + "maxResults": { + "target": "com.amazonaws.bedrockagent#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
A list, each member of which contains information about a flow.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagent#NextToken", + "traits": { + "smithy.api#documentation": "If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
Lists the ingestion jobs for a data source and information about each of them.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/knowledgebases/{knowledgeBaseId}/datasources/{dataSourceId}/ingestionjobs/" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "ingestionJobSummaries" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#ListIngestionJobsRequest": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the knowledge base for which to return ingestion jobs.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "dataSourceId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the data source for which to return ingestion jobs.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "filters": { + "target": "com.amazonaws.bedrockagent#IngestionJobFilters", + "traits": { + "smithy.api#documentation": "Contains a definition of a filter for which to filter the results.
" + } + }, + "sortBy": { + "target": "com.amazonaws.bedrockagent#IngestionJobSortBy", + "traits": { + "smithy.api#documentation": "Contains details about how to sort the results.
" + } + }, + "maxResults": { + "target": "com.amazonaws.bedrockagent#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
A list of objects, each of which contains information about an ingestion job.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagent#NextToken", + "traits": { + "smithy.api#documentation": "If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
Lists the knowledge bases in an account and information about each of them.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/knowledgebases/" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "knowledgeBaseSummaries" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#ListKnowledgeBasesRequest": { + "type": "structure", + "members": { + "maxResults": { + "target": "com.amazonaws.bedrockagent#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
A list of objects, each of which contains information about a knowledge base.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagent#NextToken", + "traits": { + "smithy.api#documentation": "If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
Returns either information about the working draft (DRAFT version) of each prompt in an account, or information about of all versions of a prompt, depending on whether you include the promptIdentifier field or not. For more information, see View information about prompts using Prompt management in the Amazon Bedrock User Guide.
The unique identifier of the prompt for whose versions you want to return information. Omit this field to list information about all prompts in an account.
", + "smithy.api#httpQuery": "promptIdentifier" + } + }, + "maxResults": { + "target": "com.amazonaws.bedrockagent#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
A list, each member of which contains information about a prompt using Prompt management.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagent#NextToken", + "traits": { + "smithy.api#documentation": "If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
List all the tags for the resource you specify.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/tags/{resourceArn}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockagent#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.bedrockagent#TaggableResourcesArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource for which to list tags.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "tags": { + "target": "com.amazonaws.bedrockagent#TagsMap", + "traits": { + "smithy.api#documentation": "The key-value pairs for the tags associated with the resource.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.bedrockagent#MaximumLength": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 4096 + } + } + }, + "com.amazonaws.bedrockagent#MemoryConfiguration": { + "type": "structure", + "members": { + "enabledMemoryTypes": { + "target": "com.amazonaws.bedrockagent#EnabledMemoryTypes", + "traits": { + "smithy.api#documentation": "The type of memory that is stored.
", + "smithy.api#required": {} + } + }, + "storageDays": { + "target": "com.amazonaws.bedrockagent#StorageDays", + "traits": { + "smithy.api#default": 30, + "smithy.api#documentation": "The number of days the agent is configured to retain the conversational context.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details of the memory configuration.
" + } + }, + "com.amazonaws.bedrockagent#MemoryType": { + "type": "enum", + "members": { + "SESSION_SUMMARY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SESSION_SUMMARY" + } + } + } + }, + "com.amazonaws.bedrockagent#Microsoft365TenantId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 36, + "max": 36 + }, + "smithy.api#pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" + } + }, + "com.amazonaws.bedrockagent#ModelIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}(([:][a-z0-9-]{1,63}){0,2})?/[a-z0-9]{12})|(:foundation-model/([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2})))|(([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2}))|(([0-9a-zA-Z][_-]?)+)$" + } + }, + "com.amazonaws.bedrockagent#MongoDbAtlasCollectionName": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 63 + }, + "smithy.api#pattern": "^.*$" + } + }, + "com.amazonaws.bedrockagent#MongoDbAtlasConfiguration": { + "type": "structure", + "members": { + "endpoint": { + "target": "com.amazonaws.bedrockagent#MongoDbAtlasEndpoint", + "traits": { + "smithy.api#documentation": "The endpoint URL of your MongoDB Atlas cluster for your knowledge base.
", + "smithy.api#required": {} + } + }, + "databaseName": { + "target": "com.amazonaws.bedrockagent#MongoDbAtlasDatabaseName", + "traits": { + "smithy.api#documentation": "The database name in your MongoDB Atlas cluster for your knowledge base.
", + "smithy.api#required": {} + } + }, + "collectionName": { + "target": "com.amazonaws.bedrockagent#MongoDbAtlasCollectionName", + "traits": { + "smithy.api#documentation": "The collection name of the knowledge base in MongoDB Atlas.
", + "smithy.api#required": {} + } + }, + "vectorIndexName": { + "target": "com.amazonaws.bedrockagent#MongoDbAtlasIndexName", + "traits": { + "smithy.api#documentation": "The name of the MongoDB Atlas vector search index.
", + "smithy.api#required": {} + } + }, + "credentialsSecretArn": { + "target": "com.amazonaws.bedrockagent#SecretArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that contains user credentials for your MongoDB Atlas cluster.
", + "smithy.api#required": {} + } + }, + "fieldMapping": { + "target": "com.amazonaws.bedrockagent#MongoDbAtlasFieldMapping", + "traits": { + "smithy.api#documentation": "Contains the names of the fields to which to map information about the vector store.
", + "smithy.api#required": {} + } + }, + "endpointServiceName": { + "target": "com.amazonaws.bedrockagent#MongoDbAtlasEndpointServiceName", + "traits": { + "smithy.api#documentation": "The name of the VPC endpoint service in your account that is connected to your MongoDB Atlas cluster.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about the storage configuration of the knowledge base in MongoDB Atlas.
" + } + }, + "com.amazonaws.bedrockagent#MongoDbAtlasDatabaseName": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 63 + }, + "smithy.api#pattern": "^.*$" + } + }, + "com.amazonaws.bedrockagent#MongoDbAtlasEndpoint": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^.*$" + } + }, + "com.amazonaws.bedrockagent#MongoDbAtlasEndpointServiceName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^(?:arn:aws(?:-us-gov|-cn|-iso|-iso-[a-z])*:.+:.*:\\d+:.+/.+$|[a-zA-Z0-9*]+[a-zA-Z0-9._-]*)$" + } + }, + "com.amazonaws.bedrockagent#MongoDbAtlasFieldMapping": { + "type": "structure", + "members": { + "vectorField": { + "target": "com.amazonaws.bedrockagent#FieldName", + "traits": { + "smithy.api#documentation": "The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
", + "smithy.api#required": {} + } + }, + "textField": { + "target": "com.amazonaws.bedrockagent#FieldName", + "traits": { + "smithy.api#documentation": "The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
", + "smithy.api#required": {} + } + }, + "metadataField": { + "target": "com.amazonaws.bedrockagent#FieldName", + "traits": { + "smithy.api#documentation": "The name of the field in which Amazon Bedrock stores metadata about the vector store.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the names of the fields to which to map information about the vector store.
" + } + }, + "com.amazonaws.bedrockagent#MongoDbAtlasIndexName": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^.*$" + } + }, + "com.amazonaws.bedrockagent#Name": { + "type": "string", + "traits": { + "smithy.api#pattern": "^([0-9a-zA-Z][_-]?){1,100}$" + } + }, + "com.amazonaws.bedrockagent#NextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^\\S*$" + } + }, + "com.amazonaws.bedrockagent#NonBlankString": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[\\s\\S]+$" + } + }, + "com.amazonaws.bedrockagent#NumericalVersion": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[0-9]{1,5}$" + } + }, + "com.amazonaws.bedrockagent#OpenSearchServerlessCollectionArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws:aoss:[a-z]{2}(-gov)?-[a-z]+-\\d{1}:\\d{12}:collection/[a-z0-9-]{3,32}$" + } + }, + "com.amazonaws.bedrockagent#OpenSearchServerlessConfiguration": { + "type": "structure", + "members": { + "collectionArn": { + "target": "com.amazonaws.bedrockagent#OpenSearchServerlessCollectionArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the OpenSearch Service vector store.
", + "smithy.api#required": {} + } + }, + "vectorIndexName": { + "target": "com.amazonaws.bedrockagent#OpenSearchServerlessIndexName", + "traits": { + "smithy.api#documentation": "The name of the vector store.
", + "smithy.api#required": {} + } + }, + "fieldMapping": { + "target": "com.amazonaws.bedrockagent#OpenSearchServerlessFieldMapping", + "traits": { + "smithy.api#documentation": "Contains the names of the fields to which to map information about the vector store.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about the storage configuration of the knowledge base in Amazon OpenSearch Service. For more information, see Create a vector index in Amazon OpenSearch Service.
" + } + }, + "com.amazonaws.bedrockagent#OpenSearchServerlessFieldMapping": { + "type": "structure", + "members": { + "vectorField": { + "target": "com.amazonaws.bedrockagent#FieldName", + "traits": { + "smithy.api#documentation": "The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
", + "smithy.api#required": {} + } + }, + "textField": { + "target": "com.amazonaws.bedrockagent#FieldName", + "traits": { + "smithy.api#documentation": "The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
", + "smithy.api#required": {} + } + }, + "metadataField": { + "target": "com.amazonaws.bedrockagent#FieldName", + "traits": { + "smithy.api#documentation": "The name of the field in which Amazon Bedrock stores metadata about the vector store.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the names of the fields to which to map information about the vector store.
" + } + }, + "com.amazonaws.bedrockagent#OpenSearchServerlessIndexName": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^.*$" + } + }, + "com.amazonaws.bedrockagent#OutputFlowNodeConfiguration": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "Contains configurations for an output flow node in the flow. You specify the data type expected for the input into the node in the type field and how to return the final output in the expression field.
A description of the parameter. Helps the foundation model determine how to elicit the parameters from the user.
" + } + }, + "type": { + "target": "com.amazonaws.bedrockagent#Type", + "traits": { + "smithy.api#documentation": "The data type of the parameter.
", + "smithy.api#required": {} + } + }, + "required": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Whether the parameter is required for the agent to complete the function for action group invocation.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about a parameter in a function for an action group.
\nThis data type is used in the following API operations:
\nThe parsing strategy for the data source.
", + "smithy.api#required": {} + } + }, + "bedrockFoundationModelConfiguration": { + "target": "com.amazonaws.bedrockagent#BedrockFoundationModelConfiguration", + "traits": { + "smithy.api#documentation": "Settings for a foundation model used to parse documents for a data source.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Settings for parsing document contents. By default, the service converts the contents of each\n document into text before splitting it into chunks. To improve processing of PDF files with tables and images,\n you can configure the data source to convert the pages of text into images and use a model to describe the\n contents of each page.
\nTo use a model to parse PDF documents, set the parsing strategy to BEDROCK_FOUNDATION_MODEL and\n specify the model to use by ARN. You can also override the default parsing prompt with instructions for how\n to interpret images and tables in your documents. The following models are supported.
Anthropic Claude 3 Sonnet - anthropic.claude-3-sonnet-20240229-v1:0\n
Anthropic Claude 3 Haiku - anthropic.claude-3-haiku-20240307-v1:0\n
You can get the ARN of a model with the ListFoundationModels action. Standard model usage\n charges apply for the foundation model parsing strategy.
" + } + }, + "com.amazonaws.bedrockagent#ParsingPrompt": { + "type": "structure", + "members": { + "parsingPromptText": { + "target": "com.amazonaws.bedrockagent#ParsingPromptText", + "traits": { + "smithy.api#documentation": "Instructions for interpreting the contents of a document.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Instructions for interpreting the contents of a document.
" + } + }, + "com.amazonaws.bedrockagent#ParsingPromptText": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10000 + } + } + }, + "com.amazonaws.bedrockagent#ParsingStrategy": { + "type": "enum", + "members": { + "BEDROCK_FOUNDATION_MODEL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BEDROCK_FOUNDATION_MODEL" + } + } + } + }, + "com.amazonaws.bedrockagent#PatternObjectFilter": { + "type": "structure", + "members": { + "objectType": { + "target": "com.amazonaws.bedrockagent#FilteredObjectType", + "traits": { + "smithy.api#documentation": "The supported object type or content type of the data source.
", + "smithy.api#required": {} + } + }, + "inclusionFilters": { + "target": "com.amazonaws.bedrockagent#FilterList", + "traits": { + "smithy.api#documentation": "A list of one or more inclusion regular expression patterns to include certain \n object types that adhere to the pattern. If you specify an inclusion and exclusion \n filter/pattern and both match a document, the exclusion filter takes precedence \n and the document isn’t crawled.
" + } + }, + "exclusionFilters": { + "target": "com.amazonaws.bedrockagent#FilterList", + "traits": { + "smithy.api#documentation": "A list of one or more exclusion regular expression patterns to exclude certain \n object types that adhere to the pattern. If you specify an inclusion and exclusion \n filter/pattern and both match a document, the exclusion filter takes precedence \n and the document isn’t crawled.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The specific filters applied to your data source content. You can filter out or \n include certain content.
" + } + }, + "com.amazonaws.bedrockagent#PatternObjectFilterConfiguration": { + "type": "structure", + "members": { + "filters": { + "target": "com.amazonaws.bedrockagent#PatternObjectFilterList", + "traits": { + "smithy.api#documentation": "The configuration of specific filters applied to your data source content. You can \n filter out or include certain content.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration of filtering certain objects or content types of the data source.
" + } + }, + "com.amazonaws.bedrockagent#PatternObjectFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#PatternObjectFilter" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 25 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagent#Payload": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagent#PineconeConfiguration": { + "type": "structure", + "members": { + "connectionString": { + "target": "com.amazonaws.bedrockagent#PineconeConnectionString", + "traits": { + "smithy.api#documentation": "The endpoint URL for your index management page.
", + "smithy.api#required": {} + } + }, + "credentialsSecretArn": { + "target": "com.amazonaws.bedrockagent#SecretArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that is linked to your Pinecone API key.
", + "smithy.api#required": {} + } + }, + "namespace": { + "target": "com.amazonaws.bedrockagent#PineconeNamespace", + "traits": { + "smithy.api#documentation": "The namespace to be used to write new data to your database.
" + } + }, + "fieldMapping": { + "target": "com.amazonaws.bedrockagent#PineconeFieldMapping", + "traits": { + "smithy.api#documentation": "Contains the names of the fields to which to map information about the vector store.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about the storage configuration of the knowledge base in Pinecone. For more information, see Create a vector index in Pinecone.
" + } + }, + "com.amazonaws.bedrockagent#PineconeConnectionString": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^.*$" + } + }, + "com.amazonaws.bedrockagent#PineconeFieldMapping": { + "type": "structure", + "members": { + "textField": { + "target": "com.amazonaws.bedrockagent#FieldName", + "traits": { + "smithy.api#documentation": "The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
", + "smithy.api#required": {} + } + }, + "metadataField": { + "target": "com.amazonaws.bedrockagent#FieldName", + "traits": { + "smithy.api#documentation": "The name of the field in which Amazon Bedrock stores metadata about the vector store.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the names of the fields to which to map information about the vector store.
" + } + }, + "com.amazonaws.bedrockagent#PineconeNamespace": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^.*$" + } + }, + "com.amazonaws.bedrockagent#PrepareAgent": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#PrepareAgentRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#PrepareAgentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a DRAFT version of the agent that can be used for internal testing.
The unique identifier of the agent for which to create a DRAFT version.
The unique identifier of the agent for which the DRAFT version was created.
The status of the DRAFT version and whether it is ready for use.
The version of the agent.
", + "smithy.api#required": {} + } + }, + "preparedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the DRAFT version of the agent was last prepared.
Prepares the DRAFT version of a flow so that it can be invoked. For more information, see Test a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
The unique identifier of the flow.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#PrepareFlowResponse": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.bedrockagent#FlowId", + "traits": { + "smithy.api#documentation": "The unique identifier of the flow.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagent#FlowStatus", + "traits": { + "smithy.api#documentation": "The status of the flow. When you submit this request, the status will be NotPrepared. If preparation succeeds, the status becomes Prepared. If it fails, the status becomes FAILED.
The step in the agent sequence that this prompt configuration applies to.
" + } + }, + "promptCreationMode": { + "target": "com.amazonaws.bedrockagent#CreationMode", + "traits": { + "smithy.api#documentation": "Specifies whether to override the default prompt template for this promptType. Set this value to OVERRIDDEN to use the prompt that you provide in the basePromptTemplate. If you leave it as DEFAULT, the agent uses a default prompt template.
Specifies whether to allow the agent to carry out the step specified in the promptType. If you set this value to DISABLED, the agent skips that step. The default state for each promptType is as follows.
\n PRE_PROCESSING – ENABLED\n
\n ORCHESTRATION – ENABLED\n
\n KNOWLEDGE_BASE_RESPONSE_GENERATION – ENABLED\n
\n POST_PROCESSING – DISABLED\n
Defines the prompt template with which to replace the default prompt template. You can use placeholder variables in the base prompt template to customize the prompt. For more information, see Prompt template placeholder variables. For more information, see Configure the prompt templates.
" + } + }, + "inferenceConfiguration": { + "target": "com.amazonaws.bedrockagent#InferenceConfiguration", + "traits": { + "smithy.api#documentation": "Contains inference parameters to use when the agent invokes a foundation model in the part of the agent sequence defined by the promptType. For more information, see Inference parameters for foundation models.
Specifies whether to override the default parser Lambda function when parsing the raw foundation model output in the part of the agent sequence defined by the promptType. If you set the field as OVERRIDEN, the overrideLambda field in the PromptOverrideConfiguration must be specified with the ARN of a Lambda function.
Contains configurations to override a prompt template in one part of an agent sequence. For more information, see Advanced prompts.
" + } + }, + "com.amazonaws.bedrockagent#PromptConfigurations": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#PromptConfiguration" + }, + "traits": { + "smithy.api#length": { + "max": 10 + } + } + }, + "com.amazonaws.bedrockagent#PromptDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + } + } + }, + "com.amazonaws.bedrockagent#PromptFlowNodeConfiguration": { + "type": "structure", + "members": { + "sourceConfiguration": { + "target": "com.amazonaws.bedrockagent#PromptFlowNodeSourceConfiguration", + "traits": { + "smithy.api#documentation": "Specifies whether the prompt is from Prompt management or defined inline.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configurations for a prompt node in the flow. You can use a prompt from Prompt management or you can define one in this node. If the prompt contains variables, the inputs into this node will fill in the variables. The output from this node is the response generated by the model. For more information, see Node types in Amazon Bedrock works in the Amazon Bedrock User Guide.
" + } + }, + "com.amazonaws.bedrockagent#PromptFlowNodeInlineConfiguration": { + "type": "structure", + "members": { + "templateType": { + "target": "com.amazonaws.bedrockagent#PromptTemplateType", + "traits": { + "smithy.api#documentation": "The type of prompt template.
", + "smithy.api#required": {} + } + }, + "templateConfiguration": { + "target": "com.amazonaws.bedrockagent#PromptTemplateConfiguration", + "traits": { + "smithy.api#documentation": "Contains a prompt and variables in the prompt that can be replaced with values at runtime.
", + "smithy.api#required": {} + } + }, + "modelId": { + "target": "com.amazonaws.bedrockagent#PromptModelIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the model to run inference with.
", + "smithy.api#required": {} + } + }, + "inferenceConfiguration": { + "target": "com.amazonaws.bedrockagent#PromptInferenceConfiguration", + "traits": { + "smithy.api#documentation": "Contains inference configurations for the prompt.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configurations for a prompt defined inline in the node.
" + } + }, + "com.amazonaws.bedrockagent#PromptFlowNodeResourceConfiguration": { + "type": "structure", + "members": { + "promptArn": { + "target": "com.amazonaws.bedrockagent#PromptArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the prompt from Prompt management.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configurations for a prompt from Prompt management to use in a node.
" + } + }, + "com.amazonaws.bedrockagent#PromptFlowNodeSourceConfiguration": { + "type": "union", + "members": { + "resource": { + "target": "com.amazonaws.bedrockagent#PromptFlowNodeResourceConfiguration", + "traits": { + "smithy.api#documentation": "Contains configurations for a prompt from Prompt management.
" + } + }, + "inline": { + "target": "com.amazonaws.bedrockagent#PromptFlowNodeInlineConfiguration", + "traits": { + "smithy.api#documentation": "Contains configurations for a prompt that is defined inline
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configurations for a prompt and whether it is from Prompt management or defined inline.
" + } + }, + "com.amazonaws.bedrockagent#PromptId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[0-9a-zA-Z]{10}$" + } + }, + "com.amazonaws.bedrockagent#PromptIdentifier": { + "type": "string", + "traits": { + "smithy.api#pattern": "^([0-9a-zA-Z]{10})|(arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:prompt/[0-9a-zA-Z]{10})(?::[0-9]{1,5})?$" + } + }, + "com.amazonaws.bedrockagent#PromptInferenceConfiguration": { + "type": "union", + "members": { + "text": { + "target": "com.amazonaws.bedrockagent#PromptModelInferenceConfiguration", + "traits": { + "smithy.api#documentation": "Contains inference configurations for a text prompt.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains inference configurations for the prompt.
" + } + }, + "com.amazonaws.bedrockagent#PromptInputVariable": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagent#PromptInputVariableName", + "traits": { + "smithy.api#documentation": "The name of the variable.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about a variable in the prompt.
" + } + }, + "com.amazonaws.bedrockagent#PromptInputVariableName": { + "type": "string", + "traits": { + "smithy.api#pattern": "^([0-9a-zA-Z][_-]?){1,100}$" + } + }, + "com.amazonaws.bedrockagent#PromptInputVariablesList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#PromptInputVariable" + }, + "traits": { + "smithy.api#length": { + "max": 5 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagent#PromptMetadataEntry": { + "type": "structure", + "members": { + "key": { + "target": "com.amazonaws.bedrockagent#PromptMetadataKey", + "traits": { + "smithy.api#documentation": "The key of a metadata tag for a prompt variant.
", + "smithy.api#required": {} + } + }, + "value": { + "target": "com.amazonaws.bedrockagent#PromptMetadataValue", + "traits": { + "smithy.api#documentation": "The value of a metadata tag for a prompt variant.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains a key-value pair that defines a metadata tag and value to attach to a prompt variant. For more information, see Create a prompt using Prompt management.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagent#PromptMetadataKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\s._:/=+@-]*$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagent#PromptMetadataList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#PromptMetadataEntry" + }, + "traits": { + "smithy.api#length": { + "max": 50 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagent#PromptMetadataValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\s._:/=+@-]*$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagent#PromptModelIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|([0-9]{12}:provisioned-model/[a-z0-9]{12})))|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|(([0-9a-zA-Z][_-]?)+)$" + } + }, + "com.amazonaws.bedrockagent#PromptModelInferenceConfiguration": { + "type": "structure", + "members": { + "temperature": { + "target": "com.amazonaws.bedrockagent#Temperature", + "traits": { + "smithy.api#documentation": "Controls the randomness of the response. Choose a lower value for more predictable outputs and a higher value for more surprising outputs.
" + } + }, + "topP": { + "target": "com.amazonaws.bedrockagent#TopP", + "traits": { + "smithy.api#documentation": "The percentage of most-likely candidates that the model considers for the next token.
" + } + }, + "topK": { + "target": "com.amazonaws.bedrockagent#TopK", + "traits": { + "smithy.api#documentation": "The number of most-likely candidates that the model considers for the next token during generation.
" + } + }, + "maxTokens": { + "target": "com.amazonaws.bedrockagent#MaximumLength", + "traits": { + "smithy.api#documentation": "The maximum number of tokens to return in the response.
" + } + }, + "stopSequences": { + "target": "com.amazonaws.bedrockagent#StopSequences", + "traits": { + "smithy.api#documentation": "A list of strings that define sequences after which the model will stop generating.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains inference configurations related to model inference for a prompt. For more information, see Inference parameters.
" + } + }, + "com.amazonaws.bedrockagent#PromptName": { + "type": "string", + "traits": { + "smithy.api#pattern": "^([0-9a-zA-Z][_-]?){1,100}$" + } + }, + "com.amazonaws.bedrockagent#PromptOverrideConfiguration": { + "type": "structure", + "members": { + "promptConfigurations": { + "target": "com.amazonaws.bedrockagent#PromptConfigurations", + "traits": { + "smithy.api#documentation": "Contains configurations to override a prompt template in one part of an agent sequence. For more information, see Advanced prompts.
", + "smithy.api#required": {} + } + }, + "overrideLambda": { + "target": "com.amazonaws.bedrockagent#LambdaArn", + "traits": { + "smithy.api#documentation": "The ARN of the Lambda function to use when parsing the raw foundation model output in parts of the agent sequence. If you specify this field, at least one of the promptConfigurations must contain a parserMode value that is set to OVERRIDDEN. For more information, see Parser Lambda function in Agents for Amazon Bedrock.
Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagent#PromptResource": { + "type": "resource", + "identifiers": { + "promptIdentifier": { + "target": "com.amazonaws.bedrockagent#PromptIdentifier" + } + }, + "create": { + "target": "com.amazonaws.bedrockagent#CreatePrompt" + }, + "read": { + "target": "com.amazonaws.bedrockagent#GetPrompt" + }, + "update": { + "target": "com.amazonaws.bedrockagent#UpdatePrompt" + }, + "delete": { + "target": "com.amazonaws.bedrockagent#DeletePrompt" + }, + "list": { + "target": "com.amazonaws.bedrockagent#ListPrompts" + }, + "operations": [ + { + "target": "com.amazonaws.bedrockagent#CreatePromptVersion" + } + ], + "traits": { + "aws.cloudformation#cfnResource": { + "name": "Prompt" + } + } + }, + "com.amazonaws.bedrockagent#PromptState": { + "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.bedrockagent#PromptSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#PromptSummary" + }, + "traits": { + "smithy.api#length": { + "max": 10 + } + } + }, + "com.amazonaws.bedrockagent#PromptSummary": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagent#PromptName", + "traits": { + "smithy.api#documentation": "The name of the prompt.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#PromptDescription", + "traits": { + "smithy.api#documentation": "The description of the prompt.
" + } + }, + "id": { + "target": "com.amazonaws.bedrockagent#PromptId", + "traits": { + "smithy.api#documentation": "The unique identifier of the prompt.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.bedrockagent#PromptArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the prompt or the prompt version (if you specified a version in the request).
", + "smithy.api#required": {} + } + }, + "version": { + "target": "com.amazonaws.bedrockagent#Version", + "traits": { + "smithy.api#documentation": "The version of the prompt that this summary applies to.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the prompt was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the prompt was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about a prompt in your Prompt management tool.
\nThis data type is used in the following API operations:
\n\n ListPrompts response\n
\nContains configurations for the text in a message for a prompt.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the message for a prompt. For more information, see Prompt management in Amazon Bedrock.
" + } + }, + "com.amazonaws.bedrockagent#PromptTemplateType": { + "type": "enum", + "members": { + "TEXT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TEXT" + } + } + } + }, + "com.amazonaws.bedrockagent#PromptType": { + "type": "enum", + "members": { + "PRE_PROCESSING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PRE_PROCESSING" + } + }, + "ORCHESTRATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ORCHESTRATION" + } + }, + "POST_PROCESSING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "POST_PROCESSING" + } + }, + "KNOWLEDGE_BASE_RESPONSE_GENERATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KNOWLEDGE_BASE_RESPONSE_GENERATION" + } + } + } + }, + "com.amazonaws.bedrockagent#PromptVariant": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagent#PromptVariantName", + "traits": { + "smithy.api#documentation": "The name of the prompt variant.
", + "smithy.api#required": {} + } + }, + "templateType": { + "target": "com.amazonaws.bedrockagent#PromptTemplateType", + "traits": { + "smithy.api#documentation": "The type of prompt template to use.
", + "smithy.api#required": {} + } + }, + "templateConfiguration": { + "target": "com.amazonaws.bedrockagent#PromptTemplateConfiguration", + "traits": { + "smithy.api#documentation": "Contains configurations for the prompt template.
" + } + }, + "modelId": { + "target": "com.amazonaws.bedrockagent#PromptModelIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the model with which to run inference on the prompt.
" + } + }, + "inferenceConfiguration": { + "target": "com.amazonaws.bedrockagent#PromptInferenceConfiguration", + "traits": { + "smithy.api#documentation": "Contains inference configurations for the prompt variant.
" + } + }, + "metadata": { + "target": "com.amazonaws.bedrockagent#PromptMetadataList", + "traits": { + "smithy.api#documentation": "An array of objects, each containing a key-value pair that defines a metadata tag and value to attach to a prompt variant. For more information, see Create a prompt using Prompt management.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about a variant of the prompt.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagent#PromptVariantList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#PromptVariant" + }, + "traits": { + "smithy.api#length": { + "max": 3 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagent#PromptVariantName": { + "type": "string", + "traits": { + "smithy.api#pattern": "^([0-9a-zA-Z][_-]?){1,100}$" + } + }, + "com.amazonaws.bedrockagent#ProvisionedModelIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^((([0-9a-zA-Z][_-]?){1,63})|(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:provisioned-model/[a-z0-9]{12}))$" + } + }, + "com.amazonaws.bedrockagent#RdsArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws(|-cn|-us-gov):rds:[a-zA-Z0-9-]*:[0-9]{12}:cluster:[a-zA-Z0-9-]{1,63}$" + } + }, + "com.amazonaws.bedrockagent#RdsConfiguration": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.bedrockagent#RdsArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the vector store.
", + "smithy.api#required": {} + } + }, + "credentialsSecretArn": { + "target": "com.amazonaws.bedrockagent#SecretArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that is linked to your Amazon RDS database.
", + "smithy.api#required": {} + } + }, + "databaseName": { + "target": "com.amazonaws.bedrockagent#RdsDatabaseName", + "traits": { + "smithy.api#documentation": "The name of your Amazon RDS database.
", + "smithy.api#required": {} + } + }, + "tableName": { + "target": "com.amazonaws.bedrockagent#RdsTableName", + "traits": { + "smithy.api#documentation": "The name of the table in the database.
", + "smithy.api#required": {} + } + }, + "fieldMapping": { + "target": "com.amazonaws.bedrockagent#RdsFieldMapping", + "traits": { + "smithy.api#documentation": "Contains the names of the fields to which to map information about the vector store.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about the storage configuration of the knowledge base in Amazon RDS. For more information, see Create a vector index in Amazon RDS.
" + } + }, + "com.amazonaws.bedrockagent#RdsDatabaseName": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_\\-]+$" + } + }, + "com.amazonaws.bedrockagent#RdsFieldMapping": { + "type": "structure", + "members": { + "primaryKeyField": { + "target": "com.amazonaws.bedrockagent#ColumnName", + "traits": { + "smithy.api#documentation": "The name of the field in which Amazon Bedrock stores the ID for each entry.
", + "smithy.api#required": {} + } + }, + "vectorField": { + "target": "com.amazonaws.bedrockagent#ColumnName", + "traits": { + "smithy.api#documentation": "The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
", + "smithy.api#required": {} + } + }, + "textField": { + "target": "com.amazonaws.bedrockagent#ColumnName", + "traits": { + "smithy.api#documentation": "The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
", + "smithy.api#required": {} + } + }, + "metadataField": { + "target": "com.amazonaws.bedrockagent#ColumnName", + "traits": { + "smithy.api#documentation": "The name of the field in which Amazon Bedrock stores metadata about the vector store.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the names of the fields to which to map information about the vector store.
" + } + }, + "com.amazonaws.bedrockagent#RdsTableName": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_\\.\\-]+$" + } + }, + "com.amazonaws.bedrockagent#RecommendedAction": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + } + } + }, + "com.amazonaws.bedrockagent#RecommendedActions": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#RecommendedAction" + }, + "traits": { + "smithy.api#length": { + "max": 2048 + } + } + }, + "com.amazonaws.bedrockagent#RedisEnterpriseCloudConfiguration": { + "type": "structure", + "members": { + "endpoint": { + "target": "com.amazonaws.bedrockagent#RedisEnterpriseCloudEndpoint", + "traits": { + "smithy.api#documentation": "The endpoint URL of the Redis Enterprise Cloud database.
", + "smithy.api#required": {} + } + }, + "vectorIndexName": { + "target": "com.amazonaws.bedrockagent#RedisEnterpriseCloudIndexName", + "traits": { + "smithy.api#documentation": "The name of the vector index.
", + "smithy.api#required": {} + } + }, + "credentialsSecretArn": { + "target": "com.amazonaws.bedrockagent#SecretArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that is linked to your Redis Enterprise Cloud database.
", + "smithy.api#required": {} + } + }, + "fieldMapping": { + "target": "com.amazonaws.bedrockagent#RedisEnterpriseCloudFieldMapping", + "traits": { + "smithy.api#documentation": "Contains the names of the fields to which to map information about the vector store.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about the storage configuration of the knowledge base in Redis Enterprise Cloud. For more information, see Create a vector index in Redis Enterprise Cloud.
" + } + }, + "com.amazonaws.bedrockagent#RedisEnterpriseCloudEndpoint": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^.*$" + } + }, + "com.amazonaws.bedrockagent#RedisEnterpriseCloudFieldMapping": { + "type": "structure", + "members": { + "vectorField": { + "target": "com.amazonaws.bedrockagent#FieldName", + "traits": { + "smithy.api#documentation": "The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
", + "smithy.api#required": {} + } + }, + "textField": { + "target": "com.amazonaws.bedrockagent#FieldName", + "traits": { + "smithy.api#documentation": "The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
", + "smithy.api#required": {} + } + }, + "metadataField": { + "target": "com.amazonaws.bedrockagent#FieldName", + "traits": { + "smithy.api#documentation": "The name of the field in which Amazon Bedrock stores metadata about the vector store.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the names of the fields to which to map information about the vector store.
" + } + }, + "com.amazonaws.bedrockagent#RedisEnterpriseCloudIndexName": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^.*$" + } + }, + "com.amazonaws.bedrockagent#RequireConfirmation": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + }, + "traits": { + "smithy.api#documentation": "ENUM to check if action requires user confirmation" + } + }, + "com.amazonaws.bedrockagent#ResourceNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.bedrockagent#NonBlankString" + } + }, + "traits": { + "smithy.api#documentation": "The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.bedrockagent#RetrievalFlowNodeConfiguration": { + "type": "structure", + "members": { + "serviceConfiguration": { + "target": "com.amazonaws.bedrockagent#RetrievalFlowNodeServiceConfiguration", + "traits": { + "smithy.api#documentation": "Contains configurations for the service to use for retrieving data to return as the output from the node.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configurations for a Retrieval node in a flow. This node retrieves data from the Amazon S3 location that you specify and returns it as the output.
" + } + }, + "com.amazonaws.bedrockagent#RetrievalFlowNodeS3Configuration": { + "type": "structure", + "members": { + "bucketName": { + "target": "com.amazonaws.bedrockagent#S3BucketName", + "traits": { + "smithy.api#documentation": "The name of the Amazon S3 bucket from which to retrieve data.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configurations for the Amazon S3 location from which to retrieve data to return as the output from the node.
" + } + }, + "com.amazonaws.bedrockagent#RetrievalFlowNodeServiceConfiguration": { + "type": "union", + "members": { + "s3": { + "target": "com.amazonaws.bedrockagent#RetrievalFlowNodeS3Configuration", + "traits": { + "smithy.api#documentation": "Contains configurations for the Amazon S3 location from which to retrieve data to return as the output from the node.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configurations for the service to use for retrieving data to return as the output from the node.
" + } + }, + "com.amazonaws.bedrockagent#S3BucketArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws(|-cn|-us-gov):s3:::[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]$" + } + }, + "com.amazonaws.bedrockagent#S3BucketName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 63 + }, + "smithy.api#pattern": "^[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]$" + } + }, + "com.amazonaws.bedrockagent#S3BucketUri": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^s3://.{1,128}$" + } + }, + "com.amazonaws.bedrockagent#S3DataSourceConfiguration": { + "type": "structure", + "members": { + "bucketArn": { + "target": "com.amazonaws.bedrockagent#S3BucketArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the S3 bucket that contains your data.
", + "smithy.api#required": {} + } + }, + "inclusionPrefixes": { + "target": "com.amazonaws.bedrockagent#S3Prefixes", + "traits": { + "smithy.api#documentation": "A list of S3 prefixes to include certain files or content. For more information, \n see Organizing objects using prefixes.
" + } + }, + "bucketOwnerAccountId": { + "target": "com.amazonaws.bedrockagent#BucketOwnerAccountId", + "traits": { + "smithy.api#documentation": "The account ID for the owner of the S3 bucket.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration information to connect to Amazon S3 as your data source.
" + } + }, + "com.amazonaws.bedrockagent#S3Identifier": { + "type": "structure", + "members": { + "s3BucketName": { + "target": "com.amazonaws.bedrockagent#S3BucketName", + "traits": { + "smithy.api#documentation": "The name of the S3 bucket.
" + } + }, + "s3ObjectKey": { + "target": "com.amazonaws.bedrockagent#S3ObjectKey", + "traits": { + "smithy.api#documentation": "The S3 object key for the S3 resource.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The identifier information for an Amazon S3 bucket.
" + } + }, + "com.amazonaws.bedrockagent#S3Location": { + "type": "structure", + "members": { + "uri": { + "target": "com.amazonaws.bedrockagent#S3BucketUri", + "traits": { + "smithy.api#documentation": "The location's URI. For example, s3://my-bucket/chunk-processor/.
An Amazon S3 location.
" + } + }, + "com.amazonaws.bedrockagent#S3ObjectKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^[\\.\\-\\!\\*\\_\\'\\(\\)a-zA-Z0-9][\\.\\-\\!\\*\\_\\'\\(\\)\\/a-zA-Z0-9]*$" + } + }, + "com.amazonaws.bedrockagent#S3Prefix": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 300 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagent#S3Prefixes": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#S3Prefix" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.bedrockagent#SalesforceAuthType": { + "type": "enum", + "members": { + "OAUTH2_CLIENT_CREDENTIALS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OAUTH2_CLIENT_CREDENTIALS" + } + } + } + }, + "com.amazonaws.bedrockagent#SalesforceCrawlerConfiguration": { + "type": "structure", + "members": { + "filterConfiguration": { + "target": "com.amazonaws.bedrockagent#CrawlFilterConfiguration", + "traits": { + "smithy.api#documentation": "The configuration of filtering the Salesforce content. For example, \n configuring regular expression patterns to include or exclude certain \n content.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration of the Salesforce content. For example, configuring \n specific types of Salesforce content.
" + } + }, + "com.amazonaws.bedrockagent#SalesforceDataSourceConfiguration": { + "type": "structure", + "members": { + "sourceConfiguration": { + "target": "com.amazonaws.bedrockagent#SalesforceSourceConfiguration", + "traits": { + "smithy.api#documentation": "The endpoint information to connect to your Salesforce data source.
", + "smithy.api#required": {} + } + }, + "crawlerConfiguration": { + "target": "com.amazonaws.bedrockagent#SalesforceCrawlerConfiguration", + "traits": { + "smithy.api#documentation": "The configuration of the Salesforce content. For example, configuring \n specific types of Salesforce content.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration information to connect to Salesforce as your data source.
" + } + }, + "com.amazonaws.bedrockagent#SalesforceSourceConfiguration": { + "type": "structure", + "members": { + "hostUrl": { + "target": "com.amazonaws.bedrockagent#HttpsUrl", + "traits": { + "smithy.api#documentation": "The Salesforce host URL or instance URL.
", + "smithy.api#required": {} + } + }, + "authType": { + "target": "com.amazonaws.bedrockagent#SalesforceAuthType", + "traits": { + "smithy.api#documentation": "The supported authentication type to authenticate and connect to your \n Salesforce instance.
", + "smithy.api#required": {} + } + }, + "credentialsSecretArn": { + "target": "com.amazonaws.bedrockagent#SecretArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name of an Secrets Manager secret that \n stores your authentication credentials for your Salesforce instance URL. \n For more information on the key-value pairs that must be included in \n your secret, depending on your authentication type, see \n Salesforce connection configuration.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The endpoint information to connect to your Salesforce data source.
" + } + }, + "com.amazonaws.bedrockagent#SecretArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws(|-cn|-us-gov):secretsmanager:[a-z0-9-]{1,20}:([0-9]{12}|):secret:[a-zA-Z0-9!/_+=.@-]{1,512}$" + } + }, + "com.amazonaws.bedrockagent#SeedUrl": { + "type": "structure", + "members": { + "url": { + "target": "com.amazonaws.bedrockagent#Url", + "traits": { + "smithy.api#documentation": "A seed or starting point URL.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The seed or starting point URL. \n You should be authorized to crawl the URL.
" + } + }, + "com.amazonaws.bedrockagent#SeedUrls": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#SeedUrl" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.bedrockagent#SemanticChunkingConfiguration": { + "type": "structure", + "members": { + "maxTokens": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The maximum number of tokens that a chunk can contain.
", + "smithy.api#range": { + "min": 1 + }, + "smithy.api#required": {} + } + }, + "bufferSize": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The buffer size.
", + "smithy.api#range": { + "min": 0, + "max": 1 + }, + "smithy.api#required": {} + } + }, + "breakpointPercentileThreshold": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The dissimilarity threshold for splitting chunks.
", + "smithy.api#range": { + "min": 50, + "max": 99 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Settings for semantic document chunking for a data source. Semantic chunking splits\n a document into into smaller documents based on groups of similar content derived from the text\n with natural language processing.
\nWith semantic chunking, each sentence is compared to the next to determine how similar they are.\n You specify a threshold in the form of a percentile, where adjacent sentences that are less similar than\n that percentage of sentence pairs are divided into separate chunks. For example, if you set the threshold to \n 90, then the 10 percent of sentence pairs that are least similar are split. So if you have 101 sentences,\n 100 sentence pairs are compared, and the 10 with the least similarity are split, creating 11 chunks. These\n chunks are further split if they exceed the max token size.
\nYou must also specify a buffer size, which determines whether sentences are compared in isolation, or\n within a moving context window that includes the previous and following sentence. For example, if you set\n the buffer size to 1, the embedding for sentence 10 is derived from sentences 9, 10, and 11\n combined.
The Amazon Resource Name (ARN) of the KMS key used to encrypt the resource.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the configuration for server-side encryption.
" + } + }, + "com.amazonaws.bedrockagent#ServiceQuotaExceededException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.bedrockagent#NonBlankString" + } + }, + "traits": { + "smithy.api#documentation": "The number of requests exceeds the service quota. Resubmit your request later.
", + "smithy.api#error": "client", + "smithy.api#httpError": 402 + } + }, + "com.amazonaws.bedrockagent#SessionTTL": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 60, + "max": 3600 + } + } + }, + "com.amazonaws.bedrockagent#SharePointAuthType": { + "type": "enum", + "members": { + "OAUTH2_CLIENT_CREDENTIALS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OAUTH2_CLIENT_CREDENTIALS" + } + } + } + }, + "com.amazonaws.bedrockagent#SharePointCrawlerConfiguration": { + "type": "structure", + "members": { + "filterConfiguration": { + "target": "com.amazonaws.bedrockagent#CrawlFilterConfiguration", + "traits": { + "smithy.api#documentation": "The configuration of filtering the SharePoint content. For example, \n configuring regular expression patterns to include or exclude certain content.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration of the SharePoint content. For example, configuring \n specific types of SharePoint content.
" + } + }, + "com.amazonaws.bedrockagent#SharePointDataSourceConfiguration": { + "type": "structure", + "members": { + "sourceConfiguration": { + "target": "com.amazonaws.bedrockagent#SharePointSourceConfiguration", + "traits": { + "smithy.api#documentation": "The endpoint information to connect to your SharePoint data source.
", + "smithy.api#required": {} + } + }, + "crawlerConfiguration": { + "target": "com.amazonaws.bedrockagent#SharePointCrawlerConfiguration", + "traits": { + "smithy.api#documentation": "The configuration of the SharePoint content. For example, configuring \n specific types of SharePoint content.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration information to connect to SharePoint as your data source.
" + } + }, + "com.amazonaws.bedrockagent#SharePointDomain": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.bedrockagent#SharePointHostType": { + "type": "enum", + "members": { + "ONLINE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ONLINE" + } + } + } + }, + "com.amazonaws.bedrockagent#SharePointSiteUrls": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#HttpsUrl" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.bedrockagent#SharePointSourceConfiguration": { + "type": "structure", + "members": { + "tenantId": { + "target": "com.amazonaws.bedrockagent#Microsoft365TenantId", + "traits": { + "smithy.api#documentation": "The identifier of your Microsoft 365 tenant.
" + } + }, + "domain": { + "target": "com.amazonaws.bedrockagent#SharePointDomain", + "traits": { + "smithy.api#documentation": "The domain of your SharePoint instance or site URL/URLs.
", + "smithy.api#required": {} + } + }, + "siteUrls": { + "target": "com.amazonaws.bedrockagent#SharePointSiteUrls", + "traits": { + "smithy.api#documentation": "A list of one or more SharePoint site URLs.
", + "smithy.api#required": {} + } + }, + "hostType": { + "target": "com.amazonaws.bedrockagent#SharePointHostType", + "traits": { + "smithy.api#documentation": "The supported host type, whether online/cloud or server/on-premises.
", + "smithy.api#required": {} + } + }, + "authType": { + "target": "com.amazonaws.bedrockagent#SharePointAuthType", + "traits": { + "smithy.api#documentation": "The supported authentication type to authenticate and connect \n to your SharePoint site/sites.
", + "smithy.api#required": {} + } + }, + "credentialsSecretArn": { + "target": "com.amazonaws.bedrockagent#SecretArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name of an Secrets Manager secret that \n stores your authentication credentials for your SharePoint site/sites. \n For more information on the key-value pairs that must be included in \n your secret, depending on your authentication type, see \n SharePoint connection configuration.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The endpoint information to connect to your SharePoint data source.
" + } + }, + "com.amazonaws.bedrockagent#SortOrder": { + "type": "enum", + "members": { + "ASCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASCENDING" + } + }, + "DESCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DESCENDING" + } + } + } + }, + "com.amazonaws.bedrockagent#StartIngestionJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#StartIngestionJobRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#StartIngestionJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Begins an ingestion job, in which a data source is added to a knowledge base.
", + "smithy.api#http": { + "code": 202, + "method": "PUT", + "uri": "/knowledgebases/{knowledgeBaseId}/datasources/{dataSourceId}/ingestionjobs/" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#StartIngestionJobRequest": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the knowledge base to which to add the data source.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "dataSourceId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the data source to ingest.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagent#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
", + "smithy.api#idempotencyToken": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "A description of the ingestion job.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#StartIngestionJobResponse": { + "type": "structure", + "members": { + "ingestionJob": { + "target": "com.amazonaws.bedrockagent#IngestionJob", + "traits": { + "smithy.api#documentation": "An object containing information about the ingestion job.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#StepType": { + "type": "enum", + "members": { + "POST_CHUNKING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "POST_CHUNKING" + } + } + } + }, + "com.amazonaws.bedrockagent#StopSequences": { + "type": "list", + "member": { + "target": "smithy.api#String" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 4 + } + } + }, + "com.amazonaws.bedrockagent#StorageConfiguration": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseStorageType", + "traits": { + "smithy.api#documentation": "The vector store service in which the knowledge base is stored.
", + "smithy.api#required": {} + } + }, + "opensearchServerlessConfiguration": { + "target": "com.amazonaws.bedrockagent#OpenSearchServerlessConfiguration", + "traits": { + "smithy.api#documentation": "Contains the storage configuration of the knowledge base in Amazon OpenSearch Service.
" + } + }, + "pineconeConfiguration": { + "target": "com.amazonaws.bedrockagent#PineconeConfiguration", + "traits": { + "smithy.api#documentation": "Contains the storage configuration of the knowledge base in Pinecone.
" + } + }, + "redisEnterpriseCloudConfiguration": { + "target": "com.amazonaws.bedrockagent#RedisEnterpriseCloudConfiguration", + "traits": { + "smithy.api#documentation": "Contains the storage configuration of the knowledge base in Redis Enterprise Cloud.
" + } + }, + "rdsConfiguration": { + "target": "com.amazonaws.bedrockagent#RdsConfiguration", + "traits": { + "smithy.api#documentation": "Contains details about the storage configuration of the knowledge base in Amazon RDS. For more information, see Create a vector index in Amazon RDS.
" + } + }, + "mongoDbAtlasConfiguration": { + "target": "com.amazonaws.bedrockagent#MongoDbAtlasConfiguration", + "traits": { + "smithy.api#documentation": "Contains the storage configuration of the knowledge base in MongoDB Atlas.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the storage configuration of the knowledge base.
" + } + }, + "com.amazonaws.bedrockagent#StorageDays": { + "type": "integer", + "traits": { + "smithy.api#default": 30, + "smithy.api#range": { + "min": 0, + "max": 30 + } + } + }, + "com.amazonaws.bedrockagent#StorageFlowNodeConfiguration": { + "type": "structure", + "members": { + "serviceConfiguration": { + "target": "com.amazonaws.bedrockagent#StorageFlowNodeServiceConfiguration", + "traits": { + "smithy.api#documentation": "Contains configurations for the service to use for storing the input into the node.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configurations for a Storage node in a flow. This node stores the input in an Amazon S3 location that you specify.
" + } + }, + "com.amazonaws.bedrockagent#StorageFlowNodeS3Configuration": { + "type": "structure", + "members": { + "bucketName": { + "target": "com.amazonaws.bedrockagent#S3BucketName", + "traits": { + "smithy.api#documentation": "The name of the Amazon S3 bucket in which to store the input into the node.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configurations for the Amazon S3 location in which to store the input into the node.
" + } + }, + "com.amazonaws.bedrockagent#StorageFlowNodeServiceConfiguration": { + "type": "union", + "members": { + "s3": { + "target": "com.amazonaws.bedrockagent#StorageFlowNodeS3Configuration", + "traits": { + "smithy.api#documentation": "Contains configurations for the Amazon S3 location in which to store the input into the node.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configurations for the service to use for storing the input into the node.
" + } + }, + "com.amazonaws.bedrockagent#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\s._:/=+@-]*$" + } + }, + "com.amazonaws.bedrockagent#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.bedrockagent#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#TagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Associate tags with a resource. For more information, see Tagging resources in the Amazon Bedrock User Guide.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/tags/{resourceArn}" + } + } + }, + "com.amazonaws.bedrockagent#TagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.bedrockagent#TaggableResourcesArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource to tag.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.bedrockagent#TagsMap", + "traits": { + "smithy.api#documentation": "An object containing key-value pairs that define the tags to attach to the resource.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#TagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\s._:/=+@-]*$" + } + }, + "com.amazonaws.bedrockagent#TaggableResourcesArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 1011 + }, + "smithy.api#pattern": "(^arn:aws:bedrock:[a-zA-Z0-9-]+:/d{12}:(agent|agent-alias|knowledge-base|flow|prompt)/[A-Z0-9]{10}(?:/[A-Z0-9]{10})?$|^arn:aws:bedrock:[a-zA-Z0-9-]+:/d{12}:flow/([A-Z0-9]{10})/alias/([A-Z0-9]{10})$|^arn:aws:bedrock:[a-zA-Z0-9-]+:/d{12}:prompt/([A-Z0-9]{10})?(?::/d+)?$)" + } + }, + "com.amazonaws.bedrockagent#TaggingResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrockagent#ListTagsForResource" + }, + { + "target": "com.amazonaws.bedrockagent#TagResource" + }, + { + "target": "com.amazonaws.bedrockagent#UntagResource" + } + ] + }, + "com.amazonaws.bedrockagent#TagsMap": { + "type": "map", + "key": { + "target": "com.amazonaws.bedrockagent#TagKey" + }, + "value": { + "target": "com.amazonaws.bedrockagent#TagValue" + } + }, + "com.amazonaws.bedrockagent#Temperature": { + "type": "float", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.bedrockagent#TextPrompt": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200000 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagent#TextPromptTemplateConfiguration": { + "type": "structure", + "members": { + "text": { + "target": "com.amazonaws.bedrockagent#TextPrompt", + "traits": { + "smithy.api#documentation": "The message for the prompt.
", + "smithy.api#required": {} + } + }, + "inputVariables": { + "target": "com.amazonaws.bedrockagent#PromptInputVariablesList", + "traits": { + "smithy.api#documentation": "An array of the variables in the prompt template.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configurations for a text prompt template. To include a variable, enclose a word in double curly braces as in {{variable}}.
The number of requests exceeds the limit. Resubmit your request later.
", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, + "com.amazonaws.bedrockagent#TopK": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 500 + } + } + }, + "com.amazonaws.bedrockagent#TopP": { + "type": "float", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.bedrockagent#Transformation": { + "type": "structure", + "members": { + "transformationFunction": { + "target": "com.amazonaws.bedrockagent#TransformationFunction", + "traits": { + "smithy.api#documentation": "A Lambda function that processes documents.
", + "smithy.api#required": {} + } + }, + "stepToApply": { + "target": "com.amazonaws.bedrockagent#StepType", + "traits": { + "smithy.api#documentation": "When the service applies the transformation.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A custom processing step for documents moving through a data source ingestion pipeline. To\n process documents after they have been converted into chunks, set the step to apply to\n POST_CHUNKING.
The Lambda function.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A Lambda function that processes documents.
" + } + }, + "com.amazonaws.bedrockagent#TransformationLambdaConfiguration": { + "type": "structure", + "members": { + "lambdaArn": { + "target": "com.amazonaws.bedrockagent#LambdaArn", + "traits": { + "smithy.api#documentation": "The function's ARN identifier.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A Lambda function that processes documents.
" + } + }, + "com.amazonaws.bedrockagent#Transformations": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#Transformation" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.bedrockagent#Type": { + "type": "enum", + "members": { + "STRING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "string" + } + }, + "NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "number" + } + }, + "INTEGER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "integer" + } + }, + "BOOLEAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "boolean" + } + }, + "ARRAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "array" + } + } + } + }, + "com.amazonaws.bedrockagent#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Remove tags from a resource.
", + "smithy.api#http": { + "code": 200, + "method": "DELETE", + "uri": "/tags/{resourceArn}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrockagent#UntagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.bedrockagent#TaggableResourcesArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource from which to remove tags.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tagKeys": { + "target": "com.amazonaws.bedrockagent#TagKeyList", + "traits": { + "smithy.api#documentation": "A list of keys of the tags to remove from the resource.
", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#UntagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#UpdateAgent": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#UpdateAgentRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#UpdateAgentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates the configuration of an agent.
", + "smithy.api#http": { + "code": 202, + "method": "PUT", + "uri": "/agents/{agentId}/" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#UpdateAgentActionGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#UpdateAgentActionGroupRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#UpdateAgentActionGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates the configuration for an action group for an agent.
", + "smithy.api#http": { + "code": 200, + "method": "PUT", + "uri": "/agents/{agentId}/agentversions/{agentVersion}/actiongroups/{actionGroupId}/" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#UpdateAgentActionGroupRequest": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the agent for which to update the action group.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "agentVersion": { + "target": "com.amazonaws.bedrockagent#DraftVersion", + "traits": { + "smithy.api#documentation": "The unique identifier of the agent version for which to update the action group.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "actionGroupId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the action group.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "actionGroupName": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#documentation": "Specifies a new name for the action group.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "Specifies a new name for the action group.
" + } + }, + "parentActionGroupSignature": { + "target": "com.amazonaws.bedrockagent#ActionGroupSignature", + "traits": { + "smithy.api#documentation": "To allow your agent to request the user for additional information when trying to complete a task, set this field to AMAZON.UserInput. You must leave the description, apiSchema, and actionGroupExecutor fields blank for this action group.
During orchestration, if your agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an Observation reprompting the user for more information.
" + } + }, + "actionGroupExecutor": { + "target": "com.amazonaws.bedrockagent#ActionGroupExecutor", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.
" + } + }, + "actionGroupState": { + "target": "com.amazonaws.bedrockagent#ActionGroupState", + "traits": { + "smithy.api#documentation": "Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
" + } + }, + "apiSchema": { + "target": "com.amazonaws.bedrockagent#APISchema", + "traits": { + "smithy.api#documentation": "Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see Action group OpenAPI schemas.
" + } + }, + "functionSchema": { + "target": "com.amazonaws.bedrockagent#FunctionSchema", + "traits": { + "smithy.api#documentation": "Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#UpdateAgentActionGroupResponse": { + "type": "structure", + "members": { + "agentActionGroup": { + "target": "com.amazonaws.bedrockagent#AgentActionGroup", + "traits": { + "smithy.api#documentation": "Contains details about the action group that was updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#UpdateAgentAlias": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#UpdateAgentAliasRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#UpdateAgentAliasResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates configurations for an alias of an agent.
", + "smithy.api#http": { + "code": 202, + "method": "PUT", + "uri": "/agents/{agentId}/agentaliases/{agentAliasId}/" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#UpdateAgentAliasRequest": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the agent.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "agentAliasId": { + "target": "com.amazonaws.bedrockagent#AgentAliasId", + "traits": { + "smithy.api#documentation": "The unique identifier of the alias.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "agentAliasName": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#documentation": "Specifies a new name for the alias.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "Specifies a new description for the alias.
" + } + }, + "routingConfiguration": { + "target": "com.amazonaws.bedrockagent#AgentAliasRoutingConfiguration", + "traits": { + "smithy.api#documentation": "Contains details about the routing configuration of the alias.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#UpdateAgentAliasResponse": { + "type": "structure", + "members": { + "agentAlias": { + "target": "com.amazonaws.bedrockagent#AgentAlias", + "traits": { + "smithy.api#documentation": "Contains details about the alias that was updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#UpdateAgentKnowledgeBase": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#UpdateAgentKnowledgeBaseRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#UpdateAgentKnowledgeBaseResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates the configuration for a knowledge base that has been associated with an agent.
", + "smithy.api#http": { + "code": 200, + "method": "PUT", + "uri": "/agents/{agentId}/agentversions/{agentVersion}/knowledgebases/{knowledgeBaseId}/" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#UpdateAgentKnowledgeBaseRequest": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the agent associated with the knowledge base that you want to update.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "agentVersion": { + "target": "com.amazonaws.bedrockagent#DraftVersion", + "traits": { + "smithy.api#documentation": "The version of the agent associated with the knowledge base that you want to update.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the knowledge base that has been associated with an agent.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "Specifies a new description for the knowledge base associated with an agent.
" + } + }, + "knowledgeBaseState": { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseState", + "traits": { + "smithy.api#documentation": "Specifies whether the agent uses the knowledge base or not when sending an InvokeAgent request.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#UpdateAgentKnowledgeBaseResponse": { + "type": "structure", + "members": { + "agentKnowledgeBase": { + "target": "com.amazonaws.bedrockagent#AgentKnowledgeBase", + "traits": { + "smithy.api#documentation": "Contains details about the knowledge base that has been associated with an agent.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#UpdateAgentRequest": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the agent.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "agentName": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#documentation": "Specifies a new name for the agent.
", + "smithy.api#required": {} + } + }, + "instruction": { + "target": "com.amazonaws.bedrockagent#Instruction", + "traits": { + "smithy.api#documentation": "Specifies new instructions that tell the agent what it should do and how it should interact with users.
" + } + }, + "foundationModel": { + "target": "com.amazonaws.bedrockagent#ModelIdentifier", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Specifies a new foundation model to be used for orchestration by the agent.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "Specifies a new description of the agent.
" + } + }, + "idleSessionTTLInSeconds": { + "target": "com.amazonaws.bedrockagent#SessionTTL", + "traits": { + "smithy.api#documentation": "The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.
\nA user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.
" + } + }, + "agentResourceRoleArn": { + "target": "com.amazonaws.bedrockagent#AgentRoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.
", + "smithy.api#required": {} + } + }, + "customerEncryptionKeyArn": { + "target": "com.amazonaws.bedrockagent#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key with which to encrypt the agent.
" + } + }, + "promptOverrideConfiguration": { + "target": "com.amazonaws.bedrockagent#PromptOverrideConfiguration", + "traits": { + "smithy.api#documentation": "Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.
" + } + }, + "guardrailConfiguration": { + "target": "com.amazonaws.bedrockagent#GuardrailConfiguration", + "traits": { + "smithy.api#documentation": "The unique Guardrail configuration assigned to the agent when it is updated.
" + } + }, + "memoryConfiguration": { + "target": "com.amazonaws.bedrockagent#MemoryConfiguration", + "traits": { + "smithy.api#documentation": "Specifies the new memory configuration for the agent.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#UpdateAgentResponse": { + "type": "structure", + "members": { + "agent": { + "target": "com.amazonaws.bedrockagent#Agent", + "traits": { + "smithy.api#documentation": "Contains details about the agent that was updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#UpdateDataSource": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#UpdateDataSourceRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#UpdateDataSourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates the configurations for a data source connector.
\nYou can't change the chunkingConfiguration after you create the data source connector. Specify the existing chunkingConfiguration.
The unique identifier of the knowledge base for the data source.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "dataSourceId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the data source.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#documentation": "Specifies a new name for the data source.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "Specifies a new description for the data source.
" + } + }, + "dataSourceConfiguration": { + "target": "com.amazonaws.bedrockagent#DataSourceConfiguration", + "traits": { + "smithy.api#documentation": "The connection configuration for the data source that you want to update.
", + "smithy.api#required": {} + } + }, + "dataDeletionPolicy": { + "target": "com.amazonaws.bedrockagent#DataDeletionPolicy", + "traits": { + "smithy.api#documentation": "The data deletion policy for the data source that you want to update.
" + } + }, + "serverSideEncryptionConfiguration": { + "target": "com.amazonaws.bedrockagent#ServerSideEncryptionConfiguration", + "traits": { + "smithy.api#documentation": "Contains details about server-side encryption of the data source.
" + } + }, + "vectorIngestionConfiguration": { + "target": "com.amazonaws.bedrockagent#VectorIngestionConfiguration", + "traits": { + "smithy.api#documentation": "Contains details about how to ingest the documents in the data source.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#UpdateDataSourceResponse": { + "type": "structure", + "members": { + "dataSource": { + "target": "com.amazonaws.bedrockagent#DataSource", + "traits": { + "smithy.api#documentation": "Contains details about the data source.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#UpdateFlow": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#UpdateFlowRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#UpdateFlowResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Modifies a flow. Include both fields that you want to keep and fields that you want to change. For more information, see How it works and Create a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
", + "smithy.api#http": { + "code": 200, + "method": "PUT", + "uri": "/flows/{flowIdentifier}/" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#UpdateFlowAlias": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#UpdateFlowAliasRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#UpdateFlowAliasResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Modifies the alias of a flow. Include both fields that you want to keep and ones that you want to change. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
", + "smithy.api#http": { + "code": 200, + "method": "PUT", + "uri": "/flows/{flowIdentifier}/aliases/{aliasIdentifier}" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#UpdateFlowAliasRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#documentation": "The name of the alias.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "A description for the alias.
" + } + }, + "routingConfiguration": { + "target": "com.amazonaws.bedrockagent#FlowAliasRoutingConfiguration", + "traits": { + "smithy.api#documentation": "Contains information about the version to which to map the alias.
", + "smithy.api#required": {} + } + }, + "flowIdentifier": { + "target": "com.amazonaws.bedrockagent#FlowIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the flow.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "aliasIdentifier": { + "target": "com.amazonaws.bedrockagent#FlowAliasIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the alias.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#UpdateFlowAliasResponse": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#documentation": "The name of the alias.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "The description of the flow.
" + } + }, + "routingConfiguration": { + "target": "com.amazonaws.bedrockagent#FlowAliasRoutingConfiguration", + "traits": { + "smithy.api#documentation": "Contains information about the version that the alias is mapped to.
", + "smithy.api#required": {} + } + }, + "flowId": { + "target": "com.amazonaws.bedrockagent#FlowId", + "traits": { + "smithy.api#documentation": "The unique identifier of the flow.
", + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.bedrockagent#FlowAliasId", + "traits": { + "smithy.api#documentation": "The unique identifier of the alias.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.bedrockagent#FlowAliasArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the flow.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the flow was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the alias was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#UpdateFlowRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagent#FlowName", + "traits": { + "smithy.api#documentation": "A name for the flow.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#FlowDescription", + "traits": { + "smithy.api#documentation": "A description for the flow.
" + } + }, + "executionRoleArn": { + "target": "com.amazonaws.bedrockagent#FlowExecutionRoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the service role with permissions to create and manage a flow. For more information, see Create a service role for flows in Amazon Bedrock in the Amazon Bedrock User Guide.
", + "smithy.api#required": {} + } + }, + "customerEncryptionKeyArn": { + "target": "com.amazonaws.bedrockagent#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key to encrypt the flow.
" + } + }, + "definition": { + "target": "com.amazonaws.bedrockagent#FlowDefinition", + "traits": { + "smithy.api#documentation": "A definition of the nodes and the connections between the nodes in the flow.
" + } + }, + "flowIdentifier": { + "target": "com.amazonaws.bedrockagent#FlowIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the flow.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#UpdateFlowResponse": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagent#FlowName", + "traits": { + "smithy.api#documentation": "The name of the flow.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#FlowDescription", + "traits": { + "smithy.api#documentation": "The description of the flow.
" + } + }, + "executionRoleArn": { + "target": "com.amazonaws.bedrockagent#FlowExecutionRoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the service role with permissions to create a flow. For more information, see Create a service role for flows in Amazon Bedrock in the Amazon Bedrock User Guide.
", + "smithy.api#required": {} + } + }, + "customerEncryptionKeyArn": { + "target": "com.amazonaws.bedrockagent#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key that the flow was encrypted with.
" + } + }, + "id": { + "target": "com.amazonaws.bedrockagent#FlowId", + "traits": { + "smithy.api#documentation": "The unique identifier of the flow.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.bedrockagent#FlowArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the flow.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagent#FlowStatus", + "traits": { + "smithy.api#documentation": "The status of the flow. When you submit this request, the status will be NotPrepared. If updating fails, the status becomes Failed.
The time at which the flow was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the flow was last updated.
", + "smithy.api#required": {} + } + }, + "version": { + "target": "com.amazonaws.bedrockagent#DraftVersion", + "traits": { + "smithy.api#documentation": "The version of the flow. When you update a flow, the version updated is the DRAFT version.
A definition of the nodes and the connections between nodes in the flow.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#UpdateKnowledgeBase": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#UpdateKnowledgeBaseRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#UpdateKnowledgeBaseResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates the configuration of a knowledge base with the fields that you specify. Because all fields will be overwritten, you must include the same values for fields that you want to keep the same.
\nYou can change the following fields:
\n\n name\n
\n description\n
\n roleArn\n
You can't change the knowledgeBaseConfiguration or storageConfiguration fields, so you must specify the same configurations as when you created the knowledge base. You can send a GetKnowledgeBase request and copy the same configurations.
The unique identifier of the knowledge base to update.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#documentation": "Specifies a new name for the knowledge base.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "Specifies a new description for the knowledge base.
" + } + }, + "roleArn": { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseRoleArn", + "traits": { + "smithy.api#documentation": "Specifies a different Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.
", + "smithy.api#required": {} + } + }, + "knowledgeBaseConfiguration": { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseConfiguration", + "traits": { + "smithy.api#documentation": "Specifies the configuration for the embeddings model used for the knowledge base. You must use the same configuration as when the knowledge base was created.
", + "smithy.api#required": {} + } + }, + "storageConfiguration": { + "target": "com.amazonaws.bedrockagent#StorageConfiguration", + "traits": { + "smithy.api#documentation": "Specifies the configuration for the vector store used for the knowledge base. You must use the same configuration as when the knowledge base was created.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#UpdateKnowledgeBaseResponse": { + "type": "structure", + "members": { + "knowledgeBase": { + "target": "com.amazonaws.bedrockagent#KnowledgeBase", + "traits": { + "smithy.api#documentation": "Contains details about the knowledge base.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#UpdatePrompt": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#UpdatePromptRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#UpdatePromptResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Modifies a prompt in your prompt library. Include both fields that you want to keep and fields that you want to replace. For more information, see Prompt management in Amazon Bedrock and Edit prompts in your prompt library in the Amazon Bedrock User Guide.
", + "smithy.api#http": { + "code": 200, + "method": "PUT", + "uri": "/prompts/{promptIdentifier}/" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#UpdatePromptRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagent#PromptName", + "traits": { + "smithy.api#documentation": "A name for the prompt.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#PromptDescription", + "traits": { + "smithy.api#documentation": "A description for the prompt.
" + } + }, + "customerEncryptionKeyArn": { + "target": "com.amazonaws.bedrockagent#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key to encrypt the prompt.
" + } + }, + "defaultVariant": { + "target": "com.amazonaws.bedrockagent#PromptVariantName", + "traits": { + "smithy.api#documentation": "The name of the default variant for the prompt. This value must match the name field in the relevant PromptVariant object.
A list of objects, each containing details about a variant of the prompt.
" + } + }, + "promptIdentifier": { + "target": "com.amazonaws.bedrockagent#PromptIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the prompt.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#UpdatePromptResponse": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagent#PromptName", + "traits": { + "smithy.api#documentation": "The name of the prompt.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#PromptDescription", + "traits": { + "smithy.api#documentation": "The description of the prompt.
" + } + }, + "customerEncryptionKeyArn": { + "target": "com.amazonaws.bedrockagent#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key to encrypt the prompt.
" + } + }, + "defaultVariant": { + "target": "com.amazonaws.bedrockagent#PromptVariantName", + "traits": { + "smithy.api#documentation": "The name of the default variant for the prompt. This value must match the name field in the relevant PromptVariant object.
A list of objects, each containing details about a variant of the prompt.
" + } + }, + "id": { + "target": "com.amazonaws.bedrockagent#PromptId", + "traits": { + "smithy.api#documentation": "The unique identifier of the prompt.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.bedrockagent#PromptArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the prompt.
", + "smithy.api#required": {} + } + }, + "version": { + "target": "com.amazonaws.bedrockagent#Version", + "traits": { + "smithy.api#documentation": "The version of the prompt. When you update a prompt, the version updated is the DRAFT version.
The time at which the prompt was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the prompt was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#Url": { + "type": "string", + "traits": { + "smithy.api#pattern": "^https?://[A-Za-z0-9][^\\s]*$" + } + }, + "com.amazonaws.bedrockagent#UrlConfiguration": { + "type": "structure", + "members": { + "seedUrls": { + "target": "com.amazonaws.bedrockagent#SeedUrls", + "traits": { + "smithy.api#documentation": "One or more seed or starting point URLs.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration of web URLs that you want to crawl. \n You should be authorized to crawl the URLs.
" + } + }, + "com.amazonaws.bedrockagent#ValidationException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.bedrockagent#NonBlankString" + }, + "fieldList": { + "target": "com.amazonaws.bedrockagent#ValidationExceptionFieldList", + "traits": { + "smithy.api#documentation": "A list of objects containing fields that caused validation errors and their corresponding validation error messages.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Input validation failed. Check your request parameters and retry the request.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.bedrockagent#ValidationExceptionField": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagent#NonBlankString", + "traits": { + "smithy.api#documentation": "The name of the field.
", + "smithy.api#required": {} + } + }, + "message": { + "target": "com.amazonaws.bedrockagent#NonBlankString", + "traits": { + "smithy.api#documentation": "A message describing why this field failed validation.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Stores information about a field passed inside a request that resulted in an validation error.
" + } + }, + "com.amazonaws.bedrockagent#ValidationExceptionFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#ValidationExceptionField" + } + }, + "com.amazonaws.bedrockagent#VectorIngestionConfiguration": { + "type": "structure", + "members": { + "chunkingConfiguration": { + "target": "com.amazonaws.bedrockagent#ChunkingConfiguration", + "traits": { + "smithy.api#documentation": "Details about how to chunk the documents in the data source. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried.
" + } + }, + "customTransformationConfiguration": { + "target": "com.amazonaws.bedrockagent#CustomTransformationConfiguration", + "traits": { + "smithy.api#documentation": "A custom document transformer for parsed data source documents.
" + } + }, + "parsingConfiguration": { + "target": "com.amazonaws.bedrockagent#ParsingConfiguration", + "traits": { + "smithy.api#documentation": "A custom parser for data source documents.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about how to ingest the documents in a data source.
" + } + }, + "com.amazonaws.bedrockagent#VectorKnowledgeBaseConfiguration": { + "type": "structure", + "members": { + "embeddingModelArn": { + "target": "com.amazonaws.bedrockagent#BedrockEmbeddingModelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model used to create vector embeddings for the knowledge base.
", + "smithy.api#required": {} + } + }, + "embeddingModelConfiguration": { + "target": "com.amazonaws.bedrockagent#EmbeddingModelConfiguration", + "traits": { + "smithy.api#documentation": "The embeddings model configuration details for the vector model used in Knowledge Base.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about the model used to create vector embeddings for the knowledge base.
" + } + }, + "com.amazonaws.bedrockagent#Version": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + }, + "smithy.api#pattern": "^(DRAFT|[0-9]{0,4}[1-9][0-9]{0,4})$" + } + }, + "com.amazonaws.bedrockagent#VersionResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrockagent#DeleteAgentVersion" + }, + { + "target": "com.amazonaws.bedrockagent#GetAgentVersion" + }, + { + "target": "com.amazonaws.bedrockagent#ListAgentVersions" + } + ] + }, + "com.amazonaws.bedrockagent#WebCrawlerConfiguration": { + "type": "structure", + "members": { + "crawlerLimits": { + "target": "com.amazonaws.bedrockagent#WebCrawlerLimits", + "traits": { + "smithy.api#documentation": "The configuration of crawl limits for the web URLs.
" + } + }, + "inclusionFilters": { + "target": "com.amazonaws.bedrockagent#FilterList", + "traits": { + "smithy.api#documentation": "A list of one or more inclusion regular expression patterns to include \n certain URLs. If you specify an inclusion and exclusion filter/pattern \n and both match a URL, the exclusion filter takes precedence and the web \n content of the URL isn’t crawled.
" + } + }, + "exclusionFilters": { + "target": "com.amazonaws.bedrockagent#FilterList", + "traits": { + "smithy.api#documentation": "A list of one or more exclusion regular expression patterns to exclude \n certain URLs. If you specify an inclusion and exclusion filter/pattern \n and both match a URL, the exclusion filter takes precedence and the web \n content of the URL isn’t crawled.
" + } + }, + "scope": { + "target": "com.amazonaws.bedrockagent#WebScopeType", + "traits": { + "smithy.api#documentation": "The scope of what is crawled for your URLs.
\nYou can choose to crawl only web pages that belong to the same host or primary \n domain. For example, only web pages that contain the seed URL \n \"https://docs.aws.amazon.com/bedrock/latest/userguide/\" and no other domains. \n You can choose to include sub domains in addition to the host or primary domain. \n For example, web pages that contain \"aws.amazon.com\" can also include sub domain \n \"docs.aws.amazon.com\".
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration of web URLs that you want to crawl. \n You should be authorized to crawl the URLs.
" + } + }, + "com.amazonaws.bedrockagent#WebCrawlerLimits": { + "type": "structure", + "members": { + "rateLimit": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The max rate at which pages are crawled, up to 300 per minute per host.
", + "smithy.api#range": { + "min": 1, + "max": 300 + } + } + } + }, + "traits": { + "smithy.api#documentation": "The rate limits for the URLs that you want to crawl. \n You should be authorized to crawl the URLs.
" + } + }, + "com.amazonaws.bedrockagent#WebDataSourceConfiguration": { + "type": "structure", + "members": { + "sourceConfiguration": { + "target": "com.amazonaws.bedrockagent#WebSourceConfiguration", + "traits": { + "smithy.api#documentation": "The source configuration details for the web data source.
", + "smithy.api#required": {} + } + }, + "crawlerConfiguration": { + "target": "com.amazonaws.bedrockagent#WebCrawlerConfiguration", + "traits": { + "smithy.api#documentation": "The Web Crawler configuration details for the web data source.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration details for the web data source.
" + } + }, + "com.amazonaws.bedrockagent#WebScopeType": { + "type": "enum", + "members": { + "HOST_ONLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HOST_ONLY" + } + }, + "SUBDOMAINS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUBDOMAINS" + } + } + } + }, + "com.amazonaws.bedrockagent#WebSourceConfiguration": { + "type": "structure", + "members": { + "urlConfiguration": { + "target": "com.amazonaws.bedrockagent#UrlConfiguration", + "traits": { + "smithy.api#documentation": "The configuration of the URL/URLs.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration of the URL/URLs for the web content that you want \n to crawl. You should be authorized to crawl the URLs.
" + } } - }, - "traits": { - "smithy.api#documentation": "The configuration of the URL/URLs for the web content that you want \n to crawl. You should be authorized to crawl the URLs.
" - } } - } -} +} \ No newline at end of file diff --git a/codegen/sdk-codegen/aws-models/cloudwatch-logs.json b/codegen/sdk-codegen/aws-models/cloudwatch-logs.json index 59e08ef2a1ed..e512433e3a87 100644 --- a/codegen/sdk-codegen/aws-models/cloudwatch-logs.json +++ b/codegen/sdk-codegen/aws-models/cloudwatch-logs.json @@ -1,9568 +1,10018 @@ { - "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.cloudwatchlogs#AccessDeniedException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.cloudwatchlogs#Message" - } - }, - "traits": { - "smithy.api#documentation": "You don't have sufficient permissions to perform this action.
", - "smithy.api#error": "client" - } - }, - "com.amazonaws.cloudwatchlogs#AccessPolicy": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.cloudwatchlogs#AccountId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 12, - "max": 12 - }, - "smithy.api#pattern": "^\\d{12}$" - } - }, - "com.amazonaws.cloudwatchlogs#AccountIds": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudwatchlogs#AccountId" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 20 - } - } - }, - "com.amazonaws.cloudwatchlogs#AccountPolicies": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudwatchlogs#AccountPolicy" - } - }, - "com.amazonaws.cloudwatchlogs#AccountPolicy": { - "type": "structure", - "members": { - "policyName": { - "target": "com.amazonaws.cloudwatchlogs#PolicyName", - "traits": { - "smithy.api#documentation": "The name of the account policy.
" - } - }, - "policyDocument": { - "target": "com.amazonaws.cloudwatchlogs#AccountPolicyDocument", - "traits": { - "smithy.api#documentation": "The policy document for this account policy.
\nThe JSON specified in policyDocument can be up to 30,720 characters.
The date and time that this policy was most recently updated.
" - } - }, - "policyType": { - "target": "com.amazonaws.cloudwatchlogs#PolicyType", - "traits": { - "smithy.api#documentation": "The type of policy for this account policy.
" - } - }, - "scope": { - "target": "com.amazonaws.cloudwatchlogs#Scope", - "traits": { - "smithy.api#documentation": "The scope of the account policy.
" - } - }, - "selectionCriteria": { - "target": "com.amazonaws.cloudwatchlogs#SelectionCriteria", - "traits": { - "smithy.api#documentation": "The log group selection criteria for this subscription filter policy.
" - } - }, - "accountId": { - "target": "com.amazonaws.cloudwatchlogs#AccountId", - "traits": { - "smithy.api#documentation": "The Amazon Web Services account ID that the policy applies to.
" - } - } - }, - "traits": { - "smithy.api#documentation": "A structure that contains information about one CloudWatch Logs account policy.
" - } - }, - "com.amazonaws.cloudwatchlogs#AccountPolicyDocument": { - "type": "string" - }, - "com.amazonaws.cloudwatchlogs#AmazonResourceName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1011 - }, - "smithy.api#pattern": "^[\\w+=/:,.@-]*$" - } - }, - "com.amazonaws.cloudwatchlogs#Anomalies": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudwatchlogs#Anomaly" - } - }, - "com.amazonaws.cloudwatchlogs#Anomaly": { - "type": "structure", - "members": { - "anomalyId": { - "target": "com.amazonaws.cloudwatchlogs#AnomalyId", - "traits": { - "smithy.api#documentation": "The unique ID that CloudWatch Logs assigned to this anomaly.
", - "smithy.api#required": {} - } - }, - "patternId": { - "target": "com.amazonaws.cloudwatchlogs#PatternId", - "traits": { - "smithy.api#documentation": "The ID of the pattern used to help identify this anomaly.
", - "smithy.api#required": {} - } - }, - "anomalyDetectorArn": { - "target": "com.amazonaws.cloudwatchlogs#AnomalyDetectorArn", - "traits": { - "smithy.api#documentation": "The ARN of the anomaly detector that identified this anomaly.
", - "smithy.api#required": {} - } - }, - "patternString": { - "target": "com.amazonaws.cloudwatchlogs#PatternString", - "traits": { - "smithy.api#documentation": "The pattern used to help identify this anomaly, in string format.
", - "smithy.api#required": {} - } - }, - "patternRegex": { - "target": "com.amazonaws.cloudwatchlogs#PatternRegex", - "traits": { - "smithy.api#documentation": "The pattern used to help identify this anomaly, in regular expression format.
" - } - }, - "priority": { - "target": "com.amazonaws.cloudwatchlogs#Priority", - "traits": { - "smithy.api#documentation": "The priority level of this anomaly, as determined by CloudWatch Logs. Priority is computed based on log \n severity labels such as FATAL and ERROR and the amount of deviation from the baseline.\n Possible values are\n HIGH, MEDIUM, and LOW.
The date and time when the anomaly detector first saw this anomaly. \n It is specified as epoch time, which is the number of seconds\n since January 1, 1970, 00:00:00 UTC.
The date and time when the anomaly detector most recently saw this anomaly. \n It is specified as epoch time, which is the number of seconds\n since January 1, 1970, 00:00:00 UTC.
A human-readable description of the anomaly. This description is generated by\n CloudWatch Logs.
", - "smithy.api#required": {} - } - }, - "active": { - "target": "com.amazonaws.cloudwatchlogs#Boolean", - "traits": { - "smithy.api#documentation": "Specifies whether this anomaly is still ongoing.
", - "smithy.api#required": {} - } - }, - "state": { - "target": "com.amazonaws.cloudwatchlogs#State", - "traits": { - "smithy.api#documentation": "Indicates the current state of this anomaly. If it is still being treated as an anomaly, the value\n is Active. If you have suppressed this anomaly by using the UpdateAnomaly operation,\n the value is Suppressed. If this behavior is now considered to be normal, the value\n is Baseline.
A map showing times when the anomaly detector ran, and the number of occurrences of this anomaly that \n were detected at each of those runs. The times are specified in epoch time, which is the number of seconds\n since January 1, 1970, 00:00:00 UTC.
An array of sample log event messages that are considered to be part of this anomaly.
", - "smithy.api#required": {} - } - }, - "patternTokens": { - "target": "com.amazonaws.cloudwatchlogs#PatternTokens", - "traits": { - "smithy.api#documentation": "An array of structures where each structure contains information about one token that makes up the pattern.
", - "smithy.api#required": {} - } - }, - "logGroupArnList": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupArnList", - "traits": { - "smithy.api#documentation": "An array of ARNS of the log groups that contained log events considered to be part of this anomaly.
", - "smithy.api#required": {} - } - }, - "suppressed": { - "target": "com.amazonaws.cloudwatchlogs#Boolean", - "traits": { - "smithy.api#documentation": "Indicates whether this anomaly is currently suppressed. To suppress an anomaly, \n use UpdateAnomaly.
" - } - }, - "suppressedDate": { - "target": "com.amazonaws.cloudwatchlogs#EpochMillis", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "If the anomaly is suppressed, this indicates when it was suppressed.
" - } - }, - "suppressedUntil": { - "target": "com.amazonaws.cloudwatchlogs#EpochMillis", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "If the anomaly is suppressed, this indicates when the suppression will end. If this value is 0, \n the anomaly was suppressed with no expiration, with the INFINITE value.
If this anomaly is suppressed, this field is true if the suppression is because the \n pattern is suppressed. If false, then only this particular anomaly is suppressed.
This structure represents one anomaly that has been found by a logs anomaly detector.
\nFor more information about patterns and anomalies, see CreateLogAnomalyDetector.\n
" - } - }, - "com.amazonaws.cloudwatchlogs#AnomalyDetector": { - "type": "structure", - "members": { - "anomalyDetectorArn": { - "target": "com.amazonaws.cloudwatchlogs#AnomalyDetectorArn", - "traits": { - "smithy.api#documentation": "The ARN of the anomaly detector.
" - } - }, - "detectorName": { - "target": "com.amazonaws.cloudwatchlogs#DetectorName", - "traits": { - "smithy.api#documentation": "The name of the anomaly detector.
" - } - }, - "logGroupArnList": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupArnList", - "traits": { - "smithy.api#documentation": "A list of the ARNs of the log groups that this anomaly detector watches.
" - } - }, - "evaluationFrequency": { - "target": "com.amazonaws.cloudwatchlogs#EvaluationFrequency", - "traits": { - "smithy.api#documentation": "Specifies how often the anomaly detector runs and look for anomalies.
" - } - }, - "filterPattern": { - "target": "com.amazonaws.cloudwatchlogs#FilterPattern" - }, - "anomalyDetectorStatus": { - "target": "com.amazonaws.cloudwatchlogs#AnomalyDetectorStatus", - "traits": { - "smithy.api#documentation": "Specifies the current status of the anomaly detector. To pause an anomaly detector, use\n the enabled parameter in the UpdateLogAnomalyDetector \n operation.
The ID of the KMS key assigned to this anomaly detector, if any.
" - } - }, - "creationTimeStamp": { - "target": "com.amazonaws.cloudwatchlogs#EpochMillis", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The date and time when this anomaly detector was created.
" - } - }, - "lastModifiedTimeStamp": { - "target": "com.amazonaws.cloudwatchlogs#EpochMillis", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The date and time when this anomaly detector was most recently modified.
" - } - }, - "anomalyVisibilityTime": { - "target": "com.amazonaws.cloudwatchlogs#AnomalyVisibilityTime", - "traits": { - "smithy.api#documentation": "The number of days used as the life cycle of anomalies. After this time, anomalies are automatically baselined \n and the anomaly detector model will treat new occurrences of similar event as normal.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about one anomaly detector in the account.
" - } - }, - "com.amazonaws.cloudwatchlogs#AnomalyDetectorArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1 - }, - "smithy.api#pattern": "^[\\w#+=/:,.@-]*$" - } - }, - "com.amazonaws.cloudwatchlogs#AnomalyDetectorStatus": { - "type": "enum", - "members": { - "INITIALIZING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INITIALIZING" - } - }, - "TRAINING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TRAINING" - } - }, - "ANALYZING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ANALYZING" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - }, - "DELETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETED" - } - }, - "PAUSED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PAUSED" - } - } - } - }, - "com.amazonaws.cloudwatchlogs#AnomalyDetectors": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudwatchlogs#AnomalyDetector" - } - }, - "com.amazonaws.cloudwatchlogs#AnomalyId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 36, - "max": 36 - } - } - }, - "com.amazonaws.cloudwatchlogs#AnomalyVisibilityTime": { - "type": "long", - "traits": { - "smithy.api#range": { - "min": 7, - "max": 90 - } - } - }, - "com.amazonaws.cloudwatchlogs#Arn": { - "type": "string" - }, - "com.amazonaws.cloudwatchlogs#AssociateKmsKey": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#AssociateKmsKeyRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "Associates the specified KMS key with either one log group in the account, or with all stored\n CloudWatch Logs query insights results in the account.
\nWhen you use AssociateKmsKey, you specify either the logGroupName parameter\n or the resourceIdentifier parameter. You can't specify both of those parameters in the same operation.
Specify the logGroupName parameter to cause all log events stored in the log group to\n be encrypted with that key. Only the log events ingested after the key is associated are encrypted with that key.
Associating a KMS key with a log group overrides any existing\n associations between the log group and a KMS key. After a KMS key is associated with a log group, all newly ingested data for the log group is encrypted\n using the KMS key. This association is stored as long as the data encrypted\n with the KMS key is still within CloudWatch Logs. This enables CloudWatch Logs to decrypt this data whenever it is requested.
\nAssociating\n a key with a log group does not cause the results of queries of that log group to be encrypted with that key. To have query\n results encrypted with a KMS key, you must use an AssociateKmsKey operation with the resourceIdentifier\n parameter that specifies a query-result resource.
Specify the resourceIdentifier parameter with a query-result resource, \n to use that key to encrypt the stored results of all future \n StartQuery\n operations in the account. The response from a \n GetQueryResults\n operation will still return\n the query results in plain text.
Even if you have not associated a key with your query results, the query results are encrypted when stored,\n using the default CloudWatch Logs method.
\nIf you run a query from a monitoring account that queries logs in a source account, the\n query results key from the monitoring account, if any, is used.
\nIf you delete the key that is used to encrypt log events or log group query results,\n then all the associated stored log events or query results that were encrypted with that key \n will be unencryptable and unusable.
\nCloudWatch Logs supports only symmetric KMS keys. Do not use an associate\n an asymmetric KMS key with your log group or query results. For more information, see Using\n Symmetric and Asymmetric Keys.
\nIt can take up to 5 minutes for this operation to take effect.
\nIf you attempt to associate a KMS key with a log group but the KMS key does not exist or the KMS key is disabled, you receive an\n InvalidParameterException error.
The name of the log group.
\nIn your AssociateKmsKey operation,\n you must specify either the resourceIdentifier parameter or the logGroup parameter, \n but you can't specify both.
The Amazon Resource Name (ARN) of the KMS key to use when encrypting log\n data. This must be a symmetric KMS key. For more information, see Amazon Resource Names and Using Symmetric and Asymmetric\n Keys.
", - "smithy.api#required": {} - } - }, - "resourceIdentifier": { - "target": "com.amazonaws.cloudwatchlogs#ResourceIdentifier", - "traits": { - "smithy.api#documentation": "Specifies the target for this operation. You must specify one of the following:
\nSpecify the following ARN to have future GetQueryResults\n operations in this account encrypt the results\n with the specified KMS key. Replace\n REGION and ACCOUNT_ID with your Region and account ID.
\n\n arn:aws:logs:REGION:ACCOUNT_ID:query-result:*\n
Specify the ARN of a log group to have CloudWatch Logs use the KMS key\n to encrypt log events that are ingested and stored by that log group. The log group ARN must be in \n the following format. Replace\n REGION and ACCOUNT_ID with your Region and account ID.
\n\n arn:aws:logs:REGION:ACCOUNT_ID:log-group:LOG_GROUP_NAME\n \n
In your AssociateKmsKey operation,\n you must specify either the resourceIdentifier parameter or the logGroup parameter, \n but you can't specify both.
Cancels the specified export task.
\nThe task must be in the PENDING or RUNNING state.
The ID of the export task.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#ClientToken": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 36, - "max": 128 - }, - "smithy.api#pattern": "^\\S{36,128}$" - } - }, - "com.amazonaws.cloudwatchlogs#ConflictException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.cloudwatchlogs#Message" - } - }, - "traits": { - "smithy.api#documentation": "This operation attempted to create a resource that already exists.
", - "smithy.api#error": "client" - } - }, - "com.amazonaws.cloudwatchlogs#Count": { - "type": "long", - "traits": { - "smithy.api#default": 0 - } - }, - "com.amazonaws.cloudwatchlogs#CreateDelivery": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#CreateDeliveryRequest" - }, - "output": { - "target": "com.amazonaws.cloudwatchlogs#CreateDeliveryResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#AccessDeniedException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ConflictException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ThrottlingException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Creates a delivery. A delivery is a connection between a logical delivery source and a logical\n delivery destination\n that you have already created.
\nOnly some Amazon Web Services services support being configured as a delivery source using this operation. These services are listed\n as Supported [V2 Permissions] in the table at \n Enabling \n logging from Amazon Web Services services.\n
\nA delivery destination can represent a log group in CloudWatch Logs, an Amazon S3 bucket, or a delivery stream in Firehose.
\nTo configure logs delivery between a supported Amazon Web Services service and a destination, you must do the following:
\nCreate a delivery source, which is a logical object that represents the resource that is actually\n sending the logs. For more \n information, see PutDeliverySource.
\nCreate a delivery destination, which is a logical object that represents the actual\n delivery destination. For more \n information, see PutDeliveryDestination.
\nIf you are delivering logs cross-account, you must use \n PutDeliveryDestinationPolicy\n in the destination account to assign an IAM policy to the \n destination. This policy allows delivery to that destination.\n
\nUse CreateDelivery to create a delivery by pairing exactly one delivery source and one delivery destination.\n
You can configure a single delivery source to send logs to multiple destinations by creating multiple deliveries. You \n can also create multiple deliveries to configure multiple delivery sources to send logs to the same delivery destination.
\nYou can't update an existing delivery. You can only create and delete deliveries.
" - } - }, - "com.amazonaws.cloudwatchlogs#CreateDeliveryRequest": { - "type": "structure", - "members": { - "deliverySourceName": { - "target": "com.amazonaws.cloudwatchlogs#DeliverySourceName", - "traits": { - "smithy.api#documentation": "The name of the delivery source to use for this delivery.
", - "smithy.api#required": {} - } - }, - "deliveryDestinationArn": { - "target": "com.amazonaws.cloudwatchlogs#Arn", - "traits": { - "smithy.api#documentation": "The ARN of the delivery destination to use for this delivery.
", - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.cloudwatchlogs#Tags", - "traits": { - "smithy.api#documentation": "An optional list of key-value pairs to associate with the resource.
\nFor more information about tagging, see \n Tagging Amazon Web Services resources\n
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#CreateDeliveryResponse": { - "type": "structure", - "members": { - "delivery": { - "target": "com.amazonaws.cloudwatchlogs#Delivery", - "traits": { - "smithy.api#documentation": "A structure that contains information about the delivery that you just created.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudwatchlogs#CreateExportTask": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#CreateExportTaskRequest" - }, - "output": { - "target": "com.amazonaws.cloudwatchlogs#CreateExportTaskResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#LimitExceededException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceAlreadyExistsException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "Creates an export task so that you can efficiently export data from a log group to an\n Amazon S3 bucket. When you perform a CreateExportTask operation, you must use\n credentials that have permission to write to the S3 bucket that you specify as the\n destination.
Exporting log data to S3 buckets that are encrypted by KMS is supported.\n Exporting log data to Amazon S3 buckets that have S3 Object Lock enabled with a\n retention period is also supported.
\nExporting to S3 buckets that are encrypted with AES-256 is supported.
\nThis is an asynchronous call. If all the required information is provided, this \n operation initiates an export task and responds with the ID of the task. After the task has started,\n you can use DescribeExportTasks to get the status of the export task. Each account can\n only have one active (RUNNING or PENDING) export task at a time.\n To cancel an export task, use CancelExportTask.
You can export logs from multiple log groups or multiple time ranges to the same S3\n bucket. To separate log data for each export task, specify a prefix to be used as the Amazon\n S3 key prefix for all exported objects.
\nTime-based sorting on chunks of log data inside an exported file is not guaranteed. You can\n sort the exported log field data by using Linux utilities.
\nThe name of the export task.
" - } - }, - "logGroupName": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupName", - "traits": { - "smithy.api#documentation": "The name of the log group.
", - "smithy.api#required": {} - } - }, - "logStreamNamePrefix": { - "target": "com.amazonaws.cloudwatchlogs#LogStreamName", - "traits": { - "smithy.api#documentation": "Export only log streams that match the provided prefix. If you don't\n specify a value, no prefix filter is applied.
" - } - }, - "from": { - "target": "com.amazonaws.cloudwatchlogs#Timestamp", - "traits": { - "smithy.api#documentation": "The start time of the range for the request, expressed as the number of milliseconds\n after Jan 1, 1970 00:00:00 UTC. Events with a timestamp earlier than this time\n are not exported.
The end time of the range for the request, expressed as the number of milliseconds\n after Jan 1, 1970 00:00:00 UTC. Events with a timestamp later than this time are\n not exported.
You must specify a time that is not earlier than when this log group was created.
", - "smithy.api#required": {} - } - }, - "destination": { - "target": "com.amazonaws.cloudwatchlogs#ExportDestinationBucket", - "traits": { - "smithy.api#documentation": "The name of S3 bucket for the exported log data. The bucket must be in the same Amazon Web Services Region.
", - "smithy.api#required": {} - } - }, - "destinationPrefix": { - "target": "com.amazonaws.cloudwatchlogs#ExportDestinationPrefix", - "traits": { - "smithy.api#documentation": "The prefix used as the start of the key for every object exported. If you don't\n specify a value, the default is exportedlogs.
The ID of the export task.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudwatchlogs#CreateLogAnomalyDetector": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#CreateLogAnomalyDetectorRequest" - }, - "output": { - "target": "com.amazonaws.cloudwatchlogs#CreateLogAnomalyDetectorResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#LimitExceededException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "Creates an anomaly detector that regularly scans one or more \n log groups and look for patterns\n and anomalies in the logs.
\nAn anomaly detector can help surface issues by automatically discovering anomalies in your log event traffic. \n An anomaly detector uses machine learning algorithms to scan log events and find patterns.\n \n A pattern is a shared text structure that recurs among your log fields. Patterns provide a useful tool for \n analyzing large sets of logs because a large number of log events can often be\n compressed into a few patterns.
\nThe anomaly detector uses pattern recognition to find anomalies, which are unusual log \n events. It uses the evaluationFrequency to compare current log events and patterns\n with trained baselines.
Fields within a pattern are called tokens.\n Fields that vary within a pattern, such as a \n request ID or timestamp, are referred to as dynamic tokens and\n represented by <*>.
The following is an example of a pattern:
\n\n [INFO] Request time: <*> ms\n
This pattern\n represents log events like [INFO] Request time: 327 ms and other similar log events\n that differ only by the number, in this csse 327. When the pattern is displayed, the different numbers are replaced\n by <*>\n
Any parts of log events that are masked as sensitive data are not scanned for anomalies. For more information\n about masking sensitive data, see \n Help protect sensitive log data with\n masking.\n
\nAn array containing the ARN of the log group that this anomaly detector will watch. You can specify only one\n log group ARN.
", - "smithy.api#required": {} - } - }, - "detectorName": { - "target": "com.amazonaws.cloudwatchlogs#DetectorName", - "traits": { - "smithy.api#documentation": "A name for this anomaly detector.
" - } - }, - "evaluationFrequency": { - "target": "com.amazonaws.cloudwatchlogs#EvaluationFrequency", - "traits": { - "smithy.api#documentation": "Specifies how often the anomaly detector is to run and look for anomalies. Set this value\n according to the frequency that the log group receives new logs. For example, if the log group\n receives new log events every 10 minutes, then 15 minutes might be a good setting for \n evaluationFrequency .
You can use this parameter to limit the anomaly detection model to examine only log events\n that match the pattern you specify here. For more information, see Filter and Pattern Syntax.
" - } - }, - "kmsKeyId": { - "target": "com.amazonaws.cloudwatchlogs#KmsKeyId", - "traits": { - "smithy.api#documentation": "Optionally assigns a KMS key to secure this anomaly detector and its findings. If a key is \n assigned, the anomalies found and the model used by this detector are encrypted at rest with the key. If \n a key is assigned to an anomaly detector, a user must have permissions for both this key and for the \n anomaly detector to retrieve information about the anomalies that it finds.
\nFor more information about using a KMS key and to see the required IAM\n policy, see Use a KMS key with an anomaly detector.
" - } - }, - "anomalyVisibilityTime": { - "target": "com.amazonaws.cloudwatchlogs#AnomalyVisibilityTime", - "traits": { - "smithy.api#documentation": "The number of days to have visibility on an anomaly. After this time period has elapsed for an anomaly, \n it will be automatically baselined and the anomaly detector will treat new occurrences of a similar anomaly as \n normal. Therefore, \n if you do not correct the cause of an \n anomaly during the time period specified in anomalyVisibilityTime, it will be considered normal \n going forward and will not be detected as an anomaly.
An optional list of key-value pairs to associate with the resource.
\nFor more information about tagging, see \n Tagging Amazon Web Services resources\n
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#CreateLogAnomalyDetectorResponse": { - "type": "structure", - "members": { - "anomalyDetectorArn": { - "target": "com.amazonaws.cloudwatchlogs#AnomalyDetectorArn", - "traits": { - "smithy.api#documentation": "The ARN of the log anomaly detector that you just created.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudwatchlogs#CreateLogGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#CreateLogGroupRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#LimitExceededException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceAlreadyExistsException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "Creates a log group with the specified name. You can create up to 1,000,000 log groups per Region per account.
\nYou must use the following guidelines when naming a log group:
\nLog group names must be unique within a Region for an Amazon Web Services\n account.
\nLog group names can be between 1 and 512 characters long.
\nLog group names consist of the following characters: a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), \n '/' (forward slash), '.' (period), and '#' (number sign)
\nLog group names can't start with the string aws/\n
When you create a log group, by default the log events in the log group do not expire.\n To set a retention policy so that events expire and are deleted after a specified time, use\n PutRetentionPolicy.
\nIf you associate an KMS key with the log group, ingested data is\n encrypted using the KMS key. This association is stored as long as the data\n encrypted with the KMS key is still within CloudWatch Logs. This enables\n CloudWatch Logs to decrypt this data whenever it is requested.
\nIf you attempt to associate a KMS key with the log group but the KMS key does not exist or the KMS key is disabled, you receive an\n InvalidParameterException error.
CloudWatch Logs supports only symmetric KMS keys. Do not associate an\n asymmetric KMS key with your log group. For more information, see Using\n Symmetric and Asymmetric Keys.
\nA name for the log group.
", - "smithy.api#required": {} - } - }, - "kmsKeyId": { - "target": "com.amazonaws.cloudwatchlogs#KmsKeyId", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key to use when encrypting log\n data. For more information, see Amazon Resource\n Names.
" - } - }, - "tags": { - "target": "com.amazonaws.cloudwatchlogs#Tags", - "traits": { - "smithy.api#documentation": "The key-value pairs to use for the tags.
\nYou can grant users access to certain log groups while preventing them from accessing other log groups.\n To do so, tag your groups and use IAM policies that refer to those tags. To assign tags when \n you create a log group, you must have either the logs:TagResource or logs:TagLogGroup\n permission. For more information about tagging, see \n Tagging Amazon Web Services resources.\n For more information about using tags to control access, see \n Controlling access to Amazon Web Services resources using tags.
Use this parameter to specify the log group class for this log group. There are two classes:
\nThe Standard log class supports all CloudWatch Logs features.
The Infrequent Access log class supports a subset of CloudWatch Logs features\n and incurs lower costs.
If you omit this parameter, the default of STANDARD is used.
The value of logGroupClass can't be changed after a log group is created.
For details about the features supported by each class, see \n Log classes\n
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#CreateLogStream": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#CreateLogStreamRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceAlreadyExistsException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "Creates a log stream for the specified log group. A log stream is a sequence of log events\n that originate from a single source, such as an application instance or a resource that is \n being monitored.
\nThere is no limit on the number of log streams that you can create for a log group. There is a limit \n of 50 TPS on CreateLogStream operations, after which transactions are throttled.
You must use the following guidelines when naming a log stream:
\nLog stream names must be unique within the log group.
\nLog stream names can be between 1 and 512 characters long.
\nDon't use ':' (colon) or '*' (asterisk) characters.
\nThe name of the log group.
", - "smithy.api#required": {} - } - }, - "logStreamName": { - "target": "com.amazonaws.cloudwatchlogs#LogStreamName", - "traits": { - "smithy.api#documentation": "The name of the log stream.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#DataAlreadyAcceptedException": { - "type": "structure", - "members": { - "expectedSequenceToken": { - "target": "com.amazonaws.cloudwatchlogs#SequenceToken" - }, - "message": { - "target": "com.amazonaws.cloudwatchlogs#Message" - } - }, - "traits": { - "smithy.api#documentation": "The event was already logged.
\n\n PutLogEvents\n actions are now always accepted and never return\n DataAlreadyAcceptedException regardless of whether a given batch of log events\n has already been accepted.
The number of days to retain the log events in the specified log group.\n Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1096, 1827, 2192, 2557, 2922, 3288, and 3653.
\nTo set a log group so that its log events do not expire, use DeleteRetentionPolicy.
" - } - }, - "com.amazonaws.cloudwatchlogs#DefaultValue": { - "type": "double" - }, - "com.amazonaws.cloudwatchlogs#DeleteAccountPolicy": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#DeleteAccountPolicyRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes a CloudWatch Logs account policy. This stops the policy from applying to all log groups\n or a subset of log groups in the account. Log-group level policies will still be in effect.
\nTo use this operation, you must be signed on with the correct permissions depending on the type of policy\n that you are deleting.
\nTo delete a data protection policy, you must have the logs:DeleteDataProtectionPolicy and \n logs:DeleteAccountPolicy permissions.
To delete a subscription filter policy, you must have the logs:DeleteSubscriptionFilter and \n logs:DeleteAccountPolicy permissions.
The name of the policy to delete.
", - "smithy.api#required": {} - } - }, - "policyType": { - "target": "com.amazonaws.cloudwatchlogs#PolicyType", - "traits": { - "smithy.api#documentation": "The type of policy to delete.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#DeleteDataProtectionPolicy": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#DeleteDataProtectionPolicyRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes the data protection policy from the specified log group.
\nFor more information about data protection policies, see PutDataProtectionPolicy.
" - } - }, - "com.amazonaws.cloudwatchlogs#DeleteDataProtectionPolicyRequest": { - "type": "structure", - "members": { - "logGroupIdentifier": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupIdentifier", - "traits": { - "smithy.api#documentation": "The name or ARN of the log group that you want to delete the data protection policy for.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#DeleteDelivery": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#DeleteDeliveryRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#ConflictException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ThrottlingException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes s delivery. A delivery is a connection between a logical delivery source and a logical\n delivery destination. Deleting a delivery only deletes the connection between the delivery source and delivery destination. It does\n not delete the delivery destination or the delivery source.
" - } - }, - "com.amazonaws.cloudwatchlogs#DeleteDeliveryDestination": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#DeleteDeliveryDestinationRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#ConflictException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ThrottlingException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes a delivery destination. A delivery is a connection between a logical delivery source and a logical\n delivery destination.
\nYou can't delete a delivery destination if any current deliveries are associated with it. To find whether any deliveries are associated with \n this delivery destination, use the DescribeDeliveries operation and check the deliveryDestinationArn field in the results.
Deletes a delivery destination policy. For more information about these policies,\n see PutDeliveryDestinationPolicy.
" - } - }, - "com.amazonaws.cloudwatchlogs#DeleteDeliveryDestinationPolicyRequest": { - "type": "structure", - "members": { - "deliveryDestinationName": { - "target": "com.amazonaws.cloudwatchlogs#DeliveryDestinationName", - "traits": { - "smithy.api#documentation": "The name of the delivery destination that you want to delete the policy for.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#DeleteDeliveryDestinationRequest": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.cloudwatchlogs#DeliveryDestinationName", - "traits": { - "smithy.api#documentation": "The name of the delivery destination that you want to delete. You can find a list of delivery destionation names\n by using the DescribeDeliveryDestinations\n operation.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#DeleteDeliveryRequest": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.cloudwatchlogs#DeliveryId", - "traits": { - "smithy.api#documentation": "The unique ID of the delivery to delete. You can find the ID of a delivery with the \n DescribeDeliveries operation.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#DeleteDeliverySource": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#DeleteDeliverySourceRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#ConflictException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ThrottlingException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes a delivery source. A delivery is a connection between a logical delivery source and a logical\n delivery destination.
\nYou can't delete a delivery source if any current deliveries are associated with it. To find whether any deliveries are associated with \n this delivery source, use the DescribeDeliveries operation and check the deliverySourceName field in the results.
The name of the delivery source that you want to delete.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#DeleteDestination": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#DeleteDestinationRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes the specified destination, and eventually disables all the\n subscription filters that publish to it. This operation does not delete the \n physical resource encapsulated by the destination.
" - } - }, - "com.amazonaws.cloudwatchlogs#DeleteDestinationRequest": { - "type": "structure", - "members": { - "destinationName": { - "target": "com.amazonaws.cloudwatchlogs#DestinationName", - "traits": { - "smithy.api#documentation": "The name of the destination.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#DeleteLogAnomalyDetector": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#DeleteLogAnomalyDetectorRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes the specified CloudWatch Logs anomaly detector.
" - } - }, - "com.amazonaws.cloudwatchlogs#DeleteLogAnomalyDetectorRequest": { - "type": "structure", - "members": { - "anomalyDetectorArn": { - "target": "com.amazonaws.cloudwatchlogs#AnomalyDetectorArn", - "traits": { - "smithy.api#documentation": "The ARN of the anomaly detector to delete. You can find the ARNs of log anomaly detectors \n in your account by using the ListLogAnomalyDetectors\n operation.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#DeleteLogGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#DeleteLogGroupRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes the specified log group and permanently deletes all the archived\n log events associated with the log group.
" - } - }, - "com.amazonaws.cloudwatchlogs#DeleteLogGroupRequest": { - "type": "structure", - "members": { - "logGroupName": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupName", - "traits": { - "smithy.api#documentation": "The name of the log group.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#DeleteLogStream": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#DeleteLogStreamRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes the specified log stream and permanently deletes all the archived log events associated\n with the log stream.
" - } - }, - "com.amazonaws.cloudwatchlogs#DeleteLogStreamRequest": { - "type": "structure", - "members": { - "logGroupName": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupName", - "traits": { - "smithy.api#documentation": "The name of the log group.
", - "smithy.api#required": {} - } - }, - "logStreamName": { - "target": "com.amazonaws.cloudwatchlogs#LogStreamName", - "traits": { - "smithy.api#documentation": "The name of the log stream.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#DeleteMetricFilter": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#DeleteMetricFilterRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes the specified metric filter.
" - } - }, - "com.amazonaws.cloudwatchlogs#DeleteMetricFilterRequest": { - "type": "structure", - "members": { - "logGroupName": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupName", - "traits": { - "smithy.api#documentation": "The name of the log group.
", - "smithy.api#required": {} - } - }, - "filterName": { - "target": "com.amazonaws.cloudwatchlogs#FilterName", - "traits": { - "smithy.api#documentation": "The name of the metric filter.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#DeleteQueryDefinition": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#DeleteQueryDefinitionRequest" - }, - "output": { - "target": "com.amazonaws.cloudwatchlogs#DeleteQueryDefinitionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes a saved CloudWatch Logs Insights query definition. \n A query definition contains details about a saved CloudWatch Logs Insights query.
\nEach DeleteQueryDefinition operation can delete one query definition.
You must have the logs:DeleteQueryDefinition permission to be able to perform\n this operation.
The ID of the query definition that you want to delete. You can use DescribeQueryDefinitions to retrieve the\n IDs of your saved query definitions.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#DeleteQueryDefinitionResponse": { - "type": "structure", - "members": { - "success": { - "target": "com.amazonaws.cloudwatchlogs#Success", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "A value of TRUE indicates that the operation succeeded. FALSE indicates that the operation\n failed.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudwatchlogs#DeleteResourcePolicy": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#DeleteResourcePolicyRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes a resource policy from this account. This revokes \n the access of the identities in that policy to put log events to this account.
" - } - }, - "com.amazonaws.cloudwatchlogs#DeleteResourcePolicyRequest": { - "type": "structure", - "members": { - "policyName": { - "target": "com.amazonaws.cloudwatchlogs#PolicyName", - "traits": { - "smithy.api#documentation": "The name of the policy to be revoked. This parameter is required.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#DeleteRetentionPolicy": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#DeleteRetentionPolicyRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes the specified retention policy.
\nLog events do not expire if they belong to log groups without a retention policy.
" - } - }, - "com.amazonaws.cloudwatchlogs#DeleteRetentionPolicyRequest": { - "type": "structure", - "members": { - "logGroupName": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupName", - "traits": { - "smithy.api#documentation": "The name of the log group.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#DeleteSubscriptionFilter": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#DeleteSubscriptionFilterRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes the specified subscription filter.
" - } - }, - "com.amazonaws.cloudwatchlogs#DeleteSubscriptionFilterRequest": { - "type": "structure", - "members": { - "logGroupName": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupName", - "traits": { - "smithy.api#documentation": "The name of the log group.
", - "smithy.api#required": {} - } - }, - "filterName": { - "target": "com.amazonaws.cloudwatchlogs#FilterName", - "traits": { - "smithy.api#documentation": "The name of the subscription filter.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#Deliveries": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudwatchlogs#Delivery" - } - }, - "com.amazonaws.cloudwatchlogs#Delivery": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.cloudwatchlogs#DeliveryId", - "traits": { - "smithy.api#documentation": "The unique ID that identifies this delivery in your account.
" - } - }, - "arn": { - "target": "com.amazonaws.cloudwatchlogs#Arn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) that uniquely identifies this delivery.
" - } - }, - "deliverySourceName": { - "target": "com.amazonaws.cloudwatchlogs#DeliverySourceName", - "traits": { - "smithy.api#documentation": "The name of the delivery source that is associated with this delivery.
" - } - }, - "deliveryDestinationArn": { - "target": "com.amazonaws.cloudwatchlogs#Arn", - "traits": { - "smithy.api#documentation": "The ARN of the delivery destination that is associated with this delivery.
" - } - }, - "deliveryDestinationType": { - "target": "com.amazonaws.cloudwatchlogs#DeliveryDestinationType", - "traits": { - "smithy.api#documentation": "Displays whether the delivery destination associated with this delivery is CloudWatch Logs, Amazon S3, or Firehose.
" - } - }, - "tags": { - "target": "com.amazonaws.cloudwatchlogs#Tags", - "traits": { - "smithy.api#documentation": "The tags that have been assigned to this delivery.
" - } - } - }, - "traits": { - "smithy.api#documentation": "This structure contains information about one delivery in your account.
\nA delivery is a connection between a logical delivery source and a logical\n delivery destination.
\nFor more information, see CreateDelivery.
\nYou can't update an existing delivery. You can only create and delete deliveries.
" - } - }, - "com.amazonaws.cloudwatchlogs#DeliveryDestination": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.cloudwatchlogs#DeliveryDestinationName", - "traits": { - "smithy.api#documentation": "The name of this delivery destination.
" - } - }, - "arn": { - "target": "com.amazonaws.cloudwatchlogs#Arn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) that uniquely identifies this delivery destination.
" - } - }, - "deliveryDestinationType": { - "target": "com.amazonaws.cloudwatchlogs#DeliveryDestinationType", - "traits": { - "smithy.api#documentation": "Displays whether this delivery destination is CloudWatch Logs, Amazon S3, or Firehose.
" - } - }, - "outputFormat": { - "target": "com.amazonaws.cloudwatchlogs#OutputFormat", - "traits": { - "smithy.api#documentation": "The format of the logs that are sent to this delivery destination.
" - } - }, - "deliveryDestinationConfiguration": { - "target": "com.amazonaws.cloudwatchlogs#DeliveryDestinationConfiguration", - "traits": { - "smithy.api#documentation": "A structure that contains the ARN of the Amazon Web Services resource that will receive the logs.
" - } - }, - "tags": { - "target": "com.amazonaws.cloudwatchlogs#Tags", - "traits": { - "smithy.api#documentation": "The tags that have been assigned to this delivery destination.
" - } - } - }, - "traits": { - "smithy.api#documentation": "This structure contains information about one delivery destination in your account. \n A delivery destination is an Amazon Web Services resource that represents an \n Amazon Web Services service that logs can be sent to. CloudWatch Logs, Amazon S3, are supported as Firehose delivery destinations.
\nTo configure logs delivery between a supported Amazon Web Services service and a destination, you must do the following:
\nCreate a delivery source, which is a logical object that represents the resource that is actually\n sending the logs. For more \n information, see PutDeliverySource.
\nCreate a delivery destination, which is a logical object that represents the actual\n delivery destination.
\nIf you are delivering logs cross-account, you must use \n PutDeliveryDestinationPolicy\n in the destination account to assign an IAM policy to the \n destination. This policy allows delivery to that destination.\n
\nCreate a delivery by pairing exactly one delivery source and one delivery destination.\n For more information, see CreateDelivery.
\nYou can configure a single delivery source to send logs to multiple destinations by creating multiple deliveries. You \n can also create multiple deliveries to configure multiple delivery sources to send logs to the same delivery destination.
" - } - }, - "com.amazonaws.cloudwatchlogs#DeliveryDestinationConfiguration": { - "type": "structure", - "members": { - "destinationResourceArn": { - "target": "com.amazonaws.cloudwatchlogs#Arn", - "traits": { - "smithy.api#documentation": "The ARN of the Amazon Web Services destination that this delivery destination represents. That Amazon Web Services destination\n can be a log group in CloudWatch Logs, an Amazon S3 bucket, or a delivery stream in Firehose.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "A structure that contains information about one logs delivery destination.
" - } - }, - "com.amazonaws.cloudwatchlogs#DeliveryDestinationName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 60 - }, - "smithy.api#pattern": "^[\\w-]*$" - } - }, - "com.amazonaws.cloudwatchlogs#DeliveryDestinationPolicy": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 51200 - } - } - }, - "com.amazonaws.cloudwatchlogs#DeliveryDestinationType": { - "type": "enum", - "members": { - "S3": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "S3" - } - }, - "CWL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CWL" - } - }, - "FH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FH" - } - } - } - }, - "com.amazonaws.cloudwatchlogs#DeliveryDestinations": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudwatchlogs#DeliveryDestination" - } - }, - "com.amazonaws.cloudwatchlogs#DeliveryId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - }, - "smithy.api#pattern": "^[0-9A-Za-z]+$" - } - }, - "com.amazonaws.cloudwatchlogs#DeliverySource": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.cloudwatchlogs#DeliverySourceName", - "traits": { - "smithy.api#documentation": "The unique name of the delivery source.
" - } - }, - "arn": { - "target": "com.amazonaws.cloudwatchlogs#Arn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) that uniquely identifies this delivery source.
" - } - }, - "resourceArns": { - "target": "com.amazonaws.cloudwatchlogs#ResourceArns", - "traits": { - "smithy.api#documentation": "This array contains the ARN of the Amazon Web Services resource that sends logs and is represented by \n this delivery source. Currently, only one ARN can be in the array.
" - } - }, - "service": { - "target": "com.amazonaws.cloudwatchlogs#Service", - "traits": { - "smithy.api#documentation": "The Amazon Web Services service that is sending logs.
" - } - }, - "logType": { - "target": "com.amazonaws.cloudwatchlogs#LogType", - "traits": { - "smithy.api#documentation": "The type of log that the source is sending. For valid values for this parameter, see the documentation for\n the source service.
" - } - }, - "tags": { - "target": "com.amazonaws.cloudwatchlogs#Tags", - "traits": { - "smithy.api#documentation": "The tags that have been assigned to this delivery source.
" - } - } - }, - "traits": { - "smithy.api#documentation": "This structure contains information about one delivery source in your account. \n A delivery source is an Amazon Web Services resource that sends logs to an\n Amazon Web Services destination. The destination can be CloudWatch Logs, Amazon S3, or Firehose.
\nOnly some Amazon Web Services services support being configured as a delivery source. These services are listed\n as Supported [V2 Permissions] in the table at \n Enabling \n logging from Amazon Web Services services.\n
\nTo configure logs delivery between a supported Amazon Web Services service and a destination, you must do the following:
\nCreate a delivery source, which is a logical object that represents the resource that is actually\n sending the logs. For more \n information, see PutDeliverySource.
\nCreate a delivery destination, which is a logical object that represents the actual\n delivery destination. For more \n information, see PutDeliveryDestination.
\nIf you are delivering logs cross-account, you must use \n PutDeliveryDestinationPolicy\n in the destination account to assign an IAM policy to the \n destination. This policy allows delivery to that destination.\n
\nCreate a delivery by pairing exactly one delivery source and one delivery destination.\n For more information, see CreateDelivery.
\nYou can configure a single delivery source to send logs to multiple destinations by creating multiple deliveries. You \n can also create multiple deliveries to configure multiple delivery sources to send logs to the same delivery destination.
" - } - }, - "com.amazonaws.cloudwatchlogs#DeliverySourceName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 60 - }, - "smithy.api#pattern": "^[\\w-]*$" - } - }, - "com.amazonaws.cloudwatchlogs#DeliverySources": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudwatchlogs#DeliverySource" - } - }, - "com.amazonaws.cloudwatchlogs#Descending": { - "type": "boolean" - }, - "com.amazonaws.cloudwatchlogs#DescribeAccountPolicies": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#DescribeAccountPoliciesRequest" - }, - "output": { - "target": "com.amazonaws.cloudwatchlogs#DescribeAccountPoliciesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "Returns a list of all CloudWatch Logs account policies in the account.
" - } - }, - "com.amazonaws.cloudwatchlogs#DescribeAccountPoliciesRequest": { - "type": "structure", - "members": { - "policyType": { - "target": "com.amazonaws.cloudwatchlogs#PolicyType", - "traits": { - "smithy.api#documentation": "Use this parameter to limit the returned policies to only the policies that match the policy type that you\n specify.
", - "smithy.api#required": {} - } - }, - "policyName": { - "target": "com.amazonaws.cloudwatchlogs#PolicyName", - "traits": { - "smithy.api#documentation": "Use this parameter to limit the returned policies to only the policy with the name that you specify.
" - } - }, - "accountIdentifiers": { - "target": "com.amazonaws.cloudwatchlogs#AccountIds", - "traits": { - "smithy.api#documentation": "If you are using an account that is set up as a monitoring account for CloudWatch unified cross-account\n observability, you can use this to specify the account ID of a source account. If you do, \n the operation returns the account policy for the specified account. Currently, you can specify only\n one account ID in this parameter.
\nIf you\n omit this parameter, only the policy in the current account is returned.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#DescribeAccountPoliciesResponse": { - "type": "structure", - "members": { - "accountPolicies": { - "target": "com.amazonaws.cloudwatchlogs#AccountPolicies", - "traits": { - "smithy.api#documentation": "An array of structures that contain information about the CloudWatch Logs account policies that match \n the specified filters.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudwatchlogs#DescribeDeliveries": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#DescribeDeliveriesRequest" - }, - "output": { - "target": "com.amazonaws.cloudwatchlogs#DescribeDeliveriesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ThrottlingException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Retrieves a list of the deliveries that have been created in the account.
\nA delivery is a \n connection between a \n delivery source\n and a \n \n delivery destination\n .
\nA delivery source represents an Amazon Web Services resource that sends logs to an logs delivery destination. \n The destination can be CloudWatch Logs, Amazon S3, or Firehose. \n Only some Amazon Web Services services support being configured as a delivery source. These services are listed\n in Enable logging from Amazon Web Services \n services.\n
", - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "deliveries", - "pageSize": "limit" - } - } - }, - "com.amazonaws.cloudwatchlogs#DescribeDeliveriesRequest": { - "type": "structure", - "members": { - "nextToken": { - "target": "com.amazonaws.cloudwatchlogs#NextToken" - }, - "limit": { - "target": "com.amazonaws.cloudwatchlogs#DescribeLimit", - "traits": { - "smithy.api#documentation": "Optionally specify the maximum number of deliveries to return in the response.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#DescribeDeliveriesResponse": { - "type": "structure", - "members": { - "deliveries": { - "target": "com.amazonaws.cloudwatchlogs#Deliveries", - "traits": { - "smithy.api#documentation": "An array of structures. Each structure contains information about one delivery in the account.
" - } - }, - "nextToken": { - "target": "com.amazonaws.cloudwatchlogs#NextToken" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudwatchlogs#DescribeDeliveryDestinations": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#DescribeDeliveryDestinationsRequest" - }, - "output": { - "target": "com.amazonaws.cloudwatchlogs#DescribeDeliveryDestinationsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ThrottlingException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Retrieves a list of the delivery destinations that have been created in the account.
", - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "deliveryDestinations", - "pageSize": "limit" - } - } - }, - "com.amazonaws.cloudwatchlogs#DescribeDeliveryDestinationsRequest": { - "type": "structure", - "members": { - "nextToken": { - "target": "com.amazonaws.cloudwatchlogs#NextToken" - }, - "limit": { - "target": "com.amazonaws.cloudwatchlogs#DescribeLimit", - "traits": { - "smithy.api#documentation": "Optionally specify the maximum number of delivery destinations to return in the response.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#DescribeDeliveryDestinationsResponse": { - "type": "structure", - "members": { - "deliveryDestinations": { - "target": "com.amazonaws.cloudwatchlogs#DeliveryDestinations", - "traits": { - "smithy.api#documentation": "An array of structures. Each structure contains information about one delivery destination in the account.
" - } - }, - "nextToken": { - "target": "com.amazonaws.cloudwatchlogs#NextToken" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudwatchlogs#DescribeDeliverySources": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#DescribeDeliverySourcesRequest" - }, - "output": { - "target": "com.amazonaws.cloudwatchlogs#DescribeDeliverySourcesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ThrottlingException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Retrieves a list of the delivery sources that have been created in the account.
", - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "deliverySources", - "pageSize": "limit" - } - } - }, - "com.amazonaws.cloudwatchlogs#DescribeDeliverySourcesRequest": { - "type": "structure", - "members": { - "nextToken": { - "target": "com.amazonaws.cloudwatchlogs#NextToken" - }, - "limit": { - "target": "com.amazonaws.cloudwatchlogs#DescribeLimit", - "traits": { - "smithy.api#documentation": "Optionally specify the maximum number of delivery sources to return in the response.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#DescribeDeliverySourcesResponse": { - "type": "structure", - "members": { - "deliverySources": { - "target": "com.amazonaws.cloudwatchlogs#DeliverySources", - "traits": { - "smithy.api#documentation": "An array of structures. Each structure contains information about one delivery source in the account.
" - } - }, - "nextToken": { - "target": "com.amazonaws.cloudwatchlogs#NextToken" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudwatchlogs#DescribeDestinations": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#DescribeDestinationsRequest" - }, - "output": { - "target": "com.amazonaws.cloudwatchlogs#DescribeDestinationsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "Lists all your destinations. The results are ASCII-sorted by destination name.
", - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "destinations", - "pageSize": "limit" - } - } - }, - "com.amazonaws.cloudwatchlogs#DescribeDestinationsRequest": { - "type": "structure", - "members": { - "DestinationNamePrefix": { - "target": "com.amazonaws.cloudwatchlogs#DestinationName", - "traits": { - "smithy.api#documentation": "The prefix to match. If you don't specify a value, no prefix filter is applied.
" - } - }, - "nextToken": { - "target": "com.amazonaws.cloudwatchlogs#NextToken", - "traits": { - "smithy.api#documentation": "The token for the next set of items to return. (You received this token from a previous call.)
" - } - }, - "limit": { - "target": "com.amazonaws.cloudwatchlogs#DescribeLimit", - "traits": { - "smithy.api#documentation": "The maximum number of items returned. If you don't specify a value, the default maximum value of \n 50 items is used.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#DescribeDestinationsResponse": { - "type": "structure", - "members": { - "destinations": { - "target": "com.amazonaws.cloudwatchlogs#Destinations", - "traits": { - "smithy.api#documentation": "The destinations.
" - } - }, - "nextToken": { - "target": "com.amazonaws.cloudwatchlogs#NextToken" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudwatchlogs#DescribeExportTasks": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#DescribeExportTasksRequest" - }, - "output": { - "target": "com.amazonaws.cloudwatchlogs#DescribeExportTasksResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "Lists the specified export tasks. You can list all your export tasks or filter \n the results based on task ID or task status.
" - } - }, - "com.amazonaws.cloudwatchlogs#DescribeExportTasksRequest": { - "type": "structure", - "members": { - "taskId": { - "target": "com.amazonaws.cloudwatchlogs#ExportTaskId", - "traits": { - "smithy.api#documentation": "The ID of the export task. Specifying a task ID filters the results to one or zero\n export tasks.
" - } - }, - "statusCode": { - "target": "com.amazonaws.cloudwatchlogs#ExportTaskStatusCode", - "traits": { - "smithy.api#documentation": "The status code of the export task. Specifying a status code filters the results to zero or more export tasks.
" - } - }, - "nextToken": { - "target": "com.amazonaws.cloudwatchlogs#NextToken", - "traits": { - "smithy.api#documentation": "The token for the next set of items to return. (You received this token from a previous call.)
" - } - }, - "limit": { - "target": "com.amazonaws.cloudwatchlogs#DescribeLimit", - "traits": { - "smithy.api#documentation": "The maximum number of items returned. If you don't specify a value, the default is up to 50 items.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#DescribeExportTasksResponse": { - "type": "structure", - "members": { - "exportTasks": { - "target": "com.amazonaws.cloudwatchlogs#ExportTasks", - "traits": { - "smithy.api#documentation": "The export tasks.
" - } - }, - "nextToken": { - "target": "com.amazonaws.cloudwatchlogs#NextToken" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudwatchlogs#DescribeLimit": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.cloudwatchlogs#DescribeLogGroups": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#DescribeLogGroupsRequest" - }, - "output": { - "target": "com.amazonaws.cloudwatchlogs#DescribeLogGroupsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "Lists the specified log groups. You can list all your log groups or filter the results by prefix.\n The results are ASCII-sorted by log group name.
\nCloudWatch Logs doesn’t support IAM policies that control access to the DescribeLogGroups action by using the \n aws:ResourceTag/key-name\n condition key. Other CloudWatch Logs actions\n do support the use of the aws:ResourceTag/key-name\n condition key to control access.\n For more information about using tags to control access, see \n Controlling access to Amazon Web Services resources using tags.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and \n view data from the linked source accounts. For more information, see \n CloudWatch cross-account observability.
", - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "logGroups", - "pageSize": "limit" - }, - "smithy.test#smokeTests": [ - { - "id": "DescribeLogGroupsSuccess", - "params": {}, - "vendorParams": { - "region": "us-west-2" - }, - "vendorParamsShape": "aws.test#AwsVendorParams", - "expect": { - "success": {} - } - } + "smithy": "2.0", + "metadata": { + "suppressions": [ + { + "id": "HttpMethodSemantics", + "namespace": "*" + }, + { + "id": "HttpResponseCodeSemantics", + "namespace": "*" + }, + { + "id": "PaginatedTrait", + "namespace": "*" + }, + { + "id": "HttpHeaderTrait", + "namespace": "*" + }, + { + "id": "HttpUriConflict", + "namespace": "*" + }, + { + "id": "Service", + "namespace": "*" + } ] - } - }, - "com.amazonaws.cloudwatchlogs#DescribeLogGroupsRequest": { - "type": "structure", - "members": { - "accountIdentifiers": { - "target": "com.amazonaws.cloudwatchlogs#AccountIds", - "traits": { - "smithy.api#documentation": "When includeLinkedAccounts is set to True, use this parameter to\n specify the list of accounts to search. You can specify as many as 20 account IDs in the array.
The prefix to match.
\n\n logGroupNamePrefix and logGroupNamePattern are mutually exclusive. \n Only one \n of these parameters can be passed.\n
If you specify a string for this parameter, the operation returns only log groups that have names\nthat match the string based on a case-sensitive substring search. For example, if you specify Foo, log groups\nnamed FooBar, aws/Foo, and GroupFoo would match, but foo, \nF/o/o and Froo would not match.
If you specify logGroupNamePattern in your request, then only\n arn, creationTime, and logGroupName\n are included in the response.
\n logGroupNamePattern and logGroupNamePrefix are mutually exclusive. \n Only one \n of these parameters can be passed.\n
The token for the next set of items to return. (You received this token from a previous call.)
" - } - }, - "limit": { - "target": "com.amazonaws.cloudwatchlogs#DescribeLimit", - "traits": { - "smithy.api#documentation": "The maximum number of items returned. If you don't specify a value, the default is up to 50 items.
" - } - }, - "includeLinkedAccounts": { - "target": "com.amazonaws.cloudwatchlogs#IncludeLinkedAccounts", - "traits": { - "smithy.api#documentation": "If you are using a monitoring account, set this to True to have the operation\n return log groups in \n the accounts listed in accountIdentifiers.
If this parameter is set to true and accountIdentifiers\n\n contains a null value, the operation returns all log groups in the monitoring account\n and all log groups in all source accounts that are linked to the monitoring account.
Specifies the log group class for this log group. There are two classes:
\nThe Standard log class supports all CloudWatch Logs features.
The Infrequent Access log class supports a subset of CloudWatch Logs features\n and incurs lower costs.
For details about the features supported by each class, see \n Log classes\n
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#DescribeLogGroupsResponse": { - "type": "structure", - "members": { - "logGroups": { - "target": "com.amazonaws.cloudwatchlogs#LogGroups", - "traits": { - "smithy.api#documentation": "The log groups.
\nIf the retentionInDays value is not included for a log group, then that log\n group's events do not expire.
Lists the log streams for the specified log group. \n You can list all the log streams or filter the results by prefix.\n You can also control how the results are ordered.
\nYou can specify the log group to search by using either logGroupIdentifier or logGroupName.\n You must include one of these two parameters, but you can't include both.\n
This operation has a limit of five transactions per second, after which transactions are throttled.
\nIf you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and \n view data from the linked source accounts. For more information, see \n CloudWatch cross-account observability.
", - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "logStreams", - "pageSize": "limit" - } - } - }, - "com.amazonaws.cloudwatchlogs#DescribeLogStreamsRequest": { - "type": "structure", - "members": { - "logGroupName": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupName", - "traits": { - "smithy.api#documentation": "The name of the log group.
\n\n You must include either logGroupIdentifier or logGroupName, but not \n both.\n
Specify either the name or ARN of the log group to view. If the log group is in a source account\n and you are using a monitoring account, you must use the log group ARN.
\n\n You must include either logGroupIdentifier or logGroupName, but not \n both.\n
The prefix to match.
\nIf orderBy is LastEventTime, you cannot specify this\n parameter.
If the value is LogStreamName, the results are ordered by log stream name.\n If the value is LastEventTime, the results are ordered by the event time. \n The default value is LogStreamName.
If you order the results by event time, you cannot specify the logStreamNamePrefix parameter.
\n lastEventTimestamp represents the time of the most recent log event in the\n log stream in CloudWatch Logs. This number is expressed as the number of milliseconds after\n Jan 1, 1970 00:00:00 UTC. lastEventTimestamp updates on an\n eventual consistency basis. It typically updates in less than an hour from ingestion, but in\n rare situations might take longer.
If the value is true, results are returned in descending order. \n If the value is to false, results are returned in ascending order.\n The default value is false.
" - } - }, - "nextToken": { - "target": "com.amazonaws.cloudwatchlogs#NextToken", - "traits": { - "smithy.api#documentation": "The token for the next set of items to return. (You received this token from a previous call.)
" - } - }, - "limit": { - "target": "com.amazonaws.cloudwatchlogs#DescribeLimit", - "traits": { - "smithy.api#documentation": "The maximum number of items returned. If you don't specify a value, the default is up to 50 items.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#DescribeLogStreamsResponse": { - "type": "structure", - "members": { - "logStreams": { - "target": "com.amazonaws.cloudwatchlogs#LogStreams", - "traits": { - "smithy.api#documentation": "The log streams.
" - } - }, - "nextToken": { - "target": "com.amazonaws.cloudwatchlogs#NextToken" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudwatchlogs#DescribeMetricFilters": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#DescribeMetricFiltersRequest" - }, - "output": { - "target": "com.amazonaws.cloudwatchlogs#DescribeMetricFiltersResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "Lists the specified metric filters. You can list all of the metric filters or filter\n the results by log name, prefix, metric name, or metric namespace. The results are\n ASCII-sorted by filter name.
", - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "metricFilters", - "pageSize": "limit" - } - } - }, - "com.amazonaws.cloudwatchlogs#DescribeMetricFiltersRequest": { - "type": "structure", - "members": { - "logGroupName": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupName", - "traits": { - "smithy.api#documentation": "The name of the log group.
" - } - }, - "filterNamePrefix": { - "target": "com.amazonaws.cloudwatchlogs#FilterName", - "traits": { - "smithy.api#documentation": "The prefix to match. CloudWatch Logs uses the value that you set here only if you also\n include the logGroupName parameter in your request.
The token for the next set of items to return. (You received this token from a previous call.)
" - } - }, - "limit": { - "target": "com.amazonaws.cloudwatchlogs#DescribeLimit", - "traits": { - "smithy.api#documentation": "The maximum number of items returned. If you don't specify a value, the default is up to 50 items.
" - } - }, - "metricName": { - "target": "com.amazonaws.cloudwatchlogs#MetricName", - "traits": { - "smithy.api#documentation": "Filters results to include only those with the specified metric name. If you include this parameter in your request, you \n must also include the metricNamespace parameter.
Filters results to include only those in the specified namespace. If you include this parameter in your request, you \n must also include the metricName parameter.
The metric filters.
" - } - }, - "nextToken": { - "target": "com.amazonaws.cloudwatchlogs#NextToken" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudwatchlogs#DescribeQueries": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#DescribeQueriesRequest" - }, - "output": { - "target": "com.amazonaws.cloudwatchlogs#DescribeQueriesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "Returns a list of CloudWatch Logs Insights queries that are scheduled, running, or have\n been run recently in this account. You can request all queries or limit it to queries of a\n specific log group or queries with a certain status.
" - } - }, - "com.amazonaws.cloudwatchlogs#DescribeQueriesMaxResults": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 1000 - } - } - }, - "com.amazonaws.cloudwatchlogs#DescribeQueriesRequest": { - "type": "structure", - "members": { - "logGroupName": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupName", - "traits": { - "smithy.api#documentation": "Limits the returned queries to only those for the specified log group.
" - } - }, - "status": { - "target": "com.amazonaws.cloudwatchlogs#QueryStatus", - "traits": { - "smithy.api#documentation": "Limits the returned queries to only those that have the specified status. Valid values are Cancelled, \n Complete, Failed, Running, and Scheduled.
Limits the number of returned queries to the specified number.
" - } - }, - "nextToken": { - "target": "com.amazonaws.cloudwatchlogs#NextToken" - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#DescribeQueriesResponse": { - "type": "structure", - "members": { - "queries": { - "target": "com.amazonaws.cloudwatchlogs#QueryInfoList", - "traits": { - "smithy.api#documentation": "The list of queries that match the request.
" - } - }, - "nextToken": { - "target": "com.amazonaws.cloudwatchlogs#NextToken" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudwatchlogs#DescribeQueryDefinitions": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#DescribeQueryDefinitionsRequest" - }, - "output": { - "target": "com.amazonaws.cloudwatchlogs#DescribeQueryDefinitionsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "This operation returns a paginated list of your saved CloudWatch Logs Insights query definitions. You can\n retrieve query definitions from the current account or from a source account that is linked to the current account.
\nYou can use the queryDefinitionNamePrefix parameter to limit the results to only the\n query definitions that have names that start with a certain string.
Use this parameter to filter your results to only the query definitions that have names that start with the prefix you specify.
" - } - }, - "maxResults": { - "target": "com.amazonaws.cloudwatchlogs#QueryListMaxResults", - "traits": { - "smithy.api#documentation": "Limits the number of returned query definitions to the specified number.
" - } - }, - "nextToken": { - "target": "com.amazonaws.cloudwatchlogs#NextToken" - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#DescribeQueryDefinitionsResponse": { - "type": "structure", - "members": { - "queryDefinitions": { - "target": "com.amazonaws.cloudwatchlogs#QueryDefinitionList", - "traits": { - "smithy.api#documentation": "The list of query definitions that match your request.
" - } - }, - "nextToken": { - "target": "com.amazonaws.cloudwatchlogs#NextToken" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudwatchlogs#DescribeResourcePolicies": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#DescribeResourcePoliciesRequest" - }, - "output": { - "target": "com.amazonaws.cloudwatchlogs#DescribeResourcePoliciesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "Lists the resource policies in this account.
" - } - }, - "com.amazonaws.cloudwatchlogs#DescribeResourcePoliciesRequest": { - "type": "structure", - "members": { - "nextToken": { - "target": "com.amazonaws.cloudwatchlogs#NextToken" - }, - "limit": { - "target": "com.amazonaws.cloudwatchlogs#DescribeLimit", - "traits": { - "smithy.api#documentation": "The maximum number of resource policies to be displayed with one call of this API.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#DescribeResourcePoliciesResponse": { - "type": "structure", - "members": { - "resourcePolicies": { - "target": "com.amazonaws.cloudwatchlogs#ResourcePolicies", - "traits": { - "smithy.api#documentation": "The resource policies that exist in this account.
" - } - }, - "nextToken": { - "target": "com.amazonaws.cloudwatchlogs#NextToken" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudwatchlogs#DescribeSubscriptionFilters": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#DescribeSubscriptionFiltersRequest" - }, - "output": { - "target": "com.amazonaws.cloudwatchlogs#DescribeSubscriptionFiltersResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "Lists the subscription filters for the specified log group. You can list all the subscription filters or filter the results by prefix.\n The results are ASCII-sorted by filter name.
", - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "subscriptionFilters", - "pageSize": "limit" - } - } - }, - "com.amazonaws.cloudwatchlogs#DescribeSubscriptionFiltersRequest": { - "type": "structure", - "members": { - "logGroupName": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupName", - "traits": { - "smithy.api#documentation": "The name of the log group.
", - "smithy.api#required": {} - } - }, - "filterNamePrefix": { - "target": "com.amazonaws.cloudwatchlogs#FilterName", - "traits": { - "smithy.api#documentation": "The prefix to match. If you don't specify a value, no prefix filter is applied.
" - } - }, - "nextToken": { - "target": "com.amazonaws.cloudwatchlogs#NextToken", - "traits": { - "smithy.api#documentation": "The token for the next set of items to return. (You received this token from a previous call.)
" - } - }, - "limit": { - "target": "com.amazonaws.cloudwatchlogs#DescribeLimit", - "traits": { - "smithy.api#documentation": "The maximum number of items returned. If you don't specify a value, the default is up to 50 items.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#DescribeSubscriptionFiltersResponse": { - "type": "structure", - "members": { - "subscriptionFilters": { - "target": "com.amazonaws.cloudwatchlogs#SubscriptionFilters", - "traits": { - "smithy.api#documentation": "The subscription filters.
" - } - }, - "nextToken": { - "target": "com.amazonaws.cloudwatchlogs#NextToken" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudwatchlogs#Description": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.cloudwatchlogs#Destination": { - "type": "structure", - "members": { - "destinationName": { - "target": "com.amazonaws.cloudwatchlogs#DestinationName", - "traits": { - "smithy.api#documentation": "The name of the destination.
" - } - }, - "targetArn": { - "target": "com.amazonaws.cloudwatchlogs#TargetArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the physical target where the log events are\n delivered (for example, a Kinesis stream).
" - } - }, - "roleArn": { - "target": "com.amazonaws.cloudwatchlogs#RoleArn", - "traits": { - "smithy.api#documentation": "A role for impersonation, used when delivering log events to the target.
" - } - }, - "accessPolicy": { - "target": "com.amazonaws.cloudwatchlogs#AccessPolicy", - "traits": { - "smithy.api#documentation": "An IAM policy document that governs which Amazon Web Services accounts can create subscription filters\n against this destination.
" - } - }, - "arn": { - "target": "com.amazonaws.cloudwatchlogs#Arn", - "traits": { - "smithy.api#documentation": "The ARN of this destination.
" - } - }, - "creationTime": { - "target": "com.amazonaws.cloudwatchlogs#Timestamp", - "traits": { - "smithy.api#documentation": "The creation time of the destination, expressed as the number of milliseconds after Jan\n 1, 1970 00:00:00 UTC.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Represents a cross-account destination that receives subscription log events.
" - } - }, - "com.amazonaws.cloudwatchlogs#DestinationArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.cloudwatchlogs#DestinationName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 512 - }, - "smithy.api#pattern": "^[^:*]*$" - } - }, - "com.amazonaws.cloudwatchlogs#Destinations": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudwatchlogs#Destination" - } - }, - "com.amazonaws.cloudwatchlogs#DetectorName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.cloudwatchlogs#Dimensions": { - "type": "map", - "key": { - "target": "com.amazonaws.cloudwatchlogs#DimensionsKey" - }, - "value": { - "target": "com.amazonaws.cloudwatchlogs#DimensionsValue" - } - }, - "com.amazonaws.cloudwatchlogs#DimensionsKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 255 - } - } - }, - "com.amazonaws.cloudwatchlogs#DimensionsValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 255 - } - } - }, - "com.amazonaws.cloudwatchlogs#DisassociateKmsKey": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#DisassociateKmsKeyRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "Disassociates the specified KMS key from the specified log\n group or from all CloudWatch Logs Insights query results in the account.
\nWhen you use DisassociateKmsKey, you specify either the logGroupName parameter\n or the resourceIdentifier parameter. You can't specify both of those parameters in the same operation.
Specify the logGroupName parameter to stop using the KMS key\n to encrypt future log events ingested and stored in the log group. Instead, they will be\n encrypted with the default CloudWatch Logs method. The log events that were ingested\n while the key was associated with the log group are still encrypted with that key.\n Therefore, CloudWatch Logs will need permissions for the key whenever that data is\n accessed.
Specify the resourceIdentifier parameter with the query-result\n resource to stop using the KMS key to encrypt the results of all\n future StartQuery\n operations in the account. They will instead be encrypted with the default CloudWatch Logs method. The results from queries that ran while the key was associated with\n the account are still encrypted with that key. Therefore, CloudWatch Logs will need\n permissions for the key whenever that data is accessed.
It can take up to 5 minutes for this operation to take effect.
" - } - }, - "com.amazonaws.cloudwatchlogs#DisassociateKmsKeyRequest": { - "type": "structure", - "members": { - "logGroupName": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupName", - "traits": { - "smithy.api#documentation": "The name of the log group.
\nIn your DisassociateKmsKey operation,\n you must specify either the resourceIdentifier parameter or the logGroup parameter, \n but you can't specify both.
Specifies the target for this operation. You must specify one of the following:
\nSpecify the ARN of a log group to stop having CloudWatch Logs use the KMS key\n to encrypt log events that are ingested and stored by that log group. After you run this operation, CloudWatch Logs\n encrypts ingested log events with the default CloudWatch Logs method. The log group ARN must be in \n the following format. Replace\n REGION and ACCOUNT_ID with your Region and account ID.
\n\n arn:aws:logs:REGION:ACCOUNT_ID:log-group:LOG_GROUP_NAME\n \n
Specify the following ARN to stop using this key to encrypt the results of future StartQuery\n operations in this account. Replace\n REGION and ACCOUNT_ID with your Region and account ID.
\n\n arn:aws:logs:REGION:ACCOUNT_ID:query-result:*\n
In your DisssociateKmsKey operation,\n you must specify either the resourceIdentifier parameter or the logGroup parameter, \n but you can't specify both.
The method used to distribute log data to the destination, which can be either\n random or grouped by log stream.
" - } - }, - "com.amazonaws.cloudwatchlogs#DynamicTokenPosition": { - "type": "integer", - "traits": { - "smithy.api#default": 0 - } - }, - "com.amazonaws.cloudwatchlogs#EncryptionKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - } - } - }, - "com.amazonaws.cloudwatchlogs#Entity": { - "type": "structure", - "members": { - "keyAttributes": { - "target": "com.amazonaws.cloudwatchlogs#EntityKeyAttributes", - "traits": { - "smithy.api#documentation": "Reserved for future use.
" - } - }, - "attributes": { - "target": "com.amazonaws.cloudwatchlogs#EntityAttributes", - "traits": { - "smithy.api#documentation": "Reserved for future use.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Reserved for future use.
" - } - }, - "com.amazonaws.cloudwatchlogs#EntityAttributes": { - "type": "map", - "key": { - "target": "com.amazonaws.cloudwatchlogs#EntityAttributesKey" - }, - "value": { - "target": "com.amazonaws.cloudwatchlogs#EntityAttributesValue" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 10 - } - } - }, - "com.amazonaws.cloudwatchlogs#EntityAttributesKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - } - } - }, - "com.amazonaws.cloudwatchlogs#EntityAttributesValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 512 - } - } - }, - "com.amazonaws.cloudwatchlogs#EntityKeyAttributes": { - "type": "map", - "key": { - "target": "com.amazonaws.cloudwatchlogs#EntityKeyAttributesKey" - }, - "value": { - "target": "com.amazonaws.cloudwatchlogs#EntityKeyAttributesValue" - }, - "traits": { - "smithy.api#length": { - "min": 2, - "max": 3 - } - } - }, - "com.amazonaws.cloudwatchlogs#EntityKeyAttributesKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 32 - } - } - }, - "com.amazonaws.cloudwatchlogs#EntityKeyAttributesValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 512 - } - } - }, - "com.amazonaws.cloudwatchlogs#EntityRejectionErrorType": { - "type": "enum", - "members": { - "INVALID_ENTITY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InvalidEntity" - } - }, - "INVALID_TYPE_VALUE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InvalidTypeValue" - } - }, - "INVALID_KEY_ATTRIBUTE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InvalidKeyAttributes" - } - }, - "INVALID_ATTRIBUTES": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InvalidAttributes" - } - }, - "ENTITY_SIZE_TOO_LARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EntitySizeTooLarge" - } - }, - "UNSUPPORTED_LOG_GROUP_TYPE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UnsupportedLogGroupType" - } - }, - "MISSING_REQUIRED_FIELDS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MissingRequiredFields" - } - } - } - }, - "com.amazonaws.cloudwatchlogs#Enumerations": { - "type": "map", - "key": { - "target": "com.amazonaws.cloudwatchlogs#TokenString" - }, - "value": { - "target": "com.amazonaws.cloudwatchlogs#TokenValue" - } - }, - "com.amazonaws.cloudwatchlogs#EpochMillis": { - "type": "long", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 0 - } - } - }, - "com.amazonaws.cloudwatchlogs#EvaluationFrequency": { - "type": "enum", - "members": { - "ONE_MIN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ONE_MIN" - } - }, - "FIVE_MIN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FIVE_MIN" - } - }, - "TEN_MIN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TEN_MIN" - } - }, - "FIFTEEN_MIN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FIFTEEN_MIN" - } - }, - "THIRTY_MIN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "THIRTY_MIN" - } - }, - "ONE_HOUR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ONE_HOUR" - } - } - } - }, - "com.amazonaws.cloudwatchlogs#EventId": { - "type": "string" - }, - "com.amazonaws.cloudwatchlogs#EventMessage": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.cloudwatchlogs#EventNumber": { - "type": "long", - "traits": { - "smithy.api#default": 0 - } - }, - "com.amazonaws.cloudwatchlogs#EventsLimit": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 10000 - } - } - }, - "com.amazonaws.cloudwatchlogs#ExportDestinationBucket": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 512 - } - } - }, - "com.amazonaws.cloudwatchlogs#ExportDestinationPrefix": { - "type": "string" - }, - "com.amazonaws.cloudwatchlogs#ExportTask": { - "type": "structure", - "members": { - "taskId": { - "target": "com.amazonaws.cloudwatchlogs#ExportTaskId", - "traits": { - "smithy.api#documentation": "The ID of the export task.
" - } - }, - "taskName": { - "target": "com.amazonaws.cloudwatchlogs#ExportTaskName", - "traits": { - "smithy.api#documentation": "The name of the export task.
" - } - }, - "logGroupName": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupName", - "traits": { - "smithy.api#documentation": "The name of the log group from which logs data was exported.
" - } - }, - "from": { - "target": "com.amazonaws.cloudwatchlogs#Timestamp", - "traits": { - "smithy.api#documentation": "The start time, expressed as the number of milliseconds after Jan 1, 1970\n 00:00:00 UTC. Events with a timestamp before this time are not exported.
The end time, expressed as the number of milliseconds after Jan 1, 1970 00:00:00\n UTC. Events with a timestamp later than this time are not exported.
The name of the S3 bucket to which the log data was exported.
" - } - }, - "destinationPrefix": { - "target": "com.amazonaws.cloudwatchlogs#ExportDestinationPrefix", - "traits": { - "smithy.api#documentation": "The prefix that was used as the start of Amazon S3 key for every object exported.
" - } - }, - "status": { - "target": "com.amazonaws.cloudwatchlogs#ExportTaskStatus", - "traits": { - "smithy.api#documentation": "The status of the export task.
" - } - }, - "executionInfo": { - "target": "com.amazonaws.cloudwatchlogs#ExportTaskExecutionInfo", - "traits": { - "smithy.api#documentation": "Execution information about the export task.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Represents an export task.
" - } - }, - "com.amazonaws.cloudwatchlogs#ExportTaskExecutionInfo": { - "type": "structure", - "members": { - "creationTime": { - "target": "com.amazonaws.cloudwatchlogs#Timestamp", - "traits": { - "smithy.api#documentation": "The creation time of the export task, expressed as the number of milliseconds after\n Jan 1, 1970 00:00:00 UTC.
The completion time of the export task, expressed as the number of milliseconds after\n Jan 1, 1970 00:00:00 UTC.
Represents the status of an export task.
" - } - }, - "com.amazonaws.cloudwatchlogs#ExportTaskId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 512 - } - } - }, - "com.amazonaws.cloudwatchlogs#ExportTaskName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 512 - } - } - }, - "com.amazonaws.cloudwatchlogs#ExportTaskStatus": { - "type": "structure", - "members": { - "code": { - "target": "com.amazonaws.cloudwatchlogs#ExportTaskStatusCode", - "traits": { - "smithy.api#documentation": "The status code of the export task.
" - } - }, - "message": { - "target": "com.amazonaws.cloudwatchlogs#ExportTaskStatusMessage", - "traits": { - "smithy.api#documentation": "The status message related to the status code.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Represents the status of an export task.
" - } - }, - "com.amazonaws.cloudwatchlogs#ExportTaskStatusCode": { - "type": "enum", - "members": { - "CANCELLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CANCELLED" - } - }, - "COMPLETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COMPLETED" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - }, - "PENDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PENDING" - } - }, - "PENDING_CANCEL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PENDING_CANCEL" - } - }, - "RUNNING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RUNNING" - } - } - } - }, - "com.amazonaws.cloudwatchlogs#ExportTaskStatusMessage": { - "type": "string" - }, - "com.amazonaws.cloudwatchlogs#ExportTasks": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudwatchlogs#ExportTask" - } - }, - "com.amazonaws.cloudwatchlogs#ExtractedValues": { - "type": "map", - "key": { - "target": "com.amazonaws.cloudwatchlogs#Token" - }, - "value": { - "target": "com.amazonaws.cloudwatchlogs#Value" - } - }, - "com.amazonaws.cloudwatchlogs#Field": { - "type": "string" - }, - "com.amazonaws.cloudwatchlogs#FilterCount": { - "type": "integer" - }, - "com.amazonaws.cloudwatchlogs#FilterLogEvents": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#FilterLogEventsRequest" - }, - "output": { - "target": "com.amazonaws.cloudwatchlogs#FilterLogEventsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "Lists log events from the specified log group. You can list all the log events or filter the results\n using a filter pattern, a time range, and the name of the log stream.
\nYou must have the logs:FilterLogEvents permission to perform this operation.
You can specify the log group to search by using either logGroupIdentifier or logGroupName.\n You must include one of these two parameters, but you can't include both.\n
By default, this operation returns as many log events as can fit in 1 MB (up to 10,000\n log events) or all the events found within the specified time range. If the results include a\n token, that means there are more log events available. You can get additional results by\n specifying the token in a subsequent call. This operation can return empty results while there\n are more log events available through the token.
\nThe returned log events are sorted by event timestamp, the timestamp when the event was ingested\n by CloudWatch Logs, and the ID of the PutLogEvents request.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and \n view data from the linked source accounts. For more information, see \n CloudWatch cross-account observability.
", - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "limit" - } - } - }, - "com.amazonaws.cloudwatchlogs#FilterLogEventsRequest": { - "type": "structure", - "members": { - "logGroupName": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupName", - "traits": { - "smithy.api#documentation": "The name of the log group to search.
\n\n You must include either logGroupIdentifier or logGroupName, but not \n both.\n
Specify either the name or ARN of the log group to view log events from. If the log group is in a source account\n and you are using a monitoring account, you must use the log group ARN.
\n\n You must include either logGroupIdentifier or logGroupName, but not \n both.\n
Filters the results to only logs from the log streams in this list.
\nIf you specify a value for both logStreamNames and logStreamNamePrefix, the action\n returns an InvalidParameterException error.
Filters the results to include only events from log streams that have names starting with this prefix.
\nIf you specify a value for both logStreamNamePrefix and logStreamNames, the action\n returns an InvalidParameterException error.
The start of the time range, expressed as the number of milliseconds after Jan 1,\n 1970 00:00:00 UTC. Events with a timestamp before this time are not\n returned.
The end of the time range, expressed as the number of milliseconds after Jan 1,\n 1970 00:00:00 UTC. Events with a timestamp later than this time are not\n returned.
The filter pattern to use. For more information, see Filter and Pattern Syntax.
\nIf not provided, all the events are matched.
" - } - }, - "nextToken": { - "target": "com.amazonaws.cloudwatchlogs#NextToken", - "traits": { - "smithy.api#documentation": "The token for the next set of events to return. (You received this token from a previous call.)
" - } - }, - "limit": { - "target": "com.amazonaws.cloudwatchlogs#EventsLimit", - "traits": { - "smithy.api#documentation": "The maximum number of events to return. The default is 10,000 events.
" - } - }, - "interleaved": { - "target": "com.amazonaws.cloudwatchlogs#Interleaved", - "traits": { - "smithy.api#deprecated": { - "message": "Starting on June 17, 2019, this parameter will be ignored and the value will be assumed to be true. The response from this operation will always interleave events from multiple log streams within a log group." - }, - "smithy.api#documentation": "If the value is true, the operation attempts to provide responses that contain events\n from multiple log streams within the log group, interleaved in a single response. If the value\n is false, all the matched log events in the first log stream are searched first, then those in\n the next log stream, and so on.
\n\n Important As of June 17, 2019, this parameter is\n ignored and the value is assumed to be true. The response from this operation always\n interleaves events from multiple log streams within a log group.
" - } - }, - "unmask": { - "target": "com.amazonaws.cloudwatchlogs#Unmask", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "Specify true to display the log event fields with all sensitive data unmasked and visible.\n The default is false.
To use this operation with this parameter, you must be signed into an account with the logs:Unmask\n permission.
The matched events.
" - } - }, - "searchedLogStreams": { - "target": "com.amazonaws.cloudwatchlogs#SearchedLogStreams", - "traits": { - "smithy.api#documentation": "\n Important As of May 15, 2020, this parameter is no longer\n supported. This parameter returns an empty list.
\nIndicates which log streams have been searched and whether each has been searched completely.
" - } - }, - "nextToken": { - "target": "com.amazonaws.cloudwatchlogs#NextToken", - "traits": { - "smithy.api#documentation": "The token to use when requesting the next set of items. The token expires after 24 hours.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudwatchlogs#FilterName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 512 - }, - "smithy.api#pattern": "^[^:*]*$" - } - }, - "com.amazonaws.cloudwatchlogs#FilterPattern": { - "type": "string", - "traits": { - "smithy.api#documentation": "A symbolic description of how CloudWatch Logs should interpret the data in each log\n event. For example, a log event can contain timestamps, IP addresses, strings, and so on. You\n use the filter pattern to specify what to look for in the log event message.
", - "smithy.api#length": { - "min": 0, - "max": 1024 - } - } - }, - "com.amazonaws.cloudwatchlogs#FilteredLogEvent": { - "type": "structure", - "members": { - "logStreamName": { - "target": "com.amazonaws.cloudwatchlogs#LogStreamName", - "traits": { - "smithy.api#documentation": "The name of the log stream to which this event belongs.
" - } - }, - "timestamp": { - "target": "com.amazonaws.cloudwatchlogs#Timestamp", - "traits": { - "smithy.api#documentation": "The time the event occurred, expressed as the number of milliseconds after Jan 1,\n 1970 00:00:00 UTC.
The data contained in the log event.
" - } - }, - "ingestionTime": { - "target": "com.amazonaws.cloudwatchlogs#Timestamp", - "traits": { - "smithy.api#documentation": "The time the event was ingested, expressed as the number of milliseconds after\n Jan 1, 1970 00:00:00 UTC.
The ID of the event.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Represents a matched event.
" - } - }, - "com.amazonaws.cloudwatchlogs#FilteredLogEvents": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudwatchlogs#FilteredLogEvent" - } - }, - "com.amazonaws.cloudwatchlogs#ForceUpdate": { - "type": "boolean" - }, - "com.amazonaws.cloudwatchlogs#GetDataProtectionPolicy": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#GetDataProtectionPolicyRequest" - }, - "output": { - "target": "com.amazonaws.cloudwatchlogs#GetDataProtectionPolicyResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "Returns information about a log group data protection policy.
" - } - }, - "com.amazonaws.cloudwatchlogs#GetDataProtectionPolicyRequest": { - "type": "structure", - "members": { - "logGroupIdentifier": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupIdentifier", - "traits": { - "smithy.api#documentation": "The name or ARN of the log group that contains the data protection policy that you want to see.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#GetDataProtectionPolicyResponse": { - "type": "structure", - "members": { - "logGroupIdentifier": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupIdentifier", - "traits": { - "smithy.api#documentation": "The log group name or ARN that you specified in your request.
" - } - }, - "policyDocument": { - "target": "com.amazonaws.cloudwatchlogs#DataProtectionPolicyDocument", - "traits": { - "smithy.api#documentation": "The data protection policy document for this log group.
" - } - }, - "lastUpdatedTime": { - "target": "com.amazonaws.cloudwatchlogs#Timestamp", - "traits": { - "smithy.api#documentation": "The date and time that this policy was most recently updated.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudwatchlogs#GetDelivery": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#GetDeliveryRequest" - }, - "output": { - "target": "com.amazonaws.cloudwatchlogs#GetDeliveryResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ThrottlingException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Returns complete information about one logical delivery. A delivery is a \n connection between a \n delivery source\n and a \n \n delivery destination\n .
\nA delivery source represents an Amazon Web Services resource that sends logs to an logs delivery destination. \n The destination can be CloudWatch Logs, Amazon S3, or Firehose. \n Only some Amazon Web Services services support being configured as a delivery source. These services are listed\n in Enable logging from Amazon Web Services \n services.\n
\nYou need to specify the delivery id in this operation. You can find the IDs of the deliveries in your account with the \n DescribeDeliveries operation.
Retrieves complete information about one delivery destination.
" - } - }, - "com.amazonaws.cloudwatchlogs#GetDeliveryDestinationPolicy": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#GetDeliveryDestinationPolicyRequest" - }, - "output": { - "target": "com.amazonaws.cloudwatchlogs#GetDeliveryDestinationPolicyResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Retrieves the delivery destination policy assigned to the delivery destination that you specify.\n For more information about delivery destinations and their policies, see \n PutDeliveryDestinationPolicy.
" - } - }, - "com.amazonaws.cloudwatchlogs#GetDeliveryDestinationPolicyRequest": { - "type": "structure", - "members": { - "deliveryDestinationName": { - "target": "com.amazonaws.cloudwatchlogs#DeliveryDestinationName", - "traits": { - "smithy.api#documentation": "The name of the delivery destination that you want to retrieve the policy of.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#GetDeliveryDestinationPolicyResponse": { - "type": "structure", - "members": { - "policy": { - "target": "com.amazonaws.cloudwatchlogs#Policy", - "traits": { - "smithy.api#documentation": "The IAM policy for this delivery destination.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudwatchlogs#GetDeliveryDestinationRequest": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.cloudwatchlogs#DeliveryDestinationName", - "traits": { - "smithy.api#documentation": "The name of the delivery destination that you want to retrieve.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#GetDeliveryDestinationResponse": { - "type": "structure", - "members": { - "deliveryDestination": { - "target": "com.amazonaws.cloudwatchlogs#DeliveryDestination", - "traits": { - "smithy.api#documentation": "A structure containing information about the delivery destination.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudwatchlogs#GetDeliveryRequest": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.cloudwatchlogs#DeliveryId", - "traits": { - "smithy.api#documentation": "The ID of the delivery that you want to retrieve.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#GetDeliveryResponse": { - "type": "structure", - "members": { - "delivery": { - "target": "com.amazonaws.cloudwatchlogs#Delivery", - "traits": { - "smithy.api#documentation": "A structure that contains information about the delivery.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudwatchlogs#GetDeliverySource": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#GetDeliverySourceRequest" - }, - "output": { - "target": "com.amazonaws.cloudwatchlogs#GetDeliverySourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ThrottlingException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Retrieves complete information about one delivery source.
" - } - }, - "com.amazonaws.cloudwatchlogs#GetDeliverySourceRequest": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.cloudwatchlogs#DeliverySourceName", - "traits": { - "smithy.api#documentation": "The name of the delivery source that you want to retrieve.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#GetDeliverySourceResponse": { - "type": "structure", - "members": { - "deliverySource": { - "target": "com.amazonaws.cloudwatchlogs#DeliverySource", - "traits": { - "smithy.api#documentation": "A structure containing information about the delivery source.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudwatchlogs#GetLogAnomalyDetector": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#GetLogAnomalyDetectorRequest" - }, - "output": { - "target": "com.amazonaws.cloudwatchlogs#GetLogAnomalyDetectorResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "Retrieves information about the log anomaly detector that you specify.
" - } - }, - "com.amazonaws.cloudwatchlogs#GetLogAnomalyDetectorRequest": { - "type": "structure", - "members": { - "anomalyDetectorArn": { - "target": "com.amazonaws.cloudwatchlogs#AnomalyDetectorArn", - "traits": { - "smithy.api#documentation": "The ARN of the anomaly detector to retrieve information about. You can find the ARNs of log anomaly detectors \n in your account by using the ListLogAnomalyDetectors\n operation.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#GetLogAnomalyDetectorResponse": { - "type": "structure", - "members": { - "detectorName": { - "target": "com.amazonaws.cloudwatchlogs#DetectorName", - "traits": { - "smithy.api#documentation": "The name of the log anomaly detector
" - } - }, - "logGroupArnList": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupArnList", - "traits": { - "smithy.api#documentation": "An array of structures, where each structure contains the ARN of a log group\n associated with this anomaly detector.
" - } - }, - "evaluationFrequency": { - "target": "com.amazonaws.cloudwatchlogs#EvaluationFrequency", - "traits": { - "smithy.api#documentation": "Specifies how often the anomaly detector runs and look for anomalies. Set this value\n according to the frequency that the log group receives new logs. For example, if the log group\n receives new log events every 10 minutes, then setting evaluationFrequency to\n FIFTEEN_MIN might be appropriate.
Specifies whether the anomaly detector is currently active. To change its status, use\n the enabled parameter in the UpdateLogAnomalyDetector \n operation.
The ID of the KMS key assigned to this anomaly detector, if any.
" - } - }, - "creationTimeStamp": { - "target": "com.amazonaws.cloudwatchlogs#EpochMillis", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The date and time when this anomaly detector was created.
" - } - }, - "lastModifiedTimeStamp": { - "target": "com.amazonaws.cloudwatchlogs#EpochMillis", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The date and time when this anomaly detector was most recently modified.
" - } - }, - "anomalyVisibilityTime": { - "target": "com.amazonaws.cloudwatchlogs#AnomalyVisibilityTime", - "traits": { - "smithy.api#documentation": "The number of days used as the life cycle of anomalies. After this time, anomalies are automatically baselined \n and the anomaly detector model will treat new occurrences of similar event as normal.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudwatchlogs#GetLogEvents": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#GetLogEventsRequest" - }, - "output": { - "target": "com.amazonaws.cloudwatchlogs#GetLogEventsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "Lists log events from the specified log stream. You can list all of the log events or\n filter using a time range.
\nBy default, this operation returns as many log events as can fit in a response size of 1MB (up to 10,000 log events). \n You can get additional log events by specifying one of the tokens in a subsequent call.\n This operation can return empty results while there are more log events available through the token.
\nIf you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and \n view data from the linked source accounts. For more information, see \n CloudWatch cross-account observability.
\nYou can specify the log group to search by using either logGroupIdentifier or logGroupName.\n You must include one of these two parameters, but you can't include both.\n
The name of the log group.
\n\n You must include either logGroupIdentifier or logGroupName, but not \n both.\n
Specify either the name or ARN of the log group to view events from. If the log group is in a source account\n and you are using a monitoring account, you must use the log group ARN.
\n\n You must include either logGroupIdentifier or logGroupName, but not \n both.\n
The name of the log stream.
", - "smithy.api#required": {} - } - }, - "startTime": { - "target": "com.amazonaws.cloudwatchlogs#Timestamp", - "traits": { - "smithy.api#documentation": "The start of the time range, expressed as the number of milliseconds after Jan 1,\n 1970 00:00:00 UTC. Events with a timestamp equal to this time or later than this time\n are included. Events with a timestamp earlier than this time are not included.
The end of the time range, expressed as the number of milliseconds after Jan 1,\n 1970 00:00:00 UTC. Events with a timestamp equal to or later than this time are not\n included.
The token for the next set of items to return. (You received this token from a previous call.)
" - } - }, - "limit": { - "target": "com.amazonaws.cloudwatchlogs#EventsLimit", - "traits": { - "smithy.api#documentation": "The maximum number of log events returned. If you don't specify a limit, the default is\n as many log events as can fit in a response size of 1 MB (up to 10,000 log events).
" - } - }, - "startFromHead": { - "target": "com.amazonaws.cloudwatchlogs#StartFromHead", - "traits": { - "smithy.api#documentation": "If the value is true, the earliest log events are returned first.\n If the value is false, the latest log events are returned first.\n The default value is false.
\nIf you are using a previous nextForwardToken value as the nextToken in this operation, \n you must specify true for startFromHead.
Specify true to display the log event fields with all sensitive data unmasked and visible.\n The default is false.
To use this operation with this parameter, you must be signed into an account with the logs:Unmask\n permission.
The events.
" - } - }, - "nextForwardToken": { - "target": "com.amazonaws.cloudwatchlogs#NextToken", - "traits": { - "smithy.api#documentation": "The token for the next set of items in the forward direction. The token expires after\n 24 hours. If you have reached the end of the stream, it returns the same token you passed\n in.
" - } - }, - "nextBackwardToken": { - "target": "com.amazonaws.cloudwatchlogs#NextToken", - "traits": { - "smithy.api#documentation": "The token for the next set of items in the backward direction. The token expires after\n 24 hours. This token is not null. If you have reached the end of the stream, it returns the\n same token you passed in.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudwatchlogs#GetLogGroupFields": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#GetLogGroupFieldsRequest" - }, - "output": { - "target": "com.amazonaws.cloudwatchlogs#GetLogGroupFieldsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#LimitExceededException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "Returns a list of the fields that are included in log events in the specified log group.\n Includes the percentage of log events that contain each field. The search is limited to a time\n period that you specify.
\nYou can specify the log group to search by using either logGroupIdentifier or logGroupName.\n You must specify one of these parameters, but you can't specify both.\n
In the results, fields that start with @ are fields generated by CloudWatch\n Logs. For example, @timestamp is the timestamp of each log event. For more\n information about the fields that are generated by CloudWatch logs, see Supported\n Logs and Discovered Fields.
The response results are sorted by the frequency percentage, starting \n with the highest percentage.
\nIf you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and \n view data from the linked source accounts. For more information, see \n CloudWatch cross-account observability.
" - } - }, - "com.amazonaws.cloudwatchlogs#GetLogGroupFieldsRequest": { - "type": "structure", - "members": { - "logGroupName": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupName", - "traits": { - "smithy.api#documentation": "The name of the log group to search.
\n\n You must include either logGroupIdentifier or logGroupName, but not \n both.\n
The time to set as the center of the query. If you specify time, the 8 minutes before and\n 8 minutes after this time are searched. If you omit time, the most recent 15 minutes\n up to the current time are searched.
The time value is specified as epoch time, which is the number of seconds\n since January 1, 1970, 00:00:00 UTC.
Specify either the name or ARN of the log group to view. If the log group is in a source account and\n you are using a monitoring account, you must specify the ARN.
\n\n You must include either logGroupIdentifier or logGroupName, but not \n both.\n
The array of fields found in the query. Each object in the array contains the name of the\n field, along with the percentage of time it appeared in the log events that were\n queried.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudwatchlogs#GetLogRecord": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#GetLogRecordRequest" - }, - "output": { - "target": "com.amazonaws.cloudwatchlogs#GetLogRecordResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#LimitExceededException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "Retrieves all of the fields and values of a single log event. All fields are retrieved,\n even if the original query that produced the logRecordPointer retrieved only a\n subset of fields. Fields are returned as field name/field value pairs.
The full unparsed log event is returned within @message.
The pointer corresponding to the log event record you want to retrieve. You get this from\n the response of a GetQueryResults operation. In that response, the value of the\n @ptr field for a log event is the value to use as logRecordPointer\n to retrieve that complete log event record.
Specify true to display the log event fields with all sensitive data unmasked and visible.\n The default is false.
To use this operation with this parameter, you must be signed into an account with the logs:Unmask\n permission.
The requested log event, as a JSON string.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudwatchlogs#GetQueryResults": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#GetQueryResultsRequest" - }, - "output": { - "target": "com.amazonaws.cloudwatchlogs#GetQueryResultsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "Returns the results from the specified query.
\nOnly the fields requested in the query are returned, along with a @ptr\n field, which is the identifier for the log record. You can use the value of @ptr\n in a GetLogRecord\n operation to get the full log record.
\n GetQueryResults does not start running a query. To run a query, use StartQuery. For more information about how long results of previous queries\n are available, see CloudWatch Logs quotas.
If the value of the Status field in the output is Running, this operation \n returns only partial results. If you see a value of Scheduled or Running for the status, \n you can retry the operation later to see the final results.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account to start \n queries in linked source accounts. For more information, see \n CloudWatch cross-account observability.
" - } - }, - "com.amazonaws.cloudwatchlogs#GetQueryResultsRequest": { - "type": "structure", - "members": { - "queryId": { - "target": "com.amazonaws.cloudwatchlogs#QueryId", - "traits": { - "smithy.api#documentation": "The ID number of the query.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#GetQueryResultsResponse": { - "type": "structure", - "members": { - "results": { - "target": "com.amazonaws.cloudwatchlogs#QueryResults", - "traits": { - "smithy.api#documentation": "The log events that matched the query criteria during the most recent time it ran.
\nThe results value is an array of arrays. Each log event is one object in the\n top-level array. Each of these log event objects is an array of\n field/value pairs.
Includes the number of log events scanned by the query, the number of log events that\n matched the query criteria, and the total number of bytes in the scanned log events. These\n values reflect the full raw results of the query.
" - } - }, - "status": { - "target": "com.amazonaws.cloudwatchlogs#QueryStatus", - "traits": { - "smithy.api#documentation": "The status of the most recent running of the query. Possible values are Cancelled, \n Complete, Failed, Running, Scheduled, \n Timeout, and Unknown.
Queries time out after 60 minutes of runtime. To avoid having your queries time out,\n reduce the time range being searched or partition your query into a number of queries.
" - } - }, - "encryptionKey": { - "target": "com.amazonaws.cloudwatchlogs#EncryptionKey", - "traits": { - "smithy.api#documentation": "If you associated an KMS key with the CloudWatch Logs Insights\n query results in this account, this field displays the ARN of the key that's used to encrypt\n the query results when StartQuery stores\n them.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudwatchlogs#Histogram": { - "type": "map", - "key": { - "target": "com.amazonaws.cloudwatchlogs#Time" - }, - "value": { - "target": "com.amazonaws.cloudwatchlogs#Count" - } - }, - "com.amazonaws.cloudwatchlogs#IncludeLinkedAccounts": { - "type": "boolean" - }, - "com.amazonaws.cloudwatchlogs#InheritedProperties": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudwatchlogs#InheritedProperty" - } - }, - "com.amazonaws.cloudwatchlogs#InheritedProperty": { - "type": "enum", - "members": { - "ACCOUNT_DATA_PROTECTION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACCOUNT_DATA_PROTECTION" - } - } - } - }, - "com.amazonaws.cloudwatchlogs#InputLogEvent": { - "type": "structure", - "members": { - "timestamp": { - "target": "com.amazonaws.cloudwatchlogs#Timestamp", - "traits": { - "smithy.api#documentation": "The time the event occurred, expressed as the number of milliseconds after Jan 1,\n 1970 00:00:00 UTC.
The raw event message. Each log event can be no larger than 256 KB.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Represents a log event, which is a record of activity that was recorded \n by the application or resource being monitored.
" - } - }, - "com.amazonaws.cloudwatchlogs#InputLogEvents": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudwatchlogs#InputLogEvent" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10000 - } - } - }, - "com.amazonaws.cloudwatchlogs#InputLogStreamNames": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudwatchlogs#LogStreamName" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.cloudwatchlogs#Integer": { - "type": "integer", - "traits": { - "smithy.api#default": 0 - } - }, - "com.amazonaws.cloudwatchlogs#Interleaved": { - "type": "boolean" - }, - "com.amazonaws.cloudwatchlogs#InvalidOperationException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.cloudwatchlogs#Message" - } - }, - "traits": { - "smithy.api#documentation": "The operation is not valid on the specified resource.
", - "smithy.api#error": "client" - } - }, - "com.amazonaws.cloudwatchlogs#InvalidParameterException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.cloudwatchlogs#Message" - } - }, - "traits": { - "smithy.api#documentation": "A parameter is specified incorrectly.
", - "smithy.api#error": "client" - } - }, - "com.amazonaws.cloudwatchlogs#InvalidSequenceTokenException": { - "type": "structure", - "members": { - "expectedSequenceToken": { - "target": "com.amazonaws.cloudwatchlogs#SequenceToken" - }, - "message": { - "target": "com.amazonaws.cloudwatchlogs#Message" - } - }, - "traits": { - "smithy.api#documentation": "The sequence token is not valid. You can get the correct sequence token in \n the expectedSequenceToken field in the InvalidSequenceTokenException\n message.
\n PutLogEvents\n actions are now always accepted and never return\n InvalidSequenceTokenException regardless of receiving an invalid sequence token.
You have reached the maximum number of resources that can be created.
", - "smithy.api#error": "client" - } - }, - "com.amazonaws.cloudwatchlogs#ListAnomalies": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#ListAnomaliesRequest" - }, - "output": { - "target": "com.amazonaws.cloudwatchlogs#ListAnomaliesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "Returns a list of anomalies that log anomaly detectors have found. For details about the structure format of\n each anomaly object that is returned, see the example in this section.
", - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "anomalies", - "pageSize": "limit" - } - } - }, - "com.amazonaws.cloudwatchlogs#ListAnomaliesLimit": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.cloudwatchlogs#ListAnomaliesRequest": { - "type": "structure", - "members": { - "anomalyDetectorArn": { - "target": "com.amazonaws.cloudwatchlogs#AnomalyDetectorArn", - "traits": { - "smithy.api#documentation": "Use this to optionally limit the results to only the anomalies found by a certain \n anomaly detector.
" - } - }, - "suppressionState": { - "target": "com.amazonaws.cloudwatchlogs#SuppressionState", - "traits": { - "smithy.api#documentation": "You can specify this parameter if you want to the operation to return only anomalies that \n are currently either suppressed or unsuppressed.
" - } - }, - "limit": { - "target": "com.amazonaws.cloudwatchlogs#ListAnomaliesLimit", - "traits": { - "smithy.api#documentation": "The maximum number of items to return. If you don't specify a value, the default maximum value of \n 50 items is used.
" - } - }, - "nextToken": { - "target": "com.amazonaws.cloudwatchlogs#NextToken" - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#ListAnomaliesResponse": { - "type": "structure", - "members": { - "anomalies": { - "target": "com.amazonaws.cloudwatchlogs#Anomalies", - "traits": { - "smithy.api#documentation": "An array of structures, where each structure contains information about one anomaly that a log\n anomaly detector has found.
" - } - }, - "nextToken": { - "target": "com.amazonaws.cloudwatchlogs#NextToken" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudwatchlogs#ListLogAnomalyDetectors": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#ListLogAnomalyDetectorsRequest" - }, - "output": { - "target": "com.amazonaws.cloudwatchlogs#ListLogAnomalyDetectorsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "Retrieves a list of the log anomaly detectors in the account.
", - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "anomalyDetectors", - "pageSize": "limit" - } - } - }, - "com.amazonaws.cloudwatchlogs#ListLogAnomalyDetectorsLimit": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.cloudwatchlogs#ListLogAnomalyDetectorsRequest": { - "type": "structure", - "members": { - "filterLogGroupArn": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupArn", - "traits": { - "smithy.api#documentation": "Use this to optionally filter the results to only include anomaly detectors that are associated with the \n specified log group.
" - } - }, - "limit": { - "target": "com.amazonaws.cloudwatchlogs#ListLogAnomalyDetectorsLimit", - "traits": { - "smithy.api#documentation": "The maximum number of items to return. If you don't specify a value, the default maximum value of \n 50 items is used.
" - } - }, - "nextToken": { - "target": "com.amazonaws.cloudwatchlogs#NextToken" - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#ListLogAnomalyDetectorsResponse": { - "type": "structure", - "members": { - "anomalyDetectors": { - "target": "com.amazonaws.cloudwatchlogs#AnomalyDetectors", - "traits": { - "smithy.api#documentation": "An array of structures, where each structure in the array contains information about one anomaly detector.
" - } - }, - "nextToken": { - "target": "com.amazonaws.cloudwatchlogs#NextToken" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudwatchlogs#ListTagsForResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#ListTagsForResourceRequest" - }, - "output": { - "target": "com.amazonaws.cloudwatchlogs#ListTagsForResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "Displays the tags associated with a CloudWatch Logs resource. Currently, log groups \n and destinations support tagging.
" - } - }, - "com.amazonaws.cloudwatchlogs#ListTagsForResourceRequest": { - "type": "structure", - "members": { - "resourceArn": { - "target": "com.amazonaws.cloudwatchlogs#AmazonResourceName", - "traits": { - "smithy.api#documentation": "The ARN of the resource that you want to view tags for.
\nThe ARN format of a log group is \n arn:aws:logs:Region:account-id:log-group:log-group-name\n \n
The ARN format of a destination is \n arn:aws:logs:Region:account-id:destination:destination-name\n \n
For more information about ARN format, see CloudWatch Logs \n resources and operations.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#ListTagsForResourceResponse": { - "type": "structure", - "members": { - "tags": { - "target": "com.amazonaws.cloudwatchlogs#Tags", - "traits": { - "smithy.api#documentation": "The list of tags associated with the requested resource.>
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudwatchlogs#ListTagsLogGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#ListTagsLogGroupRequest" - }, - "output": { - "target": "com.amazonaws.cloudwatchlogs#ListTagsLogGroupResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "Please use the generic tagging API ListTagsForResource" + "shapes": { + "com.amazonaws.cloudwatchlogs#AccessDeniedException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.cloudwatchlogs#Message" + } + }, + "traits": { + "smithy.api#documentation": "You don't have sufficient permissions to perform this action.
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.cloudwatchlogs#AccessPolicy": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.cloudwatchlogs#AccountId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 12, + "max": 12 + }, + "smithy.api#pattern": "^\\d{12}$" + } + }, + "com.amazonaws.cloudwatchlogs#AccountIds": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#AccountId" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 20 + } + } + }, + "com.amazonaws.cloudwatchlogs#AccountPolicies": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#AccountPolicy" + } + }, + "com.amazonaws.cloudwatchlogs#AccountPolicy": { + "type": "structure", + "members": { + "policyName": { + "target": "com.amazonaws.cloudwatchlogs#PolicyName", + "traits": { + "smithy.api#documentation": "The name of the account policy.
" + } + }, + "policyDocument": { + "target": "com.amazonaws.cloudwatchlogs#AccountPolicyDocument", + "traits": { + "smithy.api#documentation": "The policy document for this account policy.
\nThe JSON specified in policyDocument can be up to 30,720 characters.
The date and time that this policy was most recently updated.
" + } + }, + "policyType": { + "target": "com.amazonaws.cloudwatchlogs#PolicyType", + "traits": { + "smithy.api#documentation": "The type of policy for this account policy.
" + } + }, + "scope": { + "target": "com.amazonaws.cloudwatchlogs#Scope", + "traits": { + "smithy.api#documentation": "The scope of the account policy.
" + } + }, + "selectionCriteria": { + "target": "com.amazonaws.cloudwatchlogs#SelectionCriteria", + "traits": { + "smithy.api#documentation": "The log group selection criteria for this subscription filter policy.
" + } + }, + "accountId": { + "target": "com.amazonaws.cloudwatchlogs#AccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID that the policy applies to.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A structure that contains information about one CloudWatch Logs account policy.
" + } + }, + "com.amazonaws.cloudwatchlogs#AccountPolicyDocument": { + "type": "string" + }, + "com.amazonaws.cloudwatchlogs#AllowedActionForAllowVendedLogsDeliveryForResource": { + "type": "string" + }, + "com.amazonaws.cloudwatchlogs#AllowedFieldDelimiters": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#FieldDelimiter" + } + }, + "com.amazonaws.cloudwatchlogs#AllowedFields": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#RecordField" + } + }, + "com.amazonaws.cloudwatchlogs#AmazonResourceName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1011 + }, + "smithy.api#pattern": "^[\\w+=/:,.@-]*$" + } + }, + "com.amazonaws.cloudwatchlogs#Anomalies": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#Anomaly" + } + }, + "com.amazonaws.cloudwatchlogs#Anomaly": { + "type": "structure", + "members": { + "anomalyId": { + "target": "com.amazonaws.cloudwatchlogs#AnomalyId", + "traits": { + "smithy.api#documentation": "The unique ID that CloudWatch Logs assigned to this anomaly.
", + "smithy.api#required": {} + } + }, + "patternId": { + "target": "com.amazonaws.cloudwatchlogs#PatternId", + "traits": { + "smithy.api#documentation": "The ID of the pattern used to help identify this anomaly.
", + "smithy.api#required": {} + } + }, + "anomalyDetectorArn": { + "target": "com.amazonaws.cloudwatchlogs#AnomalyDetectorArn", + "traits": { + "smithy.api#documentation": "The ARN of the anomaly detector that identified this anomaly.
", + "smithy.api#required": {} + } + }, + "patternString": { + "target": "com.amazonaws.cloudwatchlogs#PatternString", + "traits": { + "smithy.api#documentation": "The pattern used to help identify this anomaly, in string format.
", + "smithy.api#required": {} + } + }, + "patternRegex": { + "target": "com.amazonaws.cloudwatchlogs#PatternRegex", + "traits": { + "smithy.api#documentation": "The pattern used to help identify this anomaly, in regular expression format.
" + } + }, + "priority": { + "target": "com.amazonaws.cloudwatchlogs#Priority", + "traits": { + "smithy.api#documentation": "The priority level of this anomaly, as determined by CloudWatch Logs. Priority is computed based on log \n severity labels such as FATAL and ERROR and the amount of deviation from the baseline.\n Possible values are\n HIGH, MEDIUM, and LOW.
The date and time when the anomaly detector first saw this anomaly. \n It is specified as epoch time, which is the number of seconds\n since January 1, 1970, 00:00:00 UTC.
The date and time when the anomaly detector most recently saw this anomaly. \n It is specified as epoch time, which is the number of seconds\n since January 1, 1970, 00:00:00 UTC.
A human-readable description of the anomaly. This description is generated by\n CloudWatch Logs.
", + "smithy.api#required": {} + } + }, + "active": { + "target": "com.amazonaws.cloudwatchlogs#Boolean", + "traits": { + "smithy.api#documentation": "Specifies whether this anomaly is still ongoing.
", + "smithy.api#required": {} + } + }, + "state": { + "target": "com.amazonaws.cloudwatchlogs#State", + "traits": { + "smithy.api#documentation": "Indicates the current state of this anomaly. If it is still being treated as an anomaly, the value\n is Active. If you have suppressed this anomaly by using the UpdateAnomaly operation,\n the value is Suppressed. If this behavior is now considered to be normal, the value\n is Baseline.
A map showing times when the anomaly detector ran, and the number of occurrences of this anomaly that \n were detected at each of those runs. The times are specified in epoch time, which is the number of seconds\n since January 1, 1970, 00:00:00 UTC.
An array of sample log event messages that are considered to be part of this anomaly.
", + "smithy.api#required": {} + } + }, + "patternTokens": { + "target": "com.amazonaws.cloudwatchlogs#PatternTokens", + "traits": { + "smithy.api#documentation": "An array of structures where each structure contains information about one token that makes up the pattern.
", + "smithy.api#required": {} + } + }, + "logGroupArnList": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupArnList", + "traits": { + "smithy.api#documentation": "An array of ARNS of the log groups that contained log events considered to be part of this anomaly.
", + "smithy.api#required": {} + } + }, + "suppressed": { + "target": "com.amazonaws.cloudwatchlogs#Boolean", + "traits": { + "smithy.api#documentation": "Indicates whether this anomaly is currently suppressed. To suppress an anomaly, \n use UpdateAnomaly.
" + } + }, + "suppressedDate": { + "target": "com.amazonaws.cloudwatchlogs#EpochMillis", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "If the anomaly is suppressed, this indicates when it was suppressed.
" + } + }, + "suppressedUntil": { + "target": "com.amazonaws.cloudwatchlogs#EpochMillis", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "If the anomaly is suppressed, this indicates when the suppression will end. If this value is 0, \n the anomaly was suppressed with no expiration, with the INFINITE value.
If this anomaly is suppressed, this field is true if the suppression is because the \n pattern is suppressed. If false, then only this particular anomaly is suppressed.
This structure represents one anomaly that has been found by a logs anomaly detector.
\nFor more information about patterns and anomalies, see CreateLogAnomalyDetector.\n
" + } + }, + "com.amazonaws.cloudwatchlogs#AnomalyDetector": { + "type": "structure", + "members": { + "anomalyDetectorArn": { + "target": "com.amazonaws.cloudwatchlogs#AnomalyDetectorArn", + "traits": { + "smithy.api#documentation": "The ARN of the anomaly detector.
" + } + }, + "detectorName": { + "target": "com.amazonaws.cloudwatchlogs#DetectorName", + "traits": { + "smithy.api#documentation": "The name of the anomaly detector.
" + } + }, + "logGroupArnList": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupArnList", + "traits": { + "smithy.api#documentation": "A list of the ARNs of the log groups that this anomaly detector watches.
" + } + }, + "evaluationFrequency": { + "target": "com.amazonaws.cloudwatchlogs#EvaluationFrequency", + "traits": { + "smithy.api#documentation": "Specifies how often the anomaly detector runs and look for anomalies.
" + } + }, + "filterPattern": { + "target": "com.amazonaws.cloudwatchlogs#FilterPattern" + }, + "anomalyDetectorStatus": { + "target": "com.amazonaws.cloudwatchlogs#AnomalyDetectorStatus", + "traits": { + "smithy.api#documentation": "Specifies the current status of the anomaly detector. To pause an anomaly detector, use\n the enabled parameter in the UpdateLogAnomalyDetector \n operation.
The ID of the KMS key assigned to this anomaly detector, if any.
" + } + }, + "creationTimeStamp": { + "target": "com.amazonaws.cloudwatchlogs#EpochMillis", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The date and time when this anomaly detector was created.
" + } + }, + "lastModifiedTimeStamp": { + "target": "com.amazonaws.cloudwatchlogs#EpochMillis", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The date and time when this anomaly detector was most recently modified.
" + } + }, + "anomalyVisibilityTime": { + "target": "com.amazonaws.cloudwatchlogs#AnomalyVisibilityTime", + "traits": { + "smithy.api#documentation": "The number of days used as the life cycle of anomalies. After this time, anomalies are automatically baselined \n and the anomaly detector model will treat new occurrences of similar event as normal.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about one anomaly detector in the account.
" + } + }, + "com.amazonaws.cloudwatchlogs#AnomalyDetectorArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + }, + "smithy.api#pattern": "^[\\w#+=/:,.@-]*$" + } + }, + "com.amazonaws.cloudwatchlogs#AnomalyDetectorStatus": { + "type": "enum", + "members": { + "INITIALIZING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INITIALIZING" + } + }, + "TRAINING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TRAINING" + } + }, + "ANALYZING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ANALYZING" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" + } + }, + "PAUSED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PAUSED" + } + } + } + }, + "com.amazonaws.cloudwatchlogs#AnomalyDetectors": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#AnomalyDetector" + } + }, + "com.amazonaws.cloudwatchlogs#AnomalyId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 36, + "max": 36 + } + } + }, + "com.amazonaws.cloudwatchlogs#AnomalyVisibilityTime": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 7, + "max": 90 + } + } + }, + "com.amazonaws.cloudwatchlogs#Arn": { + "type": "string" + }, + "com.amazonaws.cloudwatchlogs#AssociateKmsKey": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#AssociateKmsKeyRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "Associates the specified KMS key with either one log group in the account, or with all stored\n CloudWatch Logs query insights results in the account.
\nWhen you use AssociateKmsKey, you specify either the logGroupName parameter\n or the resourceIdentifier parameter. You can't specify both of those parameters in the same operation.
Specify the logGroupName parameter to cause all log events stored in the log group to\n be encrypted with that key. Only the log events ingested after the key is associated are encrypted with that key.
Associating a KMS key with a log group overrides any existing\n associations between the log group and a KMS key. After a KMS key is associated with a log group, all newly ingested data for the log group is encrypted\n using the KMS key. This association is stored as long as the data encrypted\n with the KMS key is still within CloudWatch Logs. This enables CloudWatch Logs to decrypt this data whenever it is requested.
\nAssociating\n a key with a log group does not cause the results of queries of that log group to be encrypted with that key. To have query\n results encrypted with a KMS key, you must use an AssociateKmsKey operation with the resourceIdentifier\n parameter that specifies a query-result resource.
Specify the resourceIdentifier parameter with a query-result resource, \n to use that key to encrypt the stored results of all future \n StartQuery\n operations in the account. The response from a \n GetQueryResults\n operation will still return\n the query results in plain text.
Even if you have not associated a key with your query results, the query results are encrypted when stored,\n using the default CloudWatch Logs method.
\nIf you run a query from a monitoring account that queries logs in a source account, the\n query results key from the monitoring account, if any, is used.
\nIf you delete the key that is used to encrypt log events or log group query results,\n then all the associated stored log events or query results that were encrypted with that key \n will be unencryptable and unusable.
\nCloudWatch Logs supports only symmetric KMS keys. Do not use an associate\n an asymmetric KMS key with your log group or query results. For more information, see Using\n Symmetric and Asymmetric Keys.
\nIt can take up to 5 minutes for this operation to take effect.
\nIf you attempt to associate a KMS key with a log group but the KMS key does not exist or the KMS key is disabled, you receive an\n InvalidParameterException error.
The name of the log group.
\nIn your AssociateKmsKey operation,\n you must specify either the resourceIdentifier parameter or the logGroup parameter, \n but you can't specify both.
The Amazon Resource Name (ARN) of the KMS key to use when encrypting log\n data. This must be a symmetric KMS key. For more information, see Amazon Resource Names and Using Symmetric and Asymmetric\n Keys.
", + "smithy.api#required": {} + } + }, + "resourceIdentifier": { + "target": "com.amazonaws.cloudwatchlogs#ResourceIdentifier", + "traits": { + "smithy.api#documentation": "Specifies the target for this operation. You must specify one of the following:
\nSpecify the following ARN to have future GetQueryResults\n operations in this account encrypt the results\n with the specified KMS key. Replace\n REGION and ACCOUNT_ID with your Region and account ID.
\n\n arn:aws:logs:REGION:ACCOUNT_ID:query-result:*\n
Specify the ARN of a log group to have CloudWatch Logs use the KMS key\n to encrypt log events that are ingested and stored by that log group. The log group ARN must be in \n the following format. Replace\n REGION and ACCOUNT_ID with your Region and account ID.
\n\n arn:aws:logs:REGION:ACCOUNT_ID:log-group:LOG_GROUP_NAME\n \n
In your AssociateKmsKey operation,\n you must specify either the resourceIdentifier parameter or the logGroup parameter, \n but you can't specify both.
Cancels the specified export task.
\nThe task must be in the PENDING or RUNNING state.
The ID of the export task.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#ClientToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 36, + "max": 128 + }, + "smithy.api#pattern": "^\\S{36,128}$" + } + }, + "com.amazonaws.cloudwatchlogs#ConfigurationTemplate": { + "type": "structure", + "members": { + "service": { + "target": "com.amazonaws.cloudwatchlogs#Service", + "traits": { + "smithy.api#documentation": "A string specifying which service this configuration template applies to. For more information about supported services see \n Enable logging from Amazon Web Services \n services..
" + } + }, + "logType": { + "target": "com.amazonaws.cloudwatchlogs#LogType", + "traits": { + "smithy.api#documentation": "A string specifying which log type this configuration template applies to.
" + } + }, + "resourceType": { + "target": "com.amazonaws.cloudwatchlogs#ResourceType", + "traits": { + "smithy.api#documentation": "A string specifying which resource type this configuration template applies to.
" + } + }, + "deliveryDestinationType": { + "target": "com.amazonaws.cloudwatchlogs#DeliveryDestinationType", + "traits": { + "smithy.api#documentation": "A string specifying which destination type this configuration template applies to.
" + } + }, + "defaultDeliveryConfigValues": { + "target": "com.amazonaws.cloudwatchlogs#ConfigurationTemplateDeliveryConfigValues", + "traits": { + "smithy.api#documentation": "A mapping that displays the default value of each property within a delivery’s configuration,\n if it is not specified in the request.
" + } + }, + "allowedFields": { + "target": "com.amazonaws.cloudwatchlogs#AllowedFields", + "traits": { + "smithy.api#documentation": "The allowed fields that a caller can use in the recordFields parameter of a CreateDelivery or \n UpdateDeliveryConfiguration operation.
The list of delivery destination output formats that are supported by this log source.
" + } + }, + "allowedActionForAllowVendedLogsDeliveryForResource": { + "target": "com.amazonaws.cloudwatchlogs#AllowedActionForAllowVendedLogsDeliveryForResource", + "traits": { + "smithy.api#documentation": "The action permissions that a caller needs to have to be able to successfully create a delivery source on the \n desired resource type when calling PutDeliverySource.
" + } + }, + "allowedFieldDelimiters": { + "target": "com.amazonaws.cloudwatchlogs#AllowedFieldDelimiters", + "traits": { + "smithy.api#documentation": "The valid values that a caller can use as field delimiters when calling CreateDelivery or \n UpdateDeliveryConfiguration \n on a delivery that delivers in Plain, W3C, or Raw format.
The list of variable fields that can be used in the suffix path of a delivery that delivers to an S3 bucket.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A structure containing information about the deafult settings and available settings that you can use to configure a delivery or a \n delivery destination.
" + } + }, + "com.amazonaws.cloudwatchlogs#ConfigurationTemplateDeliveryConfigValues": { + "type": "structure", + "members": { + "recordFields": { + "target": "com.amazonaws.cloudwatchlogs#RecordFields", + "traits": { + "smithy.api#documentation": "The default record fields that will be delivered when a list of record fields is not provided in \n a CreateDelivery operation.
" + } + }, + "fieldDelimiter": { + "target": "com.amazonaws.cloudwatchlogs#FieldDelimiter", + "traits": { + "smithy.api#documentation": "The default field delimiter that is used in a CreateDelivery operation when\n the field delimiter is not specified in that operation. The field delimiter is used only when \n the final output delivery is in Plain, W3C, or Raw format.
The delivery parameters that are used when you create a delivery to a delivery destination that is an S3 Bucket.
" + } + } + }, + "traits": { + "smithy.api#documentation": "This structure contains the default values that are used for each configuration parameter when you use\n CreateDelivery to create a deliver under the current service type, resource type, and log type.
" + } + }, + "com.amazonaws.cloudwatchlogs#ConfigurationTemplates": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#ConfigurationTemplate" + } + }, + "com.amazonaws.cloudwatchlogs#ConflictException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.cloudwatchlogs#Message" + } + }, + "traits": { + "smithy.api#documentation": "This operation attempted to create a resource that already exists.
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.cloudwatchlogs#Count": { + "type": "long", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.cloudwatchlogs#CreateDelivery": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#CreateDeliveryRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#CreateDeliveryResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#AccessDeniedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ConflictException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ThrottlingException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a delivery. A delivery is a connection between a logical delivery source and a logical\n delivery destination\n that you have already created.
\nOnly some Amazon Web Services services support being configured as a delivery source using this operation. These services are listed\n as Supported [V2 Permissions] in the table at \n Enabling \n logging from Amazon Web Services services.\n
\nA delivery destination can represent a log group in CloudWatch Logs, an Amazon S3 bucket, or a delivery stream in Firehose.
\nTo configure logs delivery between a supported Amazon Web Services service and a destination, you must do the following:
\nCreate a delivery source, which is a logical object that represents the resource that is actually\n sending the logs. For more \n information, see PutDeliverySource.
\nCreate a delivery destination, which is a logical object that represents the actual\n delivery destination. For more \n information, see PutDeliveryDestination.
\nIf you are delivering logs cross-account, you must use \n PutDeliveryDestinationPolicy\n in the destination account to assign an IAM policy to the \n destination. This policy allows delivery to that destination.\n
\nUse CreateDelivery to create a delivery by pairing exactly one delivery source and one delivery destination.\n
You can configure a single delivery source to send logs to multiple destinations by creating multiple deliveries. You \n can also create multiple deliveries to configure multiple delivery sources to send logs to the same delivery destination.
\nYou can't update an existing delivery. You can only create and delete deliveries.
" + } + }, + "com.amazonaws.cloudwatchlogs#CreateDeliveryRequest": { + "type": "structure", + "members": { + "deliverySourceName": { + "target": "com.amazonaws.cloudwatchlogs#DeliverySourceName", + "traits": { + "smithy.api#documentation": "The name of the delivery source to use for this delivery.
", + "smithy.api#required": {} + } + }, + "deliveryDestinationArn": { + "target": "com.amazonaws.cloudwatchlogs#Arn", + "traits": { + "smithy.api#documentation": "The ARN of the delivery destination to use for this delivery.
", + "smithy.api#required": {} + } + }, + "recordFields": { + "target": "com.amazonaws.cloudwatchlogs#RecordFields", + "traits": { + "smithy.api#documentation": "The list of record fields to be delivered to the destination, in order. \n If the delivery’s log source has mandatory fields, they must be included in this list.
" + } + }, + "fieldDelimiter": { + "target": "com.amazonaws.cloudwatchlogs#FieldDelimiter", + "traits": { + "smithy.api#documentation": "The field delimiter to use between record fields when the final output format of a delivery\n is in Plain, W3C, or Raw format.
This structure contains parameters that are valid only when the delivery’s delivery destination is an S3 bucket.
" + } + }, + "tags": { + "target": "com.amazonaws.cloudwatchlogs#Tags", + "traits": { + "smithy.api#documentation": "An optional list of key-value pairs to associate with the resource.
\nFor more information about tagging, see \n Tagging Amazon Web Services resources\n
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#CreateDeliveryResponse": { + "type": "structure", + "members": { + "delivery": { + "target": "com.amazonaws.cloudwatchlogs#Delivery", + "traits": { + "smithy.api#documentation": "A structure that contains information about the delivery that you just created.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#CreateExportTask": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#CreateExportTaskRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#CreateExportTaskResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#LimitExceededException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceAlreadyExistsException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "Creates an export task so that you can efficiently export data from a log group to an\n Amazon S3 bucket. When you perform a CreateExportTask operation, you must use\n credentials that have permission to write to the S3 bucket that you specify as the\n destination.
Exporting log data to S3 buckets that are encrypted by KMS is supported.\n Exporting log data to Amazon S3 buckets that have S3 Object Lock enabled with a\n retention period is also supported.
\nExporting to S3 buckets that are encrypted with AES-256 is supported.
\nThis is an asynchronous call. If all the required information is provided, this \n operation initiates an export task and responds with the ID of the task. After the task has started,\n you can use DescribeExportTasks to get the status of the export task. Each account can\n only have one active (RUNNING or PENDING) export task at a time.\n To cancel an export task, use CancelExportTask.
You can export logs from multiple log groups or multiple time ranges to the same S3\n bucket. To separate log data for each export task, specify a prefix to be used as the Amazon\n S3 key prefix for all exported objects.
\nTime-based sorting on chunks of log data inside an exported file is not guaranteed. You can\n sort the exported log field data by using Linux utilities.
\nThe name of the export task.
" + } + }, + "logGroupName": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupName", + "traits": { + "smithy.api#documentation": "The name of the log group.
", + "smithy.api#required": {} + } + }, + "logStreamNamePrefix": { + "target": "com.amazonaws.cloudwatchlogs#LogStreamName", + "traits": { + "smithy.api#documentation": "Export only log streams that match the provided prefix. If you don't\n specify a value, no prefix filter is applied.
" + } + }, + "from": { + "target": "com.amazonaws.cloudwatchlogs#Timestamp", + "traits": { + "smithy.api#documentation": "The start time of the range for the request, expressed as the number of milliseconds\n after Jan 1, 1970 00:00:00 UTC. Events with a timestamp earlier than this time\n are not exported.
The end time of the range for the request, expressed as the number of milliseconds\n after Jan 1, 1970 00:00:00 UTC. Events with a timestamp later than this time are\n not exported.
You must specify a time that is not earlier than when this log group was created.
", + "smithy.api#required": {} + } + }, + "destination": { + "target": "com.amazonaws.cloudwatchlogs#ExportDestinationBucket", + "traits": { + "smithy.api#documentation": "The name of S3 bucket for the exported log data. The bucket must be in the same Amazon Web Services Region.
", + "smithy.api#required": {} + } + }, + "destinationPrefix": { + "target": "com.amazonaws.cloudwatchlogs#ExportDestinationPrefix", + "traits": { + "smithy.api#documentation": "The prefix used as the start of the key for every object exported. If you don't\n specify a value, the default is exportedlogs.
The ID of the export task.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#CreateLogAnomalyDetector": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#CreateLogAnomalyDetectorRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#CreateLogAnomalyDetectorResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#LimitExceededException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "Creates an anomaly detector that regularly scans one or more \n log groups and look for patterns\n and anomalies in the logs.
\nAn anomaly detector can help surface issues by automatically discovering anomalies in your log event traffic. \n An anomaly detector uses machine learning algorithms to scan log events and find patterns.\n \n A pattern is a shared text structure that recurs among your log fields. Patterns provide a useful tool for \n analyzing large sets of logs because a large number of log events can often be\n compressed into a few patterns.
\nThe anomaly detector uses pattern recognition to find anomalies, which are unusual log \n events. It uses the evaluationFrequency to compare current log events and patterns\n with trained baselines.
Fields within a pattern are called tokens.\n Fields that vary within a pattern, such as a \n request ID or timestamp, are referred to as dynamic tokens and\n represented by <*>.
The following is an example of a pattern:
\n\n [INFO] Request time: <*> ms\n
This pattern\n represents log events like [INFO] Request time: 327 ms and other similar log events\n that differ only by the number, in this csse 327. When the pattern is displayed, the different numbers are replaced\n by <*>\n
Any parts of log events that are masked as sensitive data are not scanned for anomalies. For more information\n about masking sensitive data, see \n Help protect sensitive log data with\n masking.\n
\nAn array containing the ARN of the log group that this anomaly detector will watch. You can specify only one\n log group ARN.
", + "smithy.api#required": {} + } + }, + "detectorName": { + "target": "com.amazonaws.cloudwatchlogs#DetectorName", + "traits": { + "smithy.api#documentation": "A name for this anomaly detector.
" + } + }, + "evaluationFrequency": { + "target": "com.amazonaws.cloudwatchlogs#EvaluationFrequency", + "traits": { + "smithy.api#documentation": "Specifies how often the anomaly detector is to run and look for anomalies. Set this value\n according to the frequency that the log group receives new logs. For example, if the log group\n receives new log events every 10 minutes, then 15 minutes might be a good setting for \n evaluationFrequency .
You can use this parameter to limit the anomaly detection model to examine only log events\n that match the pattern you specify here. For more information, see Filter and Pattern Syntax.
" + } + }, + "kmsKeyId": { + "target": "com.amazonaws.cloudwatchlogs#KmsKeyId", + "traits": { + "smithy.api#documentation": "Optionally assigns a KMS key to secure this anomaly detector and its findings. If a key is \n assigned, the anomalies found and the model used by this detector are encrypted at rest with the key. If \n a key is assigned to an anomaly detector, a user must have permissions for both this key and for the \n anomaly detector to retrieve information about the anomalies that it finds.
\nFor more information about using a KMS key and to see the required IAM\n policy, see Use a KMS key with an anomaly detector.
" + } + }, + "anomalyVisibilityTime": { + "target": "com.amazonaws.cloudwatchlogs#AnomalyVisibilityTime", + "traits": { + "smithy.api#documentation": "The number of days to have visibility on an anomaly. After this time period has elapsed for an anomaly, \n it will be automatically baselined and the anomaly detector will treat new occurrences of a similar anomaly as \n normal. Therefore, \n if you do not correct the cause of an \n anomaly during the time period specified in anomalyVisibilityTime, it will be considered normal \n going forward and will not be detected as an anomaly.
An optional list of key-value pairs to associate with the resource.
\nFor more information about tagging, see \n Tagging Amazon Web Services resources\n
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#CreateLogAnomalyDetectorResponse": { + "type": "structure", + "members": { + "anomalyDetectorArn": { + "target": "com.amazonaws.cloudwatchlogs#AnomalyDetectorArn", + "traits": { + "smithy.api#documentation": "The ARN of the log anomaly detector that you just created.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#CreateLogGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#CreateLogGroupRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#LimitExceededException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceAlreadyExistsException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a log group with the specified name. You can create up to 1,000,000 log groups per Region per account.
\nYou must use the following guidelines when naming a log group:
\nLog group names must be unique within a Region for an Amazon Web Services\n account.
\nLog group names can be between 1 and 512 characters long.
\nLog group names consist of the following characters: a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), \n '/' (forward slash), '.' (period), and '#' (number sign)
\nLog group names can't start with the string aws/\n
When you create a log group, by default the log events in the log group do not expire.\n To set a retention policy so that events expire and are deleted after a specified time, use\n PutRetentionPolicy.
\nIf you associate an KMS key with the log group, ingested data is\n encrypted using the KMS key. This association is stored as long as the data\n encrypted with the KMS key is still within CloudWatch Logs. This enables\n CloudWatch Logs to decrypt this data whenever it is requested.
\nIf you attempt to associate a KMS key with the log group but the KMS key does not exist or the KMS key is disabled, you receive an\n InvalidParameterException error.
CloudWatch Logs supports only symmetric KMS keys. Do not associate an\n asymmetric KMS key with your log group. For more information, see Using\n Symmetric and Asymmetric Keys.
\nA name for the log group.
", + "smithy.api#required": {} + } + }, + "kmsKeyId": { + "target": "com.amazonaws.cloudwatchlogs#KmsKeyId", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key to use when encrypting log\n data. For more information, see Amazon Resource\n Names.
" + } + }, + "tags": { + "target": "com.amazonaws.cloudwatchlogs#Tags", + "traits": { + "smithy.api#documentation": "The key-value pairs to use for the tags.
\nYou can grant users access to certain log groups while preventing them from accessing other log groups.\n To do so, tag your groups and use IAM policies that refer to those tags. To assign tags when \n you create a log group, you must have either the logs:TagResource or logs:TagLogGroup\n permission. For more information about tagging, see \n Tagging Amazon Web Services resources.\n For more information about using tags to control access, see \n Controlling access to Amazon Web Services resources using tags.
Use this parameter to specify the log group class for this log group. There are two classes:
\nThe Standard log class supports all CloudWatch Logs features.
The Infrequent Access log class supports a subset of CloudWatch Logs features\n and incurs lower costs.
If you omit this parameter, the default of STANDARD is used.
The value of logGroupClass can't be changed after a log group is created.
For details about the features supported by each class, see \n Log classes\n
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#CreateLogStream": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#CreateLogStreamRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceAlreadyExistsException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a log stream for the specified log group. A log stream is a sequence of log events\n that originate from a single source, such as an application instance or a resource that is \n being monitored.
\nThere is no limit on the number of log streams that you can create for a log group. There is a limit \n of 50 TPS on CreateLogStream operations, after which transactions are throttled.
You must use the following guidelines when naming a log stream:
\nLog stream names must be unique within the log group.
\nLog stream names can be between 1 and 512 characters long.
\nDon't use ':' (colon) or '*' (asterisk) characters.
\nThe name of the log group.
", + "smithy.api#required": {} + } + }, + "logStreamName": { + "target": "com.amazonaws.cloudwatchlogs#LogStreamName", + "traits": { + "smithy.api#documentation": "The name of the log stream.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DataAlreadyAcceptedException": { + "type": "structure", + "members": { + "expectedSequenceToken": { + "target": "com.amazonaws.cloudwatchlogs#SequenceToken" + }, + "message": { + "target": "com.amazonaws.cloudwatchlogs#Message" + } + }, + "traits": { + "smithy.api#documentation": "The event was already logged.
\n\n PutLogEvents\n actions are now always accepted and never return\n DataAlreadyAcceptedException regardless of whether a given batch of log events\n has already been accepted.
The number of days to retain the log events in the specified log group.\n Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1096, 1827, 2192, 2557, 2922, 3288, and 3653.
\nTo set a log group so that its log events do not expire, use DeleteRetentionPolicy.
" + } + }, + "com.amazonaws.cloudwatchlogs#DefaultValue": { + "type": "double" + }, + "com.amazonaws.cloudwatchlogs#DeleteAccountPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DeleteAccountPolicyRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a CloudWatch Logs account policy. This stops the policy from applying to all log groups\n or a subset of log groups in the account. Log-group level policies will still be in effect.
\nTo use this operation, you must be signed on with the correct permissions depending on the type of policy\n that you are deleting.
\nTo delete a data protection policy, you must have the logs:DeleteDataProtectionPolicy and \n logs:DeleteAccountPolicy permissions.
To delete a subscription filter policy, you must have the logs:DeleteSubscriptionFilter and \n logs:DeleteAccountPolicy permissions.
The name of the policy to delete.
", + "smithy.api#required": {} + } + }, + "policyType": { + "target": "com.amazonaws.cloudwatchlogs#PolicyType", + "traits": { + "smithy.api#documentation": "The type of policy to delete.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DeleteDataProtectionPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DeleteDataProtectionPolicyRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes the data protection policy from the specified log group.
\nFor more information about data protection policies, see PutDataProtectionPolicy.
" + } + }, + "com.amazonaws.cloudwatchlogs#DeleteDataProtectionPolicyRequest": { + "type": "structure", + "members": { + "logGroupIdentifier": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupIdentifier", + "traits": { + "smithy.api#documentation": "The name or ARN of the log group that you want to delete the data protection policy for.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DeleteDelivery": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DeleteDeliveryRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#ConflictException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ThrottlingException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes s delivery. A delivery is a connection between a logical delivery source and a logical\n delivery destination. Deleting a delivery only deletes the connection between the delivery source and delivery destination. It does\n not delete the delivery destination or the delivery source.
" + } + }, + "com.amazonaws.cloudwatchlogs#DeleteDeliveryDestination": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DeleteDeliveryDestinationRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#ConflictException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ThrottlingException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a delivery destination. A delivery is a connection between a logical delivery source and a logical\n delivery destination.
\nYou can't delete a delivery destination if any current deliveries are associated with it. To find whether any deliveries are associated with \n this delivery destination, use the DescribeDeliveries operation and check the deliveryDestinationArn field in the results.
Deletes a delivery destination policy. For more information about these policies,\n see PutDeliveryDestinationPolicy.
" + } + }, + "com.amazonaws.cloudwatchlogs#DeleteDeliveryDestinationPolicyRequest": { + "type": "structure", + "members": { + "deliveryDestinationName": { + "target": "com.amazonaws.cloudwatchlogs#DeliveryDestinationName", + "traits": { + "smithy.api#documentation": "The name of the delivery destination that you want to delete the policy for.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DeleteDeliveryDestinationRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.cloudwatchlogs#DeliveryDestinationName", + "traits": { + "smithy.api#documentation": "The name of the delivery destination that you want to delete. You can find a list of delivery destionation names\n by using the DescribeDeliveryDestinations\n operation.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DeleteDeliveryRequest": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.cloudwatchlogs#DeliveryId", + "traits": { + "smithy.api#documentation": "The unique ID of the delivery to delete. You can find the ID of a delivery with the \n DescribeDeliveries operation.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DeleteDeliverySource": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DeleteDeliverySourceRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#ConflictException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ThrottlingException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a delivery source. A delivery is a connection between a logical delivery source and a logical\n delivery destination.
\nYou can't delete a delivery source if any current deliveries are associated with it. To find whether any deliveries are associated with \n this delivery source, use the DescribeDeliveries operation and check the deliverySourceName field in the results.
The name of the delivery source that you want to delete.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DeleteDestination": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DeleteDestinationRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes the specified destination, and eventually disables all the\n subscription filters that publish to it. This operation does not delete the \n physical resource encapsulated by the destination.
" + } + }, + "com.amazonaws.cloudwatchlogs#DeleteDestinationRequest": { + "type": "structure", + "members": { + "destinationName": { + "target": "com.amazonaws.cloudwatchlogs#DestinationName", + "traits": { + "smithy.api#documentation": "The name of the destination.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DeleteLogAnomalyDetector": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DeleteLogAnomalyDetectorRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes the specified CloudWatch Logs anomaly detector.
" + } + }, + "com.amazonaws.cloudwatchlogs#DeleteLogAnomalyDetectorRequest": { + "type": "structure", + "members": { + "anomalyDetectorArn": { + "target": "com.amazonaws.cloudwatchlogs#AnomalyDetectorArn", + "traits": { + "smithy.api#documentation": "The ARN of the anomaly detector to delete. You can find the ARNs of log anomaly detectors \n in your account by using the ListLogAnomalyDetectors\n operation.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DeleteLogGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DeleteLogGroupRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes the specified log group and permanently deletes all the archived\n log events associated with the log group.
" + } + }, + "com.amazonaws.cloudwatchlogs#DeleteLogGroupRequest": { + "type": "structure", + "members": { + "logGroupName": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupName", + "traits": { + "smithy.api#documentation": "The name of the log group.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DeleteLogStream": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DeleteLogStreamRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes the specified log stream and permanently deletes all the archived log events associated\n with the log stream.
" + } + }, + "com.amazonaws.cloudwatchlogs#DeleteLogStreamRequest": { + "type": "structure", + "members": { + "logGroupName": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupName", + "traits": { + "smithy.api#documentation": "The name of the log group.
", + "smithy.api#required": {} + } + }, + "logStreamName": { + "target": "com.amazonaws.cloudwatchlogs#LogStreamName", + "traits": { + "smithy.api#documentation": "The name of the log stream.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DeleteMetricFilter": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DeleteMetricFilterRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes the specified metric filter.
" + } + }, + "com.amazonaws.cloudwatchlogs#DeleteMetricFilterRequest": { + "type": "structure", + "members": { + "logGroupName": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupName", + "traits": { + "smithy.api#documentation": "The name of the log group.
", + "smithy.api#required": {} + } + }, + "filterName": { + "target": "com.amazonaws.cloudwatchlogs#FilterName", + "traits": { + "smithy.api#documentation": "The name of the metric filter.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DeleteQueryDefinition": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DeleteQueryDefinitionRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#DeleteQueryDefinitionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a saved CloudWatch Logs Insights query definition. \n A query definition contains details about a saved CloudWatch Logs Insights query.
\nEach DeleteQueryDefinition operation can delete one query definition.
You must have the logs:DeleteQueryDefinition permission to be able to perform\n this operation.
The ID of the query definition that you want to delete. You can use DescribeQueryDefinitions to retrieve the\n IDs of your saved query definitions.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DeleteQueryDefinitionResponse": { + "type": "structure", + "members": { + "success": { + "target": "com.amazonaws.cloudwatchlogs#Success", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "A value of TRUE indicates that the operation succeeded. FALSE indicates that the operation\n failed.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#DeleteResourcePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DeleteResourcePolicyRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a resource policy from this account. This revokes \n the access of the identities in that policy to put log events to this account.
" + } + }, + "com.amazonaws.cloudwatchlogs#DeleteResourcePolicyRequest": { + "type": "structure", + "members": { + "policyName": { + "target": "com.amazonaws.cloudwatchlogs#PolicyName", + "traits": { + "smithy.api#documentation": "The name of the policy to be revoked. This parameter is required.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DeleteRetentionPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DeleteRetentionPolicyRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes the specified retention policy.
\nLog events do not expire if they belong to log groups without a retention policy.
" + } + }, + "com.amazonaws.cloudwatchlogs#DeleteRetentionPolicyRequest": { + "type": "structure", + "members": { + "logGroupName": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupName", + "traits": { + "smithy.api#documentation": "The name of the log group.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DeleteSubscriptionFilter": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DeleteSubscriptionFilterRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes the specified subscription filter.
" + } + }, + "com.amazonaws.cloudwatchlogs#DeleteSubscriptionFilterRequest": { + "type": "structure", + "members": { + "logGroupName": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupName", + "traits": { + "smithy.api#documentation": "The name of the log group.
", + "smithy.api#required": {} + } + }, + "filterName": { + "target": "com.amazonaws.cloudwatchlogs#FilterName", + "traits": { + "smithy.api#documentation": "The name of the subscription filter.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#Deliveries": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#Delivery" + } + }, + "com.amazonaws.cloudwatchlogs#Delivery": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.cloudwatchlogs#DeliveryId", + "traits": { + "smithy.api#documentation": "The unique ID that identifies this delivery in your account.
" + } + }, + "arn": { + "target": "com.amazonaws.cloudwatchlogs#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) that uniquely identifies this delivery.
" + } + }, + "deliverySourceName": { + "target": "com.amazonaws.cloudwatchlogs#DeliverySourceName", + "traits": { + "smithy.api#documentation": "The name of the delivery source that is associated with this delivery.
" + } + }, + "deliveryDestinationArn": { + "target": "com.amazonaws.cloudwatchlogs#Arn", + "traits": { + "smithy.api#documentation": "The ARN of the delivery destination that is associated with this delivery.
" + } + }, + "deliveryDestinationType": { + "target": "com.amazonaws.cloudwatchlogs#DeliveryDestinationType", + "traits": { + "smithy.api#documentation": "Displays whether the delivery destination associated with this delivery is CloudWatch Logs, Amazon S3, or Firehose.
" + } + }, + "recordFields": { + "target": "com.amazonaws.cloudwatchlogs#RecordFields", + "traits": { + "smithy.api#documentation": "The record fields used in this delivery.
" + } + }, + "fieldDelimiter": { + "target": "com.amazonaws.cloudwatchlogs#FieldDelimiter", + "traits": { + "smithy.api#documentation": "The field delimiter that is used between record fields when the final output format of a delivery\n is in Plain, W3C, or Raw format.
This structure contains delivery configurations that apply only when the delivery destination resource is an S3 bucket.
" + } + }, + "tags": { + "target": "com.amazonaws.cloudwatchlogs#Tags", + "traits": { + "smithy.api#documentation": "The tags that have been assigned to this delivery.
" + } + } + }, + "traits": { + "smithy.api#documentation": "This structure contains information about one delivery in your account.
\nA delivery is a connection between a logical delivery source and a logical\n delivery destination.
\nFor more information, see CreateDelivery.
\nYou can't update an existing delivery. You can only create and delete deliveries.
" + } + }, + "com.amazonaws.cloudwatchlogs#DeliveryDestination": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.cloudwatchlogs#DeliveryDestinationName", + "traits": { + "smithy.api#documentation": "The name of this delivery destination.
" + } + }, + "arn": { + "target": "com.amazonaws.cloudwatchlogs#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) that uniquely identifies this delivery destination.
" + } + }, + "deliveryDestinationType": { + "target": "com.amazonaws.cloudwatchlogs#DeliveryDestinationType", + "traits": { + "smithy.api#documentation": "Displays whether this delivery destination is CloudWatch Logs, Amazon S3, or Firehose.
" + } + }, + "outputFormat": { + "target": "com.amazonaws.cloudwatchlogs#OutputFormat", + "traits": { + "smithy.api#documentation": "The format of the logs that are sent to this delivery destination.
" + } + }, + "deliveryDestinationConfiguration": { + "target": "com.amazonaws.cloudwatchlogs#DeliveryDestinationConfiguration", + "traits": { + "smithy.api#documentation": "A structure that contains the ARN of the Amazon Web Services resource that will receive the logs.
" + } + }, + "tags": { + "target": "com.amazonaws.cloudwatchlogs#Tags", + "traits": { + "smithy.api#documentation": "The tags that have been assigned to this delivery destination.
" + } + } + }, + "traits": { + "smithy.api#documentation": "This structure contains information about one delivery destination in your account. \n A delivery destination is an Amazon Web Services resource that represents an \n Amazon Web Services service that logs can be sent to. CloudWatch Logs, Amazon S3, are supported as Firehose delivery destinations.
\nTo configure logs delivery between a supported Amazon Web Services service and a destination, you must do the following:
\nCreate a delivery source, which is a logical object that represents the resource that is actually\n sending the logs. For more \n information, see PutDeliverySource.
\nCreate a delivery destination, which is a logical object that represents the actual\n delivery destination.
\nIf you are delivering logs cross-account, you must use \n PutDeliveryDestinationPolicy\n in the destination account to assign an IAM policy to the \n destination. This policy allows delivery to that destination.\n
\nCreate a delivery by pairing exactly one delivery source and one delivery destination.\n For more information, see CreateDelivery.
\nYou can configure a single delivery source to send logs to multiple destinations by creating multiple deliveries. You \n can also create multiple deliveries to configure multiple delivery sources to send logs to the same delivery destination.
" + } + }, + "com.amazonaws.cloudwatchlogs#DeliveryDestinationConfiguration": { + "type": "structure", + "members": { + "destinationResourceArn": { + "target": "com.amazonaws.cloudwatchlogs#Arn", + "traits": { + "smithy.api#documentation": "The ARN of the Amazon Web Services destination that this delivery destination represents. That Amazon Web Services destination\n can be a log group in CloudWatch Logs, an Amazon S3 bucket, or a delivery stream in Firehose.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A structure that contains information about one logs delivery destination.
" + } + }, + "com.amazonaws.cloudwatchlogs#DeliveryDestinationName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 60 + }, + "smithy.api#pattern": "^[\\w-]*$" + } + }, + "com.amazonaws.cloudwatchlogs#DeliveryDestinationPolicy": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 51200 + } + } + }, + "com.amazonaws.cloudwatchlogs#DeliveryDestinationType": { + "type": "enum", + "members": { + "S3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "S3" + } + }, + "CWL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CWL" + } + }, + "FH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FH" + } + } + } + }, + "com.amazonaws.cloudwatchlogs#DeliveryDestinationTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#DeliveryDestinationType" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 3 + } + } + }, + "com.amazonaws.cloudwatchlogs#DeliveryDestinations": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#DeliveryDestination" + } + }, + "com.amazonaws.cloudwatchlogs#DeliveryId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[0-9A-Za-z]+$" + } + }, + "com.amazonaws.cloudwatchlogs#DeliverySource": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.cloudwatchlogs#DeliverySourceName", + "traits": { + "smithy.api#documentation": "The unique name of the delivery source.
" + } + }, + "arn": { + "target": "com.amazonaws.cloudwatchlogs#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) that uniquely identifies this delivery source.
" + } + }, + "resourceArns": { + "target": "com.amazonaws.cloudwatchlogs#ResourceArns", + "traits": { + "smithy.api#documentation": "This array contains the ARN of the Amazon Web Services resource that sends logs and is represented by \n this delivery source. Currently, only one ARN can be in the array.
" + } + }, + "service": { + "target": "com.amazonaws.cloudwatchlogs#Service", + "traits": { + "smithy.api#documentation": "The Amazon Web Services service that is sending logs.
" + } + }, + "logType": { + "target": "com.amazonaws.cloudwatchlogs#LogType", + "traits": { + "smithy.api#documentation": "The type of log that the source is sending. For valid values for this parameter, see the documentation for\n the source service.
" + } + }, + "tags": { + "target": "com.amazonaws.cloudwatchlogs#Tags", + "traits": { + "smithy.api#documentation": "The tags that have been assigned to this delivery source.
" + } + } + }, + "traits": { + "smithy.api#documentation": "This structure contains information about one delivery source in your account. \n A delivery source is an Amazon Web Services resource that sends logs to an\n Amazon Web Services destination. The destination can be CloudWatch Logs, Amazon S3, or Firehose.
\nOnly some Amazon Web Services services support being configured as a delivery source. These services are listed\n as Supported [V2 Permissions] in the table at \n Enabling \n logging from Amazon Web Services services.\n
\nTo configure logs delivery between a supported Amazon Web Services service and a destination, you must do the following:
\nCreate a delivery source, which is a logical object that represents the resource that is actually\n sending the logs. For more \n information, see PutDeliverySource.
\nCreate a delivery destination, which is a logical object that represents the actual\n delivery destination. For more \n information, see PutDeliveryDestination.
\nIf you are delivering logs cross-account, you must use \n PutDeliveryDestinationPolicy\n in the destination account to assign an IAM policy to the \n destination. This policy allows delivery to that destination.\n
\nCreate a delivery by pairing exactly one delivery source and one delivery destination.\n For more information, see CreateDelivery.
\nYou can configure a single delivery source to send logs to multiple destinations by creating multiple deliveries. You \n can also create multiple deliveries to configure multiple delivery sources to send logs to the same delivery destination.
" + } + }, + "com.amazonaws.cloudwatchlogs#DeliverySourceName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 60 + }, + "smithy.api#pattern": "^[\\w-]*$" + } + }, + "com.amazonaws.cloudwatchlogs#DeliverySources": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#DeliverySource" + } + }, + "com.amazonaws.cloudwatchlogs#DeliverySuffixPath": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.cloudwatchlogs#Descending": { + "type": "boolean" + }, + "com.amazonaws.cloudwatchlogs#DescribeAccountPolicies": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DescribeAccountPoliciesRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#DescribeAccountPoliciesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "Returns a list of all CloudWatch Logs account policies in the account.
" + } + }, + "com.amazonaws.cloudwatchlogs#DescribeAccountPoliciesRequest": { + "type": "structure", + "members": { + "policyType": { + "target": "com.amazonaws.cloudwatchlogs#PolicyType", + "traits": { + "smithy.api#documentation": "Use this parameter to limit the returned policies to only the policies that match the policy type that you\n specify.
", + "smithy.api#required": {} + } + }, + "policyName": { + "target": "com.amazonaws.cloudwatchlogs#PolicyName", + "traits": { + "smithy.api#documentation": "Use this parameter to limit the returned policies to only the policy with the name that you specify.
" + } + }, + "accountIdentifiers": { + "target": "com.amazonaws.cloudwatchlogs#AccountIds", + "traits": { + "smithy.api#documentation": "If you are using an account that is set up as a monitoring account for CloudWatch unified cross-account\n observability, you can use this to specify the account ID of a source account. If you do, \n the operation returns the account policy for the specified account. Currently, you can specify only\n one account ID in this parameter.
\nIf you\n omit this parameter, only the policy in the current account is returned.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DescribeAccountPoliciesResponse": { + "type": "structure", + "members": { + "accountPolicies": { + "target": "com.amazonaws.cloudwatchlogs#AccountPolicies", + "traits": { + "smithy.api#documentation": "An array of structures that contain information about the CloudWatch Logs account policies that match \n the specified filters.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#DescribeConfigurationTemplates": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DescribeConfigurationTemplatesRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#DescribeConfigurationTemplatesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ThrottlingException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Use this operation to return the valid and default values that are used when creating delivery sources, delivery destinations, and deliveries.\n For more information about deliveries, see CreateDelivery.
", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "configurationTemplates", + "pageSize": "limit" + } + } + }, + "com.amazonaws.cloudwatchlogs#DescribeConfigurationTemplatesRequest": { + "type": "structure", + "members": { + "service": { + "target": "com.amazonaws.cloudwatchlogs#Service", + "traits": { + "smithy.api#documentation": "Use this parameter to filter the response to include only the \n configuration templates that apply to the Amazon Web Services service that you specify here.
" + } + }, + "logTypes": { + "target": "com.amazonaws.cloudwatchlogs#LogTypes", + "traits": { + "smithy.api#documentation": "Use this parameter to filter the response to include only the \n configuration templates that apply to the log types that you specify here.
" + } + }, + "resourceTypes": { + "target": "com.amazonaws.cloudwatchlogs#ResourceTypes", + "traits": { + "smithy.api#documentation": "Use this parameter to filter the response to include only the \n configuration templates that apply to the resource types that you specify here.
" + } + }, + "deliveryDestinationTypes": { + "target": "com.amazonaws.cloudwatchlogs#DeliveryDestinationTypes", + "traits": { + "smithy.api#documentation": "Use this parameter to filter the response to include only the \n configuration templates that apply to the delivery destination types that you specify here.
" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken" + }, + "limit": { + "target": "com.amazonaws.cloudwatchlogs#DescribeLimit", + "traits": { + "smithy.api#documentation": "Use this parameter to limit the number of configuration templates that are returned\n in the response.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DescribeConfigurationTemplatesResponse": { + "type": "structure", + "members": { + "configurationTemplates": { + "target": "com.amazonaws.cloudwatchlogs#ConfigurationTemplates", + "traits": { + "smithy.api#documentation": "An array of objects, where each object describes one configuration template that matches\n the filters that you specified in the request.
" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#DescribeDeliveries": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DescribeDeliveriesRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#DescribeDeliveriesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ThrottlingException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves a list of the deliveries that have been created in the account.
\nA delivery is a \n connection between a \n delivery source\n and a \n \n delivery destination\n .
\nA delivery source represents an Amazon Web Services resource that sends logs to an logs delivery destination. \n The destination can be CloudWatch Logs, Amazon S3, or Firehose. \n Only some Amazon Web Services services support being configured as a delivery source. These services are listed\n in Enable logging from Amazon Web Services \n services.\n
", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "deliveries", + "pageSize": "limit" + } + } + }, + "com.amazonaws.cloudwatchlogs#DescribeDeliveriesRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken" + }, + "limit": { + "target": "com.amazonaws.cloudwatchlogs#DescribeLimit", + "traits": { + "smithy.api#documentation": "Optionally specify the maximum number of deliveries to return in the response.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DescribeDeliveriesResponse": { + "type": "structure", + "members": { + "deliveries": { + "target": "com.amazonaws.cloudwatchlogs#Deliveries", + "traits": { + "smithy.api#documentation": "An array of structures. Each structure contains information about one delivery in the account.
" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#DescribeDeliveryDestinations": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DescribeDeliveryDestinationsRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#DescribeDeliveryDestinationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ThrottlingException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves a list of the delivery destinations that have been created in the account.
", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "deliveryDestinations", + "pageSize": "limit" + } + } + }, + "com.amazonaws.cloudwatchlogs#DescribeDeliveryDestinationsRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken" + }, + "limit": { + "target": "com.amazonaws.cloudwatchlogs#DescribeLimit", + "traits": { + "smithy.api#documentation": "Optionally specify the maximum number of delivery destinations to return in the response.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DescribeDeliveryDestinationsResponse": { + "type": "structure", + "members": { + "deliveryDestinations": { + "target": "com.amazonaws.cloudwatchlogs#DeliveryDestinations", + "traits": { + "smithy.api#documentation": "An array of structures. Each structure contains information about one delivery destination in the account.
" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#DescribeDeliverySources": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DescribeDeliverySourcesRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#DescribeDeliverySourcesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ThrottlingException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves a list of the delivery sources that have been created in the account.
", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "deliverySources", + "pageSize": "limit" + } + } + }, + "com.amazonaws.cloudwatchlogs#DescribeDeliverySourcesRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken" + }, + "limit": { + "target": "com.amazonaws.cloudwatchlogs#DescribeLimit", + "traits": { + "smithy.api#documentation": "Optionally specify the maximum number of delivery sources to return in the response.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DescribeDeliverySourcesResponse": { + "type": "structure", + "members": { + "deliverySources": { + "target": "com.amazonaws.cloudwatchlogs#DeliverySources", + "traits": { + "smithy.api#documentation": "An array of structures. Each structure contains information about one delivery source in the account.
" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#DescribeDestinations": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DescribeDestinationsRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#DescribeDestinationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "Lists all your destinations. The results are ASCII-sorted by destination name.
", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "destinations", + "pageSize": "limit" + } + } + }, + "com.amazonaws.cloudwatchlogs#DescribeDestinationsRequest": { + "type": "structure", + "members": { + "DestinationNamePrefix": { + "target": "com.amazonaws.cloudwatchlogs#DestinationName", + "traits": { + "smithy.api#documentation": "The prefix to match. If you don't specify a value, no prefix filter is applied.
" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken", + "traits": { + "smithy.api#documentation": "The token for the next set of items to return. (You received this token from a previous call.)
" + } + }, + "limit": { + "target": "com.amazonaws.cloudwatchlogs#DescribeLimit", + "traits": { + "smithy.api#documentation": "The maximum number of items returned. If you don't specify a value, the default maximum value of \n 50 items is used.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DescribeDestinationsResponse": { + "type": "structure", + "members": { + "destinations": { + "target": "com.amazonaws.cloudwatchlogs#Destinations", + "traits": { + "smithy.api#documentation": "The destinations.
" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#DescribeExportTasks": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DescribeExportTasksRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#DescribeExportTasksResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the specified export tasks. You can list all your export tasks or filter \n the results based on task ID or task status.
" + } + }, + "com.amazonaws.cloudwatchlogs#DescribeExportTasksRequest": { + "type": "structure", + "members": { + "taskId": { + "target": "com.amazonaws.cloudwatchlogs#ExportTaskId", + "traits": { + "smithy.api#documentation": "The ID of the export task. Specifying a task ID filters the results to one or zero\n export tasks.
" + } + }, + "statusCode": { + "target": "com.amazonaws.cloudwatchlogs#ExportTaskStatusCode", + "traits": { + "smithy.api#documentation": "The status code of the export task. Specifying a status code filters the results to zero or more export tasks.
" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken", + "traits": { + "smithy.api#documentation": "The token for the next set of items to return. (You received this token from a previous call.)
" + } + }, + "limit": { + "target": "com.amazonaws.cloudwatchlogs#DescribeLimit", + "traits": { + "smithy.api#documentation": "The maximum number of items returned. If you don't specify a value, the default is up to 50 items.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DescribeExportTasksResponse": { + "type": "structure", + "members": { + "exportTasks": { + "target": "com.amazonaws.cloudwatchlogs#ExportTasks", + "traits": { + "smithy.api#documentation": "The export tasks.
" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#DescribeLimit": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.cloudwatchlogs#DescribeLogGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DescribeLogGroupsRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#DescribeLogGroupsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the specified log groups. You can list all your log groups or filter the results by prefix.\n The results are ASCII-sorted by log group name.
\nCloudWatch Logs doesn’t support IAM policies that control access to the DescribeLogGroups action by using the \n aws:ResourceTag/key-name\n condition key. Other CloudWatch Logs actions\n do support the use of the aws:ResourceTag/key-name\n condition key to control access.\n For more information about using tags to control access, see \n Controlling access to Amazon Web Services resources using tags.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and \n view data from the linked source accounts. For more information, see \n CloudWatch cross-account observability.
", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "logGroups", + "pageSize": "limit" + }, + "smithy.test#smokeTests": [ + { + "id": "DescribeLogGroupsSuccess", + "params": {}, + "vendorParams": { + "region": "us-west-2" + }, + "vendorParamsShape": "aws.test#AwsVendorParams", + "expect": { + "success": {} + } + } + ] + } + }, + "com.amazonaws.cloudwatchlogs#DescribeLogGroupsRequest": { + "type": "structure", + "members": { + "accountIdentifiers": { + "target": "com.amazonaws.cloudwatchlogs#AccountIds", + "traits": { + "smithy.api#documentation": "When includeLinkedAccounts is set to True, use this parameter to\n specify the list of accounts to search. You can specify as many as 20 account IDs in the array.
The prefix to match.
\n\n logGroupNamePrefix and logGroupNamePattern are mutually exclusive. \n Only one \n of these parameters can be passed.\n
If you specify a string for this parameter, the operation returns only log groups that have names\nthat match the string based on a case-sensitive substring search. For example, if you specify Foo, log groups\nnamed FooBar, aws/Foo, and GroupFoo would match, but foo, \nF/o/o and Froo would not match.
If you specify logGroupNamePattern in your request, then only\n arn, creationTime, and logGroupName\n are included in the response.
\n logGroupNamePattern and logGroupNamePrefix are mutually exclusive. \n Only one \n of these parameters can be passed.\n
The token for the next set of items to return. (You received this token from a previous call.)
" + } + }, + "limit": { + "target": "com.amazonaws.cloudwatchlogs#DescribeLimit", + "traits": { + "smithy.api#documentation": "The maximum number of items returned. If you don't specify a value, the default is up to 50 items.
" + } + }, + "includeLinkedAccounts": { + "target": "com.amazonaws.cloudwatchlogs#IncludeLinkedAccounts", + "traits": { + "smithy.api#documentation": "If you are using a monitoring account, set this to True to have the operation\n return log groups in \n the accounts listed in accountIdentifiers.
If this parameter is set to true and accountIdentifiers\n\n contains a null value, the operation returns all log groups in the monitoring account\n and all log groups in all source accounts that are linked to the monitoring account.
Specifies the log group class for this log group. There are two classes:
\nThe Standard log class supports all CloudWatch Logs features.
The Infrequent Access log class supports a subset of CloudWatch Logs features\n and incurs lower costs.
For details about the features supported by each class, see \n Log classes\n
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DescribeLogGroupsResponse": { + "type": "structure", + "members": { + "logGroups": { + "target": "com.amazonaws.cloudwatchlogs#LogGroups", + "traits": { + "smithy.api#documentation": "The log groups.
\nIf the retentionInDays value is not included for a log group, then that log\n group's events do not expire.
Lists the log streams for the specified log group. \n You can list all the log streams or filter the results by prefix.\n You can also control how the results are ordered.
\nYou can specify the log group to search by using either logGroupIdentifier or logGroupName.\n You must include one of these two parameters, but you can't include both.\n
This operation has a limit of five transactions per second, after which transactions are throttled.
\nIf you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and \n view data from the linked source accounts. For more information, see \n CloudWatch cross-account observability.
", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "logStreams", + "pageSize": "limit" + } + } + }, + "com.amazonaws.cloudwatchlogs#DescribeLogStreamsRequest": { + "type": "structure", + "members": { + "logGroupName": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupName", + "traits": { + "smithy.api#documentation": "The name of the log group.
\n\n You must include either logGroupIdentifier or logGroupName, but not \n both.\n
Specify either the name or ARN of the log group to view. If the log group is in a source account\n and you are using a monitoring account, you must use the log group ARN.
\n\n You must include either logGroupIdentifier or logGroupName, but not \n both.\n
The prefix to match.
\nIf orderBy is LastEventTime, you cannot specify this\n parameter.
If the value is LogStreamName, the results are ordered by log stream name.\n If the value is LastEventTime, the results are ordered by the event time. \n The default value is LogStreamName.
If you order the results by event time, you cannot specify the logStreamNamePrefix parameter.
\n lastEventTimestamp represents the time of the most recent log event in the\n log stream in CloudWatch Logs. This number is expressed as the number of milliseconds after\n Jan 1, 1970 00:00:00 UTC. lastEventTimestamp updates on an\n eventual consistency basis. It typically updates in less than an hour from ingestion, but in\n rare situations might take longer.
If the value is true, results are returned in descending order. \n If the value is to false, results are returned in ascending order.\n The default value is false.
" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken", + "traits": { + "smithy.api#documentation": "The token for the next set of items to return. (You received this token from a previous call.)
" + } + }, + "limit": { + "target": "com.amazonaws.cloudwatchlogs#DescribeLimit", + "traits": { + "smithy.api#documentation": "The maximum number of items returned. If you don't specify a value, the default is up to 50 items.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DescribeLogStreamsResponse": { + "type": "structure", + "members": { + "logStreams": { + "target": "com.amazonaws.cloudwatchlogs#LogStreams", + "traits": { + "smithy.api#documentation": "The log streams.
" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#DescribeMetricFilters": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DescribeMetricFiltersRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#DescribeMetricFiltersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the specified metric filters. You can list all of the metric filters or filter\n the results by log name, prefix, metric name, or metric namespace. The results are\n ASCII-sorted by filter name.
", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "metricFilters", + "pageSize": "limit" + } + } + }, + "com.amazonaws.cloudwatchlogs#DescribeMetricFiltersRequest": { + "type": "structure", + "members": { + "logGroupName": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupName", + "traits": { + "smithy.api#documentation": "The name of the log group.
" + } + }, + "filterNamePrefix": { + "target": "com.amazonaws.cloudwatchlogs#FilterName", + "traits": { + "smithy.api#documentation": "The prefix to match. CloudWatch Logs uses the value that you set here only if you also\n include the logGroupName parameter in your request.
The token for the next set of items to return. (You received this token from a previous call.)
" + } + }, + "limit": { + "target": "com.amazonaws.cloudwatchlogs#DescribeLimit", + "traits": { + "smithy.api#documentation": "The maximum number of items returned. If you don't specify a value, the default is up to 50 items.
" + } + }, + "metricName": { + "target": "com.amazonaws.cloudwatchlogs#MetricName", + "traits": { + "smithy.api#documentation": "Filters results to include only those with the specified metric name. If you include this parameter in your request, you \n must also include the metricNamespace parameter.
Filters results to include only those in the specified namespace. If you include this parameter in your request, you \n must also include the metricName parameter.
The metric filters.
" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#DescribeQueries": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DescribeQueriesRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#DescribeQueriesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "Returns a list of CloudWatch Logs Insights queries that are scheduled, running, or have\n been run recently in this account. You can request all queries or limit it to queries of a\n specific log group or queries with a certain status.
" + } + }, + "com.amazonaws.cloudwatchlogs#DescribeQueriesMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.cloudwatchlogs#DescribeQueriesRequest": { + "type": "structure", + "members": { + "logGroupName": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupName", + "traits": { + "smithy.api#documentation": "Limits the returned queries to only those for the specified log group.
" + } + }, + "status": { + "target": "com.amazonaws.cloudwatchlogs#QueryStatus", + "traits": { + "smithy.api#documentation": "Limits the returned queries to only those that have the specified status. Valid values are Cancelled, \n Complete, Failed, Running, and Scheduled.
Limits the number of returned queries to the specified number.
" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken" + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DescribeQueriesResponse": { + "type": "structure", + "members": { + "queries": { + "target": "com.amazonaws.cloudwatchlogs#QueryInfoList", + "traits": { + "smithy.api#documentation": "The list of queries that match the request.
" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#DescribeQueryDefinitions": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DescribeQueryDefinitionsRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#DescribeQueryDefinitionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "This operation returns a paginated list of your saved CloudWatch Logs Insights query definitions. You can\n retrieve query definitions from the current account or from a source account that is linked to the current account.
\nYou can use the queryDefinitionNamePrefix parameter to limit the results to only the\n query definitions that have names that start with a certain string.
Use this parameter to filter your results to only the query definitions that have names that start with the prefix you specify.
" + } + }, + "maxResults": { + "target": "com.amazonaws.cloudwatchlogs#QueryListMaxResults", + "traits": { + "smithy.api#documentation": "Limits the number of returned query definitions to the specified number.
" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken" + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DescribeQueryDefinitionsResponse": { + "type": "structure", + "members": { + "queryDefinitions": { + "target": "com.amazonaws.cloudwatchlogs#QueryDefinitionList", + "traits": { + "smithy.api#documentation": "The list of query definitions that match your request.
" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#DescribeResourcePolicies": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DescribeResourcePoliciesRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#DescribeResourcePoliciesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the resource policies in this account.
" + } + }, + "com.amazonaws.cloudwatchlogs#DescribeResourcePoliciesRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken" + }, + "limit": { + "target": "com.amazonaws.cloudwatchlogs#DescribeLimit", + "traits": { + "smithy.api#documentation": "The maximum number of resource policies to be displayed with one call of this API.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DescribeResourcePoliciesResponse": { + "type": "structure", + "members": { + "resourcePolicies": { + "target": "com.amazonaws.cloudwatchlogs#ResourcePolicies", + "traits": { + "smithy.api#documentation": "The resource policies that exist in this account.
" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#DescribeSubscriptionFilters": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DescribeSubscriptionFiltersRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#DescribeSubscriptionFiltersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the subscription filters for the specified log group. You can list all the subscription filters or filter the results by prefix.\n The results are ASCII-sorted by filter name.
", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "subscriptionFilters", + "pageSize": "limit" + } + } + }, + "com.amazonaws.cloudwatchlogs#DescribeSubscriptionFiltersRequest": { + "type": "structure", + "members": { + "logGroupName": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupName", + "traits": { + "smithy.api#documentation": "The name of the log group.
", + "smithy.api#required": {} + } + }, + "filterNamePrefix": { + "target": "com.amazonaws.cloudwatchlogs#FilterName", + "traits": { + "smithy.api#documentation": "The prefix to match. If you don't specify a value, no prefix filter is applied.
" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken", + "traits": { + "smithy.api#documentation": "The token for the next set of items to return. (You received this token from a previous call.)
" + } + }, + "limit": { + "target": "com.amazonaws.cloudwatchlogs#DescribeLimit", + "traits": { + "smithy.api#documentation": "The maximum number of items returned. If you don't specify a value, the default is up to 50 items.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DescribeSubscriptionFiltersResponse": { + "type": "structure", + "members": { + "subscriptionFilters": { + "target": "com.amazonaws.cloudwatchlogs#SubscriptionFilters", + "traits": { + "smithy.api#documentation": "The subscription filters.
" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#Description": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.cloudwatchlogs#Destination": { + "type": "structure", + "members": { + "destinationName": { + "target": "com.amazonaws.cloudwatchlogs#DestinationName", + "traits": { + "smithy.api#documentation": "The name of the destination.
" + } + }, + "targetArn": { + "target": "com.amazonaws.cloudwatchlogs#TargetArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the physical target where the log events are\n delivered (for example, a Kinesis stream).
" + } + }, + "roleArn": { + "target": "com.amazonaws.cloudwatchlogs#RoleArn", + "traits": { + "smithy.api#documentation": "A role for impersonation, used when delivering log events to the target.
" + } + }, + "accessPolicy": { + "target": "com.amazonaws.cloudwatchlogs#AccessPolicy", + "traits": { + "smithy.api#documentation": "An IAM policy document that governs which Amazon Web Services accounts can create subscription filters\n against this destination.
" + } + }, + "arn": { + "target": "com.amazonaws.cloudwatchlogs#Arn", + "traits": { + "smithy.api#documentation": "The ARN of this destination.
" + } + }, + "creationTime": { + "target": "com.amazonaws.cloudwatchlogs#Timestamp", + "traits": { + "smithy.api#documentation": "The creation time of the destination, expressed as the number of milliseconds after Jan\n 1, 1970 00:00:00 UTC.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a cross-account destination that receives subscription log events.
" + } + }, + "com.amazonaws.cloudwatchlogs#DestinationArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.cloudwatchlogs#DestinationName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + }, + "smithy.api#pattern": "^[^:*]*$" + } + }, + "com.amazonaws.cloudwatchlogs#Destinations": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#Destination" + } + }, + "com.amazonaws.cloudwatchlogs#DetectorName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.cloudwatchlogs#Dimensions": { + "type": "map", + "key": { + "target": "com.amazonaws.cloudwatchlogs#DimensionsKey" + }, + "value": { + "target": "com.amazonaws.cloudwatchlogs#DimensionsValue" + } + }, + "com.amazonaws.cloudwatchlogs#DimensionsKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + } + } + }, + "com.amazonaws.cloudwatchlogs#DimensionsValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + } + } + }, + "com.amazonaws.cloudwatchlogs#DisassociateKmsKey": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DisassociateKmsKeyRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "Disassociates the specified KMS key from the specified log\n group or from all CloudWatch Logs Insights query results in the account.
\nWhen you use DisassociateKmsKey, you specify either the logGroupName parameter\n or the resourceIdentifier parameter. You can't specify both of those parameters in the same operation.
Specify the logGroupName parameter to stop using the KMS key\n to encrypt future log events ingested and stored in the log group. Instead, they will be\n encrypted with the default CloudWatch Logs method. The log events that were ingested\n while the key was associated with the log group are still encrypted with that key.\n Therefore, CloudWatch Logs will need permissions for the key whenever that data is\n accessed.
Specify the resourceIdentifier parameter with the query-result\n resource to stop using the KMS key to encrypt the results of all\n future StartQuery\n operations in the account. They will instead be encrypted with the default CloudWatch Logs method. The results from queries that ran while the key was associated with\n the account are still encrypted with that key. Therefore, CloudWatch Logs will need\n permissions for the key whenever that data is accessed.
It can take up to 5 minutes for this operation to take effect.
" + } + }, + "com.amazonaws.cloudwatchlogs#DisassociateKmsKeyRequest": { + "type": "structure", + "members": { + "logGroupName": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupName", + "traits": { + "smithy.api#documentation": "The name of the log group.
\nIn your DisassociateKmsKey operation,\n you must specify either the resourceIdentifier parameter or the logGroup parameter, \n but you can't specify both.
Specifies the target for this operation. You must specify one of the following:
\nSpecify the ARN of a log group to stop having CloudWatch Logs use the KMS key\n to encrypt log events that are ingested and stored by that log group. After you run this operation, CloudWatch Logs\n encrypts ingested log events with the default CloudWatch Logs method. The log group ARN must be in \n the following format. Replace\n REGION and ACCOUNT_ID with your Region and account ID.
\n\n arn:aws:logs:REGION:ACCOUNT_ID:log-group:LOG_GROUP_NAME\n \n
Specify the following ARN to stop using this key to encrypt the results of future StartQuery\n operations in this account. Replace\n REGION and ACCOUNT_ID with your Region and account ID.
\n\n arn:aws:logs:REGION:ACCOUNT_ID:query-result:*\n
In your DisssociateKmsKey operation,\n you must specify either the resourceIdentifier parameter or the logGroup parameter, \n but you can't specify both.
The method used to distribute log data to the destination, which can be either\n random or grouped by log stream.
" + } + }, + "com.amazonaws.cloudwatchlogs#DynamicTokenPosition": { + "type": "integer", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.cloudwatchlogs#EncryptionKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.cloudwatchlogs#Entity": { + "type": "structure", + "members": { + "keyAttributes": { + "target": "com.amazonaws.cloudwatchlogs#EntityKeyAttributes", + "traits": { + "smithy.api#documentation": "Reserved for internal use.
" + } + }, + "attributes": { + "target": "com.amazonaws.cloudwatchlogs#EntityAttributes", + "traits": { + "smithy.api#documentation": "Reserved for internal use.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Reserved for internal use.
" + } + }, + "com.amazonaws.cloudwatchlogs#EntityAttributes": { + "type": "map", + "key": { + "target": "com.amazonaws.cloudwatchlogs#EntityAttributesKey" + }, + "value": { + "target": "com.amazonaws.cloudwatchlogs#EntityAttributesValue" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.cloudwatchlogs#EntityAttributesKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.cloudwatchlogs#EntityAttributesValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + } + } + }, + "com.amazonaws.cloudwatchlogs#EntityKeyAttributes": { + "type": "map", + "key": { + "target": "com.amazonaws.cloudwatchlogs#EntityKeyAttributesKey" + }, + "value": { + "target": "com.amazonaws.cloudwatchlogs#EntityKeyAttributesValue" + }, + "traits": { + "smithy.api#length": { + "min": 2, + "max": 3 + } + } + }, + "com.amazonaws.cloudwatchlogs#EntityKeyAttributesKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 32 + } + } + }, + "com.amazonaws.cloudwatchlogs#EntityKeyAttributesValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + } + } + }, + "com.amazonaws.cloudwatchlogs#EntityRejectionErrorType": { + "type": "enum", + "members": { + "INVALID_ENTITY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InvalidEntity" + } + }, + "INVALID_TYPE_VALUE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InvalidTypeValue" + } + }, + "INVALID_KEY_ATTRIBUTE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InvalidKeyAttributes" + } + }, + "INVALID_ATTRIBUTES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InvalidAttributes" + } + }, + "ENTITY_SIZE_TOO_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EntitySizeTooLarge" + } + }, + "UNSUPPORTED_LOG_GROUP_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UnsupportedLogGroupType" + } + }, + "MISSING_REQUIRED_FIELDS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MissingRequiredFields" + } + } + } + }, + "com.amazonaws.cloudwatchlogs#Enumerations": { + "type": "map", + "key": { + "target": "com.amazonaws.cloudwatchlogs#TokenString" + }, + "value": { + "target": "com.amazonaws.cloudwatchlogs#TokenValue" + } + }, + "com.amazonaws.cloudwatchlogs#EpochMillis": { + "type": "long", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.cloudwatchlogs#EvaluationFrequency": { + "type": "enum", + "members": { + "ONE_MIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ONE_MIN" + } + }, + "FIVE_MIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FIVE_MIN" + } + }, + "TEN_MIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TEN_MIN" + } + }, + "FIFTEEN_MIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FIFTEEN_MIN" + } + }, + "THIRTY_MIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "THIRTY_MIN" + } + }, + "ONE_HOUR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ONE_HOUR" + } + } + } + }, + "com.amazonaws.cloudwatchlogs#EventId": { + "type": "string" + }, + "com.amazonaws.cloudwatchlogs#EventMessage": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.cloudwatchlogs#EventNumber": { + "type": "long", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.cloudwatchlogs#EventsLimit": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 10000 + } + } + }, + "com.amazonaws.cloudwatchlogs#ExportDestinationBucket": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + } + } + }, + "com.amazonaws.cloudwatchlogs#ExportDestinationPrefix": { + "type": "string" + }, + "com.amazonaws.cloudwatchlogs#ExportTask": { + "type": "structure", + "members": { + "taskId": { + "target": "com.amazonaws.cloudwatchlogs#ExportTaskId", + "traits": { + "smithy.api#documentation": "The ID of the export task.
" + } + }, + "taskName": { + "target": "com.amazonaws.cloudwatchlogs#ExportTaskName", + "traits": { + "smithy.api#documentation": "The name of the export task.
" + } + }, + "logGroupName": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupName", + "traits": { + "smithy.api#documentation": "The name of the log group from which logs data was exported.
" + } + }, + "from": { + "target": "com.amazonaws.cloudwatchlogs#Timestamp", + "traits": { + "smithy.api#documentation": "The start time, expressed as the number of milliseconds after Jan 1, 1970\n 00:00:00 UTC. Events with a timestamp before this time are not exported.
The end time, expressed as the number of milliseconds after Jan 1, 1970 00:00:00\n UTC. Events with a timestamp later than this time are not exported.
The name of the S3 bucket to which the log data was exported.
" + } + }, + "destinationPrefix": { + "target": "com.amazonaws.cloudwatchlogs#ExportDestinationPrefix", + "traits": { + "smithy.api#documentation": "The prefix that was used as the start of Amazon S3 key for every object exported.
" + } + }, + "status": { + "target": "com.amazonaws.cloudwatchlogs#ExportTaskStatus", + "traits": { + "smithy.api#documentation": "The status of the export task.
" + } + }, + "executionInfo": { + "target": "com.amazonaws.cloudwatchlogs#ExportTaskExecutionInfo", + "traits": { + "smithy.api#documentation": "Execution information about the export task.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents an export task.
" + } + }, + "com.amazonaws.cloudwatchlogs#ExportTaskExecutionInfo": { + "type": "structure", + "members": { + "creationTime": { + "target": "com.amazonaws.cloudwatchlogs#Timestamp", + "traits": { + "smithy.api#documentation": "The creation time of the export task, expressed as the number of milliseconds after\n Jan 1, 1970 00:00:00 UTC.
The completion time of the export task, expressed as the number of milliseconds after\n Jan 1, 1970 00:00:00 UTC.
Represents the status of an export task.
" + } + }, + "com.amazonaws.cloudwatchlogs#ExportTaskId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + } + } + }, + "com.amazonaws.cloudwatchlogs#ExportTaskName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + } + } + }, + "com.amazonaws.cloudwatchlogs#ExportTaskStatus": { + "type": "structure", + "members": { + "code": { + "target": "com.amazonaws.cloudwatchlogs#ExportTaskStatusCode", + "traits": { + "smithy.api#documentation": "The status code of the export task.
" + } + }, + "message": { + "target": "com.amazonaws.cloudwatchlogs#ExportTaskStatusMessage", + "traits": { + "smithy.api#documentation": "The status message related to the status code.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents the status of an export task.
" + } + }, + "com.amazonaws.cloudwatchlogs#ExportTaskStatusCode": { + "type": "enum", + "members": { + "CANCELLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CANCELLED" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "PENDING_CANCEL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_CANCEL" + } + }, + "RUNNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RUNNING" + } + } + } + }, + "com.amazonaws.cloudwatchlogs#ExportTaskStatusMessage": { + "type": "string" + }, + "com.amazonaws.cloudwatchlogs#ExportTasks": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#ExportTask" + } + }, + "com.amazonaws.cloudwatchlogs#ExtractedValues": { + "type": "map", + "key": { + "target": "com.amazonaws.cloudwatchlogs#Token" + }, + "value": { + "target": "com.amazonaws.cloudwatchlogs#Value" + } + }, + "com.amazonaws.cloudwatchlogs#Field": { + "type": "string" + }, + "com.amazonaws.cloudwatchlogs#FieldDelimiter": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5 + } + } + }, + "com.amazonaws.cloudwatchlogs#FieldHeader": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.cloudwatchlogs#FilterCount": { + "type": "integer" + }, + "com.amazonaws.cloudwatchlogs#FilterLogEvents": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#FilterLogEventsRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#FilterLogEventsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "Lists log events from the specified log group. You can list all the log events or filter the results\n using a filter pattern, a time range, and the name of the log stream.
\nYou must have the logs:FilterLogEvents permission to perform this operation.
You can specify the log group to search by using either logGroupIdentifier or logGroupName.\n You must include one of these two parameters, but you can't include both.\n
By default, this operation returns as many log events as can fit in 1 MB (up to 10,000\n log events) or all the events found within the specified time range. If the results include a\n token, that means there are more log events available. You can get additional results by\n specifying the token in a subsequent call. This operation can return empty results while there\n are more log events available through the token.
\nThe returned log events are sorted by event timestamp, the timestamp when the event was ingested\n by CloudWatch Logs, and the ID of the PutLogEvents request.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and \n view data from the linked source accounts. For more information, see \n CloudWatch cross-account observability.
", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "limit" + } + } + }, + "com.amazonaws.cloudwatchlogs#FilterLogEventsRequest": { + "type": "structure", + "members": { + "logGroupName": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupName", + "traits": { + "smithy.api#documentation": "The name of the log group to search.
\n\n You must include either logGroupIdentifier or logGroupName, but not \n both.\n
Specify either the name or ARN of the log group to view log events from. If the log group is in a source account\n and you are using a monitoring account, you must use the log group ARN.
\n\n You must include either logGroupIdentifier or logGroupName, but not \n both.\n
Filters the results to only logs from the log streams in this list.
\nIf you specify a value for both logStreamNames and logStreamNamePrefix, the action\n returns an InvalidParameterException error.
Filters the results to include only events from log streams that have names starting with this prefix.
\nIf you specify a value for both logStreamNamePrefix and logStreamNames, the action\n returns an InvalidParameterException error.
The start of the time range, expressed as the number of milliseconds after Jan 1,\n 1970 00:00:00 UTC. Events with a timestamp before this time are not\n returned.
The end of the time range, expressed as the number of milliseconds after Jan 1,\n 1970 00:00:00 UTC. Events with a timestamp later than this time are not\n returned.
The filter pattern to use. For more information, see Filter and Pattern Syntax.
\nIf not provided, all the events are matched.
" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken", + "traits": { + "smithy.api#documentation": "The token for the next set of events to return. (You received this token from a previous call.)
" + } + }, + "limit": { + "target": "com.amazonaws.cloudwatchlogs#EventsLimit", + "traits": { + "smithy.api#documentation": "The maximum number of events to return. The default is 10,000 events.
" + } + }, + "interleaved": { + "target": "com.amazonaws.cloudwatchlogs#Interleaved", + "traits": { + "smithy.api#deprecated": { + "message": "Starting on June 17, 2019, this parameter will be ignored and the value will be assumed to be true. The response from this operation will always interleave events from multiple log streams within a log group." + }, + "smithy.api#documentation": "If the value is true, the operation attempts to provide responses that contain events\n from multiple log streams within the log group, interleaved in a single response. If the value\n is false, all the matched log events in the first log stream are searched first, then those in\n the next log stream, and so on.
\n\n Important As of June 17, 2019, this parameter is\n ignored and the value is assumed to be true. The response from this operation always\n interleaves events from multiple log streams within a log group.
" + } + }, + "unmask": { + "target": "com.amazonaws.cloudwatchlogs#Unmask", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Specify true to display the log event fields with all sensitive data unmasked and visible.\n The default is false.
To use this operation with this parameter, you must be signed into an account with the logs:Unmask\n permission.
The matched events.
" + } + }, + "searchedLogStreams": { + "target": "com.amazonaws.cloudwatchlogs#SearchedLogStreams", + "traits": { + "smithy.api#documentation": "\n Important As of May 15, 2020, this parameter is no longer\n supported. This parameter returns an empty list.
\nIndicates which log streams have been searched and whether each has been searched completely.
" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken", + "traits": { + "smithy.api#documentation": "The token to use when requesting the next set of items. The token expires after 24 hours.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#FilterName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + }, + "smithy.api#pattern": "^[^:*]*$" + } + }, + "com.amazonaws.cloudwatchlogs#FilterPattern": { + "type": "string", + "traits": { + "smithy.api#documentation": "A symbolic description of how CloudWatch Logs should interpret the data in each log\n event. For example, a log event can contain timestamps, IP addresses, strings, and so on. You\n use the filter pattern to specify what to look for in the log event message.
", + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, + "com.amazonaws.cloudwatchlogs#FilteredLogEvent": { + "type": "structure", + "members": { + "logStreamName": { + "target": "com.amazonaws.cloudwatchlogs#LogStreamName", + "traits": { + "smithy.api#documentation": "The name of the log stream to which this event belongs.
" + } + }, + "timestamp": { + "target": "com.amazonaws.cloudwatchlogs#Timestamp", + "traits": { + "smithy.api#documentation": "The time the event occurred, expressed as the number of milliseconds after Jan 1,\n 1970 00:00:00 UTC.
The data contained in the log event.
" + } + }, + "ingestionTime": { + "target": "com.amazonaws.cloudwatchlogs#Timestamp", + "traits": { + "smithy.api#documentation": "The time the event was ingested, expressed as the number of milliseconds after\n Jan 1, 1970 00:00:00 UTC.
The ID of the event.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a matched event.
" + } + }, + "com.amazonaws.cloudwatchlogs#FilteredLogEvents": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#FilteredLogEvent" + } + }, + "com.amazonaws.cloudwatchlogs#ForceUpdate": { + "type": "boolean" + }, + "com.amazonaws.cloudwatchlogs#GetDataProtectionPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#GetDataProtectionPolicyRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#GetDataProtectionPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "Returns information about a log group data protection policy.
" + } + }, + "com.amazonaws.cloudwatchlogs#GetDataProtectionPolicyRequest": { + "type": "structure", + "members": { + "logGroupIdentifier": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupIdentifier", + "traits": { + "smithy.api#documentation": "The name or ARN of the log group that contains the data protection policy that you want to see.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#GetDataProtectionPolicyResponse": { + "type": "structure", + "members": { + "logGroupIdentifier": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupIdentifier", + "traits": { + "smithy.api#documentation": "The log group name or ARN that you specified in your request.
" + } + }, + "policyDocument": { + "target": "com.amazonaws.cloudwatchlogs#DataProtectionPolicyDocument", + "traits": { + "smithy.api#documentation": "The data protection policy document for this log group.
" + } + }, + "lastUpdatedTime": { + "target": "com.amazonaws.cloudwatchlogs#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time that this policy was most recently updated.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#GetDelivery": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#GetDeliveryRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#GetDeliveryResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ThrottlingException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns complete information about one logical delivery. A delivery is a \n connection between a \n delivery source\n and a \n \n delivery destination\n .
\nA delivery source represents an Amazon Web Services resource that sends logs to an logs delivery destination. \n The destination can be CloudWatch Logs, Amazon S3, or Firehose. \n Only some Amazon Web Services services support being configured as a delivery source. These services are listed\n in Enable logging from Amazon Web Services \n services.\n
\nYou need to specify the delivery id in this operation. You can find the IDs of the deliveries in your account with the \n DescribeDeliveries operation.
Retrieves complete information about one delivery destination.
" + } + }, + "com.amazonaws.cloudwatchlogs#GetDeliveryDestinationPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#GetDeliveryDestinationPolicyRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#GetDeliveryDestinationPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves the delivery destination policy assigned to the delivery destination that you specify.\n For more information about delivery destinations and their policies, see \n PutDeliveryDestinationPolicy.
" + } + }, + "com.amazonaws.cloudwatchlogs#GetDeliveryDestinationPolicyRequest": { + "type": "structure", + "members": { + "deliveryDestinationName": { + "target": "com.amazonaws.cloudwatchlogs#DeliveryDestinationName", + "traits": { + "smithy.api#documentation": "The name of the delivery destination that you want to retrieve the policy of.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#GetDeliveryDestinationPolicyResponse": { + "type": "structure", + "members": { + "policy": { + "target": "com.amazonaws.cloudwatchlogs#Policy", + "traits": { + "smithy.api#documentation": "The IAM policy for this delivery destination.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#GetDeliveryDestinationRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.cloudwatchlogs#DeliveryDestinationName", + "traits": { + "smithy.api#documentation": "The name of the delivery destination that you want to retrieve.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#GetDeliveryDestinationResponse": { + "type": "structure", + "members": { + "deliveryDestination": { + "target": "com.amazonaws.cloudwatchlogs#DeliveryDestination", + "traits": { + "smithy.api#documentation": "A structure containing information about the delivery destination.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#GetDeliveryRequest": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.cloudwatchlogs#DeliveryId", + "traits": { + "smithy.api#documentation": "The ID of the delivery that you want to retrieve.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#GetDeliveryResponse": { + "type": "structure", + "members": { + "delivery": { + "target": "com.amazonaws.cloudwatchlogs#Delivery", + "traits": { + "smithy.api#documentation": "A structure that contains information about the delivery.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#GetDeliverySource": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#GetDeliverySourceRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#GetDeliverySourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ThrottlingException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves complete information about one delivery source.
" + } + }, + "com.amazonaws.cloudwatchlogs#GetDeliverySourceRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.cloudwatchlogs#DeliverySourceName", + "traits": { + "smithy.api#documentation": "The name of the delivery source that you want to retrieve.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#GetDeliverySourceResponse": { + "type": "structure", + "members": { + "deliverySource": { + "target": "com.amazonaws.cloudwatchlogs#DeliverySource", + "traits": { + "smithy.api#documentation": "A structure containing information about the delivery source.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#GetLogAnomalyDetector": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#GetLogAnomalyDetectorRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#GetLogAnomalyDetectorResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves information about the log anomaly detector that you specify.
" + } + }, + "com.amazonaws.cloudwatchlogs#GetLogAnomalyDetectorRequest": { + "type": "structure", + "members": { + "anomalyDetectorArn": { + "target": "com.amazonaws.cloudwatchlogs#AnomalyDetectorArn", + "traits": { + "smithy.api#documentation": "The ARN of the anomaly detector to retrieve information about. You can find the ARNs of log anomaly detectors \n in your account by using the ListLogAnomalyDetectors\n operation.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#GetLogAnomalyDetectorResponse": { + "type": "structure", + "members": { + "detectorName": { + "target": "com.amazonaws.cloudwatchlogs#DetectorName", + "traits": { + "smithy.api#documentation": "The name of the log anomaly detector
" + } + }, + "logGroupArnList": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupArnList", + "traits": { + "smithy.api#documentation": "An array of structures, where each structure contains the ARN of a log group\n associated with this anomaly detector.
" + } + }, + "evaluationFrequency": { + "target": "com.amazonaws.cloudwatchlogs#EvaluationFrequency", + "traits": { + "smithy.api#documentation": "Specifies how often the anomaly detector runs and look for anomalies. Set this value\n according to the frequency that the log group receives new logs. For example, if the log group\n receives new log events every 10 minutes, then setting evaluationFrequency to\n FIFTEEN_MIN might be appropriate.
Specifies whether the anomaly detector is currently active. To change its status, use\n the enabled parameter in the UpdateLogAnomalyDetector \n operation.
The ID of the KMS key assigned to this anomaly detector, if any.
" + } + }, + "creationTimeStamp": { + "target": "com.amazonaws.cloudwatchlogs#EpochMillis", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The date and time when this anomaly detector was created.
" + } + }, + "lastModifiedTimeStamp": { + "target": "com.amazonaws.cloudwatchlogs#EpochMillis", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The date and time when this anomaly detector was most recently modified.
" + } + }, + "anomalyVisibilityTime": { + "target": "com.amazonaws.cloudwatchlogs#AnomalyVisibilityTime", + "traits": { + "smithy.api#documentation": "The number of days used as the life cycle of anomalies. After this time, anomalies are automatically baselined \n and the anomaly detector model will treat new occurrences of similar event as normal.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#GetLogEvents": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#GetLogEventsRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#GetLogEventsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "Lists log events from the specified log stream. You can list all of the log events or\n filter using a time range.
\nBy default, this operation returns as many log events as can fit in a response size of 1MB (up to 10,000 log events). \n You can get additional log events by specifying one of the tokens in a subsequent call.\n This operation can return empty results while there are more log events available through the token.
\nIf you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and \n view data from the linked source accounts. For more information, see \n CloudWatch cross-account observability.
\nYou can specify the log group to search by using either logGroupIdentifier or logGroupName.\n You must include one of these two parameters, but you can't include both.\n
The name of the log group.
\n\n You must include either logGroupIdentifier or logGroupName, but not \n both.\n
Specify either the name or ARN of the log group to view events from. If the log group is in a source account\n and you are using a monitoring account, you must use the log group ARN.
\n\n You must include either logGroupIdentifier or logGroupName, but not \n both.\n
The name of the log stream.
", + "smithy.api#required": {} + } + }, + "startTime": { + "target": "com.amazonaws.cloudwatchlogs#Timestamp", + "traits": { + "smithy.api#documentation": "The start of the time range, expressed as the number of milliseconds after Jan 1,\n 1970 00:00:00 UTC. Events with a timestamp equal to this time or later than this time\n are included. Events with a timestamp earlier than this time are not included.
The end of the time range, expressed as the number of milliseconds after Jan 1,\n 1970 00:00:00 UTC. Events with a timestamp equal to or later than this time are not\n included.
The token for the next set of items to return. (You received this token from a previous call.)
" + } + }, + "limit": { + "target": "com.amazonaws.cloudwatchlogs#EventsLimit", + "traits": { + "smithy.api#documentation": "The maximum number of log events returned. If you don't specify a limit, the default is\n as many log events as can fit in a response size of 1 MB (up to 10,000 log events).
" + } + }, + "startFromHead": { + "target": "com.amazonaws.cloudwatchlogs#StartFromHead", + "traits": { + "smithy.api#documentation": "If the value is true, the earliest log events are returned first.\n If the value is false, the latest log events are returned first.\n The default value is false.
\nIf you are using a previous nextForwardToken value as the nextToken in this operation, \n you must specify true for startFromHead.
Specify true to display the log event fields with all sensitive data unmasked and visible.\n The default is false.
To use this operation with this parameter, you must be signed into an account with the logs:Unmask\n permission.
The events.
" + } + }, + "nextForwardToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken", + "traits": { + "smithy.api#documentation": "The token for the next set of items in the forward direction. The token expires after\n 24 hours. If you have reached the end of the stream, it returns the same token you passed\n in.
" + } + }, + "nextBackwardToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken", + "traits": { + "smithy.api#documentation": "The token for the next set of items in the backward direction. The token expires after\n 24 hours. This token is not null. If you have reached the end of the stream, it returns the\n same token you passed in.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#GetLogGroupFields": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#GetLogGroupFieldsRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#GetLogGroupFieldsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#LimitExceededException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "Returns a list of the fields that are included in log events in the specified log group.\n Includes the percentage of log events that contain each field. The search is limited to a time\n period that you specify.
\nYou can specify the log group to search by using either logGroupIdentifier or logGroupName.\n You must specify one of these parameters, but you can't specify both.\n
In the results, fields that start with @ are fields generated by CloudWatch\n Logs. For example, @timestamp is the timestamp of each log event. For more\n information about the fields that are generated by CloudWatch logs, see Supported\n Logs and Discovered Fields.
The response results are sorted by the frequency percentage, starting \n with the highest percentage.
\nIf you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and \n view data from the linked source accounts. For more information, see \n CloudWatch cross-account observability.
" + } + }, + "com.amazonaws.cloudwatchlogs#GetLogGroupFieldsRequest": { + "type": "structure", + "members": { + "logGroupName": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupName", + "traits": { + "smithy.api#documentation": "The name of the log group to search.
\n\n You must include either logGroupIdentifier or logGroupName, but not \n both.\n
The time to set as the center of the query. If you specify time, the 8 minutes before and\n 8 minutes after this time are searched. If you omit time, the most recent 15 minutes\n up to the current time are searched.
The time value is specified as epoch time, which is the number of seconds\n since January 1, 1970, 00:00:00 UTC.
Specify either the name or ARN of the log group to view. If the log group is in a source account and\n you are using a monitoring account, you must specify the ARN.
\n\n You must include either logGroupIdentifier or logGroupName, but not \n both.\n
The array of fields found in the query. Each object in the array contains the name of the\n field, along with the percentage of time it appeared in the log events that were\n queried.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#GetLogRecord": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#GetLogRecordRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#GetLogRecordResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#LimitExceededException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves all of the fields and values of a single log event. All fields are retrieved,\n even if the original query that produced the logRecordPointer retrieved only a\n subset of fields. Fields are returned as field name/field value pairs.
The full unparsed log event is returned within @message.
The pointer corresponding to the log event record you want to retrieve. You get this from\n the response of a GetQueryResults operation. In that response, the value of the\n @ptr field for a log event is the value to use as logRecordPointer\n to retrieve that complete log event record.
Specify true to display the log event fields with all sensitive data unmasked and visible.\n The default is false.
To use this operation with this parameter, you must be signed into an account with the logs:Unmask\n permission.
The requested log event, as a JSON string.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#GetQueryResults": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#GetQueryResultsRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#GetQueryResultsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "Returns the results from the specified query.
\nOnly the fields requested in the query are returned, along with a @ptr\n field, which is the identifier for the log record. You can use the value of @ptr\n in a GetLogRecord\n operation to get the full log record.
\n GetQueryResults does not start running a query. To run a query, use StartQuery. For more information about how long results of previous queries\n are available, see CloudWatch Logs quotas.
If the value of the Status field in the output is Running, this operation \n returns only partial results. If you see a value of Scheduled or Running for the status, \n you can retry the operation later to see the final results.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account to start \n queries in linked source accounts. For more information, see \n CloudWatch cross-account observability.
" + } + }, + "com.amazonaws.cloudwatchlogs#GetQueryResultsRequest": { + "type": "structure", + "members": { + "queryId": { + "target": "com.amazonaws.cloudwatchlogs#QueryId", + "traits": { + "smithy.api#documentation": "The ID number of the query.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#GetQueryResultsResponse": { + "type": "structure", + "members": { + "results": { + "target": "com.amazonaws.cloudwatchlogs#QueryResults", + "traits": { + "smithy.api#documentation": "The log events that matched the query criteria during the most recent time it ran.
\nThe results value is an array of arrays. Each log event is one object in the\n top-level array. Each of these log event objects is an array of\n field/value pairs.
Includes the number of log events scanned by the query, the number of log events that\n matched the query criteria, and the total number of bytes in the scanned log events. These\n values reflect the full raw results of the query.
" + } + }, + "status": { + "target": "com.amazonaws.cloudwatchlogs#QueryStatus", + "traits": { + "smithy.api#documentation": "The status of the most recent running of the query. Possible values are Cancelled, \n Complete, Failed, Running, Scheduled, \n Timeout, and Unknown.
Queries time out after 60 minutes of runtime. To avoid having your queries time out,\n reduce the time range being searched or partition your query into a number of queries.
" + } + }, + "encryptionKey": { + "target": "com.amazonaws.cloudwatchlogs#EncryptionKey", + "traits": { + "smithy.api#documentation": "If you associated an KMS key with the CloudWatch Logs Insights\n query results in this account, this field displays the ARN of the key that's used to encrypt\n the query results when StartQuery stores\n them.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#Histogram": { + "type": "map", + "key": { + "target": "com.amazonaws.cloudwatchlogs#Time" + }, + "value": { + "target": "com.amazonaws.cloudwatchlogs#Count" + } + }, + "com.amazonaws.cloudwatchlogs#IncludeLinkedAccounts": { + "type": "boolean" + }, + "com.amazonaws.cloudwatchlogs#InheritedProperties": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#InheritedProperty" + } + }, + "com.amazonaws.cloudwatchlogs#InheritedProperty": { + "type": "enum", + "members": { + "ACCOUNT_DATA_PROTECTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACCOUNT_DATA_PROTECTION" + } + } + } + }, + "com.amazonaws.cloudwatchlogs#InputLogEvent": { + "type": "structure", + "members": { + "timestamp": { + "target": "com.amazonaws.cloudwatchlogs#Timestamp", + "traits": { + "smithy.api#documentation": "The time the event occurred, expressed as the number of milliseconds after Jan 1,\n 1970 00:00:00 UTC.
The raw event message. Each log event can be no larger than 256 KB.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a log event, which is a record of activity that was recorded \n by the application or resource being monitored.
" + } + }, + "com.amazonaws.cloudwatchlogs#InputLogEvents": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#InputLogEvent" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10000 + } + } + }, + "com.amazonaws.cloudwatchlogs#InputLogStreamNames": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#LogStreamName" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.cloudwatchlogs#Integer": { + "type": "integer", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.cloudwatchlogs#Interleaved": { + "type": "boolean" + }, + "com.amazonaws.cloudwatchlogs#InvalidOperationException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.cloudwatchlogs#Message" + } + }, + "traits": { + "smithy.api#documentation": "The operation is not valid on the specified resource.
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.cloudwatchlogs#InvalidParameterException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.cloudwatchlogs#Message" + } + }, + "traits": { + "smithy.api#documentation": "A parameter is specified incorrectly.
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.cloudwatchlogs#InvalidSequenceTokenException": { + "type": "structure", + "members": { + "expectedSequenceToken": { + "target": "com.amazonaws.cloudwatchlogs#SequenceToken" + }, + "message": { + "target": "com.amazonaws.cloudwatchlogs#Message" + } + }, + "traits": { + "smithy.api#documentation": "The sequence token is not valid. You can get the correct sequence token in \n the expectedSequenceToken field in the InvalidSequenceTokenException\n message.
\n PutLogEvents\n actions are now always accepted and never return\n InvalidSequenceTokenException regardless of receiving an invalid sequence token.
You have reached the maximum number of resources that can be created.
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.cloudwatchlogs#ListAnomalies": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#ListAnomaliesRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#ListAnomaliesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "Returns a list of anomalies that log anomaly detectors have found. For details about the structure format of\n each anomaly object that is returned, see the example in this section.
", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "anomalies", + "pageSize": "limit" + } + } + }, + "com.amazonaws.cloudwatchlogs#ListAnomaliesLimit": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.cloudwatchlogs#ListAnomaliesRequest": { + "type": "structure", + "members": { + "anomalyDetectorArn": { + "target": "com.amazonaws.cloudwatchlogs#AnomalyDetectorArn", + "traits": { + "smithy.api#documentation": "Use this to optionally limit the results to only the anomalies found by a certain \n anomaly detector.
" + } + }, + "suppressionState": { + "target": "com.amazonaws.cloudwatchlogs#SuppressionState", + "traits": { + "smithy.api#documentation": "You can specify this parameter if you want to the operation to return only anomalies that \n are currently either suppressed or unsuppressed.
" + } + }, + "limit": { + "target": "com.amazonaws.cloudwatchlogs#ListAnomaliesLimit", + "traits": { + "smithy.api#documentation": "The maximum number of items to return. If you don't specify a value, the default maximum value of \n 50 items is used.
" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken" + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#ListAnomaliesResponse": { + "type": "structure", + "members": { + "anomalies": { + "target": "com.amazonaws.cloudwatchlogs#Anomalies", + "traits": { + "smithy.api#documentation": "An array of structures, where each structure contains information about one anomaly that a log\n anomaly detector has found.
" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#ListLogAnomalyDetectors": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#ListLogAnomalyDetectorsRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#ListLogAnomalyDetectorsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves a list of the log anomaly detectors in the account.
", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "anomalyDetectors", + "pageSize": "limit" + } + } + }, + "com.amazonaws.cloudwatchlogs#ListLogAnomalyDetectorsLimit": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.cloudwatchlogs#ListLogAnomalyDetectorsRequest": { + "type": "structure", + "members": { + "filterLogGroupArn": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupArn", + "traits": { + "smithy.api#documentation": "Use this to optionally filter the results to only include anomaly detectors that are associated with the \n specified log group.
" + } + }, + "limit": { + "target": "com.amazonaws.cloudwatchlogs#ListLogAnomalyDetectorsLimit", + "traits": { + "smithy.api#documentation": "The maximum number of items to return. If you don't specify a value, the default maximum value of \n 50 items is used.
" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken" + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#ListLogAnomalyDetectorsResponse": { + "type": "structure", + "members": { + "anomalyDetectors": { + "target": "com.amazonaws.cloudwatchlogs#AnomalyDetectors", + "traits": { + "smithy.api#documentation": "An array of structures, where each structure in the array contains information about one anomaly detector.
" + } + }, + "nextToken": { + "target": "com.amazonaws.cloudwatchlogs#NextToken" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "Displays the tags associated with a CloudWatch Logs resource. Currently, log groups \n and destinations support tagging.
" + } + }, + "com.amazonaws.cloudwatchlogs#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.cloudwatchlogs#AmazonResourceName", + "traits": { + "smithy.api#documentation": "The ARN of the resource that you want to view tags for.
\nThe ARN format of a log group is \n arn:aws:logs:Region:account-id:log-group:log-group-name\n \n
The ARN format of a destination is \n arn:aws:logs:Region:account-id:destination:destination-name\n \n
For more information about ARN format, see CloudWatch Logs \n resources and operations.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "tags": { + "target": "com.amazonaws.cloudwatchlogs#Tags", + "traits": { + "smithy.api#documentation": "The list of tags associated with the requested resource.>
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#ListTagsLogGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#ListTagsLogGroupRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#ListTagsLogGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#deprecated": { + "message": "Please use the generic tagging API ListTagsForResource" + }, + "smithy.api#documentation": "The ListTagsLogGroup operation is on the path to deprecation. We recommend that you use \n ListTagsForResource instead.
\nLists the tags for the specified log group.
" + } + }, + "com.amazonaws.cloudwatchlogs#ListTagsLogGroupRequest": { + "type": "structure", + "members": { + "logGroupName": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupName", + "traits": { + "smithy.api#documentation": "The name of the log group.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#deprecated": { + "message": "Please use the generic tagging API model ListTagsForResourceRequest and ListTagsForResourceResponse" + }, + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#ListTagsLogGroupResponse": { + "type": "structure", + "members": { + "tags": { + "target": "com.amazonaws.cloudwatchlogs#Tags", + "traits": { + "smithy.api#documentation": "The tags for the log group.
" + } + } + }, + "traits": { + "smithy.api#deprecated": { + "message": "Please use the generic tagging API model ListTagsForResourceRequest and ListTagsForResourceResponse" + }, + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#LiveTailSessionLogEvent": { + "type": "structure", + "members": { + "logStreamName": { + "target": "com.amazonaws.cloudwatchlogs#LogStreamName", + "traits": { + "smithy.api#documentation": "The name of the log stream that ingested this log event.
" + } + }, + "logGroupIdentifier": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupIdentifier", + "traits": { + "smithy.api#documentation": "The name or ARN of the log group that ingested this log event.
" + } + }, + "message": { + "target": "com.amazonaws.cloudwatchlogs#EventMessage", + "traits": { + "smithy.api#documentation": "The log event message text.
" + } + }, + "timestamp": { + "target": "com.amazonaws.cloudwatchlogs#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp specifying when this log event was created.
" + } + }, + "ingestionTime": { + "target": "com.amazonaws.cloudwatchlogs#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp specifying when this log event was ingested into the log group.
" + } + } + }, + "traits": { + "smithy.api#documentation": "This object contains the information for one log event returned in a Live Tail stream.
" + } + }, + "com.amazonaws.cloudwatchlogs#LiveTailSessionMetadata": { + "type": "structure", + "members": { + "sampled": { + "target": "com.amazonaws.cloudwatchlogs#IsSampled", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "If this is true, then more than 500 log events matched the request for this update, and the \n sessionResults includes a sample of 500 of those events.
If this is false, then 500 or fewer log events matched the request for this update, so no sampling\n was necessary. In this case, the \n sessionResults array includes all log events that matched your request during this time.
This object contains the metadata for one LiveTailSessionUpdate structure. It indicates whether\n that update includes only a sample of 500 log events out of a larger number of ingested log events, or if it contains\n all of the matching log events ingested during that second of time.
The unique ID generated by CloudWatch Logs to identify this Live Tail session request.
" + } + }, + "sessionId": { + "target": "com.amazonaws.cloudwatchlogs#SessionId", + "traits": { + "smithy.api#documentation": "The unique ID generated by CloudWatch Logs to identify this Live Tail session.
" + } + }, + "logGroupIdentifiers": { + "target": "com.amazonaws.cloudwatchlogs#StartLiveTailLogGroupIdentifiers", + "traits": { + "smithy.api#documentation": "An array of the names and ARNs of the log groups included in this Live Tail session.
" + } + }, + "logStreamNames": { + "target": "com.amazonaws.cloudwatchlogs#InputLogStreamNames", + "traits": { + "smithy.api#documentation": "If your StartLiveTail operation request included a logStreamNames parameter that filtered the session\n to only include certain log streams, these streams are listed here.
If your StartLiveTail operation request included a logStreamNamePrefixes parameter that filtered the session\n to only include log streams that have names that start with certain prefixes, these prefixes are listed here.
An optional pattern to filter the results to include only log events that match the pattern.\n For example, a filter pattern of error 404 displays only log events that include both error \n and 404.
For more information about filter pattern syntax, see Filter and Pattern Syntax.
" + } + } + }, + "traits": { + "smithy.api#documentation": "This object contains information about this Live Tail session, including the log groups included and the \n log stream filters, if any.
" + } + }, + "com.amazonaws.cloudwatchlogs#LiveTailSessionUpdate": { + "type": "structure", + "members": { + "sessionMetadata": { + "target": "com.amazonaws.cloudwatchlogs#LiveTailSessionMetadata", + "traits": { + "smithy.api#documentation": "This object contains the session metadata for a Live Tail session.
" + } + }, + "sessionResults": { + "target": "com.amazonaws.cloudwatchlogs#LiveTailSessionResults", + "traits": { + "smithy.api#documentation": "An array, where each member of the array includes the information for one log event in the Live Tail session.
\nA sessionResults array can include as many as 500 log events. If the number of \n log events matching the request exceeds 500 per second, the\n log events are sampled down to 500 log events to be included in each sessionUpdate structure.
This object contains the log events and metadata for a Live Tail session.
" + } + }, + "com.amazonaws.cloudwatchlogs#LogEvent": { + "type": "structure", + "members": { + "timestamp": { + "target": "com.amazonaws.cloudwatchlogs#Timestamp", + "traits": { + "smithy.api#documentation": "The time stamp of the log event.
" + } + }, + "message": { + "target": "com.amazonaws.cloudwatchlogs#EventMessage", + "traits": { + "smithy.api#documentation": "The message content of the log event.
" + } + } + }, + "traits": { + "smithy.api#documentation": "This structure contains the information for one sample log event that is associated \n with an anomaly found by a log anomaly detector.
" + } + }, + "com.amazonaws.cloudwatchlogs#LogEventIndex": { + "type": "integer" + }, + "com.amazonaws.cloudwatchlogs#LogGroup": { + "type": "structure", + "members": { + "logGroupName": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupName", + "traits": { + "smithy.api#documentation": "The name of the log group.
" + } + }, + "creationTime": { + "target": "com.amazonaws.cloudwatchlogs#Timestamp", + "traits": { + "smithy.api#documentation": "The creation time of the log group, expressed as the number of milliseconds after Jan\n 1, 1970 00:00:00 UTC.
" + } + }, + "retentionInDays": { + "target": "com.amazonaws.cloudwatchlogs#Days" + }, + "metricFilterCount": { + "target": "com.amazonaws.cloudwatchlogs#FilterCount", + "traits": { + "smithy.api#documentation": "The number of metric filters.
" + } + }, + "arn": { + "target": "com.amazonaws.cloudwatchlogs#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the log group. This version of the ARN includes a trailing :* after the log group name.
Use this version to refer to the ARN in IAM policies when specifying permissions for most API actions. The exception is when specifying permissions for TagResource, UntagResource, and \n ListTagsForResource. \n The permissions for those three actions require the ARN version that doesn't include a trailing :*.
The number of bytes stored.
" + } + }, + "kmsKeyId": { + "target": "com.amazonaws.cloudwatchlogs#KmsKeyId", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key to use when\n encrypting log data.
" + } + }, + "dataProtectionStatus": { + "target": "com.amazonaws.cloudwatchlogs#DataProtectionStatus", + "traits": { + "smithy.api#documentation": "Displays whether this log group has a protection policy, or whether it had one in the past. For more information, see \n PutDataProtectionPolicy.
" + } + }, + "inheritedProperties": { + "target": "com.amazonaws.cloudwatchlogs#InheritedProperties", + "traits": { + "smithy.api#documentation": "Displays all the properties that this log group has inherited from account-level \n settings.
" + } + }, + "logGroupClass": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupClass", + "traits": { + "smithy.api#documentation": "This specifies the log group class for this log group. There are two classes:
\nThe Standard log class supports all CloudWatch Logs features.
The Infrequent Access log class supports a subset of CloudWatch Logs features\n and incurs lower costs.
For details about the features supported by each class, see \n Log classes\n
" + } + }, + "logGroupArn": { + "target": "com.amazonaws.cloudwatchlogs#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the log group. This version of the ARN doesn't include a trailing :* after the log group name.
Use this version to refer to the ARN in the following situations:
\nIn the logGroupIdentifier input field in many CloudWatch Logs APIs.
In the resourceArn field in tagging APIs
In IAM policies, when specifying permissions for TagResource, UntagResource, and \n ListTagsForResource.
\nRepresents a log group.
" + } + }, + "com.amazonaws.cloudwatchlogs#LogGroupArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^[\\w#+=/:,.@-]*$" + } + }, + "com.amazonaws.cloudwatchlogs#LogGroupArnList": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupArn" + } + }, + "com.amazonaws.cloudwatchlogs#LogGroupClass": { + "type": "enum", + "members": { + "STANDARD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STANDARD" + } + }, + "INFREQUENT_ACCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INFREQUENT_ACCESS" + } + } + } + }, + "com.amazonaws.cloudwatchlogs#LogGroupField": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.cloudwatchlogs#Field", + "traits": { + "smithy.api#documentation": "The name of a log field.
" + } + }, + "percent": { + "target": "com.amazonaws.cloudwatchlogs#Percentage", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The percentage of log events queried that contained the field.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The fields contained in log events found by a GetLogGroupFields operation,\n along with the percentage of queried log events in which each field appears.
The name of the log stream.
" + } + }, + "creationTime": { + "target": "com.amazonaws.cloudwatchlogs#Timestamp", + "traits": { + "smithy.api#documentation": "The creation time of the stream, expressed as the number of milliseconds after\n Jan 1, 1970 00:00:00 UTC.
The time of the first event, expressed as the number of milliseconds after Jan 1,\n 1970 00:00:00 UTC.
The time of the most recent log event in the log stream in CloudWatch Logs. This number\n is expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. The\n lastEventTime value updates on an eventual consistency basis. It typically\n updates in less than an hour from ingestion, but in rare situations might take\n longer.
The ingestion time, expressed as the number of milliseconds after Jan 1, 1970\n 00:00:00 UTC The lastIngestionTime value updates on an eventual consistency basis. It \n typically updates in less than an hour after ingestion, but in rare situations might take longer.
The sequence token.
\nThe sequence token is now ignored in \n PutLogEvents\n actions. PutLogEvents actions are always accepted regardless of receiving an invalid sequence token. \n You don't need to obtain uploadSequenceToken to use a PutLogEvents action.
The Amazon Resource Name (ARN) of the log stream.
" + } + }, + "storedBytes": { + "target": "com.amazonaws.cloudwatchlogs#StoredBytes", + "traits": { + "smithy.api#deprecated": { + "message": "Starting on June 17, 2019, this parameter will be deprecated for log streams, and will be reported as zero. This change applies only to log streams. The storedBytes parameter for log groups is not affected." + }, + "smithy.api#documentation": "The number of bytes stored.
\n\n Important: As of June 17, 2019, this parameter is no\n longer supported for log streams, and is always reported as zero. This change applies only to\n log streams. The storedBytes parameter for log groups is not affected.
Represents a log stream, which is a sequence of log events from \n a single emitter of logs.
" + } + }, + "com.amazonaws.cloudwatchlogs#LogStreamName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + }, + "smithy.api#pattern": "^[^:*]*$" + } + }, + "com.amazonaws.cloudwatchlogs#LogStreamSearchedCompletely": { + "type": "boolean" + }, + "com.amazonaws.cloudwatchlogs#LogStreams": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#LogStream" + } + }, + "com.amazonaws.cloudwatchlogs#LogType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[\\w]*$" + } + }, + "com.amazonaws.cloudwatchlogs#LogTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#LogType" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.cloudwatchlogs#Logs_20140328": { + "type": "service", + "version": "2014-03-28", + "operations": [ + { + "target": "com.amazonaws.cloudwatchlogs#AssociateKmsKey" + }, + { + "target": "com.amazonaws.cloudwatchlogs#CancelExportTask" + }, + { + "target": "com.amazonaws.cloudwatchlogs#CreateDelivery" + }, + { + "target": "com.amazonaws.cloudwatchlogs#CreateExportTask" + }, + { + "target": "com.amazonaws.cloudwatchlogs#CreateLogAnomalyDetector" + }, + { + "target": "com.amazonaws.cloudwatchlogs#CreateLogGroup" + }, + { + "target": "com.amazonaws.cloudwatchlogs#CreateLogStream" + }, + { + "target": "com.amazonaws.cloudwatchlogs#DeleteAccountPolicy" + }, + { + "target": "com.amazonaws.cloudwatchlogs#DeleteDataProtectionPolicy" + }, + { + "target": "com.amazonaws.cloudwatchlogs#DeleteDelivery" + }, + { + "target": "com.amazonaws.cloudwatchlogs#DeleteDeliveryDestination" + }, + { + "target": "com.amazonaws.cloudwatchlogs#DeleteDeliveryDestinationPolicy" + }, + { + "target": "com.amazonaws.cloudwatchlogs#DeleteDeliverySource" + }, + { + "target": "com.amazonaws.cloudwatchlogs#DeleteDestination" + }, + { + "target": "com.amazonaws.cloudwatchlogs#DeleteLogAnomalyDetector" + }, + { + "target": "com.amazonaws.cloudwatchlogs#DeleteLogGroup" + }, + { + "target": "com.amazonaws.cloudwatchlogs#DeleteLogStream" + }, + { + "target": "com.amazonaws.cloudwatchlogs#DeleteMetricFilter" + }, + { + "target": "com.amazonaws.cloudwatchlogs#DeleteQueryDefinition" + }, + { + "target": "com.amazonaws.cloudwatchlogs#DeleteResourcePolicy" + }, + { + "target": "com.amazonaws.cloudwatchlogs#DeleteRetentionPolicy" + }, + { + "target": "com.amazonaws.cloudwatchlogs#DeleteSubscriptionFilter" + }, + { + "target": "com.amazonaws.cloudwatchlogs#DescribeAccountPolicies" + }, + { + "target": "com.amazonaws.cloudwatchlogs#DescribeConfigurationTemplates" + }, + { + "target": "com.amazonaws.cloudwatchlogs#DescribeDeliveries" + }, + { + "target": "com.amazonaws.cloudwatchlogs#DescribeDeliveryDestinations" + }, + { + "target": "com.amazonaws.cloudwatchlogs#DescribeDeliverySources" + }, + { + "target": "com.amazonaws.cloudwatchlogs#DescribeDestinations" + }, + { + "target": "com.amazonaws.cloudwatchlogs#DescribeExportTasks" + }, + { + "target": "com.amazonaws.cloudwatchlogs#DescribeLogGroups" + }, + { + "target": "com.amazonaws.cloudwatchlogs#DescribeLogStreams" + }, + { + "target": "com.amazonaws.cloudwatchlogs#DescribeMetricFilters" + }, + { + "target": "com.amazonaws.cloudwatchlogs#DescribeQueries" + }, + { + "target": "com.amazonaws.cloudwatchlogs#DescribeQueryDefinitions" + }, + { + "target": "com.amazonaws.cloudwatchlogs#DescribeResourcePolicies" + }, + { + "target": "com.amazonaws.cloudwatchlogs#DescribeSubscriptionFilters" + }, + { + "target": "com.amazonaws.cloudwatchlogs#DisassociateKmsKey" + }, + { + "target": "com.amazonaws.cloudwatchlogs#FilterLogEvents" + }, + { + "target": "com.amazonaws.cloudwatchlogs#GetDataProtectionPolicy" + }, + { + "target": "com.amazonaws.cloudwatchlogs#GetDelivery" + }, + { + "target": "com.amazonaws.cloudwatchlogs#GetDeliveryDestination" + }, + { + "target": "com.amazonaws.cloudwatchlogs#GetDeliveryDestinationPolicy" + }, + { + "target": "com.amazonaws.cloudwatchlogs#GetDeliverySource" + }, + { + "target": "com.amazonaws.cloudwatchlogs#GetLogAnomalyDetector" + }, + { + "target": "com.amazonaws.cloudwatchlogs#GetLogEvents" + }, + { + "target": "com.amazonaws.cloudwatchlogs#GetLogGroupFields" + }, + { + "target": "com.amazonaws.cloudwatchlogs#GetLogRecord" + }, + { + "target": "com.amazonaws.cloudwatchlogs#GetQueryResults" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ListAnomalies" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ListLogAnomalyDetectors" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ListTagsForResource" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ListTagsLogGroup" + }, + { + "target": "com.amazonaws.cloudwatchlogs#PutAccountPolicy" + }, + { + "target": "com.amazonaws.cloudwatchlogs#PutDataProtectionPolicy" + }, + { + "target": "com.amazonaws.cloudwatchlogs#PutDeliveryDestination" + }, + { + "target": "com.amazonaws.cloudwatchlogs#PutDeliveryDestinationPolicy" + }, + { + "target": "com.amazonaws.cloudwatchlogs#PutDeliverySource" + }, + { + "target": "com.amazonaws.cloudwatchlogs#PutDestination" + }, + { + "target": "com.amazonaws.cloudwatchlogs#PutDestinationPolicy" + }, + { + "target": "com.amazonaws.cloudwatchlogs#PutLogEvents" + }, + { + "target": "com.amazonaws.cloudwatchlogs#PutMetricFilter" + }, + { + "target": "com.amazonaws.cloudwatchlogs#PutQueryDefinition" + }, + { + "target": "com.amazonaws.cloudwatchlogs#PutResourcePolicy" + }, + { + "target": "com.amazonaws.cloudwatchlogs#PutRetentionPolicy" + }, + { + "target": "com.amazonaws.cloudwatchlogs#PutSubscriptionFilter" + }, + { + "target": "com.amazonaws.cloudwatchlogs#StartLiveTail" + }, + { + "target": "com.amazonaws.cloudwatchlogs#StartQuery" + }, + { + "target": "com.amazonaws.cloudwatchlogs#StopQuery" + }, + { + "target": "com.amazonaws.cloudwatchlogs#TagLogGroup" + }, + { + "target": "com.amazonaws.cloudwatchlogs#TagResource" + }, + { + "target": "com.amazonaws.cloudwatchlogs#TestMetricFilter" + }, + { + "target": "com.amazonaws.cloudwatchlogs#UntagLogGroup" + }, + { + "target": "com.amazonaws.cloudwatchlogs#UntagResource" + }, + { + "target": "com.amazonaws.cloudwatchlogs#UpdateAnomaly" + }, + { + "target": "com.amazonaws.cloudwatchlogs#UpdateDeliveryConfiguration" + }, + { + "target": "com.amazonaws.cloudwatchlogs#UpdateLogAnomalyDetector" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "CloudWatch Logs", + "arnNamespace": "logs", + "cloudFormationName": "Logs", + "cloudTrailEventSource": "logs.amazonaws.com", + "docId": "logs-2014-03-28", + "endpointPrefix": "logs" + }, + "aws.auth#sigv4": { + "name": "logs" + }, + "aws.protocols#awsJson1_1": {}, + "smithy.api#documentation": "You can use Amazon CloudWatch Logs to monitor, store, and access your log files from\n EC2 instances, CloudTrail, and other sources. You can then retrieve the associated\n log data from CloudWatch Logs using the CloudWatch console. Alternatively, you can use\n CloudWatch Logs commands in the Amazon Web Services CLI, CloudWatch Logs API, or CloudWatch\n Logs SDK.
\nYou can use CloudWatch Logs to:
\n\n Monitor logs from EC2 instances in real time: You\n can use CloudWatch Logs to monitor applications and systems using log data. For example,\n CloudWatch Logs can track the number of errors that occur in your application logs. Then,\n it can send you a notification whenever the rate of errors exceeds a threshold that you\n specify. CloudWatch Logs uses your log data for monitoring so no code changes are\n required. For example, you can monitor application logs for specific literal terms (such\n as \"NullReferenceException\"). You can also count the number of occurrences of a literal\n term at a particular position in log data (such as \"404\" status codes in an Apache access\n log). When the term you are searching for is found, CloudWatch Logs reports the data to a\n CloudWatch metric that you specify.
\n\n Monitor CloudTrail logged events: You can\n create alarms in CloudWatch and receive notifications of particular API activity as\n captured by CloudTrail. You can use the notification to perform troubleshooting.
\n\n Archive log data: You can use CloudWatch Logs to\n store your log data in highly durable storage. You can change the log retention setting so\n that any log events earlier than this setting are automatically deleted. The CloudWatch\n Logs agent helps to quickly send both rotated and non-rotated log data off of a host and\n into the log service. You can then access the raw log data when you need it.
\nThe query string is not valid. Details about this error are displayed in a \n QueryCompileError object. For more information, see \n QueryCompileError.
For more information about valid query syntax, see\n CloudWatch Logs Insights Query Syntax.
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.cloudwatchlogs#Message": { + "type": "string" + }, + "com.amazonaws.cloudwatchlogs#MetricFilter": { + "type": "structure", + "members": { + "filterName": { + "target": "com.amazonaws.cloudwatchlogs#FilterName", + "traits": { + "smithy.api#documentation": "The name of the metric filter.
" + } + }, + "filterPattern": { + "target": "com.amazonaws.cloudwatchlogs#FilterPattern" + }, + "metricTransformations": { + "target": "com.amazonaws.cloudwatchlogs#MetricTransformations", + "traits": { + "smithy.api#documentation": "The metric transformations.
" + } + }, + "creationTime": { + "target": "com.amazonaws.cloudwatchlogs#Timestamp", + "traits": { + "smithy.api#documentation": "The creation time of the metric filter, expressed as the number of milliseconds after\n Jan 1, 1970 00:00:00 UTC.
The name of the log group.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Metric filters express how CloudWatch Logs would extract metric observations \n from ingested log events and transform them into metric data in a CloudWatch metric.
" + } + }, + "com.amazonaws.cloudwatchlogs#MetricFilterMatchRecord": { + "type": "structure", + "members": { + "eventNumber": { + "target": "com.amazonaws.cloudwatchlogs#EventNumber", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The event number.
" + } + }, + "eventMessage": { + "target": "com.amazonaws.cloudwatchlogs#EventMessage", + "traits": { + "smithy.api#documentation": "The raw event data.
" + } + }, + "extractedValues": { + "target": "com.amazonaws.cloudwatchlogs#ExtractedValues", + "traits": { + "smithy.api#documentation": "The values extracted from the event data by the filter.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a matched event.
" + } + }, + "com.amazonaws.cloudwatchlogs#MetricFilterMatches": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#MetricFilterMatchRecord" + } + }, + "com.amazonaws.cloudwatchlogs#MetricFilters": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#MetricFilter" + } + }, + "com.amazonaws.cloudwatchlogs#MetricName": { + "type": "string", + "traits": { + "smithy.api#documentation": "The name of the CloudWatch metric to which the monitored log information should be\n published. For example, you might publish to a metric named ErrorCount.
", + "smithy.api#length": { + "min": 0, + "max": 255 + }, + "smithy.api#pattern": "^[^:*$]*$" + } + }, + "com.amazonaws.cloudwatchlogs#MetricNamespace": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + }, + "smithy.api#pattern": "^[^:*$]*$" + } + }, + "com.amazonaws.cloudwatchlogs#MetricTransformation": { + "type": "structure", + "members": { + "metricName": { + "target": "com.amazonaws.cloudwatchlogs#MetricName", + "traits": { + "smithy.api#documentation": "The name of the CloudWatch metric.
", + "smithy.api#required": {} + } + }, + "metricNamespace": { + "target": "com.amazonaws.cloudwatchlogs#MetricNamespace", + "traits": { + "smithy.api#documentation": "A custom namespace to contain your metric in CloudWatch. Use namespaces to group together metrics\n that are similar. For more information, see Namespaces.
", + "smithy.api#required": {} + } + }, + "metricValue": { + "target": "com.amazonaws.cloudwatchlogs#MetricValue", + "traits": { + "smithy.api#documentation": "The value to publish to the CloudWatch metric when a filter pattern matches a log event.
", + "smithy.api#required": {} + } + }, + "defaultValue": { + "target": "com.amazonaws.cloudwatchlogs#DefaultValue", + "traits": { + "smithy.api#documentation": "(Optional) The value to emit when a filter pattern does not match a log event. \n This value can be null.
" + } + }, + "dimensions": { + "target": "com.amazonaws.cloudwatchlogs#Dimensions", + "traits": { + "smithy.api#documentation": "The fields to use as dimensions for the metric. One metric filter can include\n as many as three dimensions.
\nMetrics extracted from log events are charged as custom metrics.\n To prevent unexpected high charges, do not specify high-cardinality fields such as \n IPAddress or requestID as dimensions. Each different value \n found for \n a dimension is treated as a separate metric and accrues charges as a separate custom metric.\n
CloudWatch Logs disables a metric filter if it generates 1000 different name/value pairs for your\n specified dimensions within a certain amount of time. This helps to prevent accidental high\n charges.
\nYou can also set up a billing alarm to alert you if your charges are higher than \n expected. For more information, \n see \n Creating a Billing Alarm to Monitor Your Estimated Amazon Web Services Charges.\n
\nThe unit to assign to the metric. If you omit this, the unit is set as None.
Indicates how to transform ingested log events to metric data in a CloudWatch\n metric.
" + } + }, + "com.amazonaws.cloudwatchlogs#MetricTransformations": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#MetricTransformation" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.cloudwatchlogs#MetricValue": { + "type": "string", + "traits": { + "smithy.api#documentation": "The value to publish to the CloudWatch metric. For example, if you're counting the\n occurrences of a term like Error, the value is 1 for each\n occurrence. If you're counting the bytes transferred, the value is the value in the log\n event.
The token for the next set of items to return. The token expires after 24 hours.
", + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.cloudwatchlogs#OperationAbortedException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.cloudwatchlogs#Message" + } + }, + "traits": { + "smithy.api#documentation": "Multiple concurrent requests to update the same resource were in conflict.
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.cloudwatchlogs#OrderBy": { + "type": "enum", + "members": { + "LogStreamName": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LogStreamName" + } + }, + "LastEventTime": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LastEventTime" + } + } + } + }, + "com.amazonaws.cloudwatchlogs#OutputFormat": { + "type": "enum", + "members": { + "JSON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "json" + } + }, + "PLAIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "plain" + } + }, + "W3C": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "w3c" + } + }, + "RAW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "raw" + } + }, + "PARQUET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "parquet" + } + } + } + }, + "com.amazonaws.cloudwatchlogs#OutputFormats": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#OutputFormat" + } + }, + "com.amazonaws.cloudwatchlogs#OutputLogEvent": { + "type": "structure", + "members": { + "timestamp": { + "target": "com.amazonaws.cloudwatchlogs#Timestamp", + "traits": { + "smithy.api#documentation": "The time the event occurred, expressed as the number of milliseconds after Jan 1,\n 1970 00:00:00 UTC.
The data contained in the log event.
" + } + }, + "ingestionTime": { + "target": "com.amazonaws.cloudwatchlogs#Timestamp", + "traits": { + "smithy.api#documentation": "The time the event was ingested, expressed as the number of milliseconds after\n Jan 1, 1970 00:00:00 UTC.
Represents a log event.
" + } + }, + "com.amazonaws.cloudwatchlogs#OutputLogEvents": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#OutputLogEvent" + } + }, + "com.amazonaws.cloudwatchlogs#PatternId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 32, + "max": 32 + } + } + }, + "com.amazonaws.cloudwatchlogs#PatternRegex": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.cloudwatchlogs#PatternString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.cloudwatchlogs#PatternToken": { + "type": "structure", + "members": { + "dynamicTokenPosition": { + "target": "com.amazonaws.cloudwatchlogs#DynamicTokenPosition", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "For a dynamic token, this indicates where in the pattern that this token appears, related\n to other dynamic tokens. The dynamic token that appears first has a value of 1, the \n one that appears second is 2, and so on.
Specifies whether this is a dynamic token.
" + } + }, + "tokenString": { + "target": "com.amazonaws.cloudwatchlogs#TokenString", + "traits": { + "smithy.api#documentation": "The string represented by this token. If this is a dynamic token, the\n value will be <*>\n
Contains the values found for a dynamic token, and the number of times each value was found.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A structure that contains information about one pattern token related to \n an anomaly.
\nFor more information about patterns and tokens, see CreateLogAnomalyDetector.\n
" + } + }, + "com.amazonaws.cloudwatchlogs#PatternTokens": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#PatternToken" + } + }, + "com.amazonaws.cloudwatchlogs#Percentage": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.cloudwatchlogs#Policy": { + "type": "structure", + "members": { + "deliveryDestinationPolicy": { + "target": "com.amazonaws.cloudwatchlogs#DeliveryDestinationPolicy", + "traits": { + "smithy.api#documentation": "The contents of the delivery destination policy.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A structure that contains information about one delivery destination policy.
" + } + }, + "com.amazonaws.cloudwatchlogs#PolicyDocument": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5120 + } + } + }, + "com.amazonaws.cloudwatchlogs#PolicyName": { + "type": "string" + }, + "com.amazonaws.cloudwatchlogs#PolicyType": { + "type": "enum", + "members": { + "DATA_PROTECTION_POLICY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATA_PROTECTION_POLICY" + } + }, + "SUBSCRIPTION_FILTER_POLICY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUBSCRIPTION_FILTER_POLICY" + } + } + } + }, + "com.amazonaws.cloudwatchlogs#Priority": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.cloudwatchlogs#PutAccountPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#PutAccountPolicyRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#PutAccountPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#LimitExceededException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "Creates an account-level data protection policy or subscription filter policy that applies to all log groups \n or a subset of log groups in the account.
\n\n Data protection policy\n
\nA data protection policy can help safeguard sensitive \n data that's ingested by your log groups by auditing and masking the sensitive log data. Each account can have only\n one account-level data protection policy.
\nSensitive data is detected and masked when it is ingested into a log group. When you set a \n data protection policy, log events ingested into the log groups before that time are not masked.
\nIf you use PutAccountPolicy to create a data protection policy for your whole account, it applies to both existing log groups\n and all log groups that are created later in this account. The account-level policy is applied to existing log groups\n with eventual consistency. It might take up to 5 minutes before sensitive data in existing log groups begins to be masked.
By default, when a user views a log event that includes masked data, the sensitive data is replaced by asterisks.\n A user who has the logs:Unmask permission can use a \n GetLogEvents or \n FilterLogEvents\n operation with the unmask parameter set to true to view the unmasked \n log events. Users with the logs:Unmask can also view unmasked data in the CloudWatch Logs\n console by running a CloudWatch Logs Insights query with the unmask query command.
For more information, including a list of types of data that can be audited and masked, see\n Protect sensitive log data with masking.
\nTo use the PutAccountPolicy operation for a data protection policy, you must be signed on with \n the logs:PutDataProtectionPolicy\n and logs:PutAccountPolicy permissions.
The PutAccountPolicy operation applies to all log groups in the account. You can use \n PutDataProtectionPolicy\n to create a data protection policy that applies to just one log group. \n If a log group has its own data protection policy and \n the account also has an account-level data protection policy, then the two policies are cumulative. Any sensitive term\n specified in either policy is masked.
\n Subscription filter policy\n
\nA subscription filter policy sets up a real-time feed of log events from CloudWatch Logs to other Amazon Web Services services.\n Account-level subscription filter policies apply to both existing log groups and log groups that are created later in \n this account. Supported destinations are Kinesis Data Streams, Firehose, and \n Lambda. When log events are sent to the receiving service, they are Base64 encoded and \n compressed with the GZIP format.
\nThe following destinations are supported for subscription filters:
\nAn Kinesis Data Streams data stream in the same account as the subscription policy, for same-account delivery.
\nAn Firehose data stream in the same account as the subscription policy, for same-account delivery.
\nA Lambda function in the same account as the subscription policy, for same-account delivery.
\nA logical destination in a different account created with PutDestination, for cross-account\n delivery. Kinesis Data Streams and Firehose are supported as logical destinations.
\nEach account can have one account-level subscription filter policy per Region. \n If you are updating an existing filter, you must specify the correct name in PolicyName.\n To perform a PutAccountPolicy subscription filter operation for any destination except a Lambda \n function, you must also have the iam:PassRole permission.
A name for the policy. This must be unique within the account.
", + "smithy.api#required": {} + } + }, + "policyDocument": { + "target": "com.amazonaws.cloudwatchlogs#AccountPolicyDocument", + "traits": { + "smithy.api#documentation": "Specify the policy, in JSON.
\n\n Data protection policy\n
\nA data protection policy must include two JSON blocks:
\nThe first block must include both a DataIdentifer array and an \n Operation property with an Audit action. The DataIdentifer array lists the types of sensitive data that\n you want to mask. For more information about the available options, see \n Types of data that you can mask.
The Operation property with an Audit action is required to find the \n sensitive data terms. This Audit action must contain a FindingsDestination\n object. You can optionally use that FindingsDestination object to list one or more \n destinations to send audit findings to. If you specify destinations such as log groups, \n Firehose streams, and S3 buckets, they must already exist.
The second block must include both a DataIdentifer array and an\n Operation property with an Deidentify action. The\n DataIdentifer array must exactly match the DataIdentifer array\n in the first block of the policy.
The Operation property with the Deidentify action is what actually masks the \n data, and it must \n contain the \n \"MaskConfig\": {} object. The \n \"MaskConfig\": {} object must be empty.
For an example data protection policy, see the Examples section on this page.
\nThe contents of the two DataIdentifer arrays must match exactly.
In addition to the two JSON blocks, the policyDocument can also include Name,\n Description, and Version fields. The Name is different than the \n operation's policyName parameter, and is used as a dimension when\n CloudWatch Logs reports audit findings metrics to CloudWatch.
The JSON specified in policyDocument can be up to 30,720 characters long.
\n Subscription filter policy\n
\nA subscription filter policy can include the following attributes in a JSON block:
\n\n DestinationArn The ARN of the destination\n to deliver log events to. Supported destinations are:
\nAn Kinesis Data Streams data stream in the same account as the subscription policy, for same-account delivery.
\nAn Firehose data stream in the same account as the subscription policy, for same-account delivery.
\nA Lambda function in the same account as the subscription policy, for same-account delivery.
\nA logical destination in a different account created with PutDestination, for cross-account\n delivery. Kinesis Data Streams and Firehose are supported as logical destinations.
\n\n RoleArn The ARN of an IAM role that grants CloudWatch Logs permissions to deliver ingested log\n events to the destination stream. You don't need to provide the ARN when you are working with\n a logical destination for cross-account delivery.
\n\n FilterPattern A filter pattern for subscribing to a \n filtered stream of log events.
\n\n Distribution The method used to distribute log data to the destination. \n By default, log data is\n grouped by log stream, but the grouping can be set to Random for a more even distribution.\n This property is only applicable when the destination is an Kinesis Data Streams data stream.
The type of policy that you're creating or updating.
", + "smithy.api#required": {} + } + }, + "scope": { + "target": "com.amazonaws.cloudwatchlogs#Scope", + "traits": { + "smithy.api#documentation": "Currently the only valid value for this parameter is ALL, which specifies that the data \n protection policy applies to all log groups in the account. If you omit this parameter, the default\n of ALL is used.
Use this parameter to apply the subscription filter policy to a subset of log groups in the account.\n Currently, the only supported filter is LogGroupName NOT IN []. The selectionCriteria\n string can be up to 25KB in length. The length is determined by using its UTF-8 bytes.
Using the selectionCriteria parameter is useful to help prevent infinite loops. \n For more information, see Log recursion prevention.
Specifing selectionCriteria is valid only when you specify SUBSCRIPTION_FILTER_POLICY\n for policyType.
The account policy that you created.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#PutDataProtectionPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#PutDataProtectionPolicyRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#PutDataProtectionPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#LimitExceededException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a data protection policy for the specified log group. A data protection policy can help safeguard sensitive \n data that's ingested by the log group by auditing and masking the sensitive log data.
\nSensitive data is detected and masked when it is ingested into the log group. When you set a \n data protection policy, log events ingested into the log group before that time are not masked.
\nBy default, when a user views a log event that includes masked data, the sensitive data is replaced by asterisks.\n A user who has the logs:Unmask permission can use a \n GetLogEvents or \n FilterLogEvents\n operation with the unmask parameter set to true to view the unmasked \n log events. Users with the logs:Unmask can also view unmasked data in the CloudWatch Logs\n console by running a CloudWatch Logs Insights query with the unmask query command.
For more information, including a list of types of data that can be audited and masked, see\n Protect sensitive log data with masking.
\nThe PutDataProtectionPolicy operation applies to only the specified log group. You can also use \n PutAccountPolicy\n to create an account-level data protection policy that applies to all log groups in the account, \n including both existing log groups and log groups that are created level. If a log group has its own data protection policy and \n the account also has an account-level data protection policy, then the two policies are cumulative. Any sensitive term\n specified in either policy is masked.
Specify either the log group name or log group ARN.
", + "smithy.api#required": {} + } + }, + "policyDocument": { + "target": "com.amazonaws.cloudwatchlogs#DataProtectionPolicyDocument", + "traits": { + "smithy.api#documentation": "Specify the data protection policy, in JSON.
\nThis policy must include two JSON blocks:
\nThe first block must include both a DataIdentifer array and an \n Operation property with an Audit action. The DataIdentifer array lists the types of sensitive data that\n you want to mask. For more information about the available options, see \n Types of data that you can mask.
The Operation property with an Audit action is required to find the \n sensitive data terms. This Audit action must contain a FindingsDestination\n object. You can optionally use that FindingsDestination object to list one or more \n destinations to send audit findings to. If you specify destinations such as log groups, \n Firehose streams, and S3 buckets, they must already exist.
The second block must include both a DataIdentifer array and an\n Operation property with an Deidentify action. The\n DataIdentifer array must exactly match the DataIdentifer array\n in the first block of the policy.
The Operation property with the Deidentify action is what actually masks the \n data, and it must \n contain the \n \"MaskConfig\": {} object. The \n \"MaskConfig\": {} object must be empty.
For an example data protection policy, see the Examples section on this page.
\nThe contents of the two DataIdentifer arrays must match exactly.
In addition to the two JSON blocks, the policyDocument can also include Name,\n Description, and Version fields. The Name is used as a dimension when\n CloudWatch Logs reports audit findings metrics to CloudWatch.
The JSON specified in policyDocument can be up to 30,720 characters.
The log group name or ARN that you specified in your request.
" + } + }, + "policyDocument": { + "target": "com.amazonaws.cloudwatchlogs#DataProtectionPolicyDocument", + "traits": { + "smithy.api#documentation": "The data protection policy used for this log group.
" + } + }, + "lastUpdatedTime": { + "target": "com.amazonaws.cloudwatchlogs#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time that this policy was most recently updated.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#PutDeliveryDestination": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#PutDeliveryDestinationRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#PutDeliveryDestinationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#ConflictException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ThrottlingException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates or updates a logical delivery destination. A delivery destination is an Amazon Web Services resource that represents an \n Amazon Web Services service that logs can be sent to. CloudWatch Logs, Amazon S3, and\n Firehose are supported as logs delivery destinations.
\nTo configure logs delivery between a supported Amazon Web Services service and a destination, you must do the following:
\nCreate a delivery source, which is a logical object that represents the resource that is actually\n sending the logs. For more \n information, see PutDeliverySource.
\nUse PutDeliveryDestination to create a delivery destination, which is a logical object that represents the actual\n delivery destination.
If you are delivering logs cross-account, you must use \n PutDeliveryDestinationPolicy\n in the destination account to assign an IAM policy to the \n destination. This policy allows delivery to that destination.\n
\nUse CreateDelivery to create a delivery by pairing exactly \n one delivery source and one delivery destination. For more \n information, see CreateDelivery.\n
You can configure a single delivery source to send logs to multiple destinations by creating multiple deliveries. You \n can also create multiple deliveries to configure multiple delivery sources to send logs to the same delivery destination.
\nOnly some Amazon Web Services services support being configured as a delivery source. These services are listed\n as Supported [V2 Permissions] in the table at \n Enabling \n logging from Amazon Web Services services.\n
\nIf you use this operation to update an existing delivery destination, all the current delivery destination parameters are overwritten\n with the new parameter values that you specify.
" + } + }, + "com.amazonaws.cloudwatchlogs#PutDeliveryDestinationPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#PutDeliveryDestinationPolicyRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#PutDeliveryDestinationPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#ConflictException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates and assigns an IAM policy that grants permissions to CloudWatch Logs to deliver \n logs cross-account to a specified destination in this account. To configure the delivery of logs from an \n Amazon Web Services service in another account to a logs delivery destination in the current account, you must do the following:
\nCreate a delivery source, which is a logical object that represents the resource that is actually\n sending the logs. For more \n information, see PutDeliverySource.
\nCreate a delivery destination, which is a logical object that represents the actual\n delivery destination. For more \n information, see PutDeliveryDestination.
\nUse this operation in the destination account to assign an IAM policy to the \n destination. This policy allows delivery to that destination.\n
\nCreate a delivery by pairing exactly one delivery source and one delivery destination.\n For more information, see CreateDelivery.
\nOnly some Amazon Web Services services support being configured as a delivery source. These services are listed\n as Supported [V2 Permissions] in the table at \n Enabling \n logging from Amazon Web Services services.\n
\nThe contents of the policy must include two statements. One statement enables general logs delivery, and the other\n allows delivery to the chosen destination. See the examples for the needed policies.
" + } + }, + "com.amazonaws.cloudwatchlogs#PutDeliveryDestinationPolicyRequest": { + "type": "structure", + "members": { + "deliveryDestinationName": { + "target": "com.amazonaws.cloudwatchlogs#DeliveryDestinationName", + "traits": { + "smithy.api#documentation": "The name of the delivery destination to assign this policy to.
", + "smithy.api#required": {} + } + }, + "deliveryDestinationPolicy": { + "target": "com.amazonaws.cloudwatchlogs#DeliveryDestinationPolicy", + "traits": { + "smithy.api#documentation": "The contents of the policy.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#PutDeliveryDestinationPolicyResponse": { + "type": "structure", + "members": { + "policy": { + "target": "com.amazonaws.cloudwatchlogs#Policy", + "traits": { + "smithy.api#documentation": "The contents of the policy that you just created.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#PutDeliveryDestinationRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.cloudwatchlogs#DeliveryDestinationName", + "traits": { + "smithy.api#documentation": "A name for this delivery destination. This name must be unique for all delivery destinations in your account.
", + "smithy.api#required": {} + } + }, + "outputFormat": { + "target": "com.amazonaws.cloudwatchlogs#OutputFormat", + "traits": { + "smithy.api#documentation": "The format for the logs that this delivery destination will receive.
" + } + }, + "deliveryDestinationConfiguration": { + "target": "com.amazonaws.cloudwatchlogs#DeliveryDestinationConfiguration", + "traits": { + "smithy.api#documentation": "A structure that contains the ARN of the Amazon Web Services resource that will receive the logs.
", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.cloudwatchlogs#Tags", + "traits": { + "smithy.api#documentation": "An optional list of key-value pairs to associate with the resource.
\nFor more information about tagging, see \n Tagging Amazon Web Services resources\n
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#PutDeliveryDestinationResponse": { + "type": "structure", + "members": { + "deliveryDestination": { + "target": "com.amazonaws.cloudwatchlogs#DeliveryDestination", + "traits": { + "smithy.api#documentation": "A structure containing information about the delivery destination that you just created or updated.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#PutDeliverySource": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#PutDeliverySourceRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#PutDeliverySourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#ConflictException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ThrottlingException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates or updates a logical delivery source. A delivery source represents an Amazon Web Services resource that sends logs to an\n logs delivery destination. The destination can be CloudWatch Logs, Amazon S3, or Firehose.
\nTo configure logs delivery between a delivery destination and an Amazon Web Services service that is supported as a delivery source, you must do the following:
\nUse PutDeliverySource to create a delivery source, which is a logical object that represents the resource that is actually\n sending the logs.
Use PutDeliveryDestination to create a delivery destination, which is a logical object that represents the actual\n delivery destination. For more \n information, see PutDeliveryDestination.
If you are delivering logs cross-account, you must use \n PutDeliveryDestinationPolicy\n in the destination account to assign an IAM policy to the \n destination. This policy allows delivery to that destination.\n
\nUse CreateDelivery to create a delivery by pairing exactly \n one delivery source and one delivery destination. For more \n information, see CreateDelivery.\n
You can configure a single delivery source to send logs to multiple destinations by creating multiple deliveries. You \n can also create multiple deliveries to configure multiple delivery sources to send logs to the same delivery destination.
\nOnly some Amazon Web Services services support being configured as a delivery source. These services are listed\n as Supported [V2 Permissions] in the table at \n Enabling \n logging from Amazon Web Services services.\n
\nIf you use this operation to update an existing delivery source, all the current delivery source parameters are overwritten\n with the new parameter values that you specify.
" + } + }, + "com.amazonaws.cloudwatchlogs#PutDeliverySourceRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.cloudwatchlogs#DeliverySourceName", + "traits": { + "smithy.api#documentation": "A name for this delivery source. This name must be unique for all delivery sources in your account.
", + "smithy.api#required": {} + } + }, + "resourceArn": { + "target": "com.amazonaws.cloudwatchlogs#Arn", + "traits": { + "smithy.api#documentation": "The ARN of the Amazon Web Services resource that is generating and sending logs. \n For example, arn:aws:workmail:us-east-1:123456789012:organization/m-1234EXAMPLEabcd1234abcd1234abcd1234\n
Defines the type of log that the source is sending.
\nFor Amazon Bedrock, the valid value is \n APPLICATION_LOGS.
For Amazon CodeWhisperer, the valid value is \n EVENT_LOGS.
For IAM Identity Center, the valid value is \n ERROR_LOGS.
For Amazon WorkMail, the valid values are \n ACCESS_CONTROL_LOGS, AUTHENTICATION_LOGS, WORKMAIL_AVAILABILITY_PROVIDER_LOGS, and WORKMAIL_MAILBOX_ACCESS_LOGS.
An optional list of key-value pairs to associate with the resource.
\nFor more information about tagging, see \n Tagging Amazon Web Services resources\n
" + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - "smithy.api#documentation": "The ListTagsLogGroup operation is on the path to deprecation. We recommend that you use \n ListTagsForResource instead.
\nLists the tags for the specified log group.
" - } - }, - "com.amazonaws.cloudwatchlogs#ListTagsLogGroupRequest": { - "type": "structure", - "members": { - "logGroupName": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupName", - "traits": { - "smithy.api#documentation": "The name of the log group.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#deprecated": { - "message": "Please use the generic tagging API model ListTagsForResourceRequest and ListTagsForResourceResponse" + "com.amazonaws.cloudwatchlogs#PutDeliverySourceResponse": { + "type": "structure", + "members": { + "deliverySource": { + "target": "com.amazonaws.cloudwatchlogs#DeliverySource", + "traits": { + "smithy.api#documentation": "A structure containing information about the delivery source that was just created or updated.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } }, - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#ListTagsLogGroupResponse": { - "type": "structure", - "members": { - "tags": { - "target": "com.amazonaws.cloudwatchlogs#Tags", - "traits": { - "smithy.api#documentation": "The tags for the log group.
" - } - } - }, - "traits": { - "smithy.api#deprecated": { - "message": "Please use the generic tagging API model ListTagsForResourceRequest and ListTagsForResourceResponse" + "com.amazonaws.cloudwatchlogs#PutDestination": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#PutDestinationRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#PutDestinationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "Creates or updates a destination. This operation is used only to create destinations for cross-account subscriptions.
\nA destination encapsulates a physical resource (such as an Amazon Kinesis stream). With\n a destination, you can subscribe to a real-time stream of log events for a different account,\n ingested using PutLogEvents.
\nThrough an access policy, a destination controls what is written to it.\n By default, PutDestination does not set any access policy with the destination,\n which means a cross-account user cannot call PutSubscriptionFilter against\n this destination. To enable this, the destination owner must call PutDestinationPolicy after PutDestination.
To perform a PutDestination operation, you must also have the \n iam:PassRole permission.
The name of the log stream that ingested this log event.
" - } - }, - "logGroupIdentifier": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupIdentifier", - "traits": { - "smithy.api#documentation": "The name or ARN of the log group that ingested this log event.
" - } - }, - "message": { - "target": "com.amazonaws.cloudwatchlogs#EventMessage", - "traits": { - "smithy.api#documentation": "The log event message text.
" - } - }, - "timestamp": { - "target": "com.amazonaws.cloudwatchlogs#Timestamp", - "traits": { - "smithy.api#documentation": "The timestamp specifying when this log event was created.
" - } - }, - "ingestionTime": { - "target": "com.amazonaws.cloudwatchlogs#Timestamp", - "traits": { - "smithy.api#documentation": "The timestamp specifying when this log event was ingested into the log group.
" - } - } - }, - "traits": { - "smithy.api#documentation": "This object contains the information for one log event returned in a Live Tail stream.
" - } - }, - "com.amazonaws.cloudwatchlogs#LiveTailSessionMetadata": { - "type": "structure", - "members": { - "sampled": { - "target": "com.amazonaws.cloudwatchlogs#IsSampled", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "If this is true, then more than 500 log events matched the request for this update, and the \n sessionResults includes a sample of 500 of those events.
If this is false, then 500 or fewer log events matched the request for this update, so no sampling\n was necessary. In this case, the \n sessionResults array includes all log events that matched your request during this time.
This object contains the metadata for one LiveTailSessionUpdate structure. It indicates whether\n that update includes only a sample of 500 log events out of a larger number of ingested log events, or if it contains\n all of the matching log events ingested during that second of time.
The unique ID generated by CloudWatch Logs to identify this Live Tail session request.
" - } - }, - "sessionId": { - "target": "com.amazonaws.cloudwatchlogs#SessionId", - "traits": { - "smithy.api#documentation": "The unique ID generated by CloudWatch Logs to identify this Live Tail session.
" - } - }, - "logGroupIdentifiers": { - "target": "com.amazonaws.cloudwatchlogs#StartLiveTailLogGroupIdentifiers", - "traits": { - "smithy.api#documentation": "An array of the names and ARNs of the log groups included in this Live Tail session.
" - } - }, - "logStreamNames": { - "target": "com.amazonaws.cloudwatchlogs#InputLogStreamNames", - "traits": { - "smithy.api#documentation": "If your StartLiveTail operation request included a logStreamNames parameter that filtered the session\n to only include certain log streams, these streams are listed here.
If your StartLiveTail operation request included a logStreamNamePrefixes parameter that filtered the session\n to only include log streams that have names that start with certain prefixes, these prefixes are listed here.
An optional pattern to filter the results to include only log events that match the pattern.\n For example, a filter pattern of error 404 displays only log events that include both error \n and 404.
For more information about filter pattern syntax, see Filter and Pattern Syntax.
" - } - } - }, - "traits": { - "smithy.api#documentation": "This object contains information about this Live Tail session, including the log groups included and the \n log stream filters, if any.
" - } - }, - "com.amazonaws.cloudwatchlogs#LiveTailSessionUpdate": { - "type": "structure", - "members": { - "sessionMetadata": { - "target": "com.amazonaws.cloudwatchlogs#LiveTailSessionMetadata", - "traits": { - "smithy.api#documentation": "This object contains the session metadata for a Live Tail session.
" - } - }, - "sessionResults": { - "target": "com.amazonaws.cloudwatchlogs#LiveTailSessionResults", - "traits": { - "smithy.api#documentation": "An array, where each member of the array includes the information for one log event in the Live Tail session.
\nA sessionResults array can include as many as 500 log events. If the number of \n log events matching the request exceeds 500 per second, the\n log events are sampled down to 500 log events to be included in each sessionUpdate structure.
This object contains the log events and metadata for a Live Tail session.
" - } - }, - "com.amazonaws.cloudwatchlogs#LogEvent": { - "type": "structure", - "members": { - "timestamp": { - "target": "com.amazonaws.cloudwatchlogs#Timestamp", - "traits": { - "smithy.api#documentation": "The time stamp of the log event.
" - } - }, - "message": { - "target": "com.amazonaws.cloudwatchlogs#EventMessage", - "traits": { - "smithy.api#documentation": "The message content of the log event.
" - } - } - }, - "traits": { - "smithy.api#documentation": "This structure contains the information for one sample log event that is associated \n with an anomaly found by a log anomaly detector.
" - } - }, - "com.amazonaws.cloudwatchlogs#LogEventIndex": { - "type": "integer" - }, - "com.amazonaws.cloudwatchlogs#LogGroup": { - "type": "structure", - "members": { - "logGroupName": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupName", - "traits": { - "smithy.api#documentation": "The name of the log group.
" - } - }, - "creationTime": { - "target": "com.amazonaws.cloudwatchlogs#Timestamp", - "traits": { - "smithy.api#documentation": "The creation time of the log group, expressed as the number of milliseconds after Jan\n 1, 1970 00:00:00 UTC.
" - } - }, - "retentionInDays": { - "target": "com.amazonaws.cloudwatchlogs#Days" - }, - "metricFilterCount": { - "target": "com.amazonaws.cloudwatchlogs#FilterCount", - "traits": { - "smithy.api#documentation": "The number of metric filters.
" - } - }, - "arn": { - "target": "com.amazonaws.cloudwatchlogs#Arn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the log group. This version of the ARN includes a trailing :* after the log group name.
Use this version to refer to the ARN in IAM policies when specifying permissions for most API actions. The exception is when specifying permissions for TagResource, UntagResource, and \n ListTagsForResource. \n The permissions for those three actions require the ARN version that doesn't include a trailing :*.
The number of bytes stored.
" - } - }, - "kmsKeyId": { - "target": "com.amazonaws.cloudwatchlogs#KmsKeyId", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key to use when\n encrypting log data.
" - } - }, - "dataProtectionStatus": { - "target": "com.amazonaws.cloudwatchlogs#DataProtectionStatus", - "traits": { - "smithy.api#documentation": "Displays whether this log group has a protection policy, or whether it had one in the past. For more information, see \n PutDataProtectionPolicy.
" - } - }, - "inheritedProperties": { - "target": "com.amazonaws.cloudwatchlogs#InheritedProperties", - "traits": { - "smithy.api#documentation": "Displays all the properties that this log group has inherited from account-level \n settings.
" - } - }, - "logGroupClass": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupClass", - "traits": { - "smithy.api#documentation": "This specifies the log group class for this log group. There are two classes:
\nThe Standard log class supports all CloudWatch Logs features.
The Infrequent Access log class supports a subset of CloudWatch Logs features\n and incurs lower costs.
For details about the features supported by each class, see \n Log classes\n
" - } - }, - "logGroupArn": { - "target": "com.amazonaws.cloudwatchlogs#Arn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the log group. This version of the ARN doesn't include a trailing :* after the log group name.
Use this version to refer to the ARN in the following situations:
\nIn the logGroupIdentifier input field in many CloudWatch Logs APIs.
In the resourceArn field in tagging APIs
In IAM policies, when specifying permissions for TagResource, UntagResource, and \n ListTagsForResource.
\nRepresents a log group.
" - } - }, - "com.amazonaws.cloudwatchlogs#LogGroupArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - }, - "smithy.api#pattern": "^[\\w#+=/:,.@-]*$" - } - }, - "com.amazonaws.cloudwatchlogs#LogGroupArnList": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupArn" - } - }, - "com.amazonaws.cloudwatchlogs#LogGroupClass": { - "type": "enum", - "members": { - "STANDARD": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STANDARD" - } - }, - "INFREQUENT_ACCESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INFREQUENT_ACCESS" - } - } - } - }, - "com.amazonaws.cloudwatchlogs#LogGroupField": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.cloudwatchlogs#Field", - "traits": { - "smithy.api#documentation": "The name of a log field.
" - } - }, - "percent": { - "target": "com.amazonaws.cloudwatchlogs#Percentage", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The percentage of log events queried that contained the field.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The fields contained in log events found by a GetLogGroupFields operation,\n along with the percentage of queried log events in which each field appears.
The name of the log stream.
" - } - }, - "creationTime": { - "target": "com.amazonaws.cloudwatchlogs#Timestamp", - "traits": { - "smithy.api#documentation": "The creation time of the stream, expressed as the number of milliseconds after\n Jan 1, 1970 00:00:00 UTC.
The time of the first event, expressed as the number of milliseconds after Jan 1,\n 1970 00:00:00 UTC.
The time of the most recent log event in the log stream in CloudWatch Logs. This number\n is expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. The\n lastEventTime value updates on an eventual consistency basis. It typically\n updates in less than an hour from ingestion, but in rare situations might take\n longer.
The ingestion time, expressed as the number of milliseconds after Jan 1, 1970\n 00:00:00 UTC The lastIngestionTime value updates on an eventual consistency basis. It \n typically updates in less than an hour after ingestion, but in rare situations might take longer.
The sequence token.
\nThe sequence token is now ignored in \n PutLogEvents\n actions. PutLogEvents actions are always accepted regardless of receiving an invalid sequence token. \n You don't need to obtain uploadSequenceToken to use a PutLogEvents action.
The Amazon Resource Name (ARN) of the log stream.
" - } - }, - "storedBytes": { - "target": "com.amazonaws.cloudwatchlogs#StoredBytes", - "traits": { - "smithy.api#deprecated": { - "message": "Starting on June 17, 2019, this parameter will be deprecated for log streams, and will be reported as zero. This change applies only to log streams. The storedBytes parameter for log groups is not affected." - }, - "smithy.api#documentation": "The number of bytes stored.
\n\n Important: As of June 17, 2019, this parameter is no\n longer supported for log streams, and is always reported as zero. This change applies only to\n log streams. The storedBytes parameter for log groups is not affected.
Represents a log stream, which is a sequence of log events from \n a single emitter of logs.
" - } - }, - "com.amazonaws.cloudwatchlogs#LogStreamName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 512 - }, - "smithy.api#pattern": "^[^:*]*$" - } - }, - "com.amazonaws.cloudwatchlogs#LogStreamSearchedCompletely": { - "type": "boolean" - }, - "com.amazonaws.cloudwatchlogs#LogStreams": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudwatchlogs#LogStream" - } - }, - "com.amazonaws.cloudwatchlogs#LogType": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - }, - "smithy.api#pattern": "^[\\w]*$" - } - }, - "com.amazonaws.cloudwatchlogs#Logs_20140328": { - "type": "service", - "version": "2014-03-28", - "operations": [ - { - "target": "com.amazonaws.cloudwatchlogs#AssociateKmsKey" + "com.amazonaws.cloudwatchlogs#PutDestinationPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#PutDestinationPolicyRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "Creates or updates an access policy associated with an existing\n destination. An access policy is an IAM policy document that is used\n to authorize claims to register a subscription filter against a given destination.
" + } + }, + "com.amazonaws.cloudwatchlogs#PutDestinationPolicyRequest": { + "type": "structure", + "members": { + "destinationName": { + "target": "com.amazonaws.cloudwatchlogs#DestinationName", + "traits": { + "smithy.api#documentation": "A name for an existing destination.
", + "smithy.api#required": {} + } + }, + "accessPolicy": { + "target": "com.amazonaws.cloudwatchlogs#AccessPolicy", + "traits": { + "smithy.api#documentation": "An IAM policy document that authorizes cross-account users to deliver their log events\n to the associated destination. This can be up to 5120 bytes.
", + "smithy.api#required": {} + } + }, + "forceUpdate": { + "target": "com.amazonaws.cloudwatchlogs#ForceUpdate", + "traits": { + "smithy.api#documentation": "Specify true if you are updating an existing destination policy to grant permission to\n an organization ID instead of granting permission to individual Amazon Web Services accounts. Before\n you update a destination policy this way, you must first update the subscription\n filters in the accounts that send logs to this destination. If you do not, the subscription\n filters might stop working. By specifying true\n for forceUpdate, you are affirming that you have already updated the subscription \n filters.\n For more information, see \n Updating an existing cross-account subscription\n
If you omit this parameter, the default of false is used.
A name for the destination.
", + "smithy.api#required": {} + } + }, + "targetArn": { + "target": "com.amazonaws.cloudwatchlogs#TargetArn", + "traits": { + "smithy.api#documentation": "The ARN of an Amazon Kinesis stream to which to deliver matching log events.
", + "smithy.api#required": {} + } + }, + "roleArn": { + "target": "com.amazonaws.cloudwatchlogs#RoleArn", + "traits": { + "smithy.api#documentation": "The ARN of an IAM role that grants CloudWatch Logs permissions to call the Amazon\n Kinesis PutRecord operation on the destination stream.
An optional list of key-value pairs to associate with the resource.
\nFor more information about tagging, see \n Tagging Amazon Web Services resources\n
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#PutDestinationResponse": { + "type": "structure", + "members": { + "destination": { + "target": "com.amazonaws.cloudwatchlogs#Destination", + "traits": { + "smithy.api#documentation": "The destination.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#PutLogEvents": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#PutLogEventsRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#PutLogEventsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#DataAlreadyAcceptedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#InvalidSequenceTokenException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#UnrecognizedClientException" + } + ], + "traits": { + "smithy.api#documentation": "Uploads a batch of log events to the specified log stream.
\nThe sequence token is now ignored in PutLogEvents\n actions. PutLogEvents\n actions are always accepted and never return InvalidSequenceTokenException or\n DataAlreadyAcceptedException even if the sequence token is not valid. You can use\n parallel PutLogEvents actions on the same log stream.
The batch of events must satisfy the following constraints:
\nThe maximum batch size is 1,048,576 bytes. This size is calculated as the sum of\n all event messages in UTF-8, plus 26 bytes for each log event.
\nNone of the log events in the batch can be more than 2 hours in the future.
\nNone of the log events in the batch can be more than 14 days in the past. Also,\n none of the log events can be from earlier than the retention period of the log\n group.
\nThe log events in the batch must be in chronological order by their timestamp. The\n timestamp is the time that the event occurred, expressed as the number of milliseconds\n after Jan 1, 1970 00:00:00 UTC. (In Amazon Web Services Tools for PowerShell\n and the Amazon Web Services SDK for .NET, the timestamp is specified in .NET format:\n yyyy-mm-ddThh:mm:ss. For example, 2017-09-15T13:45:30.)
A batch of log events in a single request cannot span more than 24 hours. Otherwise, the operation fails.
\nEach log event can be no larger than 256 KB.
\nThe maximum number of log events in a batch is 10,000.
\nThe quota of five requests per second per log stream\n has been removed. Instead, PutLogEvents actions are throttled based on a \n per-second per-account quota. You can request an increase to the per-second throttling\n quota by using the Service Quotas service.
If a call to PutLogEvents returns \"UnrecognizedClientException\" the most\n likely cause is a non-valid Amazon Web Services access key ID or secret key.
The name of the log group.
", + "smithy.api#required": {} + } + }, + "logStreamName": { + "target": "com.amazonaws.cloudwatchlogs#LogStreamName", + "traits": { + "smithy.api#documentation": "The name of the log stream.
", + "smithy.api#required": {} + } + }, + "logEvents": { + "target": "com.amazonaws.cloudwatchlogs#InputLogEvents", + "traits": { + "smithy.api#documentation": "The log events.
", + "smithy.api#required": {} + } + }, + "sequenceToken": { + "target": "com.amazonaws.cloudwatchlogs#SequenceToken", + "traits": { + "smithy.api#documentation": "The sequence token obtained from the response of the previous PutLogEvents\n call.
The sequenceToken parameter is now ignored in PutLogEvents\n actions. PutLogEvents\n actions are now accepted and never return InvalidSequenceTokenException or\n DataAlreadyAcceptedException even if the sequence token is not valid.
Reserved for internal use.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#PutLogEventsResponse": { + "type": "structure", + "members": { + "nextSequenceToken": { + "target": "com.amazonaws.cloudwatchlogs#SequenceToken", + "traits": { + "smithy.api#documentation": "The next sequence token.
\nThis field has been deprecated.
\nThe sequence token is now ignored in PutLogEvents\n actions. PutLogEvents\n actions are always accepted even if the sequence token is not valid. You can use\n parallel PutLogEvents actions on the same log stream and you do not need\n to wait for the response of a previous PutLogEvents action to obtain \n the nextSequenceToken value.
The rejected events.
" + } + }, + "rejectedEntityInfo": { + "target": "com.amazonaws.cloudwatchlogs#RejectedEntityInfo", + "traits": { + "smithy.api#documentation": "Reserved for internal use.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#PutMetricFilter": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#PutMetricFilterRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#LimitExceededException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "Creates or updates a metric filter and associates it with the specified log group. With\n metric filters, you can configure rules to extract metric data from log events ingested\n through PutLogEvents.
\nThe maximum number of metric filters that can be associated with a log group is\n 100.
\nUsing regular expressions to create metric filters is supported. For these filters, \n there is a quotas of quota of two regular expression patterns within a single filter pattern. There\n is also a quota of five regular expression patterns per log group.\n For more information about using regular expressions in metric filters, \n see \n Filter pattern syntax for metric filters, subscription filters, filter log events, and Live Tail.
\nWhen you create a metric filter, you can also optionally assign a unit and dimensions\n to the metric that is created.
\nMetrics extracted from log events are charged as custom metrics.\n To prevent unexpected high charges, do not specify high-cardinality fields such as \n IPAddress or requestID as dimensions. Each different value \n found for \n a dimension is treated as a separate metric and accrues charges as a separate custom metric.\n
CloudWatch Logs might disable a metric filter if it generates 1,000 different name/value pairs for\n your specified dimensions within one hour.
\nYou can also set up a billing alarm to alert you if your charges are higher than \n expected. For more information, \n see \n Creating a Billing Alarm to Monitor Your Estimated Amazon Web Services Charges.\n
\nThe name of the log group.
", + "smithy.api#required": {} + } + }, + "filterName": { + "target": "com.amazonaws.cloudwatchlogs#FilterName", + "traits": { + "smithy.api#documentation": "A name for the metric filter.
", + "smithy.api#required": {} + } + }, + "filterPattern": { + "target": "com.amazonaws.cloudwatchlogs#FilterPattern", + "traits": { + "smithy.api#documentation": "A filter pattern for extracting metric data out of ingested log events.
", + "smithy.api#required": {} + } + }, + "metricTransformations": { + "target": "com.amazonaws.cloudwatchlogs#MetricTransformations", + "traits": { + "smithy.api#documentation": "A collection of information that defines how metric data gets emitted.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.cloudwatchlogs#CancelExportTask" + "com.amazonaws.cloudwatchlogs#PutQueryDefinition": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#PutQueryDefinitionRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#PutQueryDefinitionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#LimitExceededException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "Creates or updates a query definition for CloudWatch Logs Insights. For \n more information, see Analyzing Log Data with CloudWatch Logs Insights.
\nTo update a query definition, specify its queryDefinitionId in your request.\n The values of name, queryString, and logGroupNames are\n changed to the values that you specify in your update operation. No current values are\n retained from the current query definition. For example, imagine updating a current query\n definition that includes log groups. If you don't specify the logGroupNames\n parameter in your update operation, the query definition changes to contain no log\n groups.
You must have the logs:PutQueryDefinition permission to be able to perform\n this operation.
A name for the query definition. If you are saving numerous query definitions, we\n recommend that you name them. This way, you can find the ones you want by using the first part\n of the name as a filter in the queryDefinitionNamePrefix parameter of DescribeQueryDefinitions.
If you are updating a query definition, use this parameter to specify the ID of the query\n definition that you want to update. You can use DescribeQueryDefinitions to retrieve the IDs of your saved query\n definitions.
\nIf you are creating a query definition, do not specify this parameter. CloudWatch\n generates a unique ID for the new query definition and include it in the response to this\n operation.
" + } + }, + "logGroupNames": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupNames", + "traits": { + "smithy.api#documentation": "Use this parameter to include specific log groups as part of your query definition.
\nIf you are updating a query definition and you omit this parameter, then the updated\n definition will contain no log groups.
" + } + }, + "queryString": { + "target": "com.amazonaws.cloudwatchlogs#QueryDefinitionString", + "traits": { + "smithy.api#documentation": "The query string to use for this definition. \n For more information, see CloudWatch Logs Insights Query Syntax.
", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.cloudwatchlogs#ClientToken", + "traits": { + "smithy.api#documentation": "Used as an idempotency token, to avoid returning an exception if the service receives the same \n request twice because of a network\n\n error.
", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.cloudwatchlogs#CreateExportTask" + "com.amazonaws.cloudwatchlogs#PutQueryDefinitionResponse": { + "type": "structure", + "members": { + "queryDefinitionId": { + "target": "com.amazonaws.cloudwatchlogs#QueryId", + "traits": { + "smithy.api#documentation": "The ID of the query definition.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.cloudwatchlogs#CreateLogAnomalyDetector" + "com.amazonaws.cloudwatchlogs#PutResourcePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#PutResourcePolicyRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#PutResourcePolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#LimitExceededException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "Creates or updates a resource policy allowing other Amazon Web Services services to put log events to\n this account, such as Amazon Route 53. An account can have up to 10 resource policies per Amazon Web Services\n Region.
" + } }, - { - "target": "com.amazonaws.cloudwatchlogs#CreateLogGroup" + "com.amazonaws.cloudwatchlogs#PutResourcePolicyRequest": { + "type": "structure", + "members": { + "policyName": { + "target": "com.amazonaws.cloudwatchlogs#PolicyName", + "traits": { + "smithy.api#documentation": "Name of the new policy. This parameter is required.
" + } + }, + "policyDocument": { + "target": "com.amazonaws.cloudwatchlogs#PolicyDocument", + "traits": { + "smithy.api#documentation": "Details of the new policy, including the identity of the principal that is enabled to put logs to this account. This is formatted as a JSON string.\n This parameter is required.
\nThe following example creates a resource policy enabling the Route 53 service to put\n DNS query logs in to the specified log group. Replace \"logArn\" with the ARN of \n your CloudWatch Logs resource, such as a log group or log stream.
CloudWatch Logs also supports aws:SourceArn\n and aws:SourceAccount\ncondition context keys.
\nIn the example resource policy, you would replace the value of SourceArn with\n the resource making the call from Route 53 to CloudWatch Logs. You would also\n replace the value of SourceAccount with the Amazon Web Services account ID making\n that call.
\n {\n \"Version\": \"2012-10-17\",\n \"Statement\": [\n {\n \"Sid\": \"Route53LogsToCloudWatchLogs\",\n \"Effect\": \"Allow\",\n \"Principal\": {\n \"Service\": [\n \"route53.amazonaws.com\"\n ]\n },\n \"Action\": \"logs:PutLogEvents\",\n \"Resource\": \"logArn\",\n \"Condition\": {\n \"ArnLike\": {\n \"aws:SourceArn\": \"myRoute53ResourceArn\"\n },\n \"StringEquals\": {\n \"aws:SourceAccount\": \"myAwsAccountId\"\n }\n }\n }\n ]\n}\n
The new policy.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.cloudwatchlogs#DeleteAccountPolicy" + "com.amazonaws.cloudwatchlogs#PutRetentionPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#PutRetentionPolicyRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "Sets the retention of the specified log group. With a retention policy, you can\n configure the number of days for which to retain log events in the specified log\n group.
\nCloudWatch Logs doesn’t immediately delete log events when they reach their retention\n setting. It typically takes up to 72 hours after that before log events are deleted, but in\n rare situations might take longer.
\nTo illustrate, imagine that you change a log group to have a longer retention setting\n when it contains log events that are past the expiration date, but haven’t been deleted.\n Those log events will take up to 72 hours to be deleted after the new retention date is\n reached. To make sure that log data is deleted permanently, keep a log group at its lower\n retention setting until 72 hours after the previous retention period ends. Alternatively,\n wait to change the retention setting until you confirm that the earlier log events are\n deleted.
\nWhen log events reach their retention setting they are marked for deletion. After\n they are marked for deletion, they do not add to your archival storage costs anymore, even if \n they are not actually deleted until later. These log events marked for deletion are also not \n included when you use an API to retrieve the storedBytes value to see how many bytes a log group is storing.
The name of the log group.
", + "smithy.api#required": {} + } + }, + "retentionInDays": { + "target": "com.amazonaws.cloudwatchlogs#Days", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.cloudwatchlogs#DeleteDelivery" + "com.amazonaws.cloudwatchlogs#PutSubscriptionFilter": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#PutSubscriptionFilterRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#LimitExceededException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "Creates or updates a subscription filter and associates it with the specified log\n group. With subscription filters, you can subscribe to a real-time stream of log events\n ingested through PutLogEvents\n and have them delivered to a specific destination. When log events are sent to the receiving\n service, they are Base64 encoded and compressed with the GZIP format.
\nThe following destinations are supported for subscription filters:
\nAn Amazon Kinesis data stream belonging to the same account as the subscription\n filter, for same-account delivery.
\nA logical destination created with PutDestination that belongs to a different account, for cross-account delivery.\n We currently support Kinesis Data Streams and Firehose as logical destinations.
\nAn Amazon Kinesis Data Firehose delivery stream that belongs to the same account as\n the subscription filter, for same-account delivery.
\nAn Lambda function that belongs to the same account as the\n subscription filter, for same-account delivery.
\nEach log group can have up to two subscription filters associated with it. If you are\n updating an existing filter, you must specify the correct name in filterName.\n
Using regular expressions to create subscription filters is supported. For these filters, \n there is a quotas of quota of two regular expression patterns within a single filter pattern. There\n is also a quota of five regular expression patterns per log group.\n For more information about using regular expressions in subscription filters, \n see \n Filter pattern syntax for metric filters, subscription filters, filter log events, and Live Tail.
\nTo perform a PutSubscriptionFilter operation for any destination except a Lambda function, \n you must also have the \n iam:PassRole permission.
The name of the log group.
", + "smithy.api#required": {} + } + }, + "filterName": { + "target": "com.amazonaws.cloudwatchlogs#FilterName", + "traits": { + "smithy.api#documentation": "A name for the subscription filter. If you are updating an existing filter, you must\n specify the correct name in filterName. To find the name of the filter currently\n associated with a log group, use DescribeSubscriptionFilters.
A filter pattern for subscribing to a filtered stream of log events.
", + "smithy.api#required": {} + } + }, + "destinationArn": { + "target": "com.amazonaws.cloudwatchlogs#DestinationArn", + "traits": { + "smithy.api#documentation": "The ARN of the destination to deliver matching log events to. Currently, the supported\n destinations are:
\nAn Amazon Kinesis stream belonging to the same account as the subscription filter,\n for same-account delivery.
\nA logical destination (specified using an ARN) belonging to a different account, \n for cross-account delivery.
\nIf you're setting up a cross-account subscription, the destination must have an IAM\n policy associated with it. The IAM policy must allow the sender to send logs to the\n destination. For more information, see PutDestinationPolicy.
\nA Kinesis Data Firehose delivery stream belonging to the same account as the\n subscription filter, for same-account delivery.
\nA Lambda function belonging to the same account as the subscription filter,\n for same-account delivery.
\nThe ARN of an IAM role that grants CloudWatch Logs permissions to deliver ingested log\n events to the destination stream. You don't need to provide the ARN when you are working with\n a logical destination for cross-account delivery.
" + } + }, + "distribution": { + "target": "com.amazonaws.cloudwatchlogs#Distribution", + "traits": { + "smithy.api#documentation": "The method used to distribute log data to the destination. By default, log data is\n grouped by log stream, but the grouping can be set to random for a more even distribution.\n This property is only applicable when the destination is an Amazon Kinesis data stream.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.cloudwatchlogs#DeleteDeliveryDestinationPolicy" + "com.amazonaws.cloudwatchlogs#QueryCharOffset": { + "type": "integer" }, - { - "target": "com.amazonaws.cloudwatchlogs#DeleteDeliverySource" + "com.amazonaws.cloudwatchlogs#QueryCompileError": { + "type": "structure", + "members": { + "location": { + "target": "com.amazonaws.cloudwatchlogs#QueryCompileErrorLocation", + "traits": { + "smithy.api#documentation": "Reserved.
" + } + }, + "message": { + "target": "com.amazonaws.cloudwatchlogs#Message", + "traits": { + "smithy.api#documentation": "Reserved.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Reserved.
" + } }, - { - "target": "com.amazonaws.cloudwatchlogs#DeleteDestination" + "com.amazonaws.cloudwatchlogs#QueryCompileErrorLocation": { + "type": "structure", + "members": { + "startCharOffset": { + "target": "com.amazonaws.cloudwatchlogs#QueryCharOffset", + "traits": { + "smithy.api#documentation": "Reserved.
" + } + }, + "endCharOffset": { + "target": "com.amazonaws.cloudwatchlogs#QueryCharOffset", + "traits": { + "smithy.api#documentation": "Reserved.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Reserved.
" + } }, - { - "target": "com.amazonaws.cloudwatchlogs#DeleteLogAnomalyDetector" + "com.amazonaws.cloudwatchlogs#QueryDefinition": { + "type": "structure", + "members": { + "queryDefinitionId": { + "target": "com.amazonaws.cloudwatchlogs#QueryId", + "traits": { + "smithy.api#documentation": "The unique ID of the query definition.
" + } + }, + "name": { + "target": "com.amazonaws.cloudwatchlogs#QueryDefinitionName", + "traits": { + "smithy.api#documentation": "The name of the query definition.
" + } + }, + "queryString": { + "target": "com.amazonaws.cloudwatchlogs#QueryDefinitionString", + "traits": { + "smithy.api#documentation": "The query string to use for this definition.\n For more information, see CloudWatch Logs Insights Query Syntax.
" + } + }, + "lastModified": { + "target": "com.amazonaws.cloudwatchlogs#Timestamp", + "traits": { + "smithy.api#documentation": "The date that the query definition was most recently modified.
" + } + }, + "logGroupNames": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupNames", + "traits": { + "smithy.api#documentation": "If this query definition contains a list of log groups that it is limited to, that list appears here.
" + } + } + }, + "traits": { + "smithy.api#documentation": "This structure contains details about a saved CloudWatch Logs Insights query definition.
" + } }, - { - "target": "com.amazonaws.cloudwatchlogs#DeleteLogGroup" + "com.amazonaws.cloudwatchlogs#QueryDefinitionList": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#QueryDefinition" + } }, - { - "target": "com.amazonaws.cloudwatchlogs#DeleteLogStream" + "com.amazonaws.cloudwatchlogs#QueryDefinitionName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } }, - { - "target": "com.amazonaws.cloudwatchlogs#DeleteMetricFilter" + "com.amazonaws.cloudwatchlogs#QueryDefinitionString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10000 + } + } }, - { - "target": "com.amazonaws.cloudwatchlogs#DeleteQueryDefinition" + "com.amazonaws.cloudwatchlogs#QueryId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } }, - { - "target": "com.amazonaws.cloudwatchlogs#DeleteResourcePolicy" + "com.amazonaws.cloudwatchlogs#QueryInfo": { + "type": "structure", + "members": { + "queryId": { + "target": "com.amazonaws.cloudwatchlogs#QueryId", + "traits": { + "smithy.api#documentation": "The unique ID number of this query.
" + } + }, + "queryString": { + "target": "com.amazonaws.cloudwatchlogs#QueryString", + "traits": { + "smithy.api#documentation": "The query string used in this query.
" + } + }, + "status": { + "target": "com.amazonaws.cloudwatchlogs#QueryStatus", + "traits": { + "smithy.api#documentation": "The status of this query. Possible values are Cancelled,\n Complete, Failed, Running, Scheduled, and Unknown.
The date and time that this query was created.
" + } + }, + "logGroupName": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupName", + "traits": { + "smithy.api#documentation": "The name of the log group scanned by this query.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about one CloudWatch Logs Insights query that matches the request in a DescribeQueries operation.
The number of log events that matched the query string.
" + } + }, + "recordsScanned": { + "target": "com.amazonaws.cloudwatchlogs#StatsValue", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The total number of log events scanned during the query.
" + } + }, + "bytesScanned": { + "target": "com.amazonaws.cloudwatchlogs#StatsValue", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The total number of bytes in the log events scanned during the query.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the number of log events scanned by the query, the number of log events that matched the \n query criteria, and the total number of bytes in the log events that were scanned.
" + } }, - { - "target": "com.amazonaws.cloudwatchlogs#DescribeDeliveryDestinations" + "com.amazonaws.cloudwatchlogs#QueryStatus": { + "type": "enum", + "members": { + "Scheduled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Scheduled" + } + }, + "Running": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Running" + } + }, + "Complete": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Complete" + } + }, + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "Cancelled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Cancelled" + } + }, + "Timeout": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Timeout" + } + }, + "Unknown": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Unknown" + } + } + } }, - { - "target": "com.amazonaws.cloudwatchlogs#DescribeDeliverySources" + "com.amazonaws.cloudwatchlogs#QueryString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10000 + } + } }, - { - "target": "com.amazonaws.cloudwatchlogs#DescribeDestinations" + "com.amazonaws.cloudwatchlogs#RecordField": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.cloudwatchlogs#FieldHeader", + "traits": { + "smithy.api#documentation": "The name to use when specifying this record field in a \n CreateDelivery or \n UpdateDeliveryConfiguration operation.
" + } + }, + "mandatory": { + "target": "com.amazonaws.cloudwatchlogs#Boolean", + "traits": { + "smithy.api#documentation": "If this is true, the record field must be present in the recordFields parameter provided to a \n CreateDelivery or \n UpdateDeliveryConfiguration operation.
A structure that represents a valid record field header and whether it is mandatory.
" + } }, - { - "target": "com.amazonaws.cloudwatchlogs#DescribeExportTasks" + "com.amazonaws.cloudwatchlogs#RecordFields": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#FieldHeader" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 128 + } + } }, - { - "target": "com.amazonaws.cloudwatchlogs#DescribeLogGroups" + "com.amazonaws.cloudwatchlogs#RejectedEntityInfo": { + "type": "structure", + "members": { + "errorType": { + "target": "com.amazonaws.cloudwatchlogs#EntityRejectionErrorType", + "traits": { + "smithy.api#documentation": "Reserved for internal use.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Reserved for internal use.
" + } }, - { - "target": "com.amazonaws.cloudwatchlogs#DescribeLogStreams" + "com.amazonaws.cloudwatchlogs#RejectedLogEventsInfo": { + "type": "structure", + "members": { + "tooNewLogEventStartIndex": { + "target": "com.amazonaws.cloudwatchlogs#LogEventIndex", + "traits": { + "smithy.api#documentation": "The index of the first log event that is too new. This field is inclusive.
" + } + }, + "tooOldLogEventEndIndex": { + "target": "com.amazonaws.cloudwatchlogs#LogEventIndex", + "traits": { + "smithy.api#documentation": "The index of the last log event that is too old. This field is exclusive.
" + } + }, + "expiredLogEventEndIndex": { + "target": "com.amazonaws.cloudwatchlogs#LogEventIndex", + "traits": { + "smithy.api#documentation": "The expired log events.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents the rejected events.
" + } }, - { - "target": "com.amazonaws.cloudwatchlogs#DescribeMetricFilters" + "com.amazonaws.cloudwatchlogs#RequestId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } }, - { - "target": "com.amazonaws.cloudwatchlogs#DescribeQueries" + "com.amazonaws.cloudwatchlogs#ResourceAlreadyExistsException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.cloudwatchlogs#Message" + } + }, + "traits": { + "smithy.api#documentation": "The specified resource already exists.
", + "smithy.api#error": "client" + } }, - { - "target": "com.amazonaws.cloudwatchlogs#DescribeQueryDefinitions" + "com.amazonaws.cloudwatchlogs#ResourceArns": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#Arn" + } }, - { - "target": "com.amazonaws.cloudwatchlogs#DescribeResourcePolicies" + "com.amazonaws.cloudwatchlogs#ResourceIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^[\\w+=/:,.@\\-\\*]*$" + } }, - { - "target": "com.amazonaws.cloudwatchlogs#DescribeSubscriptionFilters" + "com.amazonaws.cloudwatchlogs#ResourceNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.cloudwatchlogs#Message" + } + }, + "traits": { + "smithy.api#documentation": "The specified resource does not exist.
", + "smithy.api#error": "client" + } }, - { - "target": "com.amazonaws.cloudwatchlogs#DisassociateKmsKey" + "com.amazonaws.cloudwatchlogs#ResourcePolicies": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#ResourcePolicy" + } }, - { - "target": "com.amazonaws.cloudwatchlogs#FilterLogEvents" + "com.amazonaws.cloudwatchlogs#ResourcePolicy": { + "type": "structure", + "members": { + "policyName": { + "target": "com.amazonaws.cloudwatchlogs#PolicyName", + "traits": { + "smithy.api#documentation": "The name of the resource policy.
" + } + }, + "policyDocument": { + "target": "com.amazonaws.cloudwatchlogs#PolicyDocument", + "traits": { + "smithy.api#documentation": "The details of the policy.
" + } + }, + "lastUpdatedTime": { + "target": "com.amazonaws.cloudwatchlogs#Timestamp", + "traits": { + "smithy.api#documentation": "Timestamp showing when this policy was last updated, expressed as the number of\n milliseconds after Jan 1, 1970 00:00:00 UTC.
A policy enabling one or more entities to put logs to a log group in this account.
" + } }, - { - "target": "com.amazonaws.cloudwatchlogs#GetDataProtectionPolicy" + "com.amazonaws.cloudwatchlogs#ResourceType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[\\w-_]*$" + } }, - { - "target": "com.amazonaws.cloudwatchlogs#GetDelivery" + "com.amazonaws.cloudwatchlogs#ResourceTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#ResourceType" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } }, - { - "target": "com.amazonaws.cloudwatchlogs#GetDeliveryDestination" + "com.amazonaws.cloudwatchlogs#ResultField": { + "type": "structure", + "members": { + "field": { + "target": "com.amazonaws.cloudwatchlogs#Field", + "traits": { + "smithy.api#documentation": "The log event field.
" + } + }, + "value": { + "target": "com.amazonaws.cloudwatchlogs#Value", + "traits": { + "smithy.api#documentation": "The value of this field.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains one field from one log event returned by a CloudWatch Logs Insights query, along with the value of that field.
\nFor more information about the fields that are \n generated by CloudWatch logs, see \n Supported Logs and Discovered Fields.
" + } }, - { - "target": "com.amazonaws.cloudwatchlogs#GetDeliveryDestinationPolicy" + "com.amazonaws.cloudwatchlogs#ResultRows": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#ResultField" + } }, - { - "target": "com.amazonaws.cloudwatchlogs#GetDeliverySource" + "com.amazonaws.cloudwatchlogs#RoleArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } }, - { - "target": "com.amazonaws.cloudwatchlogs#GetLogAnomalyDetector" + "com.amazonaws.cloudwatchlogs#S3DeliveryConfiguration": { + "type": "structure", + "members": { + "suffixPath": { + "target": "com.amazonaws.cloudwatchlogs#DeliverySuffixPath", + "traits": { + "smithy.api#documentation": "This string allows re-configuring the S3 object prefix to contain either static or variable sections. The valid variables \n to use in the suffix path will vary by each log source. See ConfigurationTemplate$allowedSuffixPathFields for \n more info on what values are supported in the suffix path for each log source.
" + } + }, + "enableHiveCompatiblePath": { + "target": "com.amazonaws.cloudwatchlogs#Boolean", + "traits": { + "smithy.api#documentation": "This parameter causes the S3 objects that contain delivered logs to use a prefix structure that allows for integration with Apache Hive.
" + } + } + }, + "traits": { + "smithy.api#documentation": "This structure contains delivery configurations that apply only when the delivery destination resource is an S3 bucket.
" + } }, - { - "target": "com.amazonaws.cloudwatchlogs#GetLogEvents" + "com.amazonaws.cloudwatchlogs#Scope": { + "type": "enum", + "members": { + "ALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL" + } + } + } }, - { - "target": "com.amazonaws.cloudwatchlogs#GetLogGroupFields" + "com.amazonaws.cloudwatchlogs#SearchedLogStream": { + "type": "structure", + "members": { + "logStreamName": { + "target": "com.amazonaws.cloudwatchlogs#LogStreamName", + "traits": { + "smithy.api#documentation": "The name of the log stream.
" + } + }, + "searchedCompletely": { + "target": "com.amazonaws.cloudwatchlogs#LogStreamSearchedCompletely", + "traits": { + "smithy.api#documentation": "Indicates whether all the events in this log stream were searched.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents the search status of a log stream.
" + } }, - { - "target": "com.amazonaws.cloudwatchlogs#GetLogRecord" + "com.amazonaws.cloudwatchlogs#SearchedLogStreams": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#SearchedLogStream" + } }, - { - "target": "com.amazonaws.cloudwatchlogs#GetQueryResults" + "com.amazonaws.cloudwatchlogs#SelectionCriteria": { + "type": "string" }, - { - "target": "com.amazonaws.cloudwatchlogs#ListAnomalies" + "com.amazonaws.cloudwatchlogs#SequenceToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } }, - { - "target": "com.amazonaws.cloudwatchlogs#ListLogAnomalyDetectors" + "com.amazonaws.cloudwatchlogs#Service": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[\\w_-]*$" + } }, - { - "target": "com.amazonaws.cloudwatchlogs#ListTagsForResource" + "com.amazonaws.cloudwatchlogs#ServiceQuotaExceededException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.cloudwatchlogs#Message" + } + }, + "traits": { + "smithy.api#documentation": "This request exceeds a service quota.
", + "smithy.api#error": "client" + } }, - { - "target": "com.amazonaws.cloudwatchlogs#ListTagsLogGroup" + "com.amazonaws.cloudwatchlogs#ServiceUnavailableException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.cloudwatchlogs#Message" + } + }, + "traits": { + "smithy.api#documentation": "The service cannot complete the request.
", + "smithy.api#error": "server" + } }, - { - "target": "com.amazonaws.cloudwatchlogs#PutAccountPolicy" + "com.amazonaws.cloudwatchlogs#SessionId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } }, - { - "target": "com.amazonaws.cloudwatchlogs#PutDataProtectionPolicy" + "com.amazonaws.cloudwatchlogs#SessionStreamingException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.cloudwatchlogs#Message" + } + }, + "traits": { + "smithy.api#documentation": "his exception is returned if an unknown error occurs during a Live Tail session.
", + "smithy.api#error": "client" + } }, - { - "target": "com.amazonaws.cloudwatchlogs#PutDeliveryDestination" + "com.amazonaws.cloudwatchlogs#SessionTimeoutException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.cloudwatchlogs#Message" + } + }, + "traits": { + "smithy.api#documentation": "This exception is returned in a Live Tail stream when the Live Tail session times out. Live Tail sessions time\n out after three hours.
", + "smithy.api#error": "client" + } }, - { - "target": "com.amazonaws.cloudwatchlogs#PutDeliveryDestinationPolicy" + "com.amazonaws.cloudwatchlogs#StandardUnit": { + "type": "enum", + "members": { + "Seconds": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Seconds" + } + }, + "Microseconds": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Microseconds" + } + }, + "Milliseconds": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Milliseconds" + } + }, + "Bytes": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Bytes" + } + }, + "Kilobytes": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Kilobytes" + } + }, + "Megabytes": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Megabytes" + } + }, + "Gigabytes": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Gigabytes" + } + }, + "Terabytes": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Terabytes" + } + }, + "Bits": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Bits" + } + }, + "Kilobits": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Kilobits" + } + }, + "Megabits": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Megabits" + } + }, + "Gigabits": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Gigabits" + } + }, + "Terabits": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Terabits" + } + }, + "Percent": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Percent" + } + }, + "Count": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Count" + } + }, + "BytesSecond": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Bytes/Second" + } + }, + "KilobytesSecond": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Kilobytes/Second" + } + }, + "MegabytesSecond": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Megabytes/Second" + } + }, + "GigabytesSecond": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Gigabytes/Second" + } + }, + "TerabytesSecond": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Terabytes/Second" + } + }, + "BitsSecond": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Bits/Second" + } + }, + "KilobitsSecond": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Kilobits/Second" + } + }, + "MegabitsSecond": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Megabits/Second" + } + }, + "GigabitsSecond": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Gigabits/Second" + } + }, + "TerabitsSecond": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Terabits/Second" + } + }, + "CountSecond": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Count/Second" + } + }, + "None": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "None" + } + } + } }, - { - "target": "com.amazonaws.cloudwatchlogs#PutDeliverySource" + "com.amazonaws.cloudwatchlogs#StartFromHead": { + "type": "boolean" }, - { - "target": "com.amazonaws.cloudwatchlogs#PutDestination" + "com.amazonaws.cloudwatchlogs#StartLiveTail": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#StartLiveTailRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#StartLiveTailResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#AccessDeniedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#InvalidOperationException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#LimitExceededException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Starts a Live Tail streaming session for one or more log groups. A Live Tail session returns a stream of \n log events that have\n been recently ingested in the log groups. For more information, see \n Use Live Tail to view logs in near real time.\n
\nThe response to this operation is a response stream, over which \n the server sends live log events and the client receives them.
\nThe following objects are sent over the stream:
\nA single LiveTailSessionStart \n object is sent at the start of the session.
\nEvery second, a LiveTailSessionUpdate\n object is sent. Each of these objects contains an array of the actual log events.
\nIf no new log events were ingested in the past second, the \n LiveTailSessionUpdate object will contain an empty array.
The array of log events contained in a LiveTailSessionUpdate can include\n as many as 500 log events. If the number of log events matching the request exceeds 500 per second, the\n log events are sampled down to 500 log events to be included in each LiveTailSessionUpdate object.
If your client consumes the log events slower than the server produces them, CloudWatch Logs\n buffers up to 10 LiveTailSessionUpdate events or 5000 log events, after \n which it starts dropping the oldest events.
A SessionStreamingException \n object is returned if an unknown error occurs on the server side.
\nA SessionTimeoutException \n object is returned when the session times out, after it has been kept open for three hours.
\nYou can end a session before it times out by closing the session stream or by closing the client that is receiving the \n stream. The session also ends if the established connection between the client and the server breaks.
\nFor examples of using an SDK to start a Live Tail session, see \n \n Start a Live Tail session using an Amazon Web Services SDK.
", + "smithy.api#endpoint": { + "hostPrefix": "streaming-" + } + } }, - { - "target": "com.amazonaws.cloudwatchlogs#PutDestinationPolicy" + "com.amazonaws.cloudwatchlogs#StartLiveTailLogGroupIdentifiers": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupIdentifier" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } }, - { - "target": "com.amazonaws.cloudwatchlogs#PutLogEvents" + "com.amazonaws.cloudwatchlogs#StartLiveTailRequest": { + "type": "structure", + "members": { + "logGroupIdentifiers": { + "target": "com.amazonaws.cloudwatchlogs#StartLiveTailLogGroupIdentifiers", + "traits": { + "smithy.api#documentation": "An array where each item in the array is a log group to include in the Live Tail session.
\nSpecify each log group by its ARN.
\nIf you specify an ARN, the ARN can't end with an asterisk (*).
\nYou can include up to 10 log groups.
\nIf you specify this parameter, then only log events in the log streams that you specify here are \n included in the Live Tail session.
\nIf you specify this field, you can't also specify the logStreamNamePrefixes field.
You can specify this parameter only if you specify only one log group in logGroupIdentifiers.
If you specify this parameter, then only log events in the log streams that have names that start with the \n prefixes that you specify here are \n included in the Live Tail session.
\nIf you specify this field, you can't also specify the logStreamNames field.
You can specify this parameter only if you specify only one log group in logGroupIdentifiers.
An optional pattern to use to filter the results to include only log events that match the pattern.\n For example, a filter pattern of error 404 causes only log events that include both error \n and 404 to be included in the Live Tail stream.
Regular expression filter patterns are supported.
\nFor more information about filter pattern syntax, see Filter and Pattern Syntax.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.cloudwatchlogs#PutMetricFilter" + "com.amazonaws.cloudwatchlogs#StartLiveTailResponse": { + "type": "structure", + "members": { + "responseStream": { + "target": "com.amazonaws.cloudwatchlogs#StartLiveTailResponseStream", + "traits": { + "smithy.api#documentation": "An object that includes the stream returned by your request. It can include both log events and exceptions.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.cloudwatchlogs#PutQueryDefinition" + "com.amazonaws.cloudwatchlogs#StartLiveTailResponseStream": { + "type": "union", + "members": { + "sessionStart": { + "target": "com.amazonaws.cloudwatchlogs#LiveTailSessionStart", + "traits": { + "smithy.api#documentation": "This object contains information about this Live Tail session, including the log groups included and the \n log stream filters, if any.
" + } + }, + "sessionUpdate": { + "target": "com.amazonaws.cloudwatchlogs#LiveTailSessionUpdate", + "traits": { + "smithy.api#documentation": "This object contains the log events and session metadata.
" + } + }, + "SessionTimeoutException": { + "target": "com.amazonaws.cloudwatchlogs#SessionTimeoutException", + "traits": { + "smithy.api#documentation": "This exception is returned in the stream when the Live Tail session times out. Live Tail sessions time\n out after three hours.
" + } + }, + "SessionStreamingException": { + "target": "com.amazonaws.cloudwatchlogs#SessionStreamingException", + "traits": { + "smithy.api#documentation": "This exception is returned if an unknown error occurs.
" + } + } + }, + "traits": { + "smithy.api#documentation": "This object includes the stream returned by your \n StartLiveTail\n request.
", + "smithy.api#streaming": {} + } }, - { - "target": "com.amazonaws.cloudwatchlogs#PutResourcePolicy" + "com.amazonaws.cloudwatchlogs#StartQuery": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#StartQueryRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#StartQueryResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#LimitExceededException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#MalformedQueryException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "Schedules a query of a log group using CloudWatch Logs Insights. You specify the log group\n and time range to query and the query string to use.
\nFor more information, see CloudWatch Logs Insights Query Syntax.
\nAfter you run a query using StartQuery, the query results are stored by CloudWatch Logs. \n You can use GetQueryResults to retrieve\n the results of a query, using the queryId that StartQuery returns.\n
If you have associated a KMS key with the query results in this account, \n then \n StartQuery uses that key to \n encrypt the results when it stores them. If no key is associated with query results, the query results are \n encrypted with the default CloudWatch Logs encryption method.
\nQueries time out after 60 minutes of runtime. If your queries are timing out, reduce the\n time range being searched or partition your query into a number of queries.
\nIf you are using CloudWatch cross-account observability, you can use this operation in a\n monitoring account to start a query in a linked source account. For more information, see\n CloudWatch\n cross-account observability. For a cross-account StartQuery operation,\n the query definition must be defined in the monitoring account.
You can have up to 30 concurrent CloudWatch Logs insights queries, including queries\n that have been added to dashboards.
" + } }, - { - "target": "com.amazonaws.cloudwatchlogs#PutRetentionPolicy" + "com.amazonaws.cloudwatchlogs#StartQueryRequest": { + "type": "structure", + "members": { + "logGroupName": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupName", + "traits": { + "smithy.api#documentation": "The log group on which to perform the query.
\nA StartQuery operation must include exactly one of the following\n parameters: logGroupName, logGroupNames, or\n logGroupIdentifiers.
The list of log groups to be queried. You can include up to 50 log groups.
\nA StartQuery operation must include exactly one of the following\n parameters: logGroupName, logGroupNames, or\n logGroupIdentifiers.
The list of log groups to query. You can include up to 50 log groups.
\nYou can specify them by the log group name or ARN. If a log group that you're querying is\n in a source account and you're using a monitoring account, you must specify the ARN of the log\n group here. The query definition must also be defined in the monitoring account.
\nIf you specify an ARN, the ARN can't end with an asterisk (*).
\nA StartQuery operation must include exactly one of the following parameters:\n logGroupName, logGroupNames, or logGroupIdentifiers.
The beginning of the time range to query. The range is inclusive, so the specified start\n time is included in the query. Specified as epoch time, the number of seconds since\n January 1, 1970, 00:00:00 UTC.
The end of the time range to query. The range is inclusive, so the specified end time is\n included in the query. Specified as epoch time, the number of seconds since January 1,\n 1970, 00:00:00 UTC.
The query string to use.\n For more information, see CloudWatch Logs Insights Query Syntax.
", + "smithy.api#required": {} + } + }, + "limit": { + "target": "com.amazonaws.cloudwatchlogs#EventsLimit", + "traits": { + "smithy.api#documentation": "The maximum number of log events to return in the query. If the query string uses the fields command,\n only the specified fields and their values are returned. The default is 1000.
The unique ID of the query.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.cloudwatchlogs#StartLiveTail" + "com.amazonaws.cloudwatchlogs#State": { + "type": "enum", + "members": { + "Active": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Active" + } + }, + "Suppressed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Suppressed" + } + }, + "Baseline": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Baseline" + } + } + } }, - { - "target": "com.amazonaws.cloudwatchlogs#StartQuery" + "com.amazonaws.cloudwatchlogs#StatsValue": { + "type": "double", + "traits": { + "smithy.api#default": 0 + } }, - { - "target": "com.amazonaws.cloudwatchlogs#StopQuery" + "com.amazonaws.cloudwatchlogs#StopQuery": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#StopQueryRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#StopQueryResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "Stops a CloudWatch Logs Insights query that is in progress. If the query has already ended, the operation\n returns an error indicating that the specified query is not running.
" + } }, - { - "target": "com.amazonaws.cloudwatchlogs#TagLogGroup" + "com.amazonaws.cloudwatchlogs#StopQueryRequest": { + "type": "structure", + "members": { + "queryId": { + "target": "com.amazonaws.cloudwatchlogs#QueryId", + "traits": { + "smithy.api#documentation": "The ID number of the query to stop. To find this ID number, use\n DescribeQueries.
This is true if the query was stopped by the StopQuery operation.
The name of the subscription filter.
" + } + }, + "logGroupName": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupName", + "traits": { + "smithy.api#documentation": "The name of the log group.
" + } + }, + "filterPattern": { + "target": "com.amazonaws.cloudwatchlogs#FilterPattern" + }, + "destinationArn": { + "target": "com.amazonaws.cloudwatchlogs#DestinationArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the destination.
" + } + }, + "roleArn": { + "target": "com.amazonaws.cloudwatchlogs#RoleArn", + "traits": { + "smithy.api#documentation": "" + } + }, + "distribution": { + "target": "com.amazonaws.cloudwatchlogs#Distribution" + }, + "creationTime": { + "target": "com.amazonaws.cloudwatchlogs#Timestamp", + "traits": { + "smithy.api#documentation": "The creation time of the subscription filter, expressed as the number of milliseconds\n after Jan 1, 1970 00:00:00 UTC.
Represents a subscription filter.
" + } }, - { - "target": "com.amazonaws.cloudwatchlogs#UntagResource" + "com.amazonaws.cloudwatchlogs#SubscriptionFilters": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#SubscriptionFilter" + } }, - { - "target": "com.amazonaws.cloudwatchlogs#UpdateAnomaly" + "com.amazonaws.cloudwatchlogs#Success": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } }, - { - "target": "com.amazonaws.cloudwatchlogs#UpdateLogAnomalyDetector" - } - ], - "traits": { - "aws.api#service": { - "sdkId": "CloudWatch Logs", - "arnNamespace": "logs", - "cloudFormationName": "Logs", - "cloudTrailEventSource": "logs.amazonaws.com", - "docId": "logs-2014-03-28", - "endpointPrefix": "logs" - }, - "aws.auth#sigv4": { - "name": "logs" - }, - "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "You can use Amazon CloudWatch Logs to monitor, store, and access your log files from\n EC2 instances, CloudTrail, and other sources. You can then retrieve the associated\n log data from CloudWatch Logs using the CloudWatch console. Alternatively, you can use\n CloudWatch Logs commands in the Amazon Web Services CLI, CloudWatch Logs API, or CloudWatch\n Logs SDK.
\nYou can use CloudWatch Logs to:
\n\n Monitor logs from EC2 instances in real time: You\n can use CloudWatch Logs to monitor applications and systems using log data. For example,\n CloudWatch Logs can track the number of errors that occur in your application logs. Then,\n it can send you a notification whenever the rate of errors exceeds a threshold that you\n specify. CloudWatch Logs uses your log data for monitoring so no code changes are\n required. For example, you can monitor application logs for specific literal terms (such\n as \"NullReferenceException\"). You can also count the number of occurrences of a literal\n term at a particular position in log data (such as \"404\" status codes in an Apache access\n log). When the term you are searching for is found, CloudWatch Logs reports the data to a\n CloudWatch metric that you specify.
\n\n Monitor CloudTrail logged events: You can\n create alarms in CloudWatch and receive notifications of particular API activity as\n captured by CloudTrail. You can use the notification to perform troubleshooting.
\n\n Archive log data: You can use CloudWatch Logs to\n store your log data in highly durable storage. You can change the log retention setting so\n that any log events earlier than this setting are automatically deleted. The CloudWatch\n Logs agent helps to quickly send both rotated and non-rotated log data off of a host and\n into the log service. You can then access the raw log data when you need it.
\nSpecifies the number of seconds, minutes or hours to suppress this anomaly. There is no maximum.
" } - ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", - "type": "error" }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] + "suppressionUnit": { + "target": "com.amazonaws.cloudwatchlogs#SuppressionUnit", + "traits": { + "smithy.api#documentation": "Specifies whether the value of value is in seconds, minutes, or hours.
If you are suppressing an anomaly temporariliy, this structure defines how long the suppression period\n is to be.
" + } + }, + "com.amazonaws.cloudwatchlogs#SuppressionState": { + "type": "enum", + "members": { + "SUPPRESSED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUPPRESSED" + } + }, + "UNSUPPRESSED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNSUPPRESSED" } - ] } - ], - "rules": [ - { - "conditions": [ - { - "fn": "aws.partition", - "argv": [ - { - "ref": "Region" - } - ], - "assign": "PartitionResult" + } + }, + "com.amazonaws.cloudwatchlogs#SuppressionType": { + "type": "enum", + "members": { + "LIMITED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LIMITED" } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://logs-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ - { - "ref": "Region" - }, - "us-gov-east-1" - ] - } - ], - "endpoint": { - "url": "https://logs.us-gov-east-1.amazonaws.com", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ - { - "ref": "Region" - }, - "us-gov-west-1" - ] - } - ], - "endpoint": { - "url": "https://logs.us-gov-west-1.amazonaws.com", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "endpoint": { - "url": "https://logs-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://logs.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [], - "endpoint": { - "url": "https://logs.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + }, + "INFINITE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INFINITE" } - ], - "type": "tree" } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" } - ] }, - "smithy.rules#endpointTests": { - "testCases": [ - { - "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://logs.af-south-1.amazonaws.com" - } - }, - "params": { - "Region": "af-south-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://logs.ap-east-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://logs.ap-northeast-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://logs.ap-northeast-2.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://logs.ap-northeast-3.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-3", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://logs.ap-south-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-south-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://logs.ap-southeast-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-southeast-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://logs.ap-southeast-2.amazonaws.com" - } - }, - "params": { - "Region": "ap-southeast-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://logs.ap-southeast-3.amazonaws.com" - } - }, - "params": { - "Region": "ap-southeast-3", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://logs.ca-central-1.amazonaws.com" - } - }, - "params": { - "Region": "ca-central-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://logs.eu-central-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-central-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://logs.eu-north-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-north-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://logs.eu-south-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-south-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://logs.eu-west-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://logs.eu-west-2.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://logs.eu-west-3.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-3", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://logs.me-south-1.amazonaws.com" - } - }, - "params": { - "Region": "me-south-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://logs.sa-east-1.amazonaws.com" - } - }, - "params": { - "Region": "sa-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://logs.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://logs-fips.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://logs.us-east-2.amazonaws.com" - } - }, - "params": { - "Region": "us-east-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://logs-fips.us-east-2.amazonaws.com" - } - }, - "params": { - "Region": "us-east-2", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://logs.us-west-1.amazonaws.com" - } - }, - "params": { - "Region": "us-west-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://logs-fips.us-west-1.amazonaws.com" - } - }, - "params": { - "Region": "us-west-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://logs.us-west-2.amazonaws.com" - } - }, - "params": { - "Region": "us-west-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://logs-fips.us-west-2.amazonaws.com" - } - }, - "params": { - "Region": "us-west-2", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://logs-fips.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://logs.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://logs.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://logs.cn-northwest-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-northwest-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://logs-fips.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://logs-fips.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://logs.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://logs.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://logs.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://logs.us-gov-west-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-west-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://logs.us-gov-west-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-west-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://logs-fips.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://logs.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://logs.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-iso-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://logs.us-iso-west-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-west-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://logs-fips.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://logs.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://logs-fips.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" - } + "com.amazonaws.cloudwatchlogs#SuppressionUnit": { + "type": "enum", + "members": { + "SECONDS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SECONDS" + } + }, + "MINUTES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MINUTES" + } + }, + "HOURS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HOURS" + } + } + } + }, + "com.amazonaws.cloudwatchlogs#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]+)$" + } + }, + "com.amazonaws.cloudwatchlogs#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#TagKey" }, - { - "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" - } + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.cloudwatchlogs#TagList": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#TagKey" }, - { - "documentation": "For custom endpoint with fips enabled and dualstack disabled", - "expect": { - "error": "Invalid Configuration: FIPS and custom endpoint are not supported" - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": false, - "Endpoint": "https://example.com" - } + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.cloudwatchlogs#TagLogGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#TagLogGroupRequest" }, - { - "documentation": "For custom endpoint with fips disabled and dualstack enabled", - "expect": { - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true, - "Endpoint": "https://example.com" - } + "output": { + "target": "smithy.api#Unit" }, - { - "documentation": "Missing region", - "expect": { - "error": "Invalid Configuration: Missing Region" - } - } - ], - "version": "1.0" - } - } - }, - "com.amazonaws.cloudwatchlogs#MalformedQueryException": { - "type": "structure", - "members": { - "queryCompileError": { - "target": "com.amazonaws.cloudwatchlogs#QueryCompileError" - }, - "message": { - "target": "com.amazonaws.cloudwatchlogs#Message" - } - }, - "traits": { - "smithy.api#documentation": "The query string is not valid. Details about this error are displayed in a \n QueryCompileError object. For more information, see \n QueryCompileError.
For more information about valid query syntax, see\n CloudWatch Logs Insights Query Syntax.
", - "smithy.api#error": "client" - } - }, - "com.amazonaws.cloudwatchlogs#Message": { - "type": "string" - }, - "com.amazonaws.cloudwatchlogs#MetricFilter": { - "type": "structure", - "members": { - "filterName": { - "target": "com.amazonaws.cloudwatchlogs#FilterName", - "traits": { - "smithy.api#documentation": "The name of the metric filter.
" - } - }, - "filterPattern": { - "target": "com.amazonaws.cloudwatchlogs#FilterPattern" - }, - "metricTransformations": { - "target": "com.amazonaws.cloudwatchlogs#MetricTransformations", - "traits": { - "smithy.api#documentation": "The metric transformations.
" - } - }, - "creationTime": { - "target": "com.amazonaws.cloudwatchlogs#Timestamp", - "traits": { - "smithy.api#documentation": "The creation time of the metric filter, expressed as the number of milliseconds after\n Jan 1, 1970 00:00:00 UTC.
The name of the log group.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Metric filters express how CloudWatch Logs would extract metric observations \n from ingested log events and transform them into metric data in a CloudWatch metric.
" - } - }, - "com.amazonaws.cloudwatchlogs#MetricFilterMatchRecord": { - "type": "structure", - "members": { - "eventNumber": { - "target": "com.amazonaws.cloudwatchlogs#EventNumber", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The event number.
" - } - }, - "eventMessage": { - "target": "com.amazonaws.cloudwatchlogs#EventMessage", - "traits": { - "smithy.api#documentation": "The raw event data.
" - } - }, - "extractedValues": { - "target": "com.amazonaws.cloudwatchlogs#ExtractedValues", - "traits": { - "smithy.api#documentation": "The values extracted from the event data by the filter.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Represents a matched event.
" - } - }, - "com.amazonaws.cloudwatchlogs#MetricFilterMatches": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudwatchlogs#MetricFilterMatchRecord" - } - }, - "com.amazonaws.cloudwatchlogs#MetricFilters": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudwatchlogs#MetricFilter" - } - }, - "com.amazonaws.cloudwatchlogs#MetricName": { - "type": "string", - "traits": { - "smithy.api#documentation": "The name of the CloudWatch metric to which the monitored log information should be\n published. For example, you might publish to a metric named ErrorCount.
", - "smithy.api#length": { - "min": 0, - "max": 255 - }, - "smithy.api#pattern": "^[^:*$]*$" - } - }, - "com.amazonaws.cloudwatchlogs#MetricNamespace": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 255 - }, - "smithy.api#pattern": "^[^:*$]*$" - } - }, - "com.amazonaws.cloudwatchlogs#MetricTransformation": { - "type": "structure", - "members": { - "metricName": { - "target": "com.amazonaws.cloudwatchlogs#MetricName", - "traits": { - "smithy.api#documentation": "The name of the CloudWatch metric.
", - "smithy.api#required": {} - } - }, - "metricNamespace": { - "target": "com.amazonaws.cloudwatchlogs#MetricNamespace", - "traits": { - "smithy.api#documentation": "A custom namespace to contain your metric in CloudWatch. Use namespaces to group together metrics\n that are similar. For more information, see Namespaces.
", - "smithy.api#required": {} - } - }, - "metricValue": { - "target": "com.amazonaws.cloudwatchlogs#MetricValue", - "traits": { - "smithy.api#documentation": "The value to publish to the CloudWatch metric when a filter pattern matches a log event.
", - "smithy.api#required": {} - } - }, - "defaultValue": { - "target": "com.amazonaws.cloudwatchlogs#DefaultValue", - "traits": { - "smithy.api#documentation": "(Optional) The value to emit when a filter pattern does not match a log event. \n This value can be null.
" - } - }, - "dimensions": { - "target": "com.amazonaws.cloudwatchlogs#Dimensions", - "traits": { - "smithy.api#documentation": "The fields to use as dimensions for the metric. One metric filter can include\n as many as three dimensions.
\nMetrics extracted from log events are charged as custom metrics.\n To prevent unexpected high charges, do not specify high-cardinality fields such as \n IPAddress or requestID as dimensions. Each different value \n found for \n a dimension is treated as a separate metric and accrues charges as a separate custom metric.\n
CloudWatch Logs disables a metric filter if it generates 1000 different name/value pairs for your\n specified dimensions within a certain amount of time. This helps to prevent accidental high\n charges.
\nYou can also set up a billing alarm to alert you if your charges are higher than \n expected. For more information, \n see \n Creating a Billing Alarm to Monitor Your Estimated Amazon Web Services Charges.\n
\nThe unit to assign to the metric. If you omit this, the unit is set as None.
Indicates how to transform ingested log events to metric data in a CloudWatch\n metric.
" - } - }, - "com.amazonaws.cloudwatchlogs#MetricTransformations": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudwatchlogs#MetricTransformation" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1 - } - } - }, - "com.amazonaws.cloudwatchlogs#MetricValue": { - "type": "string", - "traits": { - "smithy.api#documentation": "The value to publish to the CloudWatch metric. For example, if you're counting the\n occurrences of a term like Error, the value is 1 for each\n occurrence. If you're counting the bytes transferred, the value is the value in the log\n event.
The token for the next set of items to return. The token expires after 24 hours.
", - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.cloudwatchlogs#OperationAbortedException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.cloudwatchlogs#Message" - } - }, - "traits": { - "smithy.api#documentation": "Multiple concurrent requests to update the same resource were in conflict.
", - "smithy.api#error": "client" - } - }, - "com.amazonaws.cloudwatchlogs#OrderBy": { - "type": "enum", - "members": { - "LogStreamName": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LogStreamName" - } - }, - "LastEventTime": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LastEventTime" - } - } - } - }, - "com.amazonaws.cloudwatchlogs#OutputFormat": { - "type": "enum", - "members": { - "JSON": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "json" - } - }, - "PLAIN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "plain" - } - }, - "W3C": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "w3c" - } - }, - "RAW": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "raw" - } - }, - "PARQUET": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "parquet" - } - } - } - }, - "com.amazonaws.cloudwatchlogs#OutputLogEvent": { - "type": "structure", - "members": { - "timestamp": { - "target": "com.amazonaws.cloudwatchlogs#Timestamp", - "traits": { - "smithy.api#documentation": "The time the event occurred, expressed as the number of milliseconds after Jan 1,\n 1970 00:00:00 UTC.
The data contained in the log event.
" - } - }, - "ingestionTime": { - "target": "com.amazonaws.cloudwatchlogs#Timestamp", - "traits": { - "smithy.api#documentation": "The time the event was ingested, expressed as the number of milliseconds after\n Jan 1, 1970 00:00:00 UTC.
Represents a log event.
" - } - }, - "com.amazonaws.cloudwatchlogs#OutputLogEvents": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudwatchlogs#OutputLogEvent" - } - }, - "com.amazonaws.cloudwatchlogs#PatternId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 32, - "max": 32 - } - } - }, - "com.amazonaws.cloudwatchlogs#PatternRegex": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.cloudwatchlogs#PatternString": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.cloudwatchlogs#PatternToken": { - "type": "structure", - "members": { - "dynamicTokenPosition": { - "target": "com.amazonaws.cloudwatchlogs#DynamicTokenPosition", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "For a dynamic token, this indicates where in the pattern that this token appears, related\n to other dynamic tokens. The dynamic token that appears first has a value of 1, the \n one that appears second is 2, and so on.
Specifies whether this is a dynamic token.
" - } - }, - "tokenString": { - "target": "com.amazonaws.cloudwatchlogs#TokenString", - "traits": { - "smithy.api#documentation": "The string represented by this token. If this is a dynamic token, the\n value will be <*>\n
Contains the values found for a dynamic token, and the number of times each value was found.
" - } - } - }, - "traits": { - "smithy.api#documentation": "A structure that contains information about one pattern token related to \n an anomaly.
\nFor more information about patterns and tokens, see CreateLogAnomalyDetector.\n
" - } - }, - "com.amazonaws.cloudwatchlogs#PatternTokens": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudwatchlogs#PatternToken" - } - }, - "com.amazonaws.cloudwatchlogs#Percentage": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.cloudwatchlogs#Policy": { - "type": "structure", - "members": { - "deliveryDestinationPolicy": { - "target": "com.amazonaws.cloudwatchlogs#DeliveryDestinationPolicy", - "traits": { - "smithy.api#documentation": "The contents of the delivery destination policy.
" - } - } - }, - "traits": { - "smithy.api#documentation": "A structure that contains information about one delivery destination policy.
" - } - }, - "com.amazonaws.cloudwatchlogs#PolicyDocument": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 5120 - } - } - }, - "com.amazonaws.cloudwatchlogs#PolicyName": { - "type": "string" - }, - "com.amazonaws.cloudwatchlogs#PolicyType": { - "type": "enum", - "members": { - "DATA_PROTECTION_POLICY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DATA_PROTECTION_POLICY" - } - }, - "SUBSCRIPTION_FILTER_POLICY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SUBSCRIPTION_FILTER_POLICY" - } - } - } - }, - "com.amazonaws.cloudwatchlogs#Priority": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.cloudwatchlogs#PutAccountPolicy": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#PutAccountPolicyRequest" - }, - "output": { - "target": "com.amazonaws.cloudwatchlogs#PutAccountPolicyResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#LimitExceededException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "Creates an account-level data protection policy or subscription filter policy that applies to all log groups \n or a subset of log groups in the account.
\n\n Data protection policy\n
\nA data protection policy can help safeguard sensitive \n data that's ingested by your log groups by auditing and masking the sensitive log data. Each account can have only\n one account-level data protection policy.
\nSensitive data is detected and masked when it is ingested into a log group. When you set a \n data protection policy, log events ingested into the log groups before that time are not masked.
\nIf you use PutAccountPolicy to create a data protection policy for your whole account, it applies to both existing log groups\n and all log groups that are created later in this account. The account-level policy is applied to existing log groups\n with eventual consistency. It might take up to 5 minutes before sensitive data in existing log groups begins to be masked.
By default, when a user views a log event that includes masked data, the sensitive data is replaced by asterisks.\n A user who has the logs:Unmask permission can use a \n GetLogEvents or \n FilterLogEvents\n operation with the unmask parameter set to true to view the unmasked \n log events. Users with the logs:Unmask can also view unmasked data in the CloudWatch Logs\n console by running a CloudWatch Logs Insights query with the unmask query command.
For more information, including a list of types of data that can be audited and masked, see\n Protect sensitive log data with masking.
\nTo use the PutAccountPolicy operation for a data protection policy, you must be signed on with \n the logs:PutDataProtectionPolicy\n and logs:PutAccountPolicy permissions.
The PutAccountPolicy operation applies to all log groups in the account. You can use \n PutDataProtectionPolicy\n to create a data protection policy that applies to just one log group. \n If a log group has its own data protection policy and \n the account also has an account-level data protection policy, then the two policies are cumulative. Any sensitive term\n specified in either policy is masked.
\n Subscription filter policy\n
\nA subscription filter policy sets up a real-time feed of log events from CloudWatch Logs to other Amazon Web Services services.\n Account-level subscription filter policies apply to both existing log groups and log groups that are created later in \n this account. Supported destinations are Kinesis Data Streams, Firehose, and \n Lambda. When log events are sent to the receiving service, they are Base64 encoded and \n compressed with the GZIP format.
\nThe following destinations are supported for subscription filters:
\nAn Kinesis Data Streams data stream in the same account as the subscription policy, for same-account delivery.
\nAn Firehose data stream in the same account as the subscription policy, for same-account delivery.
\nA Lambda function in the same account as the subscription policy, for same-account delivery.
\nA logical destination in a different account created with PutDestination, for cross-account\n delivery. Kinesis Data Streams and Firehose are supported as logical destinations.
\nEach account can have one account-level subscription filter policy per Region. \n If you are updating an existing filter, you must specify the correct name in PolicyName.\n To perform a PutAccountPolicy subscription filter operation for any destination except a Lambda \n function, you must also have the iam:PassRole permission.
A name for the policy. This must be unique within the account.
", - "smithy.api#required": {} - } - }, - "policyDocument": { - "target": "com.amazonaws.cloudwatchlogs#AccountPolicyDocument", - "traits": { - "smithy.api#documentation": "Specify the policy, in JSON.
\n\n Data protection policy\n
\nA data protection policy must include two JSON blocks:
\nThe first block must include both a DataIdentifer array and an \n Operation property with an Audit action. The DataIdentifer array lists the types of sensitive data that\n you want to mask. For more information about the available options, see \n Types of data that you can mask.
The Operation property with an Audit action is required to find the \n sensitive data terms. This Audit action must contain a FindingsDestination\n object. You can optionally use that FindingsDestination object to list one or more \n destinations to send audit findings to. If you specify destinations such as log groups, \n Firehose streams, and S3 buckets, they must already exist.
The second block must include both a DataIdentifer array and an\n Operation property with an Deidentify action. The\n DataIdentifer array must exactly match the DataIdentifer array\n in the first block of the policy.
The Operation property with the Deidentify action is what actually masks the \n data, and it must \n contain the \n \"MaskConfig\": {} object. The \n \"MaskConfig\": {} object must be empty.
For an example data protection policy, see the Examples section on this page.
\nThe contents of the two DataIdentifer arrays must match exactly.
In addition to the two JSON blocks, the policyDocument can also include Name,\n Description, and Version fields. The Name is different than the \n operation's policyName parameter, and is used as a dimension when\n CloudWatch Logs reports audit findings metrics to CloudWatch.
The JSON specified in policyDocument can be up to 30,720 characters long.
\n Subscription filter policy\n
\nA subscription filter policy can include the following attributes in a JSON block:
\n\n DestinationArn The ARN of the destination\n to deliver log events to. Supported destinations are:
\nAn Kinesis Data Streams data stream in the same account as the subscription policy, for same-account delivery.
\nAn Firehose data stream in the same account as the subscription policy, for same-account delivery.
\nA Lambda function in the same account as the subscription policy, for same-account delivery.
\nA logical destination in a different account created with PutDestination, for cross-account\n delivery. Kinesis Data Streams and Firehose are supported as logical destinations.
\n\n RoleArn The ARN of an IAM role that grants CloudWatch Logs permissions to deliver ingested log\n events to the destination stream. You don't need to provide the ARN when you are working with\n a logical destination for cross-account delivery.
\n\n FilterPattern A filter pattern for subscribing to a \n filtered stream of log events.
\n\n Distribution The method used to distribute log data to the destination. \n By default, log data is\n grouped by log stream, but the grouping can be set to Random for a more even distribution.\n This property is only applicable when the destination is an Kinesis Data Streams data stream.
The type of policy that you're creating or updating.
", - "smithy.api#required": {} - } - }, - "scope": { - "target": "com.amazonaws.cloudwatchlogs#Scope", - "traits": { - "smithy.api#documentation": "Currently the only valid value for this parameter is ALL, which specifies that the data \n protection policy applies to all log groups in the account. If you omit this parameter, the default\n of ALL is used.
Use this parameter to apply the subscription filter policy to a subset of log groups in the account.\n Currently, the only supported filter is LogGroupName NOT IN []. The selectionCriteria\n string can be up to 25KB in length. The length is determined by using its UTF-8 bytes.
Using the selectionCriteria parameter is useful to help prevent infinite loops. \n For more information, see Log recursion prevention.
Specifing selectionCriteria is valid only when you specify SUBSCRIPTION_FILTER_POLICY\n for policyType.
The account policy that you created.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudwatchlogs#PutDataProtectionPolicy": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#PutDataProtectionPolicyRequest" - }, - "output": { - "target": "com.amazonaws.cloudwatchlogs#PutDataProtectionPolicyResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#LimitExceededException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "Creates a data protection policy for the specified log group. A data protection policy can help safeguard sensitive \n data that's ingested by the log group by auditing and masking the sensitive log data.
\nSensitive data is detected and masked when it is ingested into the log group. When you set a \n data protection policy, log events ingested into the log group before that time are not masked.
\nBy default, when a user views a log event that includes masked data, the sensitive data is replaced by asterisks.\n A user who has the logs:Unmask permission can use a \n GetLogEvents or \n FilterLogEvents\n operation with the unmask parameter set to true to view the unmasked \n log events. Users with the logs:Unmask can also view unmasked data in the CloudWatch Logs\n console by running a CloudWatch Logs Insights query with the unmask query command.
For more information, including a list of types of data that can be audited and masked, see\n Protect sensitive log data with masking.
\nThe PutDataProtectionPolicy operation applies to only the specified log group. You can also use \n PutAccountPolicy\n to create an account-level data protection policy that applies to all log groups in the account, \n including both existing log groups and log groups that are created level. If a log group has its own data protection policy and \n the account also has an account-level data protection policy, then the two policies are cumulative. Any sensitive term\n specified in either policy is masked.
Specify either the log group name or log group ARN.
", - "smithy.api#required": {} - } - }, - "policyDocument": { - "target": "com.amazonaws.cloudwatchlogs#DataProtectionPolicyDocument", - "traits": { - "smithy.api#documentation": "Specify the data protection policy, in JSON.
\nThis policy must include two JSON blocks:
\nThe first block must include both a DataIdentifer array and an \n Operation property with an Audit action. The DataIdentifer array lists the types of sensitive data that\n you want to mask. For more information about the available options, see \n Types of data that you can mask.
The Operation property with an Audit action is required to find the \n sensitive data terms. This Audit action must contain a FindingsDestination\n object. You can optionally use that FindingsDestination object to list one or more \n destinations to send audit findings to. If you specify destinations such as log groups, \n Firehose streams, and S3 buckets, they must already exist.
The second block must include both a DataIdentifer array and an\n Operation property with an Deidentify action. The\n DataIdentifer array must exactly match the DataIdentifer array\n in the first block of the policy.
The Operation property with the Deidentify action is what actually masks the \n data, and it must \n contain the \n \"MaskConfig\": {} object. The \n \"MaskConfig\": {} object must be empty.
For an example data protection policy, see the Examples section on this page.
\nThe contents of the two DataIdentifer arrays must match exactly.
In addition to the two JSON blocks, the policyDocument can also include Name,\n Description, and Version fields. The Name is used as a dimension when\n CloudWatch Logs reports audit findings metrics to CloudWatch.
The JSON specified in policyDocument can be up to 30,720 characters.
The log group name or ARN that you specified in your request.
" - } - }, - "policyDocument": { - "target": "com.amazonaws.cloudwatchlogs#DataProtectionPolicyDocument", - "traits": { - "smithy.api#documentation": "The data protection policy used for this log group.
" - } - }, - "lastUpdatedTime": { - "target": "com.amazonaws.cloudwatchlogs#Timestamp", - "traits": { - "smithy.api#documentation": "The date and time that this policy was most recently updated.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudwatchlogs#PutDeliveryDestination": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#PutDeliveryDestinationRequest" - }, - "output": { - "target": "com.amazonaws.cloudwatchlogs#PutDeliveryDestinationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#ConflictException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ThrottlingException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Creates or updates a logical delivery destination. A delivery destination is an Amazon Web Services resource that represents an \n Amazon Web Services service that logs can be sent to. CloudWatch Logs, Amazon S3, and\n Firehose are supported as logs delivery destinations.
\nTo configure logs delivery between a supported Amazon Web Services service and a destination, you must do the following:
\nCreate a delivery source, which is a logical object that represents the resource that is actually\n sending the logs. For more \n information, see PutDeliverySource.
\nUse PutDeliveryDestination to create a delivery destination, which is a logical object that represents the actual\n delivery destination.
If you are delivering logs cross-account, you must use \n PutDeliveryDestinationPolicy\n in the destination account to assign an IAM policy to the \n destination. This policy allows delivery to that destination.\n
\nUse CreateDelivery to create a delivery by pairing exactly \n one delivery source and one delivery destination. For more \n information, see CreateDelivery.\n
You can configure a single delivery source to send logs to multiple destinations by creating multiple deliveries. You \n can also create multiple deliveries to configure multiple delivery sources to send logs to the same delivery destination.
\nOnly some Amazon Web Services services support being configured as a delivery source. These services are listed\n as Supported [V2 Permissions] in the table at \n Enabling \n logging from Amazon Web Services services.\n
\nIf you use this operation to update an existing delivery destination, all the current delivery destination parameters are overwritten\n with the new parameter values that you specify.
" - } - }, - "com.amazonaws.cloudwatchlogs#PutDeliveryDestinationPolicy": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#PutDeliveryDestinationPolicyRequest" - }, - "output": { - "target": "com.amazonaws.cloudwatchlogs#PutDeliveryDestinationPolicyResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#ConflictException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Creates and assigns an IAM policy that grants permissions to CloudWatch Logs to deliver \n logs cross-account to a specified destination in this account. To configure the delivery of logs from an \n Amazon Web Services service in another account to a logs delivery destination in the current account, you must do the following:
\nCreate a delivery source, which is a logical object that represents the resource that is actually\n sending the logs. For more \n information, see PutDeliverySource.
\nCreate a delivery destination, which is a logical object that represents the actual\n delivery destination. For more \n information, see PutDeliveryDestination.
\nUse this operation in the destination account to assign an IAM policy to the \n destination. This policy allows delivery to that destination.\n
\nCreate a delivery by pairing exactly one delivery source and one delivery destination.\n For more information, see CreateDelivery.
\nOnly some Amazon Web Services services support being configured as a delivery source. These services are listed\n as Supported [V2 Permissions] in the table at \n Enabling \n logging from Amazon Web Services services.\n
\nThe contents of the policy must include two statements. One statement enables general logs delivery, and the other\n allows delivery to the chosen destination. See the examples for the needed policies.
" - } - }, - "com.amazonaws.cloudwatchlogs#PutDeliveryDestinationPolicyRequest": { - "type": "structure", - "members": { - "deliveryDestinationName": { - "target": "com.amazonaws.cloudwatchlogs#DeliveryDestinationName", - "traits": { - "smithy.api#documentation": "The name of the delivery destination to assign this policy to.
", - "smithy.api#required": {} - } - }, - "deliveryDestinationPolicy": { - "target": "com.amazonaws.cloudwatchlogs#DeliveryDestinationPolicy", - "traits": { - "smithy.api#documentation": "The contents of the policy.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#PutDeliveryDestinationPolicyResponse": { - "type": "structure", - "members": { - "policy": { - "target": "com.amazonaws.cloudwatchlogs#Policy", - "traits": { - "smithy.api#documentation": "The contents of the policy that you just created.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudwatchlogs#PutDeliveryDestinationRequest": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.cloudwatchlogs#DeliveryDestinationName", - "traits": { - "smithy.api#documentation": "A name for this delivery destination. This name must be unique for all delivery destinations in your account.
", - "smithy.api#required": {} - } - }, - "outputFormat": { - "target": "com.amazonaws.cloudwatchlogs#OutputFormat", - "traits": { - "smithy.api#documentation": "The format for the logs that this delivery destination will receive.
" - } - }, - "deliveryDestinationConfiguration": { - "target": "com.amazonaws.cloudwatchlogs#DeliveryDestinationConfiguration", - "traits": { - "smithy.api#documentation": "A structure that contains the ARN of the Amazon Web Services resource that will receive the logs.
", - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.cloudwatchlogs#Tags", - "traits": { - "smithy.api#documentation": "An optional list of key-value pairs to associate with the resource.
\nFor more information about tagging, see \n Tagging Amazon Web Services resources\n
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#PutDeliveryDestinationResponse": { - "type": "structure", - "members": { - "deliveryDestination": { - "target": "com.amazonaws.cloudwatchlogs#DeliveryDestination", - "traits": { - "smithy.api#documentation": "A structure containing information about the delivery destination that you just created or updated.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudwatchlogs#PutDeliverySource": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#PutDeliverySourceRequest" - }, - "output": { - "target": "com.amazonaws.cloudwatchlogs#PutDeliverySourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#ConflictException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ThrottlingException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Creates or updates a logical delivery source. A delivery source represents an Amazon Web Services resource that sends logs to an\n logs delivery destination. The destination can be CloudWatch Logs, Amazon S3, or Firehose.
\nTo configure logs delivery between a delivery destination and an Amazon Web Services service that is supported as a delivery source, you must do the following:
\nUse PutDeliverySource to create a delivery source, which is a logical object that represents the resource that is actually\n sending the logs.
Use PutDeliveryDestination to create a delivery destination, which is a logical object that represents the actual\n delivery destination. For more \n information, see PutDeliveryDestination.
If you are delivering logs cross-account, you must use \n PutDeliveryDestinationPolicy\n in the destination account to assign an IAM policy to the \n destination. This policy allows delivery to that destination.\n
\nUse CreateDelivery to create a delivery by pairing exactly \n one delivery source and one delivery destination. For more \n information, see CreateDelivery.\n
You can configure a single delivery source to send logs to multiple destinations by creating multiple deliveries. You \n can also create multiple deliveries to configure multiple delivery sources to send logs to the same delivery destination.
\nOnly some Amazon Web Services services support being configured as a delivery source. These services are listed\n as Supported [V2 Permissions] in the table at \n Enabling \n logging from Amazon Web Services services.\n
\nIf you use this operation to update an existing delivery source, all the current delivery source parameters are overwritten\n with the new parameter values that you specify.
" - } - }, - "com.amazonaws.cloudwatchlogs#PutDeliverySourceRequest": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.cloudwatchlogs#DeliverySourceName", - "traits": { - "smithy.api#documentation": "A name for this delivery source. This name must be unique for all delivery sources in your account.
", - "smithy.api#required": {} - } - }, - "resourceArn": { - "target": "com.amazonaws.cloudwatchlogs#Arn", - "traits": { - "smithy.api#documentation": "The ARN of the Amazon Web Services resource that is generating and sending logs. \n For example, arn:aws:workmail:us-east-1:123456789012:organization/m-1234EXAMPLEabcd1234abcd1234abcd1234\n
Defines the type of log that the source is sending.
\nFor Amazon Bedrock, the valid value is \n APPLICATION_LOGS.
For Amazon CodeWhisperer, the valid value is \n EVENT_LOGS.
For IAM Identity Center, the valid value is \n ERROR_LOGS.
For Amazon WorkMail, the valid values are \n ACCESS_CONTROL_LOGS, AUTHENTICATION_LOGS, WORKMAIL_AVAILABILITY_PROVIDER_LOGS, and WORKMAIL_MAILBOX_ACCESS_LOGS.
An optional list of key-value pairs to associate with the resource.
\nFor more information about tagging, see \n Tagging Amazon Web Services resources\n
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#PutDeliverySourceResponse": { - "type": "structure", - "members": { - "deliverySource": { - "target": "com.amazonaws.cloudwatchlogs#DeliverySource", - "traits": { - "smithy.api#documentation": "A structure containing information about the delivery source that was just created or updated.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudwatchlogs#PutDestination": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#PutDestinationRequest" - }, - "output": { - "target": "com.amazonaws.cloudwatchlogs#PutDestinationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "Creates or updates a destination. This operation is used only to create destinations for cross-account subscriptions.
\nA destination encapsulates a physical resource (such as an Amazon Kinesis stream). With\n a destination, you can subscribe to a real-time stream of log events for a different account,\n ingested using PutLogEvents.
\nThrough an access policy, a destination controls what is written to it.\n By default, PutDestination does not set any access policy with the destination,\n which means a cross-account user cannot call PutSubscriptionFilter against\n this destination. To enable this, the destination owner must call PutDestinationPolicy after PutDestination.
To perform a PutDestination operation, you must also have the \n iam:PassRole permission.
Creates or updates an access policy associated with an existing\n destination. An access policy is an IAM policy document that is used\n to authorize claims to register a subscription filter against a given destination.
" - } - }, - "com.amazonaws.cloudwatchlogs#PutDestinationPolicyRequest": { - "type": "structure", - "members": { - "destinationName": { - "target": "com.amazonaws.cloudwatchlogs#DestinationName", - "traits": { - "smithy.api#documentation": "A name for an existing destination.
", - "smithy.api#required": {} - } - }, - "accessPolicy": { - "target": "com.amazonaws.cloudwatchlogs#AccessPolicy", - "traits": { - "smithy.api#documentation": "An IAM policy document that authorizes cross-account users to deliver their log events\n to the associated destination. This can be up to 5120 bytes.
", - "smithy.api#required": {} - } - }, - "forceUpdate": { - "target": "com.amazonaws.cloudwatchlogs#ForceUpdate", - "traits": { - "smithy.api#documentation": "Specify true if you are updating an existing destination policy to grant permission to\n an organization ID instead of granting permission to individual Amazon Web Services accounts. Before\n you update a destination policy this way, you must first update the subscription\n filters in the accounts that send logs to this destination. If you do not, the subscription\n filters might stop working. By specifying true\n for forceUpdate, you are affirming that you have already updated the subscription \n filters.\n For more information, see \n Updating an existing cross-account subscription\n
If you omit this parameter, the default of false is used.
A name for the destination.
", - "smithy.api#required": {} - } - }, - "targetArn": { - "target": "com.amazonaws.cloudwatchlogs#TargetArn", - "traits": { - "smithy.api#documentation": "The ARN of an Amazon Kinesis stream to which to deliver matching log events.
", - "smithy.api#required": {} - } - }, - "roleArn": { - "target": "com.amazonaws.cloudwatchlogs#RoleArn", - "traits": { - "smithy.api#documentation": "The ARN of an IAM role that grants CloudWatch Logs permissions to call the Amazon\n Kinesis PutRecord operation on the destination stream.
An optional list of key-value pairs to associate with the resource.
\nFor more information about tagging, see \n Tagging Amazon Web Services resources\n
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#PutDestinationResponse": { - "type": "structure", - "members": { - "destination": { - "target": "com.amazonaws.cloudwatchlogs#Destination", - "traits": { - "smithy.api#documentation": "The destination.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudwatchlogs#PutLogEvents": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#PutLogEventsRequest" - }, - "output": { - "target": "com.amazonaws.cloudwatchlogs#PutLogEventsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#DataAlreadyAcceptedException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#InvalidSequenceTokenException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#UnrecognizedClientException" - } - ], - "traits": { - "smithy.api#documentation": "Uploads a batch of log events to the specified log stream.
\nThe sequence token is now ignored in PutLogEvents\n actions. PutLogEvents\n actions are always accepted and never return InvalidSequenceTokenException or\n DataAlreadyAcceptedException even if the sequence token is not valid. You can use\n parallel PutLogEvents actions on the same log stream.
The batch of events must satisfy the following constraints:
\nThe maximum batch size is 1,048,576 bytes. This size is calculated as the sum of\n all event messages in UTF-8, plus 26 bytes for each log event.
\nNone of the log events in the batch can be more than 2 hours in the future.
\nNone of the log events in the batch can be more than 14 days in the past. Also,\n none of the log events can be from earlier than the retention period of the log\n group.
\nThe log events in the batch must be in chronological order by their timestamp. The\n timestamp is the time that the event occurred, expressed as the number of milliseconds\n after Jan 1, 1970 00:00:00 UTC. (In Amazon Web Services Tools for PowerShell\n and the Amazon Web Services SDK for .NET, the timestamp is specified in .NET format:\n yyyy-mm-ddThh:mm:ss. For example, 2017-09-15T13:45:30.)
A batch of log events in a single request cannot span more than 24 hours. Otherwise, the operation fails.
\nEach log event can be no larger than 256 KB.
\nThe maximum number of log events in a batch is 10,000.
\nThe quota of five requests per second per log stream\n has been removed. Instead, PutLogEvents actions are throttled based on a \n per-second per-account quota. You can request an increase to the per-second throttling\n quota by using the Service Quotas service.
If a call to PutLogEvents returns \"UnrecognizedClientException\" the most\n likely cause is a non-valid Amazon Web Services access key ID or secret key.
The name of the log group.
", - "smithy.api#required": {} - } - }, - "logStreamName": { - "target": "com.amazonaws.cloudwatchlogs#LogStreamName", - "traits": { - "smithy.api#documentation": "The name of the log stream.
", - "smithy.api#required": {} - } - }, - "logEvents": { - "target": "com.amazonaws.cloudwatchlogs#InputLogEvents", - "traits": { - "smithy.api#documentation": "The log events.
", - "smithy.api#required": {} - } - }, - "sequenceToken": { - "target": "com.amazonaws.cloudwatchlogs#SequenceToken", - "traits": { - "smithy.api#documentation": "The sequence token obtained from the response of the previous PutLogEvents\n call.
The sequenceToken parameter is now ignored in PutLogEvents\n actions. PutLogEvents\n actions are now accepted and never return InvalidSequenceTokenException or\n DataAlreadyAcceptedException even if the sequence token is not valid.
Reserved for future use.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#PutLogEventsResponse": { - "type": "structure", - "members": { - "nextSequenceToken": { - "target": "com.amazonaws.cloudwatchlogs#SequenceToken", - "traits": { - "smithy.api#documentation": "The next sequence token.
\nThis field has been deprecated.
\nThe sequence token is now ignored in PutLogEvents\n actions. PutLogEvents\n actions are always accepted even if the sequence token is not valid. You can use\n parallel PutLogEvents actions on the same log stream and you do not need\n to wait for the response of a previous PutLogEvents action to obtain \n the nextSequenceToken value.
The rejected events.
" - } - }, - "rejectedEntityInfo": { - "target": "com.amazonaws.cloudwatchlogs#RejectedEntityInfo", - "traits": { - "smithy.api#documentation": "Reserved for future use.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudwatchlogs#PutMetricFilter": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#PutMetricFilterRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#LimitExceededException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "Creates or updates a metric filter and associates it with the specified log group. With\n metric filters, you can configure rules to extract metric data from log events ingested\n through PutLogEvents.
\nThe maximum number of metric filters that can be associated with a log group is\n 100.
\nUsing regular expressions to create metric filters is supported. For these filters, \n there is a quotas of quota of two regular expression patterns within a single filter pattern. There\n is also a quota of five regular expression patterns per log group.\n For more information about using regular expressions in metric filters, \n see \n Filter pattern syntax for metric filters, subscription filters, filter log events, and Live Tail.
\nWhen you create a metric filter, you can also optionally assign a unit and dimensions\n to the metric that is created.
\nMetrics extracted from log events are charged as custom metrics.\n To prevent unexpected high charges, do not specify high-cardinality fields such as \n IPAddress or requestID as dimensions. Each different value \n found for \n a dimension is treated as a separate metric and accrues charges as a separate custom metric.\n
CloudWatch Logs might disable a metric filter if it generates 1,000 different name/value pairs for\n your specified dimensions within one hour.
\nYou can also set up a billing alarm to alert you if your charges are higher than \n expected. For more information, \n see \n Creating a Billing Alarm to Monitor Your Estimated Amazon Web Services Charges.\n
\nThe name of the log group.
", - "smithy.api#required": {} - } - }, - "filterName": { - "target": "com.amazonaws.cloudwatchlogs#FilterName", - "traits": { - "smithy.api#documentation": "A name for the metric filter.
", - "smithy.api#required": {} - } - }, - "filterPattern": { - "target": "com.amazonaws.cloudwatchlogs#FilterPattern", - "traits": { - "smithy.api#documentation": "A filter pattern for extracting metric data out of ingested log events.
", - "smithy.api#required": {} - } - }, - "metricTransformations": { - "target": "com.amazonaws.cloudwatchlogs#MetricTransformations", - "traits": { - "smithy.api#documentation": "A collection of information that defines how metric data gets emitted.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#PutQueryDefinition": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#PutQueryDefinitionRequest" - }, - "output": { - "target": "com.amazonaws.cloudwatchlogs#PutQueryDefinitionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#LimitExceededException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "Creates or updates a query definition for CloudWatch Logs Insights. For \n more information, see Analyzing Log Data with CloudWatch Logs Insights.
\nTo update a query definition, specify its queryDefinitionId in your request.\n The values of name, queryString, and logGroupNames are\n changed to the values that you specify in your update operation. No current values are\n retained from the current query definition. For example, imagine updating a current query\n definition that includes log groups. If you don't specify the logGroupNames\n parameter in your update operation, the query definition changes to contain no log\n groups.
You must have the logs:PutQueryDefinition permission to be able to perform\n this operation.
A name for the query definition. If you are saving numerous query definitions, we\n recommend that you name them. This way, you can find the ones you want by using the first part\n of the name as a filter in the queryDefinitionNamePrefix parameter of DescribeQueryDefinitions.
If you are updating a query definition, use this parameter to specify the ID of the query\n definition that you want to update. You can use DescribeQueryDefinitions to retrieve the IDs of your saved query\n definitions.
\nIf you are creating a query definition, do not specify this parameter. CloudWatch\n generates a unique ID for the new query definition and include it in the response to this\n operation.
" - } - }, - "logGroupNames": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupNames", - "traits": { - "smithy.api#documentation": "Use this parameter to include specific log groups as part of your query definition.
\nIf you are updating a query definition and you omit this parameter, then the updated\n definition will contain no log groups.
" - } - }, - "queryString": { - "target": "com.amazonaws.cloudwatchlogs#QueryDefinitionString", - "traits": { - "smithy.api#documentation": "The query string to use for this definition. \n For more information, see CloudWatch Logs Insights Query Syntax.
", - "smithy.api#required": {} - } - }, - "clientToken": { - "target": "com.amazonaws.cloudwatchlogs#ClientToken", - "traits": { - "smithy.api#documentation": "Used as an idempotency token, to avoid returning an exception if the service receives the same \n request twice because of a network\n\n error.
", - "smithy.api#idempotencyToken": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#PutQueryDefinitionResponse": { - "type": "structure", - "members": { - "queryDefinitionId": { - "target": "com.amazonaws.cloudwatchlogs#QueryId", - "traits": { - "smithy.api#documentation": "The ID of the query definition.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudwatchlogs#PutResourcePolicy": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#PutResourcePolicyRequest" - }, - "output": { - "target": "com.amazonaws.cloudwatchlogs#PutResourcePolicyResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#LimitExceededException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "Creates or updates a resource policy allowing other Amazon Web Services services to put log events to\n this account, such as Amazon Route 53. An account can have up to 10 resource policies per Amazon Web Services\n Region.
" - } - }, - "com.amazonaws.cloudwatchlogs#PutResourcePolicyRequest": { - "type": "structure", - "members": { - "policyName": { - "target": "com.amazonaws.cloudwatchlogs#PolicyName", - "traits": { - "smithy.api#documentation": "Name of the new policy. This parameter is required.
" - } - }, - "policyDocument": { - "target": "com.amazonaws.cloudwatchlogs#PolicyDocument", - "traits": { - "smithy.api#documentation": "Details of the new policy, including the identity of the principal that is enabled to put logs to this account. This is formatted as a JSON string.\n This parameter is required.
\nThe following example creates a resource policy enabling the Route 53 service to put\n DNS query logs in to the specified log group. Replace \"logArn\" with the ARN of \n your CloudWatch Logs resource, such as a log group or log stream.
CloudWatch Logs also supports aws:SourceArn\n and aws:SourceAccount\ncondition context keys.
\nIn the example resource policy, you would replace the value of SourceArn with\n the resource making the call from Route 53 to CloudWatch Logs. You would also\n replace the value of SourceAccount with the Amazon Web Services account ID making\n that call.
\n {\n \"Version\": \"2012-10-17\",\n \"Statement\": [\n {\n \"Sid\": \"Route53LogsToCloudWatchLogs\",\n \"Effect\": \"Allow\",\n \"Principal\": {\n \"Service\": [\n \"route53.amazonaws.com\"\n ]\n },\n \"Action\": \"logs:PutLogEvents\",\n \"Resource\": \"logArn\",\n \"Condition\": {\n \"ArnLike\": {\n \"aws:SourceArn\": \"myRoute53ResourceArn\"\n },\n \"StringEquals\": {\n \"aws:SourceAccount\": \"myAwsAccountId\"\n }\n }\n }\n ]\n}\n
The new policy.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudwatchlogs#PutRetentionPolicy": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#PutRetentionPolicyRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "Sets the retention of the specified log group. With a retention policy, you can\n configure the number of days for which to retain log events in the specified log\n group.
\nCloudWatch Logs doesn’t immediately delete log events when they reach their retention\n setting. It typically takes up to 72 hours after that before log events are deleted, but in\n rare situations might take longer.
\nTo illustrate, imagine that you change a log group to have a longer retention setting\n when it contains log events that are past the expiration date, but haven’t been deleted.\n Those log events will take up to 72 hours to be deleted after the new retention date is\n reached. To make sure that log data is deleted permanently, keep a log group at its lower\n retention setting until 72 hours after the previous retention period ends. Alternatively,\n wait to change the retention setting until you confirm that the earlier log events are\n deleted.
\nWhen log events reach their retention setting they are marked for deletion. After\n they are marked for deletion, they do not add to your archival storage costs anymore, even if \n they are not actually deleted until later. These log events marked for deletion are also not \n included when you use an API to retrieve the storedBytes value to see how many bytes a log group is storing.
The name of the log group.
", - "smithy.api#required": {} - } - }, - "retentionInDays": { - "target": "com.amazonaws.cloudwatchlogs#Days", - "traits": { - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#PutSubscriptionFilter": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#PutSubscriptionFilterRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#LimitExceededException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "Creates or updates a subscription filter and associates it with the specified log\n group. With subscription filters, you can subscribe to a real-time stream of log events\n ingested through PutLogEvents\n and have them delivered to a specific destination. When log events are sent to the receiving\n service, they are Base64 encoded and compressed with the GZIP format.
\nThe following destinations are supported for subscription filters:
\nAn Amazon Kinesis data stream belonging to the same account as the subscription\n filter, for same-account delivery.
\nA logical destination created with PutDestination that belongs to a different account, for cross-account delivery.\n We currently support Kinesis Data Streams and Firehose as logical destinations.
\nAn Amazon Kinesis Data Firehose delivery stream that belongs to the same account as\n the subscription filter, for same-account delivery.
\nAn Lambda function that belongs to the same account as the\n subscription filter, for same-account delivery.
\nEach log group can have up to two subscription filters associated with it. If you are\n updating an existing filter, you must specify the correct name in filterName.\n
Using regular expressions to create subscription filters is supported. For these filters, \n there is a quotas of quota of two regular expression patterns within a single filter pattern. There\n is also a quota of five regular expression patterns per log group.\n For more information about using regular expressions in subscription filters, \n see \n Filter pattern syntax for metric filters, subscription filters, filter log events, and Live Tail.
\nTo perform a PutSubscriptionFilter operation for any destination except a Lambda function, \n you must also have the \n iam:PassRole permission.
The name of the log group.
", - "smithy.api#required": {} - } - }, - "filterName": { - "target": "com.amazonaws.cloudwatchlogs#FilterName", - "traits": { - "smithy.api#documentation": "A name for the subscription filter. If you are updating an existing filter, you must\n specify the correct name in filterName. To find the name of the filter currently\n associated with a log group, use DescribeSubscriptionFilters.
A filter pattern for subscribing to a filtered stream of log events.
", - "smithy.api#required": {} - } - }, - "destinationArn": { - "target": "com.amazonaws.cloudwatchlogs#DestinationArn", - "traits": { - "smithy.api#documentation": "The ARN of the destination to deliver matching log events to. Currently, the supported\n destinations are:
\nAn Amazon Kinesis stream belonging to the same account as the subscription filter,\n for same-account delivery.
\nA logical destination (specified using an ARN) belonging to a different account, \n for cross-account delivery.
\nIf you're setting up a cross-account subscription, the destination must have an IAM\n policy associated with it. The IAM policy must allow the sender to send logs to the\n destination. For more information, see PutDestinationPolicy.
\nA Kinesis Data Firehose delivery stream belonging to the same account as the\n subscription filter, for same-account delivery.
\nA Lambda function belonging to the same account as the subscription filter,\n for same-account delivery.
\nThe ARN of an IAM role that grants CloudWatch Logs permissions to deliver ingested log\n events to the destination stream. You don't need to provide the ARN when you are working with\n a logical destination for cross-account delivery.
" - } - }, - "distribution": { - "target": "com.amazonaws.cloudwatchlogs#Distribution", - "traits": { - "smithy.api#documentation": "The method used to distribute log data to the destination. By default, log data is\n grouped by log stream, but the grouping can be set to random for a more even distribution.\n This property is only applicable when the destination is an Amazon Kinesis data stream.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#QueryCharOffset": { - "type": "integer" - }, - "com.amazonaws.cloudwatchlogs#QueryCompileError": { - "type": "structure", - "members": { - "location": { - "target": "com.amazonaws.cloudwatchlogs#QueryCompileErrorLocation", - "traits": { - "smithy.api#documentation": "Reserved.
" - } - }, - "message": { - "target": "com.amazonaws.cloudwatchlogs#Message", - "traits": { - "smithy.api#documentation": "Reserved.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Reserved.
" - } - }, - "com.amazonaws.cloudwatchlogs#QueryCompileErrorLocation": { - "type": "structure", - "members": { - "startCharOffset": { - "target": "com.amazonaws.cloudwatchlogs#QueryCharOffset", - "traits": { - "smithy.api#documentation": "Reserved.
" - } - }, - "endCharOffset": { - "target": "com.amazonaws.cloudwatchlogs#QueryCharOffset", - "traits": { - "smithy.api#documentation": "Reserved.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Reserved.
" - } - }, - "com.amazonaws.cloudwatchlogs#QueryDefinition": { - "type": "structure", - "members": { - "queryDefinitionId": { - "target": "com.amazonaws.cloudwatchlogs#QueryId", - "traits": { - "smithy.api#documentation": "The unique ID of the query definition.
" - } - }, - "name": { - "target": "com.amazonaws.cloudwatchlogs#QueryDefinitionName", - "traits": { - "smithy.api#documentation": "The name of the query definition.
" - } - }, - "queryString": { - "target": "com.amazonaws.cloudwatchlogs#QueryDefinitionString", - "traits": { - "smithy.api#documentation": "The query string to use for this definition.\n For more information, see CloudWatch Logs Insights Query Syntax.
" - } - }, - "lastModified": { - "target": "com.amazonaws.cloudwatchlogs#Timestamp", - "traits": { - "smithy.api#documentation": "The date that the query definition was most recently modified.
" - } - }, - "logGroupNames": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupNames", - "traits": { - "smithy.api#documentation": "If this query definition contains a list of log groups that it is limited to, that list appears here.
" - } - } - }, - "traits": { - "smithy.api#documentation": "This structure contains details about a saved CloudWatch Logs Insights query definition.
" - } - }, - "com.amazonaws.cloudwatchlogs#QueryDefinitionList": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudwatchlogs#QueryDefinition" - } - }, - "com.amazonaws.cloudwatchlogs#QueryDefinitionName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - } - } - }, - "com.amazonaws.cloudwatchlogs#QueryDefinitionString": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10000 - } - } - }, - "com.amazonaws.cloudwatchlogs#QueryId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - } - } - }, - "com.amazonaws.cloudwatchlogs#QueryInfo": { - "type": "structure", - "members": { - "queryId": { - "target": "com.amazonaws.cloudwatchlogs#QueryId", - "traits": { - "smithy.api#documentation": "The unique ID number of this query.
" - } - }, - "queryString": { - "target": "com.amazonaws.cloudwatchlogs#QueryString", - "traits": { - "smithy.api#documentation": "The query string used in this query.
" - } - }, - "status": { - "target": "com.amazonaws.cloudwatchlogs#QueryStatus", - "traits": { - "smithy.api#documentation": "The status of this query. Possible values are Cancelled,\n Complete, Failed, Running, Scheduled, and Unknown.
The date and time that this query was created.
" - } - }, - "logGroupName": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupName", - "traits": { - "smithy.api#documentation": "The name of the log group scanned by this query.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Information about one CloudWatch Logs Insights query that matches the request in a DescribeQueries operation.
The number of log events that matched the query string.
" - } - }, - "recordsScanned": { - "target": "com.amazonaws.cloudwatchlogs#StatsValue", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The total number of log events scanned during the query.
" - } - }, - "bytesScanned": { - "target": "com.amazonaws.cloudwatchlogs#StatsValue", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The total number of bytes in the log events scanned during the query.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains the number of log events scanned by the query, the number of log events that matched the \n query criteria, and the total number of bytes in the log events that were scanned.
" - } - }, - "com.amazonaws.cloudwatchlogs#QueryStatus": { - "type": "enum", - "members": { - "Scheduled": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Scheduled" - } - }, - "Running": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Running" - } - }, - "Complete": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Complete" - } - }, - "Failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Failed" - } - }, - "Cancelled": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Cancelled" - } - }, - "Timeout": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Timeout" - } - }, - "Unknown": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Unknown" - } - } - } - }, - "com.amazonaws.cloudwatchlogs#QueryString": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 10000 - } - } - }, - "com.amazonaws.cloudwatchlogs#RejectedEntityInfo": { - "type": "structure", - "members": { - "errorType": { - "target": "com.amazonaws.cloudwatchlogs#EntityRejectionErrorType", - "traits": { - "smithy.api#documentation": "Reserved for future use.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Reserved for future use.
" - } - }, - "com.amazonaws.cloudwatchlogs#RejectedLogEventsInfo": { - "type": "structure", - "members": { - "tooNewLogEventStartIndex": { - "target": "com.amazonaws.cloudwatchlogs#LogEventIndex", - "traits": { - "smithy.api#documentation": "The index of the first log event that is too new. This field is inclusive.
" - } - }, - "tooOldLogEventEndIndex": { - "target": "com.amazonaws.cloudwatchlogs#LogEventIndex", - "traits": { - "smithy.api#documentation": "The index of the last log event that is too old. This field is exclusive.
" - } - }, - "expiredLogEventEndIndex": { - "target": "com.amazonaws.cloudwatchlogs#LogEventIndex", - "traits": { - "smithy.api#documentation": "The expired log events.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Represents the rejected events.
" - } - }, - "com.amazonaws.cloudwatchlogs#RequestId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - } - } - }, - "com.amazonaws.cloudwatchlogs#ResourceAlreadyExistsException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.cloudwatchlogs#Message" - } - }, - "traits": { - "smithy.api#documentation": "The specified resource already exists.
", - "smithy.api#error": "client" - } - }, - "com.amazonaws.cloudwatchlogs#ResourceArns": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudwatchlogs#Arn" - } - }, - "com.amazonaws.cloudwatchlogs#ResourceIdentifier": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - }, - "smithy.api#pattern": "^[\\w+=/:,.@\\-\\*]*$" - } - }, - "com.amazonaws.cloudwatchlogs#ResourceNotFoundException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.cloudwatchlogs#Message" - } - }, - "traits": { - "smithy.api#documentation": "The specified resource does not exist.
", - "smithy.api#error": "client" - } - }, - "com.amazonaws.cloudwatchlogs#ResourcePolicies": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudwatchlogs#ResourcePolicy" - } - }, - "com.amazonaws.cloudwatchlogs#ResourcePolicy": { - "type": "structure", - "members": { - "policyName": { - "target": "com.amazonaws.cloudwatchlogs#PolicyName", - "traits": { - "smithy.api#documentation": "The name of the resource policy.
" - } - }, - "policyDocument": { - "target": "com.amazonaws.cloudwatchlogs#PolicyDocument", - "traits": { - "smithy.api#documentation": "The details of the policy.
" - } - }, - "lastUpdatedTime": { - "target": "com.amazonaws.cloudwatchlogs#Timestamp", - "traits": { - "smithy.api#documentation": "Timestamp showing when this policy was last updated, expressed as the number of\n milliseconds after Jan 1, 1970 00:00:00 UTC.
A policy enabling one or more entities to put logs to a log group in this account.
" - } - }, - "com.amazonaws.cloudwatchlogs#ResultField": { - "type": "structure", - "members": { - "field": { - "target": "com.amazonaws.cloudwatchlogs#Field", - "traits": { - "smithy.api#documentation": "The log event field.
" - } - }, - "value": { - "target": "com.amazonaws.cloudwatchlogs#Value", - "traits": { - "smithy.api#documentation": "The value of this field.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains one field from one log event returned by a CloudWatch Logs Insights query, along with the value of that field.
\nFor more information about the fields that are \n generated by CloudWatch logs, see \n Supported Logs and Discovered Fields.
" - } - }, - "com.amazonaws.cloudwatchlogs#ResultRows": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudwatchlogs#ResultField" - } - }, - "com.amazonaws.cloudwatchlogs#RoleArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.cloudwatchlogs#Scope": { - "type": "enum", - "members": { - "ALL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ALL" - } - } - } - }, - "com.amazonaws.cloudwatchlogs#SearchedLogStream": { - "type": "structure", - "members": { - "logStreamName": { - "target": "com.amazonaws.cloudwatchlogs#LogStreamName", - "traits": { - "smithy.api#documentation": "The name of the log stream.
" - } - }, - "searchedCompletely": { - "target": "com.amazonaws.cloudwatchlogs#LogStreamSearchedCompletely", - "traits": { - "smithy.api#documentation": "Indicates whether all the events in this log stream were searched.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Represents the search status of a log stream.
" - } - }, - "com.amazonaws.cloudwatchlogs#SearchedLogStreams": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudwatchlogs#SearchedLogStream" - } - }, - "com.amazonaws.cloudwatchlogs#SelectionCriteria": { - "type": "string" - }, - "com.amazonaws.cloudwatchlogs#SequenceToken": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.cloudwatchlogs#Service": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - }, - "smithy.api#pattern": "^[\\w]*$" - } - }, - "com.amazonaws.cloudwatchlogs#ServiceQuotaExceededException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.cloudwatchlogs#Message" - } - }, - "traits": { - "smithy.api#documentation": "This request exceeds a service quota.
", - "smithy.api#error": "client" - } - }, - "com.amazonaws.cloudwatchlogs#ServiceUnavailableException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.cloudwatchlogs#Message" - } - }, - "traits": { - "smithy.api#documentation": "The service cannot complete the request.
", - "smithy.api#error": "server" - } - }, - "com.amazonaws.cloudwatchlogs#SessionId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - } - } - }, - "com.amazonaws.cloudwatchlogs#SessionStreamingException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.cloudwatchlogs#Message" - } - }, - "traits": { - "smithy.api#documentation": "his exception is returned if an unknown error occurs during a Live Tail session.
", - "smithy.api#error": "client" - } - }, - "com.amazonaws.cloudwatchlogs#SessionTimeoutException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.cloudwatchlogs#Message" - } - }, - "traits": { - "smithy.api#documentation": "This exception is returned in a Live Tail stream when the Live Tail session times out. Live Tail sessions time\n out after three hours.
", - "smithy.api#error": "client" - } - }, - "com.amazonaws.cloudwatchlogs#StandardUnit": { - "type": "enum", - "members": { - "Seconds": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Seconds" - } - }, - "Microseconds": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Microseconds" - } - }, - "Milliseconds": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Milliseconds" - } - }, - "Bytes": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Bytes" - } - }, - "Kilobytes": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Kilobytes" - } - }, - "Megabytes": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Megabytes" - } - }, - "Gigabytes": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Gigabytes" - } - }, - "Terabytes": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Terabytes" - } - }, - "Bits": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Bits" - } - }, - "Kilobits": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Kilobits" - } - }, - "Megabits": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Megabits" - } - }, - "Gigabits": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Gigabits" - } - }, - "Terabits": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Terabits" - } - }, - "Percent": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Percent" - } - }, - "Count": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Count" - } - }, - "BytesSecond": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Bytes/Second" - } - }, - "KilobytesSecond": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Kilobytes/Second" - } - }, - "MegabytesSecond": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Megabytes/Second" - } - }, - "GigabytesSecond": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Gigabytes/Second" - } - }, - "TerabytesSecond": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Terabytes/Second" - } - }, - "BitsSecond": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Bits/Second" - } - }, - "KilobitsSecond": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Kilobits/Second" - } - }, - "MegabitsSecond": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Megabits/Second" - } - }, - "GigabitsSecond": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Gigabits/Second" - } - }, - "TerabitsSecond": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Terabits/Second" - } - }, - "CountSecond": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Count/Second" - } - }, - "None": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "None" - } - } - } - }, - "com.amazonaws.cloudwatchlogs#StartFromHead": { - "type": "boolean" - }, - "com.amazonaws.cloudwatchlogs#StartLiveTail": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#StartLiveTailRequest" - }, - "output": { - "target": "com.amazonaws.cloudwatchlogs#StartLiveTailResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#AccessDeniedException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#InvalidOperationException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#LimitExceededException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "Starts a Live Tail streaming session for one or more log groups. A Live Tail session returns a stream of \n log events that have\n been recently ingested in the log groups. For more information, see \n Use Live Tail to view logs in near real time.\n
\nThe response to this operation is a response stream, over which \n the server sends live log events and the client receives them.
\nThe following objects are sent over the stream:
\nA single LiveTailSessionStart \n object is sent at the start of the session.
\nEvery second, a LiveTailSessionUpdate\n object is sent. Each of these objects contains an array of the actual log events.
\nIf no new log events were ingested in the past second, the \n LiveTailSessionUpdate object will contain an empty array.
The array of log events contained in a LiveTailSessionUpdate can include\n as many as 500 log events. If the number of log events matching the request exceeds 500 per second, the\n log events are sampled down to 500 log events to be included in each LiveTailSessionUpdate object.
If your client consumes the log events slower than the server produces them, CloudWatch Logs\n buffers up to 10 LiveTailSessionUpdate events or 5000 log events, after \n which it starts dropping the oldest events.
A SessionStreamingException \n object is returned if an unknown error occurs on the server side.
\nA SessionTimeoutException \n object is returned when the session times out, after it has been kept open for three hours.
\nYou can end a session before it times out by closing the session stream or by closing the client that is receiving the \n stream. The session also ends if the established connection between the client and the server breaks.
\nFor examples of using an SDK to start a Live Tail session, see \n \n Start a Live Tail session using an Amazon Web Services SDK.
", - "smithy.api#endpoint": { - "hostPrefix": "streaming-" - } - } - }, - "com.amazonaws.cloudwatchlogs#StartLiveTailLogGroupIdentifiers": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupIdentifier" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.cloudwatchlogs#StartLiveTailRequest": { - "type": "structure", - "members": { - "logGroupIdentifiers": { - "target": "com.amazonaws.cloudwatchlogs#StartLiveTailLogGroupIdentifiers", - "traits": { - "smithy.api#documentation": "An array where each item in the array is a log group to include in the Live Tail session.
\nSpecify each log group by its ARN.
\nIf you specify an ARN, the ARN can't end with an asterisk (*).
\nYou can include up to 10 log groups.
\nIf you specify this parameter, then only log events in the log streams that you specify here are \n included in the Live Tail session.
\nIf you specify this field, you can't also specify the logStreamNamePrefixes field.
You can specify this parameter only if you specify only one log group in logGroupIdentifiers.
If you specify this parameter, then only log events in the log streams that have names that start with the \n prefixes that you specify here are \n included in the Live Tail session.
\nIf you specify this field, you can't also specify the logStreamNames field.
You can specify this parameter only if you specify only one log group in logGroupIdentifiers.
An optional pattern to use to filter the results to include only log events that match the pattern.\n For example, a filter pattern of error 404 causes only log events that include both error \n and 404 to be included in the Live Tail stream.
Regular expression filter patterns are supported.
\nFor more information about filter pattern syntax, see Filter and Pattern Syntax.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#StartLiveTailResponse": { - "type": "structure", - "members": { - "responseStream": { - "target": "com.amazonaws.cloudwatchlogs#StartLiveTailResponseStream", - "traits": { - "smithy.api#documentation": "An object that includes the stream returned by your request. It can include both log events and exceptions.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudwatchlogs#StartLiveTailResponseStream": { - "type": "union", - "members": { - "sessionStart": { - "target": "com.amazonaws.cloudwatchlogs#LiveTailSessionStart", - "traits": { - "smithy.api#documentation": "This object contains information about this Live Tail session, including the log groups included and the \n log stream filters, if any.
" - } - }, - "sessionUpdate": { - "target": "com.amazonaws.cloudwatchlogs#LiveTailSessionUpdate", - "traits": { - "smithy.api#documentation": "This object contains the log events and session metadata.
" - } - }, - "SessionTimeoutException": { - "target": "com.amazonaws.cloudwatchlogs#SessionTimeoutException", - "traits": { - "smithy.api#documentation": "This exception is returned in the stream when the Live Tail session times out. Live Tail sessions time\n out after three hours.
" - } - }, - "SessionStreamingException": { - "target": "com.amazonaws.cloudwatchlogs#SessionStreamingException", - "traits": { - "smithy.api#documentation": "This exception is returned if an unknown error occurs.
" - } - } - }, - "traits": { - "smithy.api#documentation": "This object includes the stream returned by your \n StartLiveTail\n request.
", - "smithy.api#streaming": {} - } - }, - "com.amazonaws.cloudwatchlogs#StartQuery": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#StartQueryRequest" - }, - "output": { - "target": "com.amazonaws.cloudwatchlogs#StartQueryResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#LimitExceededException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#MalformedQueryException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "Schedules a query of a log group using CloudWatch Logs Insights. You specify the log group\n and time range to query and the query string to use.
\nFor more information, see CloudWatch Logs Insights Query Syntax.
\nAfter you run a query using StartQuery, the query results are stored by CloudWatch Logs. \n You can use GetQueryResults to retrieve\n the results of a query, using the queryId that StartQuery returns.\n
If you have associated a KMS key with the query results in this account, \n then \n StartQuery uses that key to \n encrypt the results when it stores them. If no key is associated with query results, the query results are \n encrypted with the default CloudWatch Logs encryption method.
\nQueries time out after 60 minutes of runtime. If your queries are timing out, reduce the\n time range being searched or partition your query into a number of queries.
\nIf you are using CloudWatch cross-account observability, you can use this operation in a\n monitoring account to start a query in a linked source account. For more information, see\n CloudWatch\n cross-account observability. For a cross-account StartQuery operation,\n the query definition must be defined in the monitoring account.
You can have up to 30 concurrent CloudWatch Logs insights queries, including queries\n that have been added to dashboards.
" - } - }, - "com.amazonaws.cloudwatchlogs#StartQueryRequest": { - "type": "structure", - "members": { - "logGroupName": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupName", - "traits": { - "smithy.api#documentation": "The log group on which to perform the query.
\nA StartQuery operation must include exactly one of the following\n parameters: logGroupName, logGroupNames, or\n logGroupIdentifiers.
The list of log groups to be queried. You can include up to 50 log groups.
\nA StartQuery operation must include exactly one of the following\n parameters: logGroupName, logGroupNames, or\n logGroupIdentifiers.
The list of log groups to query. You can include up to 50 log groups.
\nYou can specify them by the log group name or ARN. If a log group that you're querying is\n in a source account and you're using a monitoring account, you must specify the ARN of the log\n group here. The query definition must also be defined in the monitoring account.
\nIf you specify an ARN, the ARN can't end with an asterisk (*).
\nA StartQuery operation must include exactly one of the following parameters:\n logGroupName, logGroupNames, or logGroupIdentifiers.
The beginning of the time range to query. The range is inclusive, so the specified start\n time is included in the query. Specified as epoch time, the number of seconds since\n January 1, 1970, 00:00:00 UTC.
The end of the time range to query. The range is inclusive, so the specified end time is\n included in the query. Specified as epoch time, the number of seconds since January 1,\n 1970, 00:00:00 UTC.
The query string to use.\n For more information, see CloudWatch Logs Insights Query Syntax.
", - "smithy.api#required": {} - } - }, - "limit": { - "target": "com.amazonaws.cloudwatchlogs#EventsLimit", - "traits": { - "smithy.api#documentation": "The maximum number of log events to return in the query. If the query string uses the fields command,\n only the specified fields and their values are returned. The default is 1000.
The unique ID of the query.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudwatchlogs#State": { - "type": "enum", - "members": { - "Active": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Active" - } - }, - "Suppressed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Suppressed" - } - }, - "Baseline": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Baseline" - } - } - } - }, - "com.amazonaws.cloudwatchlogs#StatsValue": { - "type": "double", - "traits": { - "smithy.api#default": 0 - } - }, - "com.amazonaws.cloudwatchlogs#StopQuery": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#StopQueryRequest" - }, - "output": { - "target": "com.amazonaws.cloudwatchlogs#StopQueryResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "Stops a CloudWatch Logs Insights query that is in progress. If the query has already ended, the operation\n returns an error indicating that the specified query is not running.
" - } - }, - "com.amazonaws.cloudwatchlogs#StopQueryRequest": { - "type": "structure", - "members": { - "queryId": { - "target": "com.amazonaws.cloudwatchlogs#QueryId", - "traits": { - "smithy.api#documentation": "The ID number of the query to stop. To find this ID number, use\n DescribeQueries.
This is true if the query was stopped by the StopQuery operation.
The name of the subscription filter.
" - } - }, - "logGroupName": { - "target": "com.amazonaws.cloudwatchlogs#LogGroupName", - "traits": { - "smithy.api#documentation": "The name of the log group.
" - } - }, - "filterPattern": { - "target": "com.amazonaws.cloudwatchlogs#FilterPattern" - }, - "destinationArn": { - "target": "com.amazonaws.cloudwatchlogs#DestinationArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the destination.
" - } - }, - "roleArn": { - "target": "com.amazonaws.cloudwatchlogs#RoleArn", - "traits": { - "smithy.api#documentation": "" - } - }, - "distribution": { - "target": "com.amazonaws.cloudwatchlogs#Distribution" - }, - "creationTime": { - "target": "com.amazonaws.cloudwatchlogs#Timestamp", - "traits": { - "smithy.api#documentation": "The creation time of the subscription filter, expressed as the number of milliseconds\n after Jan 1, 1970 00:00:00 UTC.
Represents a subscription filter.
" - } - }, - "com.amazonaws.cloudwatchlogs#SubscriptionFilters": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudwatchlogs#SubscriptionFilter" - } - }, - "com.amazonaws.cloudwatchlogs#Success": { - "type": "boolean", - "traits": { - "smithy.api#default": false - } - }, - "com.amazonaws.cloudwatchlogs#SuppressionPeriod": { - "type": "structure", - "members": { - "value": { - "target": "com.amazonaws.cloudwatchlogs#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "Specifies the number of seconds, minutes or hours to suppress this anomaly. There is no maximum.
" - } - }, - "suppressionUnit": { - "target": "com.amazonaws.cloudwatchlogs#SuppressionUnit", - "traits": { - "smithy.api#documentation": "Specifies whether the value of value is in seconds, minutes, or hours.
If you are suppressing an anomaly temporariliy, this structure defines how long the suppression period\n is to be.
" - } - }, - "com.amazonaws.cloudwatchlogs#SuppressionState": { - "type": "enum", - "members": { - "SUPPRESSED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SUPPRESSED" - } - }, - "UNSUPPRESSED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UNSUPPRESSED" - } - } - } - }, - "com.amazonaws.cloudwatchlogs#SuppressionType": { - "type": "enum", - "members": { - "LIMITED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LIMITED" - } - }, - "INFINITE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INFINITE" - } - } - } - }, - "com.amazonaws.cloudwatchlogs#SuppressionUnit": { - "type": "enum", - "members": { - "SECONDS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SECONDS" - } - }, - "MINUTES": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MINUTES" - } - }, - "HOURS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HOURS" - } - } - } - }, - "com.amazonaws.cloudwatchlogs#TagKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - }, - "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]+)$" - } - }, - "com.amazonaws.cloudwatchlogs#TagKeyList": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudwatchlogs#TagKey" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 50 - } - } - }, - "com.amazonaws.cloudwatchlogs#TagList": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudwatchlogs#TagKey" - }, - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.cloudwatchlogs#TagLogGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#TagLogGroupRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "Please use the generic tagging API TagResource" + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#deprecated": { + "message": "Please use the generic tagging API TagResource" + }, + "smithy.api#documentation": "The TagLogGroup operation is on the path to deprecation. We recommend that you use \n TagResource instead.
\nAdds or updates the specified tags for the specified log group.
\nTo list the tags for a log group, use ListTagsForResource.\n To remove tags, use UntagResource.
\nFor more information about tags, see Tag Log Groups in Amazon CloudWatch Logs\n in the Amazon CloudWatch Logs User Guide.
\nCloudWatch Logs doesn’t support IAM policies that prevent users from assigning specified tags to \n log groups using the aws:Resource/key-name\n or aws:TagKeys condition keys. \n For more information about using tags to control access, see \n Controlling access to Amazon Web Services resources using tags.
The TagLogGroup operation is on the path to deprecation. We recommend that you use \n TagResource instead.
\nAdds or updates the specified tags for the specified log group.
\nTo list the tags for a log group, use ListTagsForResource.\n To remove tags, use UntagResource.
\nFor more information about tags, see Tag Log Groups in Amazon CloudWatch Logs\n in the Amazon CloudWatch Logs User Guide.
\nCloudWatch Logs doesn’t support IAM policies that prevent users from assigning specified tags to \n log groups using the aws:Resource/key-name\n or aws:TagKeys condition keys. \n For more information about using tags to control access, see \n Controlling access to Amazon Web Services resources using tags.
The name of the log group.
", - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.cloudwatchlogs#Tags", - "traits": { - "smithy.api#documentation": "The key-value pairs to use for the tags.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#deprecated": { - "message": "Please use the generic tagging API model TagResourceRequest" + "com.amazonaws.cloudwatchlogs#TagLogGroupRequest": { + "type": "structure", + "members": { + "logGroupName": { + "target": "com.amazonaws.cloudwatchlogs#LogGroupName", + "traits": { + "smithy.api#documentation": "The name of the log group.
", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.cloudwatchlogs#Tags", + "traits": { + "smithy.api#documentation": "The key-value pairs to use for the tags.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#deprecated": { + "message": "Please use the generic tagging API model TagResourceRequest" + }, + "smithy.api#input": {} + } }, - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#TagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#TagResourceRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#TooManyTagsException" - } - ], - "traits": { - "smithy.api#documentation": "Assigns one or more tags (key-value pairs) to the specified CloudWatch Logs resource. \n Currently, the only CloudWatch Logs resources that \n can be tagged are log groups and destinations.
\nTags can help you organize and categorize your resources. You can also use them to scope user\n permissions by granting a user\n permission to access or change only resources with certain tag values.
\nTags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.
\nYou can use the TagResource action with a resource that already has tags. If you specify a new tag key for the alarm, \n this tag is appended to the list of tags associated\n with the alarm. If you specify a tag key that is already associated with the alarm, the new tag value that you specify replaces\n the previous value for that tag.
You can associate as many as 50 tags with a CloudWatch Logs resource.
" - } - }, - "com.amazonaws.cloudwatchlogs#TagResourceRequest": { - "type": "structure", - "members": { - "resourceArn": { - "target": "com.amazonaws.cloudwatchlogs#AmazonResourceName", - "traits": { - "smithy.api#documentation": "The ARN of the resource that you're adding tags to.
\nThe ARN format of a log group is \n arn:aws:logs:Region:account-id:log-group:log-group-name\n \n
The ARN format of a destination is \n arn:aws:logs:Region:account-id:destination:destination-name\n \n
For more information about ARN format, see CloudWatch Logs \n resources and operations.
", - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.cloudwatchlogs#Tags", - "traits": { - "smithy.api#documentation": "The list of key-value pairs to associate with the resource.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#TagValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - }, - "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" - } - }, - "com.amazonaws.cloudwatchlogs#Tags": { - "type": "map", - "key": { - "target": "com.amazonaws.cloudwatchlogs#TagKey" - }, - "value": { - "target": "com.amazonaws.cloudwatchlogs#TagValue" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.cloudwatchlogs#TargetArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.cloudwatchlogs#TestEventMessages": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudwatchlogs#EventMessage" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.cloudwatchlogs#TestMetricFilter": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#TestMetricFilterRequest" - }, - "output": { - "target": "com.amazonaws.cloudwatchlogs#TestMetricFilterResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "Tests the filter pattern of a metric filter against a sample of log event messages. You\n can use this operation to validate the correctness of a metric filter pattern.
" - } - }, - "com.amazonaws.cloudwatchlogs#TestMetricFilterRequest": { - "type": "structure", - "members": { - "filterPattern": { - "target": "com.amazonaws.cloudwatchlogs#FilterPattern", - "traits": { - "smithy.api#required": {} - } - }, - "logEventMessages": { - "target": "com.amazonaws.cloudwatchlogs#TestEventMessages", - "traits": { - "smithy.api#documentation": "The log event messages to test.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#TestMetricFilterResponse": { - "type": "structure", - "members": { - "matches": { - "target": "com.amazonaws.cloudwatchlogs#MetricFilterMatches", - "traits": { - "smithy.api#documentation": "The matched events.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudwatchlogs#ThrottlingException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.cloudwatchlogs#Message" - } - }, - "traits": { - "smithy.api#documentation": "The request was throttled because of quota limits.
", - "smithy.api#error": "client" - } - }, - "com.amazonaws.cloudwatchlogs#Time": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.cloudwatchlogs#Timestamp": { - "type": "long", - "traits": { - "smithy.api#range": { - "min": 0 - } - } - }, - "com.amazonaws.cloudwatchlogs#Token": { - "type": "string" - }, - "com.amazonaws.cloudwatchlogs#TokenString": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.cloudwatchlogs#TokenValue": { - "type": "long", - "traits": { - "smithy.api#default": 0 - } - }, - "com.amazonaws.cloudwatchlogs#TooManyTagsException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.cloudwatchlogs#Message" - }, - "resourceName": { - "target": "com.amazonaws.cloudwatchlogs#AmazonResourceName", - "traits": { - "smithy.api#documentation": "The name of the resource.
" - } - } - }, - "traits": { - "smithy.api#documentation": "A resource can have no more than 50 tags.
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.cloudwatchlogs#Unmask": { - "type": "boolean", - "traits": { - "smithy.api#default": false - } - }, - "com.amazonaws.cloudwatchlogs#UnrecognizedClientException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.cloudwatchlogs#Message" - } - }, - "traits": { - "smithy.api#documentation": "The most likely cause is an Amazon Web Services access key ID or secret key that's not\n valid.
", - "smithy.api#error": "client" - } - }, - "com.amazonaws.cloudwatchlogs#UntagLogGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#UntagLogGroupRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "Please use the generic tagging API UntagResource" + "com.amazonaws.cloudwatchlogs#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#TagResourceRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#TooManyTagsException" + } + ], + "traits": { + "smithy.api#documentation": "Assigns one or more tags (key-value pairs) to the specified CloudWatch Logs resource. \n Currently, the only CloudWatch Logs resources that \n can be tagged are log groups and destinations.
\nTags can help you organize and categorize your resources. You can also use them to scope user\n permissions by granting a user\n permission to access or change only resources with certain tag values.
\nTags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.
\nYou can use the TagResource action with a resource that already has tags. If you specify a new tag key for the alarm, \n this tag is appended to the list of tags associated\n with the alarm. If you specify a tag key that is already associated with the alarm, the new tag value that you specify replaces\n the previous value for that tag.
You can associate as many as 50 tags with a CloudWatch Logs resource.
" + } }, - "smithy.api#documentation": "The UntagLogGroup operation is on the path to deprecation. We recommend that you use \n UntagResource instead.
\nRemoves the specified tags from the specified log group.
\nTo list the tags for a log group, use ListTagsForResource.\n To add tags, use TagResource.
\nCloudWatch Logs doesn’t support IAM policies that prevent users from assigning specified tags to \n log groups using the aws:Resource/key-name\n or aws:TagKeys condition keys. \n
The name of the log group.
", - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.cloudwatchlogs#TagList", - "traits": { - "smithy.api#documentation": "The tag keys. The corresponding tags are removed from the log group.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#deprecated": { - "message": "Please use the generic tagging API model UntagResourceRequest" + "com.amazonaws.cloudwatchlogs#TagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.cloudwatchlogs#AmazonResourceName", + "traits": { + "smithy.api#documentation": "The ARN of the resource that you're adding tags to.
\nThe ARN format of a log group is \n arn:aws:logs:Region:account-id:log-group:log-group-name\n \n
The ARN format of a destination is \n arn:aws:logs:Region:account-id:destination:destination-name\n \n
For more information about ARN format, see CloudWatch Logs \n resources and operations.
", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.cloudwatchlogs#Tags", + "traits": { + "smithy.api#documentation": "The list of key-value pairs to associate with the resource.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#UntagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#UntagResourceRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "Removes one or more tags from the specified resource.
" - } - }, - "com.amazonaws.cloudwatchlogs#UntagResourceRequest": { - "type": "structure", - "members": { - "resourceArn": { - "target": "com.amazonaws.cloudwatchlogs#AmazonResourceName", - "traits": { - "smithy.api#documentation": "The ARN of the CloudWatch Logs resource that you're removing tags from.
\nThe ARN format of a log group is \n arn:aws:logs:Region:account-id:log-group:log-group-name\n \n
The ARN format of a destination is \n arn:aws:logs:Region:account-id:destination:destination-name\n \n
For more information about ARN format, see CloudWatch Logs \n resources and operations.
", - "smithy.api#required": {} - } - }, - "tagKeys": { - "target": "com.amazonaws.cloudwatchlogs#TagKeyList", - "traits": { - "smithy.api#documentation": "The list of tag keys to remove from the resource.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#UpdateAnomaly": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#UpdateAnomalyRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "Use this operation to suppress anomaly detection for a specified anomaly or pattern. If you suppress \n an anomaly, CloudWatch Logs won’t report new occurrences of that anomaly and won't\n update that anomaly \n with new data. If you suppress a pattern, CloudWatch Logs won’t report any anomalies related to that pattern.
\nYou must specify either anomalyId or patternId, but you can't specify both parameters in the \n same operation.
If you have previously used this operation to suppress detection of a pattern or anomaly, you can use it again to cause\n CloudWatch Logs to end the suppression. To do this, use this operation and specify the anomaly or pattern to \n stop suppressing, and omit the suppressionType and suppressionPeriod parameters.
If you are suppressing or unsuppressing an anomaly, specify its unique ID here. You can find anomaly IDs by\n using the ListAnomalies operation.
" - } - }, - "patternId": { - "target": "com.amazonaws.cloudwatchlogs#PatternId", - "traits": { - "smithy.api#documentation": "If you are suppressing or unsuppressing an pattern, specify its unique ID here. You can find pattern IDs by\n using the ListAnomalies operation.
" - } - }, - "anomalyDetectorArn": { - "target": "com.amazonaws.cloudwatchlogs#AnomalyDetectorArn", - "traits": { - "smithy.api#documentation": "The ARN of the anomaly detector that this operation is to act on.
", - "smithy.api#required": {} - } - }, - "suppressionType": { - "target": "com.amazonaws.cloudwatchlogs#SuppressionType", - "traits": { - "smithy.api#documentation": "Use this to specify whether the suppression to be temporary or infinite. If you specify LIMITED,\n you must also specify a suppressionPeriod. If you specify INFINITE,\n any value for suppressionPeriod is ignored.
If you are temporarily suppressing an anomaly or pattern, use this structure to specify\n how long the suppression is to last.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#UpdateLogAnomalyDetector": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudwatchlogs#UpdateLogAnomalyDetectorRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "Updates an existing log anomaly detector.
" - } - }, - "com.amazonaws.cloudwatchlogs#UpdateLogAnomalyDetectorRequest": { - "type": "structure", - "members": { - "anomalyDetectorArn": { - "target": "com.amazonaws.cloudwatchlogs#AnomalyDetectorArn", - "traits": { - "smithy.api#documentation": "The ARN of the anomaly detector that you want to update.
", - "smithy.api#required": {} - } - }, - "evaluationFrequency": { - "target": "com.amazonaws.cloudwatchlogs#EvaluationFrequency", - "traits": { - "smithy.api#documentation": "Specifies how often the anomaly detector runs and look for anomalies. Set this value\n according to the frequency that the log group receives new logs. For example, if the log group\n receives new log events every 10 minutes, then setting evaluationFrequency to\n FIFTEEN_MIN might be appropriate.
The number of days to use as the life cycle of anomalies. After this time, anomalies are automatically baselined \n and the anomaly detector model will treat new occurrences of similar event as normal. Therefore, if you do not correct the cause of an \n anomaly during this time, it will be considered normal going forward and will not be detected.
" - } - }, - "enabled": { - "target": "com.amazonaws.cloudwatchlogs#Boolean", - "traits": { - "smithy.api#documentation": "Use this parameter to pause or restart the anomaly detector.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudwatchlogs#ValidationException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.cloudwatchlogs#Message" + "com.amazonaws.cloudwatchlogs#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + } + }, + "com.amazonaws.cloudwatchlogs#Tags": { + "type": "map", + "key": { + "target": "com.amazonaws.cloudwatchlogs#TagKey" + }, + "value": { + "target": "com.amazonaws.cloudwatchlogs#TagValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.cloudwatchlogs#TargetArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.cloudwatchlogs#TestEventMessages": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#EventMessage" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.cloudwatchlogs#TestMetricFilter": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#TestMetricFilterRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#TestMetricFilterResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "Tests the filter pattern of a metric filter against a sample of log event messages. You\n can use this operation to validate the correctness of a metric filter pattern.
" + } + }, + "com.amazonaws.cloudwatchlogs#TestMetricFilterRequest": { + "type": "structure", + "members": { + "filterPattern": { + "target": "com.amazonaws.cloudwatchlogs#FilterPattern", + "traits": { + "smithy.api#required": {} + } + }, + "logEventMessages": { + "target": "com.amazonaws.cloudwatchlogs#TestEventMessages", + "traits": { + "smithy.api#documentation": "The log event messages to test.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#TestMetricFilterResponse": { + "type": "structure", + "members": { + "matches": { + "target": "com.amazonaws.cloudwatchlogs#MetricFilterMatches", + "traits": { + "smithy.api#documentation": "The matched events.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#ThrottlingException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.cloudwatchlogs#Message" + } + }, + "traits": { + "smithy.api#documentation": "The request was throttled because of quota limits.
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.cloudwatchlogs#Time": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.cloudwatchlogs#Timestamp": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.cloudwatchlogs#Token": { + "type": "string" + }, + "com.amazonaws.cloudwatchlogs#TokenString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.cloudwatchlogs#TokenValue": { + "type": "long", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.cloudwatchlogs#TooManyTagsException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.cloudwatchlogs#Message" + }, + "resourceName": { + "target": "com.amazonaws.cloudwatchlogs#AmazonResourceName", + "traits": { + "smithy.api#documentation": "The name of the resource.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A resource can have no more than 50 tags.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudwatchlogs#Unmask": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, + "com.amazonaws.cloudwatchlogs#UnrecognizedClientException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.cloudwatchlogs#Message" + } + }, + "traits": { + "smithy.api#documentation": "The most likely cause is an Amazon Web Services access key ID or secret key that's not\n valid.
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.cloudwatchlogs#UntagLogGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#UntagLogGroupRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#deprecated": { + "message": "Please use the generic tagging API UntagResource" + }, + "smithy.api#documentation": "The UntagLogGroup operation is on the path to deprecation. We recommend that you use \n UntagResource instead.
\nRemoves the specified tags from the specified log group.
\nTo list the tags for a log group, use ListTagsForResource.\n To add tags, use TagResource.
\nCloudWatch Logs doesn’t support IAM policies that prevent users from assigning specified tags to \n log groups using the aws:Resource/key-name\n or aws:TagKeys condition keys. \n
The name of the log group.
", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.cloudwatchlogs#TagList", + "traits": { + "smithy.api#documentation": "The tag keys. The corresponding tags are removed from the log group.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#deprecated": { + "message": "Please use the generic tagging API model UntagResourceRequest" + }, + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#UntagResourceRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "Removes one or more tags from the specified resource.
" + } + }, + "com.amazonaws.cloudwatchlogs#UntagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.cloudwatchlogs#AmazonResourceName", + "traits": { + "smithy.api#documentation": "The ARN of the CloudWatch Logs resource that you're removing tags from.
\nThe ARN format of a log group is \n arn:aws:logs:Region:account-id:log-group:log-group-name\n \n
The ARN format of a destination is \n arn:aws:logs:Region:account-id:destination:destination-name\n \n
For more information about ARN format, see CloudWatch Logs \n resources and operations.
", + "smithy.api#required": {} + } + }, + "tagKeys": { + "target": "com.amazonaws.cloudwatchlogs#TagKeyList", + "traits": { + "smithy.api#documentation": "The list of tag keys to remove from the resource.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#UpdateAnomaly": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#UpdateAnomalyRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "Use this operation to suppress anomaly detection for a specified anomaly or pattern. If you suppress \n an anomaly, CloudWatch Logs won’t report new occurrences of that anomaly and won't\n update that anomaly \n with new data. If you suppress a pattern, CloudWatch Logs won’t report any anomalies related to that pattern.
\nYou must specify either anomalyId or patternId, but you can't specify both parameters in the \n same operation.
If you have previously used this operation to suppress detection of a pattern or anomaly, you can use it again to cause\n CloudWatch Logs to end the suppression. To do this, use this operation and specify the anomaly or pattern to \n stop suppressing, and omit the suppressionType and suppressionPeriod parameters.
If you are suppressing or unsuppressing an anomaly, specify its unique ID here. You can find anomaly IDs by\n using the ListAnomalies operation.
" + } + }, + "patternId": { + "target": "com.amazonaws.cloudwatchlogs#PatternId", + "traits": { + "smithy.api#documentation": "If you are suppressing or unsuppressing an pattern, specify its unique ID here. You can find pattern IDs by\n using the ListAnomalies operation.
" + } + }, + "anomalyDetectorArn": { + "target": "com.amazonaws.cloudwatchlogs#AnomalyDetectorArn", + "traits": { + "smithy.api#documentation": "The ARN of the anomaly detector that this operation is to act on.
", + "smithy.api#required": {} + } + }, + "suppressionType": { + "target": "com.amazonaws.cloudwatchlogs#SuppressionType", + "traits": { + "smithy.api#documentation": "Use this to specify whether the suppression to be temporary or infinite. If you specify LIMITED,\n you must also specify a suppressionPeriod. If you specify INFINITE,\n any value for suppressionPeriod is ignored.
If you are temporarily suppressing an anomaly or pattern, use this structure to specify\n how long the suppression is to last.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#UpdateDeliveryConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#UpdateDeliveryConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#UpdateDeliveryConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#AccessDeniedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ConflictException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ThrottlingException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Use this operation to update the configuration of a delivery to change either the \n S3 path pattern or the format of the delivered logs. You can't use this operation to change the\n source or destination of the delivery.
" + } + }, + "com.amazonaws.cloudwatchlogs#UpdateDeliveryConfigurationRequest": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.cloudwatchlogs#DeliveryId", + "traits": { + "smithy.api#documentation": "The ID of the delivery to be updated by this request.
", + "smithy.api#required": {} + } + }, + "recordFields": { + "target": "com.amazonaws.cloudwatchlogs#RecordFields", + "traits": { + "smithy.api#documentation": "The list of record fields to be delivered to the destination, in order. \n If the delivery’s log source has mandatory fields, they must be included in this list.
" + } + }, + "fieldDelimiter": { + "target": "com.amazonaws.cloudwatchlogs#FieldDelimiter", + "traits": { + "smithy.api#documentation": "The field delimiter to use between record fields when the final output format of a delivery\n is in Plain, W3C, or Raw format.
This structure contains parameters that are valid only when the delivery’s delivery destination is an S3 bucket.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#UpdateDeliveryConfigurationResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#UpdateLogAnomalyDetector": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#UpdateLogAnomalyDetectorRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "Updates an existing log anomaly detector.
" + } + }, + "com.amazonaws.cloudwatchlogs#UpdateLogAnomalyDetectorRequest": { + "type": "structure", + "members": { + "anomalyDetectorArn": { + "target": "com.amazonaws.cloudwatchlogs#AnomalyDetectorArn", + "traits": { + "smithy.api#documentation": "The ARN of the anomaly detector that you want to update.
", + "smithy.api#required": {} + } + }, + "evaluationFrequency": { + "target": "com.amazonaws.cloudwatchlogs#EvaluationFrequency", + "traits": { + "smithy.api#documentation": "Specifies how often the anomaly detector runs and look for anomalies. Set this value\n according to the frequency that the log group receives new logs. For example, if the log group\n receives new log events every 10 minutes, then setting evaluationFrequency to\n FIFTEEN_MIN might be appropriate.
The number of days to use as the life cycle of anomalies. After this time, anomalies are automatically baselined \n and the anomaly detector model will treat new occurrences of similar event as normal. Therefore, if you do not correct the cause of an \n anomaly during this time, it will be considered normal going forward and will not be detected.
" + } + }, + "enabled": { + "target": "com.amazonaws.cloudwatchlogs#Boolean", + "traits": { + "smithy.api#documentation": "Use this parameter to pause or restart the anomaly detector.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#ValidationException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.cloudwatchlogs#Message" + } + }, + "traits": { + "smithy.api#documentation": "One of the parameters for the request is not valid.
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.cloudwatchlogs#Value": { + "type": "string" } - }, - "traits": { - "smithy.api#documentation": "One of the parameters for the request is not valid.
", - "smithy.api#error": "client" - } - }, - "com.amazonaws.cloudwatchlogs#Value": { - "type": "string" } - } } diff --git a/codegen/sdk-codegen/aws-models/finspace.json b/codegen/sdk-codegen/aws-models/finspace.json index f18623d3e039..14533a311368 100644 --- a/codegen/sdk-codegen/aws-models/finspace.json +++ b/codegen/sdk-codegen/aws-models/finspace.json @@ -1,9945 +1,9945 @@ { - "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.finspace#AWSHabaneroManagementService": { - "type": "service", - "version": "2021-03-12", - "operations": [ - { - "target": "com.amazonaws.finspace#CreateEnvironment" - }, - { - "target": "com.amazonaws.finspace#CreateKxChangeset" - }, - { - "target": "com.amazonaws.finspace#CreateKxCluster" - }, - { - "target": "com.amazonaws.finspace#CreateKxDatabase" - }, - { - "target": "com.amazonaws.finspace#CreateKxDataview" - }, - { - "target": "com.amazonaws.finspace#CreateKxEnvironment" - }, - { - "target": "com.amazonaws.finspace#CreateKxScalingGroup" - }, - { - "target": "com.amazonaws.finspace#CreateKxUser" - }, - { - "target": "com.amazonaws.finspace#CreateKxVolume" - }, - { - "target": "com.amazonaws.finspace#DeleteEnvironment" - }, - { - "target": "com.amazonaws.finspace#DeleteKxCluster" - }, - { - "target": "com.amazonaws.finspace#DeleteKxClusterNode" - }, - { - "target": "com.amazonaws.finspace#DeleteKxDatabase" - }, - { - "target": "com.amazonaws.finspace#DeleteKxDataview" - }, - { - "target": "com.amazonaws.finspace#DeleteKxEnvironment" - }, - { - "target": "com.amazonaws.finspace#DeleteKxScalingGroup" - }, - { - "target": "com.amazonaws.finspace#DeleteKxUser" - }, - { - "target": "com.amazonaws.finspace#DeleteKxVolume" - }, - { - "target": "com.amazonaws.finspace#GetEnvironment" - }, - { - "target": "com.amazonaws.finspace#GetKxChangeset" - }, - { - "target": "com.amazonaws.finspace#GetKxCluster" - }, - { - "target": "com.amazonaws.finspace#GetKxConnectionString" - }, - { - "target": "com.amazonaws.finspace#GetKxDatabase" - }, - { - "target": "com.amazonaws.finspace#GetKxDataview" - }, - { - "target": "com.amazonaws.finspace#GetKxEnvironment" - }, - { - "target": "com.amazonaws.finspace#GetKxScalingGroup" - }, - { - "target": "com.amazonaws.finspace#GetKxUser" - }, - { - "target": "com.amazonaws.finspace#GetKxVolume" - }, - { - "target": "com.amazonaws.finspace#ListEnvironments" - }, - { - "target": "com.amazonaws.finspace#ListKxChangesets" - }, - { - "target": "com.amazonaws.finspace#ListKxClusterNodes" - }, - { - "target": "com.amazonaws.finspace#ListKxClusters" - }, - { - "target": "com.amazonaws.finspace#ListKxDatabases" - }, - { - "target": "com.amazonaws.finspace#ListKxDataviews" - }, - { - "target": "com.amazonaws.finspace#ListKxEnvironments" - }, - { - "target": "com.amazonaws.finspace#ListKxScalingGroups" - }, - { - "target": "com.amazonaws.finspace#ListKxUsers" - }, - { - "target": "com.amazonaws.finspace#ListKxVolumes" - }, - { - "target": "com.amazonaws.finspace#ListTagsForResource" - }, - { - "target": "com.amazonaws.finspace#TagResource" - }, - { - "target": "com.amazonaws.finspace#UntagResource" - }, - { - "target": "com.amazonaws.finspace#UpdateEnvironment" - }, - { - "target": "com.amazonaws.finspace#UpdateKxClusterCodeConfiguration" - }, - { - "target": "com.amazonaws.finspace#UpdateKxClusterDatabases" - }, - { - "target": "com.amazonaws.finspace#UpdateKxDatabase" - }, - { - "target": "com.amazonaws.finspace#UpdateKxDataview" - }, - { - "target": "com.amazonaws.finspace#UpdateKxEnvironment" - }, - { - "target": "com.amazonaws.finspace#UpdateKxEnvironmentNetwork" - }, - { - "target": "com.amazonaws.finspace#UpdateKxUser" - }, - { - "target": "com.amazonaws.finspace#UpdateKxVolume" - } - ], - "traits": { - "aws.api#service": { - "sdkId": "finspace", - "arnNamespace": "finspace", - "cloudFormationName": "Finspace", - "cloudTrailEventSource": "finspace.amazonaws.com", - "endpointPrefix": "finspace" - }, - "aws.auth#sigv4": { - "name": "finspace" - }, - "aws.protocols#restJson1": {}, - "smithy.api#documentation": "The FinSpace management service provides the APIs for managing FinSpace environments.
", - "smithy.api#title": "FinSpace User Environment Management service", - "smithy.rules#endpointRuleSet": { - "version": "1.0", - "parameters": { - "Region": { - "builtIn": "AWS::Region", - "required": false, - "documentation": "The AWS region used to dispatch the request.", - "type": "String" - }, - "UseDualStack": { - "builtIn": "AWS::UseDualStack", - "required": true, - "default": false, - "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", - "type": "Boolean" - }, - "UseFIPS": { - "builtIn": "AWS::UseFIPS", - "required": true, - "default": false, - "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", - "type": "Boolean" - }, - "Endpoint": { - "builtIn": "SDK::Endpoint", - "required": false, - "documentation": "Override the endpoint used to send this request", - "type": "String" - } - }, - "rules": [ + "smithy": "2.0", + "metadata": { + "suppressions": [ + { + "id": "HttpMethodSemantics", + "namespace": "*" + }, + { + "id": "HttpResponseCodeSemantics", + "namespace": "*" + }, + { + "id": "PaginatedTrait", + "namespace": "*" + }, { - "conditions": [ + "id": "HttpHeaderTrait", + "namespace": "*" + }, + { + "id": "HttpUriConflict", + "namespace": "*" + }, + { + "id": "Service", + "namespace": "*" + } + ] + }, + "shapes": { + "com.amazonaws.finspace#AWSHabaneroManagementService": { + "type": "service", + "version": "2021-03-12", + "operations": [ { - "fn": "isSet", - "argv": [ - { - "ref": "Endpoint" - } - ] - } - ], - "rules": [ + "target": "com.amazonaws.finspace#CreateEnvironment" + }, { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", - "type": "error" + "target": "com.amazonaws.finspace#CreateKxChangeset" }, { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" + "target": "com.amazonaws.finspace#CreateKxCluster" }, { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" - }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [ + "target": "com.amazonaws.finspace#CreateKxDatabase" + }, { - "fn": "isSet", - "argv": [ - { - "ref": "Region" - } - ] - } - ], - "rules": [ + "target": "com.amazonaws.finspace#CreateKxDataview" + }, + { + "target": "com.amazonaws.finspace#CreateKxEnvironment" + }, + { + "target": "com.amazonaws.finspace#CreateKxScalingGroup" + }, + { + "target": "com.amazonaws.finspace#CreateKxUser" + }, + { + "target": "com.amazonaws.finspace#CreateKxVolume" + }, + { + "target": "com.amazonaws.finspace#DeleteEnvironment" + }, + { + "target": "com.amazonaws.finspace#DeleteKxCluster" + }, + { + "target": "com.amazonaws.finspace#DeleteKxClusterNode" + }, + { + "target": "com.amazonaws.finspace#DeleteKxDatabase" + }, + { + "target": "com.amazonaws.finspace#DeleteKxDataview" + }, + { + "target": "com.amazonaws.finspace#DeleteKxEnvironment" + }, + { + "target": "com.amazonaws.finspace#DeleteKxScalingGroup" + }, + { + "target": "com.amazonaws.finspace#DeleteKxUser" + }, + { + "target": "com.amazonaws.finspace#DeleteKxVolume" + }, + { + "target": "com.amazonaws.finspace#GetEnvironment" + }, + { + "target": "com.amazonaws.finspace#GetKxChangeset" + }, + { + "target": "com.amazonaws.finspace#GetKxCluster" + }, + { + "target": "com.amazonaws.finspace#GetKxConnectionString" + }, + { + "target": "com.amazonaws.finspace#GetKxDatabase" + }, + { + "target": "com.amazonaws.finspace#GetKxDataview" + }, + { + "target": "com.amazonaws.finspace#GetKxEnvironment" + }, + { + "target": "com.amazonaws.finspace#GetKxScalingGroup" + }, + { + "target": "com.amazonaws.finspace#GetKxUser" + }, + { + "target": "com.amazonaws.finspace#GetKxVolume" + }, + { + "target": "com.amazonaws.finspace#ListEnvironments" + }, + { + "target": "com.amazonaws.finspace#ListKxChangesets" + }, + { + "target": "com.amazonaws.finspace#ListKxClusterNodes" + }, + { + "target": "com.amazonaws.finspace#ListKxClusters" + }, + { + "target": "com.amazonaws.finspace#ListKxDatabases" + }, + { + "target": "com.amazonaws.finspace#ListKxDataviews" + }, + { + "target": "com.amazonaws.finspace#ListKxEnvironments" + }, + { + "target": "com.amazonaws.finspace#ListKxScalingGroups" + }, + { + "target": "com.amazonaws.finspace#ListKxUsers" + }, + { + "target": "com.amazonaws.finspace#ListKxVolumes" + }, + { + "target": "com.amazonaws.finspace#ListTagsForResource" + }, + { + "target": "com.amazonaws.finspace#TagResource" + }, + { + "target": "com.amazonaws.finspace#UntagResource" + }, + { + "target": "com.amazonaws.finspace#UpdateEnvironment" + }, + { + "target": "com.amazonaws.finspace#UpdateKxClusterCodeConfiguration" + }, + { + "target": "com.amazonaws.finspace#UpdateKxClusterDatabases" + }, + { + "target": "com.amazonaws.finspace#UpdateKxDatabase" + }, + { + "target": "com.amazonaws.finspace#UpdateKxDataview" + }, + { + "target": "com.amazonaws.finspace#UpdateKxEnvironment" + }, + { + "target": "com.amazonaws.finspace#UpdateKxEnvironmentNetwork" + }, + { + "target": "com.amazonaws.finspace#UpdateKxUser" + }, { - "conditions": [ - { - "fn": "aws.partition", - "argv": [ + "target": "com.amazonaws.finspace#UpdateKxVolume" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "finspace", + "arnNamespace": "finspace", + "cloudFormationName": "Finspace", + "cloudTrailEventSource": "finspace.amazonaws.com", + "endpointPrefix": "finspace" + }, + "aws.auth#sigv4": { + "name": "finspace" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "The FinSpace management service provides the APIs for managing FinSpace environments.
", + "smithy.api#title": "FinSpace User Environment Management service", + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://finspace-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://finspace-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://finspace.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "endpoint": { + "url": "https://finspace.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, { - "ref": "Region" + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" } - ], - "assign": "PartitionResult" - } - ], - "rules": [ - { - "conditions": [ + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" + "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://finspace.ca-central-1.amazonaws.com" + } }, - true - ] + "params": { + "Region": "ca-central-1", + "UseFIPS": false, + "UseDualStack": false + } }, { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" + "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://finspace.eu-west-1.amazonaws.com" + } }, - true - ] - } - ], - "rules": [ + "params": { + "Region": "eu-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://finspace.us-east-1.amazonaws.com" } - ] }, - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://finspace.us-east-2.amazonaws.com" } - ] + }, + "params": { + "Region": "us-east-2", + "UseFIPS": false, + "UseDualStack": false } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://finspace-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://finspace.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": false, + "UseDualStack": false } - ], - "type": "tree" }, { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://finspace-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://finspace-fips.us-east-1.amazonaws.com" + } }, - true - ] - } - ], - "rules": [ + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - }, - true - ] + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://finspace.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://finspace-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://finspace-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": true } - ], - "type": "tree" }, { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://finspace-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": false + } + }, { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://finspace.cn-north-1.api.amazonwebservices.com.cn" + } }, - true - ] - } - ], - "rules": [ + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://finspace.cn-north-1.amazonaws.com.cn" } - ] + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://finspace.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://finspace-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": true } - ], - "type": "tree" }, { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [], - "endpoint": { - "url": "https://finspace.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" - } - ] - }, - "smithy.rules#endpointTests": { - "testCases": [ - { - "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://finspace.ca-central-1.amazonaws.com" - } - }, - "params": { - "Region": "ca-central-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://finspace.eu-west-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-1", - "UseFIPS": false, - "UseDualStack": false - } + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://finspace-fips.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://finspace.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://finspace.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://finspace-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://finspace.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://finspace-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://finspace.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } + } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.finspace#AccessDeniedException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.finspace#ErrorMessage2" + } }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://finspace.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false - } + "traits": { + "smithy.api#documentation": "You do not have sufficient access to perform this action.
", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.finspace#AttachedClusterList": { + "type": "list", + "member": { + "target": "com.amazonaws.finspace#KxClusterName" + } + }, + "com.amazonaws.finspace#AttributeMap": { + "type": "map", + "key": { + "target": "com.amazonaws.finspace#FederationAttributeKey" }, - { - "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://finspace.us-east-2.amazonaws.com" - } - }, - "params": { - "Region": "us-east-2", - "UseFIPS": false, - "UseDualStack": false - } + "value": { + "target": "com.amazonaws.finspace#FederationAttributeValue" + } + }, + "com.amazonaws.finspace#AutoScalingConfiguration": { + "type": "structure", + "members": { + "minNodeCount": { + "target": "com.amazonaws.finspace#NodeCount", + "traits": { + "smithy.api#documentation": "The lowest number of nodes to scale. This value must be at least 1 and less than the maxNodeCount. If the nodes in a cluster belong to multiple availability zones, then minNodeCount must be at least 3.
The highest number of nodes to scale. This value cannot be greater than 5.
" + } + }, + "autoScalingMetric": { + "target": "com.amazonaws.finspace#AutoScalingMetric", + "traits": { + "smithy.api#documentation": " The metric your cluster will track in order to scale in and out. For example, CPU_UTILIZATION_PERCENTAGE is the average CPU usage across all the nodes in a cluster.
The desired value of the chosen autoScalingMetric. When the metric drops below this value, the cluster will scale in. When the metric goes above this value, the cluster will scale out. You can set the target value between 1 and 100 percent.
The duration in seconds that FinSpace will wait after a scale in event before initiating another scaling event.
" + } + }, + "scaleOutCooldownSeconds": { + "target": "com.amazonaws.finspace#CooldownTime", + "traits": { + "smithy.api#documentation": "The duration in seconds that FinSpace will wait after a scale out event before initiating another scaling event.
" + } + } }, - { - "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://finspace.us-west-2.amazonaws.com" - } - }, - "params": { - "Region": "us-west-2", - "UseFIPS": false, - "UseDualStack": false - } + "traits": { + "smithy.api#documentation": "The configuration based on which FinSpace will scale in or scale out nodes in your cluster.
" + } + }, + "com.amazonaws.finspace#AutoScalingMetric": { + "type": "enum", + "members": { + "CPU_UTILIZATION_PERCENTAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CPU_UTILIZATION_PERCENTAGE" + } + } + } + }, + "com.amazonaws.finspace#AutoScalingMetricTarget": { + "type": "double", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.finspace#AvailabilityZoneId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 8, + "max": 12 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-]+$" + } + }, + "com.amazonaws.finspace#AvailabilityZoneIds": { + "type": "list", + "member": { + "target": "com.amazonaws.finspace#AvailabilityZoneId" + } + }, + "com.amazonaws.finspace#BoxedInteger": { + "type": "integer" + }, + "com.amazonaws.finspace#CapacityConfiguration": { + "type": "structure", + "members": { + "nodeType": { + "target": "com.amazonaws.finspace#NodeType", + "traits": { + "smithy.api#documentation": "The type that determines the hardware of the host computer used for your cluster instance. Each node type offers different memory and storage capabilities. Choose a node type based on the requirements of the application or software that you plan to run on your instance.
\nYou can only specify one of the following values:
\n\n kx.s.large – The node type with a configuration of 12 GiB memory and 2 vCPUs.
\n kx.s.xlarge – The node type with a configuration of 27 GiB memory and 4 vCPUs.
\n kx.s.2xlarge – The node type with a configuration of 54 GiB memory and 8 vCPUs.
\n kx.s.4xlarge – The node type with a configuration of 108 GiB memory and 16 vCPUs.
\n kx.s.8xlarge – The node type with a configuration of 216 GiB memory and 32 vCPUs.
\n kx.s.16xlarge – The node type with a configuration of 432 GiB memory and 64 vCPUs.
\n kx.s.32xlarge – The node type with a configuration of 864 GiB memory and 128 vCPUs.
The number of instances running in a cluster.
" + } + } }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://finspace-fips.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": true - } + "traits": { + "smithy.api#documentation": "A structure for the metadata of a cluster. It includes information like the CPUs needed, memory of instances, and number of instances.
" + } + }, + "com.amazonaws.finspace#ChangeRequest": { + "type": "structure", + "members": { + "changeType": { + "target": "com.amazonaws.finspace#ChangeType", + "traits": { + "smithy.api#documentation": "Defines the type of change request. A changeType can have the following values:
PUT – Adds or updates files in a database.
\nDELETE – Deletes files in a database.
\nDefines the S3 path of the source file that is required to add or update files in a database.
" + } + }, + "dbPath": { + "target": "com.amazonaws.finspace#DbPath", + "traits": { + "smithy.api#documentation": "Defines the path within the database directory.
", + "smithy.api#required": {} + } + } }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://finspace-fips.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": false - } + "traits": { + "smithy.api#documentation": "A list of change request objects.
" + } + }, + "com.amazonaws.finspace#ChangeRequests": { + "type": "list", + "member": { + "target": "com.amazonaws.finspace#ChangeRequest" }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://finspace.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true - } + "traits": { + "smithy.api#length": { + "min": 1, + "max": 32 + } + } + }, + "com.amazonaws.finspace#ChangeType": { + "type": "enum", + "members": { + "PUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PUT" + } + }, + "DELETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE" + } + } + } + }, + "com.amazonaws.finspace#ChangesetId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 26 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]+$" + } + }, + "com.amazonaws.finspace#ChangesetStatus": { + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "PROCESSING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROCESSING" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" + } + } + } + }, + "com.amazonaws.finspace#ClientToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 36 + }, + "smithy.api#pattern": "\\S" + } + }, + "com.amazonaws.finspace#ClientTokenString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-]+$" + } + }, + "com.amazonaws.finspace#ClusterNodeCount": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.finspace#CodeConfiguration": { + "type": "structure", + "members": { + "s3Bucket": { + "target": "com.amazonaws.finspace#S3Bucket", + "traits": { + "smithy.api#documentation": "A unique name for the S3 bucket.
" + } + }, + "s3Key": { + "target": "com.amazonaws.finspace#S3Key", + "traits": { + "smithy.api#documentation": "The full S3 path (excluding bucket) to the .zip file. This file contains the code that is loaded onto the cluster when it's started.
" + } + }, + "s3ObjectVersion": { + "target": "com.amazonaws.finspace#S3ObjectVersion", + "traits": { + "smithy.api#documentation": "The version of an S3 object.
" + } + } }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://finspace-fips.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": true - } + "traits": { + "smithy.api#documentation": "The structure of the customer code available within the running cluster.
" + } + }, + "com.amazonaws.finspace#ConflictException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.finspace#ErrorMessage2" + }, + "reason": { + "target": "com.amazonaws.finspace#ErrorMessage2", + "traits": { + "smithy.api#documentation": "The reason for the conflict exception.
" + } + } }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://finspace-fips.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": false - } + "traits": { + "smithy.api#documentation": "There was a conflict with this action, and it could not be completed.
", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.finspace#CooldownTime": { + "type": "double", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 100000 + } + } + }, + "com.amazonaws.finspace#CpuCount": { + "type": "double", + "traits": { + "smithy.api#range": { + "min": 0.1 + } + } + }, + "com.amazonaws.finspace#CreateEnvironment": { + "type": "operation", + "input": { + "target": "com.amazonaws.finspace#CreateEnvironmentRequest" }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://finspace.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": true - } + "output": { + "target": "com.amazonaws.finspace#CreateEnvironmentResponse" }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://finspace.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": false - } + "errors": [ + { + "target": "com.amazonaws.finspace#AccessDeniedException" + }, + { + "target": "com.amazonaws.finspace#InternalServerException" + }, + { + "target": "com.amazonaws.finspace#LimitExceededException" + }, + { + "target": "com.amazonaws.finspace#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.finspace#ThrottlingException" + }, + { + "target": "com.amazonaws.finspace#ValidationException" + } + ], + "traits": { + "smithy.api#deprecated": { + "message": "This method will be discontinued." + }, + "smithy.api#documentation": "Create a new FinSpace environment.
", + "smithy.api#http": { + "method": "POST", + "uri": "/environment", + "code": 200 + } + } + }, + "com.amazonaws.finspace#CreateEnvironmentRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.finspace#EnvironmentName", + "traits": { + "smithy.api#documentation": "The name of the FinSpace environment to be created.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.finspace#Description", + "traits": { + "smithy.api#documentation": "The description of the FinSpace environment to be created.
" + } + }, + "kmsKeyId": { + "target": "com.amazonaws.finspace#KmsKeyId", + "traits": { + "smithy.api#documentation": "The KMS key id to encrypt your data in the FinSpace environment.
" + } + }, + "tags": { + "target": "com.amazonaws.finspace#TagMap", + "traits": { + "smithy.api#documentation": "Add tags to your FinSpace environment.
" + } + }, + "federationMode": { + "target": "com.amazonaws.finspace#FederationMode", + "traits": { + "smithy.api#documentation": "Authentication mode for the environment.
\n\n FEDERATED - Users access FinSpace through Single Sign On (SSO) via your Identity provider.
\n LOCAL - Users access FinSpace via email and password managed within the FinSpace environment.
Configuration information when authentication mode is FEDERATED.
" + } + }, + "superuserParameters": { + "target": "com.amazonaws.finspace#SuperuserParameters", + "traits": { + "smithy.api#documentation": "Configuration information for the superuser.
" + } + }, + "dataBundles": { + "target": "com.amazonaws.finspace#DataBundleArns", + "traits": { + "smithy.api#documentation": "The list of Amazon Resource Names (ARN) of the data bundles to install. Currently supported data bundle ARNs:
\n\n arn:aws:finspace:${Region}::data-bundle/capital-markets-sample - Contains sample Capital Markets datasets, categories and controlled vocabularies.
\n arn:aws:finspace:${Region}::data-bundle/taq (default) - Contains trades and quotes data in addition to sample Capital Markets data.
The unique identifier for FinSpace environment that you created.
" + } + }, + "environmentArn": { + "target": "com.amazonaws.finspace#EnvironmentArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the FinSpace environment that you created.
" + } + }, + "environmentUrl": { + "target": "com.amazonaws.finspace#url", + "traits": { + "smithy.api#documentation": "The sign-in URL for the web application of the FinSpace environment you created.
" + } + } }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://finspace-fips.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": false - } + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.finspace#CreateKxChangeset": { + "type": "operation", + "input": { + "target": "com.amazonaws.finspace#CreateKxChangesetRequest" }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://finspace.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": true - } + "output": { + "target": "com.amazonaws.finspace#CreateKxChangesetResponse" }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://finspace.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": false - } + "errors": [ + { + "target": "com.amazonaws.finspace#AccessDeniedException" + }, + { + "target": "com.amazonaws.finspace#ConflictException" + }, + { + "target": "com.amazonaws.finspace#InternalServerException" + }, + { + "target": "com.amazonaws.finspace#LimitExceededException" + }, + { + "target": "com.amazonaws.finspace#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.finspace#ThrottlingException" + }, + { + "target": "com.amazonaws.finspace#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "\n Creates a changeset for a kdb database. A changeset allows you to add and delete existing files by using an ordered list of change requests.\n
", + "smithy.api#http": { + "method": "POST", + "uri": "/kx/environments/{environmentId}/databases/{databaseName}/changesets", + "code": 200 + } + } + }, + "com.amazonaws.finspace#CreateKxChangesetRequest": { + "type": "structure", + "members": { + "environmentId": { + "target": "com.amazonaws.finspace#EnvironmentId", + "traits": { + "smithy.api#documentation": "A unique identifier of the kdb environment.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "databaseName": { + "target": "com.amazonaws.finspace#DatabaseName", + "traits": { + "smithy.api#documentation": "The name of the kdb database.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "changeRequests": { + "target": "com.amazonaws.finspace#ChangeRequests", + "traits": { + "smithy.api#documentation": "A list of change request objects that are run in order. A change request object consists of changeType , s3Path, and dbPath. \n A changeType can have the following values:
PUT – Adds or updates files in a database.
\nDELETE – Deletes files in a database.
\nAll the change requests require a mandatory dbPath attribute that defines the\n path within the database directory. All database paths must start with a leading / and end\n with a trailing /. The s3Path attribute defines the s3 source file path and is\n required for a PUT change type. The s3path must end with a trailing / if it is\n a directory and must end without a trailing / if it is a file.
Here are few examples of how you can use the change request object:
\nThis request adds a single sym file at database root location.
\n\n { \"changeType\": \"PUT\", \"s3Path\":\"s3://bucket/db/sym\",\n \"dbPath\":\"/\"}\n
This request adds files in the given s3Path under the 2020.01.02\n partition of the database.
\n { \"changeType\": \"PUT\", \"s3Path\":\"s3://bucket/db/2020.01.02/\",\n \"dbPath\":\"/2020.01.02/\"}\n
This request adds files in the given s3Path under the\n taq table partition of the database.
\n [ { \"changeType\": \"PUT\", \"s3Path\":\"s3://bucket/db/2020.01.02/taq/\",\n \"dbPath\":\"/2020.01.02/taq/\"}]\n
This request deletes the 2020.01.02 partition of the database.
\n\n [{ \"changeType\": \"DELETE\", \"dbPath\": \"/2020.01.02/\"} ]\n
The DELETE request allows you to delete the existing files under the\n 2020.01.02 partition of the database, and the PUT request adds a\n new taq table under it.
\n\n [ {\"changeType\": \"DELETE\", \"dbPath\":\"/2020.01.02/\"}, {\"changeType\": \"PUT\",\n \"s3Path\":\"s3://bucket/db/2020.01.02/taq/\",\n \"dbPath\":\"/2020.01.02/taq/\"}]\n
A token that ensures idempotency. This token expires in 10 minutes.
", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.finspace#CreateKxChangesetResponse": { + "type": "structure", + "members": { + "changesetId": { + "target": "com.amazonaws.finspace#ChangesetId", + "traits": { + "smithy.api#documentation": "A unique identifier for the changeset.
" + } + }, + "databaseName": { + "target": "com.amazonaws.finspace#DatabaseName", + "traits": { + "smithy.api#documentation": "The name of the kdb database.
" + } + }, + "environmentId": { + "target": "com.amazonaws.finspace#EnvironmentId", + "traits": { + "smithy.api#documentation": "A unique identifier for the kdb environment.
" + } + }, + "changeRequests": { + "target": "com.amazonaws.finspace#ChangeRequests", + "traits": { + "smithy.api#documentation": "A list of change requests.
" + } + }, + "createdTimestamp": { + "target": "com.amazonaws.finspace#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp at which the changeset was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" + } + }, + "lastModifiedTimestamp": { + "target": "com.amazonaws.finspace#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp at which the changeset was updated in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" + } + }, + "status": { + "target": "com.amazonaws.finspace#ChangesetStatus", + "traits": { + "smithy.api#documentation": "Status of the changeset creation process.
\nPending – Changeset creation is pending.
\nProcessing – Changeset creation is running.
\nFailed – Changeset creation has failed.
\nComplete – Changeset creation has succeeded.
\nThe details of the error that you receive when creating a changeset. It consists of the type of error and the error message.
" + } + } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://finspace-fips.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": false - } + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.finspace#CreateKxCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.finspace#CreateKxClusterRequest" }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } + "output": { + "target": "com.amazonaws.finspace#CreateKxClusterResponse" }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://finspace.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": false - } + "errors": [ + { + "target": "com.amazonaws.finspace#AccessDeniedException" + }, + { + "target": "com.amazonaws.finspace#ConflictException" + }, + { + "target": "com.amazonaws.finspace#InternalServerException" + }, + { + "target": "com.amazonaws.finspace#LimitExceededException" + }, + { + "target": "com.amazonaws.finspace#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.finspace#ThrottlingException" + }, + { + "target": "com.amazonaws.finspace#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a new kdb cluster.
", + "smithy.api#http": { + "method": "POST", + "uri": "/kx/environments/{environmentId}/clusters", + "code": 200 + } + } + }, + "com.amazonaws.finspace#CreateKxClusterRequest": { + "type": "structure", + "members": { + "clientToken": { + "target": "com.amazonaws.finspace#ClientToken", + "traits": { + "smithy.api#documentation": "A token that ensures idempotency. This token expires in 10 minutes.
", + "smithy.api#idempotencyToken": {} + } + }, + "environmentId": { + "target": "com.amazonaws.finspace#KxEnvironmentId", + "traits": { + "smithy.api#documentation": "A unique identifier for the kdb environment.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "clusterName": { + "target": "com.amazonaws.finspace#KxClusterName", + "traits": { + "smithy.api#documentation": "A unique name for the cluster that you want to create.
", + "smithy.api#required": {} + } + }, + "clusterType": { + "target": "com.amazonaws.finspace#KxClusterType", + "traits": { + "smithy.api#documentation": "Specifies the type of KDB database that is being created. The following types are available:
\nHDB – A Historical Database. The data is only accessible with read-only permissions from one of the FinSpace managed kdb databases mounted to the cluster.
\nRDB – A Realtime Database. This type of database captures all the data from a ticker plant and stores it in memory until the end of day, after which it writes all of its data to a disk and reloads the HDB. This cluster type requires local storage for temporary storage of data during the savedown process. If you specify this field in your request, you must provide the savedownStorageConfiguration parameter.
GATEWAY – A gateway cluster allows you to access data across processes in kdb systems. It allows you to create your own routing logic using the initialization scripts and custom code. This type of cluster does not require a writable local storage.
\nGP – A general purpose cluster allows you to quickly iterate on code during development by granting greater access to system commands and enabling a fast reload of custom code. This cluster type can optionally mount databases including cache and savedown storage. For this cluster type, the node count is fixed at 1. It does not support autoscaling and supports only SINGLE AZ mode.
Tickerplant – A tickerplant cluster allows you to subscribe to feed handlers based on IAM permissions. It can publish to RDBs, other Tickerplants, and real-time subscribers (RTS). Tickerplants can persist messages to log, which is readable by any RDB environment. It supports only single-node that is only one kdb process.
\n\nA configuration to store Tickerplant logs. It consists of\na list of volumes that will be mounted to your cluster. For the cluster type Tickerplant, the location of the TP volume on the cluster will be available by using the global variable .aws.tp_log_path. \n
A list of databases that will be available for querying.
" + } + }, + "cacheStorageConfigurations": { + "target": "com.amazonaws.finspace#KxCacheStorageConfigurations", + "traits": { + "smithy.api#documentation": "The configurations for a read only cache storage associated with a cluster. This cache will be stored as an FSx Lustre that reads from the S3 store.
" + } + }, + "autoScalingConfiguration": { + "target": "com.amazonaws.finspace#AutoScalingConfiguration", + "traits": { + "smithy.api#documentation": "The configuration based on which FinSpace will scale in or scale out nodes in your cluster.
" + } + }, + "clusterDescription": { + "target": "com.amazonaws.finspace#KxClusterDescription", + "traits": { + "smithy.api#documentation": "A description of the cluster.
" + } + }, + "capacityConfiguration": { + "target": "com.amazonaws.finspace#CapacityConfiguration", + "traits": { + "smithy.api#documentation": "A structure for the metadata of a cluster. It includes information like the CPUs needed, memory of instances, and number of instances.
" + } + }, + "releaseLabel": { + "target": "com.amazonaws.finspace#ReleaseLabel", + "traits": { + "smithy.api#documentation": "The version of FinSpace managed kdb to run.
", + "smithy.api#required": {} + } + }, + "vpcConfiguration": { + "target": "com.amazonaws.finspace#VpcConfiguration", + "traits": { + "smithy.api#documentation": "Configuration details about the network where the Privatelink endpoint of the cluster resides.
", + "smithy.api#required": {} + } + }, + "initializationScript": { + "target": "com.amazonaws.finspace#InitializationScriptFilePath", + "traits": { + "smithy.api#documentation": "Specifies a Q program that will be run at launch of a cluster. It is a relative path within\n .zip file that contains the custom code, which will be loaded on\n the cluster. It must include the file name itself. For example,\n somedir/init.q.
Defines the key-value pairs to make them available inside the cluster.
" + } + }, + "code": { + "target": "com.amazonaws.finspace#CodeConfiguration", + "traits": { + "smithy.api#documentation": "The details of the custom code that you want to use inside a cluster when analyzing a data. It consists of the S3 source bucket, location, S3 object version, and the relative path from where the custom code is loaded into the cluster.
" + } + }, + "executionRole": { + "target": "com.amazonaws.finspace#ExecutionRoleArn", + "traits": { + "smithy.api#documentation": "An IAM role that defines a set of permissions associated with a cluster. These permissions are assumed when a cluster attempts to access another cluster.
" + } + }, + "savedownStorageConfiguration": { + "target": "com.amazonaws.finspace#KxSavedownStorageConfiguration", + "traits": { + "smithy.api#documentation": "The size and type of the temporary storage that is used to hold data during the savedown process. This parameter is required when you choose clusterType as RDB. All the data written to this storage space is lost when the cluster node is restarted.
The number of availability zones you want to assign per cluster. This can be one of the following
\n\n SINGLE – Assigns one availability zone per cluster.
\n MULTI – Assigns all the availability zones per cluster.
The availability zone identifiers for the requested regions.
" + } + }, + "tags": { + "target": "com.amazonaws.finspace#TagMap", + "traits": { + "smithy.api#documentation": "A list of key-value pairs to label the cluster. You can add up to 50 tags to a cluster.
" + } + }, + "scalingGroupConfiguration": { + "target": "com.amazonaws.finspace#KxScalingGroupConfiguration", + "traits": { + "smithy.api#documentation": "The structure that stores the configuration details of a scaling group.
" + } + } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.finspace#CreateKxClusterResponse": { + "type": "structure", + "members": { + "environmentId": { + "target": "com.amazonaws.finspace#KxEnvironmentId", + "traits": { + "smithy.api#documentation": "A unique identifier for the kdb environment.
" + } + }, + "status": { + "target": "com.amazonaws.finspace#KxClusterStatus", + "traits": { + "smithy.api#documentation": "The status of cluster creation.
\nPENDING – The cluster is pending creation.
\nCREATING – The cluster creation process is in progress.
\nCREATE_FAILED – The cluster creation process has failed.
\nRUNNING – The cluster creation process is running.
\nUPDATING – The cluster is in the process of being updated.
\nDELETING – The cluster is in the process of being deleted.
\nDELETED – The cluster has been deleted.
\nDELETE_FAILED – The cluster failed to delete.
\nThe error message when a failed state occurs.
" + } + }, + "clusterName": { + "target": "com.amazonaws.finspace#KxClusterName", + "traits": { + "smithy.api#documentation": "A unique name for the cluster.
" + } + }, + "clusterType": { + "target": "com.amazonaws.finspace#KxClusterType", + "traits": { + "smithy.api#documentation": "Specifies the type of KDB database that is being created. The following types are available:
\nHDB – A Historical Database. The data is only accessible with read-only permissions from one of the FinSpace managed kdb databases mounted to the cluster.
\nRDB – A Realtime Database. This type of database captures all the data from a ticker plant and stores it in memory until the end of day, after which it writes all of its data to a disk and reloads the HDB. This cluster type requires local storage for temporary storage of data during the savedown process. If you specify this field in your request, you must provide the savedownStorageConfiguration parameter.
GATEWAY – A gateway cluster allows you to access data across processes in kdb systems. It allows you to create your own routing logic using the initialization scripts and custom code. This type of cluster does not require a writable local storage.
\nGP – A general purpose cluster allows you to quickly iterate on code during development by granting greater access to system commands and enabling a fast reload of custom code. This cluster type can optionally mount databases including cache and savedown storage. For this cluster type, the node count is fixed at 1. It does not support autoscaling and supports only SINGLE AZ mode.
Tickerplant – A tickerplant cluster allows you to subscribe to feed handlers based on IAM permissions. It can publish to RDBs, other Tickerplants, and real-time subscribers (RTS). Tickerplants can persist messages to log, which is readable by any RDB environment. It supports only single-node that is only one kdb process.
\n\nA list of volumes mounted on the cluster.\n
" + } + }, + "databases": { + "target": "com.amazonaws.finspace#KxDatabaseConfigurations", + "traits": { + "smithy.api#documentation": "A list of databases that will be available for querying.
" + } + }, + "cacheStorageConfigurations": { + "target": "com.amazonaws.finspace#KxCacheStorageConfigurations", + "traits": { + "smithy.api#documentation": "The configurations for a read only cache storage associated with a cluster. This cache will be stored as an FSx Lustre that reads from the S3 store.
" + } + }, + "autoScalingConfiguration": { + "target": "com.amazonaws.finspace#AutoScalingConfiguration", + "traits": { + "smithy.api#documentation": "The configuration based on which FinSpace will scale in or scale out nodes in your cluster.
" + } + }, + "clusterDescription": { + "target": "com.amazonaws.finspace#KxClusterDescription", + "traits": { + "smithy.api#documentation": "A description of the cluster.
" + } + }, + "capacityConfiguration": { + "target": "com.amazonaws.finspace#CapacityConfiguration", + "traits": { + "smithy.api#documentation": "A structure for the metadata of a cluster. It includes information like the CPUs needed, memory of instances, and number of instances.
" + } + }, + "releaseLabel": { + "target": "com.amazonaws.finspace#ReleaseLabel", + "traits": { + "smithy.api#documentation": "A version of the FinSpace managed kdb to run.
" + } + }, + "vpcConfiguration": { + "target": "com.amazonaws.finspace#VpcConfiguration", + "traits": { + "smithy.api#documentation": "Configuration details about the network where the Privatelink endpoint of the cluster resides.
" + } + }, + "initializationScript": { + "target": "com.amazonaws.finspace#InitializationScriptFilePath", + "traits": { + "smithy.api#documentation": "Specifies a Q program that will be run at launch of a cluster. It is a relative path within\n .zip file that contains the custom code, which will be loaded on\n the cluster. It must include the file name itself. For example,\n somedir/init.q.
Defines the key-value pairs to make them available inside the cluster.
" + } + }, + "code": { + "target": "com.amazonaws.finspace#CodeConfiguration", + "traits": { + "smithy.api#documentation": "The details of the custom code that you want to use inside a cluster when analyzing a data. It consists of the S3 source bucket, location, S3 object version, and the relative path from where the custom code is loaded into the cluster.
" + } + }, + "executionRole": { + "target": "com.amazonaws.finspace#ExecutionRoleArn", + "traits": { + "smithy.api#documentation": "\n An IAM role that defines a set of permissions associated with a cluster. These permissions are assumed when a cluster attempts to access another cluster.\n
" + } + }, + "lastModifiedTimestamp": { + "target": "com.amazonaws.finspace#Timestamp", + "traits": { + "smithy.api#documentation": "The last time that the cluster was modified. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" + } + }, + "savedownStorageConfiguration": { + "target": "com.amazonaws.finspace#KxSavedownStorageConfiguration", + "traits": { + "smithy.api#documentation": "The size and type of the temporary storage that is used to hold data during the savedown process. This parameter is required when you choose clusterType as RDB. All the data written to this storage space is lost when the cluster node is restarted.
The number of availability zones you want to assign per cluster. This can be one of the following
\n\n SINGLE – Assigns one availability zone per cluster.
\n MULTI – Assigns all the availability zones per cluster.
\n The availability zone identifiers for the requested regions.\n
" + } + }, + "createdTimestamp": { + "target": "com.amazonaws.finspace#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp at which the cluster was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" + } + }, + "scalingGroupConfiguration": { + "target": "com.amazonaws.finspace#KxScalingGroupConfiguration", + "traits": { + "smithy.api#documentation": "The structure that stores the configuration details of a scaling group.
" + } + } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://finspace-fips.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": false - } + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.finspace#CreateKxDatabase": { + "type": "operation", + "input": { + "target": "com.amazonaws.finspace#CreateKxDatabaseRequest" }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } + "output": { + "target": "com.amazonaws.finspace#CreateKxDatabaseResponse" }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://finspace.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": false - } + "errors": [ + { + "target": "com.amazonaws.finspace#AccessDeniedException" + }, + { + "target": "com.amazonaws.finspace#ConflictException" + }, + { + "target": "com.amazonaws.finspace#InternalServerException" + }, + { + "target": "com.amazonaws.finspace#LimitExceededException" + }, + { + "target": "com.amazonaws.finspace#ResourceAlreadyExistsException" + }, + { + "target": "com.amazonaws.finspace#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.finspace#ThrottlingException" + }, + { + "target": "com.amazonaws.finspace#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a new kdb database in the environment.
", + "smithy.api#http": { + "method": "POST", + "uri": "/kx/environments/{environmentId}/databases", + "code": 200 + } + } + }, + "com.amazonaws.finspace#CreateKxDatabaseRequest": { + "type": "structure", + "members": { + "environmentId": { + "target": "com.amazonaws.finspace#EnvironmentId", + "traits": { + "smithy.api#documentation": "A unique identifier for the kdb environment.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "databaseName": { + "target": "com.amazonaws.finspace#DatabaseName", + "traits": { + "smithy.api#documentation": "The name of the kdb database.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.finspace#Description", + "traits": { + "smithy.api#documentation": "A description of the database.
" + } + }, + "tags": { + "target": "com.amazonaws.finspace#TagMap", + "traits": { + "smithy.api#documentation": "A list of key-value pairs to label the kdb database. You can add up to 50 tags to your kdb database
" + } + }, + "clientToken": { + "target": "com.amazonaws.finspace#ClientTokenString", + "traits": { + "smithy.api#documentation": "A token that ensures idempotency. This token expires in 10 minutes.
", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + } }, - { - "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" - } + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.finspace#CreateKxDatabaseResponse": { + "type": "structure", + "members": { + "databaseName": { + "target": "com.amazonaws.finspace#DatabaseName", + "traits": { + "smithy.api#documentation": "The name of the kdb database.
" + } + }, + "databaseArn": { + "target": "com.amazonaws.finspace#DatabaseArn", + "traits": { + "smithy.api#documentation": "The ARN identifier of the database.
" + } + }, + "environmentId": { + "target": "com.amazonaws.finspace#EnvironmentId", + "traits": { + "smithy.api#documentation": "A unique identifier for the kdb environment.
" + } + }, + "description": { + "target": "com.amazonaws.finspace#Description", + "traits": { + "smithy.api#documentation": "A description of the database.
" + } + }, + "createdTimestamp": { + "target": "com.amazonaws.finspace#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp at which the database is created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" + } + }, + "lastModifiedTimestamp": { + "target": "com.amazonaws.finspace#Timestamp", + "traits": { + "smithy.api#documentation": "The last time that the database was updated in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" + } + } }, - { - "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" - } + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.finspace#CreateKxDataview": { + "type": "operation", + "input": { + "target": "com.amazonaws.finspace#CreateKxDataviewRequest" }, - { - "documentation": "For custom endpoint with fips enabled and dualstack disabled", - "expect": { - "error": "Invalid Configuration: FIPS and custom endpoint are not supported" - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": false, - "Endpoint": "https://example.com" - } + "output": { + "target": "com.amazonaws.finspace#CreateKxDataviewResponse" }, - { - "documentation": "For custom endpoint with fips disabled and dualstack enabled", - "expect": { - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true, - "Endpoint": "https://example.com" - } + "errors": [ + { + "target": "com.amazonaws.finspace#AccessDeniedException" + }, + { + "target": "com.amazonaws.finspace#ConflictException" + }, + { + "target": "com.amazonaws.finspace#InternalServerException" + }, + { + "target": "com.amazonaws.finspace#LimitExceededException" + }, + { + "target": "com.amazonaws.finspace#ResourceAlreadyExistsException" + }, + { + "target": "com.amazonaws.finspace#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.finspace#ThrottlingException" + }, + { + "target": "com.amazonaws.finspace#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "\nCreates a snapshot of kdb database with tiered storage capabilities and a pre-warmed cache, ready for mounting on kdb clusters. Dataviews are only available for clusters running on a scaling group. They are not supported on dedicated clusters.
", + "smithy.api#http": { + "method": "POST", + "uri": "/kx/environments/{environmentId}/databases/{databaseName}/dataviews", + "code": 200 + } + } + }, + "com.amazonaws.finspace#CreateKxDataviewRequest": { + "type": "structure", + "members": { + "environmentId": { + "target": "com.amazonaws.finspace#EnvironmentId", + "traits": { + "smithy.api#documentation": "A unique identifier for the kdb environment, where you want to create the dataview.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "databaseName": { + "target": "com.amazonaws.finspace#DatabaseName", + "traits": { + "smithy.api#documentation": "\nThe name of the database where you want to create a dataview.\n
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "dataviewName": { + "target": "com.amazonaws.finspace#KxDataviewName", + "traits": { + "smithy.api#documentation": "A unique identifier for the dataview.
", + "smithy.api#required": {} + } + }, + "azMode": { + "target": "com.amazonaws.finspace#KxAzMode", + "traits": { + "smithy.api#documentation": "The number of availability zones you want to assign per volume. Currently, FinSpace only supports SINGLE for volumes. This places dataview in a single AZ.
\n The identifier of the availability zones.\n
" + } + }, + "changesetId": { + "target": "com.amazonaws.finspace#ChangesetId", + "traits": { + "smithy.api#documentation": "\nA unique identifier of the changeset that you want to use to ingest data.
" + } + }, + "segmentConfigurations": { + "target": "com.amazonaws.finspace#KxDataviewSegmentConfigurationList", + "traits": { + "smithy.api#documentation": "\n The configuration that contains the database path of the data that you want to place on each selected volume. Each segment must have a unique database path for each volume. If you do not explicitly specify any database path for a volume, they are accessible from the cluster through the default S3/object store segment.
" + } + }, + "autoUpdate": { + "target": "com.amazonaws.finspace#booleanValue", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "The option to specify whether you want to apply all the future additions and corrections automatically to the dataview, when you ingest new changesets. The default value is false.
" + } + }, + "readWrite": { + "target": "com.amazonaws.finspace#booleanValue", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "\n The option to specify whether you want to make the dataview writable to perform database maintenance. The following are some considerations related to writable dataviews.\u2028\u2028
\nYou cannot create partial writable dataviews. When you create writeable dataviews you must\n provide the entire database path.
\nYou cannot perform updates on a writeable dataview. Hence, autoUpdate must be set\n as False if readWrite is True for a dataview.
You must also use a unique volume for creating a writeable dataview. So, if you choose a\n volume that is already in use by another dataview, the dataview creation\n fails.
\nOnce you create a dataview as writeable, you cannot change it to read-only. So, you cannot\n update the readWrite parameter later.
A description of the dataview.
" + } + }, + "tags": { + "target": "com.amazonaws.finspace#TagMap", + "traits": { + "smithy.api#documentation": "\nA list of key-value pairs to label the dataview. You can add up to 50 tags to a dataview.\n
" + } + }, + "clientToken": { + "target": "com.amazonaws.finspace#ClientTokenString", + "traits": { + "smithy.api#documentation": "A token that ensures idempotency. This token expires in 10 minutes.
", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + } }, - { - "documentation": "Missing region", - "expect": { - "error": "Invalid Configuration: Missing Region" - } + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.finspace#CreateKxDataviewResponse": { + "type": "structure", + "members": { + "dataviewName": { + "target": "com.amazonaws.finspace#KxDataviewName", + "traits": { + "smithy.api#documentation": "A unique identifier for the dataview.
" + } + }, + "databaseName": { + "target": "com.amazonaws.finspace#DatabaseName", + "traits": { + "smithy.api#documentation": "The name of the database where you want to create a dataview.
" + } + }, + "environmentId": { + "target": "com.amazonaws.finspace#EnvironmentId", + "traits": { + "smithy.api#documentation": "A unique identifier for the kdb environment, where you want to create the dataview.
" + } + }, + "azMode": { + "target": "com.amazonaws.finspace#KxAzMode", + "traits": { + "smithy.api#documentation": "The number of availability zones you want to assign per volume. Currently, FinSpace only supports SINGLE for volumes. This places dataview in a single AZ.
\n The identifier of the availability zones.\n
" + } + }, + "changesetId": { + "target": "com.amazonaws.finspace#ChangesetId", + "traits": { + "smithy.api#documentation": "A unique identifier for the changeset.
" + } + }, + "segmentConfigurations": { + "target": "com.amazonaws.finspace#KxDataviewSegmentConfigurationList", + "traits": { + "smithy.api#documentation": "\n The configuration that contains the database path of the data that you want to place on each selected volume. Each segment must have a unique database path for each volume. If you do not explicitly specify any database path for a volume, they are accessible from the cluster through the default S3/object store segment.
" + } + }, + "description": { + "target": "com.amazonaws.finspace#Description", + "traits": { + "smithy.api#documentation": "A description of the dataview.
" + } + }, + "autoUpdate": { + "target": "com.amazonaws.finspace#booleanValue", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "The option to select whether you want to apply all the future additions and corrections automatically to the dataview when you ingest new changesets. The default value is false.
" + } + }, + "readWrite": { + "target": "com.amazonaws.finspace#booleanValue", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Returns True if the dataview is created as writeable and False otherwise.
" + } + }, + "createdTimestamp": { + "target": "com.amazonaws.finspace#Timestamp", + "traits": { + "smithy.api#documentation": "\nThe timestamp at which the dataview was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" + } + }, + "lastModifiedTimestamp": { + "target": "com.amazonaws.finspace#Timestamp", + "traits": { + "smithy.api#documentation": "\nThe last time that the dataview was updated in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" + } + }, + "status": { + "target": "com.amazonaws.finspace#KxDataviewStatus", + "traits": { + "smithy.api#documentation": "\nThe status of dataview creation.
\n\n CREATING – The dataview creation is in progress.
\n UPDATING – The dataview is in the process of being updated.
\n ACTIVE – The dataview is active.
Creates a managed kdb environment for the account.
", + "smithy.api#http": { + "method": "POST", + "uri": "/kx/environments", + "code": 200 + } + } + }, + "com.amazonaws.finspace#CreateKxEnvironmentRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.finspace#KxEnvironmentName", + "traits": { + "smithy.api#documentation": "The name of the kdb environment that you want to create.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.finspace#Description", + "traits": { + "smithy.api#documentation": "A description for the kdb environment.
" + } + }, + "kmsKeyId": { + "target": "com.amazonaws.finspace#KmsKeyARN", + "traits": { + "smithy.api#documentation": "The KMS key ID to encrypt your data in the FinSpace environment.
", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.finspace#TagMap", + "traits": { + "smithy.api#documentation": "A list of key-value pairs to label the kdb environment. You can add up to 50 tags to your kdb environment.
" + } + }, + "clientToken": { + "target": "com.amazonaws.finspace#ClientToken", + "traits": { + "smithy.api#documentation": "A token that ensures idempotency. This token expires in 10 minutes.
", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.finspace#CreateKxEnvironmentResponse": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.finspace#KxEnvironmentName", + "traits": { + "smithy.api#documentation": "The name of the kdb environment.
" + } + }, + "status": { + "target": "com.amazonaws.finspace#EnvironmentStatus", + "traits": { + "smithy.api#documentation": "The status of the kdb environment.
" + } + }, + "environmentId": { + "target": "com.amazonaws.finspace#IdType", + "traits": { + "smithy.api#documentation": "A unique identifier for the kdb environment.
" + } + }, + "description": { + "target": "com.amazonaws.finspace#Description", + "traits": { + "smithy.api#documentation": "A description for the kdb environment.
" + } + }, + "environmentArn": { + "target": "com.amazonaws.finspace#EnvironmentArn", + "traits": { + "smithy.api#documentation": "The ARN identifier of the environment.
" + } + }, + "kmsKeyId": { + "target": "com.amazonaws.finspace#KmsKeyId", + "traits": { + "smithy.api#documentation": "The KMS key ID to encrypt your data in the FinSpace environment.
" + } + }, + "creationTimestamp": { + "target": "com.amazonaws.finspace#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp at which the kdb environment was created in FinSpace.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.finspace#CreateKxScalingGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.finspace#CreateKxScalingGroupRequest" + }, + "output": { + "target": "com.amazonaws.finspace#CreateKxScalingGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.finspace#AccessDeniedException" + }, + { + "target": "com.amazonaws.finspace#ConflictException" + }, + { + "target": "com.amazonaws.finspace#InternalServerException" + }, + { + "target": "com.amazonaws.finspace#LimitExceededException" + }, + { + "target": "com.amazonaws.finspace#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.finspace#ThrottlingException" + }, + { + "target": "com.amazonaws.finspace#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a new scaling group.
", + "smithy.api#http": { + "method": "POST", + "uri": "/kx/environments/{environmentId}/scalingGroups", + "code": 200 + } + } + }, + "com.amazonaws.finspace#CreateKxScalingGroupRequest": { + "type": "structure", + "members": { + "clientToken": { + "target": "com.amazonaws.finspace#ClientToken", + "traits": { + "smithy.api#documentation": "A token that ensures idempotency. This token expires in 10 minutes.
", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + }, + "environmentId": { + "target": "com.amazonaws.finspace#KxEnvironmentId", + "traits": { + "smithy.api#documentation": "A unique identifier for the kdb environment, where you want to create the scaling group.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "scalingGroupName": { + "target": "com.amazonaws.finspace#KxScalingGroupName", + "traits": { + "smithy.api#documentation": "A unique identifier for the kdb scaling group.
", + "smithy.api#required": {} + } + }, + "hostType": { + "target": "com.amazonaws.finspace#KxHostType", + "traits": { + "smithy.api#documentation": "\n The memory and CPU capabilities of the scaling group host on which FinSpace Managed kdb clusters will be placed.
\nYou can add one of the following values:
\n\n kx.sg.large – The host type with a configuration of 16 GiB\n memory and 2 vCPUs.
\n kx.sg.xlarge – The host type with a configuration of 32 GiB\n memory and 4 vCPUs.
\n kx.sg.2xlarge – The host type with a configuration of 64 GiB\n memory and 8 vCPUs.
\n kx.sg.4xlarge – The host type with a configuration of 108 GiB memory and 16 vCPUs.
\n kx.sg.8xlarge – The host type with a configuration of 216 GiB memory and 32 vCPUs.
\n kx.sg.16xlarge – The host type with a configuration of 432 GiB memory and 64 vCPUs.
\n kx.sg.32xlarge – The host type with a configuration of 864 GiB memory and 128 vCPUs.
\n kx.sg1.16xlarge – The host type with a configuration of 1949 GiB memory and 64 vCPUs.
\n kx.sg1.24xlarge – The host type with a configuration of 2948 GiB memory and 96 vCPUs.
The identifier of the availability zones.
", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.finspace#TagMap", + "traits": { + "smithy.api#documentation": "\nA list of key-value pairs to label the scaling group. You can add up to 50 tags to a scaling group.\n
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.finspace#CreateKxScalingGroupResponse": { + "type": "structure", + "members": { + "environmentId": { + "target": "com.amazonaws.finspace#KxEnvironmentId", + "traits": { + "smithy.api#documentation": "A unique identifier for the kdb environment, where you create the scaling group.
" + } + }, + "scalingGroupName": { + "target": "com.amazonaws.finspace#KxScalingGroupName", + "traits": { + "smithy.api#documentation": "A unique identifier for the kdb scaling group.
" + } + }, + "hostType": { + "target": "com.amazonaws.finspace#KxHostType", + "traits": { + "smithy.api#documentation": "\n The memory and CPU capabilities of the scaling group host on which FinSpace Managed kdb clusters will be placed.\n \n
" + } + }, + "availabilityZoneId": { + "target": "com.amazonaws.finspace#AvailabilityZoneId", + "traits": { + "smithy.api#documentation": "The identifier of the availability zones.
" + } + }, + "status": { + "target": "com.amazonaws.finspace#KxScalingGroupStatus", + "traits": { + "smithy.api#documentation": "The status of scaling group.
\nCREATING – The scaling group creation is in progress.
\nCREATE_FAILED – The scaling group creation has failed.
\nACTIVE – The scaling group is active.
\nUPDATING – The scaling group is in the process of being updated.
\nUPDATE_FAILED – The update action failed.
\nDELETING – The scaling group is in the process of being deleted.
\nDELETE_FAILED – The system failed to delete the scaling group.
\nDELETED – The scaling group is successfully deleted.
\n\nThe last time that the scaling group was updated in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" + } + }, + "createdTimestamp": { + "target": "com.amazonaws.finspace#Timestamp", + "traits": { + "smithy.api#documentation": "\n The timestamp at which the scaling group was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.finspace#CreateKxUser": { + "type": "operation", + "input": { + "target": "com.amazonaws.finspace#CreateKxUserRequest" + }, + "output": { + "target": "com.amazonaws.finspace#CreateKxUserResponse" + }, + "errors": [ + { + "target": "com.amazonaws.finspace#AccessDeniedException" + }, + { + "target": "com.amazonaws.finspace#ConflictException" + }, + { + "target": "com.amazonaws.finspace#InternalServerException" + }, + { + "target": "com.amazonaws.finspace#LimitExceededException" + }, + { + "target": "com.amazonaws.finspace#ResourceAlreadyExistsException" + }, + { + "target": "com.amazonaws.finspace#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.finspace#ThrottlingException" + }, + { + "target": "com.amazonaws.finspace#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a user in FinSpace kdb environment with an associated IAM role.
", + "smithy.api#http": { + "method": "POST", + "uri": "/kx/environments/{environmentId}/users", + "code": 200 + } + } + }, + "com.amazonaws.finspace#CreateKxUserRequest": { + "type": "structure", + "members": { + "environmentId": { + "target": "com.amazonaws.finspace#IdType", + "traits": { + "smithy.api#documentation": "A unique identifier for the kdb environment where you want to create a user.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "userName": { + "target": "com.amazonaws.finspace#KxUserNameString", + "traits": { + "smithy.api#documentation": "A unique identifier for the user.
", + "smithy.api#required": {} + } + }, + "iamRole": { + "target": "com.amazonaws.finspace#RoleArn", + "traits": { + "smithy.api#documentation": "The IAM role ARN that will be associated with the user.
", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.finspace#TagMap", + "traits": { + "smithy.api#documentation": "A list of key-value pairs to label the user. You can add up to 50 tags to a user.
" + } + }, + "clientToken": { + "target": "com.amazonaws.finspace#ClientToken", + "traits": { + "smithy.api#documentation": "A token that ensures idempotency. This token expires in 10 minutes.
", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.finspace#CreateKxUserResponse": { + "type": "structure", + "members": { + "userName": { + "target": "com.amazonaws.finspace#KxUserNameString", + "traits": { + "smithy.api#documentation": "A unique identifier for the user.
" + } + }, + "userArn": { + "target": "com.amazonaws.finspace#KxUserArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies the user. For more information about ARNs and\n how to use ARNs in policies, see IAM Identifiers in the\n IAM User Guide.
" + } + }, + "environmentId": { + "target": "com.amazonaws.finspace#IdType", + "traits": { + "smithy.api#documentation": "A unique identifier for the kdb environment.
" + } + }, + "iamRole": { + "target": "com.amazonaws.finspace#RoleArn", + "traits": { + "smithy.api#documentation": "The IAM role ARN that will be associated with the user.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.finspace#CreateKxVolume": { + "type": "operation", + "input": { + "target": "com.amazonaws.finspace#CreateKxVolumeRequest" + }, + "output": { + "target": "com.amazonaws.finspace#CreateKxVolumeResponse" + }, + "errors": [ + { + "target": "com.amazonaws.finspace#AccessDeniedException" + }, + { + "target": "com.amazonaws.finspace#ConflictException" + }, + { + "target": "com.amazonaws.finspace#InternalServerException" + }, + { + "target": "com.amazonaws.finspace#LimitExceededException" + }, + { + "target": "com.amazonaws.finspace#ResourceAlreadyExistsException" + }, + { + "target": "com.amazonaws.finspace#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.finspace#ThrottlingException" + }, + { + "target": "com.amazonaws.finspace#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "\nCreates a new volume with a specific amount of throughput and storage capacity.
", + "smithy.api#http": { + "method": "POST", + "uri": "/kx/environments/{environmentId}/kxvolumes", + "code": 200 + } + } + }, + "com.amazonaws.finspace#CreateKxVolumeRequest": { + "type": "structure", + "members": { + "clientToken": { + "target": "com.amazonaws.finspace#ClientToken", + "traits": { + "smithy.api#documentation": "A token that ensures idempotency. This token expires in 10 minutes.
", + "smithy.api#idempotencyToken": {} + } + }, + "environmentId": { + "target": "com.amazonaws.finspace#KxEnvironmentId", + "traits": { + "smithy.api#documentation": "A unique identifier for the kdb environment, whose clusters can attach to the volume.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "volumeType": { + "target": "com.amazonaws.finspace#KxVolumeType", + "traits": { + "smithy.api#documentation": "\n The type of file system volume. Currently, FinSpace only supports NAS_1 volume type. When you select NAS_1 volume type, you must also provide nas1Configuration.\n
A unique identifier for the volume.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.finspace#Description", + "traits": { + "smithy.api#documentation": "\nA description of the volume.\n
" + } + }, + "nas1Configuration": { + "target": "com.amazonaws.finspace#KxNAS1Configuration", + "traits": { + "smithy.api#documentation": " Specifies the configuration for the Network attached storage (NAS_1) file system volume. This\n parameter is required when you choose volumeType as\n NAS_1.
The number of availability zones you want to assign per volume. Currently, FinSpace only supports SINGLE for volumes. This places dataview in a single AZ.
The identifier of the availability zones.
", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.finspace#TagMap", + "traits": { + "smithy.api#documentation": "\nA list of key-value pairs to label the volume. You can add up to 50 tags to a volume.\n
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.finspace#CreateKxVolumeResponse": { + "type": "structure", + "members": { + "environmentId": { + "target": "com.amazonaws.finspace#KxEnvironmentId", + "traits": { + "smithy.api#documentation": "A unique identifier for the kdb environment, whose clusters can attach to the volume.
" + } + }, + "volumeName": { + "target": "com.amazonaws.finspace#KxVolumeName", + "traits": { + "smithy.api#documentation": "A unique identifier for the volume.
" + } + }, + "volumeType": { + "target": "com.amazonaws.finspace#KxVolumeType", + "traits": { + "smithy.api#documentation": "\n The type of file system volume. Currently, FinSpace only supports NAS_1 volume type.\n
\nThe ARN identifier of the volume.\n
" + } + }, + "nas1Configuration": { + "target": "com.amazonaws.finspace#KxNAS1Configuration", + "traits": { + "smithy.api#documentation": "Specifies the configuration for the Network attached storage (NAS_1) file system volume.
" + } + }, + "status": { + "target": "com.amazonaws.finspace#KxVolumeStatus", + "traits": { + "smithy.api#documentation": "The status of volume creation.
\nCREATING – The volume creation is in progress.
\nCREATE_FAILED – The volume creation has failed.
\nACTIVE – The volume is active.
\nUPDATING – The volume is in the process of being updated.
\nUPDATE_FAILED – The update action failed.
\nUPDATED – The volume is successfully updated.
\nDELETING – The volume is in the process of being deleted.
\nDELETE_FAILED – The system failed to delete the volume.
\nDELETED – The volume is successfully deleted.
\nThe error message when a failed state occurs.
" + } + }, + "azMode": { + "target": "com.amazonaws.finspace#KxAzMode", + "traits": { + "smithy.api#documentation": "The number of availability zones you want to assign per volume. Currently, FinSpace only supports SINGLE for volumes. This places dataview in a single AZ.
\nA description of the volume.\n
" + } + }, + "availabilityZoneIds": { + "target": "com.amazonaws.finspace#AvailabilityZoneIds", + "traits": { + "smithy.api#documentation": "The identifier of the availability zones.
" + } + }, + "createdTimestamp": { + "target": "com.amazonaws.finspace#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp at which the volume was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.finspace#CustomDNSConfiguration": { + "type": "list", + "member": { + "target": "com.amazonaws.finspace#CustomDNSServer" + } + }, + "com.amazonaws.finspace#CustomDNSServer": { + "type": "structure", + "members": { + "customDNSServerName": { + "target": "com.amazonaws.finspace#ValidHostname", + "traits": { + "smithy.api#documentation": "The name of the DNS server.
", + "smithy.api#required": {} + } + }, + "customDNSServerIP": { + "target": "com.amazonaws.finspace#ValidIPAddress", + "traits": { + "smithy.api#documentation": "The IP address of the DNS server.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A list of DNS server name and server IP. This is used to set up Route-53 outbound resolvers.
" + } + }, + "com.amazonaws.finspace#DataBundleArn": { + "type": "string", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the data bundle.
", + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws:finspace:[A-Za-z0-9_/.-]{0,63}:\\d*:data-bundle/[0-9A-Za-z_-]{1,128}$" + } + }, + "com.amazonaws.finspace#DataBundleArns": { + "type": "list", + "member": { + "target": "com.amazonaws.finspace#DataBundleArn" + } + }, + "com.amazonaws.finspace#DatabaseArn": { + "type": "string" + }, + "com.amazonaws.finspace#DatabaseName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_]*[a-zA-Z0-9]$" + } + }, + "com.amazonaws.finspace#DbPath": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1025 + }, + "smithy.api#pattern": "^(\\*)*[\\/\\?\\*]([^\\/]+\\/){0,2}[^\\/]*$" + } + }, + "com.amazonaws.finspace#DbPaths": { + "type": "list", + "member": { + "target": "com.amazonaws.finspace#DbPath" + } + }, + "com.amazonaws.finspace#DeleteEnvironment": { + "type": "operation", + "input": { + "target": "com.amazonaws.finspace#DeleteEnvironmentRequest" + }, + "output": { + "target": "com.amazonaws.finspace#DeleteEnvironmentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.finspace#AccessDeniedException" + }, + { + "target": "com.amazonaws.finspace#InternalServerException" + }, + { + "target": "com.amazonaws.finspace#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.finspace#ThrottlingException" + }, + { + "target": "com.amazonaws.finspace#ValidationException" + } + ], + "traits": { + "smithy.api#deprecated": { + "message": "This method will be discontinued." + }, + "smithy.api#documentation": "Delete an FinSpace environment.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/environment/{environmentId}", + "code": 200 + } + } + }, + "com.amazonaws.finspace#DeleteEnvironmentRequest": { + "type": "structure", + "members": { + "environmentId": { + "target": "com.amazonaws.finspace#IdType", + "traits": { + "smithy.api#documentation": "The identifier for the FinSpace environment.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.finspace#DeleteEnvironmentResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.finspace#DeleteKxCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.finspace#DeleteKxClusterRequest" + }, + "output": { + "target": "com.amazonaws.finspace#DeleteKxClusterResponse" + }, + "errors": [ + { + "target": "com.amazonaws.finspace#AccessDeniedException" + }, + { + "target": "com.amazonaws.finspace#ConflictException" + }, + { + "target": "com.amazonaws.finspace#InternalServerException" + }, + { + "target": "com.amazonaws.finspace#LimitExceededException" + }, + { + "target": "com.amazonaws.finspace#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.finspace#ThrottlingException" + }, + { + "target": "com.amazonaws.finspace#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a kdb cluster.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/kx/environments/{environmentId}/clusters/{clusterName}", + "code": 200 + } + } + }, + "com.amazonaws.finspace#DeleteKxClusterNode": { + "type": "operation", + "input": { + "target": "com.amazonaws.finspace#DeleteKxClusterNodeRequest" + }, + "output": { + "target": "com.amazonaws.finspace#DeleteKxClusterNodeResponse" + }, + "errors": [ + { + "target": "com.amazonaws.finspace#AccessDeniedException" + }, + { + "target": "com.amazonaws.finspace#InternalServerException" + }, + { + "target": "com.amazonaws.finspace#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.finspace#ThrottlingException" + }, + { + "target": "com.amazonaws.finspace#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes the specified nodes from a cluster.\n
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/kx/environments/{environmentId}/clusters/{clusterName}/nodes/{nodeId}", + "code": 200 + } + } + }, + "com.amazonaws.finspace#DeleteKxClusterNodeRequest": { + "type": "structure", + "members": { + "environmentId": { + "target": "com.amazonaws.finspace#KxEnvironmentId", + "traits": { + "smithy.api#documentation": "A unique identifier for the kdb environment.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "clusterName": { + "target": "com.amazonaws.finspace#KxClusterName", + "traits": { + "smithy.api#documentation": "The name of the cluster, for which you want to delete the nodes.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "nodeId": { + "target": "com.amazonaws.finspace#KxClusterNodeIdString", + "traits": { + "smithy.api#documentation": "A unique identifier for the node that you want to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.finspace#DeleteKxClusterNodeResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.finspace#DeleteKxClusterRequest": { + "type": "structure", + "members": { + "environmentId": { + "target": "com.amazonaws.finspace#KxEnvironmentId", + "traits": { + "smithy.api#documentation": "A unique identifier for the kdb environment.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "clusterName": { + "target": "com.amazonaws.finspace#KxClusterName", + "traits": { + "smithy.api#documentation": "The name of the cluster that you want to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.finspace#ClientTokenString", + "traits": { + "smithy.api#documentation": "A token that ensures idempotency. This token expires in 10 minutes.
", + "smithy.api#httpQuery": "clientToken", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.finspace#DeleteKxClusterResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.finspace#DeleteKxDatabase": { + "type": "operation", + "input": { + "target": "com.amazonaws.finspace#DeleteKxDatabaseRequest" + }, + "output": { + "target": "com.amazonaws.finspace#DeleteKxDatabaseResponse" + }, + "errors": [ + { + "target": "com.amazonaws.finspace#AccessDeniedException" + }, + { + "target": "com.amazonaws.finspace#ConflictException" + }, + { + "target": "com.amazonaws.finspace#InternalServerException" + }, + { + "target": "com.amazonaws.finspace#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.finspace#ThrottlingException" + }, + { + "target": "com.amazonaws.finspace#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes the specified database and all of its associated data. This action is irreversible. You must copy any data out of the database before deleting it if the data is to be retained.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/kx/environments/{environmentId}/databases/{databaseName}", + "code": 200 + } + } + }, + "com.amazonaws.finspace#DeleteKxDatabaseRequest": { + "type": "structure", + "members": { + "environmentId": { + "target": "com.amazonaws.finspace#EnvironmentId", + "traits": { + "smithy.api#documentation": "A unique identifier for the kdb environment.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "databaseName": { + "target": "com.amazonaws.finspace#DatabaseName", + "traits": { + "smithy.api#documentation": "The name of the kdb database that you want to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.finspace#ClientTokenString", + "traits": { + "smithy.api#documentation": "A token that ensures idempotency. This token expires in 10 minutes.
", + "smithy.api#httpQuery": "clientToken", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.finspace#DeleteKxDatabaseResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.finspace#DeleteKxDataview": { + "type": "operation", + "input": { + "target": "com.amazonaws.finspace#DeleteKxDataviewRequest" + }, + "output": { + "target": "com.amazonaws.finspace#DeleteKxDataviewResponse" + }, + "errors": [ + { + "target": "com.amazonaws.finspace#AccessDeniedException" + }, + { + "target": "com.amazonaws.finspace#ConflictException" + }, + { + "target": "com.amazonaws.finspace#InternalServerException" + }, + { + "target": "com.amazonaws.finspace#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.finspace#ThrottlingException" + }, + { + "target": "com.amazonaws.finspace#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "\nDeletes the specified dataview. Before deleting a dataview, make sure that it is not in use by any cluster.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/kx/environments/{environmentId}/databases/{databaseName}/dataviews/{dataviewName}", + "code": 200 + } + } + }, + "com.amazonaws.finspace#DeleteKxDataviewRequest": { + "type": "structure", + "members": { + "environmentId": { + "target": "com.amazonaws.finspace#EnvironmentId", + "traits": { + "smithy.api#documentation": "A unique identifier for the kdb environment, from where you want to delete the dataview.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "databaseName": { + "target": "com.amazonaws.finspace#DatabaseName", + "traits": { + "smithy.api#documentation": "The name of the database whose dataview you want to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "dataviewName": { + "target": "com.amazonaws.finspace#KxDataviewName", + "traits": { + "smithy.api#documentation": "The name of the dataview that you want to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.finspace#ClientTokenString", + "traits": { + "smithy.api#documentation": "A token that ensures idempotency. This token expires in 10 minutes.
", + "smithy.api#httpQuery": "clientToken", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.finspace#DeleteKxDataviewResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.finspace#DeleteKxEnvironment": { + "type": "operation", + "input": { + "target": "com.amazonaws.finspace#DeleteKxEnvironmentRequest" + }, + "output": { + "target": "com.amazonaws.finspace#DeleteKxEnvironmentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.finspace#AccessDeniedException" + }, + { + "target": "com.amazonaws.finspace#ConflictException" + }, + { + "target": "com.amazonaws.finspace#InternalServerException" + }, + { + "target": "com.amazonaws.finspace#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.finspace#ThrottlingException" + }, + { + "target": "com.amazonaws.finspace#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes the kdb environment. This action is irreversible. Deleting a kdb environment will remove all the associated data and any services running in it.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/kx/environments/{environmentId}", + "code": 200 + } + } + }, + "com.amazonaws.finspace#DeleteKxEnvironmentRequest": { + "type": "structure", + "members": { + "environmentId": { + "target": "com.amazonaws.finspace#IdType", + "traits": { + "smithy.api#documentation": "A unique identifier for the kdb environment.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.finspace#ClientToken", + "traits": { + "smithy.api#documentation": "A token that ensures idempotency. This token expires in 10 minutes.
", + "smithy.api#httpQuery": "clientToken", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.finspace#DeleteKxEnvironmentResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.finspace#DeleteKxScalingGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.finspace#DeleteKxScalingGroupRequest" + }, + "output": { + "target": "com.amazonaws.finspace#DeleteKxScalingGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.finspace#AccessDeniedException" + }, + { + "target": "com.amazonaws.finspace#ConflictException" + }, + { + "target": "com.amazonaws.finspace#InternalServerException" + }, + { + "target": "com.amazonaws.finspace#LimitExceededException" + }, + { + "target": "com.amazonaws.finspace#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.finspace#ThrottlingException" + }, + { + "target": "com.amazonaws.finspace#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "\nDeletes the specified scaling group. This action is irreversible. You cannot delete a scaling group until all the clusters running on it have been deleted.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/kx/environments/{environmentId}/scalingGroups/{scalingGroupName}", + "code": 200 + } + } + }, + "com.amazonaws.finspace#DeleteKxScalingGroupRequest": { + "type": "structure", + "members": { + "environmentId": { + "target": "com.amazonaws.finspace#KxEnvironmentId", + "traits": { + "smithy.api#documentation": "A unique identifier for the kdb environment, from where you want to delete the dataview.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "scalingGroupName": { + "target": "com.amazonaws.finspace#KxScalingGroupName", + "traits": { + "smithy.api#documentation": "A unique identifier for the kdb scaling group.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.finspace#ClientTokenString", + "traits": { + "smithy.api#documentation": "A token that ensures idempotency. This token expires in 10 minutes.
", + "smithy.api#httpQuery": "clientToken", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.finspace#DeleteKxScalingGroupResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.finspace#DeleteKxUser": { + "type": "operation", + "input": { + "target": "com.amazonaws.finspace#DeleteKxUserRequest" + }, + "output": { + "target": "com.amazonaws.finspace#DeleteKxUserResponse" + }, + "errors": [ + { + "target": "com.amazonaws.finspace#AccessDeniedException" + }, + { + "target": "com.amazonaws.finspace#ConflictException" + }, + { + "target": "com.amazonaws.finspace#InternalServerException" + }, + { + "target": "com.amazonaws.finspace#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.finspace#ThrottlingException" + }, + { + "target": "com.amazonaws.finspace#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a user in the specified kdb environment.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/kx/environments/{environmentId}/users/{userName}", + "code": 200 + } + } + }, + "com.amazonaws.finspace#DeleteKxUserRequest": { + "type": "structure", + "members": { + "userName": { + "target": "com.amazonaws.finspace#KxUserNameString", + "traits": { + "smithy.api#documentation": "A unique identifier for the user that you want to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "environmentId": { + "target": "com.amazonaws.finspace#IdType", + "traits": { + "smithy.api#documentation": "A unique identifier for the kdb environment.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.finspace#ClientToken", + "traits": { + "smithy.api#documentation": "A token that ensures idempotency. This token expires in 10 minutes.
", + "smithy.api#httpQuery": "clientToken", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.finspace#DeleteKxUserResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.finspace#DeleteKxVolume": { + "type": "operation", + "input": { + "target": "com.amazonaws.finspace#DeleteKxVolumeRequest" + }, + "output": { + "target": "com.amazonaws.finspace#DeleteKxVolumeResponse" + }, + "errors": [ + { + "target": "com.amazonaws.finspace#AccessDeniedException" + }, + { + "target": "com.amazonaws.finspace#ConflictException" + }, + { + "target": "com.amazonaws.finspace#InternalServerException" + }, + { + "target": "com.amazonaws.finspace#LimitExceededException" + }, + { + "target": "com.amazonaws.finspace#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.finspace#ThrottlingException" + }, + { + "target": "com.amazonaws.finspace#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "\n Deletes a volume. You can only delete a volume if it's not attached to a cluster or a dataview. When a volume is deleted, any data on the volume is lost. This action is irreversible.\n\n
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/kx/environments/{environmentId}/kxvolumes/{volumeName}", + "code": 200 + } + } + }, + "com.amazonaws.finspace#DeleteKxVolumeRequest": { + "type": "structure", + "members": { + "environmentId": { + "target": "com.amazonaws.finspace#KxEnvironmentId", + "traits": { + "smithy.api#documentation": "A unique identifier for the kdb environment, whose clusters can attach to the volume.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "volumeName": { + "target": "com.amazonaws.finspace#KxVolumeName", + "traits": { + "smithy.api#documentation": "\nThe name of the volume that you want to delete.\n
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.finspace#ClientTokenString", + "traits": { + "smithy.api#documentation": "A token that ensures idempotency. This token expires in 10 minutes.
", + "smithy.api#httpQuery": "clientToken", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.finspace#DeleteKxVolumeResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.finspace#Description": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1000 + }, + "smithy.api#pattern": "^[a-zA-Z0-9. ]{1,1000}$" + } + }, + "com.amazonaws.finspace#EmailId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[A-Z0-9a-z._%+-]+@[A-Za-z0-9.-]+[.]+[A-Za-z]+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.finspace#Environment": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.finspace#EnvironmentName", + "traits": { + "smithy.api#documentation": "The name of the FinSpace environment.
" + } + }, + "environmentId": { + "target": "com.amazonaws.finspace#IdType", + "traits": { + "smithy.api#documentation": "The identifier of the FinSpace environment.
" + } + }, + "awsAccountId": { + "target": "com.amazonaws.finspace#IdType", + "traits": { + "smithy.api#documentation": "The ID of the AWS account in which the FinSpace environment is created.
" + } + }, + "status": { + "target": "com.amazonaws.finspace#EnvironmentStatus", + "traits": { + "smithy.api#documentation": "The current status of creation of the FinSpace environment.
" + } + }, + "environmentUrl": { + "target": "com.amazonaws.finspace#url", + "traits": { + "smithy.api#documentation": "The sign-in URL for the web application of your FinSpace environment.
" + } + }, + "description": { + "target": "com.amazonaws.finspace#Description", + "traits": { + "smithy.api#documentation": "The description of the FinSpace environment.
" + } + }, + "environmentArn": { + "target": "com.amazonaws.finspace#EnvironmentArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of your FinSpace environment.
" + } + }, + "sageMakerStudioDomainUrl": { + "target": "com.amazonaws.finspace#SmsDomainUrl", + "traits": { + "smithy.api#documentation": "The URL of the integrated FinSpace notebook environment in your web application.
" + } + }, + "kmsKeyId": { + "target": "com.amazonaws.finspace#KmsKeyId", + "traits": { + "smithy.api#documentation": "The KMS key id used to encrypt in the FinSpace environment.
" + } + }, + "dedicatedServiceAccountId": { + "target": "com.amazonaws.finspace#IdType", + "traits": { + "smithy.api#documentation": "The AWS account ID of the dedicated service account associated with your FinSpace\n environment.
" + } + }, + "federationMode": { + "target": "com.amazonaws.finspace#FederationMode", + "traits": { + "smithy.api#documentation": "The authentication mode for the environment.
" + } + }, + "federationParameters": { + "target": "com.amazonaws.finspace#FederationParameters", + "traits": { + "smithy.api#documentation": "Configuration information when authentication mode is FEDERATED.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents an FinSpace environment.
" + } + }, + "com.amazonaws.finspace#EnvironmentArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws:finspace:[A-Za-z0-9_/.-]{0,63}:\\d+:environment/[0-9A-Za-z_-]{1,128}$" + } + }, + "com.amazonaws.finspace#EnvironmentErrorMessage": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1000 + }, + "smithy.api#pattern": "^[a-zA-Z0-9. ]{1,1000}$" + } + }, + "com.amazonaws.finspace#EnvironmentId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 32 + }, + "smithy.api#pattern": "\\S" + } + }, + "com.amazonaws.finspace#EnvironmentList": { + "type": "list", + "member": { + "target": "com.amazonaws.finspace#Environment" + } + }, + "com.amazonaws.finspace#EnvironmentName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]$" + } + }, + "com.amazonaws.finspace#EnvironmentStatus": { + "type": "enum", + "members": { + "CREATE_REQUESTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_REQUESTED" + } + }, + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "CREATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATED" + } + }, + "DELETE_REQUESTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_REQUESTED" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" + } + }, + "FAILED_CREATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED_CREATION" + } + }, + "RETRY_DELETION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RETRY_DELETION" + } + }, + "FAILED_DELETION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED_DELETION" + } + }, + "UPDATE_NETWORK_REQUESTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_NETWORK_REQUESTED" + } + }, + "UPDATING_NETWORK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING_NETWORK" + } + }, + "FAILED_UPDATING_NETWORK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED_UPDATING_NETWORK" + } + }, + "SUSPENDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUSPENDED" + } + } + } + }, + "com.amazonaws.finspace#ErrorDetails": { + "type": "enum", + "members": { + "VALIDATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "The inputs to this request are invalid." + } + }, + "SERVICE_QUOTA_EXCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Service limits have been exceeded." + } + }, + "ACCESS_DENIED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Missing required permission to perform this request." + } + }, + "RESOURCE_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "One or more inputs to this request were not found." + } + }, + "THROTTLING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "The system temporarily lacks sufficient resources to process the request." + } + }, + "INTERNAL_SERVICE_EXCEPTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "An internal error has occurred." + } + }, + "CANCELLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Cancelled" + } + }, + "USER_RECOVERABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "A user recoverable error has occurred" + } + } + } + }, + "com.amazonaws.finspace#ErrorInfo": { + "type": "structure", + "members": { + "errorMessage": { + "target": "com.amazonaws.finspace#ErrorMessage", + "traits": { + "smithy.api#documentation": "Specifies the error message that appears if a flow fails.
" + } + }, + "errorType": { + "target": "com.amazonaws.finspace#ErrorDetails", + "traits": { + "smithy.api#documentation": "Specifies the type of error.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides details in the event of a failed flow, including the error type and the related error message.
" + } + }, + "com.amazonaws.finspace#ErrorMessage": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1000 + } + } + }, + "com.amazonaws.finspace#ErrorMessage2": { + "type": "string" + }, + "com.amazonaws.finspace#ExecutionRoleArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^arn:aws[a-z0-9-]*:iam::\\d{12}:role\\/[\\w-\\/.@+=,]{1,1017}$" + } + }, + "com.amazonaws.finspace#FederationAttributeKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 32 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.finspace#FederationAttributeValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1000 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.finspace#FederationMode": { + "type": "enum", + "members": { + "FEDERATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FEDERATED" + } + }, + "LOCAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LOCAL" + } + } + } + }, + "com.amazonaws.finspace#FederationParameters": { + "type": "structure", + "members": { + "samlMetadataDocument": { + "target": "com.amazonaws.finspace#SamlMetadataDocument", + "traits": { + "smithy.api#documentation": "SAML 2.0 Metadata document from identity provider (IdP).
" + } + }, + "samlMetadataURL": { + "target": "com.amazonaws.finspace#url", + "traits": { + "smithy.api#documentation": "Provide the metadata URL from your SAML 2.0 compliant identity provider (IdP).
" + } + }, + "applicationCallBackURL": { + "target": "com.amazonaws.finspace#url", + "traits": { + "smithy.api#documentation": "The redirect or sign-in URL that should be entered into the SAML 2.0 compliant identity provider configuration\n (IdP).
" + } + }, + "federationURN": { + "target": "com.amazonaws.finspace#urn", + "traits": { + "smithy.api#documentation": "The Uniform Resource Name (URN). Also referred as Service Provider URN or Audience URI or Service Provider Entity ID.
" + } + }, + "federationProviderName": { + "target": "com.amazonaws.finspace#FederationProviderName", + "traits": { + "smithy.api#documentation": "Name of the identity provider (IdP).
" + } + }, + "attributeMap": { + "target": "com.amazonaws.finspace#AttributeMap", + "traits": { + "smithy.api#documentation": "SAML attribute name and value. The name must always be Email and the value should be set to\n the attribute definition in which user email is set. For example, name would be Email and\n value http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress.\n Please check your SAML 2.0 compliant identity provider (IdP) documentation for details.
Configuration information when authentication mode is FEDERATED.
" + } + }, + "com.amazonaws.finspace#FederationProviderName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 32 + }, + "smithy.api#pattern": "^[^_\\p{Z}][\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}][^_\\p{Z}]+$" + } + }, + "com.amazonaws.finspace#FinSpaceTaggableArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws:finspace:[A-Za-z0-9_/.-]{0,63}:\\d+:(environment|kxEnvironment)/[0-9A-Za-z_-]{1,128}(/(kxCluster|kxUser|kxVolume|kxScalingGroup)/[a-zA-Z0-9_-]{1,255}|/(kxDatabase/[a-zA-Z0-9_-]{1,255}(/kxDataview/[a-zA-Z0-9_-]{1,255})?))?$" + } + }, + "com.amazonaws.finspace#GetEnvironment": { + "type": "operation", + "input": { + "target": "com.amazonaws.finspace#GetEnvironmentRequest" + }, + "output": { + "target": "com.amazonaws.finspace#GetEnvironmentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.finspace#AccessDeniedException" + }, + { + "target": "com.amazonaws.finspace#InternalServerException" + }, + { + "target": "com.amazonaws.finspace#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.finspace#ValidationException" + } + ], + "traits": { + "smithy.api#deprecated": { + "message": "This method will be discontinued." + }, + "smithy.api#documentation": "Returns the FinSpace environment object.
", + "smithy.api#http": { + "method": "GET", + "uri": "/environment/{environmentId}", + "code": 200 + } + } + }, + "com.amazonaws.finspace#GetEnvironmentRequest": { + "type": "structure", + "members": { + "environmentId": { + "target": "com.amazonaws.finspace#IdType", + "traits": { + "smithy.api#documentation": "The identifier of the FinSpace environment.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.finspace#GetEnvironmentResponse": { + "type": "structure", + "members": { + "environment": { + "target": "com.amazonaws.finspace#Environment", + "traits": { + "smithy.api#documentation": "The name of the FinSpace environment.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.finspace#GetKxChangeset": { + "type": "operation", + "input": { + "target": "com.amazonaws.finspace#GetKxChangesetRequest" + }, + "output": { + "target": "com.amazonaws.finspace#GetKxChangesetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.finspace#AccessDeniedException" + }, + { + "target": "com.amazonaws.finspace#InternalServerException" + }, + { + "target": "com.amazonaws.finspace#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.finspace#ThrottlingException" + }, + { + "target": "com.amazonaws.finspace#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns information about a kdb changeset.
", + "smithy.api#http": { + "method": "GET", + "uri": "/kx/environments/{environmentId}/databases/{databaseName}/changesets/{changesetId}", + "code": 200 + } + } + }, + "com.amazonaws.finspace#GetKxChangesetRequest": { + "type": "structure", + "members": { + "environmentId": { + "target": "com.amazonaws.finspace#EnvironmentId", + "traits": { + "smithy.api#documentation": "A unique identifier for the kdb environment.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "databaseName": { + "target": "com.amazonaws.finspace#DatabaseName", + "traits": { + "smithy.api#documentation": "The name of the kdb database.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "changesetId": { + "target": "com.amazonaws.finspace#ChangesetId", + "traits": { + "smithy.api#documentation": "A unique identifier of the changeset for which you want to retrieve data.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.finspace#GetKxChangesetResponse": { + "type": "structure", + "members": { + "changesetId": { + "target": "com.amazonaws.finspace#ChangesetId", + "traits": { + "smithy.api#documentation": "A unique identifier for the changeset.
" + } + }, + "databaseName": { + "target": "com.amazonaws.finspace#DatabaseName", + "traits": { + "smithy.api#documentation": "The name of the kdb database.
" + } + }, + "environmentId": { + "target": "com.amazonaws.finspace#EnvironmentId", + "traits": { + "smithy.api#documentation": "A unique identifier for the kdb environment.
" + } + }, + "changeRequests": { + "target": "com.amazonaws.finspace#ChangeRequests", + "traits": { + "smithy.api#documentation": "A list of change request objects that are run in order.
" + } + }, + "createdTimestamp": { + "target": "com.amazonaws.finspace#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp at which the changeset was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" + } + }, + "activeFromTimestamp": { + "target": "com.amazonaws.finspace#Timestamp", + "traits": { + "smithy.api#documentation": "Beginning time from which the changeset is active. The value is determined as epoch time in\n milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as\n 1635768000000.
" + } + }, + "lastModifiedTimestamp": { + "target": "com.amazonaws.finspace#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp at which the changeset was updated in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" + } + }, + "status": { + "target": "com.amazonaws.finspace#ChangesetStatus", + "traits": { + "smithy.api#documentation": "Status of the changeset creation process.
\nPending – Changeset creation is pending.
\nProcessing – Changeset creation is running.
\nFailed – Changeset creation has failed.
\nComplete – Changeset creation has succeeded.
\nProvides details in the event of a failed flow, including the error type and the related error message.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.finspace#GetKxCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.finspace#GetKxClusterRequest" + }, + "output": { + "target": "com.amazonaws.finspace#GetKxClusterResponse" + }, + "errors": [ + { + "target": "com.amazonaws.finspace#AccessDeniedException" + }, + { + "target": "com.amazonaws.finspace#ConflictException" + }, + { + "target": "com.amazonaws.finspace#InternalServerException" + }, + { + "target": "com.amazonaws.finspace#LimitExceededException" + }, + { + "target": "com.amazonaws.finspace#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.finspace#ThrottlingException" + }, + { + "target": "com.amazonaws.finspace#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves information about a kdb cluster.
", + "smithy.api#http": { + "method": "GET", + "uri": "/kx/environments/{environmentId}/clusters/{clusterName}", + "code": 200 + } + } + }, + "com.amazonaws.finspace#GetKxClusterRequest": { + "type": "structure", + "members": { + "environmentId": { + "target": "com.amazonaws.finspace#KxEnvironmentId", + "traits": { + "smithy.api#documentation": "A unique identifier for the kdb environment.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "clusterName": { + "target": "com.amazonaws.finspace#KxClusterName", + "traits": { + "smithy.api#documentation": "The name of the cluster that you want to retrieve.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.finspace#GetKxClusterResponse": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.finspace#KxClusterStatus", + "traits": { + "smithy.api#documentation": "The status of cluster creation.
\nPENDING – The cluster is pending creation.
\nCREATING – The cluster creation process is in progress.
\nCREATE_FAILED – The cluster creation process has failed.
\nRUNNING – The cluster creation process is running.
\nUPDATING – The cluster is in the process of being updated.
\nDELETING – The cluster is in the process of being deleted.
\nDELETED – The cluster has been deleted.
\nDELETE_FAILED – The cluster failed to delete.
\nThe error message when a failed state occurs.
" + } + }, + "clusterName": { + "target": "com.amazonaws.finspace#KxClusterName", + "traits": { + "smithy.api#documentation": "A unique name for the cluster.
" + } + }, + "clusterType": { + "target": "com.amazonaws.finspace#KxClusterType", + "traits": { + "smithy.api#documentation": "Specifies the type of KDB database that is being created. The following types are available:
\nHDB – A Historical Database. The data is only accessible with read-only permissions from one of the FinSpace managed kdb databases mounted to the cluster.
\nRDB – A Realtime Database. This type of database captures all the data from a ticker plant and stores it in memory until the end of day, after which it writes all of its data to a disk and reloads the HDB. This cluster type requires local storage for temporary storage of data during the savedown process. If you specify this field in your request, you must provide the savedownStorageConfiguration parameter.
GATEWAY – A gateway cluster allows you to access data across processes in kdb systems. It allows you to create your own routing logic using the initialization scripts and custom code. This type of cluster does not require a writable local storage.
\nGP – A general purpose cluster allows you to quickly iterate on code during development by granting greater access to system commands and enabling a fast reload of custom code. This cluster type can optionally mount databases including cache and savedown storage. For this cluster type, the node count is fixed at 1. It does not support autoscaling and supports only SINGLE AZ mode.
Tickerplant – A tickerplant cluster allows you to subscribe to feed handlers based on IAM permissions. It can publish to RDBs, other Tickerplants, and real-time subscribers (RTS). Tickerplants can persist messages to log, which is readable by any RDB environment. It supports only single-node that is only one kdb process.
\n\nA list of volumes attached to the cluster.\n
" + } + }, + "databases": { + "target": "com.amazonaws.finspace#KxDatabaseConfigurations", + "traits": { + "smithy.api#documentation": "A list of databases mounted on the cluster.
" + } + }, + "cacheStorageConfigurations": { + "target": "com.amazonaws.finspace#KxCacheStorageConfigurations", + "traits": { + "smithy.api#documentation": "The configurations for a read only cache storage associated with a cluster. This cache will be stored as an FSx Lustre that reads from the S3 store.
" + } + }, + "autoScalingConfiguration": { + "target": "com.amazonaws.finspace#AutoScalingConfiguration", + "traits": { + "smithy.api#documentation": "The configuration based on which FinSpace will scale in or scale out nodes in your cluster.
" + } + }, + "clusterDescription": { + "target": "com.amazonaws.finspace#KxClusterDescription", + "traits": { + "smithy.api#documentation": "A description of the cluster.
" + } + }, + "capacityConfiguration": { + "target": "com.amazonaws.finspace#CapacityConfiguration", + "traits": { + "smithy.api#documentation": "A structure for the metadata of a cluster. It includes information like the CPUs needed, memory of instances, and number of instances.
" + } + }, + "releaseLabel": { + "target": "com.amazonaws.finspace#ReleaseLabel", + "traits": { + "smithy.api#documentation": "The version of FinSpace managed kdb to run.
" + } + }, + "vpcConfiguration": { + "target": "com.amazonaws.finspace#VpcConfiguration", + "traits": { + "smithy.api#documentation": "Configuration details about the network where the Privatelink endpoint of the cluster resides.
" + } + }, + "initializationScript": { + "target": "com.amazonaws.finspace#InitializationScriptFilePath", + "traits": { + "smithy.api#documentation": "Specifies a Q program that will be run at launch of a cluster. It is a relative path within\n .zip file that contains the custom code, which will be loaded on\n the cluster. It must include the file name itself. For example,\n somedir/init.q.
Defines key-value pairs to make them available inside the cluster.
" + } + }, + "code": { + "target": "com.amazonaws.finspace#CodeConfiguration", + "traits": { + "smithy.api#documentation": "The details of the custom code that you want to use inside a cluster when analyzing a data. It consists of the S3 source bucket, location, S3 object version, and the relative path from where the custom code is loaded into the cluster.
" + } + }, + "executionRole": { + "target": "com.amazonaws.finspace#ExecutionRoleArn", + "traits": { + "smithy.api#documentation": "\n An IAM role that defines a set of permissions associated with a cluster. These permissions are assumed when a cluster attempts to access another cluster.\n
" + } + }, + "lastModifiedTimestamp": { + "target": "com.amazonaws.finspace#Timestamp", + "traits": { + "smithy.api#documentation": "The last time that the cluster was modified. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" + } + }, + "savedownStorageConfiguration": { + "target": "com.amazonaws.finspace#KxSavedownStorageConfiguration", + "traits": { + "smithy.api#documentation": "The size and type of the temporary storage that is used to hold data during the savedown process. This parameter is required when you choose clusterType as RDB. All the data written to this storage space is lost when the cluster node is restarted.
The number of availability zones you want to assign per cluster. This can be one of the following
\n\n SINGLE – Assigns one availability zone per cluster.
\n MULTI – Assigns all the availability zones per cluster.
\n The availability zone identifiers for the requested regions.\n
" + } + }, + "createdTimestamp": { + "target": "com.amazonaws.finspace#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp at which the cluster was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" + } + }, + "scalingGroupConfiguration": { + "target": "com.amazonaws.finspace#KxScalingGroupConfiguration" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.finspace#GetKxConnectionString": { + "type": "operation", + "input": { + "target": "com.amazonaws.finspace#GetKxConnectionStringRequest" + }, + "output": { + "target": "com.amazonaws.finspace#GetKxConnectionStringResponse" + }, + "errors": [ + { + "target": "com.amazonaws.finspace#AccessDeniedException" + }, + { + "target": "com.amazonaws.finspace#InternalServerException" + }, + { + "target": "com.amazonaws.finspace#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.finspace#ThrottlingException" + }, + { + "target": "com.amazonaws.finspace#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves a connection string for a user to connect to a kdb cluster. You must call this API using the same role that you have defined while creating a user.
", + "smithy.api#http": { + "method": "GET", + "uri": "/kx/environments/{environmentId}/connectionString", + "code": 200 + } + } + }, + "com.amazonaws.finspace#GetKxConnectionStringRequest": { + "type": "structure", + "members": { + "userArn": { + "target": "com.amazonaws.finspace#KxUserArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies the user. For more information about ARNs and\n how to use ARNs in policies, see IAM Identifiers in the\n IAM User Guide.
", + "smithy.api#httpQuery": "userArn", + "smithy.api#required": {} + } + }, + "environmentId": { + "target": "com.amazonaws.finspace#IdType", + "traits": { + "smithy.api#documentation": "A unique identifier for the kdb environment.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "clusterName": { + "target": "com.amazonaws.finspace#KxClusterName", + "traits": { + "smithy.api#documentation": "A name of the kdb cluster.
", + "smithy.api#httpQuery": "clusterName", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.finspace#GetKxConnectionStringResponse": { + "type": "structure", + "members": { + "signedConnectionString": { + "target": "com.amazonaws.finspace#SignedKxConnectionString", + "traits": { + "smithy.api#documentation": "The signed connection string that you can use to connect to clusters.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.finspace#GetKxDatabase": { + "type": "operation", + "input": { + "target": "com.amazonaws.finspace#GetKxDatabaseRequest" + }, + "output": { + "target": "com.amazonaws.finspace#GetKxDatabaseResponse" + }, + "errors": [ + { + "target": "com.amazonaws.finspace#AccessDeniedException" + }, + { + "target": "com.amazonaws.finspace#InternalServerException" + }, + { + "target": "com.amazonaws.finspace#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.finspace#ThrottlingException" + }, + { + "target": "com.amazonaws.finspace#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns database information for the specified environment ID.
", + "smithy.api#http": { + "method": "GET", + "uri": "/kx/environments/{environmentId}/databases/{databaseName}", + "code": 200 + } + } + }, + "com.amazonaws.finspace#GetKxDatabaseRequest": { + "type": "structure", + "members": { + "environmentId": { + "target": "com.amazonaws.finspace#EnvironmentId", + "traits": { + "smithy.api#documentation": "A unique identifier for the kdb environment.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "databaseName": { + "target": "com.amazonaws.finspace#DatabaseName", + "traits": { + "smithy.api#documentation": "The name of the kdb database.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.finspace#GetKxDatabaseResponse": { + "type": "structure", + "members": { + "databaseName": { + "target": "com.amazonaws.finspace#DatabaseName", + "traits": { + "smithy.api#documentation": "The name of the kdb database for which the information is retrieved.
" + } + }, + "databaseArn": { + "target": "com.amazonaws.finspace#DatabaseArn", + "traits": { + "smithy.api#documentation": "The ARN identifier of the database.
" + } + }, + "environmentId": { + "target": "com.amazonaws.finspace#EnvironmentId", + "traits": { + "smithy.api#documentation": "A unique identifier for the kdb environment.
" + } + }, + "description": { + "target": "com.amazonaws.finspace#Description", + "traits": { + "smithy.api#documentation": "A description of the database.
" + } + }, + "createdTimestamp": { + "target": "com.amazonaws.finspace#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp at which the database is created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" + } + }, + "lastModifiedTimestamp": { + "target": "com.amazonaws.finspace#Timestamp", + "traits": { + "smithy.api#documentation": "The last time that the database was modified. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" + } + }, + "lastCompletedChangesetId": { + "target": "com.amazonaws.finspace#ChangesetId", + "traits": { + "smithy.api#documentation": "A unique identifier for the changeset.
" + } + }, + "numBytes": { + "target": "com.amazonaws.finspace#numBytes", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The total number of bytes in the database.
" + } + }, + "numChangesets": { + "target": "com.amazonaws.finspace#numChangesets", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The total number of changesets in the database.
" + } + }, + "numFiles": { + "target": "com.amazonaws.finspace#numFiles", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The total number of files in the database.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.finspace#GetKxDataview": { + "type": "operation", + "input": { + "target": "com.amazonaws.finspace#GetKxDataviewRequest" + }, + "output": { + "target": "com.amazonaws.finspace#GetKxDataviewResponse" + }, + "errors": [ + { + "target": "com.amazonaws.finspace#AccessDeniedException" + }, + { + "target": "com.amazonaws.finspace#InternalServerException" + }, + { + "target": "com.amazonaws.finspace#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.finspace#ThrottlingException" + }, + { + "target": "com.amazonaws.finspace#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "\nRetrieves details of the dataview.\n
", + "smithy.api#http": { + "method": "GET", + "uri": "/kx/environments/{environmentId}/databases/{databaseName}/dataviews/{dataviewName}", + "code": 200 + } + } + }, + "com.amazonaws.finspace#GetKxDataviewRequest": { + "type": "structure", + "members": { + "environmentId": { + "target": "com.amazonaws.finspace#EnvironmentId", + "traits": { + "smithy.api#documentation": "A unique identifier for the kdb environment, from where you want to retrieve the dataview details.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "databaseName": { + "target": "com.amazonaws.finspace#DatabaseName", + "traits": { + "smithy.api#documentation": "\nThe name of the database where you created the dataview.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "dataviewName": { + "target": "com.amazonaws.finspace#KxDataviewName", + "traits": { + "smithy.api#documentation": "A unique identifier for the dataview.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.finspace#GetKxDataviewResponse": { + "type": "structure", + "members": { + "databaseName": { + "target": "com.amazonaws.finspace#DatabaseName", + "traits": { + "smithy.api#documentation": "\nThe name of the database where you created the dataview.
" + } + }, + "dataviewName": { + "target": "com.amazonaws.finspace#KxDataviewName", + "traits": { + "smithy.api#documentation": "A unique identifier for the dataview.
" + } + }, + "azMode": { + "target": "com.amazonaws.finspace#KxAzMode", + "traits": { + "smithy.api#documentation": "The number of availability zones you want to assign per volume. Currently, FinSpace only supports SINGLE for volumes. This places dataview in a single AZ.
\n The identifier of the availability zones.\n
" + } + }, + "changesetId": { + "target": "com.amazonaws.finspace#ChangesetId", + "traits": { + "smithy.api#documentation": "\nA unique identifier of the changeset that you want to use to ingest data.
" + } + }, + "segmentConfigurations": { + "target": "com.amazonaws.finspace#KxDataviewSegmentConfigurationList", + "traits": { + "smithy.api#documentation": "\n The configuration that contains the database path of the data that you want to place on each selected volume. Each segment must have a unique database path for each volume. If you do not explicitly specify any database path for a volume, they are accessible from the cluster through the default S3/object store segment.
" + } + }, + "activeVersions": { + "target": "com.amazonaws.finspace#KxDataviewActiveVersionList", + "traits": { + "smithy.api#documentation": "\n The current active changeset versions of the database on the given dataview. \n \n
" + } + }, + "description": { + "target": "com.amazonaws.finspace#Description", + "traits": { + "smithy.api#documentation": "A description of the dataview.
" + } + }, + "autoUpdate": { + "target": "com.amazonaws.finspace#booleanValue", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "The option to specify whether you want to apply all the future additions and corrections automatically to the dataview when new changesets are ingested. The default value is false.
" + } + }, + "readWrite": { + "target": "com.amazonaws.finspace#booleanValue", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Returns True if the dataview is created as writeable and False otherwise.
" + } + }, + "environmentId": { + "target": "com.amazonaws.finspace#EnvironmentId", + "traits": { + "smithy.api#documentation": "A unique identifier for the kdb environment, from where you want to retrieve the dataview details.
" + } + }, + "createdTimestamp": { + "target": "com.amazonaws.finspace#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp at which the dataview was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" + } + }, + "lastModifiedTimestamp": { + "target": "com.amazonaws.finspace#Timestamp", + "traits": { + "smithy.api#documentation": "\n The last time that the dataview was updated in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.\n
" + } + }, + "status": { + "target": "com.amazonaws.finspace#KxDataviewStatus", + "traits": { + "smithy.api#documentation": "\n The status of dataview creation.
\n\n CREATING – The dataview creation is in progress.
\n UPDATING – The dataview is in the process of being updated.
\n ACTIVE – The dataview is active.
\nThe error message when a failed state occurs. \n
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.finspace#GetKxEnvironment": { + "type": "operation", + "input": { + "target": "com.amazonaws.finspace#GetKxEnvironmentRequest" + }, + "output": { + "target": "com.amazonaws.finspace#GetKxEnvironmentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.finspace#AccessDeniedException" + }, + { + "target": "com.amazonaws.finspace#ConflictException" + }, + { + "target": "com.amazonaws.finspace#InternalServerException" + }, + { + "target": "com.amazonaws.finspace#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.finspace#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves all the information for the specified kdb environment.
", + "smithy.api#http": { + "method": "GET", + "uri": "/kx/environments/{environmentId}", + "code": 200 + } + } + }, + "com.amazonaws.finspace#GetKxEnvironmentRequest": { + "type": "structure", + "members": { + "environmentId": { + "target": "com.amazonaws.finspace#IdType", + "traits": { + "smithy.api#documentation": "A unique identifier for the kdb environment.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.finspace#GetKxEnvironmentResponse": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.finspace#KxEnvironmentName", + "traits": { + "smithy.api#documentation": "The name of the kdb environment.
" + } + }, + "environmentId": { + "target": "com.amazonaws.finspace#IdType", + "traits": { + "smithy.api#documentation": "A unique identifier for the kdb environment.
" + } + }, + "awsAccountId": { + "target": "com.amazonaws.finspace#IdType", + "traits": { + "smithy.api#documentation": "The unique identifier of the AWS account that is used to create the kdb environment.
" + } + }, + "status": { + "target": "com.amazonaws.finspace#EnvironmentStatus", + "traits": { + "smithy.api#documentation": "The status of the kdb environment.
" + } + }, + "tgwStatus": { + "target": "com.amazonaws.finspace#tgwStatus", + "traits": { + "smithy.api#documentation": "The status of the network configuration.
" + } + }, + "dnsStatus": { + "target": "com.amazonaws.finspace#dnsStatus", + "traits": { + "smithy.api#documentation": "The status of DNS configuration.
" + } + }, + "errorMessage": { + "target": "com.amazonaws.finspace#EnvironmentErrorMessage", + "traits": { + "smithy.api#documentation": "Specifies the error message that appears if a flow fails.
" + } + }, + "description": { + "target": "com.amazonaws.finspace#Description", + "traits": { + "smithy.api#documentation": "A description for the kdb environment.
" + } + }, + "environmentArn": { + "target": "com.amazonaws.finspace#EnvironmentArn", + "traits": { + "smithy.api#documentation": "The ARN identifier of the environment.
" + } + }, + "kmsKeyId": { + "target": "com.amazonaws.finspace#KmsKeyId", + "traits": { + "smithy.api#documentation": "The KMS key ID to encrypt your data in the FinSpace environment.
" + } + }, + "dedicatedServiceAccountId": { + "target": "com.amazonaws.finspace#IdType", + "traits": { + "smithy.api#documentation": "A unique identifier for the AWS environment infrastructure account.
" + } + }, + "transitGatewayConfiguration": { + "target": "com.amazonaws.finspace#TransitGatewayConfiguration" + }, + "customDNSConfiguration": { + "target": "com.amazonaws.finspace#CustomDNSConfiguration", + "traits": { + "smithy.api#documentation": "A list of DNS server name and server IP. This is used to set up Route-53 outbound resolvers.
" + } + }, + "creationTimestamp": { + "target": "com.amazonaws.finspace#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp at which the kdb environment was created in FinSpace.
" + } + }, + "updateTimestamp": { + "target": "com.amazonaws.finspace#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp at which the kdb environment was updated.
" + } + }, + "availabilityZoneIds": { + "target": "com.amazonaws.finspace#AvailabilityZoneIds", + "traits": { + "smithy.api#documentation": "The identifier of the availability zones where subnets for the environment are created.
" + } + }, + "certificateAuthorityArn": { + "target": "com.amazonaws.finspace#stringValueLength1to255", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the certificate authority of the \n kdb environment.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.finspace#GetKxScalingGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.finspace#GetKxScalingGroupRequest" + }, + "output": { + "target": "com.amazonaws.finspace#GetKxScalingGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.finspace#AccessDeniedException" + }, + { + "target": "com.amazonaws.finspace#ConflictException" + }, + { + "target": "com.amazonaws.finspace#InternalServerException" + }, + { + "target": "com.amazonaws.finspace#LimitExceededException" + }, + { + "target": "com.amazonaws.finspace#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.finspace#ThrottlingException" + }, + { + "target": "com.amazonaws.finspace#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "\nRetrieves details of a scaling group.
", + "smithy.api#http": { + "method": "GET", + "uri": "/kx/environments/{environmentId}/scalingGroups/{scalingGroupName}", + "code": 200 + } + } + }, + "com.amazonaws.finspace#GetKxScalingGroupRequest": { + "type": "structure", + "members": { + "environmentId": { + "target": "com.amazonaws.finspace#KxEnvironmentId", + "traits": { + "smithy.api#documentation": "A unique identifier for the kdb environment.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "scalingGroupName": { + "target": "com.amazonaws.finspace#KxScalingGroupName", + "traits": { + "smithy.api#documentation": "A unique identifier for the kdb scaling group.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.finspace#GetKxScalingGroupResponse": { + "type": "structure", + "members": { + "scalingGroupName": { + "target": "com.amazonaws.finspace#KxScalingGroupName", + "traits": { + "smithy.api#documentation": "A unique identifier for the kdb scaling group.
" + } + }, + "scalingGroupArn": { + "target": "com.amazonaws.finspace#arn", + "traits": { + "smithy.api#documentation": "\n The ARN identifier for the scaling group.\n
" + } + }, + "hostType": { + "target": "com.amazonaws.finspace#KxHostType", + "traits": { + "smithy.api#documentation": "\n The memory and CPU capabilities of the scaling group host on which FinSpace Managed kdb clusters will be placed.
\nIt can have one of the following values:
\n\n kx.sg.large – The host type with a configuration of 16 GiB\n memory and 2 vCPUs.
\n kx.sg.xlarge – The host type with a configuration of 32 GiB\n memory and 4 vCPUs.
\n kx.sg.2xlarge – The host type with a configuration of 64 GiB\n memory and 8 vCPUs.
\n kx.sg.4xlarge – The host type with a configuration of 108 GiB memory and 16 vCPUs.
\n kx.sg.8xlarge – The host type with a configuration of 216 GiB memory and 32 vCPUs.
\n kx.sg.16xlarge – The host type with a configuration of 432 GiB memory and 64 vCPUs.
\n kx.sg.32xlarge – The host type with a configuration of 864 GiB memory and 128 vCPUs.
\n kx.sg1.16xlarge – The host type with a configuration of 1949 GiB memory and 64 vCPUs.
\n kx.sg1.24xlarge – The host type with a configuration of 2948 GiB memory and 96 vCPUs.
\n The list of Managed kdb clusters that are currently active in the given scaling group.\n \n
" + } + }, + "availabilityZoneId": { + "target": "com.amazonaws.finspace#AvailabilityZoneId", + "traits": { + "smithy.api#documentation": "The identifier of the availability zones.
" + } + }, + "status": { + "target": "com.amazonaws.finspace#KxScalingGroupStatus", + "traits": { + "smithy.api#documentation": "The status of scaling group.
\nCREATING – The scaling group creation is in progress.
\nCREATE_FAILED – The scaling group creation has failed.
\nACTIVE – The scaling group is active.
\nUPDATING – The scaling group is in the process of being updated.
\nUPDATE_FAILED – The update action failed.
\nDELETING – The scaling group is in the process of being deleted.
\nDELETE_FAILED – The system failed to delete the scaling group.
\nDELETED – The scaling group is successfully deleted.
\n\nThe error message when a failed state occurs. \n
" + } + }, + "lastModifiedTimestamp": { + "target": "com.amazonaws.finspace#Timestamp", + "traits": { + "smithy.api#documentation": "\n The last time that the scaling group was updated in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.\n
" + } + }, + "createdTimestamp": { + "target": "com.amazonaws.finspace#Timestamp", + "traits": { + "smithy.api#documentation": "\n The timestamp at which the scaling group was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.finspace#GetKxUser": { + "type": "operation", + "input": { + "target": "com.amazonaws.finspace#GetKxUserRequest" + }, + "output": { + "target": "com.amazonaws.finspace#GetKxUserResponse" + }, + "errors": [ + { + "target": "com.amazonaws.finspace#AccessDeniedException" + }, + { + "target": "com.amazonaws.finspace#InternalServerException" + }, + { + "target": "com.amazonaws.finspace#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.finspace#ThrottlingException" + }, + { + "target": "com.amazonaws.finspace#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves information about the specified kdb user.
", + "smithy.api#http": { + "method": "GET", + "uri": "/kx/environments/{environmentId}/users/{userName}", + "code": 200 + } + } + }, + "com.amazonaws.finspace#GetKxUserRequest": { + "type": "structure", + "members": { + "userName": { + "target": "com.amazonaws.finspace#KxUserNameString", + "traits": { + "smithy.api#documentation": "A unique identifier for the user.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "environmentId": { + "target": "com.amazonaws.finspace#IdType", + "traits": { + "smithy.api#documentation": "A unique identifier for the kdb environment.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.finspace#GetKxUserResponse": { + "type": "structure", + "members": { + "userName": { + "target": "com.amazonaws.finspace#IdType", + "traits": { + "smithy.api#documentation": "A unique identifier for the user.
" + } + }, + "userArn": { + "target": "com.amazonaws.finspace#KxUserArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies the user. For more information about ARNs and\n how to use ARNs in policies, see IAM Identifiers in the\n IAM User Guide.
" + } + }, + "environmentId": { + "target": "com.amazonaws.finspace#IdType", + "traits": { + "smithy.api#documentation": "A unique identifier for the kdb environment.
" + } + }, + "iamRole": { + "target": "com.amazonaws.finspace#RoleArn", + "traits": { + "smithy.api#documentation": "The IAM role ARN that is associated with the user.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.finspace#GetKxVolume": { + "type": "operation", + "input": { + "target": "com.amazonaws.finspace#GetKxVolumeRequest" + }, + "output": { + "target": "com.amazonaws.finspace#GetKxVolumeResponse" + }, + "errors": [ + { + "target": "com.amazonaws.finspace#AccessDeniedException" + }, + { + "target": "com.amazonaws.finspace#ConflictException" + }, + { + "target": "com.amazonaws.finspace#InternalServerException" + }, + { + "target": "com.amazonaws.finspace#LimitExceededException" + }, + { + "target": "com.amazonaws.finspace#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.finspace#ThrottlingException" + }, + { + "target": "com.amazonaws.finspace#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "\nRetrieves the information about the volume.
", + "smithy.api#http": { + "method": "GET", + "uri": "/kx/environments/{environmentId}/kxvolumes/{volumeName}", + "code": 200 + } + } + }, + "com.amazonaws.finspace#GetKxVolumeRequest": { + "type": "structure", + "members": { + "environmentId": { + "target": "com.amazonaws.finspace#KxEnvironmentId", + "traits": { + "smithy.api#documentation": "A unique identifier for the kdb environment, whose clusters can attach to the volume.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "volumeName": { + "target": "com.amazonaws.finspace#KxVolumeName", + "traits": { + "smithy.api#documentation": "A unique identifier for the volume.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.finspace#GetKxVolumeResponse": { + "type": "structure", + "members": { + "environmentId": { + "target": "com.amazonaws.finspace#KxEnvironmentId", + "traits": { + "smithy.api#documentation": "A unique identifier for the kdb environment, whose clusters can attach to the volume.
" + } + }, + "volumeName": { + "target": "com.amazonaws.finspace#KxVolumeName", + "traits": { + "smithy.api#documentation": "\nA unique identifier for the volume.
" + } + }, + "volumeType": { + "target": "com.amazonaws.finspace#KxVolumeType", + "traits": { + "smithy.api#documentation": "\n The type of file system volume. Currently, FinSpace only supports NAS_1 volume type.\n
\nThe ARN identifier of the volume.\n
" + } + }, + "nas1Configuration": { + "target": "com.amazonaws.finspace#KxNAS1Configuration", + "traits": { + "smithy.api#documentation": "Specifies the configuration for the Network attached storage (NAS_1) file system volume.
" + } + }, + "status": { + "target": "com.amazonaws.finspace#KxVolumeStatus", + "traits": { + "smithy.api#documentation": "The status of volume creation.
\nCREATING – The volume creation is in progress.
\nCREATE_FAILED – The volume creation has failed.
\nACTIVE – The volume is active.
\nUPDATING – The volume is in the process of being updated.
\nUPDATE_FAILED – The update action failed.
\nUPDATED – The volume is successfully updated.
\nDELETING – The volume is in the process of being deleted.
\nDELETE_FAILED – The system failed to delete the volume.
\nDELETED – The volume is successfully deleted.
\nThe error message when a failed state occurs.
" + } + }, + "createdTimestamp": { + "target": "com.amazonaws.finspace#Timestamp", + "traits": { + "smithy.api#documentation": "\nThe timestamp at which the volume was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.\n
" + } + }, + "description": { + "target": "com.amazonaws.finspace#Description", + "traits": { + "smithy.api#documentation": "\nA description of the volume.\n
" + } + }, + "azMode": { + "target": "com.amazonaws.finspace#KxAzMode", + "traits": { + "smithy.api#documentation": "The number of availability zones you want to assign per volume. Currently, FinSpace only supports SINGLE for volumes. This places dataview in a single AZ.
The identifier of the availability zones.
" + } + }, + "lastModifiedTimestamp": { + "target": "com.amazonaws.finspace#Timestamp", + "traits": { + "smithy.api#documentation": "The last time that the volume was updated in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" + } + }, + "attachedClusters": { + "target": "com.amazonaws.finspace#KxAttachedClusters", + "traits": { + "smithy.api#documentation": "\nA list of cluster identifiers that a volume is attached to. \n
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.finspace#IPAddressType": { + "type": "enum", + "members": { + "IP_V4": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IP_V4" + } + } + } + }, + "com.amazonaws.finspace#IcmpTypeCode": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.finspace#IcmpTypeOrCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The ICMP type. A value of -1 means all types.\n
", + "smithy.api#required": {} + } + }, + "code": { + "target": "com.amazonaws.finspace#IcmpTypeOrCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "\n The ICMP code. A value of -1 means all codes for the specified ICMP type.\n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "\n Defines the ICMP protocol that consists of the ICMP type and code.\n
" + } + }, + "com.amazonaws.finspace#IcmpTypeOrCode": { + "type": "integer", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.finspace#IdType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 26 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]{1,26}$" + } + }, + "com.amazonaws.finspace#InitializationScriptFilePath": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\_\\-\\.\\/\\\\]+$" + } + }, + "com.amazonaws.finspace#InternalServerException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.finspace#ErrorMessage2" + } + }, + "traits": { + "smithy.api#documentation": "The request processing has failed because of an unknown error, exception or\n failure.
", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.finspace#InvalidRequestException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.finspace#ErrorMessage2" + } + }, + "traits": { + "smithy.api#documentation": "The request is invalid. Something is wrong with the input to the request.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.finspace#KmsKeyARN": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1000 + }, + "smithy.api#pattern": "^arn:aws:kms:.*:\\d+:.*$" + } + }, + "com.amazonaws.finspace#KmsKeyId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1000 + }, + "smithy.api#pattern": "^[a-zA-Z-0-9-:\\/]*$" + } + }, + "com.amazonaws.finspace#KxAttachedCluster": { + "type": "structure", + "members": { + "clusterName": { + "target": "com.amazonaws.finspace#KxClusterName", + "traits": { + "smithy.api#documentation": "A unique name for the attached cluster.
" + } + }, + "clusterType": { + "target": "com.amazonaws.finspace#KxClusterType", + "traits": { + "smithy.api#documentation": "Specifies the type of cluster. The volume for TP and RDB cluster types will be used for TP logs.
" + } + }, + "clusterStatus": { + "target": "com.amazonaws.finspace#KxClusterStatus", + "traits": { + "smithy.api#documentation": "The status of the attached cluster.
\nPENDING – The cluster is pending creation.
\nCREATING – The cluster creation process is in progress.
\nCREATE_FAILED – The cluster creation process has failed.
\nRUNNING – The cluster creation process is running.
\nUPDATING – The cluster is in the process of being updated.
\nDELETING – The cluster is in the process of being deleted.
\nDELETED – The cluster has been deleted.
\nDELETE_FAILED – The cluster failed to delete.
\nThe structure containing the metadata of the attached clusters.
" + } + }, + "com.amazonaws.finspace#KxAttachedClusters": { + "type": "list", + "member": { + "target": "com.amazonaws.finspace#KxAttachedCluster" + } + }, + "com.amazonaws.finspace#KxAzMode": { + "type": "enum", + "members": { + "SINGLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SINGLE" + } + }, + "MULTI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MULTI" + } + } + } + }, + "com.amazonaws.finspace#KxCacheStorageConfiguration": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.finspace#KxCacheStorageType", + "traits": { + "smithy.api#documentation": "The type of cache storage. The valid values are:
\nCACHE_1000 – This type provides at least 1000 MB/s disk access throughput.
\nCACHE_250 – This type provides at least 250 MB/s disk access throughput.
\nCACHE_12 – This type provides at least 12 MB/s disk access throughput.
\nFor cache type CACHE_1000 and CACHE_250 you can select cache size as 1200 GB or increments of 2400 GB. For cache type CACHE_12 you can select the cache size in increments of 6000 GB.
The size of cache in Gigabytes.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration for read only disk cache associated with a cluster.
" + } + }, + "com.amazonaws.finspace#KxCacheStorageConfigurations": { + "type": "list", + "member": { + "target": "com.amazonaws.finspace#KxCacheStorageConfiguration" + } + }, + "com.amazonaws.finspace#KxCacheStorageSize": { + "type": "integer" + }, + "com.amazonaws.finspace#KxCacheStorageType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 8, + "max": 10 + } + } + }, + "com.amazonaws.finspace#KxChangesetListEntry": { + "type": "structure", + "members": { + "changesetId": { + "target": "com.amazonaws.finspace#ChangesetId", + "traits": { + "smithy.api#documentation": "A unique identifier for the changeset.
" + } + }, + "createdTimestamp": { + "target": "com.amazonaws.finspace#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp at which the changeset was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" + } + }, + "activeFromTimestamp": { + "target": "com.amazonaws.finspace#Timestamp", + "traits": { + "smithy.api#documentation": "Beginning time from which the changeset is active. The value is determined as epoch time in\n milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as\n 1635768000000.
" + } + }, + "lastModifiedTimestamp": { + "target": "com.amazonaws.finspace#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp at which the changeset was modified. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as\n 1635768000000.
" + } + }, + "status": { + "target": "com.amazonaws.finspace#ChangesetStatus", + "traits": { + "smithy.api#documentation": "Status of the changeset.
\nPending – Changeset creation is pending.
\nProcessing – Changeset creation is running.
\nFailed – Changeset creation has failed.
\nComplete – Changeset creation has succeeded.
\nDetails of changeset.
" + } + }, + "com.amazonaws.finspace#KxChangesets": { + "type": "list", + "member": { + "target": "com.amazonaws.finspace#KxChangesetListEntry" + } + }, + "com.amazonaws.finspace#KxCluster": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.finspace#KxClusterStatus", + "traits": { + "smithy.api#documentation": "The status of a cluster.
\nPENDING – The cluster is pending creation.
\nCREATING –The cluster creation process is in progress.
\nCREATE_FAILED– The cluster creation process has failed.
\nRUNNING – The cluster creation process is running.
\nUPDATING – The cluster is in the process of being updated.
\nDELETING – The cluster is in the process of being deleted.
\nDELETED – The cluster has been deleted.
\nDELETE_FAILED – The cluster failed to delete.
\nThe error message when a failed state occurs.
" + } + }, + "clusterName": { + "target": "com.amazonaws.finspace#KxClusterName", + "traits": { + "smithy.api#documentation": "A unique name for the cluster.
" + } + }, + "clusterType": { + "target": "com.amazonaws.finspace#KxClusterType", + "traits": { + "smithy.api#documentation": "Specifies the type of KDB database that is being created. The following types are available:
\nHDB – A Historical Database. The data is only accessible with read-only permissions from one of the FinSpace managed kdb databases mounted to the cluster.
\nRDB – A Realtime Database. This type of database captures all the data from a ticker plant and stores it in memory until the end of day, after which it writes all of its data to a disk and reloads the HDB. This cluster type requires local storage for temporary storage of data during the savedown process. If you specify this field in your request, you must provide the savedownStorageConfiguration parameter.
GATEWAY – A gateway cluster allows you to access data across processes in kdb systems. It allows you to create your own routing logic using the initialization scripts and custom code. This type of cluster does not require a writable local storage.
\nGP – A general purpose cluster allows you to quickly iterate on code during development by granting greater access to system commands and enabling a fast reload of custom code. This cluster type can optionally mount databases including cache and savedown storage. For this cluster type, the node count is fixed at 1. It does not support autoscaling and supports only SINGLE AZ mode.
Tickerplant – A tickerplant cluster allows you to subscribe to feed handlers based on IAM permissions. It can publish to RDBs, other Tickerplants, and real-time subscribers (RTS). Tickerplants can persist messages to log, which is readable by any RDB environment. It supports only single-node that is only one kdb process.
\nA description of the cluster.
" + } + }, + "releaseLabel": { + "target": "com.amazonaws.finspace#ReleaseLabel", + "traits": { + "smithy.api#documentation": "A version of the FinSpace managed kdb to run.
" + } + }, + "volumes": { + "target": "com.amazonaws.finspace#Volumes", + "traits": { + "smithy.api#documentation": "\nA list of volumes attached to the cluster.\n
" + } + }, + "initializationScript": { + "target": "com.amazonaws.finspace#InitializationScriptFilePath", + "traits": { + "smithy.api#documentation": "Specifies a Q program that will be run at launch of a cluster. It is a relative path within\n .zip file that contains the custom code, which will be loaded on\n the cluster. It must include the file name itself. For example,\n somedir/init.q.
\n An IAM role that defines a set of permissions associated with a cluster. These permissions are assumed when a cluster attempts to access another cluster.\n
" + } + }, + "azMode": { + "target": "com.amazonaws.finspace#KxAzMode", + "traits": { + "smithy.api#documentation": "The number of availability zones assigned per cluster. This can be one of the following:
\n\n SINGLE – Assigns one availability zone per cluster.
\n MULTI – Assigns all the availability zones per cluster.
\n The availability zone identifiers for the requested regions.\n
" + } + }, + "lastModifiedTimestamp": { + "target": "com.amazonaws.finspace#Timestamp", + "traits": { + "smithy.api#documentation": "The last time that the cluster was modified. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" + } + }, + "createdTimestamp": { + "target": "com.amazonaws.finspace#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp at which the cluster was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The details of a kdb cluster.
" + } + }, + "com.amazonaws.finspace#KxClusterCodeDeploymentConfiguration": { + "type": "structure", + "members": { + "deploymentStrategy": { + "target": "com.amazonaws.finspace#KxClusterCodeDeploymentStrategy", + "traits": { + "smithy.api#documentation": "\n The type of deployment that you want on a cluster.\n \n
\nROLLING – This options updates the cluster by stopping the exiting q process and starting a new q process with updated configuration.
\nNO_RESTART – This option updates the cluster without stopping the running q process. It is only available for GP type cluster. This option is quicker as it reduces the turn around time to update configuration on a cluster.
With this deployment mode, you cannot update the initializationScript and commandLineArguments parameters.
FORCE – This option updates the cluster by immediately stopping all the running processes before starting up new ones with the updated configuration.
\n\n The configuration that allows you to choose how you want to update code on a cluster. Depending on the option you choose, you can reduce the time it takes to update the cluster.\n
" + } + }, + "com.amazonaws.finspace#KxClusterCodeDeploymentStrategy": { + "type": "enum", + "members": { + "NO_RESTART": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NO_RESTART" + } + }, + "ROLLING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ROLLING" + } + }, + "FORCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FORCE" + } + } + } + }, + "com.amazonaws.finspace#KxClusterDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1000 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\_\\-\\.\\s]+$" + } + }, + "com.amazonaws.finspace#KxClusterName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_]*[a-zA-Z0-9]$" + } + }, + "com.amazonaws.finspace#KxClusterNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.finspace#KxClusterName" + } + }, + "com.amazonaws.finspace#KxClusterNodeIdString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 40 + } + } + }, + "com.amazonaws.finspace#KxClusterStatus": { + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "CREATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_FAILED" + } + }, + "RUNNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RUNNING" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" + } + }, + "DELETE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_FAILED" + } + } + } + }, + "com.amazonaws.finspace#KxClusterStatusReason": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 250 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\_\\-\\.\\s]+$" + } + }, + "com.amazonaws.finspace#KxClusterType": { + "type": "enum", + "members": { + "HDB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HDB" + } + }, + "RDB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RDB" + } + }, + "GATEWAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GATEWAY" + } + }, + "GP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GP" + } + }, + "TICKERPLANT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TICKERPLANT" + } + } + } + }, + "com.amazonaws.finspace#KxClusters": { + "type": "list", + "member": { + "target": "com.amazonaws.finspace#KxCluster" + } + }, + "com.amazonaws.finspace#KxCommandLineArgument": { + "type": "structure", + "members": { + "key": { + "target": "com.amazonaws.finspace#KxCommandLineArgumentKey", + "traits": { + "smithy.api#documentation": "The name of the key.
" + } + }, + "value": { + "target": "com.amazonaws.finspace#KxCommandLineArgumentValue", + "traits": { + "smithy.api#documentation": "The value of the key.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Defines the key-value pairs to make them available inside the cluster.
" + } + }, + "com.amazonaws.finspace#KxCommandLineArgumentKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^(?![Aa][Ww][Ss])(s|([a-zA-Z][a-zA-Z0-9_]+))|(AWS_ZIP_DEFAULT)$" + } + }, + "com.amazonaws.finspace#KxCommandLineArgumentValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_:./,]+$" + } + }, + "com.amazonaws.finspace#KxCommandLineArguments": { + "type": "list", + "member": { + "target": "com.amazonaws.finspace#KxCommandLineArgument" + } + }, + "com.amazonaws.finspace#KxDatabaseCacheConfiguration": { + "type": "structure", + "members": { + "cacheType": { + "target": "com.amazonaws.finspace#KxCacheStorageType", + "traits": { + "smithy.api#documentation": "The type of disk cache. This parameter is used to map the database path to cache storage. The valid values are:
\nCACHE_1000 – This type provides at least 1000 MB/s disk access throughput.
\nSpecifies the portions of database that will be loaded into the cache for access.
", + "smithy.api#required": {} + } + }, + "dataviewName": { + "target": "com.amazonaws.finspace#KxDataviewName", + "traits": { + "smithy.api#documentation": "\n The name of the dataview to be used for caching historical data on disk.\n \n
" + } + } + }, + "traits": { + "smithy.api#documentation": "The structure of database cache configuration that is used for mapping database paths to cache types in clusters.
" + } + }, + "com.amazonaws.finspace#KxDatabaseCacheConfigurations": { + "type": "list", + "member": { + "target": "com.amazonaws.finspace#KxDatabaseCacheConfiguration" + } + }, + "com.amazonaws.finspace#KxDatabaseConfiguration": { + "type": "structure", + "members": { + "databaseName": { + "target": "com.amazonaws.finspace#DatabaseName", + "traits": { + "smithy.api#documentation": "The name of the kdb database. When this parameter is specified in the structure, S3 with the whole database is included by default.
", + "smithy.api#required": {} + } + }, + "cacheConfigurations": { + "target": "com.amazonaws.finspace#KxDatabaseCacheConfigurations", + "traits": { + "smithy.api#documentation": "Configuration details for the disk cache used to increase performance reading from a kdb database mounted to the cluster.
" + } + }, + "changesetId": { + "target": "com.amazonaws.finspace#ChangesetId", + "traits": { + "smithy.api#documentation": "A unique identifier of the changeset that is associated with the cluster.
" + } + }, + "dataviewName": { + "target": "com.amazonaws.finspace#KxDataviewName", + "traits": { + "smithy.api#documentation": "\n The name of the dataview to be used for caching historical data on disk.\n \n
" + } + }, + "dataviewConfiguration": { + "target": "com.amazonaws.finspace#KxDataviewConfiguration", + "traits": { + "smithy.api#documentation": "\n The configuration of the dataview to be used with specified cluster.\n \n
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration of data that is available for querying from this database.
" + } + }, + "com.amazonaws.finspace#KxDatabaseConfigurations": { + "type": "list", + "member": { + "target": "com.amazonaws.finspace#KxDatabaseConfiguration" + } + }, + "com.amazonaws.finspace#KxDatabaseListEntry": { + "type": "structure", + "members": { + "databaseName": { + "target": "com.amazonaws.finspace#DatabaseName", + "traits": { + "smithy.api#documentation": "The name of the kdb database.
" + } + }, + "createdTimestamp": { + "target": "com.amazonaws.finspace#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp at which the database was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" + } + }, + "lastModifiedTimestamp": { + "target": "com.amazonaws.finspace#Timestamp", + "traits": { + "smithy.api#documentation": "The last time that the database was modified. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details about a FinSpace managed kdb database
" + } + }, + "com.amazonaws.finspace#KxDatabases": { + "type": "list", + "member": { + "target": "com.amazonaws.finspace#KxDatabaseListEntry" + } + }, + "com.amazonaws.finspace#KxDataviewActiveVersion": { + "type": "structure", + "members": { + "changesetId": { + "target": "com.amazonaws.finspace#ChangesetId", + "traits": { + "smithy.api#documentation": "A unique identifier for the changeset.
" + } + }, + "segmentConfigurations": { + "target": "com.amazonaws.finspace#KxDataviewSegmentConfigurationList", + "traits": { + "smithy.api#documentation": "\n The configuration that contains the database path of the data that you want to place on each selected volume. Each segment must have a unique database path for each volume. If you do not explicitly specify any database path for a volume, they are accessible from the cluster through the default S3/object store segment.
" + } + }, + "attachedClusters": { + "target": "com.amazonaws.finspace#AttachedClusterList", + "traits": { + "smithy.api#documentation": "\n The list of clusters that are currently using this dataview.\n \n
" + } + }, + "createdTimestamp": { + "target": "com.amazonaws.finspace#Timestamp", + "traits": { + "smithy.api#documentation": "\nThe timestamp at which the dataview version was active. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" + } + }, + "versionId": { + "target": "com.amazonaws.finspace#VersionId", + "traits": { + "smithy.api#documentation": "\nA unique identifier of the active version.
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n The active version of the dataview that is currently in use by this cluster.\n \n
" + } + }, + "com.amazonaws.finspace#KxDataviewActiveVersionList": { + "type": "list", + "member": { + "target": "com.amazonaws.finspace#KxDataviewActiveVersion" + } + }, + "com.amazonaws.finspace#KxDataviewConfiguration": { + "type": "structure", + "members": { + "dataviewName": { + "target": "com.amazonaws.finspace#KxDataviewName", + "traits": { + "smithy.api#documentation": "\nThe unique identifier of the dataview.
" + } + }, + "dataviewVersionId": { + "target": "com.amazonaws.finspace#VersionId", + "traits": { + "smithy.api#documentation": "\n The version of the dataview corresponding to a given changeset.\n \n
" + } + }, + "changesetId": { + "target": "com.amazonaws.finspace#ChangesetId", + "traits": { + "smithy.api#documentation": "A unique identifier for the changeset.
" + } + }, + "segmentConfigurations": { + "target": "com.amazonaws.finspace#KxDataviewSegmentConfigurationList", + "traits": { + "smithy.api#documentation": "\nThe db path and volume configuration for the segmented database.
" + } + } + }, + "traits": { + "smithy.api#documentation": "\nThe structure that stores the configuration details of a dataview.
" + } + }, + "com.amazonaws.finspace#KxDataviewListEntry": { + "type": "structure", + "members": { + "environmentId": { + "target": "com.amazonaws.finspace#EnvironmentId", + "traits": { + "smithy.api#documentation": "A unique identifier for the kdb environment.
" + } + }, + "databaseName": { + "target": "com.amazonaws.finspace#DatabaseName", + "traits": { + "smithy.api#documentation": "\nA unique identifier of the database.
" + } + }, + "dataviewName": { + "target": "com.amazonaws.finspace#KxDataviewName", + "traits": { + "smithy.api#documentation": "\nA unique identifier of the dataview.
" + } + }, + "azMode": { + "target": "com.amazonaws.finspace#KxAzMode", + "traits": { + "smithy.api#documentation": "The number of availability zones you want to assign per volume. Currently, FinSpace only supports SINGLE for volumes. This places dataview in a single AZ.
\n The identifier of the availability zones.\n
" + } + }, + "changesetId": { + "target": "com.amazonaws.finspace#ChangesetId", + "traits": { + "smithy.api#documentation": "A unique identifier for the changeset.
" + } + }, + "segmentConfigurations": { + "target": "com.amazonaws.finspace#KxDataviewSegmentConfigurationList", + "traits": { + "smithy.api#documentation": "\n The configuration that contains the database path of the data that you want to place on each selected volume. Each segment must have a unique database path for each volume. If you do not explicitly specify any database path for a volume, they are accessible from the cluster through the default S3/object store segment.
" + } + }, + "activeVersions": { + "target": "com.amazonaws.finspace#KxDataviewActiveVersionList", + "traits": { + "smithy.api#documentation": "\n The active changeset versions for the given dataview entry.\n \n
" + } + }, + "status": { + "target": "com.amazonaws.finspace#KxDataviewStatus", + "traits": { + "smithy.api#documentation": "\n The status of a given dataview entry.\n \n
" + } + }, + "description": { + "target": "com.amazonaws.finspace#Description", + "traits": { + "smithy.api#documentation": "\nA description for the dataview list entry.
" + } + }, + "autoUpdate": { + "target": "com.amazonaws.finspace#booleanValue", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "\n The option to specify whether you want to apply all the future additions and corrections automatically to the dataview when you ingest new changesets. The default value is false.\n
" + } + }, + "readWrite": { + "target": "com.amazonaws.finspace#booleanValue", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Returns True if the dataview is created as writeable and False otherwise.
" + } + }, + "createdTimestamp": { + "target": "com.amazonaws.finspace#Timestamp", + "traits": { + "smithy.api#documentation": "\nThe timestamp at which the dataview list entry was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" + } + }, + "lastModifiedTimestamp": { + "target": "com.amazonaws.finspace#Timestamp", + "traits": { + "smithy.api#documentation": "The last time that the dataview list was updated in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" + } + }, + "statusReason": { + "target": "com.amazonaws.finspace#KxDataviewStatusReason", + "traits": { + "smithy.api#documentation": "\nThe error message when a failed state occurs. \n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n A collection of kdb dataview entries.\n \n
" + } + }, + "com.amazonaws.finspace#KxDataviewName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_]*[a-zA-Z0-9]$" + } + }, + "com.amazonaws.finspace#KxDataviewSegmentConfiguration": { + "type": "structure", + "members": { + "dbPaths": { + "target": "com.amazonaws.finspace#SegmentConfigurationDbPathList", + "traits": { + "smithy.api#documentation": "\nThe database path of the data that you want to place on each selected volume for the segment. Each segment must have a unique database path for each volume.
", + "smithy.api#required": {} + } + }, + "volumeName": { + "target": "com.amazonaws.finspace#KxVolumeName", + "traits": { + "smithy.api#documentation": "\nThe name of the volume where you want to add data.
", + "smithy.api#required": {} + } + }, + "onDemand": { + "target": "com.amazonaws.finspace#booleanValue", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Enables on-demand caching on the selected database path when a particular file or a\n column of the database is accessed. When on demand caching is True, dataviews perform minimal loading of files on the filesystem as\n needed. When it is set to False, everything is cached. The\n default value is False.
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n The configuration that contains the database path of the data that you want to place on each selected volume. Each segment must have a unique database path for each volume. If you do not explicitly specify any database path for a volume, they are accessible from the cluster through the default S3/object store segment.
" + } + }, + "com.amazonaws.finspace#KxDataviewSegmentConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.finspace#KxDataviewSegmentConfiguration" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.finspace#KxDataviewStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + } + } + }, + "com.amazonaws.finspace#KxDataviewStatusReason": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 250 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\_\\-\\.\\s]+$" + } + }, + "com.amazonaws.finspace#KxDataviews": { + "type": "list", + "member": { + "target": "com.amazonaws.finspace#KxDataviewListEntry" + } + }, + "com.amazonaws.finspace#KxDeploymentConfiguration": { + "type": "structure", + "members": { + "deploymentStrategy": { + "target": "com.amazonaws.finspace#KxDeploymentStrategy", + "traits": { + "smithy.api#documentation": "\n The type of deployment that you want on a cluster.\n \n
\nROLLING – This options updates the cluster by stopping the exiting q process and starting a new q process with updated configuration.
\nNO_RESTART – This option updates the cluster without stopping the running q process. It is only available for HDB type cluster. This option is quicker as it reduces the turn around time to update configuration on a cluster.
With this deployment mode, you cannot update the initializationScript and commandLineArguments parameters.
\n The configuration that allows you to choose how you want to update the databases on a cluster. Depending on the option you choose, you can reduce the time it takes to update the cluster.\n
" + } + }, + "com.amazonaws.finspace#KxDeploymentStrategy": { + "type": "enum", + "members": { + "NO_RESTART": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NO_RESTART" + } + }, + "ROLLING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ROLLING" + } + } + } + }, + "com.amazonaws.finspace#KxEnvironment": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.finspace#KxEnvironmentName", + "traits": { + "smithy.api#documentation": "The name of the kdb environment.
" + } + }, + "environmentId": { + "target": "com.amazonaws.finspace#IdType", + "traits": { + "smithy.api#documentation": "A unique identifier for the kdb environment.
" + } + }, + "awsAccountId": { + "target": "com.amazonaws.finspace#IdType", + "traits": { + "smithy.api#documentation": "The unique identifier of the AWS account in which you create the kdb environment.
" + } + }, + "status": { + "target": "com.amazonaws.finspace#EnvironmentStatus", + "traits": { + "smithy.api#documentation": "The status of the environment creation.
\nCREATE_REQUESTED – Environment creation has been requested.
\nCREATING – Environment is in the process of being created.
\nFAILED_CREATION – Environment creation has failed.
\nCREATED – Environment is successfully created and is currently active.
\nDELETE REQUESTED – Environment deletion has been requested.
\nDELETING – Environment is in the process of being deleted.
\nRETRY_DELETION – Initial environment deletion failed, system is reattempting delete.
\nDELETED – Environment has been deleted.
\nFAILED_DELETION – Environment deletion has failed.
\nThe status of the network configuration.
" + } + }, + "dnsStatus": { + "target": "com.amazonaws.finspace#dnsStatus", + "traits": { + "smithy.api#documentation": "The status of DNS configuration.
" + } + }, + "errorMessage": { + "target": "com.amazonaws.finspace#EnvironmentErrorMessage", + "traits": { + "smithy.api#documentation": "Specifies the error message that appears if a flow fails.
" + } + }, + "description": { + "target": "com.amazonaws.finspace#Description", + "traits": { + "smithy.api#documentation": "A description of the kdb environment.
" + } + }, + "environmentArn": { + "target": "com.amazonaws.finspace#EnvironmentArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of your kdb environment.
" + } + }, + "kmsKeyId": { + "target": "com.amazonaws.finspace#KmsKeyId", + "traits": { + "smithy.api#documentation": "The unique identifier of the KMS key.
" + } + }, + "dedicatedServiceAccountId": { + "target": "com.amazonaws.finspace#IdType", + "traits": { + "smithy.api#documentation": "A unique identifier for the AWS environment infrastructure account.
" + } + }, + "transitGatewayConfiguration": { + "target": "com.amazonaws.finspace#TransitGatewayConfiguration", + "traits": { + "smithy.api#documentation": "Specifies the transit gateway and network configuration to connect the kdb environment to an internal network.
" + } + }, + "customDNSConfiguration": { + "target": "com.amazonaws.finspace#CustomDNSConfiguration", + "traits": { + "smithy.api#documentation": "A list of DNS server name and server IP. This is used to set up Route-53 outbound resolvers.
" + } + }, + "creationTimestamp": { + "target": "com.amazonaws.finspace#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp at which the kdb environment was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" + } + }, + "updateTimestamp": { + "target": "com.amazonaws.finspace#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp at which the kdb environment was modified in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" + } + }, + "availabilityZoneIds": { + "target": "com.amazonaws.finspace#AvailabilityZoneIds", + "traits": { + "smithy.api#documentation": "The identifier of the availability zones where subnets for the environment are created.
" + } + }, + "certificateAuthorityArn": { + "target": "com.amazonaws.finspace#stringValueLength1to255", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the certificate authority:
" + } + } + }, + "traits": { + "smithy.api#documentation": "The details of a kdb environment.
" + } + }, + "com.amazonaws.finspace#KxEnvironmentId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 32 + }, + "smithy.api#pattern": "^[a-z0-9]+$" + } + }, + "com.amazonaws.finspace#KxEnvironmentList": { + "type": "list", + "member": { + "target": "com.amazonaws.finspace#KxEnvironment" + } + }, + "com.amazonaws.finspace#KxEnvironmentName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_]*[a-zA-Z0-9]$" + } + }, + "com.amazonaws.finspace#KxHostType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 32 + }, + "smithy.api#pattern": "^[a-zA-Z0-9._]+$" + } + }, + "com.amazonaws.finspace#KxNAS1Configuration": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.finspace#KxNAS1Type", + "traits": { + "smithy.api#documentation": "\nThe type of the network attached storage.\n
" + } + }, + "size": { + "target": "com.amazonaws.finspace#KxNAS1Size", + "traits": { + "smithy.api#documentation": "\n The size of the network attached storage. For storage type\n SSD_1000 and SSD_250 you can select the\n minimum size as 1200 GB or increments of 2400 GB. For storage type\n HDD_12 you can select the minimum size as 6000 GB or increments\n of 6000 GB.
\n The structure containing the size and type of the network attached storage (NAS_1) file system volume.\n
" + } + }, + "com.amazonaws.finspace#KxNAS1Size": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1200 + } + } + }, + "com.amazonaws.finspace#KxNAS1Type": { + "type": "enum", + "members": { + "SSD_1000": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SSD_1000" + } + }, + "SSD_250": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SSD_250" + } + }, + "HDD_12": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HDD_12" + } + } + } + }, + "com.amazonaws.finspace#KxNode": { + "type": "structure", + "members": { + "nodeId": { + "target": "com.amazonaws.finspace#KxClusterNodeIdString", + "traits": { + "smithy.api#documentation": "A unique identifier for the node.
" + } + }, + "availabilityZoneId": { + "target": "com.amazonaws.finspace#AvailabilityZoneId", + "traits": { + "smithy.api#documentation": "The identifier of the availability zones where subnets for the environment are created.
" + } + }, + "launchTime": { + "target": "com.amazonaws.finspace#Timestamp", + "traits": { + "smithy.api#documentation": "The time when a particular node is started. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" + } + }, + "status": { + "target": "com.amazonaws.finspace#KxNodeStatus", + "traits": { + "smithy.api#documentation": "\n Specifies the status of the cluster nodes.
\n\n RUNNING – The node is actively serving.
\n PROVISIONING – The node is being prepared.
A structure that stores metadata for a kdb node.
" + } + }, + "com.amazonaws.finspace#KxNodeStatus": { + "type": "enum", + "members": { + "RUNNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RUNNING" + } + }, + "PROVISIONING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROVISIONING" + } + } + } + }, + "com.amazonaws.finspace#KxNodeSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.finspace#KxNode" + } + }, + "com.amazonaws.finspace#KxSavedownStorageConfiguration": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.finspace#KxSavedownStorageType", + "traits": { + "smithy.api#documentation": "The type of writeable storage space for temporarily storing your savedown data. The valid values are:
\nSDS01 – This type represents 3000 IOPS and io2 ebs volume type.
\nThe size of temporary storage in gibibytes.
" + } + }, + "volumeName": { + "target": "com.amazonaws.finspace#KxVolumeName", + "traits": { + "smithy.api#documentation": "\n The name of the kdb volume that you want to use as writeable save-down storage for clusters.\n \n
" + } + } + }, + "traits": { + "smithy.api#documentation": "The size and type of temporary storage that is used to hold data during the savedown process. All the data written to this storage space is lost when the cluster node is restarted.
" + } + }, + "com.amazonaws.finspace#KxSavedownStorageSize": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 10, + "max": 16000 + } + } + }, + "com.amazonaws.finspace#KxSavedownStorageType": { + "type": "enum", + "members": { + "SDS01": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SDS01" + } + } + } + }, + "com.amazonaws.finspace#KxScalingGroup": { + "type": "structure", + "members": { + "scalingGroupName": { + "target": "com.amazonaws.finspace#KxScalingGroupName", + "traits": { + "smithy.api#documentation": "A unique identifier for the kdb scaling group.
" + } + }, + "hostType": { + "target": "com.amazonaws.finspace#KxHostType", + "traits": { + "smithy.api#documentation": "\n The memory and CPU capabilities of the scaling group host on which FinSpace Managed kdb clusters will be placed.
\nYou can add one of the following values:
\n\n kx.sg.large – The host type with a configuration of 16 GiB\n memory and 2 vCPUs.
\n kx.sg.xlarge – The host type with a configuration of 32 GiB\n memory and 4 vCPUs.
\n kx.sg.2xlarge – The host type with a configuration of 64 GiB\n memory and 8 vCPUs.
\n kx.sg.4xlarge – The host type with a configuration of 108 GiB memory and 16 vCPUs.
\n kx.sg.8xlarge – The host type with a configuration of 216 GiB memory and 32 vCPUs.
\n kx.sg.16xlarge – The host type with a configuration of 432 GiB memory and 64 vCPUs.
\n kx.sg.32xlarge – The host type with a configuration of 864 GiB memory and 128 vCPUs.
\n kx.sg1.16xlarge – The host type with a configuration of 1949 GiB memory and 64 vCPUs.
\n kx.sg1.24xlarge – The host type with a configuration of 2948 GiB memory and 96 vCPUs.
\n The list of clusters currently active in a given scaling group.\n \n
" + } + }, + "availabilityZoneId": { + "target": "com.amazonaws.finspace#AvailabilityZoneId", + "traits": { + "smithy.api#documentation": "The identifier of the availability zones.
" + } + }, + "status": { + "target": "com.amazonaws.finspace#KxScalingGroupStatus", + "traits": { + "smithy.api#documentation": "\nThe status of scaling groups.\n
" + } + }, + "statusReason": { + "target": "com.amazonaws.finspace#KxClusterStatusReason", + "traits": { + "smithy.api#documentation": "\nThe error message when a failed state occurs. \n
" + } + }, + "lastModifiedTimestamp": { + "target": "com.amazonaws.finspace#Timestamp", + "traits": { + "smithy.api#documentation": "\n The last time that the scaling group was updated in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.\n
" + } + }, + "createdTimestamp": { + "target": "com.amazonaws.finspace#Timestamp", + "traits": { + "smithy.api#documentation": "\n The timestamp at which the scaling group was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\nA structure for storing metadata of scaling group.
" + } + }, + "com.amazonaws.finspace#KxScalingGroupConfiguration": { + "type": "structure", + "members": { + "scalingGroupName": { + "target": "com.amazonaws.finspace#KxScalingGroupName", + "traits": { + "smithy.api#documentation": "A unique identifier for the kdb scaling group.
", + "smithy.api#required": {} + } + }, + "memoryLimit": { + "target": "com.amazonaws.finspace#MemoryMib", + "traits": { + "smithy.api#documentation": "\n An optional hard limit on the amount of memory a kdb cluster can use.\n \n
" + } + }, + "memoryReservation": { + "target": "com.amazonaws.finspace#MemoryMib", + "traits": { + "smithy.api#documentation": "\n A reservation of the minimum amount of memory that should be available on the scaling group for a kdb cluster to be successfully placed in a scaling group. \n \n
", + "smithy.api#required": {} + } + }, + "nodeCount": { + "target": "com.amazonaws.finspace#ClusterNodeCount", + "traits": { + "smithy.api#documentation": "\n The number of kdb cluster nodes.\n \n
", + "smithy.api#required": {} + } + }, + "cpu": { + "target": "com.amazonaws.finspace#CpuCount", + "traits": { + "smithy.api#documentation": "\n The number of vCPUs that you want to reserve for each node of this kdb cluster on the scaling group host.\n \n
" + } + } + }, + "traits": { + "smithy.api#documentation": "The structure that stores the capacity configuration details of a scaling group.
" + } + }, + "com.amazonaws.finspace#KxScalingGroupList": { + "type": "list", + "member": { + "target": "com.amazonaws.finspace#KxScalingGroup" + } + }, + "com.amazonaws.finspace#KxScalingGroupName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_]*[a-zA-Z0-9]$" + } + }, + "com.amazonaws.finspace#KxScalingGroupStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "CREATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_FAILED" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" + } + }, + "DELETE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_FAILED" + } + } + } + }, + "com.amazonaws.finspace#KxUser": { + "type": "structure", + "members": { + "userArn": { + "target": "com.amazonaws.finspace#KxUserArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies the user. For more information about ARNs and\n how to use ARNs in policies, see IAM Identifiers in the\n IAM User Guide.
" + } + }, + "userName": { + "target": "com.amazonaws.finspace#KxUserNameString", + "traits": { + "smithy.api#documentation": "A unique identifier for the user.
" + } + }, + "iamRole": { + "target": "com.amazonaws.finspace#RoleArn", + "traits": { + "smithy.api#documentation": "The IAM role ARN that is associated with the user.
" + } + }, + "createTimestamp": { + "target": "com.amazonaws.finspace#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp at which the kdb user was created.
" + } + }, + "updateTimestamp": { + "target": "com.amazonaws.finspace#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp at which the kdb user was updated.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A structure that stores metadata for a kdb user.
" + } + }, + "com.amazonaws.finspace#KxUserArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws:finspace:[A-Za-z0-9_/.-]{0,63}:\\d+:kxEnvironment/[0-9A-Za-z_-]{1,128}/kxUser/[0-9A-Za-z_-]{1,128}$" + } + }, + "com.amazonaws.finspace#KxUserList": { + "type": "list", + "member": { + "target": "com.amazonaws.finspace#KxUser" + } + }, + "com.amazonaws.finspace#KxUserNameString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + }, + "smithy.api#pattern": "^[0-9A-Za-z_-]{1,50}$" + } + }, + "com.amazonaws.finspace#KxVolume": { + "type": "structure", + "members": { + "volumeName": { + "target": "com.amazonaws.finspace#KxVolumeName", + "traits": { + "smithy.api#documentation": "A unique identifier for the volume.
" + } + }, + "volumeType": { + "target": "com.amazonaws.finspace#KxVolumeType", + "traits": { + "smithy.api#documentation": "\n The type of file system volume. Currently, FinSpace only supports NAS_1 volume type.\n
The status of volume.
\nCREATING – The volume creation is in progress.
\nCREATE_FAILED – The volume creation has failed.
\nACTIVE – The volume is active.
\nUPDATING – The volume is in the process of being updated.
\nUPDATE_FAILED – The update action failed.
\nUPDATED – The volume is successfully updated.
\nDELETING – The volume is in the process of being deleted.
\nDELETE_FAILED – The system failed to delete the volume.
\nDELETED – The volume is successfully deleted.
\n\nA description of the volume.\n
" + } + }, + "statusReason": { + "target": "com.amazonaws.finspace#KxVolumeStatusReason", + "traits": { + "smithy.api#documentation": "The error message when a failed state occurs.
" + } + }, + "azMode": { + "target": "com.amazonaws.finspace#KxAzMode", + "traits": { + "smithy.api#documentation": "The number of availability zones you want to assign per volume. Currently, FinSpace only supports SINGLE for volumes. This places dataview in a single AZ.
The identifier of the availability zones.
" + } + }, + "createdTimestamp": { + "target": "com.amazonaws.finspace#Timestamp", + "traits": { + "smithy.api#documentation": "\nThe timestamp at which the volume was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" + } + }, + "lastModifiedTimestamp": { + "target": "com.amazonaws.finspace#Timestamp", + "traits": { + "smithy.api#documentation": "The last time that the volume was updated in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" + } + } + }, + "traits": { + "smithy.api#documentation": "\nThe structure that contains the metadata of the volume.\n
" + } + }, + "com.amazonaws.finspace#KxVolumeArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws:finspace:[A-Za-z0-9_/.-]{0,63}:\\d+:kxEnvironment/[0-9A-Za-z_-]{1,128}(/kxSharedVolume/[a-zA-Z0-9_-]{1,255})?$" + } + }, + "com.amazonaws.finspace#KxVolumeName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_]*[a-zA-Z0-9]$" + } + }, + "com.amazonaws.finspace#KxVolumeStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "CREATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_FAILED" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "UPDATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATED" + } + }, + "UPDATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_FAILED" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" + } + }, + "DELETE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_FAILED" + } + } + } + }, + "com.amazonaws.finspace#KxVolumeStatusReason": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 250 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\_\\-\\.\\s]+$" + } + }, + "com.amazonaws.finspace#KxVolumeType": { + "type": "enum", + "members": { + "NAS_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NAS_1" + } + } + } + }, + "com.amazonaws.finspace#KxVolumes": { + "type": "list", + "member": { + "target": "com.amazonaws.finspace#KxVolume" + } + }, + "com.amazonaws.finspace#LimitExceededException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.finspace#ErrorMessage2" + } + }, + "traits": { + "smithy.api#documentation": "A service limit or quota is exceeded.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.finspace#ListEnvironments": { + "type": "operation", + "input": { + "target": "com.amazonaws.finspace#ListEnvironmentsRequest" + }, + "output": { + "target": "com.amazonaws.finspace#ListEnvironmentsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.finspace#AccessDeniedException" + }, + { + "target": "com.amazonaws.finspace#InternalServerException" + }, + { + "target": "com.amazonaws.finspace#ValidationException" + } + ], + "traits": { + "smithy.api#deprecated": { + "message": "This method will be discontinued." + }, + "smithy.api#documentation": "A list of all of your FinSpace environments.
", + "smithy.api#http": { + "method": "GET", + "uri": "/environment", + "code": 200 + } + } + }, + "com.amazonaws.finspace#ListEnvironmentsRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.finspace#PaginationToken", + "traits": { + "smithy.api#documentation": "A token generated by FinSpace that specifies where to continue pagination if a previous\n request was truncated. To get the next set of pages, pass in the nextTokennextToken value from the\n response object of the previous page call.
The maximum number of results to return in this request.
", + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.finspace#ListEnvironmentsResponse": { + "type": "structure", + "members": { + "environments": { + "target": "com.amazonaws.finspace#EnvironmentList", + "traits": { + "smithy.api#documentation": "A list of all of your FinSpace environments.
" + } + }, + "nextToken": { + "target": "com.amazonaws.finspace#PaginationToken", + "traits": { + "smithy.api#documentation": "A token that you can use in a subsequent call to retrieve the next set of\n results.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.finspace#ListKxChangesets": { + "type": "operation", + "input": { + "target": "com.amazonaws.finspace#ListKxChangesetsRequest" + }, + "output": { + "target": "com.amazonaws.finspace#ListKxChangesetsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.finspace#AccessDeniedException" + }, + { + "target": "com.amazonaws.finspace#InternalServerException" + }, + { + "target": "com.amazonaws.finspace#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.finspace#ThrottlingException" + }, + { + "target": "com.amazonaws.finspace#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns a list of all the changesets for a database.
", + "smithy.api#http": { + "method": "GET", + "uri": "/kx/environments/{environmentId}/databases/{databaseName}/changesets", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.finspace#ListKxChangesetsRequest": { + "type": "structure", + "members": { + "environmentId": { + "target": "com.amazonaws.finspace#EnvironmentId", + "traits": { + "smithy.api#documentation": "A unique identifier for the kdb environment.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "databaseName": { + "target": "com.amazonaws.finspace#DatabaseName", + "traits": { + "smithy.api#documentation": "The name of the kdb database.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.finspace#PaginationToken", + "traits": { + "smithy.api#documentation": "A token that indicates where a results page should begin.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.finspace#MaxResults", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The maximum number of results to return in this request.
", + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.finspace#ListKxChangesetsResponse": { + "type": "structure", + "members": { + "kxChangesets": { + "target": "com.amazonaws.finspace#KxChangesets", + "traits": { + "smithy.api#documentation": "A list of changesets for a database.
" + } + }, + "nextToken": { + "target": "com.amazonaws.finspace#PaginationToken", + "traits": { + "smithy.api#documentation": "A token that indicates where a results page should begin.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.finspace#ListKxClusterNodes": { + "type": "operation", + "input": { + "target": "com.amazonaws.finspace#ListKxClusterNodesRequest" + }, + "output": { + "target": "com.amazonaws.finspace#ListKxClusterNodesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.finspace#AccessDeniedException" + }, + { + "target": "com.amazonaws.finspace#InternalServerException" + }, + { + "target": "com.amazonaws.finspace#LimitExceededException" + }, + { + "target": "com.amazonaws.finspace#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.finspace#ThrottlingException" + }, + { + "target": "com.amazonaws.finspace#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists all the nodes in a kdb cluster.
", + "smithy.api#http": { + "method": "GET", + "uri": "/kx/environments/{environmentId}/clusters/{clusterName}/nodes", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.finspace#ListKxClusterNodesRequest": { + "type": "structure", + "members": { + "environmentId": { + "target": "com.amazonaws.finspace#KxEnvironmentId", + "traits": { + "smithy.api#documentation": "A unique identifier for the kdb environment.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "clusterName": { + "target": "com.amazonaws.finspace#KxClusterName", + "traits": { + "smithy.api#documentation": "A unique name for the cluster.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.finspace#PaginationToken", + "traits": { + "smithy.api#documentation": "A token that indicates where a results page should begin.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.finspace#ResultLimit", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The maximum number of results to return in this request.
", + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.finspace#ListKxClusterNodesResponse": { + "type": "structure", + "members": { + "nodes": { + "target": "com.amazonaws.finspace#KxNodeSummaries", + "traits": { + "smithy.api#documentation": "A list of nodes associated with the cluster.
" + } + }, + "nextToken": { + "target": "com.amazonaws.finspace#PaginationToken", + "traits": { + "smithy.api#documentation": "A token that indicates where a results page should begin.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.finspace#ListKxClusters": { + "type": "operation", + "input": { + "target": "com.amazonaws.finspace#ListKxClustersRequest" + }, + "output": { + "target": "com.amazonaws.finspace#ListKxClustersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.finspace#AccessDeniedException" + }, + { + "target": "com.amazonaws.finspace#ConflictException" + }, + { + "target": "com.amazonaws.finspace#InternalServerException" + }, + { + "target": "com.amazonaws.finspace#LimitExceededException" + }, + { + "target": "com.amazonaws.finspace#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.finspace#ThrottlingException" + }, + { + "target": "com.amazonaws.finspace#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns a list of clusters.
", + "smithy.api#http": { + "method": "GET", + "uri": "/kx/environments/{environmentId}/clusters", + "code": 200 + } + } + }, + "com.amazonaws.finspace#ListKxClustersRequest": { + "type": "structure", + "members": { + "environmentId": { + "target": "com.amazonaws.finspace#KxEnvironmentId", + "traits": { + "smithy.api#documentation": "A unique identifier for the kdb environment.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "clusterType": { + "target": "com.amazonaws.finspace#KxClusterType", + "traits": { + "smithy.api#documentation": "Specifies the type of KDB database that is being created. The following types are available:
\nHDB – A Historical Database. The data is only accessible with read-only permissions from one of the FinSpace managed kdb databases mounted to the cluster.
\nRDB – A Realtime Database. This type of database captures all the data from a ticker plant and stores it in memory until the end of day, after which it writes all of its data to a disk and reloads the HDB. This cluster type requires local storage for temporary storage of data during the savedown process. If you specify this field in your request, you must provide the savedownStorageConfiguration parameter.
GATEWAY – A gateway cluster allows you to access data across processes in kdb systems. It allows you to create your own routing logic using the initialization scripts and custom code. This type of cluster does not require a writable local storage.
\nGP – A general purpose cluster allows you to quickly iterate on code during development by granting greater access to system commands and enabling a fast reload of custom code. This cluster type can optionally mount databases including cache and savedown storage. For this cluster type, the node count is fixed at 1. It does not support autoscaling and supports only SINGLE AZ mode.
Tickerplant – A tickerplant cluster allows you to subscribe to feed handlers based on IAM permissions. It can publish to RDBs, other Tickerplants, and real-time subscribers (RTS). Tickerplants can persist messages to log, which is readable by any RDB environment. It supports only single-node that is only one kdb process.
\nThe maximum number of results to return in this request.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "nextToken": { + "target": "com.amazonaws.finspace#PaginationToken", + "traits": { + "smithy.api#documentation": "A token that indicates where a results page should begin.
", + "smithy.api#httpQuery": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.finspace#ListKxClustersResponse": { + "type": "structure", + "members": { + "kxClusterSummaries": { + "target": "com.amazonaws.finspace#KxClusters", + "traits": { + "smithy.api#documentation": "Lists the cluster details.
" + } + }, + "nextToken": { + "target": "com.amazonaws.finspace#PaginationToken", + "traits": { + "smithy.api#documentation": "A token that indicates where a results page should begin.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.finspace#ListKxDatabases": { + "type": "operation", + "input": { + "target": "com.amazonaws.finspace#ListKxDatabasesRequest" + }, + "output": { + "target": "com.amazonaws.finspace#ListKxDatabasesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.finspace#AccessDeniedException" + }, + { + "target": "com.amazonaws.finspace#InternalServerException" + }, + { + "target": "com.amazonaws.finspace#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.finspace#ThrottlingException" + }, + { + "target": "com.amazonaws.finspace#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns a list of all the databases in the kdb environment.
", + "smithy.api#http": { + "method": "GET", + "uri": "/kx/environments/{environmentId}/databases", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.finspace#ListKxDatabasesRequest": { + "type": "structure", + "members": { + "environmentId": { + "target": "com.amazonaws.finspace#EnvironmentId", + "traits": { + "smithy.api#documentation": "A unique identifier for the kdb environment.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.finspace#PaginationToken", + "traits": { + "smithy.api#documentation": "A token that indicates where a results page should begin.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.finspace#MaxResults", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The maximum number of results to return in this request.
", + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.finspace#ListKxDatabasesResponse": { + "type": "structure", + "members": { + "kxDatabases": { + "target": "com.amazonaws.finspace#KxDatabases", + "traits": { + "smithy.api#documentation": "A list of databases in the kdb environment.
" + } + }, + "nextToken": { + "target": "com.amazonaws.finspace#PaginationToken", + "traits": { + "smithy.api#documentation": "A token that indicates where a results page should begin.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.finspace#ListKxDataviews": { + "type": "operation", + "input": { + "target": "com.amazonaws.finspace#ListKxDataviewsRequest" + }, + "output": { + "target": "com.amazonaws.finspace#ListKxDataviewsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.finspace#AccessDeniedException" + }, + { + "target": "com.amazonaws.finspace#InternalServerException" + }, + { + "target": "com.amazonaws.finspace#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.finspace#ThrottlingException" + }, + { + "target": "com.amazonaws.finspace#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "\nReturns a list of all the dataviews in the database.
", + "smithy.api#http": { + "method": "GET", + "uri": "/kx/environments/{environmentId}/databases/{databaseName}/dataviews", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.finspace#ListKxDataviewsRequest": { + "type": "structure", + "members": { + "environmentId": { + "target": "com.amazonaws.finspace#EnvironmentId", + "traits": { + "smithy.api#documentation": "A unique identifier for the kdb environment, for which you want to retrieve a list of dataviews.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "databaseName": { + "target": "com.amazonaws.finspace#DatabaseName", + "traits": { + "smithy.api#documentation": "\nThe name of the database where the dataviews were created.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.finspace#PaginationToken", + "traits": { + "smithy.api#documentation": "\nA token that indicates where a results page should begin.\n
", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.finspace#MaxResults", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The maximum number of results to return in this request.
", + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.finspace#ListKxDataviewsResponse": { + "type": "structure", + "members": { + "kxDataviews": { + "target": "com.amazonaws.finspace#KxDataviews", + "traits": { + "smithy.api#documentation": "\n The list of kdb dataviews that are currently active for the given database.\n
" + } + }, + "nextToken": { + "target": "com.amazonaws.finspace#PaginationToken", + "traits": { + "smithy.api#documentation": "\nA token that indicates where a results page should begin.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.finspace#ListKxEnvironments": { + "type": "operation", + "input": { + "target": "com.amazonaws.finspace#ListKxEnvironmentsRequest" + }, + "output": { + "target": "com.amazonaws.finspace#ListKxEnvironmentsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.finspace#AccessDeniedException" + }, + { + "target": "com.amazonaws.finspace#InternalServerException" + }, + { + "target": "com.amazonaws.finspace#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns a list of kdb environments created in an account.
", + "smithy.api#http": { + "method": "GET", + "uri": "/kx/environments", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "environments", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.finspace#ListKxEnvironmentsRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.finspace#PaginationToken", + "traits": { + "smithy.api#documentation": "A token that indicates where a results page should begin.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.finspace#BoxedInteger", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in this request.
", + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.finspace#ListKxEnvironmentsResponse": { + "type": "structure", + "members": { + "environments": { + "target": "com.amazonaws.finspace#KxEnvironmentList", + "traits": { + "smithy.api#documentation": "A list of environments in an account.
" + } + }, + "nextToken": { + "target": "com.amazonaws.finspace#PaginationToken", + "traits": { + "smithy.api#documentation": "A token that indicates where a results page should begin.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.finspace#ListKxScalingGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.finspace#ListKxScalingGroupsRequest" + }, + "output": { + "target": "com.amazonaws.finspace#ListKxScalingGroupsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.finspace#AccessDeniedException" + }, + { + "target": "com.amazonaws.finspace#ConflictException" + }, + { + "target": "com.amazonaws.finspace#InternalServerException" + }, + { + "target": "com.amazonaws.finspace#LimitExceededException" + }, + { + "target": "com.amazonaws.finspace#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.finspace#ThrottlingException" + }, + { + "target": "com.amazonaws.finspace#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "\nReturns a list of scaling groups in a kdb environment.
", + "smithy.api#http": { + "method": "GET", + "uri": "/kx/environments/{environmentId}/scalingGroups", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.finspace#ListKxScalingGroupsRequest": { + "type": "structure", + "members": { + "environmentId": { + "target": "com.amazonaws.finspace#KxEnvironmentId", + "traits": { + "smithy.api#documentation": "A unique identifier for the kdb environment, for which you want to retrieve a list of scaling groups.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.finspace#MaxResults", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The maximum number of results to return in this request.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "nextToken": { + "target": "com.amazonaws.finspace#PaginationToken", + "traits": { + "smithy.api#documentation": "\nA token that indicates where a results page should begin.
", + "smithy.api#httpQuery": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.finspace#ListKxScalingGroupsResponse": { + "type": "structure", + "members": { + "scalingGroups": { + "target": "com.amazonaws.finspace#KxScalingGroupList", + "traits": { + "smithy.api#documentation": "\nA list of scaling groups available in a kdb environment.
" + } + }, + "nextToken": { + "target": "com.amazonaws.finspace#PaginationToken", + "traits": { + "smithy.api#documentation": "\nA token that indicates where a results page should begin.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.finspace#ListKxUsers": { + "type": "operation", + "input": { + "target": "com.amazonaws.finspace#ListKxUsersRequest" + }, + "output": { + "target": "com.amazonaws.finspace#ListKxUsersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.finspace#AccessDeniedException" + }, + { + "target": "com.amazonaws.finspace#InternalServerException" + }, + { + "target": "com.amazonaws.finspace#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.finspace#ThrottlingException" + }, + { + "target": "com.amazonaws.finspace#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists all the users in a kdb environment.
", + "smithy.api#http": { + "method": "GET", + "uri": "/kx/environments/{environmentId}/users", + "code": 200 + } + } + }, + "com.amazonaws.finspace#ListKxUsersRequest": { + "type": "structure", + "members": { + "environmentId": { + "target": "com.amazonaws.finspace#IdType", + "traits": { + "smithy.api#documentation": "A unique identifier for the kdb environment.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.finspace#PaginationToken", + "traits": { + "smithy.api#documentation": "A token that indicates where a results page should begin.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.finspace#ResultLimit", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The maximum number of results to return in this request.
", + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.finspace#ListKxUsersResponse": { + "type": "structure", + "members": { + "users": { + "target": "com.amazonaws.finspace#KxUserList", + "traits": { + "smithy.api#documentation": "A list of users in a kdb environment.
" + } + }, + "nextToken": { + "target": "com.amazonaws.finspace#PaginationToken", + "traits": { + "smithy.api#documentation": "A token that indicates where a results page should begin.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.finspace#ListKxVolumes": { + "type": "operation", + "input": { + "target": "com.amazonaws.finspace#ListKxVolumesRequest" + }, + "output": { + "target": "com.amazonaws.finspace#ListKxVolumesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.finspace#AccessDeniedException" + }, + { + "target": "com.amazonaws.finspace#ConflictException" + }, + { + "target": "com.amazonaws.finspace#InternalServerException" + }, + { + "target": "com.amazonaws.finspace#LimitExceededException" + }, + { + "target": "com.amazonaws.finspace#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.finspace#ThrottlingException" + }, + { + "target": "com.amazonaws.finspace#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "\nLists all the volumes in a kdb environment.\n
", + "smithy.api#http": { + "method": "GET", + "uri": "/kx/environments/{environmentId}/kxvolumes", + "code": 200 + } + } + }, + "com.amazonaws.finspace#ListKxVolumesRequest": { + "type": "structure", + "members": { + "environmentId": { + "target": "com.amazonaws.finspace#KxEnvironmentId", + "traits": { + "smithy.api#documentation": "A unique identifier for the kdb environment, whose clusters can attach to the volume.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.finspace#MaxResults", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The maximum number of results to return in this request.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "nextToken": { + "target": "com.amazonaws.finspace#PaginationToken", + "traits": { + "smithy.api#documentation": "A token that indicates where a results page should begin.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "volumeType": { + "target": "com.amazonaws.finspace#KxVolumeType", + "traits": { + "smithy.api#documentation": "\n The type of file system volume. Currently, FinSpace only supports NAS_1 volume type.\n
\nA summary of volumes.\n
" + } + }, + "nextToken": { + "target": "com.amazonaws.finspace#PaginationToken", + "traits": { + "smithy.api#documentation": "A token that indicates where a results page should begin.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.finspace#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.finspace#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.finspace#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.finspace#InternalServerException" + }, + { + "target": "com.amazonaws.finspace#InvalidRequestException" + }, + { + "target": "com.amazonaws.finspace#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "A list of all tags for a resource.
", + "smithy.api#http": { + "method": "GET", + "uri": "/tags/{resourceArn}", + "code": 200 + } + } + }, + "com.amazonaws.finspace#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.finspace#FinSpaceTaggableArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name of the resource.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.finspace#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "tags": { + "target": "com.amazonaws.finspace#TagMap", + "traits": { + "smithy.api#documentation": "A list of all tags for a resource.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.finspace#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.finspace#MemoryMib": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 6 + } + } + }, + "com.amazonaws.finspace#NameString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]{1,50}$" + } + }, + "com.amazonaws.finspace#NetworkACLConfiguration": { + "type": "list", + "member": { + "target": "com.amazonaws.finspace#NetworkACLEntry" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.finspace#NetworkACLEntry": { + "type": "structure", + "members": { + "ruleNumber": { + "target": "com.amazonaws.finspace#RuleNumber", + "traits": { + "smithy.api#documentation": "\n The rule number for the entry. For example 100. All the network ACL entries are processed in ascending order by rule number.\n \n
", + "smithy.api#required": {} + } + }, + "protocol": { + "target": "com.amazonaws.finspace#Protocol", + "traits": { + "smithy.api#documentation": "\n The protocol number. A value of -1 means all the protocols.\n
", + "smithy.api#required": {} + } + }, + "ruleAction": { + "target": "com.amazonaws.finspace#RuleAction", + "traits": { + "smithy.api#documentation": "\n Indicates whether to allow or deny the traffic that matches the rule.\n
", + "smithy.api#required": {} + } + }, + "portRange": { + "target": "com.amazonaws.finspace#PortRange", + "traits": { + "smithy.api#documentation": "\n The range of ports the rule applies to.\n
" + } + }, + "icmpTypeCode": { + "target": "com.amazonaws.finspace#IcmpTypeCode", + "traits": { + "smithy.api#documentation": "\n Defines the ICMP protocol that consists of the ICMP type and code.\n
" + } + }, + "cidrBlock": { + "target": "com.amazonaws.finspace#ValidCIDRBlock", + "traits": { + "smithy.api#documentation": "\n The IPv4 network range to allow or deny, in CIDR notation. For example, 172.16.0.0/24. We modify the specified CIDR block to its canonical form. For example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.\n
\n The network access control list (ACL) is an optional layer of security for your VPC that acts as a firewall for controlling traffic in and out of one or more subnets. The entry is a set of numbered ingress and egress rules that determine whether a packet should be allowed in or out of a subnet associated with the ACL. We process the entries in the ACL according to the rule numbers, in ascending order.\n
" + } + }, + "com.amazonaws.finspace#NodeCount": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.finspace#NodeType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 32 + }, + "smithy.api#pattern": "^[a-zA-Z0-9._]+$" + } + }, + "com.amazonaws.finspace#PaginationToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1000 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.finspace#Port": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0, + "max": 65535 + } + } + }, + "com.amazonaws.finspace#PortRange": { + "type": "structure", + "members": { + "from": { + "target": "com.amazonaws.finspace#Port", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "\n The first port in the range.\n
", + "smithy.api#required": {} + } + }, + "to": { + "target": "com.amazonaws.finspace#Port", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "\n The last port in the range.\n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "\n The range of ports the rule applies to.\n
" + } + }, + "com.amazonaws.finspace#Protocol": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + }, + "smithy.api#pattern": "^-1|[0-9]+$" + } + }, + "com.amazonaws.finspace#ReleaseLabel": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 16 + }, + "smithy.api#pattern": "^[a-zA-Z0-9._-]+$" + } + }, + "com.amazonaws.finspace#ResourceAlreadyExistsException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.finspace#ErrorMessage2" + } + }, + "traits": { + "smithy.api#documentation": "The specified resource group already exists.
", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.finspace#ResourceNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.finspace#ErrorMessage2" + } + }, + "traits": { + "smithy.api#documentation": "One or more resources can't be found.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.finspace#ResultLimit": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.finspace#RoleArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$" + } + }, + "com.amazonaws.finspace#RuleAction": { + "type": "enum", + "members": { + "ALLOW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "allow" + } + }, + "DENY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deny" + } + } + } + }, + "com.amazonaws.finspace#RuleNumber": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 32766 + } + } + }, + "com.amazonaws.finspace#S3Bucket": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 255 + }, + "smithy.api#pattern": "^[a-z0-9][a-z0-9\\.\\-]*[a-z0-9]$" + } + }, + "com.amazonaws.finspace#S3Key": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\/\\!\\-_\\.\\*'\\(\\)]+$" + } + }, + "com.amazonaws.finspace#S3ObjectVersion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.finspace#S3Path": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 9, + "max": 1093 + }, + "smithy.api#pattern": "^s3:\\/\\/[a-z0-9][a-z0-9-.]{1,61}[a-z0-9]\\/([^\\/]+\\/)*[^\\/]*$" + } + }, + "com.amazonaws.finspace#SamlMetadataDocument": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1000, + "max": 10000000 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.finspace#SecurityGroupIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.finspace#SecurityGroupIdString" + } + }, + "com.amazonaws.finspace#SecurityGroupIdString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^sg-([a-z0-9]{8}$|[a-z0-9]{17}$)$" + } + }, + "com.amazonaws.finspace#SegmentConfigurationDbPathList": { + "type": "list", + "member": { + "target": "com.amazonaws.finspace#DbPath" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 30 + } + } + }, + "com.amazonaws.finspace#ServiceQuotaExceededException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.finspace#ErrorMessage2" + } + }, + "traits": { + "smithy.api#documentation": "You have exceeded your service quota. To perform the requested action, \n remove some of the relevant resources, or use Service Quotas to request a service quota increase.
", + "smithy.api#error": "client", + "smithy.api#httpError": 402 + } + }, + "com.amazonaws.finspace#SignedKxConnectionString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^(:|:tcps:\\/\\/)[a-zA-Z0-9-\\.\\_]+:\\d+:[a-zA-Z0-9-\\.\\_]+:\\S+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.finspace#SmsDomainUrl": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1000 + }, + "smithy.api#pattern": "^[a-zA-Z-0-9-:\\/.]*$" + } + }, + "com.amazonaws.finspace#SubnetIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.finspace#SubnetIdString" + } + }, + "com.amazonaws.finspace#SubnetIdString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^subnet-([a-z0-9]{8}$|[a-z0-9]{17}$)$" + } + }, + "com.amazonaws.finspace#SuperuserParameters": { + "type": "structure", + "members": { + "emailAddress": { + "target": "com.amazonaws.finspace#EmailId", + "traits": { + "smithy.api#documentation": "The email address of the superuser.
", + "smithy.api#required": {} + } + }, + "firstName": { + "target": "com.amazonaws.finspace#NameString", + "traits": { + "smithy.api#documentation": "The first name of the superuser.
", + "smithy.api#required": {} + } + }, + "lastName": { + "target": "com.amazonaws.finspace#NameString", + "traits": { + "smithy.api#documentation": "The last name of the superuser.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration information for the superuser.
" + } + }, + "com.amazonaws.finspace#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$" + } + }, + "com.amazonaws.finspace#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.finspace#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.finspace#TagMap": { + "type": "map", + "key": { + "target": "com.amazonaws.finspace#TagKey" + }, + "value": { + "target": "com.amazonaws.finspace#TagValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.finspace#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.finspace#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.finspace#TagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.finspace#InternalServerException" + }, + { + "target": "com.amazonaws.finspace#InvalidRequestException" + }, + { + "target": "com.amazonaws.finspace#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Adds metadata tags to a FinSpace resource.
", + "smithy.api#http": { + "method": "POST", + "uri": "/tags/{resourceArn}", + "code": 200 + } + } + }, + "com.amazonaws.finspace#TagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.finspace#FinSpaceTaggableArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the resource.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.finspace#TagMap", + "traits": { + "smithy.api#documentation": "One or more tags to be assigned to the resource.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.finspace#TagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.finspace#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9+-=._:@ ]+$" + } + }, + "com.amazonaws.finspace#ThrottlingException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.finspace#ErrorMessage2" + } + }, + "traits": { + "smithy.api#documentation": "The request was denied due to request throttling.
", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, + "com.amazonaws.finspace#TickerplantLogConfiguration": { + "type": "structure", + "members": { + "tickerplantLogVolumes": { + "target": "com.amazonaws.finspace#TickerplantLogVolumes", + "traits": { + "smithy.api#documentation": "\nThe name of the volumes for tickerplant logs.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\nA configuration to store the Tickerplant logs. It consists of\na list of volumes that will be mounted to your cluster. For the cluster type Tickerplant, the location of the TP volume on the cluster will be available by using the global variable .aws.tp_log_path. \n
The identifier of the transit gateway created by the customer to connect outbound traffics from kdb network to your internal network.
", + "smithy.api#required": {} + } + }, + "routableCIDRSpace": { + "target": "com.amazonaws.finspace#ValidCIDRSpace", + "traits": { + "smithy.api#documentation": "The routing CIDR on behalf of kdb environment. It could be any \"/26 range in the 100.64.0.0 CIDR space. After providing, it will be added to the customer's transit gateway routing table so that the traffics could be routed to kdb network.
", + "smithy.api#required": {} + } + }, + "attachmentNetworkAclConfiguration": { + "target": "com.amazonaws.finspace#NetworkACLConfiguration", + "traits": { + "smithy.api#documentation": "\n The rules that define how you manage the outbound traffic from kdb network to your internal network.\n \n
" + } + } + }, + "traits": { + "smithy.api#documentation": "The structure of the transit gateway and network configuration that is used to connect the kdb environment to an internal network.
" + } + }, + "com.amazonaws.finspace#TransitGatewayID": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 32 + } + } + }, + "com.amazonaws.finspace#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.finspace#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.finspace#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.finspace#InternalServerException" + }, + { + "target": "com.amazonaws.finspace#InvalidRequestException" + }, + { + "target": "com.amazonaws.finspace#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Removes metadata tags from a FinSpace resource.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/tags/{resourceArn}", + "code": 200 + } + } + }, + "com.amazonaws.finspace#UntagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.finspace#FinSpaceTaggableArn", + "traits": { + "smithy.api#documentation": "A FinSpace resource from which you want to remove a tag or tags. The value for this\n parameter is an Amazon Resource Name (ARN).
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tagKeys": { + "target": "com.amazonaws.finspace#TagKeyList", + "traits": { + "smithy.api#documentation": "The tag keys (names) of one or more tags to be removed.
", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.finspace#UntagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.finspace#UpdateEnvironment": { + "type": "operation", + "input": { + "target": "com.amazonaws.finspace#UpdateEnvironmentRequest" + }, + "output": { + "target": "com.amazonaws.finspace#UpdateEnvironmentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.finspace#AccessDeniedException" + }, + { + "target": "com.amazonaws.finspace#InternalServerException" + }, + { + "target": "com.amazonaws.finspace#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.finspace#ThrottlingException" + }, + { + "target": "com.amazonaws.finspace#ValidationException" + } + ], + "traits": { + "smithy.api#deprecated": { + "message": "This method will be discontinued." + }, + "smithy.api#documentation": "Update your FinSpace environment.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/environment/{environmentId}", + "code": 200 + } + } + }, + "com.amazonaws.finspace#UpdateEnvironmentRequest": { + "type": "structure", + "members": { + "environmentId": { + "target": "com.amazonaws.finspace#IdType", + "traits": { + "smithy.api#documentation": "The identifier of the FinSpace environment.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.finspace#EnvironmentName", + "traits": { + "smithy.api#documentation": "The name of the environment.
" + } + }, + "description": { + "target": "com.amazonaws.finspace#Description", + "traits": { + "smithy.api#documentation": "The description of the environment.
" + } + }, + "federationMode": { + "target": "com.amazonaws.finspace#FederationMode", + "traits": { + "smithy.api#documentation": "Authentication mode for the environment.
\n\n FEDERATED - Users access FinSpace through Single Sign On (SSO) via your Identity provider.
\n LOCAL - Users access FinSpace via email and password managed within the FinSpace environment.
Returns the FinSpace environment object.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.finspace#UpdateKxClusterCodeConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.finspace#UpdateKxClusterCodeConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.finspace#UpdateKxClusterCodeConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.finspace#AccessDeniedException" + }, + { + "target": "com.amazonaws.finspace#ConflictException" + }, + { + "target": "com.amazonaws.finspace#InternalServerException" + }, + { + "target": "com.amazonaws.finspace#LimitExceededException" + }, + { + "target": "com.amazonaws.finspace#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.finspace#ThrottlingException" + }, + { + "target": "com.amazonaws.finspace#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "\n Allows you to update code configuration on a running cluster. By using this API you can update the code, the initialization script path, and the command line arguments for a specific cluster. \n The configuration that you want to update will override any existing configurations on the cluster. \n
", + "smithy.api#http": { + "method": "PUT", + "uri": "/kx/environments/{environmentId}/clusters/{clusterName}/configuration/code", + "code": 200 + } + } + }, + "com.amazonaws.finspace#UpdateKxClusterCodeConfigurationRequest": { + "type": "structure", + "members": { + "environmentId": { + "target": "com.amazonaws.finspace#KxEnvironmentId", + "traits": { + "smithy.api#documentation": "\n A unique identifier of the kdb environment.\n
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "clusterName": { + "target": "com.amazonaws.finspace#KxClusterName", + "traits": { + "smithy.api#documentation": "The name of the cluster.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.finspace#ClientTokenString", + "traits": { + "smithy.api#documentation": "A token that ensures idempotency. This token expires in 10 minutes.
", + "smithy.api#idempotencyToken": {} + } + }, + "code": { + "target": "com.amazonaws.finspace#CodeConfiguration", + "traits": { + "smithy.api#required": {} + } + }, + "initializationScript": { + "target": "com.amazonaws.finspace#InitializationScriptFilePath", + "traits": { + "smithy.api#documentation": "Specifies a Q program that will be run at launch of a cluster. It is a relative path within\n .zip file that contains the custom code, which will be loaded on\n the cluster. It must include the file name itself. For example,\n somedir/init.q.
You cannot update this parameter for a NO_RESTART deployment.
Specifies the key-value pairs to make them available inside the cluster.
\nYou cannot update this parameter for a NO_RESTART deployment.
\n The configuration that allows you to choose how you want to update the code on a cluster.\n
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.finspace#UpdateKxClusterCodeConfigurationResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.finspace#UpdateKxClusterDatabases": { + "type": "operation", + "input": { + "target": "com.amazonaws.finspace#UpdateKxClusterDatabasesRequest" + }, + "output": { + "target": "com.amazonaws.finspace#UpdateKxClusterDatabasesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.finspace#AccessDeniedException" + }, + { + "target": "com.amazonaws.finspace#ConflictException" + }, + { + "target": "com.amazonaws.finspace#InternalServerException" + }, + { + "target": "com.amazonaws.finspace#LimitExceededException" + }, + { + "target": "com.amazonaws.finspace#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.finspace#ThrottlingException" + }, + { + "target": "com.amazonaws.finspace#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates the databases mounted on a kdb cluster, which includes the changesetId and all the dbPaths to be cached. This API does not allow you to change a database name or add a database if you created a cluster without one.
Using this API you can point a cluster to a different changeset and modify a list of partitions being cached.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/kx/environments/{environmentId}/clusters/{clusterName}/configuration/databases", + "code": 200 + } + } + }, + "com.amazonaws.finspace#UpdateKxClusterDatabasesRequest": { + "type": "structure", + "members": { + "environmentId": { + "target": "com.amazonaws.finspace#KxEnvironmentId", + "traits": { + "smithy.api#documentation": "The unique identifier of a kdb environment.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "clusterName": { + "target": "com.amazonaws.finspace#KxClusterName", + "traits": { + "smithy.api#documentation": "A unique name for the cluster that you want to modify.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.finspace#ClientTokenString", + "traits": { + "smithy.api#documentation": "A token that ensures idempotency. This token expires in 10 minutes.
", + "smithy.api#idempotencyToken": {} + } + }, + "databases": { + "target": "com.amazonaws.finspace#KxDatabaseConfigurations", + "traits": { + "smithy.api#documentation": "The structure of databases mounted on the cluster.
", + "smithy.api#required": {} + } + }, + "deploymentConfiguration": { + "target": "com.amazonaws.finspace#KxDeploymentConfiguration", + "traits": { + "smithy.api#documentation": "\n The configuration that allows you to choose how you want to update the databases on a cluster.\n
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.finspace#UpdateKxClusterDatabasesResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.finspace#UpdateKxDatabase": { + "type": "operation", + "input": { + "target": "com.amazonaws.finspace#UpdateKxDatabaseRequest" + }, + "output": { + "target": "com.amazonaws.finspace#UpdateKxDatabaseResponse" + }, + "errors": [ + { + "target": "com.amazonaws.finspace#AccessDeniedException" + }, + { + "target": "com.amazonaws.finspace#ConflictException" + }, + { + "target": "com.amazonaws.finspace#InternalServerException" + }, + { + "target": "com.amazonaws.finspace#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.finspace#ThrottlingException" + }, + { + "target": "com.amazonaws.finspace#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates information for the given kdb database.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/kx/environments/{environmentId}/databases/{databaseName}", + "code": 200 + } + } + }, + "com.amazonaws.finspace#UpdateKxDatabaseRequest": { + "type": "structure", + "members": { + "environmentId": { + "target": "com.amazonaws.finspace#EnvironmentId", + "traits": { + "smithy.api#documentation": "A unique identifier for the kdb environment.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "databaseName": { + "target": "com.amazonaws.finspace#DatabaseName", + "traits": { + "smithy.api#documentation": "The name of the kdb database.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.finspace#Description", + "traits": { + "smithy.api#documentation": "A description of the database.
" + } + }, + "clientToken": { + "target": "com.amazonaws.finspace#ClientTokenString", + "traits": { + "smithy.api#documentation": "A token that ensures idempotency. This token expires in 10 minutes.
", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.finspace#UpdateKxDatabaseResponse": { + "type": "structure", + "members": { + "databaseName": { + "target": "com.amazonaws.finspace#DatabaseName", + "traits": { + "smithy.api#documentation": "The name of the kdb database.
" + } + }, + "environmentId": { + "target": "com.amazonaws.finspace#EnvironmentId", + "traits": { + "smithy.api#documentation": "A unique identifier for the kdb environment.
" + } + }, + "description": { + "target": "com.amazonaws.finspace#Description", + "traits": { + "smithy.api#documentation": "A description of the database.
" + } + }, + "lastModifiedTimestamp": { + "target": "com.amazonaws.finspace#Timestamp", + "traits": { + "smithy.api#documentation": "The last time that the database was modified. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.finspace#UpdateKxDataview": { + "type": "operation", + "input": { + "target": "com.amazonaws.finspace#UpdateKxDataviewRequest" + }, + "output": { + "target": "com.amazonaws.finspace#UpdateKxDataviewResponse" + }, + "errors": [ + { + "target": "com.amazonaws.finspace#AccessDeniedException" + }, + { + "target": "com.amazonaws.finspace#ConflictException" + }, + { + "target": "com.amazonaws.finspace#InternalServerException" + }, + { + "target": "com.amazonaws.finspace#ResourceAlreadyExistsException" + }, + { + "target": "com.amazonaws.finspace#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.finspace#ThrottlingException" + }, + { + "target": "com.amazonaws.finspace#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "\nUpdates the specified dataview. The dataviews get automatically updated when any new changesets are ingested. Each update of the dataview creates a new version, including changeset details and cache configurations
", + "smithy.api#http": { + "method": "PUT", + "uri": "/kx/environments/{environmentId}/databases/{databaseName}/dataviews/{dataviewName}", + "code": 200 + } + } + }, + "com.amazonaws.finspace#UpdateKxDataviewRequest": { + "type": "structure", + "members": { + "environmentId": { + "target": "com.amazonaws.finspace#EnvironmentId", + "traits": { + "smithy.api#documentation": "A unique identifier for the kdb environment, where you want to update the dataview.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "databaseName": { + "target": "com.amazonaws.finspace#DatabaseName", + "traits": { + "smithy.api#documentation": "\nThe name of the database.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "dataviewName": { + "target": "com.amazonaws.finspace#KxDataviewName", + "traits": { + "smithy.api#documentation": "The name of the dataview that you want to update.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.finspace#Description", + "traits": { + "smithy.api#documentation": "\n The description for a dataview.\n
" + } + }, + "changesetId": { + "target": "com.amazonaws.finspace#ChangesetId", + "traits": { + "smithy.api#documentation": "A unique identifier for the changeset.
" + } + }, + "segmentConfigurations": { + "target": "com.amazonaws.finspace#KxDataviewSegmentConfigurationList", + "traits": { + "smithy.api#documentation": "\n The configuration that contains the database path of the data that you want to place on each selected volume. Each segment must have a unique database path for each volume. If you do not explicitly specify any database path for a volume, they are accessible from the cluster through the default S3/object store segment.
" + } + }, + "clientToken": { + "target": "com.amazonaws.finspace#ClientTokenString", + "traits": { + "smithy.api#documentation": "A token that ensures idempotency. This token expires in 10 minutes.
", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.finspace#UpdateKxDataviewResponse": { + "type": "structure", + "members": { + "environmentId": { + "target": "com.amazonaws.finspace#EnvironmentId", + "traits": { + "smithy.api#documentation": "A unique identifier for the kdb environment, where you want to update the dataview.
" + } + }, + "databaseName": { + "target": "com.amazonaws.finspace#DatabaseName", + "traits": { + "smithy.api#documentation": "\nThe name of the database.\n
" + } + }, + "dataviewName": { + "target": "com.amazonaws.finspace#KxDataviewName", + "traits": { + "smithy.api#documentation": "\n The name of the database under which the dataview was created.\n \n
" + } + }, + "azMode": { + "target": "com.amazonaws.finspace#KxAzMode", + "traits": { + "smithy.api#documentation": "The number of availability zones you want to assign per volume. Currently, FinSpace only supports SINGLE for volumes. This places dataview in a single AZ.
\n The identifier of the availability zones.\n
" + } + }, + "changesetId": { + "target": "com.amazonaws.finspace#ChangesetId", + "traits": { + "smithy.api#documentation": "A unique identifier for the changeset.
" + } + }, + "segmentConfigurations": { + "target": "com.amazonaws.finspace#KxDataviewSegmentConfigurationList", + "traits": { + "smithy.api#documentation": "\n The configuration that contains the database path of the data that you want to place on each selected volume. Each segment must have a unique database path for each volume. If you do not explicitly specify any database path for a volume, they are accessible from the cluster through the default S3/object store segment.
" + } + }, + "activeVersions": { + "target": "com.amazonaws.finspace#KxDataviewActiveVersionList", + "traits": { + "smithy.api#documentation": "\n The current active changeset versions of the database on the given dataview. \n \n
" + } + }, + "status": { + "target": "com.amazonaws.finspace#KxDataviewStatus", + "traits": { + "smithy.api#documentation": "\n The status of dataview creation.
\n\n CREATING – The dataview creation is in progress.
\n UPDATING – The dataview is in the process of being updated.
\n ACTIVE – The dataview is active.
The option to specify whether you want to apply all the future additions and corrections automatically to the dataview when new changesets are ingested. The default value is false.
" + } + }, + "readWrite": { + "target": "com.amazonaws.finspace#booleanValue", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Returns True if the dataview is created as writeable and False otherwise.
" + } + }, + "description": { + "target": "com.amazonaws.finspace#Description", + "traits": { + "smithy.api#documentation": "A description of the dataview.
" + } + }, + "createdTimestamp": { + "target": "com.amazonaws.finspace#Timestamp", + "traits": { + "smithy.api#documentation": "\n The timestamp at which the dataview was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.\n
" + } + }, + "lastModifiedTimestamp": { + "target": "com.amazonaws.finspace#Timestamp", + "traits": { + "smithy.api#documentation": "\n The last time that the dataview was updated in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.\n
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.finspace#UpdateKxEnvironment": { + "type": "operation", + "input": { + "target": "com.amazonaws.finspace#UpdateKxEnvironmentRequest" + }, + "output": { + "target": "com.amazonaws.finspace#UpdateKxEnvironmentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.finspace#AccessDeniedException" + }, + { + "target": "com.amazonaws.finspace#ConflictException" + }, + { + "target": "com.amazonaws.finspace#InternalServerException" + }, + { + "target": "com.amazonaws.finspace#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.finspace#ThrottlingException" + }, + { + "target": "com.amazonaws.finspace#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates information for the given kdb environment.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/kx/environments/{environmentId}", + "code": 200 + } + } + }, + "com.amazonaws.finspace#UpdateKxEnvironmentNetwork": { + "type": "operation", + "input": { + "target": "com.amazonaws.finspace#UpdateKxEnvironmentNetworkRequest" + }, + "output": { + "target": "com.amazonaws.finspace#UpdateKxEnvironmentNetworkResponse" + }, + "errors": [ + { + "target": "com.amazonaws.finspace#AccessDeniedException" + }, + { + "target": "com.amazonaws.finspace#ConflictException" + }, + { + "target": "com.amazonaws.finspace#InternalServerException" + }, + { + "target": "com.amazonaws.finspace#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.finspace#ThrottlingException" + }, + { + "target": "com.amazonaws.finspace#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates environment network to connect to your internal network by using a transit gateway. This API supports request to create a transit gateway attachment from FinSpace VPC to your transit gateway ID and create a custom Route-53 outbound resolvers.
\nOnce you send a request to update a network, you cannot change it again. Network update might require termination of any clusters that are running in the existing network.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/kx/environments/{environmentId}/network", + "code": 200 + } + } + }, + "com.amazonaws.finspace#UpdateKxEnvironmentNetworkRequest": { + "type": "structure", + "members": { + "environmentId": { + "target": "com.amazonaws.finspace#IdType", + "traits": { + "smithy.api#documentation": "A unique identifier for the kdb environment.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "transitGatewayConfiguration": { + "target": "com.amazonaws.finspace#TransitGatewayConfiguration", + "traits": { + "smithy.api#documentation": "Specifies the transit gateway and network configuration to connect the kdb environment to an internal network.
" + } + }, + "customDNSConfiguration": { + "target": "com.amazonaws.finspace#CustomDNSConfiguration", + "traits": { + "smithy.api#documentation": "A list of DNS server name and server IP. This is used to set up Route-53 outbound resolvers.
" + } + }, + "clientToken": { + "target": "com.amazonaws.finspace#ClientToken", + "traits": { + "smithy.api#documentation": "A token that ensures idempotency. This token expires in 10 minutes.
", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.finspace#UpdateKxEnvironmentNetworkResponse": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.finspace#KxEnvironmentName", + "traits": { + "smithy.api#documentation": "The name of the kdb environment.
" + } + }, + "environmentId": { + "target": "com.amazonaws.finspace#IdType", + "traits": { + "smithy.api#documentation": "A unique identifier for the kdb environment.
" + } + }, + "awsAccountId": { + "target": "com.amazonaws.finspace#IdType", + "traits": { + "smithy.api#documentation": "The unique identifier of the AWS account that is used to create the kdb environment.
" + } + }, + "status": { + "target": "com.amazonaws.finspace#EnvironmentStatus", + "traits": { + "smithy.api#documentation": "The status of the kdb environment.
" + } + }, + "tgwStatus": { + "target": "com.amazonaws.finspace#tgwStatus", + "traits": { + "smithy.api#documentation": "The status of the network configuration.
" + } + }, + "dnsStatus": { + "target": "com.amazonaws.finspace#dnsStatus", + "traits": { + "smithy.api#documentation": "The status of DNS configuration.
" + } + }, + "errorMessage": { + "target": "com.amazonaws.finspace#EnvironmentErrorMessage", + "traits": { + "smithy.api#documentation": "Specifies the error message that appears if a flow fails.
" + } + }, + "description": { + "target": "com.amazonaws.finspace#Description", + "traits": { + "smithy.api#documentation": "The description of the environment.
" + } + }, + "environmentArn": { + "target": "com.amazonaws.finspace#EnvironmentArn", + "traits": { + "smithy.api#documentation": "The ARN identifier of the environment.
" + } + }, + "kmsKeyId": { + "target": "com.amazonaws.finspace#KmsKeyId", + "traits": { + "smithy.api#documentation": "The KMS key ID to encrypt your data in the FinSpace environment.
" + } + }, + "dedicatedServiceAccountId": { + "target": "com.amazonaws.finspace#IdType", + "traits": { + "smithy.api#documentation": "A unique identifier for the AWS environment infrastructure account.
" + } + }, + "transitGatewayConfiguration": { + "target": "com.amazonaws.finspace#TransitGatewayConfiguration" + }, + "customDNSConfiguration": { + "target": "com.amazonaws.finspace#CustomDNSConfiguration", + "traits": { + "smithy.api#documentation": "A list of DNS server name and server IP. This is used to set up Route-53 outbound resolvers.
" + } + }, + "creationTimestamp": { + "target": "com.amazonaws.finspace#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp at which the kdb environment was created in FinSpace.
" + } + }, + "updateTimestamp": { + "target": "com.amazonaws.finspace#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp at which the kdb environment was updated.
" + } + }, + "availabilityZoneIds": { + "target": "com.amazonaws.finspace#AvailabilityZoneIds", + "traits": { + "smithy.api#documentation": "The identifier of the availability zones where subnets for the environment are created.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.finspace#UpdateKxEnvironmentRequest": { + "type": "structure", + "members": { + "environmentId": { + "target": "com.amazonaws.finspace#IdType", + "traits": { + "smithy.api#documentation": "A unique identifier for the kdb environment.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.finspace#KxEnvironmentName", + "traits": { + "smithy.api#documentation": "The name of the kdb environment.
" + } + }, + "description": { + "target": "com.amazonaws.finspace#Description", + "traits": { + "smithy.api#documentation": "A description of the kdb environment.
" + } + }, + "clientToken": { + "target": "com.amazonaws.finspace#ClientToken", + "traits": { + "smithy.api#documentation": "A token that ensures idempotency. This token expires in 10 minutes.
", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.finspace#UpdateKxEnvironmentResponse": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.finspace#KxEnvironmentName", + "traits": { + "smithy.api#documentation": "The name of the kdb environment.
" + } + }, + "environmentId": { + "target": "com.amazonaws.finspace#IdType", + "traits": { + "smithy.api#documentation": "A unique identifier for the kdb environment.
" + } + }, + "awsAccountId": { + "target": "com.amazonaws.finspace#IdType", + "traits": { + "smithy.api#documentation": "The unique identifier of the AWS account that is used to create the kdb environment.
" + } + }, + "status": { + "target": "com.amazonaws.finspace#EnvironmentStatus", + "traits": { + "smithy.api#documentation": "The status of the kdb environment.
" + } + }, + "tgwStatus": { + "target": "com.amazonaws.finspace#tgwStatus", + "traits": { + "smithy.api#documentation": "The status of the network configuration.
" + } + }, + "dnsStatus": { + "target": "com.amazonaws.finspace#dnsStatus", + "traits": { + "smithy.api#documentation": "The status of DNS configuration.
" + } + }, + "errorMessage": { + "target": "com.amazonaws.finspace#EnvironmentErrorMessage", + "traits": { + "smithy.api#documentation": "Specifies the error message that appears if a flow fails.
" + } + }, + "description": { + "target": "com.amazonaws.finspace#Description", + "traits": { + "smithy.api#documentation": "The description of the environment.
" + } + }, + "environmentArn": { + "target": "com.amazonaws.finspace#EnvironmentArn", + "traits": { + "smithy.api#documentation": "The ARN identifier of the environment.
" + } + }, + "kmsKeyId": { + "target": "com.amazonaws.finspace#KmsKeyId", + "traits": { + "smithy.api#documentation": "The KMS key ID to encrypt your data in the FinSpace environment.
" + } + }, + "dedicatedServiceAccountId": { + "target": "com.amazonaws.finspace#IdType", + "traits": { + "smithy.api#documentation": "A unique identifier for the AWS environment infrastructure account.
" + } + }, + "transitGatewayConfiguration": { + "target": "com.amazonaws.finspace#TransitGatewayConfiguration" + }, + "customDNSConfiguration": { + "target": "com.amazonaws.finspace#CustomDNSConfiguration", + "traits": { + "smithy.api#documentation": "A list of DNS server name and server IP. This is used to set up Route-53 outbound resolvers.
" + } + }, + "creationTimestamp": { + "target": "com.amazonaws.finspace#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp at which the kdb environment was created in FinSpace.
" + } + }, + "updateTimestamp": { + "target": "com.amazonaws.finspace#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp at which the kdb environment was updated.
" + } + }, + "availabilityZoneIds": { + "target": "com.amazonaws.finspace#AvailabilityZoneIds", + "traits": { + "smithy.api#documentation": "The identifier of the availability zones where subnets for the environment are created.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.finspace#UpdateKxUser": { + "type": "operation", + "input": { + "target": "com.amazonaws.finspace#UpdateKxUserRequest" + }, + "output": { + "target": "com.amazonaws.finspace#UpdateKxUserResponse" + }, + "errors": [ + { + "target": "com.amazonaws.finspace#AccessDeniedException" + }, + { + "target": "com.amazonaws.finspace#ConflictException" + }, + { + "target": "com.amazonaws.finspace#InternalServerException" + }, + { + "target": "com.amazonaws.finspace#LimitExceededException" + }, + { + "target": "com.amazonaws.finspace#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.finspace#ThrottlingException" + }, + { + "target": "com.amazonaws.finspace#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates the user details. You can only update the IAM role associated with a user.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/kx/environments/{environmentId}/users/{userName}", + "code": 200 + } + } + }, + "com.amazonaws.finspace#UpdateKxUserRequest": { + "type": "structure", + "members": { + "environmentId": { + "target": "com.amazonaws.finspace#IdType", + "traits": { + "smithy.api#documentation": "A unique identifier for the kdb environment.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "userName": { + "target": "com.amazonaws.finspace#KxUserNameString", + "traits": { + "smithy.api#documentation": "A unique identifier for the user.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "iamRole": { + "target": "com.amazonaws.finspace#RoleArn", + "traits": { + "smithy.api#documentation": "The IAM role ARN that is associated with the user.
", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.finspace#ClientToken", + "traits": { + "smithy.api#documentation": "A token that ensures idempotency. This token expires in 10 minutes.
", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.finspace#UpdateKxUserResponse": { + "type": "structure", + "members": { + "userName": { + "target": "com.amazonaws.finspace#KxUserNameString", + "traits": { + "smithy.api#documentation": "A unique identifier for the user.
" + } + }, + "userArn": { + "target": "com.amazonaws.finspace#KxUserArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies the user. For more information about ARNs and\n how to use ARNs in policies, see IAM Identifiers in the\n IAM User Guide.
" + } + }, + "environmentId": { + "target": "com.amazonaws.finspace#IdType", + "traits": { + "smithy.api#documentation": "A unique identifier for the kdb environment.
" + } + }, + "iamRole": { + "target": "com.amazonaws.finspace#RoleArn", + "traits": { + "smithy.api#documentation": "The IAM role ARN that is associated with the user.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.finspace#UpdateKxVolume": { + "type": "operation", + "input": { + "target": "com.amazonaws.finspace#UpdateKxVolumeRequest" + }, + "output": { + "target": "com.amazonaws.finspace#UpdateKxVolumeResponse" + }, + "errors": [ + { + "target": "com.amazonaws.finspace#AccessDeniedException" + }, + { + "target": "com.amazonaws.finspace#ConflictException" + }, + { + "target": "com.amazonaws.finspace#InternalServerException" + }, + { + "target": "com.amazonaws.finspace#LimitExceededException" + }, + { + "target": "com.amazonaws.finspace#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.finspace#ThrottlingException" + }, + { + "target": "com.amazonaws.finspace#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "\nUpdates the throughput or capacity of a volume. During the update process, the filesystem \nmight be unavailable for a few minutes. You can retry any operations after the update is complete.\n
", + "smithy.api#http": { + "method": "PATCH", + "uri": "/kx/environments/{environmentId}/kxvolumes/{volumeName}", + "code": 200 + } + } + }, + "com.amazonaws.finspace#UpdateKxVolumeRequest": { + "type": "structure", + "members": { + "environmentId": { + "target": "com.amazonaws.finspace#KxEnvironmentId", + "traits": { + "smithy.api#documentation": "A unique identifier for the kdb environment where you created the storage volume.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "volumeName": { + "target": "com.amazonaws.finspace#KxVolumeName", + "traits": { + "smithy.api#documentation": "\nA unique identifier for the volume.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.finspace#Description", + "traits": { + "smithy.api#documentation": "\nA description of the volume.\n
" + } + }, + "clientToken": { + "target": "com.amazonaws.finspace#ClientTokenString", + "traits": { + "smithy.api#documentation": "A token that ensures idempotency. This token expires in 10 minutes.
", + "smithy.api#idempotencyToken": {} + } + }, + "nas1Configuration": { + "target": "com.amazonaws.finspace#KxNAS1Configuration", + "traits": { + "smithy.api#documentation": "Specifies the configuration for the Network attached storage (NAS_1) file system volume.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.finspace#UpdateKxVolumeResponse": { + "type": "structure", + "members": { + "environmentId": { + "target": "com.amazonaws.finspace#KxEnvironmentId", + "traits": { + "smithy.api#documentation": "A unique identifier for the kdb environment where you want to update the volume.
" + } + }, + "volumeName": { + "target": "com.amazonaws.finspace#KxVolumeName", + "traits": { + "smithy.api#documentation": "A unique identifier for the volume that you want to update.
" + } + }, + "volumeType": { + "target": "com.amazonaws.finspace#KxVolumeType", + "traits": { + "smithy.api#documentation": "\n The type of file system volume. Currently, FinSpace only supports NAS_1 volume type.\n
\nThe ARN identifier of the volume.\n
" + } + }, + "nas1Configuration": { + "target": "com.amazonaws.finspace#KxNAS1Configuration", + "traits": { + "smithy.api#documentation": "Specifies the configuration for the Network attached storage (NAS_1) file system volume.
" + } + }, + "status": { + "target": "com.amazonaws.finspace#KxVolumeStatus", + "traits": { + "smithy.api#documentation": "The status of the volume.
\nCREATING – The volume creation is in progress.
\nCREATE_FAILED – The volume creation has failed.
\nACTIVE – The volume is active.
\nUPDATING – The volume is in the process of being updated.
\nUPDATE_FAILED – The update action failed.
\nUPDATED – The volume is successfully updated.
\nDELETING – The volume is in the process of being deleted.
\nDELETE_FAILED – The system failed to delete the volume.
\nDELETED – The volume is successfully deleted.
\n\nThe description for the volume.\n
" + } + }, + "statusReason": { + "target": "com.amazonaws.finspace#KxVolumeStatusReason", + "traits": { + "smithy.api#documentation": "The error message when a failed state occurs.
" + } + }, + "createdTimestamp": { + "target": "com.amazonaws.finspace#Timestamp", + "traits": { + "smithy.api#documentation": "\nThe timestamp at which the volume was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" + } + }, + "azMode": { + "target": "com.amazonaws.finspace#KxAzMode", + "traits": { + "smithy.api#documentation": "The number of availability zones you want to assign per volume. Currently, FinSpace only supports SINGLE for volumes. This places dataview in a single AZ.
The identifier of the availability zones.
" + } + }, + "lastModifiedTimestamp": { + "target": "com.amazonaws.finspace#Timestamp", + "traits": { + "smithy.api#documentation": "The last time that the volume was updated in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" + } + }, + "attachedClusters": { + "target": "com.amazonaws.finspace#KxAttachedClusters", + "traits": { + "smithy.api#documentation": "\nSpecifies the clusters that a volume is attached to.\n
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.finspace#ValidCIDRBlock": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 18 + }, + "smithy.api#pattern": "^(?:\\d{1,3}\\.){3}\\d{1,3}(?:\\/(?:3[0-2]|[12]\\d|\\d))$" + } + }, + "com.amazonaws.finspace#ValidCIDRSpace": { + "type": "string" + }, + "com.amazonaws.finspace#ValidHostname": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 255 + }, + "smithy.api#pattern": "^([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]{0,61}[a-zA-Z0-9])(\\.([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]{0,61}[a-zA-Z0-9]))*$" + } + }, + "com.amazonaws.finspace#ValidIPAddress": { + "type": "string", + "traits": { + "smithy.api#pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$" + } + }, + "com.amazonaws.finspace#ValidationException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.finspace#ErrorMessage2" + } + }, + "traits": { + "smithy.api#documentation": "The input fails to satisfy the constraints specified by an AWS service.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.finspace#VersionId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 26 + } + } + }, + "com.amazonaws.finspace#Volume": { + "type": "structure", + "members": { + "volumeName": { + "target": "com.amazonaws.finspace#VolumeName", + "traits": { + "smithy.api#documentation": "A unique identifier for the volume.
" + } + }, + "volumeType": { + "target": "com.amazonaws.finspace#VolumeType", + "traits": { + "smithy.api#documentation": "\n The type of file system volume. Currently, FinSpace only supports NAS_1 volume type.\n
\nThe structure that consists of name and type of volume.
" + } + }, + "com.amazonaws.finspace#VolumeName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_]*[a-zA-Z0-9]$" + } + }, + "com.amazonaws.finspace#VolumeType": { + "type": "enum", + "members": { + "NAS_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NAS_1" + } + } + } + }, + "com.amazonaws.finspace#Volumes": { + "type": "list", + "member": { + "target": "com.amazonaws.finspace#Volume" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5 + } + } + }, + "com.amazonaws.finspace#VpcConfiguration": { + "type": "structure", + "members": { + "vpcId": { + "target": "com.amazonaws.finspace#VpcIdString", + "traits": { + "smithy.api#documentation": "The identifier of the VPC endpoint.
" + } + }, + "securityGroupIds": { + "target": "com.amazonaws.finspace#SecurityGroupIdList", + "traits": { + "smithy.api#documentation": "The unique identifier of the VPC security group applied to the VPC endpoint ENI for the cluster.
" + } + }, + "subnetIds": { + "target": "com.amazonaws.finspace#SubnetIdList", + "traits": { + "smithy.api#documentation": "The identifier of the subnet that the Privatelink VPC endpoint uses to connect to the cluster.
" + } + }, + "ipAddressType": { + "target": "com.amazonaws.finspace#IPAddressType", + "traits": { + "smithy.api#documentation": "The IP address type for cluster network configuration parameters. The following type is available:
\nIP_V4 – IP address version 4
\nConfiguration details about the network where the Privatelink endpoint of the cluster resides.
" + } + }, + "com.amazonaws.finspace#VpcIdString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^vpc-([a-z0-9]{8}$|[a-z0-9]{17}$)$" + } + }, + "com.amazonaws.finspace#arn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:*:*:*:*:*$" + } + }, + "com.amazonaws.finspace#booleanValue": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, + "com.amazonaws.finspace#dnsStatus": { + "type": "enum", + "members": { + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + }, + "UPDATE_REQUESTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_REQUESTED" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "FAILED_UPDATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED_UPDATE" + } + }, + "SUCCESSFULLY_UPDATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCESSFULLY_UPDATED" + } + } + } + }, + "com.amazonaws.finspace#numBytes": { + "type": "long", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.finspace#numChangesets": { + "type": "integer", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.finspace#numFiles": { + "type": "integer", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.finspace#stringValueLength1to255": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.finspace#tgwStatus": { + "type": "enum", + "members": { + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + }, + "UPDATE_REQUESTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_REQUESTED" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "FAILED_UPDATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED_UPDATE" + } + }, + "SUCCESSFULLY_UPDATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCESSFULLY_UPDATED" + } + } + } + }, + "com.amazonaws.finspace#url": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1000 + }, + "smithy.api#pattern": "^https?://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]$" + } + }, + "com.amazonaws.finspace#urn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[A-Za-z0-9._\\-:\\/#\\+]+$" } - ], - "version": "1.0" - } - } - }, - "com.amazonaws.finspace#AccessDeniedException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.finspace#ErrorMessage2" - } - }, - "traits": { - "smithy.api#documentation": "You do not have sufficient access to perform this action.
", - "smithy.api#error": "client", - "smithy.api#httpError": 403 - } - }, - "com.amazonaws.finspace#AttachedClusterList": { - "type": "list", - "member": { - "target": "com.amazonaws.finspace#KxClusterName" - } - }, - "com.amazonaws.finspace#AttributeMap": { - "type": "map", - "key": { - "target": "com.amazonaws.finspace#FederationAttributeKey" - }, - "value": { - "target": "com.amazonaws.finspace#FederationAttributeValue" - } - }, - "com.amazonaws.finspace#AutoScalingConfiguration": { - "type": "structure", - "members": { - "minNodeCount": { - "target": "com.amazonaws.finspace#NodeCount", - "traits": { - "smithy.api#documentation": "The lowest number of nodes to scale. This value must be at least 1 and less than the maxNodeCount. If the nodes in a cluster belong to multiple availability zones, then minNodeCount must be at least 3.
The highest number of nodes to scale. This value cannot be greater than 5.
" - } - }, - "autoScalingMetric": { - "target": "com.amazonaws.finspace#AutoScalingMetric", - "traits": { - "smithy.api#documentation": " The metric your cluster will track in order to scale in and out. For example, CPU_UTILIZATION_PERCENTAGE is the average CPU usage across all the nodes in a cluster.
The desired value of the chosen autoScalingMetric. When the metric drops below this value, the cluster will scale in. When the metric goes above this value, the cluster will scale out. You can set the target value between 1 and 100 percent.
The duration in seconds that FinSpace will wait after a scale in event before initiating another scaling event.
" - } - }, - "scaleOutCooldownSeconds": { - "target": "com.amazonaws.finspace#CooldownTime", - "traits": { - "smithy.api#documentation": "The duration in seconds that FinSpace will wait after a scale out event before initiating another scaling event.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The configuration based on which FinSpace will scale in or scale out nodes in your cluster.
" - } - }, - "com.amazonaws.finspace#AutoScalingMetric": { - "type": "enum", - "members": { - "CPU_UTILIZATION_PERCENTAGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CPU_UTILIZATION_PERCENTAGE" - } - } - } - }, - "com.amazonaws.finspace#AutoScalingMetricTarget": { - "type": "double", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.finspace#AvailabilityZoneId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 8, - "max": 12 - }, - "smithy.api#pattern": "^[a-zA-Z0-9-]+$" - } - }, - "com.amazonaws.finspace#AvailabilityZoneIds": { - "type": "list", - "member": { - "target": "com.amazonaws.finspace#AvailabilityZoneId" - } - }, - "com.amazonaws.finspace#BoxedInteger": { - "type": "integer" - }, - "com.amazonaws.finspace#CapacityConfiguration": { - "type": "structure", - "members": { - "nodeType": { - "target": "com.amazonaws.finspace#NodeType", - "traits": { - "smithy.api#documentation": "The type that determines the hardware of the host computer used for your cluster instance. Each node type offers different memory and storage capabilities. Choose a node type based on the requirements of the application or software that you plan to run on your instance.
\nYou can only specify one of the following values:
\n\n kx.s.large – The node type with a configuration of 12 GiB memory and 2 vCPUs.
\n kx.s.xlarge – The node type with a configuration of 27 GiB memory and 4 vCPUs.
\n kx.s.2xlarge – The node type with a configuration of 54 GiB memory and 8 vCPUs.
\n kx.s.4xlarge – The node type with a configuration of 108 GiB memory and 16 vCPUs.
\n kx.s.8xlarge – The node type with a configuration of 216 GiB memory and 32 vCPUs.
\n kx.s.16xlarge – The node type with a configuration of 432 GiB memory and 64 vCPUs.
\n kx.s.32xlarge – The node type with a configuration of 864 GiB memory and 128 vCPUs.
The number of instances running in a cluster.
" - } - } - }, - "traits": { - "smithy.api#documentation": "A structure for the metadata of a cluster. It includes information like the CPUs needed, memory of instances, and number of instances.
" - } - }, - "com.amazonaws.finspace#ChangeRequest": { - "type": "structure", - "members": { - "changeType": { - "target": "com.amazonaws.finspace#ChangeType", - "traits": { - "smithy.api#documentation": "Defines the type of change request. A changeType can have the following values:
PUT – Adds or updates files in a database.
\nDELETE – Deletes files in a database.
\nDefines the S3 path of the source file that is required to add or update files in a database.
" - } - }, - "dbPath": { - "target": "com.amazonaws.finspace#DbPath", - "traits": { - "smithy.api#documentation": "Defines the path within the database directory.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "A list of change request objects.
" - } - }, - "com.amazonaws.finspace#ChangeRequests": { - "type": "list", - "member": { - "target": "com.amazonaws.finspace#ChangeRequest" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 32 - } - } - }, - "com.amazonaws.finspace#ChangeType": { - "type": "enum", - "members": { - "PUT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PUT" - } - }, - "DELETE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETE" - } - } - } - }, - "com.amazonaws.finspace#ChangesetId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 26 - }, - "smithy.api#pattern": "^[a-zA-Z0-9]+$" - } - }, - "com.amazonaws.finspace#ChangesetStatus": { - "type": "enum", - "members": { - "PENDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PENDING" - } - }, - "PROCESSING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PROCESSING" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - }, - "COMPLETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COMPLETED" - } - } - } - }, - "com.amazonaws.finspace#ClientToken": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 36 - }, - "smithy.api#pattern": "\\S" - } - }, - "com.amazonaws.finspace#ClientTokenString": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - }, - "smithy.api#pattern": "^[a-zA-Z0-9-]+$" - } - }, - "com.amazonaws.finspace#ClusterNodeCount": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1 - } - } - }, - "com.amazonaws.finspace#CodeConfiguration": { - "type": "structure", - "members": { - "s3Bucket": { - "target": "com.amazonaws.finspace#S3Bucket", - "traits": { - "smithy.api#documentation": "A unique name for the S3 bucket.
" - } - }, - "s3Key": { - "target": "com.amazonaws.finspace#S3Key", - "traits": { - "smithy.api#documentation": "The full S3 path (excluding bucket) to the .zip file. This file contains the code that is loaded onto the cluster when it's started.
" - } - }, - "s3ObjectVersion": { - "target": "com.amazonaws.finspace#S3ObjectVersion", - "traits": { - "smithy.api#documentation": "The version of an S3 object.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The structure of the customer code available within the running cluster.
" - } - }, - "com.amazonaws.finspace#ConflictException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.finspace#ErrorMessage2" - }, - "reason": { - "target": "com.amazonaws.finspace#ErrorMessage2", - "traits": { - "smithy.api#documentation": "The reason for the conflict exception.
" - } - } - }, - "traits": { - "smithy.api#documentation": "There was a conflict with this action, and it could not be completed.
", - "smithy.api#error": "client", - "smithy.api#httpError": 409 - } - }, - "com.amazonaws.finspace#CooldownTime": { - "type": "double", - "traits": { - "smithy.api#range": { - "min": 0, - "max": 100000 - } - } - }, - "com.amazonaws.finspace#CpuCount": { - "type": "double", - "traits": { - "smithy.api#range": { - "min": 0.1 - } - } - }, - "com.amazonaws.finspace#CreateEnvironment": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#CreateEnvironmentRequest" - }, - "output": { - "target": "com.amazonaws.finspace#CreateEnvironmentResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#LimitExceededException" - }, - { - "target": "com.amazonaws.finspace#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.finspace#ThrottlingException" - }, - { - "target": "com.amazonaws.finspace#ValidationException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "This method will be discontinued." - }, - "smithy.api#documentation": "Create a new FinSpace environment.
", - "smithy.api#http": { - "method": "POST", - "uri": "/environment", - "code": 200 - } - } - }, - "com.amazonaws.finspace#CreateEnvironmentRequest": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.finspace#EnvironmentName", - "traits": { - "smithy.api#documentation": "The name of the FinSpace environment to be created.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.finspace#Description", - "traits": { - "smithy.api#documentation": "The description of the FinSpace environment to be created.
" - } - }, - "kmsKeyId": { - "target": "com.amazonaws.finspace#KmsKeyId", - "traits": { - "smithy.api#documentation": "The KMS key id to encrypt your data in the FinSpace environment.
" - } - }, - "tags": { - "target": "com.amazonaws.finspace#TagMap", - "traits": { - "smithy.api#documentation": "Add tags to your FinSpace environment.
" - } - }, - "federationMode": { - "target": "com.amazonaws.finspace#FederationMode", - "traits": { - "smithy.api#documentation": "Authentication mode for the environment.
\n\n FEDERATED - Users access FinSpace through Single Sign On (SSO) via your Identity provider.
\n LOCAL - Users access FinSpace via email and password managed within the FinSpace environment.
Configuration information when authentication mode is FEDERATED.
" - } - }, - "superuserParameters": { - "target": "com.amazonaws.finspace#SuperuserParameters", - "traits": { - "smithy.api#documentation": "Configuration information for the superuser.
" - } - }, - "dataBundles": { - "target": "com.amazonaws.finspace#DataBundleArns", - "traits": { - "smithy.api#documentation": "The list of Amazon Resource Names (ARN) of the data bundles to install. Currently supported data bundle ARNs:
\n\n arn:aws:finspace:${Region}::data-bundle/capital-markets-sample - Contains sample Capital Markets datasets, categories and controlled vocabularies.
\n arn:aws:finspace:${Region}::data-bundle/taq (default) - Contains trades and quotes data in addition to sample Capital Markets data.
The unique identifier for FinSpace environment that you created.
" - } - }, - "environmentArn": { - "target": "com.amazonaws.finspace#EnvironmentArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the FinSpace environment that you created.
" - } - }, - "environmentUrl": { - "target": "com.amazonaws.finspace#url", - "traits": { - "smithy.api#documentation": "The sign-in URL for the web application of the FinSpace environment you created.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#CreateKxChangeset": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#CreateKxChangesetRequest" - }, - "output": { - "target": "com.amazonaws.finspace#CreateKxChangesetResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspace#ConflictException" - }, - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#LimitExceededException" - }, - { - "target": "com.amazonaws.finspace#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspace#ThrottlingException" - }, - { - "target": "com.amazonaws.finspace#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "\n Creates a changeset for a kdb database. A changeset allows you to add and delete existing files by using an ordered list of change requests.\n
", - "smithy.api#http": { - "method": "POST", - "uri": "/kx/environments/{environmentId}/databases/{databaseName}/changesets", - "code": 200 - } - } - }, - "com.amazonaws.finspace#CreateKxChangesetRequest": { - "type": "structure", - "members": { - "environmentId": { - "target": "com.amazonaws.finspace#EnvironmentId", - "traits": { - "smithy.api#documentation": "A unique identifier of the kdb environment.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "databaseName": { - "target": "com.amazonaws.finspace#DatabaseName", - "traits": { - "smithy.api#documentation": "The name of the kdb database.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "changeRequests": { - "target": "com.amazonaws.finspace#ChangeRequests", - "traits": { - "smithy.api#documentation": "A list of change request objects that are run in order. A change request object consists of changeType , s3Path, and dbPath. \n A changeType can have the following values:
PUT – Adds or updates files in a database.
\nDELETE – Deletes files in a database.
\nAll the change requests require a mandatory dbPath attribute that defines the\n path within the database directory. All database paths must start with a leading / and end\n with a trailing /. The s3Path attribute defines the s3 source file path and is\n required for a PUT change type. The s3path must end with a trailing / if it is\n a directory and must end without a trailing / if it is a file.
Here are few examples of how you can use the change request object:
\nThis request adds a single sym file at database root location.
\n\n { \"changeType\": \"PUT\", \"s3Path\":\"s3://bucket/db/sym\",\n \"dbPath\":\"/\"}\n
This request adds files in the given s3Path under the 2020.01.02\n partition of the database.
\n { \"changeType\": \"PUT\", \"s3Path\":\"s3://bucket/db/2020.01.02/\",\n \"dbPath\":\"/2020.01.02/\"}\n
This request adds files in the given s3Path under the\n taq table partition of the database.
\n [ { \"changeType\": \"PUT\", \"s3Path\":\"s3://bucket/db/2020.01.02/taq/\",\n \"dbPath\":\"/2020.01.02/taq/\"}]\n
This request deletes the 2020.01.02 partition of the database.
\n\n [{ \"changeType\": \"DELETE\", \"dbPath\": \"/2020.01.02/\"} ]\n
The DELETE request allows you to delete the existing files under the\n 2020.01.02 partition of the database, and the PUT request adds a\n new taq table under it.
\n\n [ {\"changeType\": \"DELETE\", \"dbPath\":\"/2020.01.02/\"}, {\"changeType\": \"PUT\",\n \"s3Path\":\"s3://bucket/db/2020.01.02/taq/\",\n \"dbPath\":\"/2020.01.02/taq/\"}]\n
A token that ensures idempotency. This token expires in 10 minutes.
", - "smithy.api#idempotencyToken": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspace#CreateKxChangesetResponse": { - "type": "structure", - "members": { - "changesetId": { - "target": "com.amazonaws.finspace#ChangesetId", - "traits": { - "smithy.api#documentation": "A unique identifier for the changeset.
" - } - }, - "databaseName": { - "target": "com.amazonaws.finspace#DatabaseName", - "traits": { - "smithy.api#documentation": "The name of the kdb database.
" - } - }, - "environmentId": { - "target": "com.amazonaws.finspace#EnvironmentId", - "traits": { - "smithy.api#documentation": "A unique identifier for the kdb environment.
" - } - }, - "changeRequests": { - "target": "com.amazonaws.finspace#ChangeRequests", - "traits": { - "smithy.api#documentation": "A list of change requests.
" - } - }, - "createdTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "The timestamp at which the changeset was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" - } - }, - "lastModifiedTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "The timestamp at which the changeset was updated in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" - } - }, - "status": { - "target": "com.amazonaws.finspace#ChangesetStatus", - "traits": { - "smithy.api#documentation": "Status of the changeset creation process.
\nPending – Changeset creation is pending.
\nProcessing – Changeset creation is running.
\nFailed – Changeset creation has failed.
\nComplete – Changeset creation has succeeded.
\nThe details of the error that you receive when creating a changeset. It consists of the type of error and the error message.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#CreateKxCluster": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#CreateKxClusterRequest" - }, - "output": { - "target": "com.amazonaws.finspace#CreateKxClusterResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspace#ConflictException" - }, - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#LimitExceededException" - }, - { - "target": "com.amazonaws.finspace#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspace#ThrottlingException" - }, - { - "target": "com.amazonaws.finspace#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Creates a new kdb cluster.
", - "smithy.api#http": { - "method": "POST", - "uri": "/kx/environments/{environmentId}/clusters", - "code": 200 - } - } - }, - "com.amazonaws.finspace#CreateKxClusterRequest": { - "type": "structure", - "members": { - "clientToken": { - "target": "com.amazonaws.finspace#ClientToken", - "traits": { - "smithy.api#documentation": "A token that ensures idempotency. This token expires in 10 minutes.
", - "smithy.api#idempotencyToken": {} - } - }, - "environmentId": { - "target": "com.amazonaws.finspace#KxEnvironmentId", - "traits": { - "smithy.api#documentation": "A unique identifier for the kdb environment.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "clusterName": { - "target": "com.amazonaws.finspace#KxClusterName", - "traits": { - "smithy.api#documentation": "A unique name for the cluster that you want to create.
", - "smithy.api#required": {} - } - }, - "clusterType": { - "target": "com.amazonaws.finspace#KxClusterType", - "traits": { - "smithy.api#documentation": "Specifies the type of KDB database that is being created. The following types are available:
\nHDB – A Historical Database. The data is only accessible with read-only permissions from one of the FinSpace managed kdb databases mounted to the cluster.
\nRDB – A Realtime Database. This type of database captures all the data from a ticker plant and stores it in memory until the end of day, after which it writes all of its data to a disk and reloads the HDB. This cluster type requires local storage for temporary storage of data during the savedown process. If you specify this field in your request, you must provide the savedownStorageConfiguration parameter.
GATEWAY – A gateway cluster allows you to access data across processes in kdb systems. It allows you to create your own routing logic using the initialization scripts and custom code. This type of cluster does not require a writable local storage.
\nGP – A general purpose cluster allows you to quickly iterate on code during development by granting greater access to system commands and enabling a fast reload of custom code. This cluster type can optionally mount databases including cache and savedown storage. For this cluster type, the node count is fixed at 1. It does not support autoscaling and supports only SINGLE AZ mode.
Tickerplant – A tickerplant cluster allows you to subscribe to feed handlers based on IAM permissions. It can publish to RDBs, other Tickerplants, and real-time subscribers (RTS). Tickerplants can persist messages to log, which is readable by any RDB environment. It supports only single-node that is only one kdb process.
\n\nA configuration to store Tickerplant logs. It consists of\na list of volumes that will be mounted to your cluster. For the cluster type Tickerplant, the location of the TP volume on the cluster will be available by using the global variable .aws.tp_log_path. \n
A list of databases that will be available for querying.
" - } - }, - "cacheStorageConfigurations": { - "target": "com.amazonaws.finspace#KxCacheStorageConfigurations", - "traits": { - "smithy.api#documentation": "The configurations for a read only cache storage associated with a cluster. This cache will be stored as an FSx Lustre that reads from the S3 store.
" - } - }, - "autoScalingConfiguration": { - "target": "com.amazonaws.finspace#AutoScalingConfiguration", - "traits": { - "smithy.api#documentation": "The configuration based on which FinSpace will scale in or scale out nodes in your cluster.
" - } - }, - "clusterDescription": { - "target": "com.amazonaws.finspace#KxClusterDescription", - "traits": { - "smithy.api#documentation": "A description of the cluster.
" - } - }, - "capacityConfiguration": { - "target": "com.amazonaws.finspace#CapacityConfiguration", - "traits": { - "smithy.api#documentation": "A structure for the metadata of a cluster. It includes information like the CPUs needed, memory of instances, and number of instances.
" - } - }, - "releaseLabel": { - "target": "com.amazonaws.finspace#ReleaseLabel", - "traits": { - "smithy.api#documentation": "The version of FinSpace managed kdb to run.
", - "smithy.api#required": {} - } - }, - "vpcConfiguration": { - "target": "com.amazonaws.finspace#VpcConfiguration", - "traits": { - "smithy.api#documentation": "Configuration details about the network where the Privatelink endpoint of the cluster resides.
", - "smithy.api#required": {} - } - }, - "initializationScript": { - "target": "com.amazonaws.finspace#InitializationScriptFilePath", - "traits": { - "smithy.api#documentation": "Specifies a Q program that will be run at launch of a cluster. It is a relative path within\n .zip file that contains the custom code, which will be loaded on\n the cluster. It must include the file name itself. For example,\n somedir/init.q.
Defines the key-value pairs to make them available inside the cluster.
" - } - }, - "code": { - "target": "com.amazonaws.finspace#CodeConfiguration", - "traits": { - "smithy.api#documentation": "The details of the custom code that you want to use inside a cluster when analyzing a data. It consists of the S3 source bucket, location, S3 object version, and the relative path from where the custom code is loaded into the cluster.
" - } - }, - "executionRole": { - "target": "com.amazonaws.finspace#ExecutionRoleArn", - "traits": { - "smithy.api#documentation": "An IAM role that defines a set of permissions associated with a cluster. These permissions are assumed when a cluster attempts to access another cluster.
" - } - }, - "savedownStorageConfiguration": { - "target": "com.amazonaws.finspace#KxSavedownStorageConfiguration", - "traits": { - "smithy.api#documentation": "The size and type of the temporary storage that is used to hold data during the savedown process. This parameter is required when you choose clusterType as RDB. All the data written to this storage space is lost when the cluster node is restarted.
The number of availability zones you want to assign per cluster. This can be one of the following
\n\n SINGLE – Assigns one availability zone per cluster.
\n MULTI – Assigns all the availability zones per cluster.
The availability zone identifiers for the requested regions.
" - } - }, - "tags": { - "target": "com.amazonaws.finspace#TagMap", - "traits": { - "smithy.api#documentation": "A list of key-value pairs to label the cluster. You can add up to 50 tags to a cluster.
" - } - }, - "scalingGroupConfiguration": { - "target": "com.amazonaws.finspace#KxScalingGroupConfiguration", - "traits": { - "smithy.api#documentation": "The structure that stores the configuration details of a scaling group.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspace#CreateKxClusterResponse": { - "type": "structure", - "members": { - "environmentId": { - "target": "com.amazonaws.finspace#KxEnvironmentId", - "traits": { - "smithy.api#documentation": "A unique identifier for the kdb environment.
" - } - }, - "status": { - "target": "com.amazonaws.finspace#KxClusterStatus", - "traits": { - "smithy.api#documentation": "The status of cluster creation.
\nPENDING – The cluster is pending creation.
\nCREATING – The cluster creation process is in progress.
\nCREATE_FAILED – The cluster creation process has failed.
\nRUNNING – The cluster creation process is running.
\nUPDATING – The cluster is in the process of being updated.
\nDELETING – The cluster is in the process of being deleted.
\nDELETED – The cluster has been deleted.
\nDELETE_FAILED – The cluster failed to delete.
\nThe error message when a failed state occurs.
" - } - }, - "clusterName": { - "target": "com.amazonaws.finspace#KxClusterName", - "traits": { - "smithy.api#documentation": "A unique name for the cluster.
" - } - }, - "clusterType": { - "target": "com.amazonaws.finspace#KxClusterType", - "traits": { - "smithy.api#documentation": "Specifies the type of KDB database that is being created. The following types are available:
\nHDB – A Historical Database. The data is only accessible with read-only permissions from one of the FinSpace managed kdb databases mounted to the cluster.
\nRDB – A Realtime Database. This type of database captures all the data from a ticker plant and stores it in memory until the end of day, after which it writes all of its data to a disk and reloads the HDB. This cluster type requires local storage for temporary storage of data during the savedown process. If you specify this field in your request, you must provide the savedownStorageConfiguration parameter.
GATEWAY – A gateway cluster allows you to access data across processes in kdb systems. It allows you to create your own routing logic using the initialization scripts and custom code. This type of cluster does not require a writable local storage.
\nGP – A general purpose cluster allows you to quickly iterate on code during development by granting greater access to system commands and enabling a fast reload of custom code. This cluster type can optionally mount databases including cache and savedown storage. For this cluster type, the node count is fixed at 1. It does not support autoscaling and supports only SINGLE AZ mode.
Tickerplant – A tickerplant cluster allows you to subscribe to feed handlers based on IAM permissions. It can publish to RDBs, other Tickerplants, and real-time subscribers (RTS). Tickerplants can persist messages to log, which is readable by any RDB environment. It supports only single-node that is only one kdb process.
\n\nA list of volumes mounted on the cluster.\n
" - } - }, - "databases": { - "target": "com.amazonaws.finspace#KxDatabaseConfigurations", - "traits": { - "smithy.api#documentation": "A list of databases that will be available for querying.
" - } - }, - "cacheStorageConfigurations": { - "target": "com.amazonaws.finspace#KxCacheStorageConfigurations", - "traits": { - "smithy.api#documentation": "The configurations for a read only cache storage associated with a cluster. This cache will be stored as an FSx Lustre that reads from the S3 store.
" - } - }, - "autoScalingConfiguration": { - "target": "com.amazonaws.finspace#AutoScalingConfiguration", - "traits": { - "smithy.api#documentation": "The configuration based on which FinSpace will scale in or scale out nodes in your cluster.
" - } - }, - "clusterDescription": { - "target": "com.amazonaws.finspace#KxClusterDescription", - "traits": { - "smithy.api#documentation": "A description of the cluster.
" - } - }, - "capacityConfiguration": { - "target": "com.amazonaws.finspace#CapacityConfiguration", - "traits": { - "smithy.api#documentation": "A structure for the metadata of a cluster. It includes information like the CPUs needed, memory of instances, and number of instances.
" - } - }, - "releaseLabel": { - "target": "com.amazonaws.finspace#ReleaseLabel", - "traits": { - "smithy.api#documentation": "A version of the FinSpace managed kdb to run.
" - } - }, - "vpcConfiguration": { - "target": "com.amazonaws.finspace#VpcConfiguration", - "traits": { - "smithy.api#documentation": "Configuration details about the network where the Privatelink endpoint of the cluster resides.
" - } - }, - "initializationScript": { - "target": "com.amazonaws.finspace#InitializationScriptFilePath", - "traits": { - "smithy.api#documentation": "Specifies a Q program that will be run at launch of a cluster. It is a relative path within\n .zip file that contains the custom code, which will be loaded on\n the cluster. It must include the file name itself. For example,\n somedir/init.q.
Defines the key-value pairs to make them available inside the cluster.
" - } - }, - "code": { - "target": "com.amazonaws.finspace#CodeConfiguration", - "traits": { - "smithy.api#documentation": "The details of the custom code that you want to use inside a cluster when analyzing a data. It consists of the S3 source bucket, location, S3 object version, and the relative path from where the custom code is loaded into the cluster.
" - } - }, - "executionRole": { - "target": "com.amazonaws.finspace#ExecutionRoleArn", - "traits": { - "smithy.api#documentation": "\n An IAM role that defines a set of permissions associated with a cluster. These permissions are assumed when a cluster attempts to access another cluster.\n
" - } - }, - "lastModifiedTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "The last time that the cluster was modified. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" - } - }, - "savedownStorageConfiguration": { - "target": "com.amazonaws.finspace#KxSavedownStorageConfiguration", - "traits": { - "smithy.api#documentation": "The size and type of the temporary storage that is used to hold data during the savedown process. This parameter is required when you choose clusterType as RDB. All the data written to this storage space is lost when the cluster node is restarted.
The number of availability zones you want to assign per cluster. This can be one of the following
\n\n SINGLE – Assigns one availability zone per cluster.
\n MULTI – Assigns all the availability zones per cluster.
\n The availability zone identifiers for the requested regions.\n
" - } - }, - "createdTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "The timestamp at which the cluster was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" - } - }, - "scalingGroupConfiguration": { - "target": "com.amazonaws.finspace#KxScalingGroupConfiguration", - "traits": { - "smithy.api#documentation": "The structure that stores the configuration details of a scaling group.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#CreateKxDatabase": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#CreateKxDatabaseRequest" - }, - "output": { - "target": "com.amazonaws.finspace#CreateKxDatabaseResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspace#ConflictException" - }, - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#LimitExceededException" - }, - { - "target": "com.amazonaws.finspace#ResourceAlreadyExistsException" - }, - { - "target": "com.amazonaws.finspace#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspace#ThrottlingException" - }, - { - "target": "com.amazonaws.finspace#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Creates a new kdb database in the environment.
", - "smithy.api#http": { - "method": "POST", - "uri": "/kx/environments/{environmentId}/databases", - "code": 200 - } - } - }, - "com.amazonaws.finspace#CreateKxDatabaseRequest": { - "type": "structure", - "members": { - "environmentId": { - "target": "com.amazonaws.finspace#EnvironmentId", - "traits": { - "smithy.api#documentation": "A unique identifier for the kdb environment.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "databaseName": { - "target": "com.amazonaws.finspace#DatabaseName", - "traits": { - "smithy.api#documentation": "The name of the kdb database.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.finspace#Description", - "traits": { - "smithy.api#documentation": "A description of the database.
" - } - }, - "tags": { - "target": "com.amazonaws.finspace#TagMap", - "traits": { - "smithy.api#documentation": "A list of key-value pairs to label the kdb database. You can add up to 50 tags to your kdb database
" - } - }, - "clientToken": { - "target": "com.amazonaws.finspace#ClientTokenString", - "traits": { - "smithy.api#documentation": "A token that ensures idempotency. This token expires in 10 minutes.
", - "smithy.api#idempotencyToken": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspace#CreateKxDatabaseResponse": { - "type": "structure", - "members": { - "databaseName": { - "target": "com.amazonaws.finspace#DatabaseName", - "traits": { - "smithy.api#documentation": "The name of the kdb database.
" - } - }, - "databaseArn": { - "target": "com.amazonaws.finspace#DatabaseArn", - "traits": { - "smithy.api#documentation": "The ARN identifier of the database.
" - } - }, - "environmentId": { - "target": "com.amazonaws.finspace#EnvironmentId", - "traits": { - "smithy.api#documentation": "A unique identifier for the kdb environment.
" - } - }, - "description": { - "target": "com.amazonaws.finspace#Description", - "traits": { - "smithy.api#documentation": "A description of the database.
" - } - }, - "createdTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "The timestamp at which the database is created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" - } - }, - "lastModifiedTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "The last time that the database was updated in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#CreateKxDataview": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#CreateKxDataviewRequest" - }, - "output": { - "target": "com.amazonaws.finspace#CreateKxDataviewResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspace#ConflictException" - }, - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#LimitExceededException" - }, - { - "target": "com.amazonaws.finspace#ResourceAlreadyExistsException" - }, - { - "target": "com.amazonaws.finspace#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspace#ThrottlingException" - }, - { - "target": "com.amazonaws.finspace#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "\nCreates a snapshot of kdb database with tiered storage capabilities and a pre-warmed cache, ready for mounting on kdb clusters. Dataviews are only available for clusters running on a scaling group. They are not supported on dedicated clusters.
", - "smithy.api#http": { - "method": "POST", - "uri": "/kx/environments/{environmentId}/databases/{databaseName}/dataviews", - "code": 200 - } - } - }, - "com.amazonaws.finspace#CreateKxDataviewRequest": { - "type": "structure", - "members": { - "environmentId": { - "target": "com.amazonaws.finspace#EnvironmentId", - "traits": { - "smithy.api#documentation": "A unique identifier for the kdb environment, where you want to create the dataview.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "databaseName": { - "target": "com.amazonaws.finspace#DatabaseName", - "traits": { - "smithy.api#documentation": "\nThe name of the database where you want to create a dataview.\n
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "dataviewName": { - "target": "com.amazonaws.finspace#KxDataviewName", - "traits": { - "smithy.api#documentation": "A unique identifier for the dataview.
", - "smithy.api#required": {} - } - }, - "azMode": { - "target": "com.amazonaws.finspace#KxAzMode", - "traits": { - "smithy.api#documentation": "The number of availability zones you want to assign per volume. Currently, FinSpace only supports SINGLE for volumes. This places dataview in a single AZ.
\n The identifier of the availability zones.\n
" - } - }, - "changesetId": { - "target": "com.amazonaws.finspace#ChangesetId", - "traits": { - "smithy.api#documentation": "\nA unique identifier of the changeset that you want to use to ingest data.
" - } - }, - "segmentConfigurations": { - "target": "com.amazonaws.finspace#KxDataviewSegmentConfigurationList", - "traits": { - "smithy.api#documentation": "\n The configuration that contains the database path of the data that you want to place on each selected volume. Each segment must have a unique database path for each volume. If you do not explicitly specify any database path for a volume, they are accessible from the cluster through the default S3/object store segment.
" - } - }, - "autoUpdate": { - "target": "com.amazonaws.finspace#booleanValue", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "The option to specify whether you want to apply all the future additions and corrections automatically to the dataview, when you ingest new changesets. The default value is false.
" - } - }, - "readWrite": { - "target": "com.amazonaws.finspace#booleanValue", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "\n The option to specify whether you want to make the dataview writable to perform database maintenance. The following are some considerations related to writable dataviews.\u2028\u2028
\nYou cannot create partial writable dataviews. When you create writeable dataviews you must\n provide the entire database path.
\nYou cannot perform updates on a writeable dataview. Hence, autoUpdate must be set\n as False if readWrite is True for a dataview.
You must also use a unique volume for creating a writeable dataview. So, if you choose a\n volume that is already in use by another dataview, the dataview creation\n fails.
\nOnce you create a dataview as writeable, you cannot change it to read-only. So, you cannot\n update the readWrite parameter later.
A description of the dataview.
" - } - }, - "tags": { - "target": "com.amazonaws.finspace#TagMap", - "traits": { - "smithy.api#documentation": "\nA list of key-value pairs to label the dataview. You can add up to 50 tags to a dataview.\n
" - } - }, - "clientToken": { - "target": "com.amazonaws.finspace#ClientTokenString", - "traits": { - "smithy.api#documentation": "A token that ensures idempotency. This token expires in 10 minutes.
", - "smithy.api#idempotencyToken": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspace#CreateKxDataviewResponse": { - "type": "structure", - "members": { - "dataviewName": { - "target": "com.amazonaws.finspace#KxDataviewName", - "traits": { - "smithy.api#documentation": "A unique identifier for the dataview.
" - } - }, - "databaseName": { - "target": "com.amazonaws.finspace#DatabaseName", - "traits": { - "smithy.api#documentation": "The name of the database where you want to create a dataview.
" - } - }, - "environmentId": { - "target": "com.amazonaws.finspace#EnvironmentId", - "traits": { - "smithy.api#documentation": "A unique identifier for the kdb environment, where you want to create the dataview.
" - } - }, - "azMode": { - "target": "com.amazonaws.finspace#KxAzMode", - "traits": { - "smithy.api#documentation": "The number of availability zones you want to assign per volume. Currently, FinSpace only supports SINGLE for volumes. This places dataview in a single AZ.
\n The identifier of the availability zones.\n
" - } - }, - "changesetId": { - "target": "com.amazonaws.finspace#ChangesetId", - "traits": { - "smithy.api#documentation": "A unique identifier for the changeset.
" - } - }, - "segmentConfigurations": { - "target": "com.amazonaws.finspace#KxDataviewSegmentConfigurationList", - "traits": { - "smithy.api#documentation": "\n The configuration that contains the database path of the data that you want to place on each selected volume. Each segment must have a unique database path for each volume. If you do not explicitly specify any database path for a volume, they are accessible from the cluster through the default S3/object store segment.
" - } - }, - "description": { - "target": "com.amazonaws.finspace#Description", - "traits": { - "smithy.api#documentation": "A description of the dataview.
" - } - }, - "autoUpdate": { - "target": "com.amazonaws.finspace#booleanValue", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "The option to select whether you want to apply all the future additions and corrections automatically to the dataview when you ingest new changesets. The default value is false.
" - } - }, - "readWrite": { - "target": "com.amazonaws.finspace#booleanValue", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "Returns True if the dataview is created as writeable and False otherwise.
" - } - }, - "createdTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "\nThe timestamp at which the dataview was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" - } - }, - "lastModifiedTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "\nThe last time that the dataview was updated in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" - } - }, - "status": { - "target": "com.amazonaws.finspace#KxDataviewStatus", - "traits": { - "smithy.api#documentation": "\nThe status of dataview creation.
\n\n CREATING – The dataview creation is in progress.
\n UPDATING – The dataview is in the process of being updated.
\n ACTIVE – The dataview is active.
Creates a managed kdb environment for the account.
", - "smithy.api#http": { - "method": "POST", - "uri": "/kx/environments", - "code": 200 - } - } - }, - "com.amazonaws.finspace#CreateKxEnvironmentRequest": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.finspace#KxEnvironmentName", - "traits": { - "smithy.api#documentation": "The name of the kdb environment that you want to create.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.finspace#Description", - "traits": { - "smithy.api#documentation": "A description for the kdb environment.
" - } - }, - "kmsKeyId": { - "target": "com.amazonaws.finspace#KmsKeyARN", - "traits": { - "smithy.api#documentation": "The KMS key ID to encrypt your data in the FinSpace environment.
", - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.finspace#TagMap", - "traits": { - "smithy.api#documentation": "A list of key-value pairs to label the kdb environment. You can add up to 50 tags to your kdb environment.
" - } - }, - "clientToken": { - "target": "com.amazonaws.finspace#ClientToken", - "traits": { - "smithy.api#documentation": "A token that ensures idempotency. This token expires in 10 minutes.
", - "smithy.api#idempotencyToken": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspace#CreateKxEnvironmentResponse": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.finspace#KxEnvironmentName", - "traits": { - "smithy.api#documentation": "The name of the kdb environment.
" - } - }, - "status": { - "target": "com.amazonaws.finspace#EnvironmentStatus", - "traits": { - "smithy.api#documentation": "The status of the kdb environment.
" - } - }, - "environmentId": { - "target": "com.amazonaws.finspace#IdType", - "traits": { - "smithy.api#documentation": "A unique identifier for the kdb environment.
" - } - }, - "description": { - "target": "com.amazonaws.finspace#Description", - "traits": { - "smithy.api#documentation": "A description for the kdb environment.
" - } - }, - "environmentArn": { - "target": "com.amazonaws.finspace#EnvironmentArn", - "traits": { - "smithy.api#documentation": "The ARN identifier of the environment.
" - } - }, - "kmsKeyId": { - "target": "com.amazonaws.finspace#KmsKeyId", - "traits": { - "smithy.api#documentation": "The KMS key ID to encrypt your data in the FinSpace environment.
" - } - }, - "creationTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "The timestamp at which the kdb environment was created in FinSpace.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#CreateKxScalingGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#CreateKxScalingGroupRequest" - }, - "output": { - "target": "com.amazonaws.finspace#CreateKxScalingGroupResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspace#ConflictException" - }, - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#LimitExceededException" - }, - { - "target": "com.amazonaws.finspace#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspace#ThrottlingException" - }, - { - "target": "com.amazonaws.finspace#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Creates a new scaling group.
", - "smithy.api#http": { - "method": "POST", - "uri": "/kx/environments/{environmentId}/scalingGroups", - "code": 200 - } - } - }, - "com.amazonaws.finspace#CreateKxScalingGroupRequest": { - "type": "structure", - "members": { - "clientToken": { - "target": "com.amazonaws.finspace#ClientToken", - "traits": { - "smithy.api#documentation": "A token that ensures idempotency. This token expires in 10 minutes.
", - "smithy.api#idempotencyToken": {}, - "smithy.api#required": {} - } - }, - "environmentId": { - "target": "com.amazonaws.finspace#KxEnvironmentId", - "traits": { - "smithy.api#documentation": "A unique identifier for the kdb environment, where you want to create the scaling group.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "scalingGroupName": { - "target": "com.amazonaws.finspace#KxScalingGroupName", - "traits": { - "smithy.api#documentation": "A unique identifier for the kdb scaling group.
", - "smithy.api#required": {} - } - }, - "hostType": { - "target": "com.amazonaws.finspace#KxHostType", - "traits": { - "smithy.api#documentation": "\n The memory and CPU capabilities of the scaling group host on which FinSpace Managed kdb clusters will be placed.
\nYou can add one of the following values:
\n\n kx.sg.4xlarge – The host type with a configuration of 108 GiB memory and 16 vCPUs.
\n kx.sg.8xlarge – The host type with a configuration of 216 GiB memory and 32 vCPUs.
\n kx.sg.16xlarge – The host type with a configuration of 432 GiB memory and 64 vCPUs.
\n kx.sg.32xlarge – The host type with a configuration of 864 GiB memory and 128 vCPUs.
\n kx.sg1.16xlarge – The host type with a configuration of 1949 GiB memory and 64 vCPUs.
\n kx.sg1.24xlarge – The host type with a configuration of 2948 GiB memory and 96 vCPUs.
The identifier of the availability zones.
", - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.finspace#TagMap", - "traits": { - "smithy.api#documentation": "\nA list of key-value pairs to label the scaling group. You can add up to 50 tags to a scaling group.\n
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspace#CreateKxScalingGroupResponse": { - "type": "structure", - "members": { - "environmentId": { - "target": "com.amazonaws.finspace#KxEnvironmentId", - "traits": { - "smithy.api#documentation": "A unique identifier for the kdb environment, where you create the scaling group.
" - } - }, - "scalingGroupName": { - "target": "com.amazonaws.finspace#KxScalingGroupName", - "traits": { - "smithy.api#documentation": "A unique identifier for the kdb scaling group.
" - } - }, - "hostType": { - "target": "com.amazonaws.finspace#KxHostType", - "traits": { - "smithy.api#documentation": "\n The memory and CPU capabilities of the scaling group host on which FinSpace Managed kdb clusters will be placed.\n \n
" - } - }, - "availabilityZoneId": { - "target": "com.amazonaws.finspace#AvailabilityZoneId", - "traits": { - "smithy.api#documentation": "The identifier of the availability zones.
" - } - }, - "status": { - "target": "com.amazonaws.finspace#KxScalingGroupStatus", - "traits": { - "smithy.api#documentation": "The status of scaling group.
\nCREATING – The scaling group creation is in progress.
\nCREATE_FAILED – The scaling group creation has failed.
\nACTIVE – The scaling group is active.
\nUPDATING – The scaling group is in the process of being updated.
\nUPDATE_FAILED – The update action failed.
\nDELETING – The scaling group is in the process of being deleted.
\nDELETE_FAILED – The system failed to delete the scaling group.
\nDELETED – The scaling group is successfully deleted.
\n\nThe last time that the scaling group was updated in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" - } - }, - "createdTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "\n The timestamp at which the scaling group was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#CreateKxUser": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#CreateKxUserRequest" - }, - "output": { - "target": "com.amazonaws.finspace#CreateKxUserResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspace#ConflictException" - }, - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#LimitExceededException" - }, - { - "target": "com.amazonaws.finspace#ResourceAlreadyExistsException" - }, - { - "target": "com.amazonaws.finspace#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspace#ThrottlingException" - }, - { - "target": "com.amazonaws.finspace#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Creates a user in FinSpace kdb environment with an associated IAM role.
", - "smithy.api#http": { - "method": "POST", - "uri": "/kx/environments/{environmentId}/users", - "code": 200 - } - } - }, - "com.amazonaws.finspace#CreateKxUserRequest": { - "type": "structure", - "members": { - "environmentId": { - "target": "com.amazonaws.finspace#IdType", - "traits": { - "smithy.api#documentation": "A unique identifier for the kdb environment where you want to create a user.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "userName": { - "target": "com.amazonaws.finspace#KxUserNameString", - "traits": { - "smithy.api#documentation": "A unique identifier for the user.
", - "smithy.api#required": {} - } - }, - "iamRole": { - "target": "com.amazonaws.finspace#RoleArn", - "traits": { - "smithy.api#documentation": "The IAM role ARN that will be associated with the user.
", - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.finspace#TagMap", - "traits": { - "smithy.api#documentation": "A list of key-value pairs to label the user. You can add up to 50 tags to a user.
" - } - }, - "clientToken": { - "target": "com.amazonaws.finspace#ClientToken", - "traits": { - "smithy.api#documentation": "A token that ensures idempotency. This token expires in 10 minutes.
", - "smithy.api#idempotencyToken": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspace#CreateKxUserResponse": { - "type": "structure", - "members": { - "userName": { - "target": "com.amazonaws.finspace#KxUserNameString", - "traits": { - "smithy.api#documentation": "A unique identifier for the user.
" - } - }, - "userArn": { - "target": "com.amazonaws.finspace#KxUserArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies the user. For more information about ARNs and\n how to use ARNs in policies, see IAM Identifiers in the\n IAM User Guide.
" - } - }, - "environmentId": { - "target": "com.amazonaws.finspace#IdType", - "traits": { - "smithy.api#documentation": "A unique identifier for the kdb environment.
" - } - }, - "iamRole": { - "target": "com.amazonaws.finspace#RoleArn", - "traits": { - "smithy.api#documentation": "The IAM role ARN that will be associated with the user.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#CreateKxVolume": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#CreateKxVolumeRequest" - }, - "output": { - "target": "com.amazonaws.finspace#CreateKxVolumeResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspace#ConflictException" - }, - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#LimitExceededException" - }, - { - "target": "com.amazonaws.finspace#ResourceAlreadyExistsException" - }, - { - "target": "com.amazonaws.finspace#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspace#ThrottlingException" - }, - { - "target": "com.amazonaws.finspace#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "\nCreates a new volume with a specific amount of throughput and storage capacity.
", - "smithy.api#http": { - "method": "POST", - "uri": "/kx/environments/{environmentId}/kxvolumes", - "code": 200 - } - } - }, - "com.amazonaws.finspace#CreateKxVolumeRequest": { - "type": "structure", - "members": { - "clientToken": { - "target": "com.amazonaws.finspace#ClientToken", - "traits": { - "smithy.api#documentation": "A token that ensures idempotency. This token expires in 10 minutes.
", - "smithy.api#idempotencyToken": {} - } - }, - "environmentId": { - "target": "com.amazonaws.finspace#KxEnvironmentId", - "traits": { - "smithy.api#documentation": "A unique identifier for the kdb environment, whose clusters can attach to the volume.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "volumeType": { - "target": "com.amazonaws.finspace#KxVolumeType", - "traits": { - "smithy.api#documentation": "\n The type of file system volume. Currently, FinSpace only supports NAS_1 volume type. When you select NAS_1 volume type, you must also provide nas1Configuration.\n
A unique identifier for the volume.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.finspace#Description", - "traits": { - "smithy.api#documentation": "\nA description of the volume.\n
" - } - }, - "nas1Configuration": { - "target": "com.amazonaws.finspace#KxNAS1Configuration", - "traits": { - "smithy.api#documentation": " Specifies the configuration for the Network attached storage (NAS_1) file system volume. This\n parameter is required when you choose volumeType as\n NAS_1.
The number of availability zones you want to assign per volume. Currently, FinSpace only supports SINGLE for volumes. This places dataview in a single AZ.
The identifier of the availability zones.
", - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.finspace#TagMap", - "traits": { - "smithy.api#documentation": "\nA list of key-value pairs to label the volume. You can add up to 50 tags to a volume.\n
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspace#CreateKxVolumeResponse": { - "type": "structure", - "members": { - "environmentId": { - "target": "com.amazonaws.finspace#KxEnvironmentId", - "traits": { - "smithy.api#documentation": "A unique identifier for the kdb environment, whose clusters can attach to the volume.
" - } - }, - "volumeName": { - "target": "com.amazonaws.finspace#KxVolumeName", - "traits": { - "smithy.api#documentation": "A unique identifier for the volume.
" - } - }, - "volumeType": { - "target": "com.amazonaws.finspace#KxVolumeType", - "traits": { - "smithy.api#documentation": "\n The type of file system volume. Currently, FinSpace only supports NAS_1 volume type.\n
\nThe ARN identifier of the volume.\n
" - } - }, - "nas1Configuration": { - "target": "com.amazonaws.finspace#KxNAS1Configuration", - "traits": { - "smithy.api#documentation": "Specifies the configuration for the Network attached storage (NAS_1) file system volume.
" - } - }, - "status": { - "target": "com.amazonaws.finspace#KxVolumeStatus", - "traits": { - "smithy.api#documentation": "The status of volume creation.
\nCREATING – The volume creation is in progress.
\nCREATE_FAILED – The volume creation has failed.
\nACTIVE – The volume is active.
\nUPDATING – The volume is in the process of being updated.
\nUPDATE_FAILED – The update action failed.
\nUPDATED – The volume is successfully updated.
\nDELETING – The volume is in the process of being deleted.
\nDELETE_FAILED – The system failed to delete the volume.
\nDELETED – The volume is successfully deleted.
\nThe error message when a failed state occurs.
" - } - }, - "azMode": { - "target": "com.amazonaws.finspace#KxAzMode", - "traits": { - "smithy.api#documentation": "The number of availability zones you want to assign per volume. Currently, FinSpace only supports SINGLE for volumes. This places dataview in a single AZ.
\nA description of the volume.\n
" - } - }, - "availabilityZoneIds": { - "target": "com.amazonaws.finspace#AvailabilityZoneIds", - "traits": { - "smithy.api#documentation": "The identifier of the availability zones.
" - } - }, - "createdTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "The timestamp at which the volume was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#CustomDNSConfiguration": { - "type": "list", - "member": { - "target": "com.amazonaws.finspace#CustomDNSServer" - } - }, - "com.amazonaws.finspace#CustomDNSServer": { - "type": "structure", - "members": { - "customDNSServerName": { - "target": "com.amazonaws.finspace#ValidHostname", - "traits": { - "smithy.api#documentation": "The name of the DNS server.
", - "smithy.api#required": {} - } - }, - "customDNSServerIP": { - "target": "com.amazonaws.finspace#ValidIPAddress", - "traits": { - "smithy.api#documentation": "The IP address of the DNS server.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "A list of DNS server name and server IP. This is used to set up Route-53 outbound resolvers.
" - } - }, - "com.amazonaws.finspace#DataBundleArn": { - "type": "string", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the data bundle.
", - "smithy.api#length": { - "min": 20, - "max": 2048 - }, - "smithy.api#pattern": "^arn:aws:finspace:[A-Za-z0-9_/.-]{0,63}:\\d*:data-bundle/[0-9A-Za-z_-]{1,128}$" - } - }, - "com.amazonaws.finspace#DataBundleArns": { - "type": "list", - "member": { - "target": "com.amazonaws.finspace#DataBundleArn" - } - }, - "com.amazonaws.finspace#DatabaseArn": { - "type": "string" - }, - "com.amazonaws.finspace#DatabaseName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 3, - "max": 63 - }, - "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_]*[a-zA-Z0-9]$" - } - }, - "com.amazonaws.finspace#DbPath": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1025 - }, - "smithy.api#pattern": "^(\\*)*[\\/\\?\\*]([^\\/]+\\/){0,2}[^\\/]*$" - } - }, - "com.amazonaws.finspace#DbPaths": { - "type": "list", - "member": { - "target": "com.amazonaws.finspace#DbPath" - } - }, - "com.amazonaws.finspace#DeleteEnvironment": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#DeleteEnvironmentRequest" - }, - "output": { - "target": "com.amazonaws.finspace#DeleteEnvironmentResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspace#ThrottlingException" - }, - { - "target": "com.amazonaws.finspace#ValidationException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "This method will be discontinued." - }, - "smithy.api#documentation": "Delete an FinSpace environment.
", - "smithy.api#http": { - "method": "DELETE", - "uri": "/environment/{environmentId}", - "code": 200 - } - } - }, - "com.amazonaws.finspace#DeleteEnvironmentRequest": { - "type": "structure", - "members": { - "environmentId": { - "target": "com.amazonaws.finspace#IdType", - "traits": { - "smithy.api#documentation": "The identifier for the FinSpace environment.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspace#DeleteEnvironmentResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#DeleteKxCluster": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#DeleteKxClusterRequest" - }, - "output": { - "target": "com.amazonaws.finspace#DeleteKxClusterResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspace#ConflictException" - }, - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#LimitExceededException" - }, - { - "target": "com.amazonaws.finspace#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspace#ThrottlingException" - }, - { - "target": "com.amazonaws.finspace#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes a kdb cluster.
", - "smithy.api#http": { - "method": "DELETE", - "uri": "/kx/environments/{environmentId}/clusters/{clusterName}", - "code": 200 - } - } - }, - "com.amazonaws.finspace#DeleteKxClusterNode": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#DeleteKxClusterNodeRequest" - }, - "output": { - "target": "com.amazonaws.finspace#DeleteKxClusterNodeResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspace#ThrottlingException" - }, - { - "target": "com.amazonaws.finspace#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes the specified nodes from a cluster.\n
", - "smithy.api#http": { - "method": "DELETE", - "uri": "/kx/environments/{environmentId}/clusters/{clusterName}/nodes/{nodeId}", - "code": 200 - } - } - }, - "com.amazonaws.finspace#DeleteKxClusterNodeRequest": { - "type": "structure", - "members": { - "environmentId": { - "target": "com.amazonaws.finspace#KxEnvironmentId", - "traits": { - "smithy.api#documentation": "A unique identifier for the kdb environment.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "clusterName": { - "target": "com.amazonaws.finspace#KxClusterName", - "traits": { - "smithy.api#documentation": "The name of the cluster, for which you want to delete the nodes.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "nodeId": { - "target": "com.amazonaws.finspace#KxClusterNodeIdString", - "traits": { - "smithy.api#documentation": "A unique identifier for the node that you want to delete.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspace#DeleteKxClusterNodeResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#DeleteKxClusterRequest": { - "type": "structure", - "members": { - "environmentId": { - "target": "com.amazonaws.finspace#KxEnvironmentId", - "traits": { - "smithy.api#documentation": "A unique identifier for the kdb environment.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "clusterName": { - "target": "com.amazonaws.finspace#KxClusterName", - "traits": { - "smithy.api#documentation": "The name of the cluster that you want to delete.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "clientToken": { - "target": "com.amazonaws.finspace#ClientTokenString", - "traits": { - "smithy.api#documentation": "A token that ensures idempotency. This token expires in 10 minutes.
", - "smithy.api#httpQuery": "clientToken", - "smithy.api#idempotencyToken": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspace#DeleteKxClusterResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#DeleteKxDatabase": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#DeleteKxDatabaseRequest" - }, - "output": { - "target": "com.amazonaws.finspace#DeleteKxDatabaseResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspace#ConflictException" - }, - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspace#ThrottlingException" - }, - { - "target": "com.amazonaws.finspace#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes the specified database and all of its associated data. This action is irreversible. You must copy any data out of the database before deleting it if the data is to be retained.
", - "smithy.api#http": { - "method": "DELETE", - "uri": "/kx/environments/{environmentId}/databases/{databaseName}", - "code": 200 - } - } - }, - "com.amazonaws.finspace#DeleteKxDatabaseRequest": { - "type": "structure", - "members": { - "environmentId": { - "target": "com.amazonaws.finspace#EnvironmentId", - "traits": { - "smithy.api#documentation": "A unique identifier for the kdb environment.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "databaseName": { - "target": "com.amazonaws.finspace#DatabaseName", - "traits": { - "smithy.api#documentation": "The name of the kdb database that you want to delete.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "clientToken": { - "target": "com.amazonaws.finspace#ClientTokenString", - "traits": { - "smithy.api#documentation": "A token that ensures idempotency. This token expires in 10 minutes.
", - "smithy.api#httpQuery": "clientToken", - "smithy.api#idempotencyToken": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspace#DeleteKxDatabaseResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#DeleteKxDataview": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#DeleteKxDataviewRequest" - }, - "output": { - "target": "com.amazonaws.finspace#DeleteKxDataviewResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspace#ConflictException" - }, - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspace#ThrottlingException" - }, - { - "target": "com.amazonaws.finspace#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "\nDeletes the specified dataview. Before deleting a dataview, make sure that it is not in use by any cluster.
", - "smithy.api#http": { - "method": "DELETE", - "uri": "/kx/environments/{environmentId}/databases/{databaseName}/dataviews/{dataviewName}", - "code": 200 - } - } - }, - "com.amazonaws.finspace#DeleteKxDataviewRequest": { - "type": "structure", - "members": { - "environmentId": { - "target": "com.amazonaws.finspace#EnvironmentId", - "traits": { - "smithy.api#documentation": "A unique identifier for the kdb environment, from where you want to delete the dataview.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "databaseName": { - "target": "com.amazonaws.finspace#DatabaseName", - "traits": { - "smithy.api#documentation": "The name of the database whose dataview you want to delete.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "dataviewName": { - "target": "com.amazonaws.finspace#KxDataviewName", - "traits": { - "smithy.api#documentation": "The name of the dataview that you want to delete.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "clientToken": { - "target": "com.amazonaws.finspace#ClientTokenString", - "traits": { - "smithy.api#documentation": "A token that ensures idempotency. This token expires in 10 minutes.
", - "smithy.api#httpQuery": "clientToken", - "smithy.api#idempotencyToken": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspace#DeleteKxDataviewResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#DeleteKxEnvironment": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#DeleteKxEnvironmentRequest" - }, - "output": { - "target": "com.amazonaws.finspace#DeleteKxEnvironmentResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspace#ConflictException" - }, - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspace#ThrottlingException" - }, - { - "target": "com.amazonaws.finspace#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes the kdb environment. This action is irreversible. Deleting a kdb environment will remove all the associated data and any services running in it.
", - "smithy.api#http": { - "method": "DELETE", - "uri": "/kx/environments/{environmentId}", - "code": 200 - } - } - }, - "com.amazonaws.finspace#DeleteKxEnvironmentRequest": { - "type": "structure", - "members": { - "environmentId": { - "target": "com.amazonaws.finspace#IdType", - "traits": { - "smithy.api#documentation": "A unique identifier for the kdb environment.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "clientToken": { - "target": "com.amazonaws.finspace#ClientToken", - "traits": { - "smithy.api#documentation": "A token that ensures idempotency. This token expires in 10 minutes.
", - "smithy.api#httpQuery": "clientToken", - "smithy.api#idempotencyToken": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspace#DeleteKxEnvironmentResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#DeleteKxScalingGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#DeleteKxScalingGroupRequest" - }, - "output": { - "target": "com.amazonaws.finspace#DeleteKxScalingGroupResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspace#ConflictException" - }, - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#LimitExceededException" - }, - { - "target": "com.amazonaws.finspace#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspace#ThrottlingException" - }, - { - "target": "com.amazonaws.finspace#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "\nDeletes the specified scaling group. This action is irreversible. You cannot delete a scaling group until all the clusters running on it have been deleted.
", - "smithy.api#http": { - "method": "DELETE", - "uri": "/kx/environments/{environmentId}/scalingGroups/{scalingGroupName}", - "code": 200 - } - } - }, - "com.amazonaws.finspace#DeleteKxScalingGroupRequest": { - "type": "structure", - "members": { - "environmentId": { - "target": "com.amazonaws.finspace#KxEnvironmentId", - "traits": { - "smithy.api#documentation": "A unique identifier for the kdb environment, from where you want to delete the dataview.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "scalingGroupName": { - "target": "com.amazonaws.finspace#KxScalingGroupName", - "traits": { - "smithy.api#documentation": "A unique identifier for the kdb scaling group.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "clientToken": { - "target": "com.amazonaws.finspace#ClientTokenString", - "traits": { - "smithy.api#documentation": "A token that ensures idempotency. This token expires in 10 minutes.
", - "smithy.api#httpQuery": "clientToken", - "smithy.api#idempotencyToken": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspace#DeleteKxScalingGroupResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#DeleteKxUser": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#DeleteKxUserRequest" - }, - "output": { - "target": "com.amazonaws.finspace#DeleteKxUserResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspace#ConflictException" - }, - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspace#ThrottlingException" - }, - { - "target": "com.amazonaws.finspace#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes a user in the specified kdb environment.
", - "smithy.api#http": { - "method": "DELETE", - "uri": "/kx/environments/{environmentId}/users/{userName}", - "code": 200 - } - } - }, - "com.amazonaws.finspace#DeleteKxUserRequest": { - "type": "structure", - "members": { - "userName": { - "target": "com.amazonaws.finspace#KxUserNameString", - "traits": { - "smithy.api#documentation": "A unique identifier for the user that you want to delete.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "environmentId": { - "target": "com.amazonaws.finspace#IdType", - "traits": { - "smithy.api#documentation": "A unique identifier for the kdb environment.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "clientToken": { - "target": "com.amazonaws.finspace#ClientToken", - "traits": { - "smithy.api#documentation": "A token that ensures idempotency. This token expires in 10 minutes.
", - "smithy.api#httpQuery": "clientToken", - "smithy.api#idempotencyToken": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspace#DeleteKxUserResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#DeleteKxVolume": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#DeleteKxVolumeRequest" - }, - "output": { - "target": "com.amazonaws.finspace#DeleteKxVolumeResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspace#ConflictException" - }, - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#LimitExceededException" - }, - { - "target": "com.amazonaws.finspace#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspace#ThrottlingException" - }, - { - "target": "com.amazonaws.finspace#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "\n Deletes a volume. You can only delete a volume if it's not attached to a cluster or a dataview. When a volume is deleted, any data on the volume is lost. This action is irreversible.\n\n
", - "smithy.api#http": { - "method": "DELETE", - "uri": "/kx/environments/{environmentId}/kxvolumes/{volumeName}", - "code": 200 - } - } - }, - "com.amazonaws.finspace#DeleteKxVolumeRequest": { - "type": "structure", - "members": { - "environmentId": { - "target": "com.amazonaws.finspace#KxEnvironmentId", - "traits": { - "smithy.api#documentation": "A unique identifier for the kdb environment, whose clusters can attach to the volume.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "volumeName": { - "target": "com.amazonaws.finspace#KxVolumeName", - "traits": { - "smithy.api#documentation": "\nThe name of the volume that you want to delete.\n
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "clientToken": { - "target": "com.amazonaws.finspace#ClientTokenString", - "traits": { - "smithy.api#documentation": "A token that ensures idempotency. This token expires in 10 minutes.
", - "smithy.api#httpQuery": "clientToken", - "smithy.api#idempotencyToken": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspace#DeleteKxVolumeResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#Description": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1000 - }, - "smithy.api#pattern": "^[a-zA-Z0-9. ]{1,1000}$" - } - }, - "com.amazonaws.finspace#EmailId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - }, - "smithy.api#pattern": "^[A-Z0-9a-z._%+-]+@[A-Za-z0-9.-]+[.]+[A-Za-z]+$", - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.finspace#Environment": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.finspace#EnvironmentName", - "traits": { - "smithy.api#documentation": "The name of the FinSpace environment.
" - } - }, - "environmentId": { - "target": "com.amazonaws.finspace#IdType", - "traits": { - "smithy.api#documentation": "The identifier of the FinSpace environment.
" - } - }, - "awsAccountId": { - "target": "com.amazonaws.finspace#IdType", - "traits": { - "smithy.api#documentation": "The ID of the AWS account in which the FinSpace environment is created.
" - } - }, - "status": { - "target": "com.amazonaws.finspace#EnvironmentStatus", - "traits": { - "smithy.api#documentation": "The current status of creation of the FinSpace environment.
" - } - }, - "environmentUrl": { - "target": "com.amazonaws.finspace#url", - "traits": { - "smithy.api#documentation": "The sign-in URL for the web application of your FinSpace environment.
" - } - }, - "description": { - "target": "com.amazonaws.finspace#Description", - "traits": { - "smithy.api#documentation": "The description of the FinSpace environment.
" - } - }, - "environmentArn": { - "target": "com.amazonaws.finspace#EnvironmentArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of your FinSpace environment.
" - } - }, - "sageMakerStudioDomainUrl": { - "target": "com.amazonaws.finspace#SmsDomainUrl", - "traits": { - "smithy.api#documentation": "The URL of the integrated FinSpace notebook environment in your web application.
" - } - }, - "kmsKeyId": { - "target": "com.amazonaws.finspace#KmsKeyId", - "traits": { - "smithy.api#documentation": "The KMS key id used to encrypt in the FinSpace environment.
" - } - }, - "dedicatedServiceAccountId": { - "target": "com.amazonaws.finspace#IdType", - "traits": { - "smithy.api#documentation": "The AWS account ID of the dedicated service account associated with your FinSpace\n environment.
" - } - }, - "federationMode": { - "target": "com.amazonaws.finspace#FederationMode", - "traits": { - "smithy.api#documentation": "The authentication mode for the environment.
" - } - }, - "federationParameters": { - "target": "com.amazonaws.finspace#FederationParameters", - "traits": { - "smithy.api#documentation": "Configuration information when authentication mode is FEDERATED.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Represents an FinSpace environment.
" - } - }, - "com.amazonaws.finspace#EnvironmentArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 20, - "max": 2048 - }, - "smithy.api#pattern": "^arn:aws:finspace:[A-Za-z0-9_/.-]{0,63}:\\d+:environment/[0-9A-Za-z_-]{1,128}$" - } - }, - "com.amazonaws.finspace#EnvironmentErrorMessage": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1000 - }, - "smithy.api#pattern": "^[a-zA-Z0-9. ]{1,1000}$" - } - }, - "com.amazonaws.finspace#EnvironmentId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 32 - }, - "smithy.api#pattern": "\\S" - } - }, - "com.amazonaws.finspace#EnvironmentList": { - "type": "list", - "member": { - "target": "com.amazonaws.finspace#Environment" - } - }, - "com.amazonaws.finspace#EnvironmentName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - }, - "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]$" - } - }, - "com.amazonaws.finspace#EnvironmentStatus": { - "type": "enum", - "members": { - "CREATE_REQUESTED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATE_REQUESTED" - } - }, - "CREATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATING" - } - }, - "CREATED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATED" - } - }, - "DELETE_REQUESTED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETE_REQUESTED" - } - }, - "DELETING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETING" - } - }, - "DELETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETED" - } - }, - "FAILED_CREATION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED_CREATION" - } - }, - "RETRY_DELETION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RETRY_DELETION" - } - }, - "FAILED_DELETION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED_DELETION" - } - }, - "UPDATE_NETWORK_REQUESTED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UPDATE_NETWORK_REQUESTED" - } - }, - "UPDATING_NETWORK": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UPDATING_NETWORK" - } - }, - "FAILED_UPDATING_NETWORK": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED_UPDATING_NETWORK" - } - }, - "SUSPENDED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SUSPENDED" - } - } - } - }, - "com.amazonaws.finspace#ErrorDetails": { - "type": "enum", - "members": { - "VALIDATION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "The inputs to this request are invalid." - } - }, - "SERVICE_QUOTA_EXCEEDED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Service limits have been exceeded." - } - }, - "ACCESS_DENIED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Missing required permission to perform this request." - } - }, - "RESOURCE_NOT_FOUND": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "One or more inputs to this request were not found." - } - }, - "THROTTLING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "The system temporarily lacks sufficient resources to process the request." - } - }, - "INTERNAL_SERVICE_EXCEPTION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "An internal error has occurred." - } - }, - "CANCELLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Cancelled" - } - }, - "USER_RECOVERABLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "A user recoverable error has occurred" - } - } - } - }, - "com.amazonaws.finspace#ErrorInfo": { - "type": "structure", - "members": { - "errorMessage": { - "target": "com.amazonaws.finspace#ErrorMessage", - "traits": { - "smithy.api#documentation": "Specifies the error message that appears if a flow fails.
" - } - }, - "errorType": { - "target": "com.amazonaws.finspace#ErrorDetails", - "traits": { - "smithy.api#documentation": "Specifies the type of error.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Provides details in the event of a failed flow, including the error type and the related error message.
" - } - }, - "com.amazonaws.finspace#ErrorMessage": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1000 - } - } - }, - "com.amazonaws.finspace#ErrorMessage2": { - "type": "string" - }, - "com.amazonaws.finspace#ExecutionRoleArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - }, - "smithy.api#pattern": "^arn:aws[a-z0-9-]*:iam::\\d{12}:role\\/[\\w-\\/.@+=,]{1,1017}$" - } - }, - "com.amazonaws.finspace#FederationAttributeKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 32 - }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.finspace#FederationAttributeValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1000 - }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.finspace#FederationMode": { - "type": "enum", - "members": { - "FEDERATED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FEDERATED" - } - }, - "LOCAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LOCAL" - } - } - } - }, - "com.amazonaws.finspace#FederationParameters": { - "type": "structure", - "members": { - "samlMetadataDocument": { - "target": "com.amazonaws.finspace#SamlMetadataDocument", - "traits": { - "smithy.api#documentation": "SAML 2.0 Metadata document from identity provider (IdP).
" - } - }, - "samlMetadataURL": { - "target": "com.amazonaws.finspace#url", - "traits": { - "smithy.api#documentation": "Provide the metadata URL from your SAML 2.0 compliant identity provider (IdP).
" - } - }, - "applicationCallBackURL": { - "target": "com.amazonaws.finspace#url", - "traits": { - "smithy.api#documentation": "The redirect or sign-in URL that should be entered into the SAML 2.0 compliant identity provider configuration\n (IdP).
" - } - }, - "federationURN": { - "target": "com.amazonaws.finspace#urn", - "traits": { - "smithy.api#documentation": "The Uniform Resource Name (URN). Also referred as Service Provider URN or Audience URI or Service Provider Entity ID.
" - } - }, - "federationProviderName": { - "target": "com.amazonaws.finspace#FederationProviderName", - "traits": { - "smithy.api#documentation": "Name of the identity provider (IdP).
" - } - }, - "attributeMap": { - "target": "com.amazonaws.finspace#AttributeMap", - "traits": { - "smithy.api#documentation": "SAML attribute name and value. The name must always be Email and the value should be set to\n the attribute definition in which user email is set. For example, name would be Email and\n value http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress.\n Please check your SAML 2.0 compliant identity provider (IdP) documentation for details.
Configuration information when authentication mode is FEDERATED.
" - } - }, - "com.amazonaws.finspace#FederationProviderName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 32 - }, - "smithy.api#pattern": "^[^_\\p{Z}][\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}][^_\\p{Z}]+$" - } - }, - "com.amazonaws.finspace#FinSpaceTaggableArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 20, - "max": 2048 - }, - "smithy.api#pattern": "^arn:aws:finspace:[A-Za-z0-9_/.-]{0,63}:\\d+:(environment|kxEnvironment)/[0-9A-Za-z_-]{1,128}(/(kxCluster|kxUser|kxVolume|kxScalingGroup)/[a-zA-Z0-9_-]{1,255}|/(kxDatabase/[a-zA-Z0-9_-]{1,255}(/kxDataview/[a-zA-Z0-9_-]{1,255})?))?$" - } - }, - "com.amazonaws.finspace#GetEnvironment": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#GetEnvironmentRequest" - }, - "output": { - "target": "com.amazonaws.finspace#GetEnvironmentResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspace#ValidationException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "This method will be discontinued." - }, - "smithy.api#documentation": "Returns the FinSpace environment object.
", - "smithy.api#http": { - "method": "GET", - "uri": "/environment/{environmentId}", - "code": 200 - } - } - }, - "com.amazonaws.finspace#GetEnvironmentRequest": { - "type": "structure", - "members": { - "environmentId": { - "target": "com.amazonaws.finspace#IdType", - "traits": { - "smithy.api#documentation": "The identifier of the FinSpace environment.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspace#GetEnvironmentResponse": { - "type": "structure", - "members": { - "environment": { - "target": "com.amazonaws.finspace#Environment", - "traits": { - "smithy.api#documentation": "The name of the FinSpace environment.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#GetKxChangeset": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#GetKxChangesetRequest" - }, - "output": { - "target": "com.amazonaws.finspace#GetKxChangesetResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspace#ThrottlingException" - }, - { - "target": "com.amazonaws.finspace#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Returns information about a kdb changeset.
", - "smithy.api#http": { - "method": "GET", - "uri": "/kx/environments/{environmentId}/databases/{databaseName}/changesets/{changesetId}", - "code": 200 - } - } - }, - "com.amazonaws.finspace#GetKxChangesetRequest": { - "type": "structure", - "members": { - "environmentId": { - "target": "com.amazonaws.finspace#EnvironmentId", - "traits": { - "smithy.api#documentation": "A unique identifier for the kdb environment.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "databaseName": { - "target": "com.amazonaws.finspace#DatabaseName", - "traits": { - "smithy.api#documentation": "The name of the kdb database.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "changesetId": { - "target": "com.amazonaws.finspace#ChangesetId", - "traits": { - "smithy.api#documentation": "A unique identifier of the changeset for which you want to retrieve data.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspace#GetKxChangesetResponse": { - "type": "structure", - "members": { - "changesetId": { - "target": "com.amazonaws.finspace#ChangesetId", - "traits": { - "smithy.api#documentation": "A unique identifier for the changeset.
" - } - }, - "databaseName": { - "target": "com.amazonaws.finspace#DatabaseName", - "traits": { - "smithy.api#documentation": "The name of the kdb database.
" - } - }, - "environmentId": { - "target": "com.amazonaws.finspace#EnvironmentId", - "traits": { - "smithy.api#documentation": "A unique identifier for the kdb environment.
" - } - }, - "changeRequests": { - "target": "com.amazonaws.finspace#ChangeRequests", - "traits": { - "smithy.api#documentation": "A list of change request objects that are run in order.
" - } - }, - "createdTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "The timestamp at which the changeset was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" - } - }, - "activeFromTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "Beginning time from which the changeset is active. The value is determined as epoch time in\n milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as\n 1635768000000.
" - } - }, - "lastModifiedTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "The timestamp at which the changeset was updated in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" - } - }, - "status": { - "target": "com.amazonaws.finspace#ChangesetStatus", - "traits": { - "smithy.api#documentation": "Status of the changeset creation process.
\nPending – Changeset creation is pending.
\nProcessing – Changeset creation is running.
\nFailed – Changeset creation has failed.
\nComplete – Changeset creation has succeeded.
\nProvides details in the event of a failed flow, including the error type and the related error message.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#GetKxCluster": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#GetKxClusterRequest" - }, - "output": { - "target": "com.amazonaws.finspace#GetKxClusterResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspace#ConflictException" - }, - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#LimitExceededException" - }, - { - "target": "com.amazonaws.finspace#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspace#ThrottlingException" - }, - { - "target": "com.amazonaws.finspace#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Retrieves information about a kdb cluster.
", - "smithy.api#http": { - "method": "GET", - "uri": "/kx/environments/{environmentId}/clusters/{clusterName}", - "code": 200 - } - } - }, - "com.amazonaws.finspace#GetKxClusterRequest": { - "type": "structure", - "members": { - "environmentId": { - "target": "com.amazonaws.finspace#KxEnvironmentId", - "traits": { - "smithy.api#documentation": "A unique identifier for the kdb environment.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "clusterName": { - "target": "com.amazonaws.finspace#KxClusterName", - "traits": { - "smithy.api#documentation": "The name of the cluster that you want to retrieve.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspace#GetKxClusterResponse": { - "type": "structure", - "members": { - "status": { - "target": "com.amazonaws.finspace#KxClusterStatus", - "traits": { - "smithy.api#documentation": "The status of cluster creation.
\nPENDING – The cluster is pending creation.
\nCREATING – The cluster creation process is in progress.
\nCREATE_FAILED – The cluster creation process has failed.
\nRUNNING – The cluster creation process is running.
\nUPDATING – The cluster is in the process of being updated.
\nDELETING – The cluster is in the process of being deleted.
\nDELETED – The cluster has been deleted.
\nDELETE_FAILED – The cluster failed to delete.
\nThe error message when a failed state occurs.
" - } - }, - "clusterName": { - "target": "com.amazonaws.finspace#KxClusterName", - "traits": { - "smithy.api#documentation": "A unique name for the cluster.
" - } - }, - "clusterType": { - "target": "com.amazonaws.finspace#KxClusterType", - "traits": { - "smithy.api#documentation": "Specifies the type of KDB database that is being created. The following types are available:
\nHDB – A Historical Database. The data is only accessible with read-only permissions from one of the FinSpace managed kdb databases mounted to the cluster.
\nRDB – A Realtime Database. This type of database captures all the data from a ticker plant and stores it in memory until the end of day, after which it writes all of its data to a disk and reloads the HDB. This cluster type requires local storage for temporary storage of data during the savedown process. If you specify this field in your request, you must provide the savedownStorageConfiguration parameter.
GATEWAY – A gateway cluster allows you to access data across processes in kdb systems. It allows you to create your own routing logic using the initialization scripts and custom code. This type of cluster does not require a writable local storage.
\nGP – A general purpose cluster allows you to quickly iterate on code during development by granting greater access to system commands and enabling a fast reload of custom code. This cluster type can optionally mount databases including cache and savedown storage. For this cluster type, the node count is fixed at 1. It does not support autoscaling and supports only SINGLE AZ mode.
Tickerplant – A tickerplant cluster allows you to subscribe to feed handlers based on IAM permissions. It can publish to RDBs, other Tickerplants, and real-time subscribers (RTS). Tickerplants can persist messages to log, which is readable by any RDB environment. It supports only single-node that is only one kdb process.
\n\nA list of volumes attached to the cluster.\n
" - } - }, - "databases": { - "target": "com.amazonaws.finspace#KxDatabaseConfigurations", - "traits": { - "smithy.api#documentation": "A list of databases mounted on the cluster.
" - } - }, - "cacheStorageConfigurations": { - "target": "com.amazonaws.finspace#KxCacheStorageConfigurations", - "traits": { - "smithy.api#documentation": "The configurations for a read only cache storage associated with a cluster. This cache will be stored as an FSx Lustre that reads from the S3 store.
" - } - }, - "autoScalingConfiguration": { - "target": "com.amazonaws.finspace#AutoScalingConfiguration", - "traits": { - "smithy.api#documentation": "The configuration based on which FinSpace will scale in or scale out nodes in your cluster.
" - } - }, - "clusterDescription": { - "target": "com.amazonaws.finspace#KxClusterDescription", - "traits": { - "smithy.api#documentation": "A description of the cluster.
" - } - }, - "capacityConfiguration": { - "target": "com.amazonaws.finspace#CapacityConfiguration", - "traits": { - "smithy.api#documentation": "A structure for the metadata of a cluster. It includes information like the CPUs needed, memory of instances, and number of instances.
" - } - }, - "releaseLabel": { - "target": "com.amazonaws.finspace#ReleaseLabel", - "traits": { - "smithy.api#documentation": "The version of FinSpace managed kdb to run.
" - } - }, - "vpcConfiguration": { - "target": "com.amazonaws.finspace#VpcConfiguration", - "traits": { - "smithy.api#documentation": "Configuration details about the network where the Privatelink endpoint of the cluster resides.
" - } - }, - "initializationScript": { - "target": "com.amazonaws.finspace#InitializationScriptFilePath", - "traits": { - "smithy.api#documentation": "Specifies a Q program that will be run at launch of a cluster. It is a relative path within\n .zip file that contains the custom code, which will be loaded on\n the cluster. It must include the file name itself. For example,\n somedir/init.q.
Defines key-value pairs to make them available inside the cluster.
" - } - }, - "code": { - "target": "com.amazonaws.finspace#CodeConfiguration", - "traits": { - "smithy.api#documentation": "The details of the custom code that you want to use inside a cluster when analyzing a data. It consists of the S3 source bucket, location, S3 object version, and the relative path from where the custom code is loaded into the cluster.
" - } - }, - "executionRole": { - "target": "com.amazonaws.finspace#ExecutionRoleArn", - "traits": { - "smithy.api#documentation": "\n An IAM role that defines a set of permissions associated with a cluster. These permissions are assumed when a cluster attempts to access another cluster.\n
" - } - }, - "lastModifiedTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "The last time that the cluster was modified. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" - } - }, - "savedownStorageConfiguration": { - "target": "com.amazonaws.finspace#KxSavedownStorageConfiguration", - "traits": { - "smithy.api#documentation": "The size and type of the temporary storage that is used to hold data during the savedown process. This parameter is required when you choose clusterType as RDB. All the data written to this storage space is lost when the cluster node is restarted.
The number of availability zones you want to assign per cluster. This can be one of the following
\n\n SINGLE – Assigns one availability zone per cluster.
\n MULTI – Assigns all the availability zones per cluster.
\n The availability zone identifiers for the requested regions.\n
" - } - }, - "createdTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "The timestamp at which the cluster was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" - } - }, - "scalingGroupConfiguration": { - "target": "com.amazonaws.finspace#KxScalingGroupConfiguration" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#GetKxConnectionString": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#GetKxConnectionStringRequest" - }, - "output": { - "target": "com.amazonaws.finspace#GetKxConnectionStringResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspace#ThrottlingException" - }, - { - "target": "com.amazonaws.finspace#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Retrieves a connection string for a user to connect to a kdb cluster. You must call this API using the same role that you have defined while creating a user.
", - "smithy.api#http": { - "method": "GET", - "uri": "/kx/environments/{environmentId}/connectionString", - "code": 200 - } - } - }, - "com.amazonaws.finspace#GetKxConnectionStringRequest": { - "type": "structure", - "members": { - "userArn": { - "target": "com.amazonaws.finspace#KxUserArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies the user. For more information about ARNs and\n how to use ARNs in policies, see IAM Identifiers in the\n IAM User Guide.
", - "smithy.api#httpQuery": "userArn", - "smithy.api#required": {} - } - }, - "environmentId": { - "target": "com.amazonaws.finspace#IdType", - "traits": { - "smithy.api#documentation": "A unique identifier for the kdb environment.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "clusterName": { - "target": "com.amazonaws.finspace#KxClusterName", - "traits": { - "smithy.api#documentation": "A name of the kdb cluster.
", - "smithy.api#httpQuery": "clusterName", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspace#GetKxConnectionStringResponse": { - "type": "structure", - "members": { - "signedConnectionString": { - "target": "com.amazonaws.finspace#SignedKxConnectionString", - "traits": { - "smithy.api#documentation": "The signed connection string that you can use to connect to clusters.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#GetKxDatabase": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#GetKxDatabaseRequest" - }, - "output": { - "target": "com.amazonaws.finspace#GetKxDatabaseResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspace#ThrottlingException" - }, - { - "target": "com.amazonaws.finspace#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Returns database information for the specified environment ID.
", - "smithy.api#http": { - "method": "GET", - "uri": "/kx/environments/{environmentId}/databases/{databaseName}", - "code": 200 - } - } - }, - "com.amazonaws.finspace#GetKxDatabaseRequest": { - "type": "structure", - "members": { - "environmentId": { - "target": "com.amazonaws.finspace#EnvironmentId", - "traits": { - "smithy.api#documentation": "A unique identifier for the kdb environment.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "databaseName": { - "target": "com.amazonaws.finspace#DatabaseName", - "traits": { - "smithy.api#documentation": "The name of the kdb database.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspace#GetKxDatabaseResponse": { - "type": "structure", - "members": { - "databaseName": { - "target": "com.amazonaws.finspace#DatabaseName", - "traits": { - "smithy.api#documentation": "The name of the kdb database for which the information is retrieved.
" - } - }, - "databaseArn": { - "target": "com.amazonaws.finspace#DatabaseArn", - "traits": { - "smithy.api#documentation": "The ARN identifier of the database.
" - } - }, - "environmentId": { - "target": "com.amazonaws.finspace#EnvironmentId", - "traits": { - "smithy.api#documentation": "A unique identifier for the kdb environment.
" - } - }, - "description": { - "target": "com.amazonaws.finspace#Description", - "traits": { - "smithy.api#documentation": "A description of the database.
" - } - }, - "createdTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "The timestamp at which the database is created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" - } - }, - "lastModifiedTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "The last time that the database was modified. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" - } - }, - "lastCompletedChangesetId": { - "target": "com.amazonaws.finspace#ChangesetId", - "traits": { - "smithy.api#documentation": "A unique identifier for the changeset.
" - } - }, - "numBytes": { - "target": "com.amazonaws.finspace#numBytes", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The total number of bytes in the database.
" - } - }, - "numChangesets": { - "target": "com.amazonaws.finspace#numChangesets", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The total number of changesets in the database.
" - } - }, - "numFiles": { - "target": "com.amazonaws.finspace#numFiles", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The total number of files in the database.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#GetKxDataview": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#GetKxDataviewRequest" - }, - "output": { - "target": "com.amazonaws.finspace#GetKxDataviewResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspace#ThrottlingException" - }, - { - "target": "com.amazonaws.finspace#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "\nRetrieves details of the dataview.\n
", - "smithy.api#http": { - "method": "GET", - "uri": "/kx/environments/{environmentId}/databases/{databaseName}/dataviews/{dataviewName}", - "code": 200 - } - } - }, - "com.amazonaws.finspace#GetKxDataviewRequest": { - "type": "structure", - "members": { - "environmentId": { - "target": "com.amazonaws.finspace#EnvironmentId", - "traits": { - "smithy.api#documentation": "A unique identifier for the kdb environment, from where you want to retrieve the dataview details.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "databaseName": { - "target": "com.amazonaws.finspace#DatabaseName", - "traits": { - "smithy.api#documentation": "\nThe name of the database where you created the dataview.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "dataviewName": { - "target": "com.amazonaws.finspace#KxDataviewName", - "traits": { - "smithy.api#documentation": "A unique identifier for the dataview.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspace#GetKxDataviewResponse": { - "type": "structure", - "members": { - "databaseName": { - "target": "com.amazonaws.finspace#DatabaseName", - "traits": { - "smithy.api#documentation": "\nThe name of the database where you created the dataview.
" - } - }, - "dataviewName": { - "target": "com.amazonaws.finspace#KxDataviewName", - "traits": { - "smithy.api#documentation": "A unique identifier for the dataview.
" - } - }, - "azMode": { - "target": "com.amazonaws.finspace#KxAzMode", - "traits": { - "smithy.api#documentation": "The number of availability zones you want to assign per volume. Currently, FinSpace only supports SINGLE for volumes. This places dataview in a single AZ.
\n The identifier of the availability zones.\n
" - } - }, - "changesetId": { - "target": "com.amazonaws.finspace#ChangesetId", - "traits": { - "smithy.api#documentation": "\nA unique identifier of the changeset that you want to use to ingest data.
" - } - }, - "segmentConfigurations": { - "target": "com.amazonaws.finspace#KxDataviewSegmentConfigurationList", - "traits": { - "smithy.api#documentation": "\n The configuration that contains the database path of the data that you want to place on each selected volume. Each segment must have a unique database path for each volume. If you do not explicitly specify any database path for a volume, they are accessible from the cluster through the default S3/object store segment.
" - } - }, - "activeVersions": { - "target": "com.amazonaws.finspace#KxDataviewActiveVersionList", - "traits": { - "smithy.api#documentation": "\n The current active changeset versions of the database on the given dataview. \n \n
" - } - }, - "description": { - "target": "com.amazonaws.finspace#Description", - "traits": { - "smithy.api#documentation": "A description of the dataview.
" - } - }, - "autoUpdate": { - "target": "com.amazonaws.finspace#booleanValue", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "The option to specify whether you want to apply all the future additions and corrections automatically to the dataview when new changesets are ingested. The default value is false.
" - } - }, - "readWrite": { - "target": "com.amazonaws.finspace#booleanValue", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "Returns True if the dataview is created as writeable and False otherwise.
" - } - }, - "environmentId": { - "target": "com.amazonaws.finspace#EnvironmentId", - "traits": { - "smithy.api#documentation": "A unique identifier for the kdb environment, from where you want to retrieve the dataview details.
" - } - }, - "createdTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "The timestamp at which the dataview was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" - } - }, - "lastModifiedTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "\n The last time that the dataview was updated in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.\n
" - } - }, - "status": { - "target": "com.amazonaws.finspace#KxDataviewStatus", - "traits": { - "smithy.api#documentation": "\n The status of dataview creation.
\n\n CREATING – The dataview creation is in progress.
\n UPDATING – The dataview is in the process of being updated.
\n ACTIVE – The dataview is active.
\nThe error message when a failed state occurs. \n
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#GetKxEnvironment": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#GetKxEnvironmentRequest" - }, - "output": { - "target": "com.amazonaws.finspace#GetKxEnvironmentResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspace#ConflictException" - }, - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspace#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Retrieves all the information for the specified kdb environment.
", - "smithy.api#http": { - "method": "GET", - "uri": "/kx/environments/{environmentId}", - "code": 200 - } - } - }, - "com.amazonaws.finspace#GetKxEnvironmentRequest": { - "type": "structure", - "members": { - "environmentId": { - "target": "com.amazonaws.finspace#IdType", - "traits": { - "smithy.api#documentation": "A unique identifier for the kdb environment.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspace#GetKxEnvironmentResponse": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.finspace#KxEnvironmentName", - "traits": { - "smithy.api#documentation": "The name of the kdb environment.
" - } - }, - "environmentId": { - "target": "com.amazonaws.finspace#IdType", - "traits": { - "smithy.api#documentation": "A unique identifier for the kdb environment.
" - } - }, - "awsAccountId": { - "target": "com.amazonaws.finspace#IdType", - "traits": { - "smithy.api#documentation": "The unique identifier of the AWS account that is used to create the kdb environment.
" - } - }, - "status": { - "target": "com.amazonaws.finspace#EnvironmentStatus", - "traits": { - "smithy.api#documentation": "The status of the kdb environment.
" - } - }, - "tgwStatus": { - "target": "com.amazonaws.finspace#tgwStatus", - "traits": { - "smithy.api#documentation": "The status of the network configuration.
" - } - }, - "dnsStatus": { - "target": "com.amazonaws.finspace#dnsStatus", - "traits": { - "smithy.api#documentation": "The status of DNS configuration.
" - } - }, - "errorMessage": { - "target": "com.amazonaws.finspace#EnvironmentErrorMessage", - "traits": { - "smithy.api#documentation": "Specifies the error message that appears if a flow fails.
" - } - }, - "description": { - "target": "com.amazonaws.finspace#Description", - "traits": { - "smithy.api#documentation": "A description for the kdb environment.
" - } - }, - "environmentArn": { - "target": "com.amazonaws.finspace#EnvironmentArn", - "traits": { - "smithy.api#documentation": "The ARN identifier of the environment.
" - } - }, - "kmsKeyId": { - "target": "com.amazonaws.finspace#KmsKeyId", - "traits": { - "smithy.api#documentation": "The KMS key ID to encrypt your data in the FinSpace environment.
" - } - }, - "dedicatedServiceAccountId": { - "target": "com.amazonaws.finspace#IdType", - "traits": { - "smithy.api#documentation": "A unique identifier for the AWS environment infrastructure account.
" - } - }, - "transitGatewayConfiguration": { - "target": "com.amazonaws.finspace#TransitGatewayConfiguration" - }, - "customDNSConfiguration": { - "target": "com.amazonaws.finspace#CustomDNSConfiguration", - "traits": { - "smithy.api#documentation": "A list of DNS server name and server IP. This is used to set up Route-53 outbound resolvers.
" - } - }, - "creationTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "The timestamp at which the kdb environment was created in FinSpace.
" - } - }, - "updateTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "The timestamp at which the kdb environment was updated.
" - } - }, - "availabilityZoneIds": { - "target": "com.amazonaws.finspace#AvailabilityZoneIds", - "traits": { - "smithy.api#documentation": "The identifier of the availability zones where subnets for the environment are created.
" - } - }, - "certificateAuthorityArn": { - "target": "com.amazonaws.finspace#stringValueLength1to255", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the certificate authority of the \n kdb environment.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#GetKxScalingGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#GetKxScalingGroupRequest" - }, - "output": { - "target": "com.amazonaws.finspace#GetKxScalingGroupResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspace#ConflictException" - }, - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#LimitExceededException" - }, - { - "target": "com.amazonaws.finspace#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspace#ThrottlingException" - }, - { - "target": "com.amazonaws.finspace#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "\nRetrieves details of a scaling group.
", - "smithy.api#http": { - "method": "GET", - "uri": "/kx/environments/{environmentId}/scalingGroups/{scalingGroupName}", - "code": 200 - } - } - }, - "com.amazonaws.finspace#GetKxScalingGroupRequest": { - "type": "structure", - "members": { - "environmentId": { - "target": "com.amazonaws.finspace#KxEnvironmentId", - "traits": { - "smithy.api#documentation": "A unique identifier for the kdb environment.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "scalingGroupName": { - "target": "com.amazonaws.finspace#KxScalingGroupName", - "traits": { - "smithy.api#documentation": "A unique identifier for the kdb scaling group.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspace#GetKxScalingGroupResponse": { - "type": "structure", - "members": { - "scalingGroupName": { - "target": "com.amazonaws.finspace#KxScalingGroupName", - "traits": { - "smithy.api#documentation": "A unique identifier for the kdb scaling group.
" - } - }, - "scalingGroupArn": { - "target": "com.amazonaws.finspace#arn", - "traits": { - "smithy.api#documentation": "\n The ARN identifier for the scaling group.\n
" - } - }, - "hostType": { - "target": "com.amazonaws.finspace#KxHostType", - "traits": { - "smithy.api#documentation": "\n The memory and CPU capabilities of the scaling group host on which FinSpace Managed kdb clusters will be placed.
\nIt can have one of the following values:
\n\n kx.sg.4xlarge – The host type with a configuration of 108 GiB memory and 16 vCPUs.
\n kx.sg.8xlarge – The host type with a configuration of 216 GiB memory and 32 vCPUs.
\n kx.sg.16xlarge – The host type with a configuration of 432 GiB memory and 64 vCPUs.
\n kx.sg.32xlarge – The host type with a configuration of 864 GiB memory and 128 vCPUs.
\n kx.sg1.16xlarge – The host type with a configuration of 1949 GiB memory and 64 vCPUs.
\n kx.sg1.24xlarge – The host type with a configuration of 2948 GiB memory and 96 vCPUs.
\n The list of Managed kdb clusters that are currently active in the given scaling group.\n \n
" - } - }, - "availabilityZoneId": { - "target": "com.amazonaws.finspace#AvailabilityZoneId", - "traits": { - "smithy.api#documentation": "The identifier of the availability zones.
" - } - }, - "status": { - "target": "com.amazonaws.finspace#KxScalingGroupStatus", - "traits": { - "smithy.api#documentation": "The status of scaling group.
\nCREATING – The scaling group creation is in progress.
\nCREATE_FAILED – The scaling group creation has failed.
\nACTIVE – The scaling group is active.
\nUPDATING – The scaling group is in the process of being updated.
\nUPDATE_FAILED – The update action failed.
\nDELETING – The scaling group is in the process of being deleted.
\nDELETE_FAILED – The system failed to delete the scaling group.
\nDELETED – The scaling group is successfully deleted.
\n\nThe error message when a failed state occurs. \n
" - } - }, - "lastModifiedTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "\n The last time that the scaling group was updated in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.\n
" - } - }, - "createdTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "\n The timestamp at which the scaling group was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#GetKxUser": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#GetKxUserRequest" - }, - "output": { - "target": "com.amazonaws.finspace#GetKxUserResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspace#ThrottlingException" - }, - { - "target": "com.amazonaws.finspace#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Retrieves information about the specified kdb user.
", - "smithy.api#http": { - "method": "GET", - "uri": "/kx/environments/{environmentId}/users/{userName}", - "code": 200 - } - } - }, - "com.amazonaws.finspace#GetKxUserRequest": { - "type": "structure", - "members": { - "userName": { - "target": "com.amazonaws.finspace#KxUserNameString", - "traits": { - "smithy.api#documentation": "A unique identifier for the user.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "environmentId": { - "target": "com.amazonaws.finspace#IdType", - "traits": { - "smithy.api#documentation": "A unique identifier for the kdb environment.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspace#GetKxUserResponse": { - "type": "structure", - "members": { - "userName": { - "target": "com.amazonaws.finspace#IdType", - "traits": { - "smithy.api#documentation": "A unique identifier for the user.
" - } - }, - "userArn": { - "target": "com.amazonaws.finspace#KxUserArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies the user. For more information about ARNs and\n how to use ARNs in policies, see IAM Identifiers in the\n IAM User Guide.
" - } - }, - "environmentId": { - "target": "com.amazonaws.finspace#IdType", - "traits": { - "smithy.api#documentation": "A unique identifier for the kdb environment.
" - } - }, - "iamRole": { - "target": "com.amazonaws.finspace#RoleArn", - "traits": { - "smithy.api#documentation": "The IAM role ARN that is associated with the user.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#GetKxVolume": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#GetKxVolumeRequest" - }, - "output": { - "target": "com.amazonaws.finspace#GetKxVolumeResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspace#ConflictException" - }, - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#LimitExceededException" - }, - { - "target": "com.amazonaws.finspace#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspace#ThrottlingException" - }, - { - "target": "com.amazonaws.finspace#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "\nRetrieves the information about the volume.
", - "smithy.api#http": { - "method": "GET", - "uri": "/kx/environments/{environmentId}/kxvolumes/{volumeName}", - "code": 200 - } - } - }, - "com.amazonaws.finspace#GetKxVolumeRequest": { - "type": "structure", - "members": { - "environmentId": { - "target": "com.amazonaws.finspace#KxEnvironmentId", - "traits": { - "smithy.api#documentation": "A unique identifier for the kdb environment, whose clusters can attach to the volume.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "volumeName": { - "target": "com.amazonaws.finspace#KxVolumeName", - "traits": { - "smithy.api#documentation": "A unique identifier for the volume.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspace#GetKxVolumeResponse": { - "type": "structure", - "members": { - "environmentId": { - "target": "com.amazonaws.finspace#KxEnvironmentId", - "traits": { - "smithy.api#documentation": "A unique identifier for the kdb environment, whose clusters can attach to the volume.
" - } - }, - "volumeName": { - "target": "com.amazonaws.finspace#KxVolumeName", - "traits": { - "smithy.api#documentation": "\nA unique identifier for the volume.
" - } - }, - "volumeType": { - "target": "com.amazonaws.finspace#KxVolumeType", - "traits": { - "smithy.api#documentation": "\n The type of file system volume. Currently, FinSpace only supports NAS_1 volume type.\n
\nThe ARN identifier of the volume.\n
" - } - }, - "nas1Configuration": { - "target": "com.amazonaws.finspace#KxNAS1Configuration", - "traits": { - "smithy.api#documentation": "Specifies the configuration for the Network attached storage (NAS_1) file system volume.
" - } - }, - "status": { - "target": "com.amazonaws.finspace#KxVolumeStatus", - "traits": { - "smithy.api#documentation": "The status of volume creation.
\nCREATING – The volume creation is in progress.
\nCREATE_FAILED – The volume creation has failed.
\nACTIVE – The volume is active.
\nUPDATING – The volume is in the process of being updated.
\nUPDATE_FAILED – The update action failed.
\nUPDATED – The volume is successfully updated.
\nDELETING – The volume is in the process of being deleted.
\nDELETE_FAILED – The system failed to delete the volume.
\nDELETED – The volume is successfully deleted.
\nThe error message when a failed state occurs.
" - } - }, - "createdTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "\nThe timestamp at which the volume was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.\n
" - } - }, - "description": { - "target": "com.amazonaws.finspace#Description", - "traits": { - "smithy.api#documentation": "\nA description of the volume.\n
" - } - }, - "azMode": { - "target": "com.amazonaws.finspace#KxAzMode", - "traits": { - "smithy.api#documentation": "The number of availability zones you want to assign per volume. Currently, FinSpace only supports SINGLE for volumes. This places dataview in a single AZ.
The identifier of the availability zones.
" - } - }, - "lastModifiedTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "The last time that the volume was updated in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" - } - }, - "attachedClusters": { - "target": "com.amazonaws.finspace#KxAttachedClusters", - "traits": { - "smithy.api#documentation": "\nA list of cluster identifiers that a volume is attached to. \n
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#IPAddressType": { - "type": "enum", - "members": { - "IP_V4": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IP_V4" - } - } - } - }, - "com.amazonaws.finspace#IcmpTypeCode": { - "type": "structure", - "members": { - "type": { - "target": "com.amazonaws.finspace#IcmpTypeOrCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The ICMP type. A value of -1 means all types.\n
", - "smithy.api#required": {} - } - }, - "code": { - "target": "com.amazonaws.finspace#IcmpTypeOrCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "\n The ICMP code. A value of -1 means all codes for the specified ICMP type.\n
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "\n Defines the ICMP protocol that consists of the ICMP type and code.\n
" - } - }, - "com.amazonaws.finspace#IcmpTypeOrCode": { - "type": "integer", - "traits": { - "smithy.api#default": 0 - } - }, - "com.amazonaws.finspace#IdType": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 26 - }, - "smithy.api#pattern": "^[a-zA-Z0-9]{1,26}$" - } - }, - "com.amazonaws.finspace#InitializationScriptFilePath": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - }, - "smithy.api#pattern": "^[a-zA-Z0-9\\_\\-\\.\\/\\\\]+$" - } - }, - "com.amazonaws.finspace#InternalServerException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.finspace#ErrorMessage2" - } - }, - "traits": { - "smithy.api#documentation": "The request processing has failed because of an unknown error, exception or\n failure.
", - "smithy.api#error": "server", - "smithy.api#httpError": 500 - } - }, - "com.amazonaws.finspace#InvalidRequestException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.finspace#ErrorMessage2" - } - }, - "traits": { - "smithy.api#documentation": "The request is invalid. Something is wrong with the input to the request.
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.finspace#KmsKeyARN": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1000 - }, - "smithy.api#pattern": "^arn:aws:kms:.*:\\d+:.*$" - } - }, - "com.amazonaws.finspace#KmsKeyId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1000 - }, - "smithy.api#pattern": "^[a-zA-Z-0-9-:\\/]*$" - } - }, - "com.amazonaws.finspace#KxAttachedCluster": { - "type": "structure", - "members": { - "clusterName": { - "target": "com.amazonaws.finspace#KxClusterName", - "traits": { - "smithy.api#documentation": "A unique name for the attached cluster.
" - } - }, - "clusterType": { - "target": "com.amazonaws.finspace#KxClusterType", - "traits": { - "smithy.api#documentation": "Specifies the type of cluster. The volume for TP and RDB cluster types will be used for TP logs.
" - } - }, - "clusterStatus": { - "target": "com.amazonaws.finspace#KxClusterStatus", - "traits": { - "smithy.api#documentation": "The status of the attached cluster.
\nPENDING – The cluster is pending creation.
\nCREATING – The cluster creation process is in progress.
\nCREATE_FAILED – The cluster creation process has failed.
\nRUNNING – The cluster creation process is running.
\nUPDATING – The cluster is in the process of being updated.
\nDELETING – The cluster is in the process of being deleted.
\nDELETED – The cluster has been deleted.
\nDELETE_FAILED – The cluster failed to delete.
\nThe structure containing the metadata of the attached clusters.
" - } - }, - "com.amazonaws.finspace#KxAttachedClusters": { - "type": "list", - "member": { - "target": "com.amazonaws.finspace#KxAttachedCluster" - } - }, - "com.amazonaws.finspace#KxAzMode": { - "type": "enum", - "members": { - "SINGLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SINGLE" - } - }, - "MULTI": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MULTI" - } - } - } - }, - "com.amazonaws.finspace#KxCacheStorageConfiguration": { - "type": "structure", - "members": { - "type": { - "target": "com.amazonaws.finspace#KxCacheStorageType", - "traits": { - "smithy.api#documentation": "The type of cache storage. The valid values are:
\nCACHE_1000 – This type provides at least 1000 MB/s disk access throughput.
\nCACHE_250 – This type provides at least 250 MB/s disk access throughput.
\nCACHE_12 – This type provides at least 12 MB/s disk access throughput.
\nFor cache type CACHE_1000 and CACHE_250 you can select cache size as 1200 GB or increments of 2400 GB. For cache type CACHE_12 you can select the cache size in increments of 6000 GB.
The size of cache in Gigabytes.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "The configuration for read only disk cache associated with a cluster.
" - } - }, - "com.amazonaws.finspace#KxCacheStorageConfigurations": { - "type": "list", - "member": { - "target": "com.amazonaws.finspace#KxCacheStorageConfiguration" - } - }, - "com.amazonaws.finspace#KxCacheStorageSize": { - "type": "integer" - }, - "com.amazonaws.finspace#KxCacheStorageType": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 8, - "max": 10 - } - } - }, - "com.amazonaws.finspace#KxChangesetListEntry": { - "type": "structure", - "members": { - "changesetId": { - "target": "com.amazonaws.finspace#ChangesetId", - "traits": { - "smithy.api#documentation": "A unique identifier for the changeset.
" - } - }, - "createdTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "The timestamp at which the changeset was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" - } - }, - "activeFromTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "Beginning time from which the changeset is active. The value is determined as epoch time in\n milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as\n 1635768000000.
" - } - }, - "lastModifiedTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "The timestamp at which the changeset was modified. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as\n 1635768000000.
" - } - }, - "status": { - "target": "com.amazonaws.finspace#ChangesetStatus", - "traits": { - "smithy.api#documentation": "Status of the changeset.
\nPending – Changeset creation is pending.
\nProcessing – Changeset creation is running.
\nFailed – Changeset creation has failed.
\nComplete – Changeset creation has succeeded.
\nDetails of changeset.
" - } - }, - "com.amazonaws.finspace#KxChangesets": { - "type": "list", - "member": { - "target": "com.amazonaws.finspace#KxChangesetListEntry" - } - }, - "com.amazonaws.finspace#KxCluster": { - "type": "structure", - "members": { - "status": { - "target": "com.amazonaws.finspace#KxClusterStatus", - "traits": { - "smithy.api#documentation": "The status of a cluster.
\nPENDING – The cluster is pending creation.
\nCREATING –The cluster creation process is in progress.
\nCREATE_FAILED– The cluster creation process has failed.
\nRUNNING – The cluster creation process is running.
\nUPDATING – The cluster is in the process of being updated.
\nDELETING – The cluster is in the process of being deleted.
\nDELETED – The cluster has been deleted.
\nDELETE_FAILED – The cluster failed to delete.
\nThe error message when a failed state occurs.
" - } - }, - "clusterName": { - "target": "com.amazonaws.finspace#KxClusterName", - "traits": { - "smithy.api#documentation": "A unique name for the cluster.
" - } - }, - "clusterType": { - "target": "com.amazonaws.finspace#KxClusterType", - "traits": { - "smithy.api#documentation": "Specifies the type of KDB database that is being created. The following types are available:
\nHDB – A Historical Database. The data is only accessible with read-only permissions from one of the FinSpace managed kdb databases mounted to the cluster.
\nRDB – A Realtime Database. This type of database captures all the data from a ticker plant and stores it in memory until the end of day, after which it writes all of its data to a disk and reloads the HDB. This cluster type requires local storage for temporary storage of data during the savedown process. If you specify this field in your request, you must provide the savedownStorageConfiguration parameter.
GATEWAY – A gateway cluster allows you to access data across processes in kdb systems. It allows you to create your own routing logic using the initialization scripts and custom code. This type of cluster does not require a writable local storage.
\nGP – A general purpose cluster allows you to quickly iterate on code during development by granting greater access to system commands and enabling a fast reload of custom code. This cluster type can optionally mount databases including cache and savedown storage. For this cluster type, the node count is fixed at 1. It does not support autoscaling and supports only SINGLE AZ mode.
Tickerplant – A tickerplant cluster allows you to subscribe to feed handlers based on IAM permissions. It can publish to RDBs, other Tickerplants, and real-time subscribers (RTS). Tickerplants can persist messages to log, which is readable by any RDB environment. It supports only single-node that is only one kdb process.
\nA description of the cluster.
" - } - }, - "releaseLabel": { - "target": "com.amazonaws.finspace#ReleaseLabel", - "traits": { - "smithy.api#documentation": "A version of the FinSpace managed kdb to run.
" - } - }, - "volumes": { - "target": "com.amazonaws.finspace#Volumes", - "traits": { - "smithy.api#documentation": "\nA list of volumes attached to the cluster.\n
" - } - }, - "initializationScript": { - "target": "com.amazonaws.finspace#InitializationScriptFilePath", - "traits": { - "smithy.api#documentation": "Specifies a Q program that will be run at launch of a cluster. It is a relative path within\n .zip file that contains the custom code, which will be loaded on\n the cluster. It must include the file name itself. For example,\n somedir/init.q.
\n An IAM role that defines a set of permissions associated with a cluster. These permissions are assumed when a cluster attempts to access another cluster.\n
" - } - }, - "azMode": { - "target": "com.amazonaws.finspace#KxAzMode", - "traits": { - "smithy.api#documentation": "The number of availability zones assigned per cluster. This can be one of the following:
\n\n SINGLE – Assigns one availability zone per cluster.
\n MULTI – Assigns all the availability zones per cluster.
\n The availability zone identifiers for the requested regions.\n
" - } - }, - "lastModifiedTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "The last time that the cluster was modified. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" - } - }, - "createdTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "The timestamp at which the cluster was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The details of a kdb cluster.
" - } - }, - "com.amazonaws.finspace#KxClusterCodeDeploymentConfiguration": { - "type": "structure", - "members": { - "deploymentStrategy": { - "target": "com.amazonaws.finspace#KxClusterCodeDeploymentStrategy", - "traits": { - "smithy.api#documentation": "\n The type of deployment that you want on a cluster.\n \n
\nROLLING – This options updates the cluster by stopping the exiting q process and starting a new q process with updated configuration.
\nNO_RESTART – This option updates the cluster without stopping the running q process. It is only available for GP type cluster. This option is quicker as it reduces the turn around time to update configuration on a cluster.
With this deployment mode, you cannot update the initializationScript and commandLineArguments parameters.
FORCE – This option updates the cluster by immediately stopping all the running processes before starting up new ones with the updated configuration.
\n\n The configuration that allows you to choose how you want to update code on a cluster. Depending on the option you choose, you can reduce the time it takes to update the cluster.\n
" - } - }, - "com.amazonaws.finspace#KxClusterCodeDeploymentStrategy": { - "type": "enum", - "members": { - "NO_RESTART": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NO_RESTART" - } - }, - "ROLLING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ROLLING" - } - }, - "FORCE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FORCE" - } - } - } - }, - "com.amazonaws.finspace#KxClusterDescription": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1000 - }, - "smithy.api#pattern": "^[a-zA-Z0-9\\_\\-\\.\\s]+$" - } - }, - "com.amazonaws.finspace#KxClusterName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 3, - "max": 63 - }, - "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_]*[a-zA-Z0-9]$" - } - }, - "com.amazonaws.finspace#KxClusterNameList": { - "type": "list", - "member": { - "target": "com.amazonaws.finspace#KxClusterName" - } - }, - "com.amazonaws.finspace#KxClusterNodeIdString": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 40 - } - } - }, - "com.amazonaws.finspace#KxClusterStatus": { - "type": "enum", - "members": { - "PENDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PENDING" - } - }, - "CREATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATING" - } - }, - "CREATE_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATE_FAILED" - } - }, - "RUNNING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RUNNING" - } - }, - "UPDATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UPDATING" - } - }, - "DELETING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETING" - } - }, - "DELETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETED" - } - }, - "DELETE_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETE_FAILED" - } - } - } - }, - "com.amazonaws.finspace#KxClusterStatusReason": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 250 - }, - "smithy.api#pattern": "^[a-zA-Z0-9\\_\\-\\.\\s]+$" - } - }, - "com.amazonaws.finspace#KxClusterType": { - "type": "enum", - "members": { - "HDB": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HDB" - } - }, - "RDB": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RDB" - } - }, - "GATEWAY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GATEWAY" - } - }, - "GP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GP" - } - }, - "TICKERPLANT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TICKERPLANT" - } - } - } - }, - "com.amazonaws.finspace#KxClusters": { - "type": "list", - "member": { - "target": "com.amazonaws.finspace#KxCluster" - } - }, - "com.amazonaws.finspace#KxCommandLineArgument": { - "type": "structure", - "members": { - "key": { - "target": "com.amazonaws.finspace#KxCommandLineArgumentKey", - "traits": { - "smithy.api#documentation": "The name of the key.
" - } - }, - "value": { - "target": "com.amazonaws.finspace#KxCommandLineArgumentValue", - "traits": { - "smithy.api#documentation": "The value of the key.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Defines the key-value pairs to make them available inside the cluster.
" - } - }, - "com.amazonaws.finspace#KxCommandLineArgumentKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - }, - "smithy.api#pattern": "^(?![Aa][Ww][Ss])(s|([a-zA-Z][a-zA-Z0-9_]+))|(AWS_ZIP_DEFAULT)$" - } - }, - "com.amazonaws.finspace#KxCommandLineArgumentValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - }, - "smithy.api#pattern": "^[a-zA-Z0-9_:./,]+$" - } - }, - "com.amazonaws.finspace#KxCommandLineArguments": { - "type": "list", - "member": { - "target": "com.amazonaws.finspace#KxCommandLineArgument" - } - }, - "com.amazonaws.finspace#KxDatabaseCacheConfiguration": { - "type": "structure", - "members": { - "cacheType": { - "target": "com.amazonaws.finspace#KxCacheStorageType", - "traits": { - "smithy.api#documentation": "The type of disk cache. This parameter is used to map the database path to cache storage. The valid values are:
\nCACHE_1000 – This type provides at least 1000 MB/s disk access throughput.
\nSpecifies the portions of database that will be loaded into the cache for access.
", - "smithy.api#required": {} - } - }, - "dataviewName": { - "target": "com.amazonaws.finspace#KxDataviewName", - "traits": { - "smithy.api#documentation": "\n The name of the dataview to be used for caching historical data on disk.\n \n
" - } - } - }, - "traits": { - "smithy.api#documentation": "The structure of database cache configuration that is used for mapping database paths to cache types in clusters.
" - } - }, - "com.amazonaws.finspace#KxDatabaseCacheConfigurations": { - "type": "list", - "member": { - "target": "com.amazonaws.finspace#KxDatabaseCacheConfiguration" - } - }, - "com.amazonaws.finspace#KxDatabaseConfiguration": { - "type": "structure", - "members": { - "databaseName": { - "target": "com.amazonaws.finspace#DatabaseName", - "traits": { - "smithy.api#documentation": "The name of the kdb database. When this parameter is specified in the structure, S3 with the whole database is included by default.
", - "smithy.api#required": {} - } - }, - "cacheConfigurations": { - "target": "com.amazonaws.finspace#KxDatabaseCacheConfigurations", - "traits": { - "smithy.api#documentation": "Configuration details for the disk cache used to increase performance reading from a kdb database mounted to the cluster.
" - } - }, - "changesetId": { - "target": "com.amazonaws.finspace#ChangesetId", - "traits": { - "smithy.api#documentation": "A unique identifier of the changeset that is associated with the cluster.
" - } - }, - "dataviewName": { - "target": "com.amazonaws.finspace#KxDataviewName", - "traits": { - "smithy.api#documentation": "\n The name of the dataview to be used for caching historical data on disk.\n \n
" - } - }, - "dataviewConfiguration": { - "target": "com.amazonaws.finspace#KxDataviewConfiguration", - "traits": { - "smithy.api#documentation": "\n The configuration of the dataview to be used with specified cluster.\n \n
" - } - } - }, - "traits": { - "smithy.api#documentation": "The configuration of data that is available for querying from this database.
" - } - }, - "com.amazonaws.finspace#KxDatabaseConfigurations": { - "type": "list", - "member": { - "target": "com.amazonaws.finspace#KxDatabaseConfiguration" - } - }, - "com.amazonaws.finspace#KxDatabaseListEntry": { - "type": "structure", - "members": { - "databaseName": { - "target": "com.amazonaws.finspace#DatabaseName", - "traits": { - "smithy.api#documentation": "The name of the kdb database.
" - } - }, - "createdTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "The timestamp at which the database was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" - } - }, - "lastModifiedTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "The last time that the database was modified. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Details about a FinSpace managed kdb database
" - } - }, - "com.amazonaws.finspace#KxDatabases": { - "type": "list", - "member": { - "target": "com.amazonaws.finspace#KxDatabaseListEntry" - } - }, - "com.amazonaws.finspace#KxDataviewActiveVersion": { - "type": "structure", - "members": { - "changesetId": { - "target": "com.amazonaws.finspace#ChangesetId", - "traits": { - "smithy.api#documentation": "A unique identifier for the changeset.
" - } - }, - "segmentConfigurations": { - "target": "com.amazonaws.finspace#KxDataviewSegmentConfigurationList", - "traits": { - "smithy.api#documentation": "\n The configuration that contains the database path of the data that you want to place on each selected volume. Each segment must have a unique database path for each volume. If you do not explicitly specify any database path for a volume, they are accessible from the cluster through the default S3/object store segment.
" - } - }, - "attachedClusters": { - "target": "com.amazonaws.finspace#AttachedClusterList", - "traits": { - "smithy.api#documentation": "\n The list of clusters that are currently using this dataview.\n \n
" - } - }, - "createdTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "\nThe timestamp at which the dataview version was active. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" - } - }, - "versionId": { - "target": "com.amazonaws.finspace#VersionId", - "traits": { - "smithy.api#documentation": "\nA unique identifier of the active version.
" - } - } - }, - "traits": { - "smithy.api#documentation": "\n The active version of the dataview that is currently in use by this cluster.\n \n
" - } - }, - "com.amazonaws.finspace#KxDataviewActiveVersionList": { - "type": "list", - "member": { - "target": "com.amazonaws.finspace#KxDataviewActiveVersion" - } - }, - "com.amazonaws.finspace#KxDataviewConfiguration": { - "type": "structure", - "members": { - "dataviewName": { - "target": "com.amazonaws.finspace#KxDataviewName", - "traits": { - "smithy.api#documentation": "\nThe unique identifier of the dataview.
" - } - }, - "dataviewVersionId": { - "target": "com.amazonaws.finspace#VersionId", - "traits": { - "smithy.api#documentation": "\n The version of the dataview corresponding to a given changeset.\n \n
" - } - }, - "changesetId": { - "target": "com.amazonaws.finspace#ChangesetId", - "traits": { - "smithy.api#documentation": "A unique identifier for the changeset.
" - } - }, - "segmentConfigurations": { - "target": "com.amazonaws.finspace#KxDataviewSegmentConfigurationList", - "traits": { - "smithy.api#documentation": "\nThe db path and volume configuration for the segmented database.
" - } - } - }, - "traits": { - "smithy.api#documentation": "\nThe structure that stores the configuration details of a dataview.
" - } - }, - "com.amazonaws.finspace#KxDataviewListEntry": { - "type": "structure", - "members": { - "environmentId": { - "target": "com.amazonaws.finspace#EnvironmentId", - "traits": { - "smithy.api#documentation": "A unique identifier for the kdb environment.
" - } - }, - "databaseName": { - "target": "com.amazonaws.finspace#DatabaseName", - "traits": { - "smithy.api#documentation": "\nA unique identifier of the database.
" - } - }, - "dataviewName": { - "target": "com.amazonaws.finspace#KxDataviewName", - "traits": { - "smithy.api#documentation": "\nA unique identifier of the dataview.
" - } - }, - "azMode": { - "target": "com.amazonaws.finspace#KxAzMode", - "traits": { - "smithy.api#documentation": "The number of availability zones you want to assign per volume. Currently, FinSpace only supports SINGLE for volumes. This places dataview in a single AZ.
\n The identifier of the availability zones.\n
" - } - }, - "changesetId": { - "target": "com.amazonaws.finspace#ChangesetId", - "traits": { - "smithy.api#documentation": "A unique identifier for the changeset.
" - } - }, - "segmentConfigurations": { - "target": "com.amazonaws.finspace#KxDataviewSegmentConfigurationList", - "traits": { - "smithy.api#documentation": "\n The configuration that contains the database path of the data that you want to place on each selected volume. Each segment must have a unique database path for each volume. If you do not explicitly specify any database path for a volume, they are accessible from the cluster through the default S3/object store segment.
" - } - }, - "activeVersions": { - "target": "com.amazonaws.finspace#KxDataviewActiveVersionList", - "traits": { - "smithy.api#documentation": "\n The active changeset versions for the given dataview entry.\n \n
" - } - }, - "status": { - "target": "com.amazonaws.finspace#KxDataviewStatus", - "traits": { - "smithy.api#documentation": "\n The status of a given dataview entry.\n \n
" - } - }, - "description": { - "target": "com.amazonaws.finspace#Description", - "traits": { - "smithy.api#documentation": "\nA description for the dataview list entry.
" - } - }, - "autoUpdate": { - "target": "com.amazonaws.finspace#booleanValue", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "\n The option to specify whether you want to apply all the future additions and corrections automatically to the dataview when you ingest new changesets. The default value is false.\n
" - } - }, - "readWrite": { - "target": "com.amazonaws.finspace#booleanValue", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "Returns True if the dataview is created as writeable and False otherwise.
" - } - }, - "createdTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "\nThe timestamp at which the dataview list entry was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" - } - }, - "lastModifiedTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "The last time that the dataview list was updated in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" - } - }, - "statusReason": { - "target": "com.amazonaws.finspace#KxDataviewStatusReason", - "traits": { - "smithy.api#documentation": "\nThe error message when a failed state occurs. \n
" - } - } - }, - "traits": { - "smithy.api#documentation": "\n A collection of kdb dataview entries.\n \n
" - } - }, - "com.amazonaws.finspace#KxDataviewName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 3, - "max": 63 - }, - "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_]*[a-zA-Z0-9]$" - } - }, - "com.amazonaws.finspace#KxDataviewSegmentConfiguration": { - "type": "structure", - "members": { - "dbPaths": { - "target": "com.amazonaws.finspace#SegmentConfigurationDbPathList", - "traits": { - "smithy.api#documentation": "\nThe database path of the data that you want to place on each selected volume for the segment. Each segment must have a unique database path for each volume.
", - "smithy.api#required": {} - } - }, - "volumeName": { - "target": "com.amazonaws.finspace#KxVolumeName", - "traits": { - "smithy.api#documentation": "\nThe name of the volume where you want to add data.
", - "smithy.api#required": {} - } - }, - "onDemand": { - "target": "com.amazonaws.finspace#booleanValue", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "Enables on-demand caching on the selected database path when a particular file or a\n column of the database is accessed. When on demand caching is True, dataviews perform minimal loading of files on the filesystem as\n needed. When it is set to False, everything is cached. The\n default value is False.
" - } - } - }, - "traits": { - "smithy.api#documentation": "\n The configuration that contains the database path of the data that you want to place on each selected volume. Each segment must have a unique database path for each volume. If you do not explicitly specify any database path for a volume, they are accessible from the cluster through the default S3/object store segment.
" - } - }, - "com.amazonaws.finspace#KxDataviewSegmentConfigurationList": { - "type": "list", - "member": { - "target": "com.amazonaws.finspace#KxDataviewSegmentConfiguration" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 50 - } - } - }, - "com.amazonaws.finspace#KxDataviewStatus": { - "type": "enum", - "members": { - "CREATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATING" - } - }, - "ACTIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACTIVE" - } - }, - "UPDATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UPDATING" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - }, - "DELETING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETING" - } - } - } - }, - "com.amazonaws.finspace#KxDataviewStatusReason": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 250 - }, - "smithy.api#pattern": "^[a-zA-Z0-9\\_\\-\\.\\s]+$" - } - }, - "com.amazonaws.finspace#KxDataviews": { - "type": "list", - "member": { - "target": "com.amazonaws.finspace#KxDataviewListEntry" - } - }, - "com.amazonaws.finspace#KxDeploymentConfiguration": { - "type": "structure", - "members": { - "deploymentStrategy": { - "target": "com.amazonaws.finspace#KxDeploymentStrategy", - "traits": { - "smithy.api#documentation": "\n The type of deployment that you want on a cluster.\n \n
\nROLLING – This options updates the cluster by stopping the exiting q process and starting a new q process with updated configuration.
\nNO_RESTART – This option updates the cluster without stopping the running q process. It is only available for HDB type cluster. This option is quicker as it reduces the turn around time to update configuration on a cluster.
With this deployment mode, you cannot update the initializationScript and commandLineArguments parameters.
\n The configuration that allows you to choose how you want to update the databases on a cluster. Depending on the option you choose, you can reduce the time it takes to update the cluster.\n
" - } - }, - "com.amazonaws.finspace#KxDeploymentStrategy": { - "type": "enum", - "members": { - "NO_RESTART": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NO_RESTART" - } - }, - "ROLLING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ROLLING" - } - } - } - }, - "com.amazonaws.finspace#KxEnvironment": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.finspace#KxEnvironmentName", - "traits": { - "smithy.api#documentation": "The name of the kdb environment.
" - } - }, - "environmentId": { - "target": "com.amazonaws.finspace#IdType", - "traits": { - "smithy.api#documentation": "A unique identifier for the kdb environment.
" - } - }, - "awsAccountId": { - "target": "com.amazonaws.finspace#IdType", - "traits": { - "smithy.api#documentation": "The unique identifier of the AWS account in which you create the kdb environment.
" - } - }, - "status": { - "target": "com.amazonaws.finspace#EnvironmentStatus", - "traits": { - "smithy.api#documentation": "The status of the environment creation.
\nCREATE_REQUESTED – Environment creation has been requested.
\nCREATING – Environment is in the process of being created.
\nFAILED_CREATION – Environment creation has failed.
\nCREATED – Environment is successfully created and is currently active.
\nDELETE REQUESTED – Environment deletion has been requested.
\nDELETING – Environment is in the process of being deleted.
\nRETRY_DELETION – Initial environment deletion failed, system is reattempting delete.
\nDELETED – Environment has been deleted.
\nFAILED_DELETION – Environment deletion has failed.
\nThe status of the network configuration.
" - } - }, - "dnsStatus": { - "target": "com.amazonaws.finspace#dnsStatus", - "traits": { - "smithy.api#documentation": "The status of DNS configuration.
" - } - }, - "errorMessage": { - "target": "com.amazonaws.finspace#EnvironmentErrorMessage", - "traits": { - "smithy.api#documentation": "Specifies the error message that appears if a flow fails.
" - } - }, - "description": { - "target": "com.amazonaws.finspace#Description", - "traits": { - "smithy.api#documentation": "A description of the kdb environment.
" - } - }, - "environmentArn": { - "target": "com.amazonaws.finspace#EnvironmentArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of your kdb environment.
" - } - }, - "kmsKeyId": { - "target": "com.amazonaws.finspace#KmsKeyId", - "traits": { - "smithy.api#documentation": "The unique identifier of the KMS key.
" - } - }, - "dedicatedServiceAccountId": { - "target": "com.amazonaws.finspace#IdType", - "traits": { - "smithy.api#documentation": "A unique identifier for the AWS environment infrastructure account.
" - } - }, - "transitGatewayConfiguration": { - "target": "com.amazonaws.finspace#TransitGatewayConfiguration", - "traits": { - "smithy.api#documentation": "Specifies the transit gateway and network configuration to connect the kdb environment to an internal network.
" - } - }, - "customDNSConfiguration": { - "target": "com.amazonaws.finspace#CustomDNSConfiguration", - "traits": { - "smithy.api#documentation": "A list of DNS server name and server IP. This is used to set up Route-53 outbound resolvers.
" - } - }, - "creationTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "The timestamp at which the kdb environment was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" - } - }, - "updateTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "The timestamp at which the kdb environment was modified in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" - } - }, - "availabilityZoneIds": { - "target": "com.amazonaws.finspace#AvailabilityZoneIds", - "traits": { - "smithy.api#documentation": "The identifier of the availability zones where subnets for the environment are created.
" - } - }, - "certificateAuthorityArn": { - "target": "com.amazonaws.finspace#stringValueLength1to255", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the certificate authority:
" - } - } - }, - "traits": { - "smithy.api#documentation": "The details of a kdb environment.
" - } - }, - "com.amazonaws.finspace#KxEnvironmentId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 32 - }, - "smithy.api#pattern": "^[a-z0-9]+$" - } - }, - "com.amazonaws.finspace#KxEnvironmentList": { - "type": "list", - "member": { - "target": "com.amazonaws.finspace#KxEnvironment" - } - }, - "com.amazonaws.finspace#KxEnvironmentName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 3, - "max": 63 - }, - "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_]*[a-zA-Z0-9]$" - } - }, - "com.amazonaws.finspace#KxHostType": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 32 - }, - "smithy.api#pattern": "^[a-zA-Z0-9._]+$" - } - }, - "com.amazonaws.finspace#KxNAS1Configuration": { - "type": "structure", - "members": { - "type": { - "target": "com.amazonaws.finspace#KxNAS1Type", - "traits": { - "smithy.api#documentation": "\nThe type of the network attached storage.\n
" - } - }, - "size": { - "target": "com.amazonaws.finspace#KxNAS1Size", - "traits": { - "smithy.api#documentation": "\n The size of the network attached storage. For storage type\n SSD_1000 and SSD_250 you can select the\n minimum size as 1200 GB or increments of 2400 GB. For storage type\n HDD_12 you can select the minimum size as 6000 GB or increments\n of 6000 GB.
\n The structure containing the size and type of the network attached storage (NAS_1) file system volume.\n
" - } - }, - "com.amazonaws.finspace#KxNAS1Size": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1200 - } - } - }, - "com.amazonaws.finspace#KxNAS1Type": { - "type": "enum", - "members": { - "SSD_1000": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SSD_1000" - } - }, - "SSD_250": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SSD_250" - } - }, - "HDD_12": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HDD_12" - } - } - } - }, - "com.amazonaws.finspace#KxNode": { - "type": "structure", - "members": { - "nodeId": { - "target": "com.amazonaws.finspace#KxClusterNodeIdString", - "traits": { - "smithy.api#documentation": "A unique identifier for the node.
" - } - }, - "availabilityZoneId": { - "target": "com.amazonaws.finspace#AvailabilityZoneId", - "traits": { - "smithy.api#documentation": "The identifier of the availability zones where subnets for the environment are created.
" - } - }, - "launchTime": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "The time when a particular node is started. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" - } - }, - "status": { - "target": "com.amazonaws.finspace#KxNodeStatus", - "traits": { - "smithy.api#documentation": "\n Specifies the status of the cluster nodes.
\n\n RUNNING – The node is actively serving.
\n PROVISIONING – The node is being prepared.
A structure that stores metadata for a kdb node.
" - } - }, - "com.amazonaws.finspace#KxNodeStatus": { - "type": "enum", - "members": { - "RUNNING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RUNNING" - } - }, - "PROVISIONING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PROVISIONING" - } - } - } - }, - "com.amazonaws.finspace#KxNodeSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.finspace#KxNode" - } - }, - "com.amazonaws.finspace#KxSavedownStorageConfiguration": { - "type": "structure", - "members": { - "type": { - "target": "com.amazonaws.finspace#KxSavedownStorageType", - "traits": { - "smithy.api#documentation": "The type of writeable storage space for temporarily storing your savedown data. The valid values are:
\nSDS01 – This type represents 3000 IOPS and io2 ebs volume type.
\nThe size of temporary storage in gibibytes.
" - } - }, - "volumeName": { - "target": "com.amazonaws.finspace#KxVolumeName", - "traits": { - "smithy.api#documentation": "\n The name of the kdb volume that you want to use as writeable save-down storage for clusters.\n \n
" - } - } - }, - "traits": { - "smithy.api#documentation": "The size and type of temporary storage that is used to hold data during the savedown process. All the data written to this storage space is lost when the cluster node is restarted.
" - } - }, - "com.amazonaws.finspace#KxSavedownStorageSize": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 10, - "max": 16000 - } - } - }, - "com.amazonaws.finspace#KxSavedownStorageType": { - "type": "enum", - "members": { - "SDS01": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SDS01" - } - } - } - }, - "com.amazonaws.finspace#KxScalingGroup": { - "type": "structure", - "members": { - "scalingGroupName": { - "target": "com.amazonaws.finspace#KxScalingGroupName", - "traits": { - "smithy.api#documentation": "A unique identifier for the kdb scaling group.
" - } - }, - "hostType": { - "target": "com.amazonaws.finspace#KxHostType", - "traits": { - "smithy.api#documentation": "\n The memory and CPU capabilities of the scaling group host on which FinSpace Managed kdb clusters will be placed.
\nYou can add one of the following values:
\n\n kx.sg.4xlarge – The host type with a configuration of 108 GiB memory and 16 vCPUs.
\n kx.sg.8xlarge – The host type with a configuration of 216 GiB memory and 32 vCPUs.
\n kx.sg.16xlarge – The host type with a configuration of 432 GiB memory and 64 vCPUs.
\n kx.sg.32xlarge – The host type with a configuration of 864 GiB memory and 128 vCPUs.
\n kx.sg1.16xlarge – The host type with a configuration of 1949 GiB memory and 64 vCPUs.
\n kx.sg1.24xlarge – The host type with a configuration of 2948 GiB memory and 96 vCPUs.
\n The list of clusters currently active in a given scaling group.\n \n
" - } - }, - "availabilityZoneId": { - "target": "com.amazonaws.finspace#AvailabilityZoneId", - "traits": { - "smithy.api#documentation": "The identifier of the availability zones.
" - } - }, - "status": { - "target": "com.amazonaws.finspace#KxScalingGroupStatus", - "traits": { - "smithy.api#documentation": "\nThe status of scaling groups.\n
" - } - }, - "statusReason": { - "target": "com.amazonaws.finspace#KxClusterStatusReason", - "traits": { - "smithy.api#documentation": "\nThe error message when a failed state occurs. \n
" - } - }, - "lastModifiedTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "\n The last time that the scaling group was updated in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.\n
" - } - }, - "createdTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "\n The timestamp at which the scaling group was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.\n
" - } - } - }, - "traits": { - "smithy.api#documentation": "\nA structure for storing metadata of scaling group.
" - } - }, - "com.amazonaws.finspace#KxScalingGroupConfiguration": { - "type": "structure", - "members": { - "scalingGroupName": { - "target": "com.amazonaws.finspace#KxScalingGroupName", - "traits": { - "smithy.api#documentation": "A unique identifier for the kdb scaling group.
", - "smithy.api#required": {} - } - }, - "memoryLimit": { - "target": "com.amazonaws.finspace#MemoryMib", - "traits": { - "smithy.api#documentation": "\n An optional hard limit on the amount of memory a kdb cluster can use.\n \n
" - } - }, - "memoryReservation": { - "target": "com.amazonaws.finspace#MemoryMib", - "traits": { - "smithy.api#documentation": "\n A reservation of the minimum amount of memory that should be available on the scaling group for a kdb cluster to be successfully placed in a scaling group. \n \n
", - "smithy.api#required": {} - } - }, - "nodeCount": { - "target": "com.amazonaws.finspace#ClusterNodeCount", - "traits": { - "smithy.api#documentation": "\n The number of kdb cluster nodes.\n \n
", - "smithy.api#required": {} - } - }, - "cpu": { - "target": "com.amazonaws.finspace#CpuCount", - "traits": { - "smithy.api#documentation": "\n The number of vCPUs that you want to reserve for each node of this kdb cluster on the scaling group host.\n \n
" - } - } - }, - "traits": { - "smithy.api#documentation": "The structure that stores the capacity configuration details of a scaling group.
" - } - }, - "com.amazonaws.finspace#KxScalingGroupList": { - "type": "list", - "member": { - "target": "com.amazonaws.finspace#KxScalingGroup" - } - }, - "com.amazonaws.finspace#KxScalingGroupName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 3, - "max": 63 - }, - "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_]*[a-zA-Z0-9]$" - } - }, - "com.amazonaws.finspace#KxScalingGroupStatus": { - "type": "enum", - "members": { - "CREATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATING" - } - }, - "CREATE_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATE_FAILED" - } - }, - "ACTIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACTIVE" - } - }, - "DELETING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETING" - } - }, - "DELETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETED" - } - }, - "DELETE_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETE_FAILED" - } - } - } - }, - "com.amazonaws.finspace#KxUser": { - "type": "structure", - "members": { - "userArn": { - "target": "com.amazonaws.finspace#KxUserArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies the user. For more information about ARNs and\n how to use ARNs in policies, see IAM Identifiers in the\n IAM User Guide.
" - } - }, - "userName": { - "target": "com.amazonaws.finspace#KxUserNameString", - "traits": { - "smithy.api#documentation": "A unique identifier for the user.
" - } - }, - "iamRole": { - "target": "com.amazonaws.finspace#RoleArn", - "traits": { - "smithy.api#documentation": "The IAM role ARN that is associated with the user.
" - } - }, - "createTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "The timestamp at which the kdb user was created.
" - } - }, - "updateTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "The timestamp at which the kdb user was updated.
" - } - } - }, - "traits": { - "smithy.api#documentation": "A structure that stores metadata for a kdb user.
" - } - }, - "com.amazonaws.finspace#KxUserArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 20, - "max": 2048 - }, - "smithy.api#pattern": "^arn:aws:finspace:[A-Za-z0-9_/.-]{0,63}:\\d+:kxEnvironment/[0-9A-Za-z_-]{1,128}/kxUser/[0-9A-Za-z_-]{1,128}$" - } - }, - "com.amazonaws.finspace#KxUserList": { - "type": "list", - "member": { - "target": "com.amazonaws.finspace#KxUser" - } - }, - "com.amazonaws.finspace#KxUserNameString": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - }, - "smithy.api#pattern": "^[0-9A-Za-z_-]{1,50}$" - } - }, - "com.amazonaws.finspace#KxVolume": { - "type": "structure", - "members": { - "volumeName": { - "target": "com.amazonaws.finspace#KxVolumeName", - "traits": { - "smithy.api#documentation": "A unique identifier for the volume.
" - } - }, - "volumeType": { - "target": "com.amazonaws.finspace#KxVolumeType", - "traits": { - "smithy.api#documentation": "\n The type of file system volume. Currently, FinSpace only supports NAS_1 volume type.\n
The status of volume.
\nCREATING – The volume creation is in progress.
\nCREATE_FAILED – The volume creation has failed.
\nACTIVE – The volume is active.
\nUPDATING – The volume is in the process of being updated.
\nUPDATE_FAILED – The update action failed.
\nUPDATED – The volume is successfully updated.
\nDELETING – The volume is in the process of being deleted.
\nDELETE_FAILED – The system failed to delete the volume.
\nDELETED – The volume is successfully deleted.
\n\nA description of the volume.\n
" - } - }, - "statusReason": { - "target": "com.amazonaws.finspace#KxVolumeStatusReason", - "traits": { - "smithy.api#documentation": "The error message when a failed state occurs.
" - } - }, - "azMode": { - "target": "com.amazonaws.finspace#KxAzMode", - "traits": { - "smithy.api#documentation": "The number of availability zones you want to assign per volume. Currently, FinSpace only supports SINGLE for volumes. This places dataview in a single AZ.
The identifier of the availability zones.
" - } - }, - "createdTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "\nThe timestamp at which the volume was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" - } - }, - "lastModifiedTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "The last time that the volume was updated in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" - } - } - }, - "traits": { - "smithy.api#documentation": "\nThe structure that contains the metadata of the volume.\n
" - } - }, - "com.amazonaws.finspace#KxVolumeArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 20, - "max": 2048 - }, - "smithy.api#pattern": "^arn:aws:finspace:[A-Za-z0-9_/.-]{0,63}:\\d+:kxEnvironment/[0-9A-Za-z_-]{1,128}(/kxSharedVolume/[a-zA-Z0-9_-]{1,255})?$" - } - }, - "com.amazonaws.finspace#KxVolumeName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 3, - "max": 63 - }, - "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_]*[a-zA-Z0-9]$" - } - }, - "com.amazonaws.finspace#KxVolumeStatus": { - "type": "enum", - "members": { - "CREATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATING" - } - }, - "CREATE_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATE_FAILED" - } - }, - "ACTIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACTIVE" - } - }, - "UPDATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UPDATING" - } - }, - "UPDATED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UPDATED" - } - }, - "UPDATE_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UPDATE_FAILED" - } - }, - "DELETING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETING" - } - }, - "DELETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETED" - } - }, - "DELETE_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETE_FAILED" - } - } - } - }, - "com.amazonaws.finspace#KxVolumeStatusReason": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 250 - }, - "smithy.api#pattern": "^[a-zA-Z0-9\\_\\-\\.\\s]+$" - } - }, - "com.amazonaws.finspace#KxVolumeType": { - "type": "enum", - "members": { - "NAS_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NAS_1" - } - } - } - }, - "com.amazonaws.finspace#KxVolumes": { - "type": "list", - "member": { - "target": "com.amazonaws.finspace#KxVolume" - } - }, - "com.amazonaws.finspace#LimitExceededException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.finspace#ErrorMessage2" - } - }, - "traits": { - "smithy.api#documentation": "A service limit or quota is exceeded.
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.finspace#ListEnvironments": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#ListEnvironmentsRequest" - }, - "output": { - "target": "com.amazonaws.finspace#ListEnvironmentsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#ValidationException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "This method will be discontinued." - }, - "smithy.api#documentation": "A list of all of your FinSpace environments.
", - "smithy.api#http": { - "method": "GET", - "uri": "/environment", - "code": 200 - } - } - }, - "com.amazonaws.finspace#ListEnvironmentsRequest": { - "type": "structure", - "members": { - "nextToken": { - "target": "com.amazonaws.finspace#PaginationToken", - "traits": { - "smithy.api#documentation": "A token generated by FinSpace that specifies where to continue pagination if a previous\n request was truncated. To get the next set of pages, pass in the nextTokennextToken value from the\n response object of the previous page call.
The maximum number of results to return in this request.
", - "smithy.api#httpQuery": "maxResults" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspace#ListEnvironmentsResponse": { - "type": "structure", - "members": { - "environments": { - "target": "com.amazonaws.finspace#EnvironmentList", - "traits": { - "smithy.api#documentation": "A list of all of your FinSpace environments.
" - } - }, - "nextToken": { - "target": "com.amazonaws.finspace#PaginationToken", - "traits": { - "smithy.api#documentation": "A token that you can use in a subsequent call to retrieve the next set of\n results.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#ListKxChangesets": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#ListKxChangesetsRequest" - }, - "output": { - "target": "com.amazonaws.finspace#ListKxChangesetsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspace#ThrottlingException" - }, - { - "target": "com.amazonaws.finspace#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Returns a list of all the changesets for a database.
", - "smithy.api#http": { - "method": "GET", - "uri": "/kx/environments/{environmentId}/databases/{databaseName}/changesets", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults" - } - } - }, - "com.amazonaws.finspace#ListKxChangesetsRequest": { - "type": "structure", - "members": { - "environmentId": { - "target": "com.amazonaws.finspace#EnvironmentId", - "traits": { - "smithy.api#documentation": "A unique identifier for the kdb environment.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "databaseName": { - "target": "com.amazonaws.finspace#DatabaseName", - "traits": { - "smithy.api#documentation": "The name of the kdb database.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "nextToken": { - "target": "com.amazonaws.finspace#PaginationToken", - "traits": { - "smithy.api#documentation": "A token that indicates where a results page should begin.
", - "smithy.api#httpQuery": "nextToken" - } - }, - "maxResults": { - "target": "com.amazonaws.finspace#MaxResults", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The maximum number of results to return in this request.
", - "smithy.api#httpQuery": "maxResults" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspace#ListKxChangesetsResponse": { - "type": "structure", - "members": { - "kxChangesets": { - "target": "com.amazonaws.finspace#KxChangesets", - "traits": { - "smithy.api#documentation": "A list of changesets for a database.
" - } - }, - "nextToken": { - "target": "com.amazonaws.finspace#PaginationToken", - "traits": { - "smithy.api#documentation": "A token that indicates where a results page should begin.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#ListKxClusterNodes": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#ListKxClusterNodesRequest" - }, - "output": { - "target": "com.amazonaws.finspace#ListKxClusterNodesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#LimitExceededException" - }, - { - "target": "com.amazonaws.finspace#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspace#ThrottlingException" - }, - { - "target": "com.amazonaws.finspace#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Lists all the nodes in a kdb cluster.
", - "smithy.api#http": { - "method": "GET", - "uri": "/kx/environments/{environmentId}/clusters/{clusterName}/nodes", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults" - } - } - }, - "com.amazonaws.finspace#ListKxClusterNodesRequest": { - "type": "structure", - "members": { - "environmentId": { - "target": "com.amazonaws.finspace#KxEnvironmentId", - "traits": { - "smithy.api#documentation": "A unique identifier for the kdb environment.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "clusterName": { - "target": "com.amazonaws.finspace#KxClusterName", - "traits": { - "smithy.api#documentation": "A unique name for the cluster.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "nextToken": { - "target": "com.amazonaws.finspace#PaginationToken", - "traits": { - "smithy.api#documentation": "A token that indicates where a results page should begin.
", - "smithy.api#httpQuery": "nextToken" - } - }, - "maxResults": { - "target": "com.amazonaws.finspace#ResultLimit", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The maximum number of results to return in this request.
", - "smithy.api#httpQuery": "maxResults" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspace#ListKxClusterNodesResponse": { - "type": "structure", - "members": { - "nodes": { - "target": "com.amazonaws.finspace#KxNodeSummaries", - "traits": { - "smithy.api#documentation": "A list of nodes associated with the cluster.
" - } - }, - "nextToken": { - "target": "com.amazonaws.finspace#PaginationToken", - "traits": { - "smithy.api#documentation": "A token that indicates where a results page should begin.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#ListKxClusters": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#ListKxClustersRequest" - }, - "output": { - "target": "com.amazonaws.finspace#ListKxClustersResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspace#ConflictException" - }, - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#LimitExceededException" - }, - { - "target": "com.amazonaws.finspace#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspace#ThrottlingException" - }, - { - "target": "com.amazonaws.finspace#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Returns a list of clusters.
", - "smithy.api#http": { - "method": "GET", - "uri": "/kx/environments/{environmentId}/clusters", - "code": 200 - } - } - }, - "com.amazonaws.finspace#ListKxClustersRequest": { - "type": "structure", - "members": { - "environmentId": { - "target": "com.amazonaws.finspace#KxEnvironmentId", - "traits": { - "smithy.api#documentation": "A unique identifier for the kdb environment.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "clusterType": { - "target": "com.amazonaws.finspace#KxClusterType", - "traits": { - "smithy.api#documentation": "Specifies the type of KDB database that is being created. The following types are available:
\nHDB – A Historical Database. The data is only accessible with read-only permissions from one of the FinSpace managed kdb databases mounted to the cluster.
\nRDB – A Realtime Database. This type of database captures all the data from a ticker plant and stores it in memory until the end of day, after which it writes all of its data to a disk and reloads the HDB. This cluster type requires local storage for temporary storage of data during the savedown process. If you specify this field in your request, you must provide the savedownStorageConfiguration parameter.
GATEWAY – A gateway cluster allows you to access data across processes in kdb systems. It allows you to create your own routing logic using the initialization scripts and custom code. This type of cluster does not require a writable local storage.
\nGP – A general purpose cluster allows you to quickly iterate on code during development by granting greater access to system commands and enabling a fast reload of custom code. This cluster type can optionally mount databases including cache and savedown storage. For this cluster type, the node count is fixed at 1. It does not support autoscaling and supports only SINGLE AZ mode.
Tickerplant – A tickerplant cluster allows you to subscribe to feed handlers based on IAM permissions. It can publish to RDBs, other Tickerplants, and real-time subscribers (RTS). Tickerplants can persist messages to log, which is readable by any RDB environment. It supports only single-node that is only one kdb process.
\nThe maximum number of results to return in this request.
", - "smithy.api#httpQuery": "maxResults" - } - }, - "nextToken": { - "target": "com.amazonaws.finspace#PaginationToken", - "traits": { - "smithy.api#documentation": "A token that indicates where a results page should begin.
", - "smithy.api#httpQuery": "nextToken" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspace#ListKxClustersResponse": { - "type": "structure", - "members": { - "kxClusterSummaries": { - "target": "com.amazonaws.finspace#KxClusters", - "traits": { - "smithy.api#documentation": "Lists the cluster details.
" - } - }, - "nextToken": { - "target": "com.amazonaws.finspace#PaginationToken", - "traits": { - "smithy.api#documentation": "A token that indicates where a results page should begin.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#ListKxDatabases": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#ListKxDatabasesRequest" - }, - "output": { - "target": "com.amazonaws.finspace#ListKxDatabasesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspace#ThrottlingException" - }, - { - "target": "com.amazonaws.finspace#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Returns a list of all the databases in the kdb environment.
", - "smithy.api#http": { - "method": "GET", - "uri": "/kx/environments/{environmentId}/databases", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults" - } - } - }, - "com.amazonaws.finspace#ListKxDatabasesRequest": { - "type": "structure", - "members": { - "environmentId": { - "target": "com.amazonaws.finspace#EnvironmentId", - "traits": { - "smithy.api#documentation": "A unique identifier for the kdb environment.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "nextToken": { - "target": "com.amazonaws.finspace#PaginationToken", - "traits": { - "smithy.api#documentation": "A token that indicates where a results page should begin.
", - "smithy.api#httpQuery": "nextToken" - } - }, - "maxResults": { - "target": "com.amazonaws.finspace#MaxResults", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The maximum number of results to return in this request.
", - "smithy.api#httpQuery": "maxResults" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspace#ListKxDatabasesResponse": { - "type": "structure", - "members": { - "kxDatabases": { - "target": "com.amazonaws.finspace#KxDatabases", - "traits": { - "smithy.api#documentation": "A list of databases in the kdb environment.
" - } - }, - "nextToken": { - "target": "com.amazonaws.finspace#PaginationToken", - "traits": { - "smithy.api#documentation": "A token that indicates where a results page should begin.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#ListKxDataviews": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#ListKxDataviewsRequest" - }, - "output": { - "target": "com.amazonaws.finspace#ListKxDataviewsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspace#ThrottlingException" - }, - { - "target": "com.amazonaws.finspace#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "\nReturns a list of all the dataviews in the database.
", - "smithy.api#http": { - "method": "GET", - "uri": "/kx/environments/{environmentId}/databases/{databaseName}/dataviews", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults" - } - } - }, - "com.amazonaws.finspace#ListKxDataviewsRequest": { - "type": "structure", - "members": { - "environmentId": { - "target": "com.amazonaws.finspace#EnvironmentId", - "traits": { - "smithy.api#documentation": "A unique identifier for the kdb environment, for which you want to retrieve a list of dataviews.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "databaseName": { - "target": "com.amazonaws.finspace#DatabaseName", - "traits": { - "smithy.api#documentation": "\nThe name of the database where the dataviews were created.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "nextToken": { - "target": "com.amazonaws.finspace#PaginationToken", - "traits": { - "smithy.api#documentation": "\nA token that indicates where a results page should begin.\n
", - "smithy.api#httpQuery": "nextToken" - } - }, - "maxResults": { - "target": "com.amazonaws.finspace#MaxResults", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The maximum number of results to return in this request.
", - "smithy.api#httpQuery": "maxResults" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspace#ListKxDataviewsResponse": { - "type": "structure", - "members": { - "kxDataviews": { - "target": "com.amazonaws.finspace#KxDataviews", - "traits": { - "smithy.api#documentation": "\n The list of kdb dataviews that are currently active for the given database.\n
" - } - }, - "nextToken": { - "target": "com.amazonaws.finspace#PaginationToken", - "traits": { - "smithy.api#documentation": "\nA token that indicates where a results page should begin.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#ListKxEnvironments": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#ListKxEnvironmentsRequest" - }, - "output": { - "target": "com.amazonaws.finspace#ListKxEnvironmentsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Returns a list of kdb environments created in an account.
", - "smithy.api#http": { - "method": "GET", - "uri": "/kx/environments", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "environments", - "pageSize": "maxResults" - } - } - }, - "com.amazonaws.finspace#ListKxEnvironmentsRequest": { - "type": "structure", - "members": { - "nextToken": { - "target": "com.amazonaws.finspace#PaginationToken", - "traits": { - "smithy.api#documentation": "A token that indicates where a results page should begin.
", - "smithy.api#httpQuery": "nextToken" - } - }, - "maxResults": { - "target": "com.amazonaws.finspace#BoxedInteger", - "traits": { - "smithy.api#documentation": "The maximum number of results to return in this request.
", - "smithy.api#httpQuery": "maxResults" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspace#ListKxEnvironmentsResponse": { - "type": "structure", - "members": { - "environments": { - "target": "com.amazonaws.finspace#KxEnvironmentList", - "traits": { - "smithy.api#documentation": "A list of environments in an account.
" - } - }, - "nextToken": { - "target": "com.amazonaws.finspace#PaginationToken", - "traits": { - "smithy.api#documentation": "A token that indicates where a results page should begin.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#ListKxScalingGroups": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#ListKxScalingGroupsRequest" - }, - "output": { - "target": "com.amazonaws.finspace#ListKxScalingGroupsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspace#ConflictException" - }, - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#LimitExceededException" - }, - { - "target": "com.amazonaws.finspace#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspace#ThrottlingException" - }, - { - "target": "com.amazonaws.finspace#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "\nReturns a list of scaling groups in a kdb environment.
", - "smithy.api#http": { - "method": "GET", - "uri": "/kx/environments/{environmentId}/scalingGroups", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults" - } - } - }, - "com.amazonaws.finspace#ListKxScalingGroupsRequest": { - "type": "structure", - "members": { - "environmentId": { - "target": "com.amazonaws.finspace#KxEnvironmentId", - "traits": { - "smithy.api#documentation": "A unique identifier for the kdb environment, for which you want to retrieve a list of scaling groups.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "maxResults": { - "target": "com.amazonaws.finspace#MaxResults", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The maximum number of results to return in this request.
", - "smithy.api#httpQuery": "maxResults" - } - }, - "nextToken": { - "target": "com.amazonaws.finspace#PaginationToken", - "traits": { - "smithy.api#documentation": "\nA token that indicates where a results page should begin.
", - "smithy.api#httpQuery": "nextToken" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspace#ListKxScalingGroupsResponse": { - "type": "structure", - "members": { - "scalingGroups": { - "target": "com.amazonaws.finspace#KxScalingGroupList", - "traits": { - "smithy.api#documentation": "\nA list of scaling groups available in a kdb environment.
" - } - }, - "nextToken": { - "target": "com.amazonaws.finspace#PaginationToken", - "traits": { - "smithy.api#documentation": "\nA token that indicates where a results page should begin.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#ListKxUsers": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#ListKxUsersRequest" - }, - "output": { - "target": "com.amazonaws.finspace#ListKxUsersResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspace#ThrottlingException" - }, - { - "target": "com.amazonaws.finspace#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Lists all the users in a kdb environment.
", - "smithy.api#http": { - "method": "GET", - "uri": "/kx/environments/{environmentId}/users", - "code": 200 - } - } - }, - "com.amazonaws.finspace#ListKxUsersRequest": { - "type": "structure", - "members": { - "environmentId": { - "target": "com.amazonaws.finspace#IdType", - "traits": { - "smithy.api#documentation": "A unique identifier for the kdb environment.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "nextToken": { - "target": "com.amazonaws.finspace#PaginationToken", - "traits": { - "smithy.api#documentation": "A token that indicates where a results page should begin.
", - "smithy.api#httpQuery": "nextToken" - } - }, - "maxResults": { - "target": "com.amazonaws.finspace#ResultLimit", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The maximum number of results to return in this request.
", - "smithy.api#httpQuery": "maxResults" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspace#ListKxUsersResponse": { - "type": "structure", - "members": { - "users": { - "target": "com.amazonaws.finspace#KxUserList", - "traits": { - "smithy.api#documentation": "A list of users in a kdb environment.
" - } - }, - "nextToken": { - "target": "com.amazonaws.finspace#PaginationToken", - "traits": { - "smithy.api#documentation": "A token that indicates where a results page should begin.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#ListKxVolumes": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#ListKxVolumesRequest" - }, - "output": { - "target": "com.amazonaws.finspace#ListKxVolumesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspace#ConflictException" - }, - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#LimitExceededException" - }, - { - "target": "com.amazonaws.finspace#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspace#ThrottlingException" - }, - { - "target": "com.amazonaws.finspace#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "\nLists all the volumes in a kdb environment.\n
", - "smithy.api#http": { - "method": "GET", - "uri": "/kx/environments/{environmentId}/kxvolumes", - "code": 200 - } - } - }, - "com.amazonaws.finspace#ListKxVolumesRequest": { - "type": "structure", - "members": { - "environmentId": { - "target": "com.amazonaws.finspace#KxEnvironmentId", - "traits": { - "smithy.api#documentation": "A unique identifier for the kdb environment, whose clusters can attach to the volume.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "maxResults": { - "target": "com.amazonaws.finspace#MaxResults", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The maximum number of results to return in this request.
", - "smithy.api#httpQuery": "maxResults" - } - }, - "nextToken": { - "target": "com.amazonaws.finspace#PaginationToken", - "traits": { - "smithy.api#documentation": "A token that indicates where a results page should begin.
", - "smithy.api#httpQuery": "nextToken" - } - }, - "volumeType": { - "target": "com.amazonaws.finspace#KxVolumeType", - "traits": { - "smithy.api#documentation": "\n The type of file system volume. Currently, FinSpace only supports NAS_1 volume type.\n
\nA summary of volumes.\n
" - } - }, - "nextToken": { - "target": "com.amazonaws.finspace#PaginationToken", - "traits": { - "smithy.api#documentation": "A token that indicates where a results page should begin.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#ListTagsForResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#ListTagsForResourceRequest" - }, - "output": { - "target": "com.amazonaws.finspace#ListTagsForResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#InvalidRequestException" - }, - { - "target": "com.amazonaws.finspace#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "A list of all tags for a resource.
", - "smithy.api#http": { - "method": "GET", - "uri": "/tags/{resourceArn}", - "code": 200 - } - } - }, - "com.amazonaws.finspace#ListTagsForResourceRequest": { - "type": "structure", - "members": { - "resourceArn": { - "target": "com.amazonaws.finspace#FinSpaceTaggableArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name of the resource.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspace#ListTagsForResourceResponse": { - "type": "structure", - "members": { - "tags": { - "target": "com.amazonaws.finspace#TagMap", - "traits": { - "smithy.api#documentation": "A list of all tags for a resource.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#MaxResults": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.finspace#MemoryMib": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 6 - } - } - }, - "com.amazonaws.finspace#NameString": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - }, - "smithy.api#pattern": "^[a-zA-Z0-9]{1,50}$" - } - }, - "com.amazonaws.finspace#NetworkACLConfiguration": { - "type": "list", - "member": { - "target": "com.amazonaws.finspace#NetworkACLEntry" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.finspace#NetworkACLEntry": { - "type": "structure", - "members": { - "ruleNumber": { - "target": "com.amazonaws.finspace#RuleNumber", - "traits": { - "smithy.api#documentation": "\n The rule number for the entry. For example 100. All the network ACL entries are processed in ascending order by rule number.\n \n
", - "smithy.api#required": {} - } - }, - "protocol": { - "target": "com.amazonaws.finspace#Protocol", - "traits": { - "smithy.api#documentation": "\n The protocol number. A value of -1 means all the protocols.\n
", - "smithy.api#required": {} - } - }, - "ruleAction": { - "target": "com.amazonaws.finspace#RuleAction", - "traits": { - "smithy.api#documentation": "\n Indicates whether to allow or deny the traffic that matches the rule.\n
", - "smithy.api#required": {} - } - }, - "portRange": { - "target": "com.amazonaws.finspace#PortRange", - "traits": { - "smithy.api#documentation": "\n The range of ports the rule applies to.\n
" - } - }, - "icmpTypeCode": { - "target": "com.amazonaws.finspace#IcmpTypeCode", - "traits": { - "smithy.api#documentation": "\n Defines the ICMP protocol that consists of the ICMP type and code.\n
" - } - }, - "cidrBlock": { - "target": "com.amazonaws.finspace#ValidCIDRBlock", - "traits": { - "smithy.api#documentation": "\n The IPv4 network range to allow or deny, in CIDR notation. For example, 172.16.0.0/24. We modify the specified CIDR block to its canonical form. For example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.\n
\n The network access control list (ACL) is an optional layer of security for your VPC that acts as a firewall for controlling traffic in and out of one or more subnets. The entry is a set of numbered ingress and egress rules that determine whether a packet should be allowed in or out of a subnet associated with the ACL. We process the entries in the ACL according to the rule numbers, in ascending order.\n
" - } - }, - "com.amazonaws.finspace#NodeCount": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1 - } - } - }, - "com.amazonaws.finspace#NodeType": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 32 - }, - "smithy.api#pattern": "^[a-zA-Z0-9._]+$" - } - }, - "com.amazonaws.finspace#PaginationToken": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1000 - }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.finspace#Port": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 0, - "max": 65535 - } - } - }, - "com.amazonaws.finspace#PortRange": { - "type": "structure", - "members": { - "from": { - "target": "com.amazonaws.finspace#Port", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "\n The first port in the range.\n
", - "smithy.api#required": {} - } - }, - "to": { - "target": "com.amazonaws.finspace#Port", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "\n The last port in the range.\n
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "\n The range of ports the rule applies to.\n
" - } - }, - "com.amazonaws.finspace#Protocol": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 5 - }, - "smithy.api#pattern": "^-1|[0-9]+$" - } - }, - "com.amazonaws.finspace#ReleaseLabel": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 16 - }, - "smithy.api#pattern": "^[a-zA-Z0-9._-]+$" - } - }, - "com.amazonaws.finspace#ResourceAlreadyExistsException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.finspace#ErrorMessage2" - } - }, - "traits": { - "smithy.api#documentation": "The specified resource group already exists.
", - "smithy.api#error": "client", - "smithy.api#httpError": 409 - } - }, - "com.amazonaws.finspace#ResourceNotFoundException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.finspace#ErrorMessage2" - } - }, - "traits": { - "smithy.api#documentation": "One or more resources can't be found.
", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.finspace#ResultLimit": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.finspace#RoleArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 20, - "max": 2048 - }, - "smithy.api#pattern": "^arn:aws[a-z\\-]*:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$" - } - }, - "com.amazonaws.finspace#RuleAction": { - "type": "enum", - "members": { - "ALLOW": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "allow" - } - }, - "DENY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "deny" - } - } - } - }, - "com.amazonaws.finspace#RuleNumber": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 32766 - } - } - }, - "com.amazonaws.finspace#S3Bucket": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 3, - "max": 255 - }, - "smithy.api#pattern": "^[a-z0-9][a-z0-9\\.\\-]*[a-z0-9]$" - } - }, - "com.amazonaws.finspace#S3Key": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - }, - "smithy.api#pattern": "^[a-zA-Z0-9\\/\\!\\-_\\.\\*'\\(\\)]+$" - } - }, - "com.amazonaws.finspace#S3ObjectVersion": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1000 - } - } - }, - "com.amazonaws.finspace#S3Path": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 9, - "max": 1093 - }, - "smithy.api#pattern": "^s3:\\/\\/[a-z0-9][a-z0-9-.]{1,61}[a-z0-9]\\/([^\\/]+\\/)*[^\\/]*$" - } - }, - "com.amazonaws.finspace#SamlMetadataDocument": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1000, - "max": 10000000 - }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.finspace#SecurityGroupIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.finspace#SecurityGroupIdString" - } - }, - "com.amazonaws.finspace#SecurityGroupIdString": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - }, - "smithy.api#pattern": "^sg-([a-z0-9]{8}$|[a-z0-9]{17}$)$" - } - }, - "com.amazonaws.finspace#SegmentConfigurationDbPathList": { - "type": "list", - "member": { - "target": "com.amazonaws.finspace#DbPath" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 30 - } - } - }, - "com.amazonaws.finspace#ServiceQuotaExceededException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.finspace#ErrorMessage2" - } - }, - "traits": { - "smithy.api#documentation": "You have exceeded your service quota. To perform the requested action, \n remove some of the relevant resources, or use Service Quotas to request a service quota increase.
", - "smithy.api#error": "client", - "smithy.api#httpError": 402 - } - }, - "com.amazonaws.finspace#SignedKxConnectionString": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - }, - "smithy.api#pattern": "^(:|:tcps:\\/\\/)[a-zA-Z0-9-\\.\\_]+:\\d+:[a-zA-Z0-9-\\.\\_]+:\\S+$", - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.finspace#SmsDomainUrl": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1000 - }, - "smithy.api#pattern": "^[a-zA-Z-0-9-:\\/.]*$" - } - }, - "com.amazonaws.finspace#SubnetIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.finspace#SubnetIdString" - } - }, - "com.amazonaws.finspace#SubnetIdString": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - }, - "smithy.api#pattern": "^subnet-([a-z0-9]{8}$|[a-z0-9]{17}$)$" - } - }, - "com.amazonaws.finspace#SuperuserParameters": { - "type": "structure", - "members": { - "emailAddress": { - "target": "com.amazonaws.finspace#EmailId", - "traits": { - "smithy.api#documentation": "The email address of the superuser.
", - "smithy.api#required": {} - } - }, - "firstName": { - "target": "com.amazonaws.finspace#NameString", - "traits": { - "smithy.api#documentation": "The first name of the superuser.
", - "smithy.api#required": {} - } - }, - "lastName": { - "target": "com.amazonaws.finspace#NameString", - "traits": { - "smithy.api#documentation": "The last name of the superuser.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Configuration information for the superuser.
" - } - }, - "com.amazonaws.finspace#TagKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - }, - "smithy.api#pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$" - } - }, - "com.amazonaws.finspace#TagKeyList": { - "type": "list", - "member": { - "target": "com.amazonaws.finspace#TagKey" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.finspace#TagMap": { - "type": "map", - "key": { - "target": "com.amazonaws.finspace#TagKey" - }, - "value": { - "target": "com.amazonaws.finspace#TagValue" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.finspace#TagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#TagResourceRequest" - }, - "output": { - "target": "com.amazonaws.finspace#TagResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#InvalidRequestException" - }, - { - "target": "com.amazonaws.finspace#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "Adds metadata tags to a FinSpace resource.
", - "smithy.api#http": { - "method": "POST", - "uri": "/tags/{resourceArn}", - "code": 200 - } - } - }, - "com.amazonaws.finspace#TagResourceRequest": { - "type": "structure", - "members": { - "resourceArn": { - "target": "com.amazonaws.finspace#FinSpaceTaggableArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) for the resource.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.finspace#TagMap", - "traits": { - "smithy.api#documentation": "One or more tags to be assigned to the resource.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspace#TagResourceResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#TagValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - }, - "smithy.api#pattern": "^[a-zA-Z0-9+-=._:@ ]+$" - } - }, - "com.amazonaws.finspace#ThrottlingException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.finspace#ErrorMessage2" - } - }, - "traits": { - "smithy.api#documentation": "The request was denied due to request throttling.
", - "smithy.api#error": "client", - "smithy.api#httpError": 429 - } - }, - "com.amazonaws.finspace#TickerplantLogConfiguration": { - "type": "structure", - "members": { - "tickerplantLogVolumes": { - "target": "com.amazonaws.finspace#TickerplantLogVolumes", - "traits": { - "smithy.api#documentation": "\nThe name of the volumes for tickerplant logs.\n
" - } - } - }, - "traits": { - "smithy.api#documentation": "\nA configuration to store the Tickerplant logs. It consists of\na list of volumes that will be mounted to your cluster. For the cluster type Tickerplant, the location of the TP volume on the cluster will be available by using the global variable .aws.tp_log_path. \n
The identifier of the transit gateway created by the customer to connect outbound traffics from kdb network to your internal network.
", - "smithy.api#required": {} - } - }, - "routableCIDRSpace": { - "target": "com.amazonaws.finspace#ValidCIDRSpace", - "traits": { - "smithy.api#documentation": "The routing CIDR on behalf of kdb environment. It could be any \"/26 range in the 100.64.0.0 CIDR space. After providing, it will be added to the customer's transit gateway routing table so that the traffics could be routed to kdb network.
", - "smithy.api#required": {} - } - }, - "attachmentNetworkAclConfiguration": { - "target": "com.amazonaws.finspace#NetworkACLConfiguration", - "traits": { - "smithy.api#documentation": "\n The rules that define how you manage the outbound traffic from kdb network to your internal network.\n \n
" - } - } - }, - "traits": { - "smithy.api#documentation": "The structure of the transit gateway and network configuration that is used to connect the kdb environment to an internal network.
" - } - }, - "com.amazonaws.finspace#TransitGatewayID": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 32 - } - } - }, - "com.amazonaws.finspace#UntagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#UntagResourceRequest" - }, - "output": { - "target": "com.amazonaws.finspace#UntagResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#InvalidRequestException" - }, - { - "target": "com.amazonaws.finspace#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "Removes metadata tags from a FinSpace resource.
", - "smithy.api#http": { - "method": "DELETE", - "uri": "/tags/{resourceArn}", - "code": 200 - } - } - }, - "com.amazonaws.finspace#UntagResourceRequest": { - "type": "structure", - "members": { - "resourceArn": { - "target": "com.amazonaws.finspace#FinSpaceTaggableArn", - "traits": { - "smithy.api#documentation": "A FinSpace resource from which you want to remove a tag or tags. The value for this\n parameter is an Amazon Resource Name (ARN).
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "tagKeys": { - "target": "com.amazonaws.finspace#TagKeyList", - "traits": { - "smithy.api#documentation": "The tag keys (names) of one or more tags to be removed.
", - "smithy.api#httpQuery": "tagKeys", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspace#UntagResourceResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#UpdateEnvironment": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#UpdateEnvironmentRequest" - }, - "output": { - "target": "com.amazonaws.finspace#UpdateEnvironmentResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspace#ThrottlingException" - }, - { - "target": "com.amazonaws.finspace#ValidationException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "This method will be discontinued." - }, - "smithy.api#documentation": "Update your FinSpace environment.
", - "smithy.api#http": { - "method": "PUT", - "uri": "/environment/{environmentId}", - "code": 200 - } - } - }, - "com.amazonaws.finspace#UpdateEnvironmentRequest": { - "type": "structure", - "members": { - "environmentId": { - "target": "com.amazonaws.finspace#IdType", - "traits": { - "smithy.api#documentation": "The identifier of the FinSpace environment.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "name": { - "target": "com.amazonaws.finspace#EnvironmentName", - "traits": { - "smithy.api#documentation": "The name of the environment.
" - } - }, - "description": { - "target": "com.amazonaws.finspace#Description", - "traits": { - "smithy.api#documentation": "The description of the environment.
" - } - }, - "federationMode": { - "target": "com.amazonaws.finspace#FederationMode", - "traits": { - "smithy.api#documentation": "Authentication mode for the environment.
\n\n FEDERATED - Users access FinSpace through Single Sign On (SSO) via your Identity provider.
\n LOCAL - Users access FinSpace via email and password managed within the FinSpace environment.
Returns the FinSpace environment object.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#UpdateKxClusterCodeConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#UpdateKxClusterCodeConfigurationRequest" - }, - "output": { - "target": "com.amazonaws.finspace#UpdateKxClusterCodeConfigurationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspace#ConflictException" - }, - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#LimitExceededException" - }, - { - "target": "com.amazonaws.finspace#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspace#ThrottlingException" - }, - { - "target": "com.amazonaws.finspace#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "\n Allows you to update code configuration on a running cluster. By using this API you can update the code, the initialization script path, and the command line arguments for a specific cluster. \n The configuration that you want to update will override any existing configurations on the cluster. \n
", - "smithy.api#http": { - "method": "PUT", - "uri": "/kx/environments/{environmentId}/clusters/{clusterName}/configuration/code", - "code": 200 - } - } - }, - "com.amazonaws.finspace#UpdateKxClusterCodeConfigurationRequest": { - "type": "structure", - "members": { - "environmentId": { - "target": "com.amazonaws.finspace#KxEnvironmentId", - "traits": { - "smithy.api#documentation": "\n A unique identifier of the kdb environment.\n
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "clusterName": { - "target": "com.amazonaws.finspace#KxClusterName", - "traits": { - "smithy.api#documentation": "The name of the cluster.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "clientToken": { - "target": "com.amazonaws.finspace#ClientTokenString", - "traits": { - "smithy.api#documentation": "A token that ensures idempotency. This token expires in 10 minutes.
", - "smithy.api#idempotencyToken": {} - } - }, - "code": { - "target": "com.amazonaws.finspace#CodeConfiguration", - "traits": { - "smithy.api#required": {} - } - }, - "initializationScript": { - "target": "com.amazonaws.finspace#InitializationScriptFilePath", - "traits": { - "smithy.api#documentation": "Specifies a Q program that will be run at launch of a cluster. It is a relative path within\n .zip file that contains the custom code, which will be loaded on\n the cluster. It must include the file name itself. For example,\n somedir/init.q.
You cannot update this parameter for a NO_RESTART deployment.
Specifies the key-value pairs to make them available inside the cluster.
\nYou cannot update this parameter for a NO_RESTART deployment.
\n The configuration that allows you to choose how you want to update the code on a cluster.\n
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspace#UpdateKxClusterCodeConfigurationResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#UpdateKxClusterDatabases": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#UpdateKxClusterDatabasesRequest" - }, - "output": { - "target": "com.amazonaws.finspace#UpdateKxClusterDatabasesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspace#ConflictException" - }, - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#LimitExceededException" - }, - { - "target": "com.amazonaws.finspace#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspace#ThrottlingException" - }, - { - "target": "com.amazonaws.finspace#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Updates the databases mounted on a kdb cluster, which includes the changesetId and all the dbPaths to be cached. This API does not allow you to change a database name or add a database if you created a cluster without one.
Using this API you can point a cluster to a different changeset and modify a list of partitions being cached.
", - "smithy.api#http": { - "method": "PUT", - "uri": "/kx/environments/{environmentId}/clusters/{clusterName}/configuration/databases", - "code": 200 - } - } - }, - "com.amazonaws.finspace#UpdateKxClusterDatabasesRequest": { - "type": "structure", - "members": { - "environmentId": { - "target": "com.amazonaws.finspace#KxEnvironmentId", - "traits": { - "smithy.api#documentation": "The unique identifier of a kdb environment.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "clusterName": { - "target": "com.amazonaws.finspace#KxClusterName", - "traits": { - "smithy.api#documentation": "A unique name for the cluster that you want to modify.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "clientToken": { - "target": "com.amazonaws.finspace#ClientTokenString", - "traits": { - "smithy.api#documentation": "A token that ensures idempotency. This token expires in 10 minutes.
", - "smithy.api#idempotencyToken": {} - } - }, - "databases": { - "target": "com.amazonaws.finspace#KxDatabaseConfigurations", - "traits": { - "smithy.api#documentation": "The structure of databases mounted on the cluster.
", - "smithy.api#required": {} - } - }, - "deploymentConfiguration": { - "target": "com.amazonaws.finspace#KxDeploymentConfiguration", - "traits": { - "smithy.api#documentation": "\n The configuration that allows you to choose how you want to update the databases on a cluster.\n
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspace#UpdateKxClusterDatabasesResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#UpdateKxDatabase": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#UpdateKxDatabaseRequest" - }, - "output": { - "target": "com.amazonaws.finspace#UpdateKxDatabaseResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspace#ConflictException" - }, - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspace#ThrottlingException" - }, - { - "target": "com.amazonaws.finspace#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Updates information for the given kdb database.
", - "smithy.api#http": { - "method": "PUT", - "uri": "/kx/environments/{environmentId}/databases/{databaseName}", - "code": 200 - } - } - }, - "com.amazonaws.finspace#UpdateKxDatabaseRequest": { - "type": "structure", - "members": { - "environmentId": { - "target": "com.amazonaws.finspace#EnvironmentId", - "traits": { - "smithy.api#documentation": "A unique identifier for the kdb environment.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "databaseName": { - "target": "com.amazonaws.finspace#DatabaseName", - "traits": { - "smithy.api#documentation": "The name of the kdb database.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.finspace#Description", - "traits": { - "smithy.api#documentation": "A description of the database.
" - } - }, - "clientToken": { - "target": "com.amazonaws.finspace#ClientTokenString", - "traits": { - "smithy.api#documentation": "A token that ensures idempotency. This token expires in 10 minutes.
", - "smithy.api#idempotencyToken": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspace#UpdateKxDatabaseResponse": { - "type": "structure", - "members": { - "databaseName": { - "target": "com.amazonaws.finspace#DatabaseName", - "traits": { - "smithy.api#documentation": "The name of the kdb database.
" - } - }, - "environmentId": { - "target": "com.amazonaws.finspace#EnvironmentId", - "traits": { - "smithy.api#documentation": "A unique identifier for the kdb environment.
" - } - }, - "description": { - "target": "com.amazonaws.finspace#Description", - "traits": { - "smithy.api#documentation": "A description of the database.
" - } - }, - "lastModifiedTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "The last time that the database was modified. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#UpdateKxDataview": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#UpdateKxDataviewRequest" - }, - "output": { - "target": "com.amazonaws.finspace#UpdateKxDataviewResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspace#ConflictException" - }, - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#ResourceAlreadyExistsException" - }, - { - "target": "com.amazonaws.finspace#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspace#ThrottlingException" - }, - { - "target": "com.amazonaws.finspace#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "\nUpdates the specified dataview. The dataviews get automatically updated when any new changesets are ingested. Each update of the dataview creates a new version, including changeset details and cache configurations
", - "smithy.api#http": { - "method": "PUT", - "uri": "/kx/environments/{environmentId}/databases/{databaseName}/dataviews/{dataviewName}", - "code": 200 - } - } - }, - "com.amazonaws.finspace#UpdateKxDataviewRequest": { - "type": "structure", - "members": { - "environmentId": { - "target": "com.amazonaws.finspace#EnvironmentId", - "traits": { - "smithy.api#documentation": "A unique identifier for the kdb environment, where you want to update the dataview.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "databaseName": { - "target": "com.amazonaws.finspace#DatabaseName", - "traits": { - "smithy.api#documentation": "\nThe name of the database.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "dataviewName": { - "target": "com.amazonaws.finspace#KxDataviewName", - "traits": { - "smithy.api#documentation": "The name of the dataview that you want to update.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.finspace#Description", - "traits": { - "smithy.api#documentation": "\n The description for a dataview.\n
" - } - }, - "changesetId": { - "target": "com.amazonaws.finspace#ChangesetId", - "traits": { - "smithy.api#documentation": "A unique identifier for the changeset.
" - } - }, - "segmentConfigurations": { - "target": "com.amazonaws.finspace#KxDataviewSegmentConfigurationList", - "traits": { - "smithy.api#documentation": "\n The configuration that contains the database path of the data that you want to place on each selected volume. Each segment must have a unique database path for each volume. If you do not explicitly specify any database path for a volume, they are accessible from the cluster through the default S3/object store segment.
" - } - }, - "clientToken": { - "target": "com.amazonaws.finspace#ClientTokenString", - "traits": { - "smithy.api#documentation": "A token that ensures idempotency. This token expires in 10 minutes.
", - "smithy.api#idempotencyToken": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspace#UpdateKxDataviewResponse": { - "type": "structure", - "members": { - "environmentId": { - "target": "com.amazonaws.finspace#EnvironmentId", - "traits": { - "smithy.api#documentation": "A unique identifier for the kdb environment, where you want to update the dataview.
" - } - }, - "databaseName": { - "target": "com.amazonaws.finspace#DatabaseName", - "traits": { - "smithy.api#documentation": "\nThe name of the database.\n
" - } - }, - "dataviewName": { - "target": "com.amazonaws.finspace#KxDataviewName", - "traits": { - "smithy.api#documentation": "\n The name of the database under which the dataview was created.\n \n
" - } - }, - "azMode": { - "target": "com.amazonaws.finspace#KxAzMode", - "traits": { - "smithy.api#documentation": "The number of availability zones you want to assign per volume. Currently, FinSpace only supports SINGLE for volumes. This places dataview in a single AZ.
\n The identifier of the availability zones.\n
" - } - }, - "changesetId": { - "target": "com.amazonaws.finspace#ChangesetId", - "traits": { - "smithy.api#documentation": "A unique identifier for the changeset.
" - } - }, - "segmentConfigurations": { - "target": "com.amazonaws.finspace#KxDataviewSegmentConfigurationList", - "traits": { - "smithy.api#documentation": "\n The configuration that contains the database path of the data that you want to place on each selected volume. Each segment must have a unique database path for each volume. If you do not explicitly specify any database path for a volume, they are accessible from the cluster through the default S3/object store segment.
" - } - }, - "activeVersions": { - "target": "com.amazonaws.finspace#KxDataviewActiveVersionList", - "traits": { - "smithy.api#documentation": "\n The current active changeset versions of the database on the given dataview. \n \n
" - } - }, - "status": { - "target": "com.amazonaws.finspace#KxDataviewStatus", - "traits": { - "smithy.api#documentation": "\n The status of dataview creation.
\n\n CREATING – The dataview creation is in progress.
\n UPDATING – The dataview is in the process of being updated.
\n ACTIVE – The dataview is active.
The option to specify whether you want to apply all the future additions and corrections automatically to the dataview when new changesets are ingested. The default value is false.
" - } - }, - "readWrite": { - "target": "com.amazonaws.finspace#booleanValue", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "Returns True if the dataview is created as writeable and False otherwise.
" - } - }, - "description": { - "target": "com.amazonaws.finspace#Description", - "traits": { - "smithy.api#documentation": "A description of the dataview.
" - } - }, - "createdTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "\n The timestamp at which the dataview was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.\n
" - } - }, - "lastModifiedTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "\n The last time that the dataview was updated in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.\n
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#UpdateKxEnvironment": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#UpdateKxEnvironmentRequest" - }, - "output": { - "target": "com.amazonaws.finspace#UpdateKxEnvironmentResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspace#ConflictException" - }, - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspace#ThrottlingException" - }, - { - "target": "com.amazonaws.finspace#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Updates information for the given kdb environment.
", - "smithy.api#http": { - "method": "PUT", - "uri": "/kx/environments/{environmentId}", - "code": 200 - } - } - }, - "com.amazonaws.finspace#UpdateKxEnvironmentNetwork": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#UpdateKxEnvironmentNetworkRequest" - }, - "output": { - "target": "com.amazonaws.finspace#UpdateKxEnvironmentNetworkResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspace#ConflictException" - }, - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspace#ThrottlingException" - }, - { - "target": "com.amazonaws.finspace#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Updates environment network to connect to your internal network by using a transit gateway. This API supports request to create a transit gateway attachment from FinSpace VPC to your transit gateway ID and create a custom Route-53 outbound resolvers.
\nOnce you send a request to update a network, you cannot change it again. Network update might require termination of any clusters that are running in the existing network.
", - "smithy.api#http": { - "method": "PUT", - "uri": "/kx/environments/{environmentId}/network", - "code": 200 - } - } - }, - "com.amazonaws.finspace#UpdateKxEnvironmentNetworkRequest": { - "type": "structure", - "members": { - "environmentId": { - "target": "com.amazonaws.finspace#IdType", - "traits": { - "smithy.api#documentation": "A unique identifier for the kdb environment.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "transitGatewayConfiguration": { - "target": "com.amazonaws.finspace#TransitGatewayConfiguration", - "traits": { - "smithy.api#documentation": "Specifies the transit gateway and network configuration to connect the kdb environment to an internal network.
" - } - }, - "customDNSConfiguration": { - "target": "com.amazonaws.finspace#CustomDNSConfiguration", - "traits": { - "smithy.api#documentation": "A list of DNS server name and server IP. This is used to set up Route-53 outbound resolvers.
" - } - }, - "clientToken": { - "target": "com.amazonaws.finspace#ClientToken", - "traits": { - "smithy.api#documentation": "A token that ensures idempotency. This token expires in 10 minutes.
", - "smithy.api#idempotencyToken": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspace#UpdateKxEnvironmentNetworkResponse": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.finspace#KxEnvironmentName", - "traits": { - "smithy.api#documentation": "The name of the kdb environment.
" - } - }, - "environmentId": { - "target": "com.amazonaws.finspace#IdType", - "traits": { - "smithy.api#documentation": "A unique identifier for the kdb environment.
" - } - }, - "awsAccountId": { - "target": "com.amazonaws.finspace#IdType", - "traits": { - "smithy.api#documentation": "The unique identifier of the AWS account that is used to create the kdb environment.
" - } - }, - "status": { - "target": "com.amazonaws.finspace#EnvironmentStatus", - "traits": { - "smithy.api#documentation": "The status of the kdb environment.
" - } - }, - "tgwStatus": { - "target": "com.amazonaws.finspace#tgwStatus", - "traits": { - "smithy.api#documentation": "The status of the network configuration.
" - } - }, - "dnsStatus": { - "target": "com.amazonaws.finspace#dnsStatus", - "traits": { - "smithy.api#documentation": "The status of DNS configuration.
" - } - }, - "errorMessage": { - "target": "com.amazonaws.finspace#EnvironmentErrorMessage", - "traits": { - "smithy.api#documentation": "Specifies the error message that appears if a flow fails.
" - } - }, - "description": { - "target": "com.amazonaws.finspace#Description", - "traits": { - "smithy.api#documentation": "The description of the environment.
" - } - }, - "environmentArn": { - "target": "com.amazonaws.finspace#EnvironmentArn", - "traits": { - "smithy.api#documentation": "The ARN identifier of the environment.
" - } - }, - "kmsKeyId": { - "target": "com.amazonaws.finspace#KmsKeyId", - "traits": { - "smithy.api#documentation": "The KMS key ID to encrypt your data in the FinSpace environment.
" - } - }, - "dedicatedServiceAccountId": { - "target": "com.amazonaws.finspace#IdType", - "traits": { - "smithy.api#documentation": "A unique identifier for the AWS environment infrastructure account.
" - } - }, - "transitGatewayConfiguration": { - "target": "com.amazonaws.finspace#TransitGatewayConfiguration" - }, - "customDNSConfiguration": { - "target": "com.amazonaws.finspace#CustomDNSConfiguration", - "traits": { - "smithy.api#documentation": "A list of DNS server name and server IP. This is used to set up Route-53 outbound resolvers.
" - } - }, - "creationTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "The timestamp at which the kdb environment was created in FinSpace.
" - } - }, - "updateTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "The timestamp at which the kdb environment was updated.
" - } - }, - "availabilityZoneIds": { - "target": "com.amazonaws.finspace#AvailabilityZoneIds", - "traits": { - "smithy.api#documentation": "The identifier of the availability zones where subnets for the environment are created.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#UpdateKxEnvironmentRequest": { - "type": "structure", - "members": { - "environmentId": { - "target": "com.amazonaws.finspace#IdType", - "traits": { - "smithy.api#documentation": "A unique identifier for the kdb environment.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "name": { - "target": "com.amazonaws.finspace#KxEnvironmentName", - "traits": { - "smithy.api#documentation": "The name of the kdb environment.
" - } - }, - "description": { - "target": "com.amazonaws.finspace#Description", - "traits": { - "smithy.api#documentation": "A description of the kdb environment.
" - } - }, - "clientToken": { - "target": "com.amazonaws.finspace#ClientToken", - "traits": { - "smithy.api#documentation": "A token that ensures idempotency. This token expires in 10 minutes.
", - "smithy.api#idempotencyToken": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspace#UpdateKxEnvironmentResponse": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.finspace#KxEnvironmentName", - "traits": { - "smithy.api#documentation": "The name of the kdb environment.
" - } - }, - "environmentId": { - "target": "com.amazonaws.finspace#IdType", - "traits": { - "smithy.api#documentation": "A unique identifier for the kdb environment.
" - } - }, - "awsAccountId": { - "target": "com.amazonaws.finspace#IdType", - "traits": { - "smithy.api#documentation": "The unique identifier of the AWS account that is used to create the kdb environment.
" - } - }, - "status": { - "target": "com.amazonaws.finspace#EnvironmentStatus", - "traits": { - "smithy.api#documentation": "The status of the kdb environment.
" - } - }, - "tgwStatus": { - "target": "com.amazonaws.finspace#tgwStatus", - "traits": { - "smithy.api#documentation": "The status of the network configuration.
" - } - }, - "dnsStatus": { - "target": "com.amazonaws.finspace#dnsStatus", - "traits": { - "smithy.api#documentation": "The status of DNS configuration.
" - } - }, - "errorMessage": { - "target": "com.amazonaws.finspace#EnvironmentErrorMessage", - "traits": { - "smithy.api#documentation": "Specifies the error message that appears if a flow fails.
" - } - }, - "description": { - "target": "com.amazonaws.finspace#Description", - "traits": { - "smithy.api#documentation": "The description of the environment.
" - } - }, - "environmentArn": { - "target": "com.amazonaws.finspace#EnvironmentArn", - "traits": { - "smithy.api#documentation": "The ARN identifier of the environment.
" - } - }, - "kmsKeyId": { - "target": "com.amazonaws.finspace#KmsKeyId", - "traits": { - "smithy.api#documentation": "The KMS key ID to encrypt your data in the FinSpace environment.
" - } - }, - "dedicatedServiceAccountId": { - "target": "com.amazonaws.finspace#IdType", - "traits": { - "smithy.api#documentation": "A unique identifier for the AWS environment infrastructure account.
" - } - }, - "transitGatewayConfiguration": { - "target": "com.amazonaws.finspace#TransitGatewayConfiguration" - }, - "customDNSConfiguration": { - "target": "com.amazonaws.finspace#CustomDNSConfiguration", - "traits": { - "smithy.api#documentation": "A list of DNS server name and server IP. This is used to set up Route-53 outbound resolvers.
" - } - }, - "creationTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "The timestamp at which the kdb environment was created in FinSpace.
" - } - }, - "updateTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "The timestamp at which the kdb environment was updated.
" - } - }, - "availabilityZoneIds": { - "target": "com.amazonaws.finspace#AvailabilityZoneIds", - "traits": { - "smithy.api#documentation": "The identifier of the availability zones where subnets for the environment are created.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#UpdateKxUser": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#UpdateKxUserRequest" - }, - "output": { - "target": "com.amazonaws.finspace#UpdateKxUserResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspace#ConflictException" - }, - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#LimitExceededException" - }, - { - "target": "com.amazonaws.finspace#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspace#ThrottlingException" - }, - { - "target": "com.amazonaws.finspace#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Updates the user details. You can only update the IAM role associated with a user.
", - "smithy.api#http": { - "method": "PUT", - "uri": "/kx/environments/{environmentId}/users/{userName}", - "code": 200 - } - } - }, - "com.amazonaws.finspace#UpdateKxUserRequest": { - "type": "structure", - "members": { - "environmentId": { - "target": "com.amazonaws.finspace#IdType", - "traits": { - "smithy.api#documentation": "A unique identifier for the kdb environment.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "userName": { - "target": "com.amazonaws.finspace#KxUserNameString", - "traits": { - "smithy.api#documentation": "A unique identifier for the user.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "iamRole": { - "target": "com.amazonaws.finspace#RoleArn", - "traits": { - "smithy.api#documentation": "The IAM role ARN that is associated with the user.
", - "smithy.api#required": {} - } - }, - "clientToken": { - "target": "com.amazonaws.finspace#ClientToken", - "traits": { - "smithy.api#documentation": "A token that ensures idempotency. This token expires in 10 minutes.
", - "smithy.api#idempotencyToken": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspace#UpdateKxUserResponse": { - "type": "structure", - "members": { - "userName": { - "target": "com.amazonaws.finspace#KxUserNameString", - "traits": { - "smithy.api#documentation": "A unique identifier for the user.
" - } - }, - "userArn": { - "target": "com.amazonaws.finspace#KxUserArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies the user. For more information about ARNs and\n how to use ARNs in policies, see IAM Identifiers in the\n IAM User Guide.
" - } - }, - "environmentId": { - "target": "com.amazonaws.finspace#IdType", - "traits": { - "smithy.api#documentation": "A unique identifier for the kdb environment.
" - } - }, - "iamRole": { - "target": "com.amazonaws.finspace#RoleArn", - "traits": { - "smithy.api#documentation": "The IAM role ARN that is associated with the user.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#UpdateKxVolume": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#UpdateKxVolumeRequest" - }, - "output": { - "target": "com.amazonaws.finspace#UpdateKxVolumeResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspace#ConflictException" - }, - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#LimitExceededException" - }, - { - "target": "com.amazonaws.finspace#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspace#ThrottlingException" - }, - { - "target": "com.amazonaws.finspace#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "\nUpdates the throughput or capacity of a volume. During the update process, the filesystem \nmight be unavailable for a few minutes. You can retry any operations after the update is complete.\n
", - "smithy.api#http": { - "method": "PATCH", - "uri": "/kx/environments/{environmentId}/kxvolumes/{volumeName}", - "code": 200 - } - } - }, - "com.amazonaws.finspace#UpdateKxVolumeRequest": { - "type": "structure", - "members": { - "environmentId": { - "target": "com.amazonaws.finspace#KxEnvironmentId", - "traits": { - "smithy.api#documentation": "A unique identifier for the kdb environment where you created the storage volume.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "volumeName": { - "target": "com.amazonaws.finspace#KxVolumeName", - "traits": { - "smithy.api#documentation": "\nA unique identifier for the volume.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.finspace#Description", - "traits": { - "smithy.api#documentation": "\nA description of the volume.\n
" - } - }, - "clientToken": { - "target": "com.amazonaws.finspace#ClientTokenString", - "traits": { - "smithy.api#documentation": "A token that ensures idempotency. This token expires in 10 minutes.
", - "smithy.api#idempotencyToken": {} - } - }, - "nas1Configuration": { - "target": "com.amazonaws.finspace#KxNAS1Configuration", - "traits": { - "smithy.api#documentation": "Specifies the configuration for the Network attached storage (NAS_1) file system volume.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspace#UpdateKxVolumeResponse": { - "type": "structure", - "members": { - "environmentId": { - "target": "com.amazonaws.finspace#KxEnvironmentId", - "traits": { - "smithy.api#documentation": "A unique identifier for the kdb environment where you want to update the volume.
" - } - }, - "volumeName": { - "target": "com.amazonaws.finspace#KxVolumeName", - "traits": { - "smithy.api#documentation": "A unique identifier for the volume that you want to update.
" - } - }, - "volumeType": { - "target": "com.amazonaws.finspace#KxVolumeType", - "traits": { - "smithy.api#documentation": "\n The type of file system volume. Currently, FinSpace only supports NAS_1 volume type.\n
\nThe ARN identifier of the volume.\n
" - } - }, - "nas1Configuration": { - "target": "com.amazonaws.finspace#KxNAS1Configuration", - "traits": { - "smithy.api#documentation": "Specifies the configuration for the Network attached storage (NAS_1) file system volume.
" - } - }, - "status": { - "target": "com.amazonaws.finspace#KxVolumeStatus", - "traits": { - "smithy.api#documentation": "The status of the volume.
\nCREATING – The volume creation is in progress.
\nCREATE_FAILED – The volume creation has failed.
\nACTIVE – The volume is active.
\nUPDATING – The volume is in the process of being updated.
\nUPDATE_FAILED – The update action failed.
\nUPDATED – The volume is successfully updated.
\nDELETING – The volume is in the process of being deleted.
\nDELETE_FAILED – The system failed to delete the volume.
\nDELETED – The volume is successfully deleted.
\n\nThe description for the volume.\n
" - } - }, - "statusReason": { - "target": "com.amazonaws.finspace#KxVolumeStatusReason", - "traits": { - "smithy.api#documentation": "The error message when a failed state occurs.
" - } - }, - "createdTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "\nThe timestamp at which the volume was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" - } - }, - "azMode": { - "target": "com.amazonaws.finspace#KxAzMode", - "traits": { - "smithy.api#documentation": "The number of availability zones you want to assign per volume. Currently, FinSpace only supports SINGLE for volumes. This places dataview in a single AZ.
The identifier of the availability zones.
" - } - }, - "lastModifiedTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "The last time that the volume was updated in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" - } - }, - "attachedClusters": { - "target": "com.amazonaws.finspace#KxAttachedClusters", - "traits": { - "smithy.api#documentation": "\nSpecifies the clusters that a volume is attached to.\n
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#ValidCIDRBlock": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 18 - }, - "smithy.api#pattern": "^(?:\\d{1,3}\\.){3}\\d{1,3}(?:\\/(?:3[0-2]|[12]\\d|\\d))$" - } - }, - "com.amazonaws.finspace#ValidCIDRSpace": { - "type": "string" - }, - "com.amazonaws.finspace#ValidHostname": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 3, - "max": 255 - }, - "smithy.api#pattern": "^([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]{0,61}[a-zA-Z0-9])(\\.([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]{0,61}[a-zA-Z0-9]))*$" - } - }, - "com.amazonaws.finspace#ValidIPAddress": { - "type": "string", - "traits": { - "smithy.api#pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$" - } - }, - "com.amazonaws.finspace#ValidationException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.finspace#ErrorMessage2" - } - }, - "traits": { - "smithy.api#documentation": "The input fails to satisfy the constraints specified by an AWS service.
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.finspace#VersionId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 26 - } - } - }, - "com.amazonaws.finspace#Volume": { - "type": "structure", - "members": { - "volumeName": { - "target": "com.amazonaws.finspace#VolumeName", - "traits": { - "smithy.api#documentation": "A unique identifier for the volume.
" - } - }, - "volumeType": { - "target": "com.amazonaws.finspace#VolumeType", - "traits": { - "smithy.api#documentation": "\n The type of file system volume. Currently, FinSpace only supports NAS_1 volume type.\n
\nThe structure that consists of name and type of volume.
" - } - }, - "com.amazonaws.finspace#VolumeName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 3, - "max": 63 - }, - "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_]*[a-zA-Z0-9]$" - } - }, - "com.amazonaws.finspace#VolumeType": { - "type": "enum", - "members": { - "NAS_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NAS_1" - } - } - } - }, - "com.amazonaws.finspace#Volumes": { - "type": "list", - "member": { - "target": "com.amazonaws.finspace#Volume" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 5 - } - } - }, - "com.amazonaws.finspace#VpcConfiguration": { - "type": "structure", - "members": { - "vpcId": { - "target": "com.amazonaws.finspace#VpcIdString", - "traits": { - "smithy.api#documentation": "The identifier of the VPC endpoint.
" - } - }, - "securityGroupIds": { - "target": "com.amazonaws.finspace#SecurityGroupIdList", - "traits": { - "smithy.api#documentation": "The unique identifier of the VPC security group applied to the VPC endpoint ENI for the cluster.
" - } - }, - "subnetIds": { - "target": "com.amazonaws.finspace#SubnetIdList", - "traits": { - "smithy.api#documentation": "The identifier of the subnet that the Privatelink VPC endpoint uses to connect to the cluster.
" - } - }, - "ipAddressType": { - "target": "com.amazonaws.finspace#IPAddressType", - "traits": { - "smithy.api#documentation": "The IP address type for cluster network configuration parameters. The following type is available:
\nIP_V4 – IP address version 4
\nConfiguration details about the network where the Privatelink endpoint of the cluster resides.
" - } - }, - "com.amazonaws.finspace#VpcIdString": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - }, - "smithy.api#pattern": "^vpc-([a-z0-9]{8}$|[a-z0-9]{17}$)$" - } - }, - "com.amazonaws.finspace#arn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 20, - "max": 2048 - }, - "smithy.api#pattern": "^arn:*:*:*:*:*$" - } - }, - "com.amazonaws.finspace#booleanValue": { - "type": "boolean", - "traits": { - "smithy.api#default": false - } - }, - "com.amazonaws.finspace#dnsStatus": { - "type": "enum", - "members": { - "NONE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NONE" - } - }, - "UPDATE_REQUESTED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UPDATE_REQUESTED" - } - }, - "UPDATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UPDATING" - } - }, - "FAILED_UPDATE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED_UPDATE" - } - }, - "SUCCESSFULLY_UPDATED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SUCCESSFULLY_UPDATED" - } - } - } - }, - "com.amazonaws.finspace#numBytes": { - "type": "long", - "traits": { - "smithy.api#default": 0 - } - }, - "com.amazonaws.finspace#numChangesets": { - "type": "integer", - "traits": { - "smithy.api#default": 0 - } - }, - "com.amazonaws.finspace#numFiles": { - "type": "integer", - "traits": { - "smithy.api#default": 0 - } - }, - "com.amazonaws.finspace#stringValueLength1to255": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - } - } - }, - "com.amazonaws.finspace#tgwStatus": { - "type": "enum", - "members": { - "NONE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NONE" - } - }, - "UPDATE_REQUESTED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UPDATE_REQUESTED" - } - }, - "UPDATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UPDATING" - } - }, - "FAILED_UPDATE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED_UPDATE" - } - }, - "SUCCESSFULLY_UPDATED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SUCCESSFULLY_UPDATED" - } } - } - }, - "com.amazonaws.finspace#url": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1000 - }, - "smithy.api#pattern": "^https?://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]$" - } - }, - "com.amazonaws.finspace#urn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - }, - "smithy.api#pattern": "^[A-Za-z0-9._\\-:\\/#\\+]+$" - } } - } } diff --git a/codegen/sdk-codegen/aws-models/fis.json b/codegen/sdk-codegen/aws-models/fis.json index 8f4752e35791..ec0e5a5c1f93 100644 --- a/codegen/sdk-codegen/aws-models/fis.json +++ b/codegen/sdk-codegen/aws-models/fis.json @@ -1,5090 +1,5340 @@ { - "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.fis#AccountTargeting": { - "type": "enum", - "members": { - "SINGLE_ACCOUNT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "single-account" - } - }, - "MULTI_ACCOUNT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "multi-account" - } - } - } - }, - "com.amazonaws.fis#Action": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.fis#ActionId", - "traits": { - "smithy.api#documentation": "The ID of the action.
" - } - }, - "arn": { - "target": "com.amazonaws.fis#ResourceArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the action.
" - } - }, - "description": { - "target": "com.amazonaws.fis#ActionDescription", - "traits": { - "smithy.api#documentation": "The description for the action.
" - } - }, - "parameters": { - "target": "com.amazonaws.fis#ActionParameterMap", - "traits": { - "smithy.api#documentation": "The action parameters, if applicable.
" - } - }, - "targets": { - "target": "com.amazonaws.fis#ActionTargetMap", - "traits": { - "smithy.api#documentation": "The supported targets for the action.
" - } - }, - "tags": { - "target": "com.amazonaws.fis#TagMap", - "traits": { - "smithy.api#documentation": "The tags for the action.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Describes an action. For more information, see FIS actions \n in the Fault Injection Service User Guide.
" - } - }, - "com.amazonaws.fis#ActionDescription": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 512 - }, - "smithy.api#pattern": "^[\\s\\S]+$" - } - }, - "com.amazonaws.fis#ActionId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 128 - }, - "smithy.api#pattern": "^[\\S]+$" - } - }, - "com.amazonaws.fis#ActionParameter": { - "type": "structure", - "members": { - "description": { - "target": "com.amazonaws.fis#ActionParameterDescription", - "traits": { - "smithy.api#documentation": "The parameter description.
" - } - }, - "required": { - "target": "com.amazonaws.fis#ActionParameterRequired", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "Indicates whether the parameter is required.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Describes a parameter for an action.
" - } - }, - "com.amazonaws.fis#ActionParameterDescription": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 512 - }, - "smithy.api#pattern": "^[\\s\\S]+$" - } - }, - "com.amazonaws.fis#ActionParameterMap": { - "type": "map", - "key": { - "target": "com.amazonaws.fis#ActionParameterName" - }, - "value": { - "target": "com.amazonaws.fis#ActionParameter" - } - }, - "com.amazonaws.fis#ActionParameterName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 64 - }, - "smithy.api#pattern": "^[\\S]+$" - } - }, - "com.amazonaws.fis#ActionParameterRequired": { - "type": "boolean", - "traits": { - "smithy.api#default": false - } - }, - "com.amazonaws.fis#ActionSummary": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.fis#ActionId", - "traits": { - "smithy.api#documentation": "The ID of the action.
" - } - }, - "arn": { - "target": "com.amazonaws.fis#ResourceArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the action.
" - } - }, - "description": { - "target": "com.amazonaws.fis#ActionDescription", - "traits": { - "smithy.api#documentation": "The description for the action.
" - } - }, - "targets": { - "target": "com.amazonaws.fis#ActionTargetMap", - "traits": { - "smithy.api#documentation": "The targets for the action.
" - } - }, - "tags": { - "target": "com.amazonaws.fis#TagMap", - "traits": { - "smithy.api#documentation": "The tags for the action.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Provides a summary of an action.
" - } - }, - "com.amazonaws.fis#ActionSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.fis#ActionSummary" - } - }, - "com.amazonaws.fis#ActionTarget": { - "type": "structure", - "members": { - "resourceType": { - "target": "com.amazonaws.fis#TargetResourceTypeId", - "traits": { - "smithy.api#documentation": "The resource type of the target.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Describes a target for an action.
" - } - }, - "com.amazonaws.fis#ActionTargetMap": { - "type": "map", - "key": { - "target": "com.amazonaws.fis#ActionTargetName" - }, - "value": { - "target": "com.amazonaws.fis#ActionTarget" - } - }, - "com.amazonaws.fis#ActionTargetName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 64 - }, - "smithy.api#pattern": "^[\\S]+$" - } - }, - "com.amazonaws.fis#ActionsMode": { - "type": "enum", - "members": { - "SKIP_ALL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "skip-all" - } - }, - "RUN_ALL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "run-all" - } - } - } - }, - "com.amazonaws.fis#ClientToken": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - }, - "smithy.api#pattern": "^[\\S]+$" - } - }, - "com.amazonaws.fis#CloudWatchLogGroupArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 20, - "max": 2048 - }, - "smithy.api#pattern": "^[\\S]+$" - } - }, - "com.amazonaws.fis#ConflictException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.fis#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "ConflictException", - "httpResponseCode": 409 - }, - "smithy.api#documentation": "The request could not be processed because of a conflict.
", - "smithy.api#error": "client", - "smithy.api#httpError": 409 - } - }, - "com.amazonaws.fis#CreateExperimentTemplate": { - "type": "operation", - "input": { - "target": "com.amazonaws.fis#CreateExperimentTemplateRequest" - }, - "output": { - "target": "com.amazonaws.fis#CreateExperimentTemplateResponse" - }, - "errors": [ - { - "target": "com.amazonaws.fis#ConflictException" - }, - { - "target": "com.amazonaws.fis#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.fis#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.fis#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Creates an experiment template.
\nAn experiment template includes the following components:
\n\n Targets: A target can be a specific resource in \n your Amazon Web Services environment, or one or more resources that match criteria that you\n specify, for example, resources that have specific tags.
\n\n Actions: The actions to carry out on the\n target. You can specify multiple actions, the duration of each action, and when to start each action during an experiment.
\n\n Stop conditions: If a stop condition is\n triggered while an experiment is running, the experiment is automatically\n stopped. You can define a stop condition as a CloudWatch alarm.
\nFor more information, see experiment templates\n in the Fault Injection Service User Guide.
", - "smithy.api#http": { - "method": "POST", - "uri": "/experimentTemplates", - "code": 200 - } - } - }, - "com.amazonaws.fis#CreateExperimentTemplateActionInput": { - "type": "structure", - "members": { - "actionId": { - "target": "com.amazonaws.fis#ActionId", - "traits": { - "smithy.api#documentation": "The ID of the action. The format of the action ID is: aws:service-name:action-type.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.fis#ExperimentTemplateActionDescription", - "traits": { - "smithy.api#documentation": "A description for the action.
" - } - }, - "parameters": { - "target": "com.amazonaws.fis#ExperimentTemplateActionParameterMap", - "traits": { - "smithy.api#documentation": "The parameters for the action, if applicable.
" - } - }, - "targets": { - "target": "com.amazonaws.fis#ExperimentTemplateActionTargetMap", - "traits": { - "smithy.api#documentation": "The targets for the action.
" - } - }, - "startAfter": { - "target": "com.amazonaws.fis#ExperimentTemplateActionStartAfterList", - "traits": { - "smithy.api#documentation": "The name of the action that must be completed before the current action starts. Omit this parameter to run the action at the start of the experiment.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Specifies an action for an experiment template.
\nFor more information, see Actions\n in the Fault Injection Service User Guide.
" - } - }, - "com.amazonaws.fis#CreateExperimentTemplateActionInputMap": { - "type": "map", - "key": { - "target": "com.amazonaws.fis#ExperimentTemplateActionName" - }, - "value": { - "target": "com.amazonaws.fis#CreateExperimentTemplateActionInput" - } - }, - "com.amazonaws.fis#CreateExperimentTemplateExperimentOptionsInput": { - "type": "structure", - "members": { - "accountTargeting": { - "target": "com.amazonaws.fis#AccountTargeting", - "traits": { - "smithy.api#documentation": "Specifies the account targeting setting for experiment options.
" - } - }, - "emptyTargetResolutionMode": { - "target": "com.amazonaws.fis#EmptyTargetResolutionMode", - "traits": { - "smithy.api#documentation": "Specifies the empty target resolution mode for experiment options.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Specifies experiment options for an experiment template.
" - } - }, - "com.amazonaws.fis#CreateExperimentTemplateLogConfigurationInput": { - "type": "structure", - "members": { - "cloudWatchLogsConfiguration": { - "target": "com.amazonaws.fis#ExperimentTemplateCloudWatchLogsLogConfigurationInput", - "traits": { - "smithy.api#documentation": "The configuration for experiment logging to Amazon CloudWatch Logs.
" - } - }, - "s3Configuration": { - "target": "com.amazonaws.fis#ExperimentTemplateS3LogConfigurationInput", - "traits": { - "smithy.api#documentation": "The configuration for experiment logging to Amazon S3.
" - } - }, - "logSchemaVersion": { - "target": "com.amazonaws.fis#LogSchemaVersion", - "traits": { - "smithy.api#documentation": "The schema version.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Specifies the configuration for experiment logging.
" - } - }, - "com.amazonaws.fis#CreateExperimentTemplateRequest": { - "type": "structure", - "members": { - "clientToken": { - "target": "com.amazonaws.fis#ClientToken", - "traits": { - "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
", - "smithy.api#idempotencyToken": {}, - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.fis#ExperimentTemplateDescription", - "traits": { - "smithy.api#documentation": "A description for the experiment template.
", - "smithy.api#required": {} - } - }, - "stopConditions": { - "target": "com.amazonaws.fis#CreateExperimentTemplateStopConditionInputList", - "traits": { - "smithy.api#documentation": "The stop conditions.
", - "smithy.api#required": {} - } - }, - "targets": { - "target": "com.amazonaws.fis#CreateExperimentTemplateTargetInputMap", - "traits": { - "smithy.api#documentation": "The targets for the experiment.
" - } - }, - "actions": { - "target": "com.amazonaws.fis#CreateExperimentTemplateActionInputMap", - "traits": { - "smithy.api#documentation": "The actions for the experiment.
", - "smithy.api#required": {} - } - }, - "roleArn": { - "target": "com.amazonaws.fis#RoleArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that grants the FIS service permission to perform service actions on your behalf.
", - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.fis#TagMap", - "traits": { - "smithy.api#documentation": "The tags to apply to the experiment template.
" - } - }, - "logConfiguration": { - "target": "com.amazonaws.fis#CreateExperimentTemplateLogConfigurationInput", - "traits": { - "smithy.api#documentation": "The configuration for experiment logging.
" - } - }, - "experimentOptions": { - "target": "com.amazonaws.fis#CreateExperimentTemplateExperimentOptionsInput", - "traits": { - "smithy.api#documentation": "The experiment options for the experiment template.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.fis#CreateExperimentTemplateResponse": { - "type": "structure", - "members": { - "experimentTemplate": { - "target": "com.amazonaws.fis#ExperimentTemplate", - "traits": { - "smithy.api#documentation": "Information about the experiment template.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.fis#CreateExperimentTemplateStopConditionInput": { - "type": "structure", - "members": { - "source": { - "target": "com.amazonaws.fis#StopConditionSource", - "traits": { - "smithy.api#documentation": "The source for the stop condition. Specify aws:cloudwatch:alarm if the stop\n condition is defined by a CloudWatch alarm. Specify none if there is no stop\n condition.
The Amazon Resource Name (ARN) of the CloudWatch alarm. This is required if the source is\n a CloudWatch alarm.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Specifies a stop condition for an experiment template.
" - } - }, - "com.amazonaws.fis#CreateExperimentTemplateStopConditionInputList": { - "type": "list", - "member": { - "target": "com.amazonaws.fis#CreateExperimentTemplateStopConditionInput" - } - }, - "com.amazonaws.fis#CreateExperimentTemplateTargetInput": { - "type": "structure", - "members": { - "resourceType": { - "target": "com.amazonaws.fis#TargetResourceTypeId", - "traits": { - "smithy.api#documentation": "The resource type. The resource type must be supported for the specified action.
", - "smithy.api#required": {} - } - }, - "resourceArns": { - "target": "com.amazonaws.fis#ResourceArnList", - "traits": { - "smithy.api#documentation": "The Amazon Resource Names (ARNs) of the resources.
" - } - }, - "resourceTags": { - "target": "com.amazonaws.fis#TagMap", - "traits": { - "smithy.api#documentation": "The tags for the target resources.
" - } - }, - "filters": { - "target": "com.amazonaws.fis#ExperimentTemplateTargetFilterInputList", - "traits": { - "smithy.api#documentation": "The filters to apply to identify target resources using specific attributes.
" - } - }, - "selectionMode": { - "target": "com.amazonaws.fis#ExperimentTemplateTargetSelectionMode", - "traits": { - "smithy.api#documentation": "Scopes the identified resources to a specific count of the resources at random, or a percentage of the resources. All identified resources are included in the target.
\nALL - Run the action on all identified targets. This is the default.
\nCOUNT(n) - Run the action on the specified number of targets, chosen from the identified targets at random.\n For example, COUNT(1) selects one of the targets.
\nPERCENT(n) - Run the action on the specified percentage of targets, chosen from the identified targets \n at random. For example, PERCENT(25) selects 25% of the targets.
\nThe resource type parameters.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Specifies a target for an experiment. You must specify at least one Amazon Resource Name (ARN) or \n at least one resource tag. You cannot specify both ARNs and tags.
\nFor more information, see Targets\n in the Fault Injection Service User Guide.
" - } - }, - "com.amazonaws.fis#CreateExperimentTemplateTargetInputMap": { - "type": "map", - "key": { - "target": "com.amazonaws.fis#ExperimentTemplateTargetName" - }, - "value": { - "target": "com.amazonaws.fis#CreateExperimentTemplateTargetInput" - } - }, - "com.amazonaws.fis#CreateTargetAccountConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.fis#CreateTargetAccountConfigurationRequest" - }, - "output": { - "target": "com.amazonaws.fis#CreateTargetAccountConfigurationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.fis#ConflictException" - }, - { - "target": "com.amazonaws.fis#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.fis#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.fis#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Creates a target account configuration for the experiment template. A target account configuration\n is required when accountTargeting of experimentOptions is set to multi-account.\n For more information, see experiment options\n in the Fault Injection Service User Guide.\n
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
", - "smithy.api#idempotencyToken": {} - } - }, - "experimentTemplateId": { - "target": "com.amazonaws.fis#ExperimentTemplateId", - "traits": { - "smithy.api#documentation": "The experiment template ID.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "accountId": { - "target": "com.amazonaws.fis#TargetAccountId", - "traits": { - "smithy.api#documentation": "The Amazon Web Services account ID of the target account.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "roleArn": { - "target": "com.amazonaws.fis#RoleArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role for the target account.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.fis#TargetAccountConfigurationDescription", - "traits": { - "smithy.api#documentation": "The description of the target account.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.fis#CreateTargetAccountConfigurationResponse": { - "type": "structure", - "members": { - "targetAccountConfiguration": { - "target": "com.amazonaws.fis#TargetAccountConfiguration", - "traits": { - "smithy.api#documentation": "Information about the target account configuration.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.fis#CreationTime": { - "type": "timestamp" - }, - "com.amazonaws.fis#DeleteExperimentTemplate": { - "type": "operation", - "input": { - "target": "com.amazonaws.fis#DeleteExperimentTemplateRequest" - }, - "output": { - "target": "com.amazonaws.fis#DeleteExperimentTemplateResponse" - }, - "errors": [ - { - "target": "com.amazonaws.fis#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.fis#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes the specified experiment template.
", - "smithy.api#http": { - "method": "DELETE", - "uri": "/experimentTemplates/{id}", - "code": 200 - } - } - }, - "com.amazonaws.fis#DeleteExperimentTemplateRequest": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.fis#ExperimentTemplateId", - "traits": { - "smithy.api#documentation": "The ID of the experiment template.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.fis#DeleteExperimentTemplateResponse": { - "type": "structure", - "members": { - "experimentTemplate": { - "target": "com.amazonaws.fis#ExperimentTemplate", - "traits": { - "smithy.api#documentation": "Information about the experiment template.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.fis#DeleteTargetAccountConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.fis#DeleteTargetAccountConfigurationRequest" - }, - "output": { - "target": "com.amazonaws.fis#DeleteTargetAccountConfigurationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.fis#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.fis#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes the specified target account configuration of the experiment template.
", - "smithy.api#http": { - "method": "DELETE", - "uri": "/experimentTemplates/{experimentTemplateId}/targetAccountConfigurations/{accountId}", - "code": 200 - } - } - }, - "com.amazonaws.fis#DeleteTargetAccountConfigurationRequest": { - "type": "structure", - "members": { - "experimentTemplateId": { - "target": "com.amazonaws.fis#ExperimentTemplateId", - "traits": { - "smithy.api#documentation": "The ID of the experiment template.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "accountId": { - "target": "com.amazonaws.fis#TargetAccountId", - "traits": { - "smithy.api#documentation": "The Amazon Web Services account ID of the target account.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.fis#DeleteTargetAccountConfigurationResponse": { - "type": "structure", - "members": { - "targetAccountConfiguration": { - "target": "com.amazonaws.fis#TargetAccountConfiguration", - "traits": { - "smithy.api#documentation": "Information about the target account configuration.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.fis#EmptyTargetResolutionMode": { - "type": "enum", - "members": { - "FAIL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "fail" - } - }, - "SKIP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "skip" - } - } - } - }, - "com.amazonaws.fis#ExceptionMessage": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1024 - }, - "smithy.api#pattern": "^[\\s\\S]+$" - } - }, - "com.amazonaws.fis#Experiment": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.fis#ExperimentId", - "traits": { - "smithy.api#documentation": "The ID of the experiment.
" - } - }, - "arn": { - "target": "com.amazonaws.fis#ResourceArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the experiment.
" - } - }, - "experimentTemplateId": { - "target": "com.amazonaws.fis#ExperimentTemplateId", - "traits": { - "smithy.api#documentation": "The ID of the experiment template.
" - } - }, - "roleArn": { - "target": "com.amazonaws.fis#RoleArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that grants the FIS service permission to perform service actions on your behalf.
" - } - }, - "state": { - "target": "com.amazonaws.fis#ExperimentState", - "traits": { - "smithy.api#documentation": "The state of the experiment.
" - } - }, - "targets": { - "target": "com.amazonaws.fis#ExperimentTargetMap", - "traits": { - "smithy.api#documentation": "The targets for the experiment.
" - } - }, - "actions": { - "target": "com.amazonaws.fis#ExperimentActionMap", - "traits": { - "smithy.api#documentation": "The actions for the experiment.
" - } - }, - "stopConditions": { - "target": "com.amazonaws.fis#ExperimentStopConditionList", - "traits": { - "smithy.api#documentation": "The stop conditions for the experiment.
" - } - }, - "creationTime": { - "target": "com.amazonaws.fis#CreationTime", - "traits": { - "smithy.api#documentation": "The time that the experiment was created.
" - } - }, - "startTime": { - "target": "com.amazonaws.fis#ExperimentStartTime", - "traits": { - "smithy.api#documentation": "The time that the experiment started.
" - } - }, - "endTime": { - "target": "com.amazonaws.fis#ExperimentEndTime", - "traits": { - "smithy.api#documentation": "The time that the experiment ended.
" - } - }, - "tags": { - "target": "com.amazonaws.fis#TagMap", - "traits": { - "smithy.api#documentation": "The tags for the experiment.
" - } - }, - "logConfiguration": { - "target": "com.amazonaws.fis#ExperimentLogConfiguration", - "traits": { - "smithy.api#documentation": "The configuration for experiment logging.
" - } - }, - "experimentOptions": { - "target": "com.amazonaws.fis#ExperimentOptions", - "traits": { - "smithy.api#documentation": "The experiment options for the experiment.
" - } - }, - "targetAccountConfigurationsCount": { - "target": "com.amazonaws.fis#TargetAccountConfigurationsCount", - "traits": { - "smithy.api#documentation": "The count of target account configurations for the experiment.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Describes an experiment.
" - } - }, - "com.amazonaws.fis#ExperimentAction": { - "type": "structure", - "members": { - "actionId": { - "target": "com.amazonaws.fis#ActionId", - "traits": { - "smithy.api#documentation": "The ID of the action.
" - } - }, - "description": { - "target": "com.amazonaws.fis#ExperimentActionDescription", - "traits": { - "smithy.api#documentation": "The description for the action.
" - } - }, - "parameters": { - "target": "com.amazonaws.fis#ExperimentActionParameterMap", - "traits": { - "smithy.api#documentation": "The parameters for the action.
" - } - }, - "targets": { - "target": "com.amazonaws.fis#ExperimentActionTargetMap", - "traits": { - "smithy.api#documentation": "The targets for the action.
" - } - }, - "startAfter": { - "target": "com.amazonaws.fis#ExperimentActionStartAfterList", - "traits": { - "smithy.api#documentation": "The name of the action that must be completed before this action starts.
" - } - }, - "state": { - "target": "com.amazonaws.fis#ExperimentActionState", - "traits": { - "smithy.api#documentation": "The state of the action.
" - } - }, - "startTime": { - "target": "com.amazonaws.fis#ExperimentActionStartTime", - "traits": { - "smithy.api#documentation": "The time that the action started.
" - } - }, - "endTime": { - "target": "com.amazonaws.fis#ExperimentActionEndTime", - "traits": { - "smithy.api#documentation": "The time that the action ended.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Describes the action for an experiment.
" - } - }, - "com.amazonaws.fis#ExperimentActionDescription": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 512 - }, - "smithy.api#pattern": "^[\\s\\S]+$" - } - }, - "com.amazonaws.fis#ExperimentActionEndTime": { - "type": "timestamp" - }, - "com.amazonaws.fis#ExperimentActionMap": { - "type": "map", - "key": { - "target": "com.amazonaws.fis#ExperimentActionName" - }, - "value": { - "target": "com.amazonaws.fis#ExperimentAction" - } - }, - "com.amazonaws.fis#ExperimentActionName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 64 - }, - "smithy.api#pattern": "^[\\S]+$" - } - }, - "com.amazonaws.fis#ExperimentActionParameter": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1024 - }, - "smithy.api#pattern": "^[\\S]+$" - } - }, - "com.amazonaws.fis#ExperimentActionParameterMap": { - "type": "map", - "key": { - "target": "com.amazonaws.fis#ExperimentActionParameterName" - }, - "value": { - "target": "com.amazonaws.fis#ExperimentActionParameter" - } - }, - "com.amazonaws.fis#ExperimentActionParameterName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 64 - }, - "smithy.api#pattern": "^[\\S]+$" - } - }, - "com.amazonaws.fis#ExperimentActionStartAfter": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 64 - }, - "smithy.api#pattern": "^[\\S]+$" - } - }, - "com.amazonaws.fis#ExperimentActionStartAfterList": { - "type": "list", - "member": { - "target": "com.amazonaws.fis#ExperimentActionStartAfter" - } - }, - "com.amazonaws.fis#ExperimentActionStartTime": { - "type": "timestamp" - }, - "com.amazonaws.fis#ExperimentActionState": { - "type": "structure", - "members": { - "status": { - "target": "com.amazonaws.fis#ExperimentActionStatus", - "traits": { - "smithy.api#documentation": "The state of the action.
" - } - }, - "reason": { - "target": "com.amazonaws.fis#ExperimentActionStatusReason", - "traits": { - "smithy.api#documentation": "The reason for the state.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Describes the state of an action.
" - } - }, - "com.amazonaws.fis#ExperimentActionStatus": { - "type": "enum", - "members": { - "pending": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "pending" - } - }, - "initiating": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "initiating" - } - }, - "running": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "running" - } - }, - "completed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "completed" - } - }, - "cancelled": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cancelled" - } - }, - "stopping": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "stopping" - } - }, - "stopped": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "stopped" - } - }, - "failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "failed" - } - }, - "skipped": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "skipped" - } - } - } - }, - "com.amazonaws.fis#ExperimentActionStatusReason": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 512 - }, - "smithy.api#pattern": "^[\\s\\S]+$" - } - }, - "com.amazonaws.fis#ExperimentActionTargetMap": { - "type": "map", - "key": { - "target": "com.amazonaws.fis#ExperimentActionTargetName" - }, - "value": { - "target": "com.amazonaws.fis#ExperimentTargetName" - } - }, - "com.amazonaws.fis#ExperimentActionTargetName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 64 - }, - "smithy.api#pattern": "^[\\S]+$" - } - }, - "com.amazonaws.fis#ExperimentCloudWatchLogsLogConfiguration": { - "type": "structure", - "members": { - "logGroupArn": { - "target": "com.amazonaws.fis#CloudWatchLogGroupArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the destination Amazon CloudWatch Logs log group.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Describes the configuration for experiment logging to Amazon CloudWatch Logs.
" - } - }, - "com.amazonaws.fis#ExperimentEndTime": { - "type": "timestamp" - }, - "com.amazonaws.fis#ExperimentError": { - "type": "structure", - "members": { - "accountId": { - "target": "com.amazonaws.fis#ExperimentErrorAccountId", - "traits": { - "smithy.api#documentation": "The Amazon Web Services Account ID where the experiment failure occurred.
" - } - }, - "code": { - "target": "com.amazonaws.fis#ExperimentErrorCode", - "traits": { - "smithy.api#documentation": "The error code for the failed experiment.
" - } - }, - "location": { - "target": "com.amazonaws.fis#ExperimentErrorLocation", - "traits": { - "smithy.api#documentation": "Context for the section of the experiment template that failed.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Describes the error when an experiment has failed.
The configuration for experiment logging to Amazon CloudWatch Logs.
" - } - }, - "s3Configuration": { - "target": "com.amazonaws.fis#ExperimentS3LogConfiguration", - "traits": { - "smithy.api#documentation": "The configuration for experiment logging to Amazon S3.
" - } - }, - "logSchemaVersion": { - "target": "com.amazonaws.fis#LogSchemaVersion", - "traits": { - "smithy.api#documentation": "The schema version.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Describes the configuration for experiment logging.
" - } - }, - "com.amazonaws.fis#ExperimentOptions": { - "type": "structure", - "members": { - "accountTargeting": { - "target": "com.amazonaws.fis#AccountTargeting", - "traits": { - "smithy.api#documentation": "The account targeting setting for an experiment.
" - } - }, - "emptyTargetResolutionMode": { - "target": "com.amazonaws.fis#EmptyTargetResolutionMode", - "traits": { - "smithy.api#documentation": "The empty target resolution mode for an experiment.
" - } - }, - "actionsMode": { - "target": "com.amazonaws.fis#ActionsMode", - "traits": { - "smithy.api#documentation": "The actions mode of the experiment that is set from the StartExperiment API command.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Describes the options for an experiment.
" - } - }, - "com.amazonaws.fis#ExperimentS3LogConfiguration": { - "type": "structure", - "members": { - "bucketName": { - "target": "com.amazonaws.fis#S3BucketName", - "traits": { - "smithy.api#documentation": "The name of the destination bucket.
" - } - }, - "prefix": { - "target": "com.amazonaws.fis#S3ObjectKey", - "traits": { - "smithy.api#documentation": "The bucket prefix.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Describes the configuration for experiment logging to Amazon S3.
" - } - }, - "com.amazonaws.fis#ExperimentStartTime": { - "type": "timestamp" - }, - "com.amazonaws.fis#ExperimentState": { - "type": "structure", - "members": { - "status": { - "target": "com.amazonaws.fis#ExperimentStatus", - "traits": { - "smithy.api#documentation": "The state of the experiment.
" - } - }, - "reason": { - "target": "com.amazonaws.fis#ExperimentStatusReason", - "traits": { - "smithy.api#documentation": "The reason for the state.
" - } - }, - "error": { - "target": "com.amazonaws.fis#ExperimentError", - "traits": { - "smithy.api#documentation": "The error information of the experiment when the action has failed.
Describes the state of an experiment.
" - } - }, - "com.amazonaws.fis#ExperimentStatus": { - "type": "enum", - "members": { - "pending": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "pending" - } - }, - "initiating": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "initiating" - } - }, - "running": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "running" - } - }, - "completed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "completed" - } - }, - "stopping": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "stopping" - } - }, - "stopped": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "stopped" - } - }, - "failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "failed" - } - } - } - }, - "com.amazonaws.fis#ExperimentStatusReason": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 512 - }, - "smithy.api#pattern": "^[\\s\\S]+$" - } - }, - "com.amazonaws.fis#ExperimentStopCondition": { - "type": "structure", - "members": { - "source": { - "target": "com.amazonaws.fis#StopConditionSource", - "traits": { - "smithy.api#documentation": "The source for the stop condition.
" - } - }, - "value": { - "target": "com.amazonaws.fis#StopConditionValue", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the CloudWatch alarm, if applicable.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Describes the stop condition for an experiment.
" - } - }, - "com.amazonaws.fis#ExperimentStopConditionList": { - "type": "list", - "member": { - "target": "com.amazonaws.fis#ExperimentStopCondition" - } - }, - "com.amazonaws.fis#ExperimentSummary": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.fis#ExperimentId", - "traits": { - "smithy.api#documentation": "The ID of the experiment.
" - } - }, - "arn": { - "target": "com.amazonaws.fis#ResourceArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the experiment.
" - } - }, - "experimentTemplateId": { - "target": "com.amazonaws.fis#ExperimentTemplateId", - "traits": { - "smithy.api#documentation": "The ID of the experiment template.
" - } - }, - "state": { - "target": "com.amazonaws.fis#ExperimentState", - "traits": { - "smithy.api#documentation": "The state of the experiment.
" - } - }, - "creationTime": { - "target": "com.amazonaws.fis#CreationTime", - "traits": { - "smithy.api#documentation": "The time that the experiment was created.
" - } - }, - "tags": { - "target": "com.amazonaws.fis#TagMap", - "traits": { - "smithy.api#documentation": "The tags for the experiment.
" - } - }, - "experimentOptions": { - "target": "com.amazonaws.fis#ExperimentOptions", - "traits": { - "smithy.api#documentation": "The experiment options for the experiment.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Provides a summary of an experiment.
" - } - }, - "com.amazonaws.fis#ExperimentSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.fis#ExperimentSummary" - } - }, - "com.amazonaws.fis#ExperimentTarget": { - "type": "structure", - "members": { - "resourceType": { - "target": "com.amazonaws.fis#TargetResourceTypeId", - "traits": { - "smithy.api#documentation": "The resource type.
" - } - }, - "resourceArns": { - "target": "com.amazonaws.fis#ResourceArnList", - "traits": { - "smithy.api#documentation": "The Amazon Resource Names (ARNs) of the resources.
" - } - }, - "resourceTags": { - "target": "com.amazonaws.fis#TagMap", - "traits": { - "smithy.api#documentation": "The tags for the target resources.
" - } - }, - "filters": { - "target": "com.amazonaws.fis#ExperimentTargetFilterList", - "traits": { - "smithy.api#documentation": "The filters to apply to identify target resources using specific attributes.
" - } - }, - "selectionMode": { - "target": "com.amazonaws.fis#ExperimentTargetSelectionMode", - "traits": { - "smithy.api#documentation": "Scopes the identified resources to a specific count or percentage.
" - } - }, - "parameters": { - "target": "com.amazonaws.fis#ExperimentTargetParameterMap", - "traits": { - "smithy.api#documentation": "The resource type parameters.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Describes a target for an experiment.
" - } - }, - "com.amazonaws.fis#ExperimentTargetAccountConfiguration": { - "type": "structure", - "members": { - "roleArn": { - "target": "com.amazonaws.fis#RoleArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role for the target account.
" - } - }, - "accountId": { - "target": "com.amazonaws.fis#TargetAccountId", - "traits": { - "smithy.api#documentation": "The Amazon Web Services account ID of the target account.
" - } - }, - "description": { - "target": "com.amazonaws.fis#TargetAccountConfigurationDescription", - "traits": { - "smithy.api#documentation": "The description of the target account.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Describes a target account configuration for an experiment.
" - } - }, - "com.amazonaws.fis#ExperimentTargetAccountConfigurationList": { - "type": "list", - "member": { - "target": "com.amazonaws.fis#ExperimentTargetAccountConfigurationSummary" - } - }, - "com.amazonaws.fis#ExperimentTargetAccountConfigurationSummary": { - "type": "structure", - "members": { - "roleArn": { - "target": "com.amazonaws.fis#RoleArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role for the target account.
" - } - }, - "accountId": { - "target": "com.amazonaws.fis#TargetAccountId", - "traits": { - "smithy.api#documentation": "The Amazon Web Services account ID of the target account.
" - } - }, - "description": { - "target": "com.amazonaws.fis#TargetAccountConfigurationDescription", - "traits": { - "smithy.api#documentation": "The description of the target account.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Provides a summary of a target account configuration.
" - } - }, - "com.amazonaws.fis#ExperimentTargetFilter": { - "type": "structure", - "members": { - "path": { - "target": "com.amazonaws.fis#ExperimentTargetFilterPath", - "traits": { - "smithy.api#documentation": "The attribute path for the filter.
" - } - }, - "values": { - "target": "com.amazonaws.fis#ExperimentTargetFilterValues", - "traits": { - "smithy.api#documentation": "The attribute values for the filter.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Describes a filter used for the target resources in an experiment.
" - } - }, - "com.amazonaws.fis#ExperimentTargetFilterList": { - "type": "list", - "member": { - "target": "com.amazonaws.fis#ExperimentTargetFilter" - } - }, - "com.amazonaws.fis#ExperimentTargetFilterPath": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - }, - "smithy.api#pattern": "^[\\S]+$" - } - }, - "com.amazonaws.fis#ExperimentTargetFilterValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 128 - }, - "smithy.api#pattern": "^[\\S]+$" - } - }, - "com.amazonaws.fis#ExperimentTargetFilterValues": { - "type": "list", - "member": { - "target": "com.amazonaws.fis#ExperimentTargetFilterValue" - } - }, - "com.amazonaws.fis#ExperimentTargetMap": { - "type": "map", - "key": { - "target": "com.amazonaws.fis#ExperimentTargetName" - }, - "value": { - "target": "com.amazonaws.fis#ExperimentTarget" - } - }, - "com.amazonaws.fis#ExperimentTargetName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 64 - }, - "smithy.api#pattern": "^[\\S]+$" - } - }, - "com.amazonaws.fis#ExperimentTargetParameterMap": { - "type": "map", - "key": { - "target": "com.amazonaws.fis#ExperimentTargetParameterName" - }, - "value": { - "target": "com.amazonaws.fis#ExperimentTargetParameterValue" - } - }, - "com.amazonaws.fis#ExperimentTargetParameterName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 64 - }, - "smithy.api#pattern": "^[\\S]+$" - } - }, - "com.amazonaws.fis#ExperimentTargetParameterValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - } - } - }, - "com.amazonaws.fis#ExperimentTargetSelectionMode": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 64 - }, - "smithy.api#pattern": "^[\\S]+$" - } - }, - "com.amazonaws.fis#ExperimentTemplate": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.fis#ExperimentTemplateId", - "traits": { - "smithy.api#documentation": "The ID of the experiment template.
" - } - }, - "arn": { - "target": "com.amazonaws.fis#ResourceArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the experiment template.
" - } - }, - "description": { - "target": "com.amazonaws.fis#ExperimentTemplateDescription", - "traits": { - "smithy.api#documentation": "The description for the experiment template.
" - } - }, - "targets": { - "target": "com.amazonaws.fis#ExperimentTemplateTargetMap", - "traits": { - "smithy.api#documentation": "The targets for the experiment.
" - } - }, - "actions": { - "target": "com.amazonaws.fis#ExperimentTemplateActionMap", - "traits": { - "smithy.api#documentation": "The actions for the experiment.
" - } - }, - "stopConditions": { - "target": "com.amazonaws.fis#ExperimentTemplateStopConditionList", - "traits": { - "smithy.api#documentation": "The stop conditions for the experiment.
" - } - }, - "creationTime": { - "target": "com.amazonaws.fis#CreationTime", - "traits": { - "smithy.api#documentation": "The time the experiment template was created.
" - } - }, - "lastUpdateTime": { - "target": "com.amazonaws.fis#LastUpdateTime", - "traits": { - "smithy.api#documentation": "The time the experiment template was last updated.
" - } - }, - "roleArn": { - "target": "com.amazonaws.fis#RoleArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role.
" - } - }, - "tags": { - "target": "com.amazonaws.fis#TagMap", - "traits": { - "smithy.api#documentation": "The tags for the experiment template.
" - } - }, - "logConfiguration": { - "target": "com.amazonaws.fis#ExperimentTemplateLogConfiguration", - "traits": { - "smithy.api#documentation": "The configuration for experiment logging.
" - } - }, - "experimentOptions": { - "target": "com.amazonaws.fis#ExperimentTemplateExperimentOptions", - "traits": { - "smithy.api#documentation": "The experiment options for an experiment template.
" - } - }, - "targetAccountConfigurationsCount": { - "target": "com.amazonaws.fis#TargetAccountConfigurationsCount", - "traits": { - "smithy.api#documentation": "The count of target account configurations for the experiment template.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Describes an experiment template.
" - } - }, - "com.amazonaws.fis#ExperimentTemplateAction": { - "type": "structure", - "members": { - "actionId": { - "target": "com.amazonaws.fis#ActionId", - "traits": { - "smithy.api#documentation": "The ID of the action.
" - } - }, - "description": { - "target": "com.amazonaws.fis#ExperimentTemplateActionDescription", - "traits": { - "smithy.api#documentation": "A description for the action.
" - } - }, - "parameters": { - "target": "com.amazonaws.fis#ExperimentTemplateActionParameterMap", - "traits": { - "smithy.api#documentation": "The parameters for the action.
" - } - }, - "targets": { - "target": "com.amazonaws.fis#ExperimentTemplateActionTargetMap", - "traits": { - "smithy.api#documentation": "The targets for the action.
" - } - }, - "startAfter": { - "target": "com.amazonaws.fis#ExperimentTemplateActionStartAfterList", - "traits": { - "smithy.api#documentation": "The name of the action that must be completed before the current action starts.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Describes an action for an experiment template.
" - } - }, - "com.amazonaws.fis#ExperimentTemplateActionDescription": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 512 - }, - "smithy.api#pattern": "^[\\s\\S]+$" - } - }, - "com.amazonaws.fis#ExperimentTemplateActionMap": { - "type": "map", - "key": { - "target": "com.amazonaws.fis#ExperimentTemplateActionName" - }, - "value": { - "target": "com.amazonaws.fis#ExperimentTemplateAction" - } - }, - "com.amazonaws.fis#ExperimentTemplateActionName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 64 - }, - "smithy.api#pattern": "^[\\S]+$" - } - }, - "com.amazonaws.fis#ExperimentTemplateActionParameter": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1024 - }, - "smithy.api#pattern": "^[\\S]+$" - } - }, - "com.amazonaws.fis#ExperimentTemplateActionParameterMap": { - "type": "map", - "key": { - "target": "com.amazonaws.fis#ExperimentTemplateActionParameterName" - }, - "value": { - "target": "com.amazonaws.fis#ExperimentTemplateActionParameter" - } - }, - "com.amazonaws.fis#ExperimentTemplateActionParameterName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 64 - }, - "smithy.api#pattern": "^[\\S]+$" - } - }, - "com.amazonaws.fis#ExperimentTemplateActionStartAfter": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 64 - }, - "smithy.api#pattern": "^[\\S]+$" - } - }, - "com.amazonaws.fis#ExperimentTemplateActionStartAfterList": { - "type": "list", - "member": { - "target": "com.amazonaws.fis#ExperimentTemplateActionStartAfter" - } - }, - "com.amazonaws.fis#ExperimentTemplateActionTargetMap": { - "type": "map", - "key": { - "target": "com.amazonaws.fis#ExperimentTemplateActionTargetName" - }, - "value": { - "target": "com.amazonaws.fis#ExperimentTemplateTargetName" - } - }, - "com.amazonaws.fis#ExperimentTemplateActionTargetName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 64 - }, - "smithy.api#pattern": "^[\\S]+$" - } - }, - "com.amazonaws.fis#ExperimentTemplateCloudWatchLogsLogConfiguration": { - "type": "structure", - "members": { - "logGroupArn": { - "target": "com.amazonaws.fis#CloudWatchLogGroupArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the destination Amazon CloudWatch Logs log group.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Describes the configuration for experiment logging to Amazon CloudWatch Logs.
" - } - }, - "com.amazonaws.fis#ExperimentTemplateCloudWatchLogsLogConfigurationInput": { - "type": "structure", - "members": { - "logGroupArn": { - "target": "com.amazonaws.fis#CloudWatchLogGroupArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the destination Amazon CloudWatch Logs log group.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Specifies the configuration for experiment logging to Amazon CloudWatch Logs.
" - } - }, - "com.amazonaws.fis#ExperimentTemplateDescription": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 512 - }, - "smithy.api#pattern": "^[\\s\\S]+$" - } - }, - "com.amazonaws.fis#ExperimentTemplateExperimentOptions": { - "type": "structure", - "members": { - "accountTargeting": { - "target": "com.amazonaws.fis#AccountTargeting", - "traits": { - "smithy.api#documentation": "The account targeting setting for an experiment template.
" - } - }, - "emptyTargetResolutionMode": { - "target": "com.amazonaws.fis#EmptyTargetResolutionMode", - "traits": { - "smithy.api#documentation": "The empty target resolution mode for an experiment template.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Describes the experiment options for an experiment template.
" - } - }, - "com.amazonaws.fis#ExperimentTemplateId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 64 - }, - "smithy.api#pattern": "^[\\S]+$" - } - }, - "com.amazonaws.fis#ExperimentTemplateLogConfiguration": { - "type": "structure", - "members": { - "cloudWatchLogsConfiguration": { - "target": "com.amazonaws.fis#ExperimentTemplateCloudWatchLogsLogConfiguration", - "traits": { - "smithy.api#documentation": "The configuration for experiment logging to Amazon CloudWatch Logs.
" - } - }, - "s3Configuration": { - "target": "com.amazonaws.fis#ExperimentTemplateS3LogConfiguration", - "traits": { - "smithy.api#documentation": "The configuration for experiment logging to Amazon S3.
" - } - }, - "logSchemaVersion": { - "target": "com.amazonaws.fis#LogSchemaVersion", - "traits": { - "smithy.api#documentation": "The schema version.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Describes the configuration for experiment logging.
" - } - }, - "com.amazonaws.fis#ExperimentTemplateS3LogConfiguration": { - "type": "structure", - "members": { - "bucketName": { - "target": "com.amazonaws.fis#S3BucketName", - "traits": { - "smithy.api#documentation": "The name of the destination bucket.
" - } - }, - "prefix": { - "target": "com.amazonaws.fis#S3ObjectKey", - "traits": { - "smithy.api#documentation": "The bucket prefix.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Describes the configuration for experiment logging to Amazon S3.
" - } - }, - "com.amazonaws.fis#ExperimentTemplateS3LogConfigurationInput": { - "type": "structure", - "members": { - "bucketName": { - "target": "com.amazonaws.fis#S3BucketName", - "traits": { - "smithy.api#documentation": "The name of the destination bucket.
", - "smithy.api#required": {} - } - }, - "prefix": { - "target": "com.amazonaws.fis#S3ObjectKey", - "traits": { - "smithy.api#documentation": "The bucket prefix.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Specifies the configuration for experiment logging to Amazon S3.
" - } - }, - "com.amazonaws.fis#ExperimentTemplateStopCondition": { - "type": "structure", - "members": { - "source": { - "target": "com.amazonaws.fis#StopConditionSource", - "traits": { - "smithy.api#documentation": "The source for the stop condition.
" - } - }, - "value": { - "target": "com.amazonaws.fis#StopConditionValue", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the CloudWatch alarm, if applicable.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Describes a stop condition for an experiment template.
" - } - }, - "com.amazonaws.fis#ExperimentTemplateStopConditionList": { - "type": "list", - "member": { - "target": "com.amazonaws.fis#ExperimentTemplateStopCondition" - } - }, - "com.amazonaws.fis#ExperimentTemplateSummary": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.fis#ExperimentTemplateId", - "traits": { - "smithy.api#documentation": "The ID of the experiment template.
" - } - }, - "arn": { - "target": "com.amazonaws.fis#ResourceArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the experiment template.
" - } - }, - "description": { - "target": "com.amazonaws.fis#ExperimentTemplateDescription", - "traits": { - "smithy.api#documentation": "The description of the experiment template.
" - } - }, - "creationTime": { - "target": "com.amazonaws.fis#CreationTime", - "traits": { - "smithy.api#documentation": "The time that the experiment template was created.
" - } - }, - "lastUpdateTime": { - "target": "com.amazonaws.fis#LastUpdateTime", - "traits": { - "smithy.api#documentation": "The time that the experiment template was last updated.
" - } - }, - "tags": { - "target": "com.amazonaws.fis#TagMap", - "traits": { - "smithy.api#documentation": "The tags for the experiment template.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Provides a summary of an experiment template.
" - } - }, - "com.amazonaws.fis#ExperimentTemplateSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.fis#ExperimentTemplateSummary" - } - }, - "com.amazonaws.fis#ExperimentTemplateTarget": { - "type": "structure", - "members": { - "resourceType": { - "target": "com.amazonaws.fis#TargetResourceTypeId", - "traits": { - "smithy.api#documentation": "The resource type.
" - } - }, - "resourceArns": { - "target": "com.amazonaws.fis#ResourceArnList", - "traits": { - "smithy.api#documentation": "The Amazon Resource Names (ARNs) of the targets.
" - } - }, - "resourceTags": { - "target": "com.amazonaws.fis#TagMap", - "traits": { - "smithy.api#documentation": "The tags for the target resources.
" - } - }, - "filters": { - "target": "com.amazonaws.fis#ExperimentTemplateTargetFilterList", - "traits": { - "smithy.api#documentation": "The filters to apply to identify target resources using specific attributes.
" - } - }, - "selectionMode": { - "target": "com.amazonaws.fis#ExperimentTemplateTargetSelectionMode", - "traits": { - "smithy.api#documentation": "Scopes the identified resources to a specific count or percentage.
" - } - }, - "parameters": { - "target": "com.amazonaws.fis#ExperimentTemplateTargetParameterMap", - "traits": { - "smithy.api#documentation": "The resource type parameters.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Describes a target for an experiment template.
" - } - }, - "com.amazonaws.fis#ExperimentTemplateTargetFilter": { - "type": "structure", - "members": { - "path": { - "target": "com.amazonaws.fis#ExperimentTemplateTargetFilterPath", - "traits": { - "smithy.api#documentation": "The attribute path for the filter.
" - } - }, - "values": { - "target": "com.amazonaws.fis#ExperimentTemplateTargetFilterValues", - "traits": { - "smithy.api#documentation": "The attribute values for the filter.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Describes a filter used for the target resources in an experiment template.
" - } - }, - "com.amazonaws.fis#ExperimentTemplateTargetFilterInputList": { - "type": "list", - "member": { - "target": "com.amazonaws.fis#ExperimentTemplateTargetInputFilter" - } - }, - "com.amazonaws.fis#ExperimentTemplateTargetFilterList": { - "type": "list", - "member": { - "target": "com.amazonaws.fis#ExperimentTemplateTargetFilter" - } - }, - "com.amazonaws.fis#ExperimentTemplateTargetFilterPath": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - }, - "smithy.api#pattern": "^[\\S]+$" - } - }, - "com.amazonaws.fis#ExperimentTemplateTargetFilterValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 128 - }, - "smithy.api#pattern": "^[\\S]+$" - } - }, - "com.amazonaws.fis#ExperimentTemplateTargetFilterValues": { - "type": "list", - "member": { - "target": "com.amazonaws.fis#ExperimentTemplateTargetFilterValue" - } - }, - "com.amazonaws.fis#ExperimentTemplateTargetInputFilter": { - "type": "structure", - "members": { - "path": { - "target": "com.amazonaws.fis#ExperimentTemplateTargetFilterPath", - "traits": { - "smithy.api#documentation": "The attribute path for the filter.
", - "smithy.api#required": {} - } - }, - "values": { - "target": "com.amazonaws.fis#ExperimentTemplateTargetFilterValues", - "traits": { - "smithy.api#documentation": "The attribute values for the filter.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Specifies a filter used for the target resource input in an experiment template.
\nFor more information, see Resource filters\n in the Fault Injection Service User Guide.
" - } - }, - "com.amazonaws.fis#ExperimentTemplateTargetMap": { - "type": "map", - "key": { - "target": "com.amazonaws.fis#ExperimentTemplateTargetName" - }, - "value": { - "target": "com.amazonaws.fis#ExperimentTemplateTarget" - } - }, - "com.amazonaws.fis#ExperimentTemplateTargetName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 64 - }, - "smithy.api#pattern": "^[\\S]+$" - } - }, - "com.amazonaws.fis#ExperimentTemplateTargetParameterMap": { - "type": "map", - "key": { - "target": "com.amazonaws.fis#ExperimentTemplateTargetParameterName" - }, - "value": { - "target": "com.amazonaws.fis#ExperimentTemplateTargetParameterValue" - } - }, - "com.amazonaws.fis#ExperimentTemplateTargetParameterName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 64 - }, - "smithy.api#pattern": "^[\\S]+$" - } - }, - "com.amazonaws.fis#ExperimentTemplateTargetParameterValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - }, - "smithy.api#pattern": "^[\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]+$" - } - }, - "com.amazonaws.fis#ExperimentTemplateTargetSelectionMode": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 64 - }, - "smithy.api#pattern": "^[\\S]+$" - } - }, - "com.amazonaws.fis#FaultInjectionSimulator": { - "type": "service", - "version": "2020-12-01", - "operations": [ - { - "target": "com.amazonaws.fis#CreateExperimentTemplate" + "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.fis#AccountTargeting": { + "type": "enum", + "members": { + "SINGLE_ACCOUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "single-account" + } + }, + "MULTI_ACCOUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "multi-account" + } + } + } }, - { - "target": "com.amazonaws.fis#CreateTargetAccountConfiguration" + "com.amazonaws.fis#Action": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.fis#ActionId", + "traits": { + "smithy.api#documentation": "The ID of the action.
" + } + }, + "arn": { + "target": "com.amazonaws.fis#ResourceArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the action.
" + } + }, + "description": { + "target": "com.amazonaws.fis#ActionDescription", + "traits": { + "smithy.api#documentation": "The description for the action.
" + } + }, + "parameters": { + "target": "com.amazonaws.fis#ActionParameterMap", + "traits": { + "smithy.api#documentation": "The action parameters, if applicable.
" + } + }, + "targets": { + "target": "com.amazonaws.fis#ActionTargetMap", + "traits": { + "smithy.api#documentation": "The supported targets for the action.
" + } + }, + "tags": { + "target": "com.amazonaws.fis#TagMap", + "traits": { + "smithy.api#documentation": "The tags for the action.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes an action. For more information, see FIS actions \n in the Fault Injection Service User Guide.
" + } }, - { - "target": "com.amazonaws.fis#DeleteExperimentTemplate" + "com.amazonaws.fis#ActionDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": "^[\\s\\S]+$" + } }, - { - "target": "com.amazonaws.fis#DeleteTargetAccountConfiguration" + "com.amazonaws.fis#ActionId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 128 + }, + "smithy.api#pattern": "^[\\S]+$" + } }, - { - "target": "com.amazonaws.fis#GetAction" + "com.amazonaws.fis#ActionParameter": { + "type": "structure", + "members": { + "description": { + "target": "com.amazonaws.fis#ActionParameterDescription", + "traits": { + "smithy.api#documentation": "The parameter description.
" + } + }, + "required": { + "target": "com.amazonaws.fis#ActionParameterRequired", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "Indicates whether the parameter is required.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes a parameter for an action.
" + } }, - { - "target": "com.amazonaws.fis#GetExperiment" + "com.amazonaws.fis#ActionParameterDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": "^[\\s\\S]+$" + } }, - { - "target": "com.amazonaws.fis#GetExperimentTargetAccountConfiguration" + "com.amazonaws.fis#ActionParameterMap": { + "type": "map", + "key": { + "target": "com.amazonaws.fis#ActionParameterName" + }, + "value": { + "target": "com.amazonaws.fis#ActionParameter" + } }, - { - "target": "com.amazonaws.fis#GetExperimentTemplate" + "com.amazonaws.fis#ActionParameterName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 64 + }, + "smithy.api#pattern": "^[\\S]+$" + } }, - { - "target": "com.amazonaws.fis#GetTargetAccountConfiguration" + "com.amazonaws.fis#ActionParameterRequired": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } }, - { - "target": "com.amazonaws.fis#GetTargetResourceType" + "com.amazonaws.fis#ActionSummary": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.fis#ActionId", + "traits": { + "smithy.api#documentation": "The ID of the action.
" + } + }, + "arn": { + "target": "com.amazonaws.fis#ResourceArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the action.
" + } + }, + "description": { + "target": "com.amazonaws.fis#ActionDescription", + "traits": { + "smithy.api#documentation": "The description for the action.
" + } + }, + "targets": { + "target": "com.amazonaws.fis#ActionTargetMap", + "traits": { + "smithy.api#documentation": "The targets for the action.
" + } + }, + "tags": { + "target": "com.amazonaws.fis#TagMap", + "traits": { + "smithy.api#documentation": "The tags for the action.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides a summary of an action.
" + } }, - { - "target": "com.amazonaws.fis#ListActions" + "com.amazonaws.fis#ActionSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.fis#ActionSummary" + } }, - { - "target": "com.amazonaws.fis#ListExperimentResolvedTargets" + "com.amazonaws.fis#ActionTarget": { + "type": "structure", + "members": { + "resourceType": { + "target": "com.amazonaws.fis#TargetResourceTypeId", + "traits": { + "smithy.api#documentation": "The resource type of the target.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes a target for an action.
" + } }, - { - "target": "com.amazonaws.fis#ListExperiments" + "com.amazonaws.fis#ActionTargetMap": { + "type": "map", + "key": { + "target": "com.amazonaws.fis#ActionTargetName" + }, + "value": { + "target": "com.amazonaws.fis#ActionTarget" + } }, - { - "target": "com.amazonaws.fis#ListExperimentTargetAccountConfigurations" - }, - { - "target": "com.amazonaws.fis#ListExperimentTemplates" - }, - { - "target": "com.amazonaws.fis#ListTagsForResource" - }, - { - "target": "com.amazonaws.fis#ListTargetAccountConfigurations" - }, - { - "target": "com.amazonaws.fis#ListTargetResourceTypes" - }, - { - "target": "com.amazonaws.fis#StartExperiment" + "com.amazonaws.fis#ActionTargetName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 64 + }, + "smithy.api#pattern": "^[\\S]+$" + } }, - { - "target": "com.amazonaws.fis#StopExperiment" + "com.amazonaws.fis#ActionsMode": { + "type": "enum", + "members": { + "SKIP_ALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "skip-all" + } + }, + "RUN_ALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "run-all" + } + } + } }, - { - "target": "com.amazonaws.fis#TagResource" + "com.amazonaws.fis#ClientToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^[\\S]+$" + } }, - { - "target": "com.amazonaws.fis#UntagResource" + "com.amazonaws.fis#CloudWatchLogGroupArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^[\\S]+$" + } }, - { - "target": "com.amazonaws.fis#UpdateExperimentTemplate" + "com.amazonaws.fis#ConflictException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.fis#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ConflictException", + "httpResponseCode": 409 + }, + "smithy.api#documentation": "The request could not be processed because of a conflict.
", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } }, - { - "target": "com.amazonaws.fis#UpdateTargetAccountConfiguration" - } - ], - "traits": { - "aws.api#service": { - "sdkId": "fis", - "arnNamespace": "fis", - "cloudFormationName": "Fis", - "cloudTrailEventSource": "fis.amazonaws.com", - "endpointPrefix": "fis" - }, - "aws.auth#sigv4": { - "name": "fis" - }, - "aws.protocols#restJson1": {}, - "smithy.api#documentation": "Amazon Web Services Fault Injection Service is a managed service that enables you to perform fault injection \n experiments on your Amazon Web Services workloads. For more information, see the Fault Injection Service User Guide.
", - "smithy.api#title": "AWS Fault Injection Simulator", - "smithy.rules#endpointRuleSet": { - "version": "1.0", - "parameters": { - "Region": { - "builtIn": "AWS::Region", - "required": false, - "documentation": "The AWS region used to dispatch the request.", - "type": "String" - }, - "UseDualStack": { - "builtIn": "AWS::UseDualStack", - "required": true, - "default": false, - "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", - "type": "Boolean" - }, - "UseFIPS": { - "builtIn": "AWS::UseFIPS", - "required": true, - "default": false, - "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", - "type": "Boolean" - }, - "Endpoint": { - "builtIn": "SDK::Endpoint", - "required": false, - "documentation": "Override the endpoint used to send this request", - "type": "String" - } - }, - "rules": [ - { - "conditions": [ + "com.amazonaws.fis#CreateExperimentTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.fis#CreateExperimentTemplateRequest" + }, + "output": { + "target": "com.amazonaws.fis#CreateExperimentTemplateResponse" + }, + "errors": [ { - "fn": "isSet", - "argv": [ - { - "ref": "Endpoint" - } - ] - } - ], - "rules": [ + "target": "com.amazonaws.fis#ConflictException" + }, { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", - "type": "error" + "target": "com.amazonaws.fis#ResourceNotFoundException" }, { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" + "target": "com.amazonaws.fis#ServiceQuotaExceededException" }, { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" - }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" + "target": "com.amazonaws.fis#ValidationException" } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Region" - } - ] + ], + "traits": { + "smithy.api#documentation": "Creates an experiment template.
\nAn experiment template includes the following components:
\n\n Targets: A target can be a specific resource in \n your Amazon Web Services environment, or one or more resources that match criteria that you\n specify, for example, resources that have specific tags.
\n\n Actions: The actions to carry out on the\n target. You can specify multiple actions, the duration of each action, and when to start each action during an experiment.
\n\n Stop conditions: If a stop condition is\n triggered while an experiment is running, the experiment is automatically\n stopped. You can define a stop condition as a CloudWatch alarm.
\nFor more information, see experiment templates\n in the Fault Injection Service User Guide.
", + "smithy.api#http": { + "method": "POST", + "uri": "/experimentTemplates", + "code": 200 } - ], - "rules": [ - { - "conditions": [ - { - "fn": "aws.partition", - "argv": [ - { - "ref": "Region" - } - ], - "assign": "PartitionResult" + } + }, + "com.amazonaws.fis#CreateExperimentTemplateActionInput": { + "type": "structure", + "members": { + "actionId": { + "target": "com.amazonaws.fis#ActionId", + "traits": { + "smithy.api#documentation": "The ID of the action. The format of the action ID is: aws:service-name:action-type.
", + "smithy.api#required": {} } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://fis-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "name" - ] - }, - "aws-us-gov" - ] - } - ], - "endpoint": { - "url": "https://fis.{Region}.amazonaws.com", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "endpoint": { - "url": "https://fis-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://fis.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [], - "endpoint": { - "url": "https://fis.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + }, + "description": { + "target": "com.amazonaws.fis#ExperimentTemplateActionDescription", + "traits": { + "smithy.api#documentation": "A description for the action.
" + } + }, + "parameters": { + "target": "com.amazonaws.fis#ExperimentTemplateActionParameterMap", + "traits": { + "smithy.api#documentation": "The parameters for the action, if applicable.
" + } + }, + "targets": { + "target": "com.amazonaws.fis#ExperimentTemplateActionTargetMap", + "traits": { + "smithy.api#documentation": "The targets for the action.
" + } + }, + "startAfter": { + "target": "com.amazonaws.fis#ExperimentTemplateActionStartAfterList", + "traits": { + "smithy.api#documentation": "The name of the action that must be completed before the current action starts. Omit this parameter to run the action at the start of the experiment.
" } - ], - "type": "tree" } - ], - "type": "tree" }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" + "traits": { + "smithy.api#documentation": "Specifies an action for an experiment template.
\nFor more information, see Actions\n in the Fault Injection Service User Guide.
" } - ] }, - "smithy.rules#endpointTests": { - "testCases": [ - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://fis-fips.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://fis-fips.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://fis.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://fis.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://fis-fips.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": true - } + "com.amazonaws.fis#CreateExperimentTemplateActionInputMap": { + "type": "map", + "key": { + "target": "com.amazonaws.fis#ExperimentTemplateActionName" }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://fis-fips.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://fis.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://fis.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://fis.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": false - } + "value": { + "target": "com.amazonaws.fis#CreateExperimentTemplateActionInput" + } + }, + "com.amazonaws.fis#CreateExperimentTemplateExperimentOptionsInput": { + "type": "structure", + "members": { + "accountTargeting": { + "target": "com.amazonaws.fis#AccountTargeting", + "traits": { + "smithy.api#documentation": "Specifies the account targeting setting for experiment options.
" + } + }, + "emptyTargetResolutionMode": { + "target": "com.amazonaws.fis#EmptyTargetResolutionMode", + "traits": { + "smithy.api#documentation": "Specifies the empty target resolution mode for experiment options.
" + } + } }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://fis.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": false - } + "traits": { + "smithy.api#documentation": "Specifies experiment options for an experiment template.
" + } + }, + "com.amazonaws.fis#CreateExperimentTemplateLogConfigurationInput": { + "type": "structure", + "members": { + "cloudWatchLogsConfiguration": { + "target": "com.amazonaws.fis#ExperimentTemplateCloudWatchLogsLogConfigurationInput", + "traits": { + "smithy.api#documentation": "The configuration for experiment logging to Amazon CloudWatch Logs.
" + } + }, + "s3Configuration": { + "target": "com.amazonaws.fis#ExperimentTemplateS3LogConfigurationInput", + "traits": { + "smithy.api#documentation": "The configuration for experiment logging to Amazon S3.
" + } + }, + "logSchemaVersion": { + "target": "com.amazonaws.fis#LogSchemaVersion", + "traits": { + "smithy.api#documentation": "The schema version.
", + "smithy.api#required": {} + } + } }, - { - "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://fis.us-gov-west-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-west-1", - "UseFIPS": false, - "UseDualStack": false - } + "traits": { + "smithy.api#documentation": "Specifies the configuration for experiment logging.
" + } + }, + "com.amazonaws.fis#CreateExperimentTemplateRequest": { + "type": "structure", + "members": { + "clientToken": { + "target": "com.amazonaws.fis#ClientToken", + "traits": { + "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.fis#ExperimentTemplateDescription", + "traits": { + "smithy.api#documentation": "A description for the experiment template.
", + "smithy.api#required": {} + } + }, + "stopConditions": { + "target": "com.amazonaws.fis#CreateExperimentTemplateStopConditionInputList", + "traits": { + "smithy.api#documentation": "The stop conditions.
", + "smithy.api#required": {} + } + }, + "targets": { + "target": "com.amazonaws.fis#CreateExperimentTemplateTargetInputMap", + "traits": { + "smithy.api#documentation": "The targets for the experiment.
" + } + }, + "actions": { + "target": "com.amazonaws.fis#CreateExperimentTemplateActionInputMap", + "traits": { + "smithy.api#documentation": "The actions for the experiment.
", + "smithy.api#required": {} + } + }, + "roleArn": { + "target": "com.amazonaws.fis#RoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that grants the FIS service permission to perform service actions on your behalf.
", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.fis#TagMap", + "traits": { + "smithy.api#documentation": "The tags to apply to the experiment template.
" + } + }, + "logConfiguration": { + "target": "com.amazonaws.fis#CreateExperimentTemplateLogConfigurationInput", + "traits": { + "smithy.api#documentation": "The configuration for experiment logging.
" + } + }, + "experimentOptions": { + "target": "com.amazonaws.fis#CreateExperimentTemplateExperimentOptionsInput", + "traits": { + "smithy.api#documentation": "The experiment options for the experiment template.
" + } + } }, - { - "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://fis.us-gov-west-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-west-1", - "UseFIPS": true, - "UseDualStack": false - } + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.fis#CreateExperimentTemplateResponse": { + "type": "structure", + "members": { + "experimentTemplate": { + "target": "com.amazonaws.fis#ExperimentTemplate", + "traits": { + "smithy.api#documentation": "Information about the experiment template.
" + } + } }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://fis-fips.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": true - } + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.fis#CreateExperimentTemplateStopConditionInput": { + "type": "structure", + "members": { + "source": { + "target": "com.amazonaws.fis#StopConditionSource", + "traits": { + "smithy.api#documentation": "The source for the stop condition. Specify aws:cloudwatch:alarm if the stop\n condition is defined by a CloudWatch alarm. Specify none if there is no stop\n condition.
The Amazon Resource Name (ARN) of the CloudWatch alarm. This is required if the source is\n a CloudWatch alarm.
" + } + } }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://fis.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": true - } + "traits": { + "smithy.api#documentation": "Specifies a stop condition for an experiment template.
" + } + }, + "com.amazonaws.fis#CreateExperimentTemplateStopConditionInputList": { + "type": "list", + "member": { + "target": "com.amazonaws.fis#CreateExperimentTemplateStopConditionInput" + } + }, + "com.amazonaws.fis#CreateExperimentTemplateTargetInput": { + "type": "structure", + "members": { + "resourceType": { + "target": "com.amazonaws.fis#TargetResourceTypeId", + "traits": { + "smithy.api#documentation": "The resource type. The resource type must be supported for the specified action.
", + "smithy.api#required": {} + } + }, + "resourceArns": { + "target": "com.amazonaws.fis#ResourceArnList", + "traits": { + "smithy.api#documentation": "The Amazon Resource Names (ARNs) of the resources.
" + } + }, + "resourceTags": { + "target": "com.amazonaws.fis#TagMap", + "traits": { + "smithy.api#documentation": "The tags for the target resources.
" + } + }, + "filters": { + "target": "com.amazonaws.fis#ExperimentTemplateTargetFilterInputList", + "traits": { + "smithy.api#documentation": "The filters to apply to identify target resources using specific attributes.
" + } + }, + "selectionMode": { + "target": "com.amazonaws.fis#ExperimentTemplateTargetSelectionMode", + "traits": { + "smithy.api#documentation": "Scopes the identified resources to a specific count of the resources at random, or a percentage of the resources. All identified resources are included in the target.
\nALL - Run the action on all identified targets. This is the default.
\nCOUNT(n) - Run the action on the specified number of targets, chosen from the identified targets at random.\n For example, COUNT(1) selects one of the targets.
\nPERCENT(n) - Run the action on the specified percentage of targets, chosen from the identified targets \n at random. For example, PERCENT(25) selects 25% of the targets.
\nThe resource type parameters.
" + } + } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } + "traits": { + "smithy.api#documentation": "Specifies a target for an experiment. You must specify at least one Amazon Resource Name (ARN) or \n at least one resource tag. You cannot specify both ARNs and tags.
\nFor more information, see Targets\n in the Fault Injection Service User Guide.
" + } + }, + "com.amazonaws.fis#CreateExperimentTemplateTargetInputMap": { + "type": "map", + "key": { + "target": "com.amazonaws.fis#ExperimentTemplateTargetName" }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://fis-fips.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": false - } + "value": { + "target": "com.amazonaws.fis#CreateExperimentTemplateTargetInput" + } + }, + "com.amazonaws.fis#CreateTargetAccountConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.fis#CreateTargetAccountConfigurationRequest" }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } + "output": { + "target": "com.amazonaws.fis#CreateTargetAccountConfigurationResponse" }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://fis.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": false - } + "errors": [ + { + "target": "com.amazonaws.fis#ConflictException" + }, + { + "target": "com.amazonaws.fis#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.fis#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.fis#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a target account configuration for the experiment template. A target account configuration\n is required when accountTargeting of experimentOptions is set to multi-account.\n For more information, see experiment options\n in the Fault Injection Service User Guide.\n
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
", + "smithy.api#idempotencyToken": {} + } + }, + "experimentTemplateId": { + "target": "com.amazonaws.fis#ExperimentTemplateId", + "traits": { + "smithy.api#documentation": "The experiment template ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "accountId": { + "target": "com.amazonaws.fis#TargetAccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID of the target account.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "roleArn": { + "target": "com.amazonaws.fis#RoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role for the target account.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.fis#TargetAccountConfigurationDescription", + "traits": { + "smithy.api#documentation": "The description of the target account.
" + } + } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.fis#CreateTargetAccountConfigurationResponse": { + "type": "structure", + "members": { + "targetAccountConfiguration": { + "target": "com.amazonaws.fis#TargetAccountConfiguration", + "traits": { + "smithy.api#documentation": "Information about the target account configuration.
" + } + } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://fis-fips.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": false - } + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.fis#CreationTime": { + "type": "timestamp" + }, + "com.amazonaws.fis#DeleteExperimentTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.fis#DeleteExperimentTemplateRequest" }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } + "output": { + "target": "com.amazonaws.fis#DeleteExperimentTemplateResponse" }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://fis.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": false - } + "errors": [ + { + "target": "com.amazonaws.fis#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.fis#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes the specified experiment template.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/experimentTemplates/{id}", + "code": 200 + } + } + }, + "com.amazonaws.fis#DeleteExperimentTemplateRequest": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.fis#ExperimentTemplateId", + "traits": { + "smithy.api#documentation": "The ID of the experiment template.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } }, - { - "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" - } + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.fis#DeleteExperimentTemplateResponse": { + "type": "structure", + "members": { + "experimentTemplate": { + "target": "com.amazonaws.fis#ExperimentTemplate", + "traits": { + "smithy.api#documentation": "Information about the experiment template.
" + } + } }, - { - "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" - } + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.fis#DeleteTargetAccountConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.fis#DeleteTargetAccountConfigurationRequest" }, - { - "documentation": "For custom endpoint with fips enabled and dualstack disabled", - "expect": { - "error": "Invalid Configuration: FIPS and custom endpoint are not supported" - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": false, - "Endpoint": "https://example.com" - } + "output": { + "target": "com.amazonaws.fis#DeleteTargetAccountConfigurationResponse" }, - { - "documentation": "For custom endpoint with fips disabled and dualstack enabled", - "expect": { - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true, - "Endpoint": "https://example.com" - } + "errors": [ + { + "target": "com.amazonaws.fis#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.fis#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes the specified target account configuration of the experiment template.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/experimentTemplates/{experimentTemplateId}/targetAccountConfigurations/{accountId}", + "code": 200 + } + } + }, + "com.amazonaws.fis#DeleteTargetAccountConfigurationRequest": { + "type": "structure", + "members": { + "experimentTemplateId": { + "target": "com.amazonaws.fis#ExperimentTemplateId", + "traits": { + "smithy.api#documentation": "The ID of the experiment template.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "accountId": { + "target": "com.amazonaws.fis#TargetAccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID of the target account.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } }, - { - "documentation": "Missing region", - "expect": { - "error": "Invalid Configuration: Missing Region" - } + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.fis#DeleteTargetAccountConfigurationResponse": { + "type": "structure", + "members": { + "targetAccountConfiguration": { + "target": "com.amazonaws.fis#TargetAccountConfiguration", + "traits": { + "smithy.api#documentation": "Information about the target account configuration.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.fis#EmptyTargetResolutionMode": { + "type": "enum", + "members": { + "FAIL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "fail" + } + }, + "SKIP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "skip" + } + } + } + }, + "com.amazonaws.fis#ExceptionMessage": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": "^[\\s\\S]+$" + } + }, + "com.amazonaws.fis#Experiment": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.fis#ExperimentId", + "traits": { + "smithy.api#documentation": "The ID of the experiment.
" + } + }, + "arn": { + "target": "com.amazonaws.fis#ResourceArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the experiment.
" + } + }, + "experimentTemplateId": { + "target": "com.amazonaws.fis#ExperimentTemplateId", + "traits": { + "smithy.api#documentation": "The ID of the experiment template.
" + } + }, + "roleArn": { + "target": "com.amazonaws.fis#RoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that grants the FIS service permission to perform service actions on your behalf.
" + } + }, + "state": { + "target": "com.amazonaws.fis#ExperimentState", + "traits": { + "smithy.api#documentation": "The state of the experiment.
" + } + }, + "targets": { + "target": "com.amazonaws.fis#ExperimentTargetMap", + "traits": { + "smithy.api#documentation": "The targets for the experiment.
" + } + }, + "actions": { + "target": "com.amazonaws.fis#ExperimentActionMap", + "traits": { + "smithy.api#documentation": "The actions for the experiment.
" + } + }, + "stopConditions": { + "target": "com.amazonaws.fis#ExperimentStopConditionList", + "traits": { + "smithy.api#documentation": "The stop conditions for the experiment.
" + } + }, + "creationTime": { + "target": "com.amazonaws.fis#CreationTime", + "traits": { + "smithy.api#documentation": "The time that the experiment was created.
" + } + }, + "startTime": { + "target": "com.amazonaws.fis#ExperimentStartTime", + "traits": { + "smithy.api#documentation": "The time that the experiment started.
" + } + }, + "endTime": { + "target": "com.amazonaws.fis#ExperimentEndTime", + "traits": { + "smithy.api#documentation": "The time that the experiment ended.
" + } + }, + "tags": { + "target": "com.amazonaws.fis#TagMap", + "traits": { + "smithy.api#documentation": "The tags for the experiment.
" + } + }, + "logConfiguration": { + "target": "com.amazonaws.fis#ExperimentLogConfiguration", + "traits": { + "smithy.api#documentation": "The configuration for experiment logging.
" + } + }, + "experimentOptions": { + "target": "com.amazonaws.fis#ExperimentOptions", + "traits": { + "smithy.api#documentation": "The experiment options for the experiment.
" + } + }, + "targetAccountConfigurationsCount": { + "target": "com.amazonaws.fis#TargetAccountConfigurationsCount", + "traits": { + "smithy.api#documentation": "The count of target account configurations for the experiment.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes an experiment.
" + } + }, + "com.amazonaws.fis#ExperimentAction": { + "type": "structure", + "members": { + "actionId": { + "target": "com.amazonaws.fis#ActionId", + "traits": { + "smithy.api#documentation": "The ID of the action.
" + } + }, + "description": { + "target": "com.amazonaws.fis#ExperimentActionDescription", + "traits": { + "smithy.api#documentation": "The description for the action.
" + } + }, + "parameters": { + "target": "com.amazonaws.fis#ExperimentActionParameterMap", + "traits": { + "smithy.api#documentation": "The parameters for the action.
" + } + }, + "targets": { + "target": "com.amazonaws.fis#ExperimentActionTargetMap", + "traits": { + "smithy.api#documentation": "The targets for the action.
" + } + }, + "startAfter": { + "target": "com.amazonaws.fis#ExperimentActionStartAfterList", + "traits": { + "smithy.api#documentation": "The name of the action that must be completed before this action starts.
" + } + }, + "state": { + "target": "com.amazonaws.fis#ExperimentActionState", + "traits": { + "smithy.api#documentation": "The state of the action.
" + } + }, + "startTime": { + "target": "com.amazonaws.fis#ExperimentActionStartTime", + "traits": { + "smithy.api#documentation": "The time that the action started.
" + } + }, + "endTime": { + "target": "com.amazonaws.fis#ExperimentActionEndTime", + "traits": { + "smithy.api#documentation": "The time that the action ended.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the action for an experiment.
" + } + }, + "com.amazonaws.fis#ExperimentActionDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": "^[\\s\\S]+$" + } + }, + "com.amazonaws.fis#ExperimentActionEndTime": { + "type": "timestamp" + }, + "com.amazonaws.fis#ExperimentActionMap": { + "type": "map", + "key": { + "target": "com.amazonaws.fis#ExperimentActionName" + }, + "value": { + "target": "com.amazonaws.fis#ExperimentAction" + } + }, + "com.amazonaws.fis#ExperimentActionName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 64 + }, + "smithy.api#pattern": "^[\\S]+$" + } + }, + "com.amazonaws.fis#ExperimentActionParameter": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": "^[\\S]+$" + } + }, + "com.amazonaws.fis#ExperimentActionParameterMap": { + "type": "map", + "key": { + "target": "com.amazonaws.fis#ExperimentActionParameterName" + }, + "value": { + "target": "com.amazonaws.fis#ExperimentActionParameter" + } + }, + "com.amazonaws.fis#ExperimentActionParameterName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 64 + }, + "smithy.api#pattern": "^[\\S]+$" + } + }, + "com.amazonaws.fis#ExperimentActionStartAfter": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 64 + }, + "smithy.api#pattern": "^[\\S]+$" + } + }, + "com.amazonaws.fis#ExperimentActionStartAfterList": { + "type": "list", + "member": { + "target": "com.amazonaws.fis#ExperimentActionStartAfter" + } + }, + "com.amazonaws.fis#ExperimentActionStartTime": { + "type": "timestamp" + }, + "com.amazonaws.fis#ExperimentActionState": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.fis#ExperimentActionStatus", + "traits": { + "smithy.api#documentation": "The state of the action.
" + } + }, + "reason": { + "target": "com.amazonaws.fis#ExperimentActionStatusReason", + "traits": { + "smithy.api#documentation": "The reason for the state.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the state of an action.
" + } + }, + "com.amazonaws.fis#ExperimentActionStatus": { + "type": "enum", + "members": { + "pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending" + } + }, + "initiating": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "initiating" + } + }, + "running": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "running" + } + }, + "completed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "completed" + } + }, + "cancelled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cancelled" + } + }, + "stopping": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "stopping" + } + }, + "stopped": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "stopped" + } + }, + "failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failed" + } + }, + "skipped": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "skipped" + } + } + } + }, + "com.amazonaws.fis#ExperimentActionStatusReason": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": "^[\\s\\S]+$" + } + }, + "com.amazonaws.fis#ExperimentActionTargetMap": { + "type": "map", + "key": { + "target": "com.amazonaws.fis#ExperimentActionTargetName" + }, + "value": { + "target": "com.amazonaws.fis#ExperimentTargetName" + } + }, + "com.amazonaws.fis#ExperimentActionTargetName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 64 + }, + "smithy.api#pattern": "^[\\S]+$" + } + }, + "com.amazonaws.fis#ExperimentCloudWatchLogsLogConfiguration": { + "type": "structure", + "members": { + "logGroupArn": { + "target": "com.amazonaws.fis#CloudWatchLogGroupArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the destination Amazon CloudWatch Logs log group.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the configuration for experiment logging to Amazon CloudWatch Logs.
" + } + }, + "com.amazonaws.fis#ExperimentEndTime": { + "type": "timestamp" + }, + "com.amazonaws.fis#ExperimentError": { + "type": "structure", + "members": { + "accountId": { + "target": "com.amazonaws.fis#ExperimentErrorAccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services Account ID where the experiment failure occurred.
" + } + }, + "code": { + "target": "com.amazonaws.fis#ExperimentErrorCode", + "traits": { + "smithy.api#documentation": "The error code for the failed experiment.
" + } + }, + "location": { + "target": "com.amazonaws.fis#ExperimentErrorLocation", + "traits": { + "smithy.api#documentation": "Context for the section of the experiment template that failed.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the error when an experiment has failed.
The configuration for experiment logging to Amazon CloudWatch Logs.
" + } + }, + "s3Configuration": { + "target": "com.amazonaws.fis#ExperimentS3LogConfiguration", + "traits": { + "smithy.api#documentation": "The configuration for experiment logging to Amazon S3.
" + } + }, + "logSchemaVersion": { + "target": "com.amazonaws.fis#LogSchemaVersion", + "traits": { + "smithy.api#documentation": "The schema version.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the configuration for experiment logging.
" + } + }, + "com.amazonaws.fis#ExperimentOptions": { + "type": "structure", + "members": { + "accountTargeting": { + "target": "com.amazonaws.fis#AccountTargeting", + "traits": { + "smithy.api#documentation": "The account targeting setting for an experiment.
" + } + }, + "emptyTargetResolutionMode": { + "target": "com.amazonaws.fis#EmptyTargetResolutionMode", + "traits": { + "smithy.api#documentation": "The empty target resolution mode for an experiment.
" + } + }, + "actionsMode": { + "target": "com.amazonaws.fis#ActionsMode", + "traits": { + "smithy.api#documentation": "The actions mode of the experiment that is set from the StartExperiment API command.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the options for an experiment.
" + } + }, + "com.amazonaws.fis#ExperimentS3LogConfiguration": { + "type": "structure", + "members": { + "bucketName": { + "target": "com.amazonaws.fis#S3BucketName", + "traits": { + "smithy.api#documentation": "The name of the destination bucket.
" + } + }, + "prefix": { + "target": "com.amazonaws.fis#S3ObjectKey", + "traits": { + "smithy.api#documentation": "The bucket prefix.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the configuration for experiment logging to Amazon S3.
" + } + }, + "com.amazonaws.fis#ExperimentStartTime": { + "type": "timestamp" + }, + "com.amazonaws.fis#ExperimentState": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.fis#ExperimentStatus", + "traits": { + "smithy.api#documentation": "The state of the experiment.
" + } + }, + "reason": { + "target": "com.amazonaws.fis#ExperimentStatusReason", + "traits": { + "smithy.api#documentation": "The reason for the state.
" + } + }, + "error": { + "target": "com.amazonaws.fis#ExperimentError", + "traits": { + "smithy.api#documentation": "The error information of the experiment when the action has failed.
Describes the state of an experiment.
" + } + }, + "com.amazonaws.fis#ExperimentStatus": { + "type": "enum", + "members": { + "pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending" + } + }, + "initiating": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "initiating" + } + }, + "running": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "running" + } + }, + "completed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "completed" + } + }, + "stopping": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "stopping" + } + }, + "stopped": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "stopped" + } + }, + "failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failed" + } + }, + "cancelled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cancelled" + } + } + } + }, + "com.amazonaws.fis#ExperimentStatusReason": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": "^[\\s\\S]+$" + } + }, + "com.amazonaws.fis#ExperimentStopCondition": { + "type": "structure", + "members": { + "source": { + "target": "com.amazonaws.fis#StopConditionSource", + "traits": { + "smithy.api#documentation": "The source for the stop condition.
" + } + }, + "value": { + "target": "com.amazonaws.fis#StopConditionValue", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the CloudWatch alarm, if applicable.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the stop condition for an experiment.
" + } + }, + "com.amazonaws.fis#ExperimentStopConditionList": { + "type": "list", + "member": { + "target": "com.amazonaws.fis#ExperimentStopCondition" + } + }, + "com.amazonaws.fis#ExperimentSummary": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.fis#ExperimentId", + "traits": { + "smithy.api#documentation": "The ID of the experiment.
" + } + }, + "arn": { + "target": "com.amazonaws.fis#ResourceArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the experiment.
" + } + }, + "experimentTemplateId": { + "target": "com.amazonaws.fis#ExperimentTemplateId", + "traits": { + "smithy.api#documentation": "The ID of the experiment template.
" + } + }, + "state": { + "target": "com.amazonaws.fis#ExperimentState", + "traits": { + "smithy.api#documentation": "The state of the experiment.
" + } + }, + "creationTime": { + "target": "com.amazonaws.fis#CreationTime", + "traits": { + "smithy.api#documentation": "The time that the experiment was created.
" + } + }, + "tags": { + "target": "com.amazonaws.fis#TagMap", + "traits": { + "smithy.api#documentation": "The tags for the experiment.
" + } + }, + "experimentOptions": { + "target": "com.amazonaws.fis#ExperimentOptions", + "traits": { + "smithy.api#documentation": "The experiment options for the experiment.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides a summary of an experiment.
" + } + }, + "com.amazonaws.fis#ExperimentSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.fis#ExperimentSummary" + } + }, + "com.amazonaws.fis#ExperimentTarget": { + "type": "structure", + "members": { + "resourceType": { + "target": "com.amazonaws.fis#TargetResourceTypeId", + "traits": { + "smithy.api#documentation": "The resource type.
" + } + }, + "resourceArns": { + "target": "com.amazonaws.fis#ResourceArnList", + "traits": { + "smithy.api#documentation": "The Amazon Resource Names (ARNs) of the resources.
" + } + }, + "resourceTags": { + "target": "com.amazonaws.fis#TagMap", + "traits": { + "smithy.api#documentation": "The tags for the target resources.
" + } + }, + "filters": { + "target": "com.amazonaws.fis#ExperimentTargetFilterList", + "traits": { + "smithy.api#documentation": "The filters to apply to identify target resources using specific attributes.
" + } + }, + "selectionMode": { + "target": "com.amazonaws.fis#ExperimentTargetSelectionMode", + "traits": { + "smithy.api#documentation": "Scopes the identified resources to a specific count or percentage.
" + } + }, + "parameters": { + "target": "com.amazonaws.fis#ExperimentTargetParameterMap", + "traits": { + "smithy.api#documentation": "The resource type parameters.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes a target for an experiment.
" + } + }, + "com.amazonaws.fis#ExperimentTargetAccountConfiguration": { + "type": "structure", + "members": { + "roleArn": { + "target": "com.amazonaws.fis#RoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role for the target account.
" + } + }, + "accountId": { + "target": "com.amazonaws.fis#TargetAccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID of the target account.
" + } + }, + "description": { + "target": "com.amazonaws.fis#TargetAccountConfigurationDescription", + "traits": { + "smithy.api#documentation": "The description of the target account.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes a target account configuration for an experiment.
" + } + }, + "com.amazonaws.fis#ExperimentTargetAccountConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.fis#ExperimentTargetAccountConfigurationSummary" + } + }, + "com.amazonaws.fis#ExperimentTargetAccountConfigurationSummary": { + "type": "structure", + "members": { + "roleArn": { + "target": "com.amazonaws.fis#RoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role for the target account.
" + } + }, + "accountId": { + "target": "com.amazonaws.fis#TargetAccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID of the target account.
" + } + }, + "description": { + "target": "com.amazonaws.fis#TargetAccountConfigurationDescription", + "traits": { + "smithy.api#documentation": "The description of the target account.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides a summary of a target account configuration.
" + } + }, + "com.amazonaws.fis#ExperimentTargetFilter": { + "type": "structure", + "members": { + "path": { + "target": "com.amazonaws.fis#ExperimentTargetFilterPath", + "traits": { + "smithy.api#documentation": "The attribute path for the filter.
" + } + }, + "values": { + "target": "com.amazonaws.fis#ExperimentTargetFilterValues", + "traits": { + "smithy.api#documentation": "The attribute values for the filter.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes a filter used for the target resources in an experiment.
" + } + }, + "com.amazonaws.fis#ExperimentTargetFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.fis#ExperimentTargetFilter" + } + }, + "com.amazonaws.fis#ExperimentTargetFilterPath": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^[\\S]+$" + } + }, + "com.amazonaws.fis#ExperimentTargetFilterValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 128 + }, + "smithy.api#pattern": "^[\\S]+$" + } + }, + "com.amazonaws.fis#ExperimentTargetFilterValues": { + "type": "list", + "member": { + "target": "com.amazonaws.fis#ExperimentTargetFilterValue" + } + }, + "com.amazonaws.fis#ExperimentTargetMap": { + "type": "map", + "key": { + "target": "com.amazonaws.fis#ExperimentTargetName" + }, + "value": { + "target": "com.amazonaws.fis#ExperimentTarget" + } + }, + "com.amazonaws.fis#ExperimentTargetName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 64 + }, + "smithy.api#pattern": "^[\\S]+$" + } + }, + "com.amazonaws.fis#ExperimentTargetParameterMap": { + "type": "map", + "key": { + "target": "com.amazonaws.fis#ExperimentTargetParameterName" + }, + "value": { + "target": "com.amazonaws.fis#ExperimentTargetParameterValue" + } + }, + "com.amazonaws.fis#ExperimentTargetParameterName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 64 + }, + "smithy.api#pattern": "^[\\S]+$" + } + }, + "com.amazonaws.fis#ExperimentTargetParameterValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.fis#ExperimentTargetSelectionMode": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 64 + }, + "smithy.api#pattern": "^[\\S]+$" + } + }, + "com.amazonaws.fis#ExperimentTemplate": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.fis#ExperimentTemplateId", + "traits": { + "smithy.api#documentation": "The ID of the experiment template.
" + } + }, + "arn": { + "target": "com.amazonaws.fis#ResourceArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the experiment template.
" + } + }, + "description": { + "target": "com.amazonaws.fis#ExperimentTemplateDescription", + "traits": { + "smithy.api#documentation": "The description for the experiment template.
" + } + }, + "targets": { + "target": "com.amazonaws.fis#ExperimentTemplateTargetMap", + "traits": { + "smithy.api#documentation": "The targets for the experiment.
" + } + }, + "actions": { + "target": "com.amazonaws.fis#ExperimentTemplateActionMap", + "traits": { + "smithy.api#documentation": "The actions for the experiment.
" + } + }, + "stopConditions": { + "target": "com.amazonaws.fis#ExperimentTemplateStopConditionList", + "traits": { + "smithy.api#documentation": "The stop conditions for the experiment.
" + } + }, + "creationTime": { + "target": "com.amazonaws.fis#CreationTime", + "traits": { + "smithy.api#documentation": "The time the experiment template was created.
" + } + }, + "lastUpdateTime": { + "target": "com.amazonaws.fis#LastUpdateTime", + "traits": { + "smithy.api#documentation": "The time the experiment template was last updated.
" + } + }, + "roleArn": { + "target": "com.amazonaws.fis#RoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role.
" + } + }, + "tags": { + "target": "com.amazonaws.fis#TagMap", + "traits": { + "smithy.api#documentation": "The tags for the experiment template.
" + } + }, + "logConfiguration": { + "target": "com.amazonaws.fis#ExperimentTemplateLogConfiguration", + "traits": { + "smithy.api#documentation": "The configuration for experiment logging.
" + } + }, + "experimentOptions": { + "target": "com.amazonaws.fis#ExperimentTemplateExperimentOptions", + "traits": { + "smithy.api#documentation": "The experiment options for an experiment template.
" + } + }, + "targetAccountConfigurationsCount": { + "target": "com.amazonaws.fis#TargetAccountConfigurationsCount", + "traits": { + "smithy.api#documentation": "The count of target account configurations for the experiment template.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes an experiment template.
" + } + }, + "com.amazonaws.fis#ExperimentTemplateAction": { + "type": "structure", + "members": { + "actionId": { + "target": "com.amazonaws.fis#ActionId", + "traits": { + "smithy.api#documentation": "The ID of the action.
" + } + }, + "description": { + "target": "com.amazonaws.fis#ExperimentTemplateActionDescription", + "traits": { + "smithy.api#documentation": "A description for the action.
" + } + }, + "parameters": { + "target": "com.amazonaws.fis#ExperimentTemplateActionParameterMap", + "traits": { + "smithy.api#documentation": "The parameters for the action.
" + } + }, + "targets": { + "target": "com.amazonaws.fis#ExperimentTemplateActionTargetMap", + "traits": { + "smithy.api#documentation": "The targets for the action.
" + } + }, + "startAfter": { + "target": "com.amazonaws.fis#ExperimentTemplateActionStartAfterList", + "traits": { + "smithy.api#documentation": "The name of the action that must be completed before the current action starts.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes an action for an experiment template.
" + } + }, + "com.amazonaws.fis#ExperimentTemplateActionDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": "^[\\s\\S]+$" + } + }, + "com.amazonaws.fis#ExperimentTemplateActionMap": { + "type": "map", + "key": { + "target": "com.amazonaws.fis#ExperimentTemplateActionName" + }, + "value": { + "target": "com.amazonaws.fis#ExperimentTemplateAction" + } + }, + "com.amazonaws.fis#ExperimentTemplateActionName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 64 + }, + "smithy.api#pattern": "^[\\S]+$" + } + }, + "com.amazonaws.fis#ExperimentTemplateActionParameter": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": "^[\\S]+$" + } + }, + "com.amazonaws.fis#ExperimentTemplateActionParameterMap": { + "type": "map", + "key": { + "target": "com.amazonaws.fis#ExperimentTemplateActionParameterName" + }, + "value": { + "target": "com.amazonaws.fis#ExperimentTemplateActionParameter" + } + }, + "com.amazonaws.fis#ExperimentTemplateActionParameterName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 64 + }, + "smithy.api#pattern": "^[\\S]+$" + } + }, + "com.amazonaws.fis#ExperimentTemplateActionStartAfter": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 64 + }, + "smithy.api#pattern": "^[\\S]+$" + } + }, + "com.amazonaws.fis#ExperimentTemplateActionStartAfterList": { + "type": "list", + "member": { + "target": "com.amazonaws.fis#ExperimentTemplateActionStartAfter" + } + }, + "com.amazonaws.fis#ExperimentTemplateActionTargetMap": { + "type": "map", + "key": { + "target": "com.amazonaws.fis#ExperimentTemplateActionTargetName" + }, + "value": { + "target": "com.amazonaws.fis#ExperimentTemplateTargetName" + } + }, + "com.amazonaws.fis#ExperimentTemplateActionTargetName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 64 + }, + "smithy.api#pattern": "^[\\S]+$" + } + }, + "com.amazonaws.fis#ExperimentTemplateCloudWatchLogsLogConfiguration": { + "type": "structure", + "members": { + "logGroupArn": { + "target": "com.amazonaws.fis#CloudWatchLogGroupArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the destination Amazon CloudWatch Logs log group.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the configuration for experiment logging to Amazon CloudWatch Logs.
" + } + }, + "com.amazonaws.fis#ExperimentTemplateCloudWatchLogsLogConfigurationInput": { + "type": "structure", + "members": { + "logGroupArn": { + "target": "com.amazonaws.fis#CloudWatchLogGroupArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the destination Amazon CloudWatch Logs log group.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies the configuration for experiment logging to Amazon CloudWatch Logs.
" + } + }, + "com.amazonaws.fis#ExperimentTemplateDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": "^[\\s\\S]+$" + } + }, + "com.amazonaws.fis#ExperimentTemplateExperimentOptions": { + "type": "structure", + "members": { + "accountTargeting": { + "target": "com.amazonaws.fis#AccountTargeting", + "traits": { + "smithy.api#documentation": "The account targeting setting for an experiment template.
" + } + }, + "emptyTargetResolutionMode": { + "target": "com.amazonaws.fis#EmptyTargetResolutionMode", + "traits": { + "smithy.api#documentation": "The empty target resolution mode for an experiment template.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the experiment options for an experiment template.
" + } + }, + "com.amazonaws.fis#ExperimentTemplateId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 64 + }, + "smithy.api#pattern": "^[\\S]+$" + } + }, + "com.amazonaws.fis#ExperimentTemplateLogConfiguration": { + "type": "structure", + "members": { + "cloudWatchLogsConfiguration": { + "target": "com.amazonaws.fis#ExperimentTemplateCloudWatchLogsLogConfiguration", + "traits": { + "smithy.api#documentation": "The configuration for experiment logging to Amazon CloudWatch Logs.
" + } + }, + "s3Configuration": { + "target": "com.amazonaws.fis#ExperimentTemplateS3LogConfiguration", + "traits": { + "smithy.api#documentation": "The configuration for experiment logging to Amazon S3.
" + } + }, + "logSchemaVersion": { + "target": "com.amazonaws.fis#LogSchemaVersion", + "traits": { + "smithy.api#documentation": "The schema version.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the configuration for experiment logging.
" + } + }, + "com.amazonaws.fis#ExperimentTemplateS3LogConfiguration": { + "type": "structure", + "members": { + "bucketName": { + "target": "com.amazonaws.fis#S3BucketName", + "traits": { + "smithy.api#documentation": "The name of the destination bucket.
" + } + }, + "prefix": { + "target": "com.amazonaws.fis#S3ObjectKey", + "traits": { + "smithy.api#documentation": "The bucket prefix.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the configuration for experiment logging to Amazon S3.
" + } + }, + "com.amazonaws.fis#ExperimentTemplateS3LogConfigurationInput": { + "type": "structure", + "members": { + "bucketName": { + "target": "com.amazonaws.fis#S3BucketName", + "traits": { + "smithy.api#documentation": "The name of the destination bucket.
", + "smithy.api#required": {} + } + }, + "prefix": { + "target": "com.amazonaws.fis#S3ObjectKey", + "traits": { + "smithy.api#documentation": "The bucket prefix.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies the configuration for experiment logging to Amazon S3.
" + } + }, + "com.amazonaws.fis#ExperimentTemplateStopCondition": { + "type": "structure", + "members": { + "source": { + "target": "com.amazonaws.fis#StopConditionSource", + "traits": { + "smithy.api#documentation": "The source for the stop condition.
" + } + }, + "value": { + "target": "com.amazonaws.fis#StopConditionValue", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the CloudWatch alarm, if applicable.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes a stop condition for an experiment template.
" + } + }, + "com.amazonaws.fis#ExperimentTemplateStopConditionList": { + "type": "list", + "member": { + "target": "com.amazonaws.fis#ExperimentTemplateStopCondition" + } + }, + "com.amazonaws.fis#ExperimentTemplateSummary": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.fis#ExperimentTemplateId", + "traits": { + "smithy.api#documentation": "The ID of the experiment template.
" + } + }, + "arn": { + "target": "com.amazonaws.fis#ResourceArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the experiment template.
" + } + }, + "description": { + "target": "com.amazonaws.fis#ExperimentTemplateDescription", + "traits": { + "smithy.api#documentation": "The description of the experiment template.
" + } + }, + "creationTime": { + "target": "com.amazonaws.fis#CreationTime", + "traits": { + "smithy.api#documentation": "The time that the experiment template was created.
" + } + }, + "lastUpdateTime": { + "target": "com.amazonaws.fis#LastUpdateTime", + "traits": { + "smithy.api#documentation": "The time that the experiment template was last updated.
" + } + }, + "tags": { + "target": "com.amazonaws.fis#TagMap", + "traits": { + "smithy.api#documentation": "The tags for the experiment template.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides a summary of an experiment template.
" + } + }, + "com.amazonaws.fis#ExperimentTemplateSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.fis#ExperimentTemplateSummary" + } + }, + "com.amazonaws.fis#ExperimentTemplateTarget": { + "type": "structure", + "members": { + "resourceType": { + "target": "com.amazonaws.fis#TargetResourceTypeId", + "traits": { + "smithy.api#documentation": "The resource type.
" + } + }, + "resourceArns": { + "target": "com.amazonaws.fis#ResourceArnList", + "traits": { + "smithy.api#documentation": "The Amazon Resource Names (ARNs) of the targets.
" + } + }, + "resourceTags": { + "target": "com.amazonaws.fis#TagMap", + "traits": { + "smithy.api#documentation": "The tags for the target resources.
" + } + }, + "filters": { + "target": "com.amazonaws.fis#ExperimentTemplateTargetFilterList", + "traits": { + "smithy.api#documentation": "The filters to apply to identify target resources using specific attributes.
" + } + }, + "selectionMode": { + "target": "com.amazonaws.fis#ExperimentTemplateTargetSelectionMode", + "traits": { + "smithy.api#documentation": "Scopes the identified resources to a specific count or percentage.
" + } + }, + "parameters": { + "target": "com.amazonaws.fis#ExperimentTemplateTargetParameterMap", + "traits": { + "smithy.api#documentation": "The resource type parameters.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes a target for an experiment template.
" + } + }, + "com.amazonaws.fis#ExperimentTemplateTargetFilter": { + "type": "structure", + "members": { + "path": { + "target": "com.amazonaws.fis#ExperimentTemplateTargetFilterPath", + "traits": { + "smithy.api#documentation": "The attribute path for the filter.
" + } + }, + "values": { + "target": "com.amazonaws.fis#ExperimentTemplateTargetFilterValues", + "traits": { + "smithy.api#documentation": "The attribute values for the filter.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes a filter used for the target resources in an experiment template.
" + } + }, + "com.amazonaws.fis#ExperimentTemplateTargetFilterInputList": { + "type": "list", + "member": { + "target": "com.amazonaws.fis#ExperimentTemplateTargetInputFilter" + } + }, + "com.amazonaws.fis#ExperimentTemplateTargetFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.fis#ExperimentTemplateTargetFilter" + } + }, + "com.amazonaws.fis#ExperimentTemplateTargetFilterPath": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^[\\S]+$" + } + }, + "com.amazonaws.fis#ExperimentTemplateTargetFilterValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 128 + }, + "smithy.api#pattern": "^[\\S]+$" + } + }, + "com.amazonaws.fis#ExperimentTemplateTargetFilterValues": { + "type": "list", + "member": { + "target": "com.amazonaws.fis#ExperimentTemplateTargetFilterValue" + } + }, + "com.amazonaws.fis#ExperimentTemplateTargetInputFilter": { + "type": "structure", + "members": { + "path": { + "target": "com.amazonaws.fis#ExperimentTemplateTargetFilterPath", + "traits": { + "smithy.api#documentation": "The attribute path for the filter.
", + "smithy.api#required": {} + } + }, + "values": { + "target": "com.amazonaws.fis#ExperimentTemplateTargetFilterValues", + "traits": { + "smithy.api#documentation": "The attribute values for the filter.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies a filter used for the target resource input in an experiment template.
\nFor more information, see Resource filters\n in the Fault Injection Service User Guide.
" + } + }, + "com.amazonaws.fis#ExperimentTemplateTargetMap": { + "type": "map", + "key": { + "target": "com.amazonaws.fis#ExperimentTemplateTargetName" + }, + "value": { + "target": "com.amazonaws.fis#ExperimentTemplateTarget" + } + }, + "com.amazonaws.fis#ExperimentTemplateTargetName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 64 + }, + "smithy.api#pattern": "^[\\S]+$" + } + }, + "com.amazonaws.fis#ExperimentTemplateTargetParameterMap": { + "type": "map", + "key": { + "target": "com.amazonaws.fis#ExperimentTemplateTargetParameterName" + }, + "value": { + "target": "com.amazonaws.fis#ExperimentTemplateTargetParameterValue" + } + }, + "com.amazonaws.fis#ExperimentTemplateTargetParameterName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 64 + }, + "smithy.api#pattern": "^[\\S]+$" + } + }, + "com.amazonaws.fis#ExperimentTemplateTargetParameterValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^[\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]+$" + } + }, + "com.amazonaws.fis#ExperimentTemplateTargetSelectionMode": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 64 + }, + "smithy.api#pattern": "^[\\S]+$" + } + }, + "com.amazonaws.fis#FaultInjectionSimulator": { + "type": "service", + "version": "2020-12-01", + "operations": [ + { + "target": "com.amazonaws.fis#CreateExperimentTemplate" + }, + { + "target": "com.amazonaws.fis#CreateTargetAccountConfiguration" + }, + { + "target": "com.amazonaws.fis#DeleteExperimentTemplate" + }, + { + "target": "com.amazonaws.fis#DeleteTargetAccountConfiguration" + }, + { + "target": "com.amazonaws.fis#GetAction" + }, + { + "target": "com.amazonaws.fis#GetExperiment" + }, + { + "target": "com.amazonaws.fis#GetExperimentTargetAccountConfiguration" + }, + { + "target": "com.amazonaws.fis#GetExperimentTemplate" + }, + { + "target": "com.amazonaws.fis#GetSafetyLever" + }, + { + "target": "com.amazonaws.fis#GetTargetAccountConfiguration" + }, + { + "target": "com.amazonaws.fis#GetTargetResourceType" + }, + { + "target": "com.amazonaws.fis#ListActions" + }, + { + "target": "com.amazonaws.fis#ListExperimentResolvedTargets" + }, + { + "target": "com.amazonaws.fis#ListExperiments" + }, + { + "target": "com.amazonaws.fis#ListExperimentTargetAccountConfigurations" + }, + { + "target": "com.amazonaws.fis#ListExperimentTemplates" + }, + { + "target": "com.amazonaws.fis#ListTagsForResource" + }, + { + "target": "com.amazonaws.fis#ListTargetAccountConfigurations" + }, + { + "target": "com.amazonaws.fis#ListTargetResourceTypes" + }, + { + "target": "com.amazonaws.fis#StartExperiment" + }, + { + "target": "com.amazonaws.fis#StopExperiment" + }, + { + "target": "com.amazonaws.fis#TagResource" + }, + { + "target": "com.amazonaws.fis#UntagResource" + }, + { + "target": "com.amazonaws.fis#UpdateExperimentTemplate" + }, + { + "target": "com.amazonaws.fis#UpdateSafetyLeverState" + }, + { + "target": "com.amazonaws.fis#UpdateTargetAccountConfiguration" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "fis", + "arnNamespace": "fis", + "cloudFormationName": "Fis", + "cloudTrailEventSource": "fis.amazonaws.com", + "endpointPrefix": "fis" + }, + "aws.auth#sigv4": { + "name": "fis" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "Amazon Web Services Fault Injection Service is a managed service that enables you to perform fault injection \n experiments on your Amazon Web Services workloads. For more information, see the Fault Injection Service User Guide.
", + "smithy.api#title": "AWS Fault Injection Simulator", + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://fis-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws-us-gov" + ] + } + ], + "endpoint": { + "url": "https://fis.{Region}.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://fis-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://fis.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "endpoint": { + "url": "https://fis.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://fis-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://fis-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://fis.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://fis.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://fis-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://fis-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://fis.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://fis.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://fis.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://fis.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://fis.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://fis.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://fis-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://fis.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://fis-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://fis.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://fis-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://fis.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } + } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.fis#GetAction": { + "type": "operation", + "input": { + "target": "com.amazonaws.fis#GetActionRequest" + }, + "output": { + "target": "com.amazonaws.fis#GetActionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.fis#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.fis#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets information about the specified FIS action.
", + "smithy.api#http": { + "method": "GET", + "uri": "/actions/{id}", + "code": 200 + } + } + }, + "com.amazonaws.fis#GetActionRequest": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.fis#ActionId", + "traits": { + "smithy.api#documentation": "The ID of the action.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.fis#GetActionResponse": { + "type": "structure", + "members": { + "action": { + "target": "com.amazonaws.fis#Action", + "traits": { + "smithy.api#documentation": "Information about the action.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.fis#GetExperiment": { + "type": "operation", + "input": { + "target": "com.amazonaws.fis#GetExperimentRequest" + }, + "output": { + "target": "com.amazonaws.fis#GetExperimentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.fis#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.fis#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets information about the specified experiment.
", + "smithy.api#http": { + "method": "GET", + "uri": "/experiments/{id}", + "code": 200 + } + } + }, + "com.amazonaws.fis#GetExperimentRequest": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.fis#ExperimentId", + "traits": { + "smithy.api#documentation": "The ID of the experiment.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.fis#GetExperimentResponse": { + "type": "structure", + "members": { + "experiment": { + "target": "com.amazonaws.fis#Experiment", + "traits": { + "smithy.api#documentation": "Information about the experiment.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.fis#GetExperimentTargetAccountConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.fis#GetExperimentTargetAccountConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.fis#GetExperimentTargetAccountConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.fis#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.fis#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets information about the specified target account configuration of the experiment.
", + "smithy.api#http": { + "method": "GET", + "uri": "/experiments/{experimentId}/targetAccountConfigurations/{accountId}", + "code": 200 + } + } + }, + "com.amazonaws.fis#GetExperimentTargetAccountConfigurationRequest": { + "type": "structure", + "members": { + "experimentId": { + "target": "com.amazonaws.fis#ExperimentId", + "traits": { + "smithy.api#documentation": "The ID of the experiment.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "accountId": { + "target": "com.amazonaws.fis#TargetAccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID of the target account.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.fis#GetExperimentTargetAccountConfigurationResponse": { + "type": "structure", + "members": { + "targetAccountConfiguration": { + "target": "com.amazonaws.fis#ExperimentTargetAccountConfiguration", + "traits": { + "smithy.api#documentation": "Information about the target account configuration.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.fis#GetExperimentTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.fis#GetExperimentTemplateRequest" + }, + "output": { + "target": "com.amazonaws.fis#GetExperimentTemplateResponse" + }, + "errors": [ + { + "target": "com.amazonaws.fis#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.fis#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets information about the specified experiment template.
", + "smithy.api#http": { + "method": "GET", + "uri": "/experimentTemplates/{id}", + "code": 200 + } + } + }, + "com.amazonaws.fis#GetExperimentTemplateRequest": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.fis#ExperimentTemplateId", + "traits": { + "smithy.api#documentation": "The ID of the experiment template.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.fis#GetExperimentTemplateResponse": { + "type": "structure", + "members": { + "experimentTemplate": { + "target": "com.amazonaws.fis#ExperimentTemplate", + "traits": { + "smithy.api#documentation": "Information about the experiment template.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.fis#GetSafetyLever": { + "type": "operation", + "input": { + "target": "com.amazonaws.fis#GetSafetyLeverRequest" + }, + "output": { + "target": "com.amazonaws.fis#GetSafetyLeverResponse" + }, + "errors": [ + { + "target": "com.amazonaws.fis#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "\n Gets information about the specified safety lever.\n
", + "smithy.api#http": { + "method": "GET", + "uri": "/safetyLevers/{id}", + "code": 200 + } + } + }, + "com.amazonaws.fis#GetSafetyLeverRequest": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.fis#SafetyLeverId", + "traits": { + "smithy.api#documentation": "\n The ID of the safety lever.\n
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.fis#GetSafetyLeverResponse": { + "type": "structure", + "members": { + "safetyLever": { + "target": "com.amazonaws.fis#SafetyLever", + "traits": { + "smithy.api#documentation": "\n Information about the safety lever.\n
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.fis#GetTargetAccountConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.fis#GetTargetAccountConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.fis#GetTargetAccountConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.fis#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.fis#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets information about the specified target account configuration of the experiment template.
", + "smithy.api#http": { + "method": "GET", + "uri": "/experimentTemplates/{experimentTemplateId}/targetAccountConfigurations/{accountId}", + "code": 200 + } + } + }, + "com.amazonaws.fis#GetTargetAccountConfigurationRequest": { + "type": "structure", + "members": { + "experimentTemplateId": { + "target": "com.amazonaws.fis#ExperimentTemplateId", + "traits": { + "smithy.api#documentation": "The ID of the experiment template.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "accountId": { + "target": "com.amazonaws.fis#TargetAccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID of the target account.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.fis#GetTargetAccountConfigurationResponse": { + "type": "structure", + "members": { + "targetAccountConfiguration": { + "target": "com.amazonaws.fis#TargetAccountConfiguration", + "traits": { + "smithy.api#documentation": "Information about the target account configuration.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.fis#GetTargetResourceType": { + "type": "operation", + "input": { + "target": "com.amazonaws.fis#GetTargetResourceTypeRequest" + }, + "output": { + "target": "com.amazonaws.fis#GetTargetResourceTypeResponse" + }, + "errors": [ + { + "target": "com.amazonaws.fis#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.fis#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets information about the specified resource type.
", + "smithy.api#http": { + "method": "GET", + "uri": "/targetResourceTypes/{resourceType}", + "code": 200 + } + } + }, + "com.amazonaws.fis#GetTargetResourceTypeRequest": { + "type": "structure", + "members": { + "resourceType": { + "target": "com.amazonaws.fis#TargetResourceTypeId", + "traits": { + "smithy.api#documentation": "The resource type.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.fis#GetTargetResourceTypeResponse": { + "type": "structure", + "members": { + "targetResourceType": { + "target": "com.amazonaws.fis#TargetResourceType", + "traits": { + "smithy.api#documentation": "Information about the resource type.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.fis#LastUpdateTime": { + "type": "timestamp" + }, + "com.amazonaws.fis#ListActions": { + "type": "operation", + "input": { + "target": "com.amazonaws.fis#ListActionsRequest" + }, + "output": { + "target": "com.amazonaws.fis#ListActionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.fis#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the available FIS actions.
", + "smithy.api#http": { + "method": "GET", + "uri": "/actions", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.fis#ListActionsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.fis#ListActionsRequest": { + "type": "structure", + "members": { + "maxResults": { + "target": "com.amazonaws.fis#ListActionsMaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
The token for the next page of results.
", + "smithy.api#httpQuery": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.fis#ListActionsResponse": { + "type": "structure", + "members": { + "actions": { + "target": "com.amazonaws.fis#ActionSummaryList", + "traits": { + "smithy.api#documentation": "The actions.
" + } + }, + "nextToken": { + "target": "com.amazonaws.fis#NextToken", + "traits": { + "smithy.api#documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Lists the resolved targets information of the specified experiment.
", + "smithy.api#http": { + "method": "GET", + "uri": "/experiments/{experimentId}/resolvedTargets", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.fis#ListExperimentResolvedTargetsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.fis#ListExperimentResolvedTargetsRequest": { + "type": "structure", + "members": { + "experimentId": { + "target": "com.amazonaws.fis#ExperimentId", + "traits": { + "smithy.api#documentation": "The ID of the experiment.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.fis#ListExperimentResolvedTargetsMaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return with a single call. To retrieve the remaining results, \n make another call with the returned nextToken value.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "nextToken": { + "target": "com.amazonaws.fis#NextToken", + "traits": { + "smithy.api#documentation": "The token for the next page of results.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "targetName": { + "target": "com.amazonaws.fis#TargetName", + "traits": { + "smithy.api#documentation": "The name of the target.
", + "smithy.api#httpQuery": "targetName" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.fis#ListExperimentResolvedTargetsResponse": { + "type": "structure", + "members": { + "resolvedTargets": { + "target": "com.amazonaws.fis#ResolvedTargetList", + "traits": { + "smithy.api#documentation": "The resolved targets.
" + } + }, + "nextToken": { + "target": "com.amazonaws.fis#NextToken", + "traits": { + "smithy.api#documentation": "The token to use to retrieve the next page of results. \n This value is null when there are no more results to return.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.fis#ListExperimentTargetAccountConfigurations": { + "type": "operation", + "input": { + "target": "com.amazonaws.fis#ListExperimentTargetAccountConfigurationsRequest" + }, + "output": { + "target": "com.amazonaws.fis#ListExperimentTargetAccountConfigurationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.fis#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.fis#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the target account configurations of the specified experiment.
", + "smithy.api#http": { + "method": "GET", + "uri": "/experiments/{experimentId}/targetAccountConfigurations", + "code": 200 + } + } + }, + "com.amazonaws.fis#ListExperimentTargetAccountConfigurationsRequest": { + "type": "structure", + "members": { + "experimentId": { + "target": "com.amazonaws.fis#ExperimentId", + "traits": { + "smithy.api#documentation": "The ID of the experiment.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.fis#NextToken", + "traits": { + "smithy.api#documentation": "The token for the next page of results.
", + "smithy.api#httpQuery": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.fis#ListExperimentTargetAccountConfigurationsResponse": { + "type": "structure", + "members": { + "targetAccountConfigurations": { + "target": "com.amazonaws.fis#ExperimentTargetAccountConfigurationList", + "traits": { + "smithy.api#documentation": "The target account configurations.
" + } + }, + "nextToken": { + "target": "com.amazonaws.fis#NextToken", + "traits": { + "smithy.api#documentation": "The token to use to retrieve the next page of results. \n This value is null when there are no more results to return.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.fis#ListExperimentTemplates": { + "type": "operation", + "input": { + "target": "com.amazonaws.fis#ListExperimentTemplatesRequest" + }, + "output": { + "target": "com.amazonaws.fis#ListExperimentTemplatesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.fis#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists your experiment templates.
", + "smithy.api#http": { + "method": "GET", + "uri": "/experimentTemplates", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.fis#ListExperimentTemplatesMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.fis#ListExperimentTemplatesRequest": { + "type": "structure", + "members": { + "maxResults": { + "target": "com.amazonaws.fis#ListExperimentTemplatesMaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
The token for the next page of results.
", + "smithy.api#httpQuery": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.fis#ListExperimentTemplatesResponse": { + "type": "structure", + "members": { + "experimentTemplates": { + "target": "com.amazonaws.fis#ExperimentTemplateSummaryList", + "traits": { + "smithy.api#documentation": "The experiment templates.
" + } + }, + "nextToken": { + "target": "com.amazonaws.fis#NextToken", + "traits": { + "smithy.api#documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Lists your experiments.
", + "smithy.api#http": { + "method": "GET", + "uri": "/experiments", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.fis#ListExperimentsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.fis#ListExperimentsRequest": { + "type": "structure", + "members": { + "maxResults": { + "target": "com.amazonaws.fis#ListExperimentsMaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
The token for the next page of results.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "experimentTemplateId": { + "target": "com.amazonaws.fis#ExperimentTemplateId", + "traits": { + "smithy.api#documentation": "The ID of the experiment template.
", + "smithy.api#httpQuery": "experimentTemplateId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.fis#ListExperimentsResponse": { + "type": "structure", + "members": { + "experiments": { + "target": "com.amazonaws.fis#ExperimentSummaryList", + "traits": { + "smithy.api#documentation": "The experiments.
" + } + }, + "nextToken": { + "target": "com.amazonaws.fis#NextToken", + "traits": { + "smithy.api#documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Lists the tags for the specified resource.
", + "smithy.api#http": { + "method": "GET", + "uri": "/tags/{resourceArn}", + "code": 200 + } + } + }, + "com.amazonaws.fis#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.fis#ResourceArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.fis#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "tags": { + "target": "com.amazonaws.fis#TagMap", + "traits": { + "smithy.api#documentation": "The tags for the resource.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.fis#ListTargetAccountConfigurations": { + "type": "operation", + "input": { + "target": "com.amazonaws.fis#ListTargetAccountConfigurationsRequest" + }, + "output": { + "target": "com.amazonaws.fis#ListTargetAccountConfigurationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.fis#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.fis#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the target account configurations of the specified experiment template.
", + "smithy.api#http": { + "method": "GET", + "uri": "/experimentTemplates/{experimentTemplateId}/targetAccountConfigurations", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.fis#ListTargetAccountConfigurationsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.fis#ListTargetAccountConfigurationsRequest": { + "type": "structure", + "members": { + "experimentTemplateId": { + "target": "com.amazonaws.fis#ExperimentTemplateId", + "traits": { + "smithy.api#documentation": "The ID of the experiment template.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.fis#ListTargetAccountConfigurationsMaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return with a single call. To retrieve the remaining results, \n make another call with the returned nextToken value.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "nextToken": { + "target": "com.amazonaws.fis#NextToken", + "traits": { + "smithy.api#documentation": "The token for the next page of results.
", + "smithy.api#httpQuery": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.fis#ListTargetAccountConfigurationsResponse": { + "type": "structure", + "members": { + "targetAccountConfigurations": { + "target": "com.amazonaws.fis#TargetAccountConfigurationList", + "traits": { + "smithy.api#documentation": "The target account configurations.
" + } + }, + "nextToken": { + "target": "com.amazonaws.fis#NextToken", + "traits": { + "smithy.api#documentation": "The token to use to retrieve the next page of results. \n This value is null when there are no more results to return.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.fis#ListTargetResourceTypes": { + "type": "operation", + "input": { + "target": "com.amazonaws.fis#ListTargetResourceTypesRequest" + }, + "output": { + "target": "com.amazonaws.fis#ListTargetResourceTypesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.fis#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the target resource types.
", + "smithy.api#http": { + "method": "GET", + "uri": "/targetResourceTypes", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.fis#ListTargetResourceTypesMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.fis#ListTargetResourceTypesRequest": { + "type": "structure", + "members": { + "maxResults": { + "target": "com.amazonaws.fis#ListTargetResourceTypesMaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
The token for the next page of results.
", + "smithy.api#httpQuery": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.fis#ListTargetResourceTypesResponse": { + "type": "structure", + "members": { + "targetResourceTypes": { + "target": "com.amazonaws.fis#TargetResourceTypeSummaryList", + "traits": { + "smithy.api#documentation": "The target resource types.
" + } + }, + "nextToken": { + "target": "com.amazonaws.fis#NextToken", + "traits": { + "smithy.api#documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The resource type of the target.
" + } + }, + "targetName": { + "target": "com.amazonaws.fis#TargetName", + "traits": { + "smithy.api#documentation": "The name of the target.
" + } + }, + "targetInformation": { + "target": "com.amazonaws.fis#TargetInformationMap", + "traits": { + "smithy.api#documentation": "Information about the target.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes a resolved target.
" + } + }, + "com.amazonaws.fis#ResolvedTargetList": { + "type": "list", + "member": { + "target": "com.amazonaws.fis#ResolvedTarget" + } + }, + "com.amazonaws.fis#ResourceArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^[\\S]+$" + } + }, + "com.amazonaws.fis#ResourceArnList": { + "type": "list", + "member": { + "target": "com.amazonaws.fis#ResourceArn" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5 + } + } + }, + "com.amazonaws.fis#ResourceNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.fis#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ResourceNotFoundException", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "The specified resource cannot be found.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.fis#RoleArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^[\\S]+$" + } + }, + "com.amazonaws.fis#S3BucketName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 63 + }, + "smithy.api#pattern": "^[\\S]+$" + } + }, + "com.amazonaws.fis#S3ObjectKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^[\\s\\S]+$" + } + }, + "com.amazonaws.fis#SafetyLever": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.fis#SafetyLeverId", + "traits": { + "smithy.api#documentation": "\n The ID of the safety lever.\n
" + } + }, + "arn": { + "target": "com.amazonaws.fis#ResourceArn", + "traits": { + "smithy.api#documentation": "\n The Amazon Resource Name (ARN) of the safety lever.\n
" + } + }, + "state": { + "target": "com.amazonaws.fis#SafetyLeverState", + "traits": { + "smithy.api#documentation": "\n The state of the safety lever.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n Describes a safety lever.\n
" + } + }, + "com.amazonaws.fis#SafetyLeverId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 64 + }, + "smithy.api#pattern": "^[\\S]+$" + } + }, + "com.amazonaws.fis#SafetyLeverState": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.fis#SafetyLeverStatus", + "traits": { + "smithy.api#documentation": "\n The state of the safety lever.\n
" + } + }, + "reason": { + "target": "com.amazonaws.fis#SafetyLeverStatusReason", + "traits": { + "smithy.api#documentation": "\n The reason for the state of the safety lever.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n Describes the state of the safety lever.\n
" + } + }, + "com.amazonaws.fis#SafetyLeverStatus": { + "type": "enum", + "members": { + "DISENGAGED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disengaged" + } + }, + "ENGAGED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "engaged" + } + }, + "ENGAGING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "engaging" + } + } + } + }, + "com.amazonaws.fis#SafetyLeverStatusInput": { + "type": "enum", + "members": { + "DISENGAGED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disengaged" + } + }, + "ENGAGED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "engaged" + } + } + } + }, + "com.amazonaws.fis#SafetyLeverStatusReason": { + "type": "string" + }, + "com.amazonaws.fis#ServiceQuotaExceededException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.fis#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ServiceQuotaExceededException", + "httpResponseCode": 402 + }, + "smithy.api#documentation": "You have exceeded your service quota.
", + "smithy.api#error": "client", + "smithy.api#httpError": 402 + } + }, + "com.amazonaws.fis#StartExperiment": { + "type": "operation", + "input": { + "target": "com.amazonaws.fis#StartExperimentRequest" + }, + "output": { + "target": "com.amazonaws.fis#StartExperimentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.fis#ConflictException" + }, + { + "target": "com.amazonaws.fis#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.fis#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.fis#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Starts running an experiment from the specified experiment template.
", + "smithy.api#http": { + "method": "POST", + "uri": "/experiments", + "code": 200 + } + } + }, + "com.amazonaws.fis#StartExperimentExperimentOptionsInput": { + "type": "structure", + "members": { + "actionsMode": { + "target": "com.amazonaws.fis#ActionsMode", + "traits": { + "smithy.api#documentation": "Specifies the actions mode for experiment options.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies experiment options for running an experiment.
" + } + }, + "com.amazonaws.fis#StartExperimentRequest": { + "type": "structure", + "members": { + "clientToken": { + "target": "com.amazonaws.fis#ClientToken", + "traits": { + "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + }, + "experimentTemplateId": { + "target": "com.amazonaws.fis#ExperimentTemplateId", + "traits": { + "smithy.api#documentation": "The ID of the experiment template.
", + "smithy.api#required": {} + } + }, + "experimentOptions": { + "target": "com.amazonaws.fis#StartExperimentExperimentOptionsInput", + "traits": { + "smithy.api#documentation": "The experiment options for running the experiment.
" + } + }, + "tags": { + "target": "com.amazonaws.fis#TagMap", + "traits": { + "smithy.api#documentation": "The tags to apply to the experiment.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.fis#StartExperimentResponse": { + "type": "structure", + "members": { + "experiment": { + "target": "com.amazonaws.fis#Experiment", + "traits": { + "smithy.api#documentation": "Information about the experiment.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.fis#StopConditionSource": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 64 + }, + "smithy.api#pattern": "^[\\S]+$" + } + }, + "com.amazonaws.fis#StopConditionValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^[\\s\\S]+$" + } + }, + "com.amazonaws.fis#StopExperiment": { + "type": "operation", + "input": { + "target": "com.amazonaws.fis#StopExperimentRequest" + }, + "output": { + "target": "com.amazonaws.fis#StopExperimentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.fis#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.fis#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Stops the specified experiment.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/experiments/{id}", + "code": 200 + } + } + }, + "com.amazonaws.fis#StopExperimentRequest": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.fis#ExperimentId", + "traits": { + "smithy.api#documentation": "The ID of the experiment.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.fis#StopExperimentResponse": { + "type": "structure", + "members": { + "experiment": { + "target": "com.amazonaws.fis#Experiment", + "traits": { + "smithy.api#documentation": "Information about the experiment.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.fis#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 128 + }, + "smithy.api#pattern": "^[\\s\\S]+$" + } + }, + "com.amazonaws.fis#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.fis#TagKey" + } + }, + "com.amazonaws.fis#TagMap": { + "type": "map", + "key": { + "target": "com.amazonaws.fis#TagKey" + }, + "value": { + "target": "com.amazonaws.fis#TagValue" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.fis#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.fis#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.fis#TagResourceResponse" + }, + "traits": { + "smithy.api#documentation": "Applies the specified tags to the specified resource.
", + "smithy.api#http": { + "method": "POST", + "uri": "/tags/{resourceArn}", + "code": 200 + } + } + }, + "com.amazonaws.fis#TagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.fis#ResourceArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.fis#TagMap", + "traits": { + "smithy.api#documentation": "The tags for the resource.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.fis#TagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.fis#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^[\\s\\S]*$" + } + }, + "com.amazonaws.fis#TargetAccountConfiguration": { + "type": "structure", + "members": { + "roleArn": { + "target": "com.amazonaws.fis#RoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role for the target account.
" + } + }, + "accountId": { + "target": "com.amazonaws.fis#TargetAccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID of the target account.
" + } + }, + "description": { + "target": "com.amazonaws.fis#TargetAccountConfigurationDescription", + "traits": { + "smithy.api#documentation": "The description of the target account.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes a target account configuration.
" + } + }, + "com.amazonaws.fis#TargetAccountConfigurationDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": "^[\\s\\S]*$" + } + }, + "com.amazonaws.fis#TargetAccountConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.fis#TargetAccountConfigurationSummary" + } + }, + "com.amazonaws.fis#TargetAccountConfigurationSummary": { + "type": "structure", + "members": { + "roleArn": { + "target": "com.amazonaws.fis#RoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role for the target account.
" + } + }, + "accountId": { + "target": "com.amazonaws.fis#TargetAccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID of the target account.
" + } + }, + "description": { + "target": "com.amazonaws.fis#TargetAccountConfigurationDescription", + "traits": { + "smithy.api#documentation": "The description of the target account.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides a summary of a target account configuration.
" + } + }, + "com.amazonaws.fis#TargetAccountConfigurationsCount": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.fis#TargetAccountId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 12, + "max": 48 + }, + "smithy.api#pattern": "^[\\S]+$" + } + }, + "com.amazonaws.fis#TargetInformationKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 64 + }, + "smithy.api#pattern": "^[\\S]+$" + } + }, + "com.amazonaws.fis#TargetInformationMap": { + "type": "map", + "key": { + "target": "com.amazonaws.fis#TargetInformationKey" + }, + "value": { + "target": "com.amazonaws.fis#TargetInformationValue" + } + }, + "com.amazonaws.fis#TargetInformationValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + }, + "smithy.api#pattern": "^[\\S]+$" + } + }, + "com.amazonaws.fis#TargetName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 64 + }, + "smithy.api#pattern": "^[\\S]+$" + } + }, + "com.amazonaws.fis#TargetResourceType": { + "type": "structure", + "members": { + "resourceType": { + "target": "com.amazonaws.fis#TargetResourceTypeId", + "traits": { + "smithy.api#documentation": "The resource type.
" + } + }, + "description": { + "target": "com.amazonaws.fis#TargetResourceTypeDescription", + "traits": { + "smithy.api#documentation": "A description of the resource type.
" + } + }, + "parameters": { + "target": "com.amazonaws.fis#TargetResourceTypeParameterMap", + "traits": { + "smithy.api#documentation": "The parameters for the resource type.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes a resource type.
" + } + }, + "com.amazonaws.fis#TargetResourceTypeDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": "^[\\s\\S]+$" + } + }, + "com.amazonaws.fis#TargetResourceTypeId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 128 + }, + "smithy.api#pattern": "^[\\S]+$" + } + }, + "com.amazonaws.fis#TargetResourceTypeParameter": { + "type": "structure", + "members": { + "description": { + "target": "com.amazonaws.fis#TargetResourceTypeParameterDescription", + "traits": { + "smithy.api#documentation": "A description of the parameter.
" + } + }, + "required": { + "target": "com.amazonaws.fis#TargetResourceTypeParameterRequired", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "Indicates whether the parameter is required.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the parameters for a resource type. Use parameters to determine which tasks are\n identified during target resolution.
" + } + }, + "com.amazonaws.fis#TargetResourceTypeParameterDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": "^[\\s\\S]+$" + } + }, + "com.amazonaws.fis#TargetResourceTypeParameterMap": { + "type": "map", + "key": { + "target": "com.amazonaws.fis#TargetResourceTypeParameterName" + }, + "value": { + "target": "com.amazonaws.fis#TargetResourceTypeParameter" + } + }, + "com.amazonaws.fis#TargetResourceTypeParameterName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 64 + }, + "smithy.api#pattern": "^[\\S]+$" + } + }, + "com.amazonaws.fis#TargetResourceTypeParameterRequired": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, + "com.amazonaws.fis#TargetResourceTypeSummary": { + "type": "structure", + "members": { + "resourceType": { + "target": "com.amazonaws.fis#TargetResourceTypeId", + "traits": { + "smithy.api#documentation": "The resource type.
" + } + }, + "description": { + "target": "com.amazonaws.fis#TargetResourceTypeDescription", + "traits": { + "smithy.api#documentation": "A description of the resource type.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes a resource type.
" + } + }, + "com.amazonaws.fis#TargetResourceTypeSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.fis#TargetResourceTypeSummary" + } + }, + "com.amazonaws.fis#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.fis#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.fis#UntagResourceResponse" + }, + "traits": { + "smithy.api#documentation": "Removes the specified tags from the specified resource.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/tags/{resourceArn}", + "code": 200 + } + } + }, + "com.amazonaws.fis#UntagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.fis#ResourceArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tagKeys": { + "target": "com.amazonaws.fis#TagKeyList", + "traits": { + "smithy.api#documentation": "The tag keys to remove.
", + "smithy.api#httpQuery": "tagKeys" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.fis#UntagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.fis#UpdateExperimentTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.fis#UpdateExperimentTemplateRequest" + }, + "output": { + "target": "com.amazonaws.fis#UpdateExperimentTemplateResponse" + }, + "errors": [ + { + "target": "com.amazonaws.fis#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.fis#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.fis#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates the specified experiment template.
", + "smithy.api#http": { + "method": "PATCH", + "uri": "/experimentTemplates/{id}", + "code": 200 + } + } + }, + "com.amazonaws.fis#UpdateExperimentTemplateActionInputItem": { + "type": "structure", + "members": { + "actionId": { + "target": "com.amazonaws.fis#ActionId", + "traits": { + "smithy.api#documentation": "The ID of the action.
" + } + }, + "description": { + "target": "com.amazonaws.fis#ExperimentTemplateActionDescription", + "traits": { + "smithy.api#documentation": "A description for the action.
" + } + }, + "parameters": { + "target": "com.amazonaws.fis#ExperimentTemplateActionParameterMap", + "traits": { + "smithy.api#documentation": "The parameters for the action, if applicable.
" + } + }, + "targets": { + "target": "com.amazonaws.fis#ExperimentTemplateActionTargetMap", + "traits": { + "smithy.api#documentation": "The targets for the action.
" + } + }, + "startAfter": { + "target": "com.amazonaws.fis#ExperimentTemplateActionStartAfterList", + "traits": { + "smithy.api#documentation": "The name of the action that must be completed before the current action starts. Omit this parameter to run the action at the start of the experiment.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies an action for an experiment template.
" + } + }, + "com.amazonaws.fis#UpdateExperimentTemplateActionInputMap": { + "type": "map", + "key": { + "target": "com.amazonaws.fis#ExperimentTemplateActionName" + }, + "value": { + "target": "com.amazonaws.fis#UpdateExperimentTemplateActionInputItem" + } + }, + "com.amazonaws.fis#UpdateExperimentTemplateExperimentOptionsInput": { + "type": "structure", + "members": { + "emptyTargetResolutionMode": { + "target": "com.amazonaws.fis#EmptyTargetResolutionMode", + "traits": { + "smithy.api#documentation": "The empty target resolution mode of the experiment template.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies an experiment option for an experiment template.
" + } + }, + "com.amazonaws.fis#UpdateExperimentTemplateLogConfigurationInput": { + "type": "structure", + "members": { + "cloudWatchLogsConfiguration": { + "target": "com.amazonaws.fis#ExperimentTemplateCloudWatchLogsLogConfigurationInput", + "traits": { + "smithy.api#documentation": "The configuration for experiment logging to Amazon CloudWatch Logs.
" + } + }, + "s3Configuration": { + "target": "com.amazonaws.fis#ExperimentTemplateS3LogConfigurationInput", + "traits": { + "smithy.api#documentation": "The configuration for experiment logging to Amazon S3.
" + } + }, + "logSchemaVersion": { + "target": "com.amazonaws.fis#LogSchemaVersion", + "traits": { + "smithy.api#documentation": "The schema version.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies the configuration for experiment logging.
" + } + }, + "com.amazonaws.fis#UpdateExperimentTemplateRequest": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.fis#ExperimentTemplateId", + "traits": { + "smithy.api#documentation": "The ID of the experiment template.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.fis#ExperimentTemplateDescription", + "traits": { + "smithy.api#documentation": "A description for the template.
" + } + }, + "stopConditions": { + "target": "com.amazonaws.fis#UpdateExperimentTemplateStopConditionInputList", + "traits": { + "smithy.api#documentation": "The stop conditions for the experiment.
" + } + }, + "targets": { + "target": "com.amazonaws.fis#UpdateExperimentTemplateTargetInputMap", + "traits": { + "smithy.api#documentation": "The targets for the experiment.
" + } + }, + "actions": { + "target": "com.amazonaws.fis#UpdateExperimentTemplateActionInputMap", + "traits": { + "smithy.api#documentation": "The actions for the experiment.
" + } + }, + "roleArn": { + "target": "com.amazonaws.fis#RoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that grants the FIS service permission to perform service actions on your behalf.
" + } + }, + "logConfiguration": { + "target": "com.amazonaws.fis#UpdateExperimentTemplateLogConfigurationInput", + "traits": { + "smithy.api#documentation": "The configuration for experiment logging.
" + } + }, + "experimentOptions": { + "target": "com.amazonaws.fis#UpdateExperimentTemplateExperimentOptionsInput", + "traits": { + "smithy.api#documentation": "The experiment options for the experiment template.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.fis#UpdateExperimentTemplateResponse": { + "type": "structure", + "members": { + "experimentTemplate": { + "target": "com.amazonaws.fis#ExperimentTemplate", + "traits": { + "smithy.api#documentation": "Information about the experiment template.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.fis#UpdateExperimentTemplateStopConditionInput": { + "type": "structure", + "members": { + "source": { + "target": "com.amazonaws.fis#StopConditionSource", + "traits": { + "smithy.api#documentation": "The source for the stop condition. Specify aws:cloudwatch:alarm if the stop\n condition is defined by a CloudWatch alarm. Specify none if there is no stop\n condition.
The Amazon Resource Name (ARN) of the CloudWatch alarm.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies a stop condition for an experiment. You can define a stop condition as a CloudWatch alarm.
" + } + }, + "com.amazonaws.fis#UpdateExperimentTemplateStopConditionInputList": { + "type": "list", + "member": { + "target": "com.amazonaws.fis#UpdateExperimentTemplateStopConditionInput" + } + }, + "com.amazonaws.fis#UpdateExperimentTemplateTargetInput": { + "type": "structure", + "members": { + "resourceType": { + "target": "com.amazonaws.fis#TargetResourceTypeId", + "traits": { + "smithy.api#documentation": "The resource type. The resource type must be supported for the specified action.
", + "smithy.api#required": {} + } + }, + "resourceArns": { + "target": "com.amazonaws.fis#ResourceArnList", + "traits": { + "smithy.api#documentation": "The Amazon Resource Names (ARNs) of the targets.
" + } + }, + "resourceTags": { + "target": "com.amazonaws.fis#TagMap", + "traits": { + "smithy.api#documentation": "The tags for the target resources.
" + } + }, + "filters": { + "target": "com.amazonaws.fis#ExperimentTemplateTargetFilterInputList", + "traits": { + "smithy.api#documentation": "The filters to apply to identify target resources using specific attributes.
" + } + }, + "selectionMode": { + "target": "com.amazonaws.fis#ExperimentTemplateTargetSelectionMode", + "traits": { + "smithy.api#documentation": "Scopes the identified resources to a specific count or percentage.
", + "smithy.api#required": {} + } + }, + "parameters": { + "target": "com.amazonaws.fis#ExperimentTemplateTargetParameterMap", + "traits": { + "smithy.api#documentation": "The resource type parameters.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies a target for an experiment. You must specify at least one Amazon Resource Name (ARN) or at least one resource tag. You cannot specify both.
" + } + }, + "com.amazonaws.fis#UpdateExperimentTemplateTargetInputMap": { + "type": "map", + "key": { + "target": "com.amazonaws.fis#ExperimentTemplateTargetName" + }, + "value": { + "target": "com.amazonaws.fis#UpdateExperimentTemplateTargetInput" + } + }, + "com.amazonaws.fis#UpdateSafetyLeverState": { + "type": "operation", + "input": { + "target": "com.amazonaws.fis#UpdateSafetyLeverStateRequest" + }, + "output": { + "target": "com.amazonaws.fis#UpdateSafetyLeverStateResponse" + }, + "errors": [ + { + "target": "com.amazonaws.fis#ConflictException" + }, + { + "target": "com.amazonaws.fis#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.fis#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "\n Updates the specified safety lever state.\n
", + "smithy.api#http": { + "method": "PATCH", + "uri": "/safetyLevers/{id}/state", + "code": 200 + } + } + }, + "com.amazonaws.fis#UpdateSafetyLeverStateInput": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.fis#SafetyLeverStatusInput", + "traits": { + "smithy.api#documentation": "\n The updated state of the safety lever.\n
", + "smithy.api#required": {} + } + }, + "reason": { + "target": "com.amazonaws.fis#SafetyLeverStatusReason", + "traits": { + "smithy.api#documentation": "\n The reason for updating the state of the safety lever.\n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "\n Specifies a state for a safety lever.\n
" + } + }, + "com.amazonaws.fis#UpdateSafetyLeverStateRequest": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.fis#SafetyLeverId", + "traits": { + "smithy.api#documentation": "\n The ID of the safety lever.\n
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "state": { + "target": "com.amazonaws.fis#UpdateSafetyLeverStateInput", + "traits": { + "smithy.api#documentation": "\n The state of the safety lever.\n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.fis#UpdateSafetyLeverStateResponse": { + "type": "structure", + "members": { + "safetyLever": { + "target": "com.amazonaws.fis#SafetyLever", + "traits": { + "smithy.api#documentation": "\n Information about the safety lever.\n
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.fis#UpdateTargetAccountConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.fis#UpdateTargetAccountConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.fis#UpdateTargetAccountConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.fis#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.fis#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates the target account configuration for the specified experiment template.
", + "smithy.api#http": { + "method": "PATCH", + "uri": "/experimentTemplates/{experimentTemplateId}/targetAccountConfigurations/{accountId}", + "code": 200 + } + } + }, + "com.amazonaws.fis#UpdateTargetAccountConfigurationRequest": { + "type": "structure", + "members": { + "experimentTemplateId": { + "target": "com.amazonaws.fis#ExperimentTemplateId", + "traits": { + "smithy.api#documentation": "The ID of the experiment template.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "accountId": { + "target": "com.amazonaws.fis#TargetAccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID of the target account.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "roleArn": { + "target": "com.amazonaws.fis#RoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role for the target account.
" + } + }, + "description": { + "target": "com.amazonaws.fis#TargetAccountConfigurationDescription", + "traits": { + "smithy.api#documentation": "The description of the target account.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.fis#UpdateTargetAccountConfigurationResponse": { + "type": "structure", + "members": { + "targetAccountConfiguration": { + "target": "com.amazonaws.fis#TargetAccountConfiguration", + "traits": { + "smithy.api#documentation": "Information about the target account configuration.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.fis#ValidationException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.fis#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ValidationException", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "The specified input is not valid, or fails to satisfy the constraints for the request.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 } - ], - "version": "1.0" - } - } - }, - "com.amazonaws.fis#GetAction": { - "type": "operation", - "input": { - "target": "com.amazonaws.fis#GetActionRequest" - }, - "output": { - "target": "com.amazonaws.fis#GetActionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.fis#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.fis#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Gets information about the specified FIS action.
", - "smithy.api#http": { - "method": "GET", - "uri": "/actions/{id}", - "code": 200 - } - } - }, - "com.amazonaws.fis#GetActionRequest": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.fis#ActionId", - "traits": { - "smithy.api#documentation": "The ID of the action.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.fis#GetActionResponse": { - "type": "structure", - "members": { - "action": { - "target": "com.amazonaws.fis#Action", - "traits": { - "smithy.api#documentation": "Information about the action.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.fis#GetExperiment": { - "type": "operation", - "input": { - "target": "com.amazonaws.fis#GetExperimentRequest" - }, - "output": { - "target": "com.amazonaws.fis#GetExperimentResponse" - }, - "errors": [ - { - "target": "com.amazonaws.fis#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.fis#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Gets information about the specified experiment.
", - "smithy.api#http": { - "method": "GET", - "uri": "/experiments/{id}", - "code": 200 - } - } - }, - "com.amazonaws.fis#GetExperimentRequest": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.fis#ExperimentId", - "traits": { - "smithy.api#documentation": "The ID of the experiment.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.fis#GetExperimentResponse": { - "type": "structure", - "members": { - "experiment": { - "target": "com.amazonaws.fis#Experiment", - "traits": { - "smithy.api#documentation": "Information about the experiment.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.fis#GetExperimentTargetAccountConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.fis#GetExperimentTargetAccountConfigurationRequest" - }, - "output": { - "target": "com.amazonaws.fis#GetExperimentTargetAccountConfigurationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.fis#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.fis#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Gets information about the specified target account configuration of the experiment.
", - "smithy.api#http": { - "method": "GET", - "uri": "/experiments/{experimentId}/targetAccountConfigurations/{accountId}", - "code": 200 - } - } - }, - "com.amazonaws.fis#GetExperimentTargetAccountConfigurationRequest": { - "type": "structure", - "members": { - "experimentId": { - "target": "com.amazonaws.fis#ExperimentId", - "traits": { - "smithy.api#documentation": "The ID of the experiment.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "accountId": { - "target": "com.amazonaws.fis#TargetAccountId", - "traits": { - "smithy.api#documentation": "The Amazon Web Services account ID of the target account.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.fis#GetExperimentTargetAccountConfigurationResponse": { - "type": "structure", - "members": { - "targetAccountConfiguration": { - "target": "com.amazonaws.fis#ExperimentTargetAccountConfiguration", - "traits": { - "smithy.api#documentation": "Information about the target account configuration.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.fis#GetExperimentTemplate": { - "type": "operation", - "input": { - "target": "com.amazonaws.fis#GetExperimentTemplateRequest" - }, - "output": { - "target": "com.amazonaws.fis#GetExperimentTemplateResponse" - }, - "errors": [ - { - "target": "com.amazonaws.fis#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.fis#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Gets information about the specified experiment template.
", - "smithy.api#http": { - "method": "GET", - "uri": "/experimentTemplates/{id}", - "code": 200 - } - } - }, - "com.amazonaws.fis#GetExperimentTemplateRequest": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.fis#ExperimentTemplateId", - "traits": { - "smithy.api#documentation": "The ID of the experiment template.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.fis#GetExperimentTemplateResponse": { - "type": "structure", - "members": { - "experimentTemplate": { - "target": "com.amazonaws.fis#ExperimentTemplate", - "traits": { - "smithy.api#documentation": "Information about the experiment template.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.fis#GetTargetAccountConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.fis#GetTargetAccountConfigurationRequest" - }, - "output": { - "target": "com.amazonaws.fis#GetTargetAccountConfigurationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.fis#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.fis#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Gets information about the specified target account configuration of the experiment template.
", - "smithy.api#http": { - "method": "GET", - "uri": "/experimentTemplates/{experimentTemplateId}/targetAccountConfigurations/{accountId}", - "code": 200 - } - } - }, - "com.amazonaws.fis#GetTargetAccountConfigurationRequest": { - "type": "structure", - "members": { - "experimentTemplateId": { - "target": "com.amazonaws.fis#ExperimentTemplateId", - "traits": { - "smithy.api#documentation": "The ID of the experiment template.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "accountId": { - "target": "com.amazonaws.fis#TargetAccountId", - "traits": { - "smithy.api#documentation": "The Amazon Web Services account ID of the target account.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.fis#GetTargetAccountConfigurationResponse": { - "type": "structure", - "members": { - "targetAccountConfiguration": { - "target": "com.amazonaws.fis#TargetAccountConfiguration", - "traits": { - "smithy.api#documentation": "Information about the target account configuration.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.fis#GetTargetResourceType": { - "type": "operation", - "input": { - "target": "com.amazonaws.fis#GetTargetResourceTypeRequest" - }, - "output": { - "target": "com.amazonaws.fis#GetTargetResourceTypeResponse" - }, - "errors": [ - { - "target": "com.amazonaws.fis#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.fis#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Gets information about the specified resource type.
", - "smithy.api#http": { - "method": "GET", - "uri": "/targetResourceTypes/{resourceType}", - "code": 200 - } - } - }, - "com.amazonaws.fis#GetTargetResourceTypeRequest": { - "type": "structure", - "members": { - "resourceType": { - "target": "com.amazonaws.fis#TargetResourceTypeId", - "traits": { - "smithy.api#documentation": "The resource type.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.fis#GetTargetResourceTypeResponse": { - "type": "structure", - "members": { - "targetResourceType": { - "target": "com.amazonaws.fis#TargetResourceType", - "traits": { - "smithy.api#documentation": "Information about the resource type.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.fis#LastUpdateTime": { - "type": "timestamp" - }, - "com.amazonaws.fis#ListActions": { - "type": "operation", - "input": { - "target": "com.amazonaws.fis#ListActionsRequest" - }, - "output": { - "target": "com.amazonaws.fis#ListActionsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.fis#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Lists the available FIS actions.
", - "smithy.api#http": { - "method": "GET", - "uri": "/actions", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults" - } - } - }, - "com.amazonaws.fis#ListActionsMaxResults": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.fis#ListActionsRequest": { - "type": "structure", - "members": { - "maxResults": { - "target": "com.amazonaws.fis#ListActionsMaxResults", - "traits": { - "smithy.api#documentation": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
The token for the next page of results.
", - "smithy.api#httpQuery": "nextToken" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.fis#ListActionsResponse": { - "type": "structure", - "members": { - "actions": { - "target": "com.amazonaws.fis#ActionSummaryList", - "traits": { - "smithy.api#documentation": "The actions.
" - } - }, - "nextToken": { - "target": "com.amazonaws.fis#NextToken", - "traits": { - "smithy.api#documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Lists the resolved targets information of the specified experiment.
", - "smithy.api#http": { - "method": "GET", - "uri": "/experiments/{experimentId}/resolvedTargets", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults" - } - } - }, - "com.amazonaws.fis#ListExperimentResolvedTargetsMaxResults": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.fis#ListExperimentResolvedTargetsRequest": { - "type": "structure", - "members": { - "experimentId": { - "target": "com.amazonaws.fis#ExperimentId", - "traits": { - "smithy.api#documentation": "The ID of the experiment.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "maxResults": { - "target": "com.amazonaws.fis#ListExperimentResolvedTargetsMaxResults", - "traits": { - "smithy.api#documentation": "The maximum number of results to return with a single call. To retrieve the remaining results, \n make another call with the returned nextToken value.
", - "smithy.api#httpQuery": "maxResults" - } - }, - "nextToken": { - "target": "com.amazonaws.fis#NextToken", - "traits": { - "smithy.api#documentation": "The token for the next page of results.
", - "smithy.api#httpQuery": "nextToken" - } - }, - "targetName": { - "target": "com.amazonaws.fis#TargetName", - "traits": { - "smithy.api#documentation": "The name of the target.
", - "smithy.api#httpQuery": "targetName" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.fis#ListExperimentResolvedTargetsResponse": { - "type": "structure", - "members": { - "resolvedTargets": { - "target": "com.amazonaws.fis#ResolvedTargetList", - "traits": { - "smithy.api#documentation": "The resolved targets.
" - } - }, - "nextToken": { - "target": "com.amazonaws.fis#NextToken", - "traits": { - "smithy.api#documentation": "The token to use to retrieve the next page of results. \n This value is null when there are no more results to return.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.fis#ListExperimentTargetAccountConfigurations": { - "type": "operation", - "input": { - "target": "com.amazonaws.fis#ListExperimentTargetAccountConfigurationsRequest" - }, - "output": { - "target": "com.amazonaws.fis#ListExperimentTargetAccountConfigurationsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.fis#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.fis#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Lists the target account configurations of the specified experiment.
", - "smithy.api#http": { - "method": "GET", - "uri": "/experiments/{experimentId}/targetAccountConfigurations", - "code": 200 - } - } - }, - "com.amazonaws.fis#ListExperimentTargetAccountConfigurationsRequest": { - "type": "structure", - "members": { - "experimentId": { - "target": "com.amazonaws.fis#ExperimentId", - "traits": { - "smithy.api#documentation": "The ID of the experiment.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "nextToken": { - "target": "com.amazonaws.fis#NextToken", - "traits": { - "smithy.api#documentation": "The token for the next page of results.
", - "smithy.api#httpQuery": "nextToken" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.fis#ListExperimentTargetAccountConfigurationsResponse": { - "type": "structure", - "members": { - "targetAccountConfigurations": { - "target": "com.amazonaws.fis#ExperimentTargetAccountConfigurationList", - "traits": { - "smithy.api#documentation": "The target account configurations.
" - } - }, - "nextToken": { - "target": "com.amazonaws.fis#NextToken", - "traits": { - "smithy.api#documentation": "The token to use to retrieve the next page of results. \n This value is null when there are no more results to return.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.fis#ListExperimentTemplates": { - "type": "operation", - "input": { - "target": "com.amazonaws.fis#ListExperimentTemplatesRequest" - }, - "output": { - "target": "com.amazonaws.fis#ListExperimentTemplatesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.fis#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Lists your experiment templates.
", - "smithy.api#http": { - "method": "GET", - "uri": "/experimentTemplates", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults" - } - } - }, - "com.amazonaws.fis#ListExperimentTemplatesMaxResults": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.fis#ListExperimentTemplatesRequest": { - "type": "structure", - "members": { - "maxResults": { - "target": "com.amazonaws.fis#ListExperimentTemplatesMaxResults", - "traits": { - "smithy.api#documentation": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
The token for the next page of results.
", - "smithy.api#httpQuery": "nextToken" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.fis#ListExperimentTemplatesResponse": { - "type": "structure", - "members": { - "experimentTemplates": { - "target": "com.amazonaws.fis#ExperimentTemplateSummaryList", - "traits": { - "smithy.api#documentation": "The experiment templates.
" - } - }, - "nextToken": { - "target": "com.amazonaws.fis#NextToken", - "traits": { - "smithy.api#documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Lists your experiments.
", - "smithy.api#http": { - "method": "GET", - "uri": "/experiments", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults" - } - } - }, - "com.amazonaws.fis#ListExperimentsMaxResults": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.fis#ListExperimentsRequest": { - "type": "structure", - "members": { - "maxResults": { - "target": "com.amazonaws.fis#ListExperimentsMaxResults", - "traits": { - "smithy.api#documentation": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
The token for the next page of results.
", - "smithy.api#httpQuery": "nextToken" - } - }, - "experimentTemplateId": { - "target": "com.amazonaws.fis#ExperimentTemplateId", - "traits": { - "smithy.api#documentation": "The ID of the experiment template.
", - "smithy.api#httpQuery": "experimentTemplateId" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.fis#ListExperimentsResponse": { - "type": "structure", - "members": { - "experiments": { - "target": "com.amazonaws.fis#ExperimentSummaryList", - "traits": { - "smithy.api#documentation": "The experiments.
" - } - }, - "nextToken": { - "target": "com.amazonaws.fis#NextToken", - "traits": { - "smithy.api#documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Lists the tags for the specified resource.
", - "smithy.api#http": { - "method": "GET", - "uri": "/tags/{resourceArn}", - "code": 200 - } - } - }, - "com.amazonaws.fis#ListTagsForResourceRequest": { - "type": "structure", - "members": { - "resourceArn": { - "target": "com.amazonaws.fis#ResourceArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.fis#ListTagsForResourceResponse": { - "type": "structure", - "members": { - "tags": { - "target": "com.amazonaws.fis#TagMap", - "traits": { - "smithy.api#documentation": "The tags for the resource.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.fis#ListTargetAccountConfigurations": { - "type": "operation", - "input": { - "target": "com.amazonaws.fis#ListTargetAccountConfigurationsRequest" - }, - "output": { - "target": "com.amazonaws.fis#ListTargetAccountConfigurationsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.fis#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.fis#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Lists the target account configurations of the specified experiment template.
", - "smithy.api#http": { - "method": "GET", - "uri": "/experimentTemplates/{experimentTemplateId}/targetAccountConfigurations", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults" - } - } - }, - "com.amazonaws.fis#ListTargetAccountConfigurationsMaxResults": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.fis#ListTargetAccountConfigurationsRequest": { - "type": "structure", - "members": { - "experimentTemplateId": { - "target": "com.amazonaws.fis#ExperimentTemplateId", - "traits": { - "smithy.api#documentation": "The ID of the experiment template.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "maxResults": { - "target": "com.amazonaws.fis#ListTargetAccountConfigurationsMaxResults", - "traits": { - "smithy.api#documentation": "The maximum number of results to return with a single call. To retrieve the remaining results, \n make another call with the returned nextToken value.
", - "smithy.api#httpQuery": "maxResults" - } - }, - "nextToken": { - "target": "com.amazonaws.fis#NextToken", - "traits": { - "smithy.api#documentation": "The token for the next page of results.
", - "smithy.api#httpQuery": "nextToken" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.fis#ListTargetAccountConfigurationsResponse": { - "type": "structure", - "members": { - "targetAccountConfigurations": { - "target": "com.amazonaws.fis#TargetAccountConfigurationList", - "traits": { - "smithy.api#documentation": "The target account configurations.
" - } - }, - "nextToken": { - "target": "com.amazonaws.fis#NextToken", - "traits": { - "smithy.api#documentation": "The token to use to retrieve the next page of results. \n This value is null when there are no more results to return.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.fis#ListTargetResourceTypes": { - "type": "operation", - "input": { - "target": "com.amazonaws.fis#ListTargetResourceTypesRequest" - }, - "output": { - "target": "com.amazonaws.fis#ListTargetResourceTypesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.fis#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Lists the target resource types.
", - "smithy.api#http": { - "method": "GET", - "uri": "/targetResourceTypes", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults" - } - } - }, - "com.amazonaws.fis#ListTargetResourceTypesMaxResults": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.fis#ListTargetResourceTypesRequest": { - "type": "structure", - "members": { - "maxResults": { - "target": "com.amazonaws.fis#ListTargetResourceTypesMaxResults", - "traits": { - "smithy.api#documentation": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
The token for the next page of results.
", - "smithy.api#httpQuery": "nextToken" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.fis#ListTargetResourceTypesResponse": { - "type": "structure", - "members": { - "targetResourceTypes": { - "target": "com.amazonaws.fis#TargetResourceTypeSummaryList", - "traits": { - "smithy.api#documentation": "The target resource types.
" - } - }, - "nextToken": { - "target": "com.amazonaws.fis#NextToken", - "traits": { - "smithy.api#documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The resource type of the target.
" - } - }, - "targetName": { - "target": "com.amazonaws.fis#TargetName", - "traits": { - "smithy.api#documentation": "The name of the target.
" - } - }, - "targetInformation": { - "target": "com.amazonaws.fis#TargetInformationMap", - "traits": { - "smithy.api#documentation": "Information about the target.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Describes a resolved target.
" - } - }, - "com.amazonaws.fis#ResolvedTargetList": { - "type": "list", - "member": { - "target": "com.amazonaws.fis#ResolvedTarget" - } - }, - "com.amazonaws.fis#ResourceArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 20, - "max": 2048 - }, - "smithy.api#pattern": "^[\\S]+$" - } - }, - "com.amazonaws.fis#ResourceArnList": { - "type": "list", - "member": { - "target": "com.amazonaws.fis#ResourceArn" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 5 - } - } - }, - "com.amazonaws.fis#ResourceNotFoundException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.fis#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "ResourceNotFoundException", - "httpResponseCode": 404 - }, - "smithy.api#documentation": "The specified resource cannot be found.
", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.fis#RoleArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 20, - "max": 2048 - }, - "smithy.api#pattern": "^[\\S]+$" - } - }, - "com.amazonaws.fis#S3BucketName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 3, - "max": 63 - }, - "smithy.api#pattern": "^[\\S]+$" - } - }, - "com.amazonaws.fis#S3ObjectKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - }, - "smithy.api#pattern": "^[\\s\\S]+$" - } - }, - "com.amazonaws.fis#ServiceQuotaExceededException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.fis#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "ServiceQuotaExceededException", - "httpResponseCode": 402 - }, - "smithy.api#documentation": "You have exceeded your service quota.
", - "smithy.api#error": "client", - "smithy.api#httpError": 402 - } - }, - "com.amazonaws.fis#StartExperiment": { - "type": "operation", - "input": { - "target": "com.amazonaws.fis#StartExperimentRequest" - }, - "output": { - "target": "com.amazonaws.fis#StartExperimentResponse" - }, - "errors": [ - { - "target": "com.amazonaws.fis#ConflictException" - }, - { - "target": "com.amazonaws.fis#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.fis#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.fis#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Starts running an experiment from the specified experiment template.
", - "smithy.api#http": { - "method": "POST", - "uri": "/experiments", - "code": 200 - } - } - }, - "com.amazonaws.fis#StartExperimentExperimentOptionsInput": { - "type": "structure", - "members": { - "actionsMode": { - "target": "com.amazonaws.fis#ActionsMode", - "traits": { - "smithy.api#documentation": "Specifies the actions mode for experiment options.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Specifies experiment options for running an experiment.
" - } - }, - "com.amazonaws.fis#StartExperimentRequest": { - "type": "structure", - "members": { - "clientToken": { - "target": "com.amazonaws.fis#ClientToken", - "traits": { - "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
", - "smithy.api#idempotencyToken": {}, - "smithy.api#required": {} - } - }, - "experimentTemplateId": { - "target": "com.amazonaws.fis#ExperimentTemplateId", - "traits": { - "smithy.api#documentation": "The ID of the experiment template.
", - "smithy.api#required": {} - } - }, - "experimentOptions": { - "target": "com.amazonaws.fis#StartExperimentExperimentOptionsInput", - "traits": { - "smithy.api#documentation": "The experiment options for running the experiment.
" - } - }, - "tags": { - "target": "com.amazonaws.fis#TagMap", - "traits": { - "smithy.api#documentation": "The tags to apply to the experiment.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.fis#StartExperimentResponse": { - "type": "structure", - "members": { - "experiment": { - "target": "com.amazonaws.fis#Experiment", - "traits": { - "smithy.api#documentation": "Information about the experiment.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.fis#StopConditionSource": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 64 - }, - "smithy.api#pattern": "^[\\S]+$" - } - }, - "com.amazonaws.fis#StopConditionValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 20, - "max": 2048 - }, - "smithy.api#pattern": "^[\\s\\S]+$" - } - }, - "com.amazonaws.fis#StopExperiment": { - "type": "operation", - "input": { - "target": "com.amazonaws.fis#StopExperimentRequest" - }, - "output": { - "target": "com.amazonaws.fis#StopExperimentResponse" - }, - "errors": [ - { - "target": "com.amazonaws.fis#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.fis#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Stops the specified experiment.
", - "smithy.api#http": { - "method": "DELETE", - "uri": "/experiments/{id}", - "code": 200 - } - } - }, - "com.amazonaws.fis#StopExperimentRequest": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.fis#ExperimentId", - "traits": { - "smithy.api#documentation": "The ID of the experiment.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.fis#StopExperimentResponse": { - "type": "structure", - "members": { - "experiment": { - "target": "com.amazonaws.fis#Experiment", - "traits": { - "smithy.api#documentation": "Information about the experiment.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.fis#TagKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 128 - }, - "smithy.api#pattern": "^[\\s\\S]+$" - } - }, - "com.amazonaws.fis#TagKeyList": { - "type": "list", - "member": { - "target": "com.amazonaws.fis#TagKey" - } - }, - "com.amazonaws.fis#TagMap": { - "type": "map", - "key": { - "target": "com.amazonaws.fis#TagKey" - }, - "value": { - "target": "com.amazonaws.fis#TagValue" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 50 - } - } - }, - "com.amazonaws.fis#TagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.fis#TagResourceRequest" - }, - "output": { - "target": "com.amazonaws.fis#TagResourceResponse" - }, - "traits": { - "smithy.api#documentation": "Applies the specified tags to the specified resource.
", - "smithy.api#http": { - "method": "POST", - "uri": "/tags/{resourceArn}", - "code": 200 - } - } - }, - "com.amazonaws.fis#TagResourceRequest": { - "type": "structure", - "members": { - "resourceArn": { - "target": "com.amazonaws.fis#ResourceArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.fis#TagMap", - "traits": { - "smithy.api#documentation": "The tags for the resource.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.fis#TagResourceResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.fis#TagValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - }, - "smithy.api#pattern": "^[\\s\\S]*$" - } - }, - "com.amazonaws.fis#TargetAccountConfiguration": { - "type": "structure", - "members": { - "roleArn": { - "target": "com.amazonaws.fis#RoleArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role for the target account.
" - } - }, - "accountId": { - "target": "com.amazonaws.fis#TargetAccountId", - "traits": { - "smithy.api#documentation": "The Amazon Web Services account ID of the target account.
" - } - }, - "description": { - "target": "com.amazonaws.fis#TargetAccountConfigurationDescription", - "traits": { - "smithy.api#documentation": "The description of the target account.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Describes a target account configuration.
" - } - }, - "com.amazonaws.fis#TargetAccountConfigurationDescription": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 512 - }, - "smithy.api#pattern": "^[\\s\\S]*$" - } - }, - "com.amazonaws.fis#TargetAccountConfigurationList": { - "type": "list", - "member": { - "target": "com.amazonaws.fis#TargetAccountConfigurationSummary" - } - }, - "com.amazonaws.fis#TargetAccountConfigurationSummary": { - "type": "structure", - "members": { - "roleArn": { - "target": "com.amazonaws.fis#RoleArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role for the target account.
" - } - }, - "accountId": { - "target": "com.amazonaws.fis#TargetAccountId", - "traits": { - "smithy.api#documentation": "The Amazon Web Services account ID of the target account.
" - } - }, - "description": { - "target": "com.amazonaws.fis#TargetAccountConfigurationDescription", - "traits": { - "smithy.api#documentation": "The description of the target account.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Provides a summary of a target account configuration.
" - } - }, - "com.amazonaws.fis#TargetAccountConfigurationsCount": { - "type": "long", - "traits": { - "smithy.api#range": { - "min": 0 - } - } - }, - "com.amazonaws.fis#TargetAccountId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 12, - "max": 48 - }, - "smithy.api#pattern": "^[\\S]+$" - } - }, - "com.amazonaws.fis#TargetInformationKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 64 - }, - "smithy.api#pattern": "^[\\S]+$" - } - }, - "com.amazonaws.fis#TargetInformationMap": { - "type": "map", - "key": { - "target": "com.amazonaws.fis#TargetInformationKey" - }, - "value": { - "target": "com.amazonaws.fis#TargetInformationValue" - } - }, - "com.amazonaws.fis#TargetInformationValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 2048 - }, - "smithy.api#pattern": "^[\\S]+$" - } - }, - "com.amazonaws.fis#TargetName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 64 - }, - "smithy.api#pattern": "^[\\S]+$" - } - }, - "com.amazonaws.fis#TargetResourceType": { - "type": "structure", - "members": { - "resourceType": { - "target": "com.amazonaws.fis#TargetResourceTypeId", - "traits": { - "smithy.api#documentation": "The resource type.
" - } - }, - "description": { - "target": "com.amazonaws.fis#TargetResourceTypeDescription", - "traits": { - "smithy.api#documentation": "A description of the resource type.
" - } - }, - "parameters": { - "target": "com.amazonaws.fis#TargetResourceTypeParameterMap", - "traits": { - "smithy.api#documentation": "The parameters for the resource type.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Describes a resource type.
" - } - }, - "com.amazonaws.fis#TargetResourceTypeDescription": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 512 - }, - "smithy.api#pattern": "^[\\s\\S]+$" - } - }, - "com.amazonaws.fis#TargetResourceTypeId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 128 - }, - "smithy.api#pattern": "^[\\S]+$" - } - }, - "com.amazonaws.fis#TargetResourceTypeParameter": { - "type": "structure", - "members": { - "description": { - "target": "com.amazonaws.fis#TargetResourceTypeParameterDescription", - "traits": { - "smithy.api#documentation": "A description of the parameter.
" - } - }, - "required": { - "target": "com.amazonaws.fis#TargetResourceTypeParameterRequired", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "Indicates whether the parameter is required.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Describes the parameters for a resource type. Use parameters to determine which tasks are\n identified during target resolution.
" - } - }, - "com.amazonaws.fis#TargetResourceTypeParameterDescription": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 512 - }, - "smithy.api#pattern": "^[\\s\\S]+$" - } - }, - "com.amazonaws.fis#TargetResourceTypeParameterMap": { - "type": "map", - "key": { - "target": "com.amazonaws.fis#TargetResourceTypeParameterName" - }, - "value": { - "target": "com.amazonaws.fis#TargetResourceTypeParameter" - } - }, - "com.amazonaws.fis#TargetResourceTypeParameterName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 64 - }, - "smithy.api#pattern": "^[\\S]+$" - } - }, - "com.amazonaws.fis#TargetResourceTypeParameterRequired": { - "type": "boolean", - "traits": { - "smithy.api#default": false - } - }, - "com.amazonaws.fis#TargetResourceTypeSummary": { - "type": "structure", - "members": { - "resourceType": { - "target": "com.amazonaws.fis#TargetResourceTypeId", - "traits": { - "smithy.api#documentation": "The resource type.
" - } - }, - "description": { - "target": "com.amazonaws.fis#TargetResourceTypeDescription", - "traits": { - "smithy.api#documentation": "A description of the resource type.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Describes a resource type.
" - } - }, - "com.amazonaws.fis#TargetResourceTypeSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.fis#TargetResourceTypeSummary" - } - }, - "com.amazonaws.fis#UntagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.fis#UntagResourceRequest" - }, - "output": { - "target": "com.amazonaws.fis#UntagResourceResponse" - }, - "traits": { - "smithy.api#documentation": "Removes the specified tags from the specified resource.
", - "smithy.api#http": { - "method": "DELETE", - "uri": "/tags/{resourceArn}", - "code": 200 - } - } - }, - "com.amazonaws.fis#UntagResourceRequest": { - "type": "structure", - "members": { - "resourceArn": { - "target": "com.amazonaws.fis#ResourceArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "tagKeys": { - "target": "com.amazonaws.fis#TagKeyList", - "traits": { - "smithy.api#documentation": "The tag keys to remove.
", - "smithy.api#httpQuery": "tagKeys" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.fis#UntagResourceResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.fis#UpdateExperimentTemplate": { - "type": "operation", - "input": { - "target": "com.amazonaws.fis#UpdateExperimentTemplateRequest" - }, - "output": { - "target": "com.amazonaws.fis#UpdateExperimentTemplateResponse" - }, - "errors": [ - { - "target": "com.amazonaws.fis#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.fis#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.fis#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Updates the specified experiment template.
", - "smithy.api#http": { - "method": "PATCH", - "uri": "/experimentTemplates/{id}", - "code": 200 - } - } - }, - "com.amazonaws.fis#UpdateExperimentTemplateActionInputItem": { - "type": "structure", - "members": { - "actionId": { - "target": "com.amazonaws.fis#ActionId", - "traits": { - "smithy.api#documentation": "The ID of the action.
" - } - }, - "description": { - "target": "com.amazonaws.fis#ExperimentTemplateActionDescription", - "traits": { - "smithy.api#documentation": "A description for the action.
" - } - }, - "parameters": { - "target": "com.amazonaws.fis#ExperimentTemplateActionParameterMap", - "traits": { - "smithy.api#documentation": "The parameters for the action, if applicable.
" - } - }, - "targets": { - "target": "com.amazonaws.fis#ExperimentTemplateActionTargetMap", - "traits": { - "smithy.api#documentation": "The targets for the action.
" - } - }, - "startAfter": { - "target": "com.amazonaws.fis#ExperimentTemplateActionStartAfterList", - "traits": { - "smithy.api#documentation": "The name of the action that must be completed before the current action starts. Omit this parameter to run the action at the start of the experiment.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Specifies an action for an experiment template.
" - } - }, - "com.amazonaws.fis#UpdateExperimentTemplateActionInputMap": { - "type": "map", - "key": { - "target": "com.amazonaws.fis#ExperimentTemplateActionName" - }, - "value": { - "target": "com.amazonaws.fis#UpdateExperimentTemplateActionInputItem" - } - }, - "com.amazonaws.fis#UpdateExperimentTemplateExperimentOptionsInput": { - "type": "structure", - "members": { - "emptyTargetResolutionMode": { - "target": "com.amazonaws.fis#EmptyTargetResolutionMode", - "traits": { - "smithy.api#documentation": "The empty target resolution mode of the experiment template.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Specifies an experiment option for an experiment template.
" - } - }, - "com.amazonaws.fis#UpdateExperimentTemplateLogConfigurationInput": { - "type": "structure", - "members": { - "cloudWatchLogsConfiguration": { - "target": "com.amazonaws.fis#ExperimentTemplateCloudWatchLogsLogConfigurationInput", - "traits": { - "smithy.api#documentation": "The configuration for experiment logging to Amazon CloudWatch Logs.
" - } - }, - "s3Configuration": { - "target": "com.amazonaws.fis#ExperimentTemplateS3LogConfigurationInput", - "traits": { - "smithy.api#documentation": "The configuration for experiment logging to Amazon S3.
" - } - }, - "logSchemaVersion": { - "target": "com.amazonaws.fis#LogSchemaVersion", - "traits": { - "smithy.api#documentation": "The schema version.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Specifies the configuration for experiment logging.
" - } - }, - "com.amazonaws.fis#UpdateExperimentTemplateRequest": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.fis#ExperimentTemplateId", - "traits": { - "smithy.api#documentation": "The ID of the experiment template.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.fis#ExperimentTemplateDescription", - "traits": { - "smithy.api#documentation": "A description for the template.
" - } - }, - "stopConditions": { - "target": "com.amazonaws.fis#UpdateExperimentTemplateStopConditionInputList", - "traits": { - "smithy.api#documentation": "The stop conditions for the experiment.
" - } - }, - "targets": { - "target": "com.amazonaws.fis#UpdateExperimentTemplateTargetInputMap", - "traits": { - "smithy.api#documentation": "The targets for the experiment.
" - } - }, - "actions": { - "target": "com.amazonaws.fis#UpdateExperimentTemplateActionInputMap", - "traits": { - "smithy.api#documentation": "The actions for the experiment.
" - } - }, - "roleArn": { - "target": "com.amazonaws.fis#RoleArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that grants the FIS service permission to perform service actions on your behalf.
" - } - }, - "logConfiguration": { - "target": "com.amazonaws.fis#UpdateExperimentTemplateLogConfigurationInput", - "traits": { - "smithy.api#documentation": "The configuration for experiment logging.
" - } - }, - "experimentOptions": { - "target": "com.amazonaws.fis#UpdateExperimentTemplateExperimentOptionsInput", - "traits": { - "smithy.api#documentation": "The experiment options for the experiment template.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.fis#UpdateExperimentTemplateResponse": { - "type": "structure", - "members": { - "experimentTemplate": { - "target": "com.amazonaws.fis#ExperimentTemplate", - "traits": { - "smithy.api#documentation": "Information about the experiment template.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.fis#UpdateExperimentTemplateStopConditionInput": { - "type": "structure", - "members": { - "source": { - "target": "com.amazonaws.fis#StopConditionSource", - "traits": { - "smithy.api#documentation": "The source for the stop condition. Specify aws:cloudwatch:alarm if the stop\n condition is defined by a CloudWatch alarm. Specify none if there is no stop\n condition.
The Amazon Resource Name (ARN) of the CloudWatch alarm.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Specifies a stop condition for an experiment. You can define a stop condition as a CloudWatch alarm.
" - } - }, - "com.amazonaws.fis#UpdateExperimentTemplateStopConditionInputList": { - "type": "list", - "member": { - "target": "com.amazonaws.fis#UpdateExperimentTemplateStopConditionInput" - } - }, - "com.amazonaws.fis#UpdateExperimentTemplateTargetInput": { - "type": "structure", - "members": { - "resourceType": { - "target": "com.amazonaws.fis#TargetResourceTypeId", - "traits": { - "smithy.api#documentation": "The resource type. The resource type must be supported for the specified action.
", - "smithy.api#required": {} - } - }, - "resourceArns": { - "target": "com.amazonaws.fis#ResourceArnList", - "traits": { - "smithy.api#documentation": "The Amazon Resource Names (ARNs) of the targets.
" - } - }, - "resourceTags": { - "target": "com.amazonaws.fis#TagMap", - "traits": { - "smithy.api#documentation": "The tags for the target resources.
" - } - }, - "filters": { - "target": "com.amazonaws.fis#ExperimentTemplateTargetFilterInputList", - "traits": { - "smithy.api#documentation": "The filters to apply to identify target resources using specific attributes.
" - } - }, - "selectionMode": { - "target": "com.amazonaws.fis#ExperimentTemplateTargetSelectionMode", - "traits": { - "smithy.api#documentation": "Scopes the identified resources to a specific count or percentage.
", - "smithy.api#required": {} - } - }, - "parameters": { - "target": "com.amazonaws.fis#ExperimentTemplateTargetParameterMap", - "traits": { - "smithy.api#documentation": "The resource type parameters.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Specifies a target for an experiment. You must specify at least one Amazon Resource Name (ARN) or at least one resource tag. You cannot specify both.
" - } - }, - "com.amazonaws.fis#UpdateExperimentTemplateTargetInputMap": { - "type": "map", - "key": { - "target": "com.amazonaws.fis#ExperimentTemplateTargetName" - }, - "value": { - "target": "com.amazonaws.fis#UpdateExperimentTemplateTargetInput" - } - }, - "com.amazonaws.fis#UpdateTargetAccountConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.fis#UpdateTargetAccountConfigurationRequest" - }, - "output": { - "target": "com.amazonaws.fis#UpdateTargetAccountConfigurationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.fis#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.fis#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Updates the target account configuration for the specified experiment template.
", - "smithy.api#http": { - "method": "PATCH", - "uri": "/experimentTemplates/{experimentTemplateId}/targetAccountConfigurations/{accountId}", - "code": 200 - } - } - }, - "com.amazonaws.fis#UpdateTargetAccountConfigurationRequest": { - "type": "structure", - "members": { - "experimentTemplateId": { - "target": "com.amazonaws.fis#ExperimentTemplateId", - "traits": { - "smithy.api#documentation": "The ID of the experiment template.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "accountId": { - "target": "com.amazonaws.fis#TargetAccountId", - "traits": { - "smithy.api#documentation": "The Amazon Web Services account ID of the target account.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "roleArn": { - "target": "com.amazonaws.fis#RoleArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role for the target account.
" - } - }, - "description": { - "target": "com.amazonaws.fis#TargetAccountConfigurationDescription", - "traits": { - "smithy.api#documentation": "The description of the target account.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.fis#UpdateTargetAccountConfigurationResponse": { - "type": "structure", - "members": { - "targetAccountConfiguration": { - "target": "com.amazonaws.fis#TargetAccountConfiguration", - "traits": { - "smithy.api#documentation": "Information about the target account configuration.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.fis#ValidationException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.fis#ExceptionMessage" } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "ValidationException", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "The specified input is not valid, or fails to satisfy the constraints for the request.
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } } - } } diff --git a/codegen/sdk-codegen/aws-models/s3-control.json b/codegen/sdk-codegen/aws-models/s3-control.json index bd2bbdc21a74..3b8586d07b7a 100644 --- a/codegen/sdk-codegen/aws-models/s3-control.json +++ b/codegen/sdk-codegen/aws-models/s3-control.json @@ -1,19333 +1,19698 @@ { - "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#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#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#ListAccessPointsForObjectLambda" - }, - { - "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#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#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" - } - }, - "rules": [ + "smithy": "2.0", + "metadata": { + "suppressions": [ + { + "id": "HttpMethodSemantics", + "namespace": "*" + }, + { + "id": "HttpResponseCodeSemantics", + "namespace": "*" + }, { - "conditions": [ + "id": "PaginatedTrait", + "namespace": "*" + }, + { + "id": "HttpHeaderTrait", + "namespace": "*" + }, + { + "id": "HttpUriConflict", + "namespace": "*" + }, + { + "id": "Service", + "namespace": "*" + } + ] + }, + "shapes": { + "com.amazonaws.s3control#AWSS3ControlServiceV20180820": { + "type": "service", + "version": "2018-08-20", + "operations": [ { - "fn": "isSet", - "argv": [ - { - "ref": "Region" - } - ] - } - ], - "rules": [ + "target": "com.amazonaws.s3control#AssociateAccessGrantsIdentityCenter" + }, { - "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" + "target": "com.amazonaws.s3control#CreateAccessGrant" }, { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "OutpostId" - } - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "aws.partition", - "argv": [ - { - "ref": "Region" - } - ], - "assign": "partitionResult" - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "stringEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "partitionResult" - }, - "name" - ] - }, - "aws-cn" - ] - } - ], - "error": "Partition does not support FIPS", - "type": "error" - }, - { - "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" + "target": "com.amazonaws.s3control#CreateAccessGrantsInstance" }, { - "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" - } - ] - }, + "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#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#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#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#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#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" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] + "ref": "Region" } - ], - "error": "Invalid Configuration: DualStack and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [ + ] + } + ], + "rules": [ + { + "conditions": [ { - "fn": "isSet", - "argv": [ - { - "ref": "UseArnRegion" - } - ] + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "snow" + ] }, { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseArnRegion" - }, - false - ] + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] }, { - "fn": "not", - "argv": [ - { - "fn": "stringEquals", - "argv": [ + "fn": "parseURL", + "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" + "ref": "Endpoint" + } + ], + "assign": "url" } - ], - "rules": [ + ], + "rules": [ { - "conditions": [ - { - "fn": "aws.partition", - "argv": [ + "conditions": [ { - "fn": "getAttr", - "argv": [ - { - "ref": "accessPointArn" - }, - "region" - ] + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "partitionResult" } - ], - "assign": "arnPartition" - } - ], - "rules": [ - { - "conditions": [ + ], + "rules": [ { - "fn": "stringEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ + "conditions": [ { - "ref": "arnPartition" + "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}" + } + ] }, - "name" - ] + "headers": {} }, - { - "fn": "getAttr", - "argv": [ + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "OutpostId" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ { - "ref": "partitionResult" - }, - "name" - ] - } - ] + "ref": "Region" + } + ], + "assign": "partitionResult" } - ], - "rules": [ + ], + "rules": [ { - "conditions": [ - { - "fn": "isValidHostLabel", - "argv": [ + "conditions": [ { - "fn": "getAttr", - "argv": [ - { - "ref": "accessPointArn" - }, - "region" - ] + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] }, - true - ] - } - ], - "rules": [ - { - "conditions": [ { - "fn": "not", - "argv": [ - { - "fn": "stringEquals", - "argv": [ + "fn": "stringEquals", + "argv": [ { - "fn": "getAttr", - "argv": [ - { - "ref": "accessPointArn" - }, - "accountId" - ] + "fn": "getAttr", + "argv": [ + { + "ref": "partitionResult" + }, + "name" + ] }, - "" - ] - } - ] + "aws-cn" + ] } - ], - "rules": [ + ], + "error": "Partition does not support FIPS", + "type": "error" + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "RequiresAccountId" + } + ] + }, { - "conditions": [ - { - "fn": "isValidHostLabel", - "argv": [ + "fn": "booleanEquals", + "argv": [ { - "fn": "getAttr", - "argv": [ - { - "ref": "accessPointArn" - }, - "accountId" - ] + "ref": "RequiresAccountId" }, - false - ] - } - ], - "rules": [ - { - "conditions": [ + 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": "isSet", - "argv": [ - { - "ref": "AccountId" - } - ] + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] }, { - "fn": "not", - "argv": [ - { - "fn": "stringEquals", - "argv": [ + "fn": "booleanEquals", + "argv": [ { - "ref": "AccountId" + "ref": "UseDualStack" }, - "{accessPointArn#accountId}" - ] - } - ] + true + ] } - ], - "error": "Invalid ARN: the accountId specified in the ARN (`{accessPointArn#accountId}`) does not match the parameter (`{AccountId}`)", - "type": "error" + ], + "endpoint": { + "url": "https://s3-outposts-fips.{Region}.{partitionResult#dualStackDnsSuffix}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3-outposts", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} }, - { - "conditions": [ + "type": "endpoint" + }, + { + "conditions": [ { - "fn": "getAttr", - "argv": [ - { - "ref": "accessPointArn" - }, - "resourceId[2]" - ], - "assign": "outpostType" + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] } - ], - "rules": [ + ], + "endpoint": { + "url": "https://s3-outposts-fips.{Region}.{partitionResult#dnsSuffix}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3-outposts", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ { - "conditions": [ - { - "fn": "getAttr", - "argv": [ + "fn": "booleanEquals", + "argv": [ { - "ref": "accessPointArn" + "ref": "UseDualStack" }, - "resourceId[3]" - ], - "assign": "accessPointName" - } - ], - "rules": [ - { - "conditions": [ + 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": [ { - "fn": "stringEquals", - "argv": [ - { - "ref": "outpostType" - }, - "accesspoint" - ] + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3-outposts", + "signingRegion": "{Region}" } - ], - "rules": [ + ] + }, + "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": "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": [ { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ + "fn": "isValidHostLabel", + "argv": [ { - "ref": "UseFIPS" + "ref": "outpostId" }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ + false + ] + } + ], + "rules": [ + { + "conditions": [ { - "ref": "UseDualStack" + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] }, - true - ] - } - ], - "endpoint": { - "url": "https://s3-outposts-fips.{accessPointArn#region}.{arnPartition#dualStackDnsSuffix}", - "properties": { - "authSchemes": [ { - "disableDoubleEncoding": true, - "name": "sigv4", - "signingName": "s3-outposts", - "signingRegion": "{accessPointArn#region}" + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] } - ] - }, - "headers": { - "x-amz-account-id": [ - "{accessPointArn#accountId}" - ], - "x-amz-outpost-id": ["{outpostId}"] - } - }, - "type": "endpoint" + ], + "error": "Invalid Configuration: DualStack and custom endpoint are not supported", + "type": "error" }, { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ + "conditions": [ { - "ref": "UseFIPS" + "fn": "isSet", + "argv": [ + { + "ref": "UseArnRegion" + } + ] }, - 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" + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseArnRegion" + }, + false + ] }, - true - ] - } - ], - "endpoint": { - "url": "https://s3-outposts.{accessPointArn#region}.{arnPartition#dualStackDnsSuffix}", - "properties": { - "authSchemes": [ { - "disableDoubleEncoding": true, - "name": "sigv4", - "signingName": "s3-outposts", - "signingRegion": "{accessPointArn#region}" + "fn": "not", + "argv": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "accessPointArn" + }, + "region" + ] + }, + "{Region}" + ] + } + ] } - ] - }, - "headers": { - "x-amz-account-id": [ - "{accessPointArn#accountId}" - ], - "x-amz-outpost-id": ["{outpostId}"] - } - }, - "type": "endpoint" + ], + "error": "Invalid configuration: region from ARN `{accessPointArn#region}` does not match client region `{Region}` and UseArnRegion is `false`", + "type": "error" }, { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Endpoint" - } - ] - }, - { - "fn": "parseURL", - "argv": [ - { - "ref": "Endpoint" - } - ], - "assign": "url" - } - ], - "endpoint": { - "url": "{url#scheme}://{url#authority}{url#path}", - "properties": { - "authSchemes": [ + "conditions": [ { - "disableDoubleEncoding": true, - "name": "sigv4", - "signingName": "s3-outposts", - "signingRegion": "{accessPointArn#region}" + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "partitionResult" } - ] - }, - "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": [ + ], + "rules": [ { - "disableDoubleEncoding": true, - "name": "sigv4", - "signingName": "s3-outposts", - "signingRegion": "{accessPointArn#region}" + "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" } - ] - }, - "headers": { - "x-amz-account-id": [ - "{accessPointArn#accountId}" - ], - "x-amz-outpost-id": ["{outpostId}"] - } - }, - "type": "endpoint" + ], + "type": "tree" } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "Expected an outpost type `accesspoint`, found `{outpostType}`", - "type": "error" - } - ], - "type": "tree" + ], + "type": "tree" }, { - "conditions": [], - "error": "Invalid ARN: expected an access point name", - "type": "error" + "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: Expected a 4-component resource", - "type": "error" - } - ], - "type": "tree" + ], + "type": "tree" }, { - "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: The Outpost Id was not set", + "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" } - ], - "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" - } - ] + ], + "type": "tree" }, { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] + "conditions": [], + "error": "Invalid ARN: No ARN type specified", + "type": "error" } - ], - "error": "Invalid Configuration: DualStack and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "UseArnRegion" - } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseArnRegion" - }, - false - ] - }, + ], + "type": "tree" + }, + { + "conditions": [ { - "fn": "not", - "argv": [ - { - "fn": "stringEquals", - "argv": [ + "fn": "isSet", + "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": [ + "ref": "Bucket" + } + ] + }, { - "fn": "aws.partition", - "argv": [ - { - "fn": "getAttr", - "argv": [ + "fn": "aws.parseArn", + "argv": [ { - "ref": "bucketArn" - }, - "region" - ] - } - ], - "assign": "arnPartition" + "ref": "Bucket" + } + ], + "assign": "bucketArn" } - ], - "rules": [ + ], + "rules": [ { - "conditions": [ - { - "fn": "aws.partition", - "argv": [ - { - "ref": "Region" - } - ], - "assign": "partitionResult" - } - ], - "rules": [ - { - "conditions": [ + "conditions": [ { - "fn": "stringEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ + "fn": "getAttr", + "argv": [ { - "ref": "arnPartition" + "ref": "bucketArn" }, - "name" - ] - }, - { - "fn": "getAttr", - "argv": [ - { - "ref": "partitionResult" - }, - "name" - ] - } - ] - } - ], - "rules": [ + "resourceId[0]" + ], + "assign": "arnType" + }, { - "conditions": [ - { - "fn": "isValidHostLabel", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "bucketArn" - }, - "region" - ] - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ + "fn": "not", + "argv": [ { - "fn": "not", - "argv": [ - { - "fn": "stringEquals", - "argv": [ + "fn": "stringEquals", + "argv": [ { - "fn": "getAttr", - "argv": [ - { - "ref": "bucketArn" - }, - "accountId" - ] + "ref": "arnType" }, "" - ] - } - ] + ] } - ], - "rules": [ + ] + } + ], + "rules": [ + { + "conditions": [ { - "conditions": [ - { - "fn": "isValidHostLabel", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "bucketArn" - }, - "accountId" - ] - }, - false - ] - } - ], - "rules": [ - { - "conditions": [ + "fn": "stringEquals", + "argv": [ { - "fn": "isSet", - "argv": [ - { - "ref": "AccountId" - } - ] + "fn": "getAttr", + "argv": [ + { + "ref": "bucketArn" + }, + "service" + ] }, + "s3-outposts" + ] + } + ], + "rules": [ + { + "conditions": [ { - "fn": "not", - "argv": [ - { - "fn": "stringEquals", - "argv": [ + "fn": "getAttr", + "argv": [ { - "ref": "AccountId" + "ref": "bucketArn" }, - "{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" + "resourceId[1]" + ], + "assign": "outpostId" } - ], - "rules": [ + ], + "rules": [ { - "conditions": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "bucketArn" - }, - "resourceId[3]" - ], - "assign": "bucketName" - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ - { - "ref": "outpostType" - }, - "bucket" - ] - } - ], - "rules": [ + "conditions": [ { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ + "fn": "isValidHostLabel", + "argv": [ { - "ref": "UseFIPS" + "ref": "outpostId" }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ + false + ] + } + ], + "rules": [ + { + "conditions": [ { - "ref": "UseDualStack" + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] }, - true - ] - } - ], - "endpoint": { - "url": "https://s3-outposts-fips.{bucketArn#region}.{arnPartition#dualStackDnsSuffix}", - "properties": { - "authSchemes": [ { - "disableDoubleEncoding": true, - "name": "sigv4", - "signingName": "s3-outposts", - "signingRegion": "{bucketArn#region}" + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] } - ] - }, - "headers": { - "x-amz-account-id": [ - "{bucketArn#accountId}" - ], - "x-amz-outpost-id": ["{outpostId}"] - } - }, - "type": "endpoint" + ], + "error": "Invalid Configuration: DualStack and custom endpoint are not supported", + "type": "error" }, { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ + "conditions": [ { - "ref": "UseFIPS" + "fn": "isSet", + "argv": [ + { + "ref": "UseArnRegion" + } + ] }, - 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" + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseArnRegion" + }, + false + ] }, - true - ] - } - ], - "endpoint": { - "url": "https://s3-outposts.{bucketArn#region}.{arnPartition#dualStackDnsSuffix}", - "properties": { - "authSchemes": [ { - "disableDoubleEncoding": true, - "name": "sigv4", - "signingName": "s3-outposts", - "signingRegion": "{bucketArn#region}" + "fn": "not", + "argv": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "bucketArn" + }, + "region" + ] + }, + "{Region}" + ] + } + ] } - ] - }, - "headers": { - "x-amz-account-id": [ - "{bucketArn#accountId}" - ], - "x-amz-outpost-id": ["{outpostId}"] - } - }, - "type": "endpoint" + ], + "error": "Invalid configuration: region from ARN `{bucketArn#region}` does not match client region `{Region}` and UseArnRegion is `false`", + "type": "error" }, { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Endpoint" - } - ] - }, - { - "fn": "parseURL", - "argv": [ - { - "ref": "Endpoint" - } - ], - "assign": "url" - } - ], - "endpoint": { - "url": "{url#scheme}://{url#authority}{url#path}", - "properties": { - "authSchemes": [ + "conditions": [ { - "disableDoubleEncoding": true, - "name": "sigv4", - "signingName": "s3-outposts", - "signingRegion": "{bucketArn#region}" + "fn": "aws.partition", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "bucketArn" + }, + "region" + ] + } + ], + "assign": "arnPartition" } - ] - }, - "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": [ + ], + "rules": [ { - "disableDoubleEncoding": true, - "name": "sigv4", - "signingName": "s3-outposts", - "signingRegion": "{bucketArn#region}" + "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" } - ] - }, - "headers": { - "x-amz-account-id": [ - "{bucketArn#accountId}" - ], - "x-amz-outpost-id": ["{outpostId}"] - } - }, - "type": "endpoint" + ], + "type": "tree" } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "Invalid ARN: Expected an outpost type `bucket`, found `{outpostType}`", - "type": "error" - } - ], - "type": "tree" + ], + "type": "tree" }, { - "conditions": [], - "error": "Invalid ARN: expected a bucket name", - "type": "error" + "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: Expected a 4-component resource", - "type": "error" - } - ], - "type": "tree" + ], + "type": "tree" }, { - "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 ARN: The Outpost Id was not set", + "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" } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "Client was configured for partition `{partitionResult#name}` but ARN has `{arnPartition#name}`", - "type": "error" - } - ], - "type": "tree" + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid ARN: No ARN type specified", + "type": "error" } - ], - "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": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "stringEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "partitionResult" - }, - "name" - ] - }, - "aws-cn" - ] - } - ], - "error": "Partition does not support FIPS", - "type": "error" - }, - { - "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" + ], + "type": "tree" }, - 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": { - "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-fips.cn-north-1.amazonaws.com.cn" - } - }, - "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 `-`." - }, - "operationInputs": [ - { - "builtInParams": { - "AWS::Region": "us-east-1" - }, - "operationName": "ListRegionalBuckets", - "operationParams": { - "AccountId": "/?invalid¬-host*label" - } - } - ], - "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 `-`." - }, - "operationInputs": [ - { - "builtInParams": { - "AWS::Region": "us-east-1", - "SDK::Endpoint": "https://beta.example.com" - }, - "operationName": "ListRegionalBuckets", - "operationParams": { - "AccountId": "/?invalid¬-host*label" - } - } - ], - "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 `-`." - }, - "operationInputs": [ - { - "builtInParams": { - "AWS::Region": "us-east-2" - }, - "operationName": "ListRegionalBuckets", - "operationParams": { - "OutpostId": "op-123", - "AccountId": "/?invalid¬-host*label" - } - } - ], - "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": "0123456789012" - } - } - ], - "params": { - "AccountId": "0123456789012", - "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": "0123456789012" - } - } - ], - "params": { - "AccountId": "0123456789012", - "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 (`0123456789012`)" - }, - "params": { - "Bucket": "arn:aws:s3-outposts:us-west-2:999999:outpost:op-01234567890123456:bucket:mybucket", - "AccountId": "0123456789012", - "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 - } - } - ], - "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 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.
\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.
" - } - } - }, - "traits": { - "smithy.api#documentation": "An access point used to access a bucket.
" - } - }, - "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.
" - } - }, - "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.
\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#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 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" - } - } - }, - "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#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.
" - } - } - }, - "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#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#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 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" - } - } - }, - "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 – Grant read-only access to the S3 data.
\n WRITE – Grant write-only access to the S3 data.
\n READWRITE – 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 – Grant read-only access to the S3 data.
\n WRITE – Grant write-only access to the S3 data.
\n READWRITE – 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 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" - } - } - }, - "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 S3 Access Grants instance.
" - } - }, - "IdentityCenterArn": { - "target": "com.amazonaws.s3control#IdentityCenterArn", - "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 passed in the request. S3 Access Grants creates this Identity Center application for this 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 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" - } - } - }, - "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": "This operation is not supported by directory buckets.
\nCreates an access point and associates it with the specified bucket. For more information, see\n Managing\n Data Access with Amazon S3 Access Points in the\n Amazon S3 User Guide.
\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.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Bucket": { - "target": "com.amazonaws.s3control#BucketName", - "traits": { - "smithy.api#documentation": "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
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’ve 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’re 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#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 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" - } - } - }, - "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 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" - } - } - } - }, - "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 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" - } - } - } - }, - "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 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" - } - } - }, - "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.
This operation is not supported by directory buckets.
\nDeletes 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": "This operation is not supported by directory buckets.
\nDeletes 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.
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. 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 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" - } - } - } - }, - "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.
\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 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" - } - } - }, - "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 – Grant read-only access to the S3 data.
\n WRITE – Grant write-only access to the S3 data.
\n READWRITE – 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.
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 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" - } - } - } - }, - "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 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" - } - } - } - }, - "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 Amazon Web Services 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 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" - } - } - }, - "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": "This operation is not supported by directory buckets.
\nReturns 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": "This operation is not supported by directory buckets.
\nReturns 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#BucketName", - "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.
\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.
" - } - } - }, - "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.
\nYou 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 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" - } - } - }, - "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 – Grant read-only access to the S3 data.
\n WRITE – Grant write-only access to the S3 data.
\n READWRITE – 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 – The scope of the returned temporary access token is the scope of the grant that is closest to the target scope.
\n Minimal – 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 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.
" - } - } - }, - "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. For\n 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:.*$" - } - }, - "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#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.
" - } - } - }, - "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.
\nThe 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.
" - } - } - }, - "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.
" - } - }, - "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.
" - } - }, - "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.
" - } - } - }, - "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.
" - } - } - }, - "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 – Grant read-only access to the S3 data.
\n WRITE – Grant write-only access to the S3 data.
\n READWRITE – 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#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 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" - } - } - }, - "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 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" - } - } - }, - "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 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" - } - } - }, - "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 – Grant read-only access to the S3 data.
\n WRITE – Grant write-only access to the S3 data.
\n READWRITE – 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\n that are\n owned by the current account\n that's\n associated with the specified bucket. You can retrieve up to 1000 access points\n per call. If the specified bucket has more than 1,000 access points (or the number specified in\n maxResults, whichever is less), the response will include a continuation\n token that you can use to list the additional access points.
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
\nThis 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.
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#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": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "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": {} - } - } - }, - "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 the Amazon Web Services resource tags for a specified resource. 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.
\nYou must have the s3:ListTagsForResource permission to use this operation.
This operation is only supported for S3 Storage Lens groups and for S3 Access Grants. The tagged resource can be an S3 Storage Lens group or S3 Access Grants instance, registered location, or grant.
\nFor more information about the required Storage Lens\n Groups permissions, see Setting account permissions to use S3 Storage Lens groups.
\nFor 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 the tags for. The tagged resource can be an S3 Storage Lens group or S3 Access Grants instance, registered location, or grant.\n
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "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": "\nSpecifies the minimum object size in Bytes. The value must be a positive number, greater than 0 and less than 5 TB.\n
" - } - }, - "BytesLessThan": { - "target": "com.amazonaws.s3control#ObjectSizeValue", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "\nSpecifies the maximum object size in Bytes. The value must be a positive number, greater than the minimum object size and less than 5 TB.\n
" - } - } - }, - "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": 0.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#ObjectAgeValue": { - "type": "integer", - "traits": { - "smithy.api#default": 0 - } - }, - "com.amazonaws.s3control#ObjectCreationTime": { - "type": "timestamp" - }, - "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" - } - } - } - }, - "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#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 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 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" - } - } - }, - "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": "This operation is not supported by directory buckets.
\nAssociates 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 in the Amazon S3 User Guide.
", - "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. 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" - } - } - } - }, - "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.
This functionality is not supported by directory buckets.
\nThis 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.
\nThis functionality is not supported by directory buckets.
\nSpecifies 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 object action doesn’t affect\n bucket-level settings for S3 Bucket Key.
\nThis functionality is not supported by directory buckets.
\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.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains\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 bucket the generated manifest is written to. If\n provided the generated manifest bucket's owner Amazon Web Services account ID must match this value, else\n the job fails.
" - } - }, - "SourceBucket": { - "target": "com.amazonaws.s3control#S3BucketArnString", - "traits": { - "smithy.api#documentation": "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#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#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": "\nFor directory buckets, only the server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) is supported.
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.
" - } - } - }, - "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#S3UserMetadata": { - "type": "map", - "key": { - "target": "com.amazonaws.s3control#NonEmptyMaxLength1024String" - }, - "value": { - "target": "com.amazonaws.s3control#MaxLength1024String" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 8192 - } - } - }, - "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#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#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 number of storage bytes percentage whose metrics will be selected.
\nYou must choose a value greater than or equal to 1.0.
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.
" - } - }, - "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 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#StorageLensDataExport": { - "type": "structure", - "members": { - "S3BucketDestination": { - "target": "com.amazonaws.s3control#S3BucketDestination", - "traits": { - "smithy.api#documentation": "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.
" - } - } - }, - "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#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.
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’t 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’t 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 An Amazon Web Services resource tag that's associated with your S3 resource. You can add tags to new objects when you upload them, or you can add object tags to existing objects. \n
\nThis operation is only supported for S3 Storage Lens groups and for S3 Access Grants. The tagged resource can be an S3 Storage Lens group or S3 Access Grants instance, registered location, or grant.
\nCreates a new Amazon Web Services resource tag or updates an existing resource tag. 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. You can add up to 50 Amazon Web Services resource tags for each S3 resource.
\nThis operation is only supported for S3 Storage Lens groups and for S3 Access Grants. The tagged resource can be an S3 Storage Lens group or S3 Access Grants instance, registered location, or grant.
\nYou must have the s3:TagResource permission to use this operation.
For more information about the required Storage Lens\n Groups permissions, see Setting account permissions to use S3 Storage Lens groups.
\nFor 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 trying to add tags to. The tagged resource can be an S3 Storage Lens group or S3 Access Grants instance, registered location, or grant.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "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 Amazon Web Services resource tags from an S3 resource. 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.
\nThis operation is only supported for S3 Storage Lens groups and for S3 Access Grants. The tagged resource can be an S3 Storage Lens group or S3 Access Grants instance, registered location, or grant.
\nYou must have the s3:UntagResource permission to use this operation.
For more information about the required Storage\n Lens Groups permissions, see Setting account permissions to use S3 Storage Lens groups.
\nFor 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": "\n The Amazon Resource Name (ARN) of the S3 resource that you're trying to remove the tags from.\n
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "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 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" - } - } - }, - "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 + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "partitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "isValidHostLabel", + "argv": [ + { + "ref": "Region" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "partitionResult" + }, + "name" + ] + }, + "aws-cn" + ] + } + ], + "error": "Partition does not support FIPS", + "type": "error" + }, + { + "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": { + "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-fips.cn-north-1.amazonaws.com.cn" + } + }, + "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 `-`." + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1" + }, + "operationName": "ListRegionalBuckets", + "operationParams": { + "AccountId": "/?invalid¬-host*label" + } + } + ], + "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 `-`." + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "SDK::Endpoint": "https://beta.example.com" + }, + "operationName": "ListRegionalBuckets", + "operationParams": { + "AccountId": "/?invalid¬-host*label" + } + } + ], + "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 `-`." + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-2" + }, + "operationName": "ListRegionalBuckets", + "operationParams": { + "OutpostId": "op-123", + "AccountId": "/?invalid¬-host*label" + } + } + ], + "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": "0123456789012" + } + } + ], + "params": { + "AccountId": "0123456789012", + "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": "0123456789012" + } + } + ], + "params": { + "AccountId": "0123456789012", + "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 (`0123456789012`)" + }, + "params": { + "Bucket": "arn:aws:s3-outposts:us-west-2:999999:outpost:op-01234567890123456:bucket:mybucket", + "AccountId": "0123456789012", + "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 + } + } + ], + "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 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 Servicesservices.
\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.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An access point used to access a bucket.
" + } + }, + "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.
" + } + }, + "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.
\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#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#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.
" + } + } + }, + "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#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 – Grant read-only access to the S3 data.
\n WRITE – Grant write-only access to the S3 data.
\n READWRITE – 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 – Grant read-only access to the S3 data.
\n WRITE – Grant write-only access to the S3 data.
\n READWRITE – 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": "This operation is not supported by directory buckets.
\nCreates an access point and associates it with the specified bucket. For more information, see\n Managing\n Data Access with Amazon S3 Access Points in the\n Amazon S3 User Guide.
\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.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Bucket": { + "target": "com.amazonaws.s3control#BucketName", + "traits": { + "smithy.api#documentation": "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
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’ve 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’re 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#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.
This operation is not supported by directory buckets.
\nDeletes 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": "This operation is not supported by directory buckets.
\nDeletes 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.
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. 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’s 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 – Grant read-only access to the S3 data.
\n WRITE – Grant write-only access to the S3 data.
\n READWRITE – 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": "This operation is not supported by directory buckets.
\nReturns 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": "This operation is not supported by directory buckets.
\nReturns 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#BucketName", + "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 Servicesservices.
\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.
" + } + } + }, + "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.
\nYou 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 – Grant read-only access to the S3 data.
\n WRITE – Grant write-only access to the S3 data.
\n READWRITE – 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 – The scope of the returned temporary access token is the scope of the grant that is closest to the target scope.
\n Minimal – 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 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.
" + } + } + }, + "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. For\n 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#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.
" + } + } + }, + "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.
\nThe 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.
" + } + } + }, + "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.
" + } + } + }, + "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 – Grant read-only access to the S3 data.
\n WRITE – Grant write-only access to the S3 data.
\n READWRITE – 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 – Grant read-only access to the S3 data.
\n WRITE – Grant write-only access to the S3 data.
\n READWRITE – 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\n that are\n owned by the current account\n that's\n associated with the specified bucket. You can retrieve up to 1000 access points\n per call. If the specified bucket has more than 1,000 access points (or the number specified in\n maxResults, whichever is less), the response will include a continuation\n token that you can use to list the additional access points.
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
\nThis 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.
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": "Returns a list of the access grants that were given to the caller using S3 Access Grants and that allow the caller to access the S3 data of the Amazon Web Services account specified in the request.
\nYou 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.
" + } + } + }, + "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. 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).
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": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "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": {} + } + } + }, + "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 the Amazon Web Services resource tags for a specified resource. 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.
\nYou must have the s3:ListTagsForResource permission to use this operation.
This operation is only supported for S3 Storage Lens groups and for S3 Access Grants. The tagged resource can be an S3 Storage Lens group or S3 Access Grants instance, registered location, or grant.
\nFor more information about the required Storage Lens\n Groups permissions, see Setting account permissions to use S3 Storage Lens groups.
\nFor 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 the tags for. The tagged resource can be an S3 Storage Lens group or S3 Access Grants instance, registered location, or grant.\n
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "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": "\nSpecifies the minimum object size in Bytes. The value must be a positive number, greater than 0 and less than 5 TB.\n
" + } + }, + "BytesLessThan": { + "target": "com.amazonaws.s3control#ObjectSizeValue", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "\nSpecifies the maximum object size in Bytes. The value must be a positive number, greater than the minimum object size and less than 5 TB.\n
" + } + } + }, + "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": 0.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#ObjectAgeValue": { + "type": "integer", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.s3control#ObjectCreationTime": { + "type": "timestamp" + }, + "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" + } + } + } + }, + "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#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 Servicesservice 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": "This operation is not supported by directory buckets.
\nAssociates 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 in the Amazon S3 User Guide.
", + "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. 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" + } + } + } + }, + "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.
This functionality is not supported by directory buckets.
\nThis 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.
\nThis functionality is not supported by directory buckets.
\nSpecifies 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 object action doesn’t affect\n bucket-level settings for S3 Bucket Key.
\nThis functionality is not supported by directory buckets.
\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.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains\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 bucket the generated manifest is written to. If\n provided the generated manifest bucket's owner Amazon Web Services account ID must match this value, else\n the job fails.
" + } + }, + "SourceBucket": { + "target": "com.amazonaws.s3control#S3BucketArnString", + "traits": { + "smithy.api#documentation": "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#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#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": "\nFor directory buckets, only the server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) is supported.
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.
" + } + } + }, + "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#S3UserMetadata": { + "type": "map", + "key": { + "target": "com.amazonaws.s3control#NonEmptyMaxLength1024String" + }, + "value": { + "target": "com.amazonaws.s3control#MaxLength1024String" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 8192 + } + } + }, + "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#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#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 number of storage bytes percentage whose metrics will be selected.
\nYou must choose a value greater than or equal to 1.0.
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.
" + } + }, + "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 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#StorageLensDataExport": { + "type": "structure", + "members": { + "S3BucketDestination": { + "target": "com.amazonaws.s3control#S3BucketDestination", + "traits": { + "smithy.api#documentation": "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.
" + } + } + }, + "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#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.
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’t 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’t 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 An Amazon Web Services resource tag that's associated with your S3 resource. You can add tags to new objects when you upload them, or you can add object tags to existing objects. \n
\nThis operation is only supported for S3 Storage Lens groups and for S3 Access Grants. The tagged resource can be an S3 Storage Lens group or S3 Access Grants instance, registered location, or grant.
\nCreates a new Amazon Web Services resource tag or updates an existing resource tag. 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. You can add up to 50 Amazon Web Services resource tags for each S3 resource.
\nThis operation is only supported for S3 Storage Lens groups and for S3 Access Grants. The tagged resource can be an S3 Storage Lens group or S3 Access Grants instance, registered location, or grant.
\nYou must have the s3:TagResource permission to use this operation.
For more information about the required Storage Lens\n Groups permissions, see Setting account permissions to use S3 Storage Lens groups.
\nFor 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 trying to add tags to. The tagged resource can be an S3 Storage Lens group or S3 Access Grants instance, registered location, or grant.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "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 Amazon Web Services resource tags from an S3 resource. 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.
\nThis operation is only supported for S3 Storage Lens groups and for S3 Access Grants. The tagged resource can be an S3 Storage Lens group or S3 Access Grants instance, registered location, or grant.
\nYou must have the s3:UntagResource permission to use this operation.
For more information about the required Storage\n Lens Groups permissions, see Setting account permissions to use S3 Storage Lens groups.
\nFor 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": "\n The Amazon Resource Name (ARN) of the S3 resource that you're trying to remove the tags from.\n
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "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 + } + } } - } } - } }