From 7d50b35dc1b0030e8ff5b1468b996d0779a25269 Mon Sep 17 00:00:00 2001 From: AWS SDK for Go v2 automation user Date: Mon, 27 Nov 2023 20:00:37 +0000 Subject: [PATCH] Update API model --- codegen/sdk-codegen/aws-models/appsync.json | 464 +- codegen/sdk-codegen/aws-models/b2bi.json | 5430 +++++++++++++++ codegen/sdk-codegen/aws-models/backup.json | 5899 +++++++++++------ .../sdk-codegen/aws-models/controltower.json | 264 +- codegen/sdk-codegen/aws-models/efs.json | 167 +- codegen/sdk-codegen/aws-models/fis.json | 997 ++- codegen/sdk-codegen/aws-models/glue.json | 10 +- codegen/sdk-codegen/aws-models/rds.json | 124 +- .../sdk-codegen/aws-models/securityhub.json | 2064 +++++- .../sdk-codegen/aws-models/transcribe.json | 727 +- 10 files changed, 13872 insertions(+), 2274 deletions(-) create mode 100644 codegen/sdk-codegen/aws-models/b2bi.json diff --git a/codegen/sdk-codegen/aws-models/appsync.json b/codegen/sdk-codegen/aws-models/appsync.json index 2c5f5736d66..382fa992100 100644 --- a/codegen/sdk-codegen/aws-models/appsync.json +++ b/codegen/sdk-codegen/aws-models/appsync.json @@ -117,6 +117,9 @@ { "target": "com.amazonaws.appsync#GetDataSource" }, + { + "target": "com.amazonaws.appsync#GetDataSourceIntrospection" + }, { "target": "com.amazonaws.appsync#GetDomainName" }, @@ -174,6 +177,9 @@ { "target": "com.amazonaws.appsync#ListTypesByAssociation" }, + { + "target": "com.amazonaws.appsync#StartDataSourceIntrospection" + }, { "target": "com.amazonaws.appsync#StartSchemaCreation" }, @@ -273,7 +279,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -316,7 +321,8 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -329,7 +335,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -343,7 +348,6 @@ "assign": "PartitionResult" } ], - "type": "tree", "rules": [ { "conditions": [ @@ -366,7 +370,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -401,7 +404,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -412,14 +414,16 @@ }, "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": [ @@ -433,14 +437,12 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ - true, { "fn": "getAttr", "argv": [ @@ -449,11 +451,11 @@ }, "supportsFIPS" ] - } + }, + true ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -464,14 +466,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -485,7 +489,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -505,7 +508,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -516,14 +518,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [], @@ -534,9 +538,11 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], @@ -3071,6 +3077,196 @@ "smithy.api#documentation": "

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.

" + } + }, + "primaryKey": { + "target": "com.amazonaws.appsync#DataSourceIntrospectionModelIndex", + "traits": { + "smithy.api#documentation": "

The primary key stored as a DataSourceIntrospectionModelIndex object.

" + } + }, + "indexes": { + "target": "com.amazonaws.appsync#DataSourceIntrospectionModelIndexes", + "traits": { + "smithy.api#documentation": "

The array of DataSourceIntrospectionModelIndex objects.

" + } + }, + "sdl": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "

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.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

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.

" + } + }, + "length": { + "target": "com.amazonaws.appsync#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

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.

\n

Valid values include:

\n " + } + }, + "name": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "

The name of the data type that represents the field. For example, String is a valid\n name value.

" + } + }, + "type": { + "target": "com.amazonaws.appsync#DataSourceIntrospectionModelFieldType", + "traits": { + "smithy.api#documentation": "

The DataSourceIntrospectionModelFieldType object data. The type is only present if\n DataSourceIntrospectionModelFieldType.kind is set to NonNull or List.

\n

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.

" + } + }, + "values": { + "target": "com.amazonaws.appsync#DataSourceIntrospectionModelFieldTypeValues", + "traits": { + "smithy.api#documentation": "

The values of the type field. This field represents the AppSync data type equivalent of the\n introspected field.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

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.

" + } + }, + "nextToken": { + "target": "com.amazonaws.appsync#PaginationToken", + "traits": { + "smithy.api#documentation": "

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.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the output of a DataSourceIntrospectionResult. This is the populated result of a\n GetDataSourceIntrospection operation.

" + } + }, + "com.amazonaws.appsync#DataSourceIntrospectionStatus": { + "type": "enum", + "members": { + "PROCESSING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROCESSING" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "SUCCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCESS" + } + } + } + }, "com.amazonaws.appsync#DataSourceType": { "type": "enum", "members": { @@ -4567,6 +4763,105 @@ } } }, + "com.amazonaws.appsync#GetDataSourceIntrospection": { + "type": "operation", + "input": { + "target": "com.amazonaws.appsync#GetDataSourceIntrospectionRequest" + }, + "output": { + "target": "com.amazonaws.appsync#GetDataSourceIntrospectionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appsync#BadRequestException" + }, + { + "target": "com.amazonaws.appsync#InternalFailureException" + }, + { + "target": "com.amazonaws.appsync#NotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

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.

", + "smithy.api#httpQuery": "includeModelsSDL" + } + }, + "nextToken": { + "target": "com.amazonaws.appsync#PaginationToken", + "traits": { + "smithy.api#documentation": "

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.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.appsync#MaxResults", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

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.

" + } + }, + "introspectionStatusDetail": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "

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.

" + } + }, + "introspectionResult": { + "target": "com.amazonaws.appsync#DataSourceIntrospectionResult", + "traits": { + "smithy.api#documentation": "

The DataSourceIntrospectionResult object data.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.appsync#GetDataSourceRequest": { "type": "structure", "members": { @@ -6592,6 +6887,64 @@ "smithy.api#documentation": "

The pipeline configuration for a resolver of kind PIPELINE.

" } }, + "com.amazonaws.appsync#RdsDataApiConfig": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.appsync#RdsDataApiConfigResourceArn", + "traits": { + "smithy.api#documentation": "

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": { @@ -7037,6 +7390,77 @@ "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.

", + "smithy.api#http": { + "method": "POST", + "uri": "/v1/datasources/introspections", + "code": 200 + } + } + }, + "com.amazonaws.appsync#StartDataSourceIntrospectionRequest": { + "type": "structure", + "members": { + "rdsDataApiConfig": { + "target": "com.amazonaws.appsync#RdsDataApiConfig", + "traits": { + "smithy.api#documentation": "

The rdsDataApiConfig object data.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appsync#StartDataSourceIntrospectionResponse": { + "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 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.

" + } + }, + "introspectionStatusDetail": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "

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.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.appsync#StartSchemaCreation": { "type": "operation", "input": { diff --git a/codegen/sdk-codegen/aws-models/b2bi.json b/codegen/sdk-codegen/aws-models/b2bi.json new file mode 100644 index 00000000000..046399e23d6 --- /dev/null +++ b/codegen/sdk-codegen/aws-models/b2bi.json @@ -0,0 +1,5430 @@ +{ + "smithy": "2.0", + "shapes": { + "com.amazonaws.b2bi#AccessDeniedException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.b2bi#ErrorMessage", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

You do not have sufficient access to perform this action.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.b2bi#AmazonResourceName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1011 + } + } + }, + "com.amazonaws.b2bi#B2BI": { + "type": "service", + "version": "2022-06-23", + "operations": [ + { + "target": "com.amazonaws.b2bi#GetTransformerJob" + }, + { + "target": "com.amazonaws.b2bi#ListTagsForResource" + }, + { + "target": "com.amazonaws.b2bi#StartTransformerJob" + }, + { + "target": "com.amazonaws.b2bi#TagResource" + }, + { + "target": "com.amazonaws.b2bi#TestMapping" + }, + { + "target": "com.amazonaws.b2bi#TestParsing" + }, + { + "target": "com.amazonaws.b2bi#UntagResource" + } + ], + "resources": [ + { + "target": "com.amazonaws.b2bi#Capability" + }, + { + "target": "com.amazonaws.b2bi#Partnership" + }, + { + "target": "com.amazonaws.b2bi#Profile" + }, + { + "target": "com.amazonaws.b2bi#Transformer" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "b2bi", + "endpointPrefix": "b2bi" + }, + "aws.api#tagEnabled": {}, + "aws.auth#sigv4": { + "name": "b2bi" + }, + "aws.protocols#awsJson1_0": {}, + "smithy.api#cors": {}, + "smithy.api#documentation": "

This is the Amazon Web Services B2B Data Interchange API Reference. It provides descriptions, API request parameters, and the XML response for each of the B2BI API actions.

\n

B2BI enables automated exchange of EDI (electronic data interchange) based business-critical transactions at cloud\n scale, with elasticity and pay-as-you-go pricing. Businesses use EDI documents to exchange\n transactional data with trading partners, such as suppliers and end customers, using\n standardized formats such as X12.

\n \n

Rather than actually running a command, you can use the\n --generate-cli-skeleton parameter with any API call to generate and display\n a parameter template. You can then use the generated template to customize and use as input\n on a later command. For details, see Generate and use a parameter skeleton file.

\n ", + "smithy.api#title": "AWS B2B Data Interchange", + "smithy.api#unstable": {}, + "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://b2bi-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://b2bi-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://b2bi.{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://b2bi.{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://b2bi-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://b2bi-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://b2bi.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://b2bi.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://b2bi-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://b2bi-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://b2bi.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://b2bi.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://b2bi-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://b2bi-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://b2bi.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://b2bi.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://b2bi-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://b2bi.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://b2bi-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://b2bi.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.b2bi#BucketName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 63 + } + } + }, + "com.amazonaws.b2bi#BusinessName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 254 + } + } + }, + "com.amazonaws.b2bi#Capability": { + "type": "resource", + "identifiers": { + "capabilityId": { + "target": "com.amazonaws.b2bi#CapabilityId" + } + }, + "create": { + "target": "com.amazonaws.b2bi#CreateCapability" + }, + "read": { + "target": "com.amazonaws.b2bi#GetCapability" + }, + "update": { + "target": "com.amazonaws.b2bi#UpdateCapability" + }, + "delete": { + "target": "com.amazonaws.b2bi#DeleteCapability" + }, + "list": { + "target": "com.amazonaws.b2bi#ListCapabilities" + }, + "traits": { + "aws.api#arn": { + "template": "capabilities/{capabilityId}" + }, + "aws.api#taggable": { + "property": "tags" + }, + "aws.cloudformation#cfnResource": { + "additionalSchemas": [ + "com.amazonaws.b2bi#CapabilitySummary" + ] + }, + "smithy.api#unstable": {} + } + }, + "com.amazonaws.b2bi#CapabilityConfiguration": { + "type": "union", + "members": { + "edi": { + "target": "com.amazonaws.b2bi#EdiConfiguration", + "traits": { + "smithy.api#documentation": "

An EDI (electronic data interchange) configuration object.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A capability object. Currently, only EDI (electronic data interchange) capabilities are supported. Capabilities contain the information necessary to process incoming EDI (electronic data interchange) documents.

" + } + }, + "com.amazonaws.b2bi#CapabilityId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_-]+$" + } + }, + "com.amazonaws.b2bi#CapabilityList": { + "type": "list", + "member": { + "target": "com.amazonaws.b2bi#CapabilitySummary" + } + }, + "com.amazonaws.b2bi#CapabilityName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 254 + } + } + }, + "com.amazonaws.b2bi#CapabilitySummary": { + "type": "structure", + "members": { + "capabilityId": { + "target": "com.amazonaws.b2bi#CapabilityId", + "traits": { + "smithy.api#documentation": "

Returns a system-assigned unique identifier for the capability.

", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.b2bi#CapabilityName", + "traits": { + "smithy.api#documentation": "

The display name of the capability.

", + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.b2bi#CapabilityType", + "traits": { + "smithy.api#documentation": "

Returns the type of the capability. Currently, only edi is supported.

", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.b2bi#CreatedDate", + "traits": { + "smithy.api#documentation": "

Returns a timestamp for creation date and time of the capability.

", + "smithy.api#required": {} + } + }, + "modifiedAt": { + "target": "com.amazonaws.b2bi#ModifiedDate", + "traits": { + "smithy.api#documentation": "

Returns a timestamp that identifies the most recent date and time that the capability was modified.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Returns the capability summary details. Capabilities contain the information necessary to process incoming EDI (electronic data interchange) documents.

" + } + }, + "com.amazonaws.b2bi#CapabilityType": { + "type": "enum", + "members": { + "EDI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "edi" + } + } + } + }, + "com.amazonaws.b2bi#ConflictException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.b2bi#ErrorMessage", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A conflict exception is thrown when you attempt to delete a resource (such as a profile or a capability) that is being used by other resources.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.b2bi#CreateCapability": { + "type": "operation", + "input": { + "target": "com.amazonaws.b2bi#CreateCapabilityRequest" + }, + "output": { + "target": "com.amazonaws.b2bi#CreateCapabilityResponse" + }, + "errors": [ + { + "target": "com.amazonaws.b2bi#AccessDeniedException" + }, + { + "target": "com.amazonaws.b2bi#ConflictException" + }, + { + "target": "com.amazonaws.b2bi#InternalServerException" + }, + { + "target": "com.amazonaws.b2bi#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.b2bi#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.b2bi#ThrottlingException" + }, + { + "target": "com.amazonaws.b2bi#ValidationException" + } + ], + "traits": { + "aws.iam#requiredActions": [ + "b2bi:TagResource" + ], + "smithy.api#documentation": "

Instantiates a capability based on the specified parameters. Capabilities contain the information necessary to process incoming EDI (electronic data interchange) documents.

", + "smithy.api#examples": [ + { + "title": "Sample CreateCapability call", + "input": { + "name": "b2biexample", + "type": "edi", + "configuration": { + "edi": { + "type": { + "x12Details": { + "transactionSet": "X12_110", + "version": "VERSION_4010" + } + }, + "inputLocation": { + "bucketName": "test-bucket", + "key": "input/" + }, + "outputLocation": { + "bucketName": "test-bucket", + "key": "output/" + }, + "transformerId": "tr-9a893cf536df4658b" + } + }, + "instructionsDocuments": [ + { + "bucketName": "test-bucket", + "key": "instructiondoc.txt" + } + ], + "clientToken": "foo", + "tags": [ + { + "Key": "capabilityKey1", + "Value": "capabilityValue1" + } + ] + }, + "output": { + "capabilityArn": "arn:aws:b2bi:us-west-2:123456789012:capability/ca-963a8121e4fc4e348", + "capabilityId": "ca-963a8121e4fc4e348", + "createdAt": "2023-11-01T21:51:05.504Z", + "configuration": { + "edi": { + "type": { + "x12Details": { + "transactionSet": "X12_110", + "version": "VERSION_4010" + } + }, + "inputLocation": { + "bucketName": "test-bucket", + "key": "input/" + }, + "outputLocation": { + "bucketName": "test-bucket", + "key": "output/" + }, + "transformerId": "tr-9a893cf536df4658b" + } + }, + "instructionsDocuments": [ + { + "bucketName": "test-bucket", + "key": "instructiondoc.txt" + } + ], + "name": "b2biexample", + "type": "edi" + } + } + ], + "smithy.api#http": { + "code": 201, + "uri": "/capabilities", + "method": "POST" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.b2bi#CreateCapabilityRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.b2bi#CapabilityName", + "traits": { + "smithy.api#documentation": "

Specifies the name of the capability, used to identify it.

", + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.b2bi#CapabilityType", + "traits": { + "smithy.api#documentation": "

Specifies the type of the capability. Currently, only edi is supported.

", + "smithy.api#required": {} + } + }, + "configuration": { + "target": "com.amazonaws.b2bi#CapabilityConfiguration", + "traits": { + "smithy.api#documentation": "

Specifies a structure that contains the details for a capability.

", + "smithy.api#required": {} + } + }, + "instructionsDocuments": { + "target": "com.amazonaws.b2bi#InstructionsDocuments", + "traits": { + "smithy.api#documentation": "

Specifies one or more locations in Amazon S3, each specifying an EDI document that can be used with this capability. Each item contains the name of the bucket and the key, to identify the document's location.

" + } + }, + "clientToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

Reserved for future use.

", + "smithy.api#idempotencyToken": {} + } + }, + "tags": { + "target": "com.amazonaws.b2bi#TagList", + "traits": { + "aws.cloudformation#cfnMutability": "full", + "smithy.api#documentation": "

Specifies the key-value pairs assigned to ARNs that you can use to group and search for resources by type. You can attach this metadata to resources (capabilities, partnerships, and so on) for any purpose.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.b2bi#CreateCapabilityResponse": { + "type": "structure", + "members": { + "capabilityId": { + "target": "com.amazonaws.b2bi#CapabilityId", + "traits": { + "smithy.api#documentation": "

Returns a system-assigned unique identifier for the capability.

", + "smithy.api#required": {} + } + }, + "capabilityArn": { + "target": "com.amazonaws.b2bi#ResourceArn", + "traits": { + "smithy.api#documentation": "

Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.

", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.b2bi#CapabilityName", + "traits": { + "smithy.api#documentation": "

Returns the name of the capability used to identify it.

", + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.b2bi#CapabilityType", + "traits": { + "smithy.api#documentation": "

Returns the type of the capability. Currently, only edi is supported.

", + "smithy.api#required": {} + } + }, + "configuration": { + "target": "com.amazonaws.b2bi#CapabilityConfiguration", + "traits": { + "smithy.api#documentation": "

Returns a structure that contains the details for a capability.

", + "smithy.api#required": {} + } + }, + "instructionsDocuments": { + "target": "com.amazonaws.b2bi#InstructionsDocuments", + "traits": { + "smithy.api#documentation": "

Returns one or more locations in Amazon S3, each specifying an EDI document that can be used with this capability. Each item contains the name of the bucket and the key, to identify the document's location.

" + } + }, + "createdAt": { + "target": "com.amazonaws.b2bi#CreatedDate", + "traits": { + "smithy.api#documentation": "

Returns a timestamp for creation date and time of the capability.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.b2bi#CreatePartnership": { + "type": "operation", + "input": { + "target": "com.amazonaws.b2bi#CreatePartnershipRequest" + }, + "output": { + "target": "com.amazonaws.b2bi#CreatePartnershipResponse" + }, + "errors": [ + { + "target": "com.amazonaws.b2bi#AccessDeniedException" + }, + { + "target": "com.amazonaws.b2bi#ConflictException" + }, + { + "target": "com.amazonaws.b2bi#InternalServerException" + }, + { + "target": "com.amazonaws.b2bi#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.b2bi#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.b2bi#ThrottlingException" + }, + { + "target": "com.amazonaws.b2bi#ValidationException" + } + ], + "traits": { + "aws.iam#requiredActions": [ + "b2bi:TagResource" + ], + "smithy.api#documentation": "

Creates a partnership between a customer and a trading partner, based on the supplied parameters. Partnerships link trading partners with your profile and a specific transformer, so that the EDI (electronic data interchange) documents that they upload to Amazon S3 can be processed according to their specifications.

", + "smithy.api#examples": [ + { + "title": "Sample CreatePartnership call", + "input": { + "capabilities": [ + "ca-963a8121e4fc4e348" + ], + "clientToken": "foo", + "email": "john@example.com", + "name": "b2bipartner", + "phone": "5555555555", + "profileId": "p-60fbc37c87f04fce9", + "tags": [ + { + "Key": "sampleKey1", + "Value": "sampleValue1" + } + ] + }, + "output": { + "capabilities": [ + "ca-963a8121e4fc4e348" + ], + "createdAt": "2023-11-01T21:51:05.504Z", + "email": "john@example.com", + "name": "b2bipartner", + "partnershipArn": "arn:aws:b2bi:us-west-2:123456789012:partnership/ps-60fbc37c87f04fce9", + "partnershipId": "ps-219fa02f5b4242af8", + "phone": "5555555555", + "profileId": "p-60fbc37c87f04fce9", + "tradingPartnerId": "tp-2a17ca447f6f4a8a8" + } + } + ], + "smithy.api#http": { + "code": 201, + "uri": "/partnerships", + "method": "POST" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.b2bi#CreatePartnershipRequest": { + "type": "structure", + "members": { + "profileId": { + "target": "com.amazonaws.b2bi#ProfileId", + "traits": { + "smithy.api#documentation": "

Specifies the unique, system-generated identifier for the profile connected to this partnership.

", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.b2bi#PartnerName", + "traits": { + "smithy.api#documentation": "

Specifies a descriptive name for the partnership.

", + "smithy.api#required": {} + } + }, + "email": { + "target": "com.amazonaws.b2bi#Email", + "traits": { + "smithy.api#documentation": "

Specifies the email address associated with this trading partner.

", + "smithy.api#required": {} + } + }, + "phone": { + "target": "com.amazonaws.b2bi#Phone", + "traits": { + "smithy.api#documentation": "

Specifies the phone number associated with the partnership.

" + } + }, + "capabilities": { + "target": "com.amazonaws.b2bi#PartnershipCapabilities", + "traits": { + "smithy.api#documentation": "

Specifies a list of the capabilities associated with this partnership.

" + } + }, + "clientToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

Reserved for future use.

", + "smithy.api#idempotencyToken": {} + } + }, + "tags": { + "target": "com.amazonaws.b2bi#TagList", + "traits": { + "aws.cloudformation#cfnMutability": "full", + "smithy.api#documentation": "

Specifies the key-value pairs assigned to ARNs that you can use to group and search for resources by type. You can attach this metadata to resources (capabilities, partnerships, and so on) for any purpose.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.b2bi#CreatePartnershipResponse": { + "type": "structure", + "members": { + "profileId": { + "target": "com.amazonaws.b2bi#ProfileId", + "traits": { + "smithy.api#documentation": "

Returns the unique, system-generated identifier for the profile connected to this partnership.

", + "smithy.api#required": {} + } + }, + "partnershipId": { + "target": "com.amazonaws.b2bi#PartnershipId", + "traits": { + "smithy.api#documentation": "

Returns the unique, system-generated identifier for a partnership.

", + "smithy.api#required": {} + } + }, + "partnershipArn": { + "target": "com.amazonaws.b2bi#ResourceArn", + "traits": { + "smithy.api#documentation": "

Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.

", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.b2bi#PartnerName", + "traits": { + "smithy.api#documentation": "

Returns a descriptive name for the partnership.

" + } + }, + "email": { + "target": "com.amazonaws.b2bi#Email", + "traits": { + "smithy.api#documentation": "

Returns the email address associated with this trading partner.

" + } + }, + "phone": { + "target": "com.amazonaws.b2bi#Phone", + "traits": { + "smithy.api#documentation": "

Returns the phone number associated with the partnership.

" + } + }, + "capabilities": { + "target": "com.amazonaws.b2bi#PartnershipCapabilities", + "traits": { + "smithy.api#documentation": "

Returns one or more capabilities associated with this partnership.

" + } + }, + "tradingPartnerId": { + "target": "com.amazonaws.b2bi#TradingPartnerId", + "traits": { + "smithy.api#documentation": "

Returns the unique, system-generated identifier for a trading partner.

" + } + }, + "createdAt": { + "target": "com.amazonaws.b2bi#CreatedDate", + "traits": { + "smithy.api#documentation": "

Returns a timestamp for creation date and time of the partnership.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.b2bi#CreateProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.b2bi#CreateProfileRequest" + }, + "output": { + "target": "com.amazonaws.b2bi#CreateProfileResponse" + }, + "errors": [ + { + "target": "com.amazonaws.b2bi#AccessDeniedException" + }, + { + "target": "com.amazonaws.b2bi#ConflictException" + }, + { + "target": "com.amazonaws.b2bi#InternalServerException" + }, + { + "target": "com.amazonaws.b2bi#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.b2bi#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.b2bi#ThrottlingException" + }, + { + "target": "com.amazonaws.b2bi#ValidationException" + } + ], + "traits": { + "aws.iam#requiredActions": [ + "b2bi:TagResource", + "logs:CreateLogDelivery", + "logs:CreateLogGroup", + "logs:CreateLogStream", + "logs:DeleteLogDelivery", + "logs:DescribeLogGroups", + "logs:DescribeLogStreams", + "logs:DescribeResourcePolicies", + "logs:ListLogDeliveries", + "logs:PutLogEvents", + "logs:PutResourcePolicy" + ], + "smithy.api#documentation": "

Creates a customer profile. You can have up to five customer profiles, each representing a distinct private network. Profiles contain basic information about you and your business.

", + "smithy.api#examples": [ + { + "title": "Sample CreateProfile call", + "input": { + "businessName": "John's Shipping", + "clientToken": "foo", + "email": "john@example.com", + "logging": "ENABLED", + "name": "Shipping Profile", + "phone": "5555555555", + "tags": [ + { + "Key": "sampleKey", + "Value": "sampleValue" + } + ] + }, + "output": { + "businessName": "John's Trucking", + "createdAt": "2023-11-01T21:51:05.504Z", + "email": "john@example.com", + "logging": "ENABLED", + "logGroupName": "b2bi/p-60fbc37c87f04fce9-Logs", + "name": "Shipping Profile", + "phone": "5555555555", + "profileArn": "arn:aws:b2bi:us-west-2:123456789012:profile/p-60fbc37c87f04fce9", + "profileId": "p-60fbc37c87f04fce9" + } + } + ], + "smithy.api#http": { + "code": 201, + "uri": "/profiles", + "method": "POST" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.b2bi#CreateProfileRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.b2bi#ProfileName", + "traits": { + "smithy.api#documentation": "

Specifies the name of the profile.

", + "smithy.api#required": {} + } + }, + "email": { + "target": "com.amazonaws.b2bi#Email", + "traits": { + "smithy.api#documentation": "

Specifies the email address associated with this customer profile.

" + } + }, + "phone": { + "target": "com.amazonaws.b2bi#Phone", + "traits": { + "smithy.api#documentation": "

Specifies the phone number associated with the profile.

", + "smithy.api#required": {} + } + }, + "businessName": { + "target": "com.amazonaws.b2bi#BusinessName", + "traits": { + "smithy.api#documentation": "

Specifies the name for the business associated with this profile.

", + "smithy.api#required": {} + } + }, + "logging": { + "target": "com.amazonaws.b2bi#Logging", + "traits": { + "smithy.api#documentation": "

Specifies whether or not logging is enabled for this profile.

", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

Reserved for future use.

", + "smithy.api#idempotencyToken": {} + } + }, + "tags": { + "target": "com.amazonaws.b2bi#TagList", + "traits": { + "aws.cloudformation#cfnMutability": "full", + "smithy.api#documentation": "

Specifies the key-value pairs assigned to ARNs that you can use to group and search for resources by type. You can attach this metadata to resources (capabilities, partnerships, and so on) for any purpose.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.b2bi#CreateProfileResponse": { + "type": "structure", + "members": { + "profileId": { + "target": "com.amazonaws.b2bi#ProfileId", + "traits": { + "smithy.api#documentation": "

Returns the unique, system-generated identifier for the profile.

", + "smithy.api#required": {} + } + }, + "profileArn": { + "target": "com.amazonaws.b2bi#ResourceArn", + "traits": { + "smithy.api#documentation": "

Returns an Amazon Resource Name (ARN) for the profile.

", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.b2bi#ProfileName", + "traits": { + "smithy.api#documentation": "

Returns the name of the profile, used to identify it.

", + "smithy.api#required": {} + } + }, + "businessName": { + "target": "com.amazonaws.b2bi#BusinessName", + "traits": { + "smithy.api#documentation": "

Returns the name for the business associated with this profile.

", + "smithy.api#required": {} + } + }, + "phone": { + "target": "com.amazonaws.b2bi#Phone", + "traits": { + "smithy.api#documentation": "

Returns the phone number associated with the profile.

", + "smithy.api#required": {} + } + }, + "email": { + "target": "com.amazonaws.b2bi#Email", + "traits": { + "smithy.api#documentation": "

Returns the email address associated with this customer profile.

" + } + }, + "logging": { + "target": "com.amazonaws.b2bi#Logging", + "traits": { + "smithy.api#documentation": "

Returns whether or not logging is turned on for this profile.

" + } + }, + "logGroupName": { + "target": "com.amazonaws.b2bi#LogGroupName", + "traits": { + "smithy.api#documentation": "

Returns the name of the logging group.

" + } + }, + "createdAt": { + "target": "com.amazonaws.b2bi#CreatedDate", + "traits": { + "smithy.api#documentation": "

Returns a timestamp representing the time the profile was created.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.b2bi#CreateTransformer": { + "type": "operation", + "input": { + "target": "com.amazonaws.b2bi#CreateTransformerRequest" + }, + "output": { + "target": "com.amazonaws.b2bi#CreateTransformerResponse" + }, + "errors": [ + { + "target": "com.amazonaws.b2bi#AccessDeniedException" + }, + { + "target": "com.amazonaws.b2bi#ConflictException" + }, + { + "target": "com.amazonaws.b2bi#InternalServerException" + }, + { + "target": "com.amazonaws.b2bi#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.b2bi#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.b2bi#ThrottlingException" + }, + { + "target": "com.amazonaws.b2bi#ValidationException" + } + ], + "traits": { + "aws.iam#requiredActions": [ + "b2bi:TagResource" + ], + "smithy.api#documentation": "

Creates a transformer. Transformers describe how to process the incoming EDI (electronic data interchange) documents, and extract the necessary information.

", + "smithy.api#examples": [ + { + "title": "Sample CreateTransformer call", + "input": { + "clientToken": "foo", + "ediType": { + "x12Details": { + "transactionSet": "X12_110", + "version": "VERSION_4010" + } + }, + "fileFormat": "JSON", + "mappingTemplate": "{}", + "name": "transformJSON", + "sampleDocument": "s3://test-bucket/sampleDoc.txt", + "tags": [ + { + "Key": "sampleKey", + "Value": "sampleValue" + } + ] + }, + "output": { + "createdAt": "2023-11-01T21:51:05.504Z", + "ediType": { + "x12Details": { + "transactionSet": "X12_110", + "version": "VERSION_4010" + } + }, + "fileFormat": "JSON", + "mappingTemplate": "$", + "name": "transformJSON", + "sampleDocument": "s3://test-bucket/sampleDoc.txt", + "status": "inactive", + "transformerArn": "arn:aws:b2bi:us-west-2:123456789012:transformer/tr-974c129999f84d8c9", + "transformerId": "tr-974c129999f84d8c9" + } + } + ], + "smithy.api#http": { + "code": 201, + "uri": "/transformers", + "method": "POST" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.b2bi#CreateTransformerRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.b2bi#TransformerName", + "traits": { + "smithy.api#documentation": "

Specifies the name of the transformer, used to identify it.

", + "smithy.api#required": {} + } + }, + "fileFormat": { + "target": "com.amazonaws.b2bi#FileFormat", + "traits": { + "smithy.api#documentation": "

Specifies that the currently supported file formats for EDI transformations are JSON and XML.

", + "smithy.api#required": {} + } + }, + "mappingTemplate": { + "target": "com.amazonaws.b2bi#MappingTemplate", + "traits": { + "smithy.api#documentation": "

Specifies the name of the mapping template for the transformer. This template is used to convert the input document into the\n correct set of objects.

", + "smithy.api#required": {} + } + }, + "ediType": { + "target": "com.amazonaws.b2bi#EdiType", + "traits": { + "smithy.api#documentation": "

Specifies the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.

", + "smithy.api#required": {} + } + }, + "sampleDocument": { + "target": "com.amazonaws.b2bi#FileLocation", + "traits": { + "smithy.api#documentation": "

Specifies a sample EDI document that is used by a transformer as a guide for processing the EDI data.

" + } + }, + "clientToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

Reserved for future use.

", + "smithy.api#idempotencyToken": {} + } + }, + "tags": { + "target": "com.amazonaws.b2bi#TagList", + "traits": { + "aws.cloudformation#cfnMutability": "full", + "smithy.api#documentation": "

Specifies the key-value pairs assigned to ARNs that you can use to group and search for resources by type. You can attach this metadata to resources (capabilities, partnerships, and so on) for any purpose.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.b2bi#CreateTransformerResponse": { + "type": "structure", + "members": { + "transformerId": { + "target": "com.amazonaws.b2bi#TransformerId", + "traits": { + "smithy.api#documentation": "

Returns the system-assigned unique identifier for the transformer.

", + "smithy.api#required": {} + } + }, + "transformerArn": { + "target": "com.amazonaws.b2bi#ResourceArn", + "traits": { + "smithy.api#documentation": "

Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.

", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.b2bi#TransformerName", + "traits": { + "smithy.api#documentation": "

Returns the name of the transformer, used to identify it.

", + "smithy.api#required": {} + } + }, + "fileFormat": { + "target": "com.amazonaws.b2bi#FileFormat", + "traits": { + "smithy.api#documentation": "

Returns that the currently supported file formats for EDI transformations are JSON and XML.

", + "smithy.api#required": {} + } + }, + "mappingTemplate": { + "target": "com.amazonaws.b2bi#MappingTemplate", + "traits": { + "smithy.api#documentation": "

Returns the name of the mapping template for the transformer. This template is used to convert the input document into the\n correct set of objects.

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.b2bi#TransformerStatus", + "traits": { + "smithy.api#documentation": "

Returns the state of the newly created transformer. The transformer can be either\n active or inactive. For the transformer to be used in a\n capability, its status must active.

", + "smithy.api#required": {} + } + }, + "ediType": { + "target": "com.amazonaws.b2bi#EdiType", + "traits": { + "smithy.api#documentation": "

Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.

", + "smithy.api#required": {} + } + }, + "sampleDocument": { + "target": "com.amazonaws.b2bi#FileLocation", + "traits": { + "smithy.api#documentation": "

Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.

" + } + }, + "createdAt": { + "target": "com.amazonaws.b2bi#CreatedDate", + "traits": { + "smithy.api#documentation": "

Returns a timestamp for creation date and time of the transformer.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.b2bi#CreatedDate": { + "type": "timestamp", + "traits": { + "smithy.api#timestampFormat": "date-time" + } + }, + "com.amazonaws.b2bi#DeleteCapability": { + "type": "operation", + "input": { + "target": "com.amazonaws.b2bi#DeleteCapabilityRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.b2bi#AccessDeniedException" + }, + { + "target": "com.amazonaws.b2bi#ConflictException" + }, + { + "target": "com.amazonaws.b2bi#InternalServerException" + }, + { + "target": "com.amazonaws.b2bi#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.b2bi#ThrottlingException" + }, + { + "target": "com.amazonaws.b2bi#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the specified capability. Capabilities contain the information necessary to process incoming EDI (electronic data interchange) documents.

", + "smithy.api#examples": [ + { + "title": "Sample DeleteCapabilty call", + "input": { + "capabilityId": "ca-963a8121e4fc4e348" + } + } + ], + "smithy.api#http": { + "code": 200, + "uri": "/capabilities/{capabilityId}", + "method": "DELETE" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.b2bi#DeleteCapabilityRequest": { + "type": "structure", + "members": { + "capabilityId": { + "target": "com.amazonaws.b2bi#CapabilityId", + "traits": { + "smithy.api#documentation": "

Specifies a system-assigned unique identifier for the capability.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.b2bi#DeletePartnership": { + "type": "operation", + "input": { + "target": "com.amazonaws.b2bi#DeletePartnershipRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.b2bi#AccessDeniedException" + }, + { + "target": "com.amazonaws.b2bi#ConflictException" + }, + { + "target": "com.amazonaws.b2bi#InternalServerException" + }, + { + "target": "com.amazonaws.b2bi#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.b2bi#ThrottlingException" + }, + { + "target": "com.amazonaws.b2bi#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the specified partnership. Partnerships link trading partners with your profile and a specific transformer, so that the EDI (electronic data interchange) documents that they upload to Amazon S3 can be processed according to their specifications.

", + "smithy.api#examples": [ + { + "title": "Sample DeletePartnership call", + "input": { + "partnershipId": "ps-219fa02f5b4242af8" + } + } + ], + "smithy.api#http": { + "code": 200, + "uri": "/partnerships/{partnershipId}", + "method": "DELETE" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.b2bi#DeletePartnershipRequest": { + "type": "structure", + "members": { + "partnershipId": { + "target": "com.amazonaws.b2bi#PartnershipId", + "traits": { + "smithy.api#documentation": "

Specifies the unique, system-generated identifier for a partnership.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.b2bi#DeleteProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.b2bi#DeleteProfileRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.b2bi#AccessDeniedException" + }, + { + "target": "com.amazonaws.b2bi#ConflictException" + }, + { + "target": "com.amazonaws.b2bi#InternalServerException" + }, + { + "target": "com.amazonaws.b2bi#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.b2bi#ThrottlingException" + }, + { + "target": "com.amazonaws.b2bi#ValidationException" + } + ], + "traits": { + "aws.iam#requiredActions": [ + "logs:DeleteLogDelivery", + "logs:ListLogDeliveries" + ], + "smithy.api#documentation": "

Deletes the specified profile. Profiles contain basic information about you and your business.

", + "smithy.api#examples": [ + { + "title": "Sample DeleteProfile call", + "input": { + "profileId": "p-60fbc37c87f04fce9" + } + } + ], + "smithy.api#http": { + "code": 200, + "uri": "/profiles/{profileId}", + "method": "DELETE" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.b2bi#DeleteProfileRequest": { + "type": "structure", + "members": { + "profileId": { + "target": "com.amazonaws.b2bi#ProfileId", + "traits": { + "smithy.api#documentation": "

Specifies the unique, system-generated identifier for the profile.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.b2bi#DeleteTransformer": { + "type": "operation", + "input": { + "target": "com.amazonaws.b2bi#DeleteTransformerRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.b2bi#AccessDeniedException" + }, + { + "target": "com.amazonaws.b2bi#ConflictException" + }, + { + "target": "com.amazonaws.b2bi#InternalServerException" + }, + { + "target": "com.amazonaws.b2bi#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.b2bi#ThrottlingException" + }, + { + "target": "com.amazonaws.b2bi#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the specified transformer. Transformers describe how to process the incoming EDI (electronic data interchange) documents, and extract the necessary information.

", + "smithy.api#examples": [ + { + "title": "Sample DeleteTransformer call", + "input": { + "transformerId": "tr-974c129999f84d8c9" + } + } + ], + "smithy.api#http": { + "code": 200, + "uri": "/transformers/{transformerId}", + "method": "DELETE" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.b2bi#DeleteTransformerRequest": { + "type": "structure", + "members": { + "transformerId": { + "target": "com.amazonaws.b2bi#TransformerId", + "traits": { + "smithy.api#documentation": "

Specifies the system-assigned unique identifier for the transformer.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.b2bi#EdiConfiguration": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.b2bi#EdiType", + "traits": { + "smithy.api#documentation": "

Returns the type of the capability. Currently, only edi is supported.

", + "smithy.api#required": {} + } + }, + "inputLocation": { + "target": "com.amazonaws.b2bi#S3Location", + "traits": { + "smithy.api#documentation": "

Contains the Amazon S3 bucket and prefix for the location of the input file, which is contained in an S3Location object.

", + "smithy.api#required": {} + } + }, + "outputLocation": { + "target": "com.amazonaws.b2bi#S3Location", + "traits": { + "smithy.api#documentation": "

Contains the Amazon S3 bucket and prefix for the location of the output file, which is contained in an S3Location object.

", + "smithy.api#required": {} + } + }, + "transformerId": { + "target": "com.amazonaws.b2bi#TransformerId", + "traits": { + "smithy.api#documentation": "

Returns the system-assigned unique identifier for the transformer.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the details for the EDI (electronic data interchange) transformation.

" + } + }, + "com.amazonaws.b2bi#EdiType": { + "type": "union", + "members": { + "x12Details": { + "target": "com.amazonaws.b2bi#X12Details", + "traits": { + "smithy.api#documentation": "

Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.

" + } + }, + "com.amazonaws.b2bi#Email": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 5, + "max": 254 + }, + "smithy.api#pattern": "^[\\w\\.\\-]+@[\\w\\.\\-]+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.b2bi#ErrorMessage": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 10, + "max": 1024 + } + } + }, + "com.amazonaws.b2bi#FileFormat": { + "type": "enum", + "members": { + "XML": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "XML" + } + }, + "JSON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JSON" + } + } + } + }, + "com.amazonaws.b2bi#FileLocation": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, + "com.amazonaws.b2bi#GetCapability": { + "type": "operation", + "input": { + "target": "com.amazonaws.b2bi#GetCapabilityRequest" + }, + "output": { + "target": "com.amazonaws.b2bi#GetCapabilityResponse" + }, + "errors": [ + { + "target": "com.amazonaws.b2bi#AccessDeniedException" + }, + { + "target": "com.amazonaws.b2bi#InternalServerException" + }, + { + "target": "com.amazonaws.b2bi#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.b2bi#ThrottlingException" + }, + { + "target": "com.amazonaws.b2bi#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the details for the specified capability. Capabilities contain the information necessary to process incoming EDI (electronic data interchange) documents.

", + "smithy.api#examples": [ + { + "title": "Sample GetCapabilty call", + "input": { + "capabilityId": "ca-963a8121e4fc4e348" + }, + "output": { + "capabilityArn": "arn:aws:b2bi:us-west-2:123456789012:capability/ca-963a8121e4fc4e348", + "capabilityId": "ca-963a8121e4fc4e348", + "configuration": { + "edi": { + "type": { + "x12Details": { + "transactionSet": "X12_110", + "version": "VERSION_4010" + } + }, + "inputLocation": { + "bucketName": "test-bucket", + "key": "input/" + }, + "outputLocation": { + "bucketName": "test-bucket", + "key": "output/" + }, + "transformerId": "tr-9a893cf536df4658b" + } + }, + "createdAt": "2023-11-01T21:51:05.504Z", + "instructionsDocuments": [ + { + "bucketName": "test-bucket", + "key": "instructiondoc.txt" + } + ], + "modifiedAt": "2023-11-02T21:51:05.504Z", + "name": "b2biexample", + "type": "edi" + } + } + ], + "smithy.api#http": { + "code": 200, + "uri": "/capabilities/{capabilityId}", + "method": "GET" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.b2bi#GetCapabilityRequest": { + "type": "structure", + "members": { + "capabilityId": { + "target": "com.amazonaws.b2bi#CapabilityId", + "traits": { + "smithy.api#documentation": "

Specifies a system-assigned unique identifier for the capability.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.b2bi#GetCapabilityResponse": { + "type": "structure", + "members": { + "capabilityId": { + "target": "com.amazonaws.b2bi#CapabilityId", + "traits": { + "smithy.api#documentation": "

Returns a system-assigned unique identifier for the capability.

", + "smithy.api#required": {} + } + }, + "capabilityArn": { + "target": "com.amazonaws.b2bi#ResourceArn", + "traits": { + "smithy.api#documentation": "

Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.

", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.b2bi#CapabilityName", + "traits": { + "smithy.api#documentation": "

Returns the name of the capability, used to identify it.

", + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.b2bi#CapabilityType", + "traits": { + "smithy.api#documentation": "

Returns the type of the capability. Currently, only edi is supported.

", + "smithy.api#required": {} + } + }, + "configuration": { + "target": "com.amazonaws.b2bi#CapabilityConfiguration", + "traits": { + "smithy.api#documentation": "

Returns a structure that contains the details for a capability.

", + "smithy.api#required": {} + } + }, + "instructionsDocuments": { + "target": "com.amazonaws.b2bi#InstructionsDocuments", + "traits": { + "smithy.api#documentation": "

Returns one or more locations in Amazon S3, each specifying an EDI document that can be used with this capability. Each item contains the name of the bucket and the key, to identify the document's location.

" + } + }, + "createdAt": { + "target": "com.amazonaws.b2bi#CreatedDate", + "traits": { + "smithy.api#documentation": "

Returns a timestamp for creation date and time of the capability.

", + "smithy.api#required": {} + } + }, + "modifiedAt": { + "target": "com.amazonaws.b2bi#ModifiedDate", + "traits": { + "smithy.api#documentation": "

Returns a timestamp for last time the capability was modified.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.b2bi#GetPartnership": { + "type": "operation", + "input": { + "target": "com.amazonaws.b2bi#GetPartnershipRequest" + }, + "output": { + "target": "com.amazonaws.b2bi#GetPartnershipResponse" + }, + "errors": [ + { + "target": "com.amazonaws.b2bi#AccessDeniedException" + }, + { + "target": "com.amazonaws.b2bi#InternalServerException" + }, + { + "target": "com.amazonaws.b2bi#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.b2bi#ThrottlingException" + }, + { + "target": "com.amazonaws.b2bi#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the details for a partnership, based on the partner and profile IDs specified. Partnerships link trading partners with your profile and a specific transformer, so that the EDI (electronic data interchange) documents that they upload to Amazon S3 can be processed according to their specifications.

", + "smithy.api#examples": [ + { + "title": "Sample GetPartnership call", + "input": { + "partnershipId": "ps-219fa02f5b4242af8" + }, + "output": { + "capabilities": [ + "ca-963a8121e4fc4e348" + ], + "createdAt": "2023-11-01T21:51:05.504Z", + "email": "john@example.com", + "modifiedAt": "2023-11-01T21:51:05.504Z", + "name": "b2bipartner", + "partnershipArn": "arn:aws:b2bi:us-west-2:123456789012:partnership/ps-219fa02f5b4242af8", + "partnershipId": "ps-219fa02f5b4242af8", + "phone": "5555555555", + "profileId": "p-60fbc37c87f04fce9", + "tradingPartnerId": "tp-2a17ca447f6f4a8a8" + } + } + ], + "smithy.api#http": { + "code": 200, + "uri": "/partnerships/{partnershipId}", + "method": "GET" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.b2bi#GetPartnershipRequest": { + "type": "structure", + "members": { + "partnershipId": { + "target": "com.amazonaws.b2bi#PartnershipId", + "traits": { + "smithy.api#documentation": "

Specifies the unique, system-generated identifier for a partnership.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.b2bi#GetPartnershipResponse": { + "type": "structure", + "members": { + "profileId": { + "target": "com.amazonaws.b2bi#ProfileId", + "traits": { + "smithy.api#documentation": "

Returns the unique, system-generated identifier for the profile connected to this partnership.

", + "smithy.api#required": {} + } + }, + "partnershipId": { + "target": "com.amazonaws.b2bi#PartnershipId", + "traits": { + "smithy.api#documentation": "

Returns the unique, system-generated identifier for a partnership.

", + "smithy.api#required": {} + } + }, + "partnershipArn": { + "target": "com.amazonaws.b2bi#ResourceArn", + "traits": { + "smithy.api#documentation": "

Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.

", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.b2bi#PartnerName", + "traits": { + "smithy.api#documentation": "

Returns the display name of the partnership

" + } + }, + "email": { + "target": "com.amazonaws.b2bi#Email", + "traits": { + "smithy.api#documentation": "

Returns the email address associated with this trading partner.

" + } + }, + "phone": { + "target": "com.amazonaws.b2bi#Phone", + "traits": { + "smithy.api#documentation": "

Returns the phone number associated with the partnership.

" + } + }, + "capabilities": { + "target": "com.amazonaws.b2bi#PartnershipCapabilities", + "traits": { + "smithy.api#documentation": "

Returns one or more capabilities associated with this partnership.

" + } + }, + "tradingPartnerId": { + "target": "com.amazonaws.b2bi#TradingPartnerId", + "traits": { + "smithy.api#documentation": "

Returns the unique identifier for the partner for this partnership.

" + } + }, + "createdAt": { + "target": "com.amazonaws.b2bi#CreatedDate", + "traits": { + "smithy.api#documentation": "

Returns a timestamp for creation date and time of the partnership.

", + "smithy.api#required": {} + } + }, + "modifiedAt": { + "target": "com.amazonaws.b2bi#ModifiedDate", + "traits": { + "smithy.api#documentation": "

Returns a timestamp that identifies the most recent date and time that the partnership was modified.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.b2bi#GetProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.b2bi#GetProfileRequest" + }, + "output": { + "target": "com.amazonaws.b2bi#GetProfileResponse" + }, + "errors": [ + { + "target": "com.amazonaws.b2bi#AccessDeniedException" + }, + { + "target": "com.amazonaws.b2bi#InternalServerException" + }, + { + "target": "com.amazonaws.b2bi#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.b2bi#ThrottlingException" + }, + { + "target": "com.amazonaws.b2bi#ValidationException" + } + ], + "traits": { + "aws.iam#requiredActions": [ + "b2bi:ListTagsForResource" + ], + "smithy.api#documentation": "

Retrieves the details for the profile specified by the profile ID. Profiles contain basic information about you and your business.

", + "smithy.api#examples": [ + { + "title": "Sample GetProfile call", + "input": { + "profileId": "p-60fbc37c87f04fce9" + }, + "output": { + "businessName": "John's Trucking", + "createdAt": "2023-11-01T21:51:05.504Z", + "email": "john@example.com", + "logging": "ENABLED", + "logGroupName": "b2bi/p-60fbc37c87f04fce9-Logs", + "name": "Shipping Profile", + "phone": "5555555555", + "profileArn": "arn:aws:b2bi:us-west-2:123456789012:profile/p-60fbc37c87f04fce9", + "profileId": "p-60fbc37c87f04fce9" + } + } + ], + "smithy.api#http": { + "code": 200, + "uri": "/profiles/{profileId}", + "method": "GET" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.b2bi#GetProfileRequest": { + "type": "structure", + "members": { + "profileId": { + "target": "com.amazonaws.b2bi#ProfileId", + "traits": { + "smithy.api#documentation": "

Specifies the unique, system-generated identifier for the profile.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.b2bi#GetProfileResponse": { + "type": "structure", + "members": { + "profileId": { + "target": "com.amazonaws.b2bi#ProfileId", + "traits": { + "smithy.api#documentation": "

Returns the unique, system-generated identifier for the profile.

", + "smithy.api#required": {} + } + }, + "profileArn": { + "target": "com.amazonaws.b2bi#ResourceArn", + "traits": { + "smithy.api#documentation": "

Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.

", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.b2bi#ProfileName", + "traits": { + "smithy.api#documentation": "

Returns the name of the profile, used to identify it.

", + "smithy.api#required": {} + } + }, + "email": { + "target": "com.amazonaws.b2bi#Email", + "traits": { + "smithy.api#documentation": "

Returns the email address associated with this customer profile.

" + } + }, + "phone": { + "target": "com.amazonaws.b2bi#Phone", + "traits": { + "smithy.api#documentation": "

Returns the phone number associated with the profile.

", + "smithy.api#required": {} + } + }, + "businessName": { + "target": "com.amazonaws.b2bi#BusinessName", + "traits": { + "smithy.api#documentation": "

Returns the name for the business associated with this profile.

", + "smithy.api#required": {} + } + }, + "logging": { + "target": "com.amazonaws.b2bi#Logging", + "traits": { + "smithy.api#documentation": "

Returns whether or not logging is enabled for this profile.

" + } + }, + "logGroupName": { + "target": "com.amazonaws.b2bi#LogGroupName", + "traits": { + "smithy.api#documentation": "

Returns the name of the logging group.

" + } + }, + "createdAt": { + "target": "com.amazonaws.b2bi#CreatedDate", + "traits": { + "smithy.api#documentation": "

Returns a timestamp for creation date and time of the transformer.

", + "smithy.api#required": {} + } + }, + "modifiedAt": { + "target": "com.amazonaws.b2bi#ModifiedDate", + "traits": { + "smithy.api#documentation": "

Returns a timestamp for last time the profile was modified.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.b2bi#GetTransformer": { + "type": "operation", + "input": { + "target": "com.amazonaws.b2bi#GetTransformerRequest" + }, + "output": { + "target": "com.amazonaws.b2bi#GetTransformerResponse" + }, + "errors": [ + { + "target": "com.amazonaws.b2bi#AccessDeniedException" + }, + { + "target": "com.amazonaws.b2bi#InternalServerException" + }, + { + "target": "com.amazonaws.b2bi#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.b2bi#ThrottlingException" + }, + { + "target": "com.amazonaws.b2bi#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the details for the transformer specified by the transformer ID. Transformers describe how to process the incoming EDI (electronic data interchange) documents, and extract the necessary information.

", + "smithy.api#examples": [ + { + "title": "Sample GetTransformer call", + "input": { + "transformerId": "tr-974c129999f84d8c9" + }, + "output": { + "createdAt": "2023-11-01T21:51:05.504Z", + "ediType": { + "x12Details": { + "transactionSet": "X12_110", + "version": "VERSION_4010" + } + }, + "fileFormat": "JSON", + "mappingTemplate": "$", + "modifiedAt": "2023-11-01T21:51:05.504Z", + "name": "transformJSON", + "sampleDocument": "s3://test-bucket/sampleDoc.txt", + "status": "inactive", + "transformerArn": "arn:aws:b2bi:us-west-2:123456789012:transformer/tr-974c129999f84d8c9", + "transformerId": "tr-974c129999f84d8c9" + } + } + ], + "smithy.api#http": { + "code": 200, + "uri": "/transformers/{transformerId}", + "method": "GET" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.b2bi#GetTransformerJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.b2bi#GetTransformerJobRequest" + }, + "output": { + "target": "com.amazonaws.b2bi#GetTransformerJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.b2bi#AccessDeniedException" + }, + { + "target": "com.amazonaws.b2bi#InternalServerException" + }, + { + "target": "com.amazonaws.b2bi#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.b2bi#ThrottlingException" + }, + { + "target": "com.amazonaws.b2bi#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the details of the transformer run, based on the Transformer job ID.

", + "smithy.api#examples": [ + { + "title": "Sample GetTransformerJob call", + "input": { + "transformerId": "tr-974c129999f84d8c9", + "transformerJobId": "tj-vpYxfV7yQOqjMSYllEslLw" + }, + "output": { + "status": "succeeded", + "outputFiles": [ + { + "bucketName": "gt-edi-test", + "key": "output/sample-214.edi.2023-11-01T10:44:03.353Z.json" + } + ], + "message": "Transformed, writing output" + } + } + ], + "smithy.api#http": { + "uri": "/transformer-jobs/{transformerJobId}", + "method": "GET" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.b2bi#GetTransformerJobRequest": { + "type": "structure", + "members": { + "transformerJobId": { + "target": "com.amazonaws.b2bi#TransformerJobId", + "traits": { + "smithy.api#documentation": "

Specifies the unique, system-generated identifier for a transformer run.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "transformerId": { + "target": "com.amazonaws.b2bi#TransformerId", + "traits": { + "smithy.api#documentation": "

Specifies the system-assigned unique identifier for the transformer.

", + "smithy.api#httpQuery": "transformerId", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.b2bi#GetTransformerJobResponse": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.b2bi#TransformerJobStatus", + "traits": { + "smithy.api#documentation": "

Returns the current state of the transformer job, either running,\n succeeded, or failed.

", + "smithy.api#required": {} + } + }, + "outputFiles": { + "target": "com.amazonaws.b2bi#S3LocationList", + "traits": { + "smithy.api#documentation": "

Returns the location for the output files. If the caller specified a directory for the\n output, then this contains the full path to the output file, including the file name\n generated by the service.

" + } + }, + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

Returns an optional error message, which gets populated when the job is not run\n successfully.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.b2bi#GetTransformerRequest": { + "type": "structure", + "members": { + "transformerId": { + "target": "com.amazonaws.b2bi#TransformerId", + "traits": { + "smithy.api#documentation": "

Specifies the system-assigned unique identifier for the transformer.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.b2bi#GetTransformerResponse": { + "type": "structure", + "members": { + "transformerId": { + "target": "com.amazonaws.b2bi#TransformerId", + "traits": { + "smithy.api#documentation": "

Returns the system-assigned unique identifier for the transformer.

", + "smithy.api#required": {} + } + }, + "transformerArn": { + "target": "com.amazonaws.b2bi#ResourceArn", + "traits": { + "smithy.api#documentation": "

Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.

", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.b2bi#TransformerName", + "traits": { + "smithy.api#documentation": "

Returns the name of the transformer, used to identify it.

", + "smithy.api#required": {} + } + }, + "fileFormat": { + "target": "com.amazonaws.b2bi#FileFormat", + "traits": { + "smithy.api#documentation": "

Returns that the currently supported file formats for EDI transformations are JSON and XML.

", + "smithy.api#required": {} + } + }, + "mappingTemplate": { + "target": "com.amazonaws.b2bi#MappingTemplate", + "traits": { + "smithy.api#documentation": "

Returns the name of the mapping template for the transformer. This template is used to convert the input document into the\n correct set of objects.

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.b2bi#TransformerStatus", + "traits": { + "smithy.api#documentation": "

Returns the state of the newly created transformer. The transformer can be either\n active or inactive. For the transformer to be used in a\n capability, its status must active.

", + "smithy.api#required": {} + } + }, + "ediType": { + "target": "com.amazonaws.b2bi#EdiType", + "traits": { + "smithy.api#documentation": "

Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.

", + "smithy.api#required": {} + } + }, + "sampleDocument": { + "target": "com.amazonaws.b2bi#FileLocation", + "traits": { + "smithy.api#documentation": "

Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.

" + } + }, + "createdAt": { + "target": "com.amazonaws.b2bi#CreatedDate", + "traits": { + "smithy.api#documentation": "

Returns a timestamp for creation date and time of the transformer.

", + "smithy.api#required": {} + } + }, + "modifiedAt": { + "target": "com.amazonaws.b2bi#ModifiedDate", + "traits": { + "smithy.api#documentation": "

Returns a timestamp for last time the transformer was modified.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.b2bi#InstructionsDocuments": { + "type": "list", + "member": { + "target": "com.amazonaws.b2bi#S3Location" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5 + } + } + }, + "com.amazonaws.b2bi#InternalServerException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.b2bi#ErrorMessage", + "traits": { + "smithy.api#required": {} + } + }, + "retryAfterSeconds": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The server attempts to retry a failed command.

", + "smithy.api#httpHeader": "Retry-After" + } + } + }, + "traits": { + "smithy.api#documentation": "

This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.

", + "smithy.api#error": "server", + "smithy.api#httpError": 500, + "smithy.api#retryable": {} + } + }, + "com.amazonaws.b2bi#ListCapabilities": { + "type": "operation", + "input": { + "target": "com.amazonaws.b2bi#ListCapabilitiesRequest" + }, + "output": { + "target": "com.amazonaws.b2bi#ListCapabilitiesResponse" + }, + "traits": { + "smithy.api#documentation": "

Lists the capabilities associated with your Amazon Web Services account for your current or specified region. Capabilities contain the information necessary to process incoming EDI (electronic data interchange) documents.

", + "smithy.api#examples": [ + { + "title": "Sample ListCapabilities call", + "input": { + "maxResults": 50, + "nextToken": "foo" + }, + "output": { + "capabilities": [ + { + "capabilityId": "ca-963a8121e4fc4e348", + "createdAt": "2023-11-01T21:51:05.504Z", + "modifiedAt": "2023-11-01T21:51:05.504Z", + "name": "b2biexample", + "type": "edi" + } + ], + "nextToken": "foo" + } + } + ], + "smithy.api#http": { + "code": 200, + "uri": "/capabilities", + "method": "GET" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "capabilities" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.b2bi#ListCapabilitiesRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.b2bi#PageToken", + "traits": { + "smithy.api#documentation": "

When additional results are obtained from the command, a NextToken parameter is returned in the output.\n You can then pass the NextToken parameter in a subsequent command to continue listing additional resources.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.b2bi#MaxResults", + "traits": { + "smithy.api#documentation": "

Specifies the maximum number of capabilities to return.

", + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.b2bi#ListCapabilitiesResponse": { + "type": "structure", + "members": { + "capabilities": { + "target": "com.amazonaws.b2bi#CapabilityList", + "traits": { + "smithy.api#documentation": "

Returns one or more capabilities associated with this partnership.

", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.b2bi#PageToken", + "traits": { + "smithy.api#documentation": "

When additional results are obtained from the command, a NextToken parameter is returned in the output.\n You can then pass the NextToken parameter in a subsequent command to continue listing additional resources.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.b2bi#ListPartnerships": { + "type": "operation", + "input": { + "target": "com.amazonaws.b2bi#ListPartnershipsRequest" + }, + "output": { + "target": "com.amazonaws.b2bi#ListPartnershipsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.b2bi#AccessDeniedException" + }, + { + "target": "com.amazonaws.b2bi#InternalServerException" + }, + { + "target": "com.amazonaws.b2bi#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.b2bi#ThrottlingException" + }, + { + "target": "com.amazonaws.b2bi#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the partnerships associated with your Amazon Web Services account for your current or specified region. Partnerships link trading partners with your profile and a specific transformer, so that the EDI (electronic data interchange) documents that they upload to Amazon S3 can be processed according to their specifications.

", + "smithy.api#examples": [ + { + "title": "Sample ListPartnerships call", + "input": { + "maxResults": 50, + "nextToken": "foo", + "profileId": "p-60fbc37c87f04fce9" + }, + "output": { + "nextToken": "string", + "partnerships": [ + { + "capabilities": [ + "ca-963a8121e4fc4e348" + ], + "createdAt": "2023-11-01T21:51:05.504Z", + "modifiedAt": "2023-11-01T21:51:05.504Z", + "name": "b2bipartner", + "partnershipId": "ps-219fa02f5b4242af8", + "profileId": "p-60fbc37c87f04fce9", + "tradingPartnerId": "tp-2a17ca447f6f4a8a8" + } + ] + } + } + ], + "smithy.api#http": { + "code": 200, + "uri": "/partnerships", + "method": "GET" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "partnerships" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.b2bi#ListPartnershipsRequest": { + "type": "structure", + "members": { + "profileId": { + "target": "com.amazonaws.b2bi#ProfileId", + "traits": { + "smithy.api#documentation": "

Specifies the unique, system-generated identifier for the profile connected to this partnership.

", + "smithy.api#httpQuery": "profileId" + } + }, + "nextToken": { + "target": "com.amazonaws.b2bi#PageToken", + "traits": { + "smithy.api#documentation": "

When additional results are obtained from the command, a NextToken parameter is returned in the output.\n You can then pass the NextToken parameter in a subsequent command to continue listing additional resources.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.b2bi#MaxResults", + "traits": { + "smithy.api#documentation": "

Specifies the maximum number of capabilities to return.

", + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.b2bi#ListPartnershipsResponse": { + "type": "structure", + "members": { + "partnerships": { + "target": "com.amazonaws.b2bi#PartnershipList", + "traits": { + "smithy.api#documentation": "

Specifies a list of your partnerships.

", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.b2bi#PageToken", + "traits": { + "smithy.api#documentation": "

When additional results are obtained from the command, a NextToken parameter is returned in the output.\n You can then pass the NextToken parameter in a subsequent command to continue listing additional resources.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.b2bi#ListProfiles": { + "type": "operation", + "input": { + "target": "com.amazonaws.b2bi#ListProfilesRequest" + }, + "output": { + "target": "com.amazonaws.b2bi#ListProfilesResponse" + }, + "traits": { + "smithy.api#documentation": "

Lists the profiles associated with your Amazon Web Services account for your current or specified region. Profiles contain basic information about you and your business.

", + "smithy.api#examples": [ + { + "title": "Sample ListProfiles call", + "input": { + "maxResults": 50, + "nextToken": "foo" + }, + "output": { + "nextToken": "foo", + "profiles": [ + { + "businessName": "John's Trucking", + "createdAt": "2023-11-01T21:51:05.504Z", + "logging": "ENABLED", + "logGroupName": "b2bi/p-60fbc37c87f04fce9-Logs", + "name": "Shipping Profile", + "profileId": "p-60fbc37c87f04fce9" + } + ] + } + } + ], + "smithy.api#http": { + "code": 200, + "uri": "/profiles", + "method": "GET" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "profiles" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.b2bi#ListProfilesRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.b2bi#PageToken", + "traits": { + "smithy.api#documentation": "

When additional results are obtained from the command, a NextToken parameter is returned in the output.\n You can then pass the NextToken parameter in a subsequent command to continue listing additional resources.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.b2bi#MaxResults", + "traits": { + "smithy.api#documentation": "

Specifies the maximum number of profiles to return.

", + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.b2bi#ListProfilesResponse": { + "type": "structure", + "members": { + "profiles": { + "target": "com.amazonaws.b2bi#ProfileList", + "traits": { + "smithy.api#documentation": "

Returns an array of ProfileSummary objects.

", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.b2bi#PageToken", + "traits": { + "smithy.api#documentation": "

When additional results are obtained from the command, a NextToken parameter is returned in the output.\n You can then pass the NextToken parameter in a subsequent command to continue listing additional resources.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.b2bi#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.b2bi#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.b2bi#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.b2bi#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.b2bi#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify. The resource can be a capability, partnership, profile, or transformer.

", + "smithy.api#examples": [ + { + "title": "Sample ListTagsForResources call", + "input": { + "ResourceARN": "arn:aws:b2bi:us-west-2:123456789012:profile/p-60fbc37c87f04fce9" + }, + "output": { + "Tags": [ + { + "Key": "sampleKey", + "Value": "SampleValue" + } + ] + } + } + ], + "smithy.api#http": { + "code": 200, + "uri": "/tags/{ResourceARN}", + "method": "GET" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.b2bi#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "ResourceARN": { + "target": "com.amazonaws.b2bi#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

Requests the tags associated with a particular Amazon Resource Name (ARN). An ARN is an identifier for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.b2bi#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "Tags": { + "target": "com.amazonaws.b2bi#TagList", + "traits": { + "smithy.api#documentation": "

Returns the key-value pairs assigned to ARNs that you can use to group and search for resources by type. You can attach this metadata to resources (capabilities, partnerships, and so on) for any purpose.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.b2bi#ListTransformers": { + "type": "operation", + "input": { + "target": "com.amazonaws.b2bi#ListTransformersRequest" + }, + "output": { + "target": "com.amazonaws.b2bi#ListTransformersResponse" + }, + "traits": { + "smithy.api#documentation": "

Lists the available transformers. Transformers describe how to process the incoming EDI (electronic data interchange) documents, and extract the necessary information.

", + "smithy.api#examples": [ + { + "title": "Sample ListTransformers call", + "input": { + "maxResults": 50, + "nextToken": "foo" + }, + "output": { + "nextToken": "foo", + "transformers": [ + { + "createdAt": "2023-11-01T21:51:05.504Z", + "ediType": { + "x12Details": { + "transactionSet": "X12_110", + "version": "VERSION_4010" + } + }, + "fileFormat": "JSON", + "mappingTemplate": "$", + "modifiedAt": "2023-11-01T21:51:05.504Z", + "name": "transformJSON", + "sampleDocument": "s3://test-bucket/sampleDoc.txt", + "status": "inactive", + "transformerId": "tr-974c129999f84d8c9" + } + ] + } + } + ], + "smithy.api#http": { + "code": 200, + "uri": "/transformers", + "method": "GET" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "transformers" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.b2bi#ListTransformersRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.b2bi#PageToken", + "traits": { + "smithy.api#documentation": "

When additional results are obtained from the command, a NextToken parameter is returned in the output.\n You can then pass the NextToken parameter in a subsequent command to continue listing additional resources.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.b2bi#MaxResults", + "traits": { + "smithy.api#documentation": "

Specifies the number of items to return for the API response.

", + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.b2bi#ListTransformersResponse": { + "type": "structure", + "members": { + "transformers": { + "target": "com.amazonaws.b2bi#TransformerList", + "traits": { + "smithy.api#documentation": "

Returns an array of one or more transformer objects.

\n

For each transformer, a TransformerSummary object is returned.\n The TransformerSummary contains all the details for a specific transformer.

", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.b2bi#PageToken", + "traits": { + "smithy.api#documentation": "

When additional results are obtained from the command, a NextToken parameter is returned in the output.\n You can then pass the NextToken parameter in a subsequent command to continue listing additional resources.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.b2bi#LogGroupName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + } + } + }, + "com.amazonaws.b2bi#Logging": { + "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.b2bi#MappingTemplate": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 350000 + } + } + }, + "com.amazonaws.b2bi#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.b2bi#ModifiedDate": { + "type": "timestamp", + "traits": { + "smithy.api#timestampFormat": "date-time" + } + }, + "com.amazonaws.b2bi#PageToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "com.amazonaws.b2bi#PartnerName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 254 + } + } + }, + "com.amazonaws.b2bi#Partnership": { + "type": "resource", + "identifiers": { + "partnershipId": { + "target": "com.amazonaws.b2bi#PartnershipId" + } + }, + "create": { + "target": "com.amazonaws.b2bi#CreatePartnership" + }, + "read": { + "target": "com.amazonaws.b2bi#GetPartnership" + }, + "update": { + "target": "com.amazonaws.b2bi#UpdatePartnership" + }, + "delete": { + "target": "com.amazonaws.b2bi#DeletePartnership" + }, + "list": { + "target": "com.amazonaws.b2bi#ListPartnerships" + }, + "traits": { + "aws.api#arn": { + "template": "partnerships/{partnershipId}" + }, + "aws.api#taggable": { + "property": "tags" + }, + "aws.cloudformation#cfnResource": { + "additionalSchemas": [ + "com.amazonaws.b2bi#PartnershipSummary" + ] + }, + "smithy.api#unstable": {} + } + }, + "com.amazonaws.b2bi#PartnershipCapabilities": { + "type": "list", + "member": { + "target": "com.amazonaws.b2bi#CapabilityId" + } + }, + "com.amazonaws.b2bi#PartnershipId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_-]+$" + } + }, + "com.amazonaws.b2bi#PartnershipList": { + "type": "list", + "member": { + "target": "com.amazonaws.b2bi#PartnershipSummary" + } + }, + "com.amazonaws.b2bi#PartnershipSummary": { + "type": "structure", + "members": { + "profileId": { + "target": "com.amazonaws.b2bi#ProfileId", + "traits": { + "smithy.api#documentation": "

Returns the unique, system-generated identifier for the profile connected to this partnership.

", + "smithy.api#required": {} + } + }, + "partnershipId": { + "target": "com.amazonaws.b2bi#PartnershipId", + "traits": { + "smithy.api#documentation": "

Returns the unique, system-generated identifier for a partnership.

", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.b2bi#PartnerName", + "traits": { + "smithy.api#documentation": "

Returns the name of the partnership.

" + } + }, + "capabilities": { + "target": "com.amazonaws.b2bi#PartnershipCapabilities", + "traits": { + "smithy.api#documentation": "

Returns one or more capabilities associated with this partnership.

" + } + }, + "tradingPartnerId": { + "target": "com.amazonaws.b2bi#TradingPartnerId", + "traits": { + "smithy.api#documentation": "

Returns the unique, system-generated identifier for a trading partner.

" + } + }, + "createdAt": { + "target": "com.amazonaws.b2bi#CreatedDate", + "traits": { + "smithy.api#documentation": "

Returns a timestamp for creation date and time of the partnership.

", + "smithy.api#required": {} + } + }, + "modifiedAt": { + "target": "com.amazonaws.b2bi#ModifiedDate", + "traits": { + "smithy.api#documentation": "

Returns a timestamp that identifies the most recent date and time that the partnership was modified.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that contains the details for a partnership. Partnerships link trading partners with your profile and a specific transformer, so that the EDI (electronic data interchange) documents that they upload to Amazon S3 can be processed according to their specifications.

", + "smithy.api#references": [ + { + "resource": "com.amazonaws.b2bi#Profile" + } + ] + } + }, + "com.amazonaws.b2bi#Phone": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 7, + "max": 22 + }, + "smithy.api#pattern": "^\\+?([0-9 \\t\\-()\\/]{7,})(?:\\s*(?:#|x\\.?|ext\\.?|extension) \\t*(\\d+))?$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.b2bi#Profile": { + "type": "resource", + "identifiers": { + "profileId": { + "target": "com.amazonaws.b2bi#ProfileId" + } + }, + "create": { + "target": "com.amazonaws.b2bi#CreateProfile" + }, + "read": { + "target": "com.amazonaws.b2bi#GetProfile" + }, + "update": { + "target": "com.amazonaws.b2bi#UpdateProfile" + }, + "delete": { + "target": "com.amazonaws.b2bi#DeleteProfile" + }, + "list": { + "target": "com.amazonaws.b2bi#ListProfiles" + }, + "traits": { + "aws.api#arn": { + "template": "profile/{profileId}" + }, + "aws.api#taggable": { + "property": "tags" + }, + "aws.cloudformation#cfnResource": { + "additionalSchemas": [ + "com.amazonaws.b2bi#ProfileSummary" + ] + }, + "smithy.api#unstable": {} + } + }, + "com.amazonaws.b2bi#ProfileId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_-]+$" + } + }, + "com.amazonaws.b2bi#ProfileList": { + "type": "list", + "member": { + "target": "com.amazonaws.b2bi#ProfileSummary" + } + }, + "com.amazonaws.b2bi#ProfileName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 254 + } + } + }, + "com.amazonaws.b2bi#ProfileSummary": { + "type": "structure", + "members": { + "profileId": { + "target": "com.amazonaws.b2bi#ProfileId", + "traits": { + "smithy.api#documentation": "

Returns the unique, system-generated identifier for the profile.

", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.b2bi#ProfileName", + "traits": { + "smithy.api#documentation": "

Returns the display name for profile.

", + "smithy.api#required": {} + } + }, + "businessName": { + "target": "com.amazonaws.b2bi#BusinessName", + "traits": { + "smithy.api#documentation": "

Returns the name for the business associated with this profile.

", + "smithy.api#required": {} + } + }, + "logging": { + "target": "com.amazonaws.b2bi#Logging", + "traits": { + "smithy.api#documentation": "

Specifies whether or not logging is enabled for this profile.

" + } + }, + "logGroupName": { + "target": "com.amazonaws.b2bi#LogGroupName", + "traits": { + "smithy.api#documentation": "

Returns the name of the logging group.

" + } + }, + "createdAt": { + "target": "com.amazonaws.b2bi#CreatedDate", + "traits": { + "smithy.api#documentation": "

Returns the timestamp for creation date and time of the profile.

", + "smithy.api#required": {} + } + }, + "modifiedAt": { + "target": "com.amazonaws.b2bi#ModifiedDate", + "traits": { + "smithy.api#documentation": "

Returns the timestamp that identifies the most recent date and time that the profile was modified.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the details for a profile. Profiles contain basic information about you and your business.

", + "smithy.api#references": [ + { + "resource": "com.amazonaws.b2bi#Profile" + } + ] + } + }, + "com.amazonaws.b2bi#ResourceArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.b2bi#ResourceNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.b2bi#ErrorMessage", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.b2bi#S3Key": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, + "com.amazonaws.b2bi#S3Location": { + "type": "structure", + "members": { + "bucketName": { + "target": "com.amazonaws.b2bi#BucketName", + "traits": { + "smithy.api#documentation": "

Specifies the name of the Amazon S3 bucket.

" + } + }, + "key": { + "target": "com.amazonaws.b2bi#S3Key", + "traits": { + "smithy.api#documentation": "

Specifies the Amazon S3 key for the file location.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the details for the Amazon S3 file location that is being used with Amazon Web Services B2BI Data Interchange. File\n locations in Amazon S3 are identified using a combination of the bucket and key.

" + } + }, + "com.amazonaws.b2bi#S3LocationList": { + "type": "list", + "member": { + "target": "com.amazonaws.b2bi#S3Location" + } + }, + "com.amazonaws.b2bi#ServiceQuotaExceededException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.b2bi#ErrorMessage", + "traits": { + "smithy.api#required": {} + } + }, + "resourceId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ID for the resource that exceeded the quota, which caused the exception.

", + "smithy.api#required": {} + } + }, + "resourceType": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The resource type (profile, partnership, transformer, or capability) that exceeded the quota, which caused the exception.

", + "smithy.api#required": {} + } + }, + "serviceCode": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The code responsible for exceeding the quota, which caused the exception.

", + "smithy.api#required": {} + } + }, + "quotaCode": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The quota that was exceeded, which caused the exception.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Occurs when the calling command attempts to exceed one of the service quotas, for example trying to create a capability when you already have the maximum number of capabilities allowed.

", + "smithy.api#error": "client", + "smithy.api#httpError": 402 + } + }, + "com.amazonaws.b2bi#StartTransformerJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.b2bi#StartTransformerJobRequest" + }, + "output": { + "target": "com.amazonaws.b2bi#StartTransformerJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.b2bi#AccessDeniedException" + }, + { + "target": "com.amazonaws.b2bi#InternalServerException" + }, + { + "target": "com.amazonaws.b2bi#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.b2bi#ThrottlingException" + }, + { + "target": "com.amazonaws.b2bi#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Runs a job, using a transformer, to parse input EDI (electronic data interchange) file into the output structures used by Amazon Web Services B2BI Data Interchange.

", + "smithy.api#examples": [ + { + "title": "Sample StartTransformerJob call", + "input": { + "clientToken": "foo", + "inputFile": { + "bucketName": "test-bucket", + "key": "input/inputFile.txt" + }, + "outputLocation": { + "bucketName": "test-bucket", + "key": "output/" + }, + "transformerId": "tr-974c129999f84d8c9" + }, + "output": { + "transformerJobId": "tj-vpYxfV7yQOqjMSYllEslLw" + } + } + ], + "smithy.api#http": { + "uri": "/transformer-jobs", + "method": "POST" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.b2bi#StartTransformerJobRequest": { + "type": "structure", + "members": { + "inputFile": { + "target": "com.amazonaws.b2bi#S3Location", + "traits": { + "smithy.api#documentation": "

Specifies the location of the input file for the transformation. The location consists of an Amazon S3 bucket and prefix.

", + "smithy.api#required": {} + } + }, + "outputLocation": { + "target": "com.amazonaws.b2bi#S3Location", + "traits": { + "smithy.api#documentation": "

Specifies the location of the output file for the transformation. The location consists of an Amazon S3 bucket and prefix.

", + "smithy.api#required": {} + } + }, + "transformerId": { + "target": "com.amazonaws.b2bi#TransformerId", + "traits": { + "smithy.api#documentation": "

Specifies the system-assigned unique identifier for the transformer.

", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

Reserved for future use.

", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.b2bi#StartTransformerJobResponse": { + "type": "structure", + "members": { + "transformerJobId": { + "target": "com.amazonaws.b2bi#TransformerJobId", + "traits": { + "smithy.api#documentation": "

Returns the unique, system-generated identifier for a transformer run.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.b2bi#Tag": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.b2bi#TagKey", + "traits": { + "smithy.api#documentation": "

Specifies the name assigned to the tag that you create.

", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.b2bi#TagValue", + "traits": { + "smithy.api#documentation": "

Contains one or more values that you assigned to the key name that you create.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Creates a key-value pair for a specific resource. Tags are metadata that you can use to search for and group a resource for various purposes.\n You can apply tags to capabilities, partnerships, profiles and transformers. A tag key can take more than one value. For example, to group capabilities for accounting purposes,\n you might create a tag called Group and assign the values Research and Accounting to that group.

" + } + }, + "com.amazonaws.b2bi#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.b2bi#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.b2bi#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.b2bi#TagList": { + "type": "list", + "member": { + "target": "com.amazonaws.b2bi#Tag" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.b2bi#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.b2bi#TagResourceRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.b2bi#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.b2bi#ThrottlingException" + }, + { + "target": "com.amazonaws.b2bi#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN). Resources are capability, partnership, profile, transformers and other entities.

\n

There is no response returned from this call.

", + "smithy.api#examples": [ + { + "title": "Sample TagResource call", + "input": { + "ResourceARN": "arn:aws:b2bi:us-west-2:123456789012:profile/p-60fbc37c87f04fce9", + "Tags": [ + { + "Key": "sampleKey", + "Value": "SampleValue" + } + ] + } + } + ], + "smithy.api#http": { + "code": 200, + "uri": "/tags/{ResourceARN}", + "method": "POST" + } + } + }, + "com.amazonaws.b2bi#TagResourceRequest": { + "type": "structure", + "members": { + "ResourceARN": { + "target": "com.amazonaws.b2bi#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

Specifies an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.b2bi#TagList", + "traits": { + "smithy.api#documentation": "

Specifies the key-value pairs assigned to ARNs that you can use to group and search for resources by type. You can attach this metadata to resources (capabilities, partnerships, and so on) for any purpose.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.b2bi#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.b2bi#TestMapping": { + "type": "operation", + "input": { + "target": "com.amazonaws.b2bi#TestMappingRequest" + }, + "output": { + "target": "com.amazonaws.b2bi#TestMappingResponse" + }, + "errors": [ + { + "target": "com.amazonaws.b2bi#AccessDeniedException" + }, + { + "target": "com.amazonaws.b2bi#InternalServerException" + }, + { + "target": "com.amazonaws.b2bi#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.b2bi#ThrottlingException" + }, + { + "target": "com.amazonaws.b2bi#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Maps the input file according to the provided template file.

", + "smithy.api#examples": [ + { + "title": "Sample TestMapping call", + "input": { + "fileFormat": "JSON", + "inputFileContent": "Sample file content", + "mappingTemplate": "$" + }, + "output": { + "mappedFileContent": "Sample file content" + } + } + ], + "smithy.api#http": { + "code": 201, + "uri": "/testmapping", + "method": "POST" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.b2bi#TestMappingInputFileContent": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200000 + } + } + }, + "com.amazonaws.b2bi#TestMappingRequest": { + "type": "structure", + "members": { + "inputFileContent": { + "target": "com.amazonaws.b2bi#TestMappingInputFileContent", + "traits": { + "smithy.api#documentation": "

Specify the EDI (electronic data interchange) file that is used as input for the transform.

", + "smithy.api#required": {} + } + }, + "mappingTemplate": { + "target": "com.amazonaws.b2bi#MappingTemplate", + "traits": { + "smithy.api#documentation": "

Specifies the name of the mapping template for the transformer. This template is used to convert the input document into the\n correct set of objects.

", + "smithy.api#required": {} + } + }, + "fileFormat": { + "target": "com.amazonaws.b2bi#FileFormat", + "traits": { + "smithy.api#documentation": "

Specifies that the currently supported file formats for EDI transformations are JSON and XML.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.b2bi#TestMappingResponse": { + "type": "structure", + "members": { + "mappedFileContent": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

Returns a string for the mapping that can be used to identify the mapping. Similar to a fingerprint

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.b2bi#TestParsing": { + "type": "operation", + "input": { + "target": "com.amazonaws.b2bi#TestParsingRequest" + }, + "output": { + "target": "com.amazonaws.b2bi#TestParsingResponse" + }, + "errors": [ + { + "target": "com.amazonaws.b2bi#AccessDeniedException" + }, + { + "target": "com.amazonaws.b2bi#InternalServerException" + }, + { + "target": "com.amazonaws.b2bi#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.b2bi#ThrottlingException" + }, + { + "target": "com.amazonaws.b2bi#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Parses the input EDI (electronic data interchange) file.

", + "smithy.api#examples": [ + { + "title": "Sample TestParsing call", + "input": { + "ediType": { + "x12Details": { + "transactionSet": "X12_110", + "version": "VERSION_4010" + } + }, + "fileFormat": "JSON", + "inputFile": { + "bucketName": "test-bucket", + "key": "sampleFile.txt" + } + }, + "output": { + "parsedFileContent": "Sample parsed file content" + } + } + ], + "smithy.api#http": { + "code": 201, + "uri": "/testparsing", + "method": "POST" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.b2bi#TestParsingRequest": { + "type": "structure", + "members": { + "inputFile": { + "target": "com.amazonaws.b2bi#S3Location", + "traits": { + "smithy.api#documentation": "

Specifies an S3Location object, which contains the Amazon S3 bucket and prefix for the location of the input file.

", + "smithy.api#required": {} + } + }, + "fileFormat": { + "target": "com.amazonaws.b2bi#FileFormat", + "traits": { + "smithy.api#documentation": "

Specifies that the currently supported file formats for EDI transformations are JSON and XML.

", + "smithy.api#required": {} + } + }, + "ediType": { + "target": "com.amazonaws.b2bi#EdiType", + "traits": { + "smithy.api#documentation": "

Specifies the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.b2bi#TestParsingResponse": { + "type": "structure", + "members": { + "parsedFileContent": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

Returns the contents of the input file being tested, parsed according to the specified EDI (electronic data interchange) type.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.b2bi#ThrottlingException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.b2bi#ErrorMessage", + "traits": { + "smithy.api#required": {} + } + }, + "retryAfterSeconds": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The server attempts to retry a command that was throttled.

", + "smithy.api#httpHeader": "Retry-After" + } + } + }, + "traits": { + "smithy.api#documentation": "

The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.

", + "smithy.api#error": "client", + "smithy.api#httpError": 429, + "smithy.api#retryable": {} + } + }, + "com.amazonaws.b2bi#TradingPartnerId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_-]+$" + } + }, + "com.amazonaws.b2bi#Transformer": { + "type": "resource", + "identifiers": { + "transformerId": { + "target": "com.amazonaws.b2bi#TransformerId" + } + }, + "create": { + "target": "com.amazonaws.b2bi#CreateTransformer" + }, + "read": { + "target": "com.amazonaws.b2bi#GetTransformer" + }, + "update": { + "target": "com.amazonaws.b2bi#UpdateTransformer" + }, + "delete": { + "target": "com.amazonaws.b2bi#DeleteTransformer" + }, + "list": { + "target": "com.amazonaws.b2bi#ListTransformers" + }, + "traits": { + "aws.api#arn": { + "template": "transformers/{transformerId}" + }, + "aws.api#taggable": { + "property": "tags" + }, + "aws.cloudformation#cfnResource": { + "additionalSchemas": [ + "com.amazonaws.b2bi#TransformerSummary" + ] + }, + "smithy.api#unstable": {} + } + }, + "com.amazonaws.b2bi#TransformerId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_-]+$" + } + }, + "com.amazonaws.b2bi#TransformerJobId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 25, + "max": 25 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_-]+$" + } + }, + "com.amazonaws.b2bi#TransformerJobStatus": { + "type": "enum", + "members": { + "RUNNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "running" + } + }, + "SUCCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "succeeded" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failed" + } + } + } + }, + "com.amazonaws.b2bi#TransformerList": { + "type": "list", + "member": { + "target": "com.amazonaws.b2bi#TransformerSummary" + } + }, + "com.amazonaws.b2bi#TransformerName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 254 + } + } + }, + "com.amazonaws.b2bi#TransformerStatus": { + "type": "enum", + "members": { + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "active" + } + }, + "INACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "inactive" + } + } + } + }, + "com.amazonaws.b2bi#TransformerSummary": { + "type": "structure", + "members": { + "transformerId": { + "target": "com.amazonaws.b2bi#TransformerId", + "traits": { + "smithy.api#documentation": "

Returns the system-assigned unique identifier for the transformer.

", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.b2bi#TransformerName", + "traits": { + "smithy.api#documentation": "

Returns the descriptive name for the transformer.

", + "smithy.api#required": {} + } + }, + "fileFormat": { + "target": "com.amazonaws.b2bi#FileFormat", + "traits": { + "smithy.api#documentation": "

Returns that the currently supported file formats for EDI transformations are JSON and XML.

", + "smithy.api#required": {} + } + }, + "mappingTemplate": { + "target": "com.amazonaws.b2bi#MappingTemplate", + "traits": { + "smithy.api#documentation": "

Returns the name of the mapping template for the transformer. This template is used to convert the input document into the\n correct set of objects.

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.b2bi#TransformerStatus", + "traits": { + "smithy.api#documentation": "

Returns the state of the newly created transformer. The transformer can be either\n active or inactive. For the transformer to be used in a\n capability, its status must active.

", + "smithy.api#required": {} + } + }, + "ediType": { + "target": "com.amazonaws.b2bi#EdiType", + "traits": { + "smithy.api#documentation": "

Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.

", + "smithy.api#required": {} + } + }, + "sampleDocument": { + "target": "com.amazonaws.b2bi#FileLocation", + "traits": { + "smithy.api#documentation": "

Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.

" + } + }, + "createdAt": { + "target": "com.amazonaws.b2bi#CreatedDate", + "traits": { + "smithy.api#documentation": "

Returns a timestamp indicating when the transformer was created. For example,\n 2023-07-20T19:58:44.624Z.

", + "smithy.api#required": {} + } + }, + "modifiedAt": { + "target": "com.amazonaws.b2bi#ModifiedDate", + "traits": { + "smithy.api#documentation": "

Returns a timestamp representing the date and time for the most recent change for the transformer object.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the details for a transformer object. Transformers describe how to process the incoming EDI (electronic data interchange) documents, and extract the necessary information.

", + "smithy.api#references": [ + { + "resource": "com.amazonaws.b2bi#Transformer" + } + ] + } + }, + "com.amazonaws.b2bi#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.b2bi#UntagResourceRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.b2bi#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.b2bi#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Detaches a key-value pair from the specified resource, as identified by its Amazon Resource Name (ARN). Resources are capability, partnership, profile, transformers and other entities.

", + "smithy.api#examples": [ + { + "title": "Sample UntagResource call", + "input": { + "ResourceARN": "arn:aws:b2bi:us-west-2:123456789012:profile/p-60fbc37c87f04fce9", + "TagKeys": [ + "sampleKey" + ] + } + } + ], + "smithy.api#http": { + "code": 200, + "uri": "/tags/{ResourceARN}", + "method": "DELETE" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.b2bi#UntagResourceRequest": { + "type": "structure", + "members": { + "ResourceARN": { + "target": "com.amazonaws.b2bi#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

Specifies an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TagKeys": { + "target": "com.amazonaws.b2bi#TagKeyList", + "traits": { + "smithy.api#documentation": "

Specifies the key-value pairs assigned to ARNs that you can use to group and search for resources by type. You can attach this metadata to resources (capabilities, partnerships, and so on) for any purpose.

", + "smithy.api#httpQuery": "TagKeys", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.b2bi#UpdateCapability": { + "type": "operation", + "input": { + "target": "com.amazonaws.b2bi#UpdateCapabilityRequest" + }, + "output": { + "target": "com.amazonaws.b2bi#UpdateCapabilityResponse" + }, + "errors": [ + { + "target": "com.amazonaws.b2bi#AccessDeniedException" + }, + { + "target": "com.amazonaws.b2bi#ConflictException" + }, + { + "target": "com.amazonaws.b2bi#InternalServerException" + }, + { + "target": "com.amazonaws.b2bi#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.b2bi#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.b2bi#ThrottlingException" + }, + { + "target": "com.amazonaws.b2bi#ValidationException" + } + ], + "traits": { + "aws.iam#requiredActions": [ + "b2bi:TagResource", + "b2bi:UntagResource" + ], + "smithy.api#documentation": "

Updates some of the parameters for a capability, based on the specified parameters.\n Capabilities contain the information necessary to process incoming EDI (electronic data interchange) documents.

", + "smithy.api#examples": [ + { + "title": "Sample UpdateCapability call", + "input": { + "capabilityId": "ca-963a8121e4fc4e348", + "name": "b2biexample", + "instructionsDocuments": [ + { + "bucketName": "test-bucket", + "key": "instructiondoc.txt" + } + ], + "configuration": { + "edi": { + "type": { + "x12Details": { + "transactionSet": "X12_110", + "version": "VERSION_4010" + } + }, + "inputLocation": { + "bucketName": "test-bucket", + "key": "input/" + }, + "outputLocation": { + "bucketName": "test-bucket", + "key": "output/" + }, + "transformerId": "tr-9a893cf536df4658b" + } + } + }, + "output": { + "capabilityArn": "arn:aws:b2bi:us-west-2:123456789012:capability/ca-963a8121e4fc4e348", + "capabilityId": "ca-963a8121e4fc4e348", + "configuration": { + "edi": { + "type": { + "x12Details": { + "transactionSet": "X12_110", + "version": "VERSION_4010" + } + }, + "inputLocation": { + "bucketName": "test-bucket", + "key": "input/" + }, + "outputLocation": { + "bucketName": "test-bucket", + "key": "output/" + }, + "transformerId": "tr-9a893cf536df4658b" + } + }, + "createdAt": "2023-11-01T21:51:05.504Z", + "instructionsDocuments": [ + { + "bucketName": "test-bucket", + "key": "instructiondoc.txt" + } + ], + "modifiedAt": "2023-11-01T21:51:05.504Z", + "name": "b2biexample", + "type": "edi" + } + } + ], + "smithy.api#http": { + "code": 200, + "uri": "/capabilities/{capabilityId}", + "method": "PATCH" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.b2bi#UpdateCapabilityRequest": { + "type": "structure", + "members": { + "capabilityId": { + "target": "com.amazonaws.b2bi#CapabilityId", + "traits": { + "smithy.api#documentation": "

Specifies a system-assigned unique identifier for the capability.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.b2bi#CapabilityName", + "traits": { + "smithy.api#documentation": "

Specifies a new name for the capability, to replace the existing name.

" + } + }, + "configuration": { + "target": "com.amazonaws.b2bi#CapabilityConfiguration", + "traits": { + "smithy.api#documentation": "

Specifies a structure that contains the details for a capability.

" + } + }, + "instructionsDocuments": { + "target": "com.amazonaws.b2bi#InstructionsDocuments", + "traits": { + "smithy.api#documentation": "

Specifies one or more locations in Amazon S3, each specifying an EDI document that can be used with this capability. Each item contains the name of the bucket and the key, to identify the document's location.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.b2bi#UpdateCapabilityResponse": { + "type": "structure", + "members": { + "capabilityId": { + "target": "com.amazonaws.b2bi#CapabilityId", + "traits": { + "smithy.api#documentation": "

Returns a system-assigned unique identifier for the capability.

", + "smithy.api#required": {} + } + }, + "capabilityArn": { + "target": "com.amazonaws.b2bi#ResourceArn", + "traits": { + "smithy.api#documentation": "

Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.

", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.b2bi#CapabilityName", + "traits": { + "smithy.api#documentation": "

Returns the name of the capability, used to identify it.

", + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.b2bi#CapabilityType", + "traits": { + "smithy.api#documentation": "

Returns the type of the capability. Currently, only edi is supported.

", + "smithy.api#required": {} + } + }, + "configuration": { + "target": "com.amazonaws.b2bi#CapabilityConfiguration", + "traits": { + "smithy.api#documentation": "

Returns a structure that contains the details for a capability.

", + "smithy.api#required": {} + } + }, + "instructionsDocuments": { + "target": "com.amazonaws.b2bi#InstructionsDocuments", + "traits": { + "smithy.api#documentation": "

Returns one or more locations in Amazon S3, each specifying an EDI document that can be used with this capability. Each item contains the name of the bucket and the key, to identify the document's location.

" + } + }, + "createdAt": { + "target": "com.amazonaws.b2bi#CreatedDate", + "traits": { + "smithy.api#documentation": "

Returns a timestamp for creation date and time of the capability.

", + "smithy.api#required": {} + } + }, + "modifiedAt": { + "target": "com.amazonaws.b2bi#ModifiedDate", + "traits": { + "smithy.api#documentation": "

Returns a timestamp for last time the capability was modified.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.b2bi#UpdatePartnership": { + "type": "operation", + "input": { + "target": "com.amazonaws.b2bi#UpdatePartnershipRequest" + }, + "output": { + "target": "com.amazonaws.b2bi#UpdatePartnershipResponse" + }, + "errors": [ + { + "target": "com.amazonaws.b2bi#AccessDeniedException" + }, + { + "target": "com.amazonaws.b2bi#ConflictException" + }, + { + "target": "com.amazonaws.b2bi#InternalServerException" + }, + { + "target": "com.amazonaws.b2bi#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.b2bi#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.b2bi#ThrottlingException" + }, + { + "target": "com.amazonaws.b2bi#ValidationException" + } + ], + "traits": { + "aws.iam#requiredActions": [ + "b2bi:TagResource", + "b2bi:UntagResource" + ], + "smithy.api#documentation": "

Updates some of the parameters for a partnership between a customer and trading partner. Partnerships link trading partners with your profile and a specific transformer, so that the EDI (electronic data interchange) documents that they upload to Amazon S3 can be processed according to their specifications.

", + "smithy.api#examples": [ + { + "title": "Sample UpdatePartnership call", + "input": { + "capabilities": [ + "ca-963a8121e4fc4e348" + ], + "name": "b2bipartner", + "partnershipId": "ps-219fa02f5b4242af8" + }, + "output": { + "capabilities": [ + "ca-963a8121e4fc4e348" + ], + "createdAt": "2023-11-01T21:51:05.504Z", + "email": "john@example.com", + "modifiedAt": "2023-11-01T21:51:05.504Z", + "name": "b2bipartner", + "partnershipArn": "arn:aws:b2bi:us-west-2:123456789012:partnership/ps-60fbc37c87f04fce9", + "partnershipId": "ps-219fa02f5b4242af8", + "phone": "5555555555", + "profileId": "p-60fbc37c87f04fce9", + "tradingPartnerId": "tp-2a17ca447f6f4a8a8" + } + } + ], + "smithy.api#http": { + "code": 200, + "uri": "/partnerships/{partnershipId}", + "method": "PATCH" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.b2bi#UpdatePartnershipRequest": { + "type": "structure", + "members": { + "partnershipId": { + "target": "com.amazonaws.b2bi#PartnershipId", + "traits": { + "smithy.api#documentation": "

Specifies the unique, system-generated identifier for a partnership.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.b2bi#PartnerName", + "traits": { + "smithy.api#documentation": "

The name of the partnership, used to identify it.

" + } + }, + "capabilities": { + "target": "com.amazonaws.b2bi#PartnershipCapabilities", + "traits": { + "smithy.api#documentation": "

List of the capabilities associated with this partnership.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.b2bi#UpdatePartnershipResponse": { + "type": "structure", + "members": { + "profileId": { + "target": "com.amazonaws.b2bi#ProfileId", + "traits": { + "smithy.api#documentation": "

Returns the unique, system-generated identifier for the profile connected to this partnership.

", + "smithy.api#required": {} + } + }, + "partnershipId": { + "target": "com.amazonaws.b2bi#PartnershipId", + "traits": { + "smithy.api#documentation": "

Returns the unique, system-generated identifier for a partnership.

", + "smithy.api#required": {} + } + }, + "partnershipArn": { + "target": "com.amazonaws.b2bi#ResourceArn", + "traits": { + "smithy.api#documentation": "

Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.

", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.b2bi#PartnerName", + "traits": { + "smithy.api#documentation": "

The name of the partnership, used to identify it.

" + } + }, + "email": { + "target": "com.amazonaws.b2bi#Email", + "traits": { + "smithy.api#documentation": "

Returns the email address associated with this trading partner.

" + } + }, + "phone": { + "target": "com.amazonaws.b2bi#Phone", + "traits": { + "smithy.api#documentation": "

Returns the phone number associated with the partnership.

" + } + }, + "capabilities": { + "target": "com.amazonaws.b2bi#PartnershipCapabilities", + "traits": { + "smithy.api#documentation": "

Returns one or more capabilities associated with this partnership.

" + } + }, + "tradingPartnerId": { + "target": "com.amazonaws.b2bi#TradingPartnerId", + "traits": { + "smithy.api#documentation": "

Returns the unique, system-generated identifier for a trading partner.

" + } + }, + "createdAt": { + "target": "com.amazonaws.b2bi#CreatedDate", + "traits": { + "smithy.api#documentation": "

Returns a timestamp that identifies the most recent date and time that the partnership was modified.

", + "smithy.api#required": {} + } + }, + "modifiedAt": { + "target": "com.amazonaws.b2bi#ModifiedDate", + "traits": { + "smithy.api#documentation": "

Returns a timestamp that identifies the most recent date and time that the partnership was modified.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.b2bi#UpdateProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.b2bi#UpdateProfileRequest" + }, + "output": { + "target": "com.amazonaws.b2bi#UpdateProfileResponse" + }, + "errors": [ + { + "target": "com.amazonaws.b2bi#AccessDeniedException" + }, + { + "target": "com.amazonaws.b2bi#ConflictException" + }, + { + "target": "com.amazonaws.b2bi#InternalServerException" + }, + { + "target": "com.amazonaws.b2bi#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.b2bi#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.b2bi#ThrottlingException" + }, + { + "target": "com.amazonaws.b2bi#ValidationException" + } + ], + "traits": { + "aws.iam#requiredActions": [ + "b2bi:TagResource", + "b2bi:UntagResource" + ], + "smithy.api#documentation": "

Updates the specified parameters for a profile. Profiles contain basic information about you and your business.

", + "smithy.api#examples": [ + { + "title": "Sample UpdateProfile call", + "input": { + "businessName": "John's Shipping", + "email": "john@example.com", + "name": "Shipping Profile", + "phone": "5555555555", + "profileId": "p-60fbc37c87f04fce9" + }, + "output": { + "businessName": "John's Trucking", + "createdAt": "2023-11-01T21:51:05.504Z", + "email": "john@example.com", + "logging": "ENABLED", + "logGroupName": "b2bi/p-60fbc37c87f04fce9-Logs", + "modifiedAt": "2023-11-02T21:51:05.504Z", + "name": "Shipping Profile", + "phone": "5555555555", + "profileArn": "arn:aws:b2bi:us-west-2:123456789012:profile/p-60fbc37c87f04fce9", + "profileId": "p-60fbc37c87f04fce9" + } + } + ], + "smithy.api#http": { + "code": 200, + "uri": "/profiles/{profileId}", + "method": "PATCH" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.b2bi#UpdateProfileRequest": { + "type": "structure", + "members": { + "profileId": { + "target": "com.amazonaws.b2bi#ProfileId", + "traits": { + "smithy.api#documentation": "

Specifies the unique, system-generated identifier for the profile.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.b2bi#ProfileName", + "traits": { + "smithy.api#documentation": "

The name of the profile, used to identify it.

" + } + }, + "email": { + "target": "com.amazonaws.b2bi#Email", + "traits": { + "smithy.api#documentation": "

Specifies the email address associated with this customer profile.

" + } + }, + "phone": { + "target": "com.amazonaws.b2bi#Phone", + "traits": { + "smithy.api#documentation": "

Specifies the phone number associated with the profile.

" + } + }, + "businessName": { + "target": "com.amazonaws.b2bi#BusinessName", + "traits": { + "smithy.api#documentation": "

Specifies the name for the business associated with this profile.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.b2bi#UpdateProfileResponse": { + "type": "structure", + "members": { + "profileId": { + "target": "com.amazonaws.b2bi#ProfileId", + "traits": { + "smithy.api#documentation": "

Returns the unique, system-generated identifier for the profile.

", + "smithy.api#required": {} + } + }, + "profileArn": { + "target": "com.amazonaws.b2bi#ResourceArn", + "traits": { + "smithy.api#documentation": "

Returns an Amazon Resource Name (ARN) for the profile.

", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.b2bi#ProfileName", + "traits": { + "smithy.api#documentation": "

Returns the name of the profile.

", + "smithy.api#required": {} + } + }, + "email": { + "target": "com.amazonaws.b2bi#Email", + "traits": { + "smithy.api#documentation": "

Returns the email address associated with this customer profile.

" + } + }, + "phone": { + "target": "com.amazonaws.b2bi#Phone", + "traits": { + "smithy.api#documentation": "

Returns the phone number associated with the profile.

", + "smithy.api#required": {} + } + }, + "businessName": { + "target": "com.amazonaws.b2bi#BusinessName", + "traits": { + "smithy.api#documentation": "

Returns the name for the business associated with this profile.

", + "smithy.api#required": {} + } + }, + "logging": { + "target": "com.amazonaws.b2bi#Logging", + "traits": { + "smithy.api#documentation": "

Specifies whether or not logging is enabled for this profile.

" + } + }, + "logGroupName": { + "target": "com.amazonaws.b2bi#LogGroupName", + "traits": { + "smithy.api#documentation": "

Returns the name of the logging group.

" + } + }, + "createdAt": { + "target": "com.amazonaws.b2bi#CreatedDate", + "traits": { + "smithy.api#documentation": "

Returns a timestamp for creation date and time of the profile.

", + "smithy.api#required": {} + } + }, + "modifiedAt": { + "target": "com.amazonaws.b2bi#ModifiedDate", + "traits": { + "smithy.api#documentation": "

Returns a timestamp for last time the profile was modified.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.b2bi#UpdateTransformer": { + "type": "operation", + "input": { + "target": "com.amazonaws.b2bi#UpdateTransformerRequest" + }, + "output": { + "target": "com.amazonaws.b2bi#UpdateTransformerResponse" + }, + "errors": [ + { + "target": "com.amazonaws.b2bi#AccessDeniedException" + }, + { + "target": "com.amazonaws.b2bi#ConflictException" + }, + { + "target": "com.amazonaws.b2bi#InternalServerException" + }, + { + "target": "com.amazonaws.b2bi#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.b2bi#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.b2bi#ThrottlingException" + }, + { + "target": "com.amazonaws.b2bi#ValidationException" + } + ], + "traits": { + "aws.iam#requiredActions": [ + "b2bi:TagResource", + "b2bi:UntagResource" + ], + "smithy.api#documentation": "

Updates the specified parameters for a transformer. Transformers describe how to process the incoming EDI (electronic data interchange) documents, and extract the necessary information.

", + "smithy.api#examples": [ + { + "title": "Sample UpdateTransformer call", + "input": { + "ediType": { + "x12Details": { + "transactionSet": "X12_110", + "version": "VERSION_4010" + } + }, + "fileFormat": "JSON", + "mappingTemplate": "{}", + "name": "transformJSON", + "sampleDocument": "s3://test-bucket/sampleDoc.txt", + "status": "inactive", + "transformerId": "tr-974c129999f84d8c9" + }, + "output": { + "createdAt": "2023-11-01T21:51:05.504Z", + "ediType": { + "x12Details": { + "transactionSet": "X12_110", + "version": "VERSION_4010" + } + }, + "fileFormat": "JSON", + "mappingTemplate": "$", + "modifiedAt": "2023-11-01T21:51:05.504Z", + "name": "transformJSON", + "sampleDocument": "s3://test-bucket/sampleDoc.txt", + "status": "inactive", + "transformerArn": "arn:aws:b2bi:us-west-2:607686414464:transformer/tr-974c129999f84d8c9", + "transformerId": "tr-974c129999f84d8c9" + } + } + ], + "smithy.api#http": { + "code": 200, + "uri": "/transformers/{transformerId}", + "method": "PATCH" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.b2bi#UpdateTransformerRequest": { + "type": "structure", + "members": { + "transformerId": { + "target": "com.amazonaws.b2bi#TransformerId", + "traits": { + "smithy.api#documentation": "

Specifies the system-assigned unique identifier for the transformer.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.b2bi#TransformerName", + "traits": { + "smithy.api#documentation": "

Specify a new name for the transformer, if you want to update it.

" + } + }, + "fileFormat": { + "target": "com.amazonaws.b2bi#FileFormat", + "traits": { + "smithy.api#documentation": "

Specifies that the currently supported file formats for EDI transformations are JSON and XML.

" + } + }, + "mappingTemplate": { + "target": "com.amazonaws.b2bi#MappingTemplate", + "traits": { + "smithy.api#documentation": "

Specifies the name of the mapping template for the transformer. This template is used to convert the input document into the\n correct set of objects.

" + } + }, + "status": { + "target": "com.amazonaws.b2bi#TransformerStatus", + "traits": { + "smithy.api#documentation": "

Specifies the transformer's status. You can update the state of the transformer, from active to inactive, or inactive to active.

" + } + }, + "ediType": { + "target": "com.amazonaws.b2bi#EdiType", + "traits": { + "smithy.api#documentation": "

Specifies the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.

" + } + }, + "sampleDocument": { + "target": "com.amazonaws.b2bi#FileLocation", + "traits": { + "smithy.api#documentation": "

Specifies a sample EDI document that is used by a transformer as a guide for processing the EDI data.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.b2bi#UpdateTransformerResponse": { + "type": "structure", + "members": { + "transformerId": { + "target": "com.amazonaws.b2bi#TransformerId", + "traits": { + "smithy.api#documentation": "

Returns the system-assigned unique identifier for the transformer.

", + "smithy.api#required": {} + } + }, + "transformerArn": { + "target": "com.amazonaws.b2bi#ResourceArn", + "traits": { + "smithy.api#documentation": "

Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.

", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.b2bi#TransformerName", + "traits": { + "smithy.api#documentation": "

Returns the name of the transformer.

", + "smithy.api#required": {} + } + }, + "fileFormat": { + "target": "com.amazonaws.b2bi#FileFormat", + "traits": { + "smithy.api#documentation": "

Returns that the currently supported file formats for EDI transformations are JSON and XML.

", + "smithy.api#required": {} + } + }, + "mappingTemplate": { + "target": "com.amazonaws.b2bi#MappingTemplate", + "traits": { + "smithy.api#documentation": "

Returns the name of the mapping template for the transformer. This template is used to convert the input document into the\n correct set of objects.

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.b2bi#TransformerStatus", + "traits": { + "smithy.api#documentation": "

Returns the state of the newly created transformer. The transformer can be either\n active or inactive. For the transformer to be used in a\n capability, its status must active.

", + "smithy.api#required": {} + } + }, + "ediType": { + "target": "com.amazonaws.b2bi#EdiType", + "traits": { + "smithy.api#documentation": "

Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.

", + "smithy.api#required": {} + } + }, + "sampleDocument": { + "target": "com.amazonaws.b2bi#FileLocation", + "traits": { + "smithy.api#documentation": "

Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.

" + } + }, + "createdAt": { + "target": "com.amazonaws.b2bi#CreatedDate", + "traits": { + "smithy.api#documentation": "

Returns a timestamp for creation date and time of the transformer.

", + "smithy.api#required": {} + } + }, + "modifiedAt": { + "target": "com.amazonaws.b2bi#ModifiedDate", + "traits": { + "smithy.api#documentation": "

Returns a timestamp for last time the transformer was modified.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.b2bi#ValidationException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.b2bi#ErrorMessage", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Occurs when a B2BI object cannot be validated against a request from another object.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.b2bi#X12Details": { + "type": "structure", + "members": { + "transactionSet": { + "target": "com.amazonaws.b2bi#X12TransactionSet", + "traits": { + "smithy.api#documentation": "

Returns an enumerated type where each value identifies an X12 transaction set. Transaction sets are maintained by the X12 Accredited Standards Committee.

" + } + }, + "version": { + "target": "com.amazonaws.b2bi#X12Version", + "traits": { + "smithy.api#documentation": "

Returns the version to use for the specified X12 transaction set. Supported versions are 4010, 4030, and 5010.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that contains the X12 transaction set and version. The X12 structure is used when the system transforms an EDI (electronic data interchange) file.

" + } + }, + "com.amazonaws.b2bi#X12TransactionSet": { + "type": "enum", + "members": { + "X12_110": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "X12_110" + } + }, + "X12_180": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "X12_180" + } + }, + "X12_204": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "X12_204" + } + }, + "X12_210": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "X12_210" + } + }, + "X12_214": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "X12_214" + } + }, + "X12_215": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "X12_215" + } + }, + "X12_310": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "X12_310" + } + }, + "X12_315": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "X12_315" + } + }, + "X12_322": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "X12_322" + } + }, + "X12_404": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "X12_404" + } + }, + "X12_410": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "X12_410" + } + }, + "X12_820": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "X12_820" + } + }, + "X12_824": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "X12_824" + } + }, + "X12_830": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "X12_830" + } + }, + "X12_846": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "X12_846" + } + }, + "X12_850": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "X12_850" + } + }, + "X12_852": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "X12_852" + } + }, + "X12_855": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "X12_855" + } + }, + "X12_856": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "X12_856" + } + }, + "X12_860": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "X12_860" + } + }, + "X12_861": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "X12_861" + } + }, + "X12_864": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "X12_864" + } + }, + "X12_940": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "X12_940" + } + }, + "X12_990": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "X12_990" + } + }, + "X12_997": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "X12_997" + } + } + } + }, + "com.amazonaws.b2bi#X12Version": { + "type": "enum", + "members": { + "VERSION_4010": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VERSION_4010" + } + }, + "VERSION_4030": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VERSION_4030" + } + }, + "VERSION_5010": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VERSION_5010" + } + } + } + } + } +} \ No newline at end of file diff --git a/codegen/sdk-codegen/aws-models/backup.json b/codegen/sdk-codegen/aws-models/backup.json index b70eaf5e8c4..bcd732e5e57 100644 --- a/codegen/sdk-codegen/aws-models/backup.json +++ b/codegen/sdk-codegen/aws-models/backup.json @@ -268,10 +268,16 @@ "smithy.api#documentation": "

This is the non-unique name of the resource that \n belongs to the specified backup.

" } }, + "InitiationDate": { + "target": "com.amazonaws.backup#timestamp", + "traits": { + "smithy.api#documentation": "

This is the date on which the backup \n job was initiated.

" + } + }, "MessageCategory": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

This parameter is the job count for the specified \n message category.

\n

Example strings include AccessDenied, \n Success, and InvalidParameters. See \n Monitoring \n for a list of MessageCategory strings.

\n

The the value ANY returns count of all message categories.

\n

\n AGGREGATE_ALL aggregates job counts \n for all message categories and returns the sum.

" + "smithy.api#documentation": "

This parameter is the job count for the specified \n message category.

\n

Example strings may include AccessDenied, \n SUCCESS, AGGREGATE_ALL, and \n INVALIDPARAMETERS. See \n Monitoring \n for a list of MessageCategory strings.

\n

The the value ANY returns count of all message categories.

\n

\n AGGREGATE_ALL aggregates job counts \n for all message categories and returns the sum.

" } } }, @@ -857,7 +863,7 @@ "ListOfTags": { "target": "com.amazonaws.backup#ListOfTags", "traits": { - "smithy.api#documentation": "

A list of conditions that you define to assign resources to your backup plans using\n tags. For example, \"StringEquals\": {\n \"ConditionKey\": \"aws:ResourceTag/CreatedByCryo\",\n \"ConditionValue\": \"true\"\n },. Condition\n operators are case sensitive.

\n

\n ListOfTags differs from Conditions as follows:

\n " + "smithy.api#documentation": "

A list of conditions that you define to assign resources to your backup plans using\n tags. For example, \"StringEquals\": {\n \"Key\": \"aws:ResourceTag/CreatedByCryo\",\n \"Value\": \"true\"\n },. Condition\n operators are case sensitive.

\n

\n ListOfTags differs from Conditions as follows:

\n " } }, "NotResources": { @@ -869,7 +875,7 @@ "Conditions": { "target": "com.amazonaws.backup#Conditions", "traits": { - "smithy.api#documentation": "

A list of conditions that you define to assign resources to your backup plans using\n tags. For example, \"StringEquals\": {\n \"ConditionKey\": \"aws:ResourceTag/CreatedByCryo\",\n \"ConditionValue\": \"true\"\n },. Condition\n operators are case sensitive.

\n

\n Conditions differs from ListOfTags as follows:

\n " + "smithy.api#documentation": "

A list of conditions that you define to assign resources to your backup plans using\n tags. For example, \"StringEquals\": {\n \"Key\": \"aws:ResourceTag/CreatedByCryo\",\n \"Value\": \"true\"\n },. Condition\n operators are case sensitive.

\n

\n Conditions differs from ListOfTags as follows:

\n " } } }, @@ -1586,7 +1592,7 @@ "MessageCategory": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

This parameter is the job count for the specified \n message category.

\n

Example strings include AccessDenied, \n Success, and InvalidParameters. See \n Monitoring \n for a list of MessageCategory strings.

\n

The the value ANY returns count of all message categories.

\n

\n AGGREGATE_ALL aggregates job counts \n for all message categories and returns the sum

" + "smithy.api#documentation": "

This parameter is the job count for the specified \n message category.

\n

Example strings may include AccessDenied, \n SUCCESS, AGGREGATE_ALL, and \n InvalidParameters. See \n Monitoring \n for a list of MessageCategory strings.

\n

The the value ANY returns count of all message categories.

\n

\n AGGREGATE_ALL aggregates job counts \n for all message categories and returns the sum

" } } }, @@ -2339,7 +2345,7 @@ "CreatorRequestId": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

This is the ID of the creation request.

" + "smithy.api#documentation": "

This is the ID of the creation request.

\n

This parameter is optional. If used, this parameter must contain \n 1 to 50 alphanumeric or '-_.' characters.

" } }, "MinRetentionDays": { @@ -2502,6 +2508,203 @@ "smithy.api#output": {} } }, + "com.amazonaws.backup#CreateRestoreTestingPlan": { + "type": "operation", + "input": { + "target": "com.amazonaws.backup#CreateRestoreTestingPlanInput" + }, + "output": { + "target": "com.amazonaws.backup#CreateRestoreTestingPlanOutput" + }, + "errors": [ + { + "target": "com.amazonaws.backup#AlreadyExistsException" + }, + { + "target": "com.amazonaws.backup#ConflictException" + }, + { + "target": "com.amazonaws.backup#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.backup#LimitExceededException" + }, + { + "target": "com.amazonaws.backup#MissingParameterValueException" + }, + { + "target": "com.amazonaws.backup#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

This is the first of two steps to create a restore testing \n plan; once this request is successful, finish the procedure with \n request CreateRestoreTestingSelection.

\n

You must include the parameter RestoreTestingPlan. You may \n optionally include CreatorRequestId and Tags.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/restore-testing/plans", + "code": 201 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.backup#CreateRestoreTestingPlanInput": { + "type": "structure", + "members": { + "CreatorRequestId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

This is a unique string that identifies the request and \n allows failed requests to be retriedwithout the risk of running \n the operation twice. This parameter is optional. If used, this \n parameter must contain 1 to 50 alphanumeric or '-_.' characters.

" + } + }, + "RestoreTestingPlan": { + "target": "com.amazonaws.backup#RestoreTestingPlanForCreate", + "traits": { + "smithy.api#documentation": "

A restore testing plan must contain a unique RestoreTestingPlanName string\n you create and must contain a ScheduleExpression cron. You may optionally\n include a StartWindowHours integer and a CreatorRequestId\n string.

\n

The RestoreTestingPlanName is a unique string that is the name of the\n restore testing plan. This cannot be changed after creation, and it must consist of only\n alphanumeric characters and underscores.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.backup#SensitiveStringMap", + "traits": { + "smithy.api#documentation": "

Optional tags to include. A tag is a key-value pair you can use to \n manage, filter, and search for your resources. Allowed characters include \n UTF-8 letters,numbers, spaces, and the following characters: \n + - = . _ : /.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.backup#CreateRestoreTestingPlanOutput": { + "type": "structure", + "members": { + "CreationTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time a restore testing plan was created, in Unix format \n and Coordinated Universal Time (UTC). The value of CreationTime \n is accurate to milliseconds. For example, the value 1516925490.087 represents \n Friday, January 26, 2018 12:11:30.087AM.

", + "smithy.api#required": {} + } + }, + "RestoreTestingPlanArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies the created \n restore testing plan.

", + "smithy.api#required": {} + } + }, + "RestoreTestingPlanName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

This unique string is the name of the restore testing plan.

\n

The name cannot be changed after creation. The name consists of only \n alphanumeric characters and underscores. Maximum length is 50.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.backup#CreateRestoreTestingSelection": { + "type": "operation", + "input": { + "target": "com.amazonaws.backup#CreateRestoreTestingSelectionInput" + }, + "output": { + "target": "com.amazonaws.backup#CreateRestoreTestingSelectionOutput" + }, + "errors": [ + { + "target": "com.amazonaws.backup#AlreadyExistsException" + }, + { + "target": "com.amazonaws.backup#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.backup#LimitExceededException" + }, + { + "target": "com.amazonaws.backup#MissingParameterValueException" + }, + { + "target": "com.amazonaws.backup#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.backup#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

This request can be sent after CreateRestoreTestingPlan request \n returns successfully. This is the second part of creating a resource testing \n plan, and it must be completed sequentially.

\n

This consists of RestoreTestingSelectionName,\n ProtectedResourceType, and one of the following:

\n \n

Each protected resource type can have one single value.

\n

A restore testing selection can include a wildcard value (\"*\") for\n ProtectedResourceArns along with ProtectedResourceConditions.\n Alternatively, you can include up to 30 specific protected resource ARNs in\n ProtectedResourceArns.

\n

Cannot select by both protected resource types AND specific ARNs. \n Request will fail if both are included.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/restore-testing/plans/{RestoreTestingPlanName}/selections", + "code": 201 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.backup#CreateRestoreTestingSelectionInput": { + "type": "structure", + "members": { + "CreatorRequestId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

This is an optional unique string that identifies the request and allows \n failed requests to be retried without the risk of running the operation \n twice. If used, this parameter must contain \n 1 to 50 alphanumeric or '-_.' characters.

" + } + }, + "RestoreTestingPlanName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

Input the restore testing plan name that was returned from the \n related CreateRestoreTestingPlan request.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "RestoreTestingSelection": { + "target": "com.amazonaws.backup#RestoreTestingSelectionForCreate", + "traits": { + "smithy.api#documentation": "

This consists of RestoreTestingSelectionName,\n ProtectedResourceType, and one of the following:

\n \n

Each protected resource type can have one single value.

\n

A restore testing selection can include a wildcard value (\"*\") for\n ProtectedResourceArns along with ProtectedResourceConditions.\n Alternatively, you can include up to 30 specific protected resource ARNs in\n ProtectedResourceArns.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.backup#CreateRestoreTestingSelectionOutput": { + "type": "structure", + "members": { + "CreationTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

This is the time the resource testing selection was created successfully.

", + "smithy.api#required": {} + } + }, + "RestoreTestingPlanArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

This is the ARN of the restore testing plan with which the restore \n testing selection is associated.

", + "smithy.api#required": {} + } + }, + "RestoreTestingPlanName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

Unique string that is the name of the restore testing plan.

\n

The name cannot be changed after creation. The name consists of only \n alphanumeric characters and underscores. Maximum length is 50.

", + "smithy.api#required": {} + } + }, + "RestoreTestingSelectionName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

This is the unique name of the restore testing selection that belongs to \n the related restore testing plan.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.backup#CronExpression": { "type": "string" }, @@ -2533,6 +2736,12 @@ { "target": "com.amazonaws.backup#CreateReportPlan" }, + { + "target": "com.amazonaws.backup#CreateRestoreTestingPlan" + }, + { + "target": "com.amazonaws.backup#CreateRestoreTestingSelection" + }, { "target": "com.amazonaws.backup#DeleteBackupPlan" }, @@ -2560,6 +2769,12 @@ { "target": "com.amazonaws.backup#DeleteReportPlan" }, + { + "target": "com.amazonaws.backup#DeleteRestoreTestingPlan" + }, + { + "target": "com.amazonaws.backup#DeleteRestoreTestingSelection" + }, { "target": "com.amazonaws.backup#DescribeBackupJob" }, @@ -2626,6 +2841,18 @@ { "target": "com.amazonaws.backup#GetRecoveryPointRestoreMetadata" }, + { + "target": "com.amazonaws.backup#GetRestoreJobMetadata" + }, + { + "target": "com.amazonaws.backup#GetRestoreTestingInferredMetadata" + }, + { + "target": "com.amazonaws.backup#GetRestoreTestingPlan" + }, + { + "target": "com.amazonaws.backup#GetRestoreTestingSelection" + }, { "target": "com.amazonaws.backup#GetSupportedResourceTypes" }, @@ -2686,9 +2913,18 @@ { "target": "com.amazonaws.backup#ListRestoreJobs" }, + { + "target": "com.amazonaws.backup#ListRestoreJobsByProtectedResource" + }, { "target": "com.amazonaws.backup#ListRestoreJobSummaries" }, + { + "target": "com.amazonaws.backup#ListRestoreTestingPlans" + }, + { + "target": "com.amazonaws.backup#ListRestoreTestingSelections" + }, { "target": "com.amazonaws.backup#ListTags" }, @@ -2701,6 +2937,9 @@ { "target": "com.amazonaws.backup#PutBackupVaultNotifications" }, + { + "target": "com.amazonaws.backup#PutRestoreValidationResult" + }, { "target": "com.amazonaws.backup#StartBackupJob" }, @@ -2739,6 +2978,12 @@ }, { "target": "com.amazonaws.backup#UpdateReportPlan" + }, + { + "target": "com.amazonaws.backup#UpdateRestoreTestingPlan" + }, + { + "target": "com.amazonaws.backup#UpdateRestoreTestingSelection" } ], "traits": { @@ -3678,17 +3923,6 @@ "expect": { "error": "Invalid Configuration: Missing Region" } - }, - { - "documentation": "Partition doesn't support DualStack", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } } ], "version": "1.0" @@ -4214,75 +4448,39 @@ "smithy.api#input": {} } }, - "com.amazonaws.backup#DependencyFailureException": { - "type": "structure", - "members": { - "Code": { - "target": "com.amazonaws.backup#string" - }, - "Message": { - "target": "com.amazonaws.backup#string" - }, - "Type": { - "target": "com.amazonaws.backup#string", - "traits": { - "smithy.api#documentation": "

" - } - }, - "Context": { - "target": "com.amazonaws.backup#string", - "traits": { - "smithy.api#documentation": "

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A dependent Amazon Web Services service or resource returned an error to the Backup service, and the action cannot be completed.

", - "smithy.api#error": "server" - } - }, - "com.amazonaws.backup#DescribeBackupJob": { + "com.amazonaws.backup#DeleteRestoreTestingPlan": { "type": "operation", "input": { - "target": "com.amazonaws.backup#DescribeBackupJobInput" + "target": "com.amazonaws.backup#DeleteRestoreTestingPlanInput" }, "output": { - "target": "com.amazonaws.backup#DescribeBackupJobOutput" + "target": "smithy.api#Unit" }, "errors": [ { - "target": "com.amazonaws.backup#DependencyFailureException" - }, - { - "target": "com.amazonaws.backup#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.backup#MissingParameterValueException" - }, - { - "target": "com.amazonaws.backup#ResourceNotFoundException" + "target": "com.amazonaws.backup#InvalidRequestException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { - "smithy.api#documentation": "

Returns backup job details for the specified BackupJobId.

", + "smithy.api#documentation": "

This request deletes the specified restore testing plan.

\n

Deletion can only successfully occur if all associated \n restore testing selections are deleted first.

", "smithy.api#http": { - "method": "GET", - "uri": "/backup-jobs/{BackupJobId}", - "code": 200 + "method": "DELETE", + "uri": "/restore-testing/plans/{RestoreTestingPlanName}", + "code": 204 }, "smithy.api#idempotent": {} } }, - "com.amazonaws.backup#DescribeBackupJobInput": { + "com.amazonaws.backup#DeleteRestoreTestingPlanInput": { "type": "structure", "members": { - "BackupJobId": { - "target": "com.amazonaws.backup#string", + "RestoreTestingPlanName": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

Uniquely identifies a request to Backup to back up a resource.

", + "smithy.api#documentation": "

Required unique name of the restore testing plan you wish \n to delete.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4292,18 +4490,146 @@ "smithy.api#input": {} } }, - "com.amazonaws.backup#DescribeBackupJobOutput": { - "type": "structure", - "members": { - "AccountId": { - "target": "com.amazonaws.backup#AccountId", - "traits": { - "smithy.api#documentation": "

Returns the account ID that owns the backup job.

" - } - }, - "BackupJobId": { - "target": "com.amazonaws.backup#string", - "traits": { + "com.amazonaws.backup#DeleteRestoreTestingSelection": { + "type": "operation", + "input": { + "target": "com.amazonaws.backup#DeleteRestoreTestingSelectionInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.backup#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.backup#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Input the Restore Testing Plan name and Restore Testing Selection \n name.

\n

All testing selections associated with a restore testing plan must \n be deleted before the restore testing plan can be deleted.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/restore-testing/plans/{RestoreTestingPlanName}/selections/{RestoreTestingSelectionName}", + "code": 204 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.backup#DeleteRestoreTestingSelectionInput": { + "type": "structure", + "members": { + "RestoreTestingPlanName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

Required unique name of the restore testing plan that contains the \n restore testing selection you wish to delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "RestoreTestingSelectionName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

Required unique name of the restore testing selection you \n wish to delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.backup#DependencyFailureException": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.backup#string" + }, + "Message": { + "target": "com.amazonaws.backup#string" + }, + "Type": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

" + } + }, + "Context": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A dependent Amazon Web Services service or resource returned an error to the Backup service, and the action cannot be completed.

", + "smithy.api#error": "server" + } + }, + "com.amazonaws.backup#DescribeBackupJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.backup#DescribeBackupJobInput" + }, + "output": { + "target": "com.amazonaws.backup#DescribeBackupJobOutput" + }, + "errors": [ + { + "target": "com.amazonaws.backup#DependencyFailureException" + }, + { + "target": "com.amazonaws.backup#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.backup#MissingParameterValueException" + }, + { + "target": "com.amazonaws.backup#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.backup#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns backup job details for the specified BackupJobId.

", + "smithy.api#http": { + "method": "GET", + "uri": "/backup-jobs/{BackupJobId}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.backup#DescribeBackupJobInput": { + "type": "structure", + "members": { + "BackupJobId": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

Uniquely identifies a request to Backup to back up a resource.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.backup#DescribeBackupJobOutput": { + "type": "structure", + "members": { + "AccountId": { + "target": "com.amazonaws.backup#AccountId", + "traits": { + "smithy.api#documentation": "

Returns the account ID that owns the backup job.

" + } + }, + "BackupJobId": { + "target": "com.amazonaws.backup#string", + "traits": { "smithy.api#documentation": "

Uniquely identifies a request to Backup to back up a resource.

" } }, @@ -4446,10 +4772,16 @@ "smithy.api#documentation": "

This is the non-unique name of the resource that \n belongs to the specified backup.

" } }, + "InitiationDate": { + "target": "com.amazonaws.backup#timestamp", + "traits": { + "smithy.api#documentation": "

This is the date a backup job was initiated.

" + } + }, "MessageCategory": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

This is the job count for the specified \n message category.

\n

Example strings may include AccessDenied, \n Success, and InvalidParameters. See \n Monitoring \n for a list of MessageCategory strings.

" + "smithy.api#documentation": "

This is the job count for the specified \n message category.

\n

Example strings may include AccessDenied, SUCCESS,\n AGGREGATE_ALL, and INVALIDPARAMETERS. View Monitoring\n for a list of accepted MessageCategory strings.

" } } }, @@ -4548,7 +4880,7 @@ "CreatorRequestId": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

A unique string that identifies the request and allows failed requests to be retried\n without the risk of running the operation twice.

" + "smithy.api#documentation": "

A unique string that identifies the request and allows failed requests to be retried\n without the risk of running the operation twice. This parameter is optional. If used, this\n parameter must contain 1 to 50 alphanumeric or '-_.' characters.

" } }, "NumberOfRecoveryPoints": { @@ -4878,6 +5210,36 @@ "traits": { "smithy.api#documentation": "

This is the non-unique name of the resource that \n belongs to the specified backup.

" } + }, + "LastBackupVaultArn": { + "target": "com.amazonaws.backup#ARN", + "traits": { + "smithy.api#documentation": "

This is the ARN (Amazon Resource Name) of the backup vault \n that contains the most recent backup recovery point.

" + } + }, + "LastRecoveryPointArn": { + "target": "com.amazonaws.backup#ARN", + "traits": { + "smithy.api#documentation": "

This is the ARN (Amazon Resource Name) of the most recent \n recovery point.

" + } + }, + "LatestRestoreExecutionTimeMinutes": { + "target": "com.amazonaws.backup#Long", + "traits": { + "smithy.api#documentation": "

This is the time in minutes the most recent restore \n job took to complete.

" + } + }, + "LatestRestoreJobCreationDate": { + "target": "com.amazonaws.backup#timestamp", + "traits": { + "smithy.api#documentation": "

This is the creation date of the most recent restore job.

" + } + }, + "LatestRestoreRecoveryPointCreationDate": { + "target": "com.amazonaws.backup#timestamp", + "traits": { + "smithy.api#documentation": "

This is the date the most recent recovery point was created.

" + } } }, "traits": { @@ -5394,6 +5756,42 @@ "traits": { "smithy.api#documentation": "

Returns metadata associated with a restore job listed by resource type.

" } + }, + "RecoveryPointCreationDate": { + "target": "com.amazonaws.backup#timestamp", + "traits": { + "smithy.api#documentation": "

This is the creation date of the recovery point made by the specifed restore job.

" + } + }, + "CreatedBy": { + "target": "com.amazonaws.backup#RestoreJobCreator", + "traits": { + "smithy.api#documentation": "

Contains identifying information about the creation of a restore job.

" + } + }, + "ValidationStatus": { + "target": "com.amazonaws.backup#RestoreValidationStatus", + "traits": { + "smithy.api#documentation": "

This is the status of validation run on the indicated \n restore job.

" + } + }, + "ValidationStatusMessage": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

This describes the status of validation run on the \n indicated restore job.

" + } + }, + "DeletionStatus": { + "target": "com.amazonaws.backup#RestoreDeletionStatus", + "traits": { + "smithy.api#documentation": "

This notes the status of the data generated by the restore test. \n The status may be Deleting, Failed, \n or Successful.

" + } + }, + "DeletionStatusMessage": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

This describes the restore job deletion status.

" + } } }, "traits": { @@ -5899,7 +6297,7 @@ "CreatorRequestId": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

A unique string that identifies the request and allows failed requests to be retried\n without the risk of running the operation twice.

" + "smithy.api#documentation": "

A unique string that identifies the request and allows failed requests to be retried\n without the risk of running the operation twice.

" } }, "CreationDate": { @@ -6378,368 +6776,260 @@ "traits": { "smithy.api#documentation": "

The set of metadata key-value pairs that describe the original configuration of the\n backed-up resource. These values vary depending on the service that is being\n restored.

" } + }, + "ResourceType": { + "target": "com.amazonaws.backup#ResourceType", + "traits": { + "smithy.api#documentation": "

This is the resource type associated with the recovery point.

" + } } }, "traits": { "smithy.api#output": {} } }, - "com.amazonaws.backup#GetSupportedResourceTypes": { + "com.amazonaws.backup#GetRestoreJobMetadata": { "type": "operation", "input": { - "target": "smithy.api#Unit" + "target": "com.amazonaws.backup#GetRestoreJobMetadataInput" }, "output": { - "target": "com.amazonaws.backup#GetSupportedResourceTypesOutput" + "target": "com.amazonaws.backup#GetRestoreJobMetadataOutput" }, "errors": [ + { + "target": "com.amazonaws.backup#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.backup#MissingParameterValueException" + }, + { + "target": "com.amazonaws.backup#ResourceNotFoundException" + }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { - "smithy.api#documentation": "

Returns the Amazon Web Services resource types supported by Backup.

", + "smithy.api#documentation": "

This request returns the metadata for the specified restore job.

", "smithy.api#http": { "method": "GET", - "uri": "/supported-resource-types", + "uri": "/restore-jobs/{RestoreJobId}/metadata", "code": 200 } } }, - "com.amazonaws.backup#GetSupportedResourceTypesOutput": { + "com.amazonaws.backup#GetRestoreJobMetadataInput": { "type": "structure", "members": { - "ResourceTypes": { - "target": "com.amazonaws.backup#ResourceTypes", + "RestoreJobId": { + "target": "com.amazonaws.backup#RestoreJobId", "traits": { - "smithy.api#documentation": "

Contains a string with the supported Amazon Web Services resource types:

\n " + "smithy.api#documentation": "

This is a unique identifier of a restore job within Backup.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } } }, "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.backup#GlobalSettings": { - "type": "map", - "key": { - "target": "com.amazonaws.backup#GlobalSettingsName" - }, - "value": { - "target": "com.amazonaws.backup#GlobalSettingsValue" + "smithy.api#input": {} } }, - "com.amazonaws.backup#GlobalSettingsName": { - "type": "string" - }, - "com.amazonaws.backup#GlobalSettingsValue": { - "type": "string" - }, - "com.amazonaws.backup#IAMPolicy": { - "type": "string" - }, - "com.amazonaws.backup#IAMRoleArn": { - "type": "string" - }, - "com.amazonaws.backup#InvalidParameterValueException": { + "com.amazonaws.backup#GetRestoreJobMetadataOutput": { "type": "structure", "members": { - "Code": { - "target": "com.amazonaws.backup#string" - }, - "Message": { - "target": "com.amazonaws.backup#string" - }, - "Type": { - "target": "com.amazonaws.backup#string", + "RestoreJobId": { + "target": "com.amazonaws.backup#RestoreJobId", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

This is a unique identifier of a restore job within Backup.

" } }, - "Context": { - "target": "com.amazonaws.backup#string", + "Metadata": { + "target": "com.amazonaws.backup#Metadata", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

This contains the metadata of the specified backup job.

" } } }, "traits": { - "smithy.api#documentation": "

Indicates that something is wrong with a parameter's value. For example, the value is\n out of range.

", - "smithy.api#error": "client" + "smithy.api#output": {} } }, - "com.amazonaws.backup#InvalidRequestException": { - "type": "structure", - "members": { - "Code": { - "target": "com.amazonaws.backup#string" - }, - "Message": { - "target": "com.amazonaws.backup#string" - }, - "Type": { - "target": "com.amazonaws.backup#string", - "traits": { - "smithy.api#documentation": "

" - } - }, - "Context": { - "target": "com.amazonaws.backup#string", - "traits": { - "smithy.api#documentation": "

" - } - } + "com.amazonaws.backup#GetRestoreTestingInferredMetadata": { + "type": "operation", + "input": { + "target": "com.amazonaws.backup#GetRestoreTestingInferredMetadataInput" }, - "traits": { - "smithy.api#documentation": "

Indicates that something is wrong with the input to the request. For example, a\n parameter is of the wrong type.

", - "smithy.api#error": "client" - } - }, - "com.amazonaws.backup#InvalidResourceStateException": { - "type": "structure", - "members": { - "Code": { - "target": "com.amazonaws.backup#string" + "output": { + "target": "com.amazonaws.backup#GetRestoreTestingInferredMetadataOutput" + }, + "errors": [ + { + "target": "com.amazonaws.backup#InvalidParameterValueException" }, - "Message": { - "target": "com.amazonaws.backup#string" + { + "target": "com.amazonaws.backup#MissingParameterValueException" }, - "Type": { - "target": "com.amazonaws.backup#string", - "traits": { - "smithy.api#documentation": "

" - } + { + "target": "com.amazonaws.backup#ResourceNotFoundException" }, - "Context": { - "target": "com.amazonaws.backup#string", - "traits": { - "smithy.api#documentation": "

" - } + { + "target": "com.amazonaws.backup#ServiceUnavailableException" } - }, - "traits": { - "smithy.api#documentation": "

Backup is already performing an action on this recovery point. It can't\n perform the action you requested until the first action finishes. Try again later.

", - "smithy.api#error": "client" - } - }, - "com.amazonaws.backup#IsEnabled": { - "type": "boolean", + ], "traits": { - "smithy.api#default": false + "smithy.api#documentation": "

This request returns the minimal required set of metadata needed to \n start a restore job with secure default settings. BackupVaultName \n and RecoveryPointArn are required parameters. \n BackupVaultAccountId is an optional parameter.

", + "smithy.api#http": { + "method": "GET", + "uri": "/restore-testing/inferred-metadata", + "code": 200 + } } }, - "com.amazonaws.backup#LegalHold": { + "com.amazonaws.backup#GetRestoreTestingInferredMetadataInput": { "type": "structure", "members": { - "Title": { - "target": "com.amazonaws.backup#string", - "traits": { - "smithy.api#documentation": "

This is the title of a legal hold.

" - } - }, - "Status": { - "target": "com.amazonaws.backup#LegalHoldStatus", - "traits": { - "smithy.api#documentation": "

This is the status of the legal hold. Statuses can be \n ACTIVE, CREATING, CANCELED, and \n CANCELING.

" - } - }, - "Description": { - "target": "com.amazonaws.backup#string", - "traits": { - "smithy.api#documentation": "

This is the description of a legal hold.

" - } - }, - "LegalHoldId": { - "target": "com.amazonaws.backup#string", - "traits": { - "smithy.api#documentation": "

ID of specific legal hold on one or more recovery points.

" - } - }, - "LegalHoldArn": { - "target": "com.amazonaws.backup#ARN", + "BackupVaultAccountId": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

This is an Amazon Resource Number (ARN) that uniquely identifies the legal hold; for example, \n arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

" + "smithy.api#documentation": "

This is the account ID of the specified backup vault.

", + "smithy.api#httpQuery": "BackupVaultAccountId" } }, - "CreationDate": { - "target": "com.amazonaws.backup#timestamp", + "BackupVaultName": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

This is the time in number format when legal hold was created.

" + "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup \n vaults are identified by names that are unique to the account used to \n create them and the Amazon Web ServicesRegion where they are created. \n They consist of letters, numbers, and hyphens.

", + "smithy.api#httpQuery": "BackupVaultName", + "smithy.api#required": {} } }, - "CancellationDate": { - "target": "com.amazonaws.backup#timestamp", + "RecoveryPointArn": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

This is the time in number format when legal hold was cancelled.

" + "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a recovery \n point; for example,\n arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.\n

", + "smithy.api#httpQuery": "RecoveryPointArn", + "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

A legal hold is an administrative tool that helps prevent backups \n from being deleted while under a hold. While the hold is in place, \n backups under a hold cannot be deleted and lifecycle policies that \n would alter the backup status (such as transition to cold storage) are \n delayed until the legal hold is removed. A backup can have more than \n one legal hold. Legal holds are applied to one or more backups \n (also known as recovery points). These backups can be filtered by resource \n types and by resource IDs.

" + "smithy.api#input": {} } }, - "com.amazonaws.backup#LegalHoldStatus": { - "type": "enum", + "com.amazonaws.backup#GetRestoreTestingInferredMetadataOutput": { + "type": "structure", "members": { - "CREATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATING" - } - }, - "ACTIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACTIVE" - } - }, - "CANCELING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CANCELING" - } - }, - "CANCELED": { - "target": "smithy.api#Unit", + "InferredMetadata": { + "target": "com.amazonaws.backup#stringMap", "traits": { - "smithy.api#enumValue": "CANCELED" + "smithy.api#documentation": "

This is a string map of the metadata inferred from the request.

", + "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#output": {} } }, - "com.amazonaws.backup#LegalHoldsList": { - "type": "list", - "member": { - "target": "com.amazonaws.backup#LegalHold" + "com.amazonaws.backup#GetRestoreTestingPlan": { + "type": "operation", + "input": { + "target": "com.amazonaws.backup#GetRestoreTestingPlanInput" + }, + "output": { + "target": "com.amazonaws.backup#GetRestoreTestingPlanOutput" + }, + "errors": [ + { + "target": "com.amazonaws.backup#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.backup#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns RestoreTestingPlan details for the specified\n RestoreTestingPlanName. The details are the body of a restore testing plan\n in JSON format, in addition to plan metadata.

", + "smithy.api#http": { + "method": "GET", + "uri": "/restore-testing/plans/{RestoreTestingPlanName}", + "code": 200 + } } }, - "com.amazonaws.backup#Lifecycle": { + "com.amazonaws.backup#GetRestoreTestingPlanInput": { "type": "structure", "members": { - "MoveToColdStorageAfterDays": { - "target": "com.amazonaws.backup#Long", - "traits": { - "smithy.api#documentation": "

Specifies the number of days after creation that a recovery point is moved to cold\n storage.

" - } - }, - "DeleteAfterDays": { - "target": "com.amazonaws.backup#Long", + "RestoreTestingPlanName": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

Specifies the number of days after creation that a recovery point is deleted. Must be\n greater than 90 days plus MoveToColdStorageAfterDays.

" + "smithy.api#documentation": "

Required unique name of the restore testing plan.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Contains an array of Transition objects specifying how long in days before\n a recovery point transitions to cold storage or is deleted.

\n

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90\n days. Therefore, on the console, the “retention” setting must be 90 days greater than the\n “transition to cold after days” setting. The “transition to cold after days” setting cannot\n be changed after a backup has been transitioned to cold.

\n

Resource types that are able to be transitioned to cold storage are listed in the \"Lifecycle to cold storage\" \n section of the \n Feature availability by resource table. Backup ignores this expression for\n other resource types.

" + "smithy.api#input": {} } }, - "com.amazonaws.backup#LimitExceededException": { + "com.amazonaws.backup#GetRestoreTestingPlanOutput": { "type": "structure", "members": { - "Code": { - "target": "com.amazonaws.backup#string" - }, - "Message": { - "target": "com.amazonaws.backup#string" - }, - "Type": { - "target": "com.amazonaws.backup#string", - "traits": { - "smithy.api#documentation": "

" - } - }, - "Context": { - "target": "com.amazonaws.backup#string", + "RestoreTestingPlan": { + "target": "com.amazonaws.backup#RestoreTestingPlanForGet", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

Specifies the body of a restore testing plan. Includes \n RestoreTestingPlanName.

", + "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

A limit in the request has been exceeded; for example, a maximum number of items allowed\n in a request.

", - "smithy.api#error": "client" + "smithy.api#output": {} } }, - "com.amazonaws.backup#ListBackupJobSummaries": { + "com.amazonaws.backup#GetRestoreTestingSelection": { "type": "operation", "input": { - "target": "com.amazonaws.backup#ListBackupJobSummariesInput" + "target": "com.amazonaws.backup#GetRestoreTestingSelectionInput" }, "output": { - "target": "com.amazonaws.backup#ListBackupJobSummariesOutput" + "target": "com.amazonaws.backup#GetRestoreTestingSelectionOutput" }, "errors": [ { - "target": "com.amazonaws.backup#InvalidParameterValueException" + "target": "com.amazonaws.backup#ResourceNotFoundException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { - "smithy.api#documentation": "

This is a request for a summary of backup jobs created \n or running within the most recent 30 days. You can \n include parameters AccountID, State, ResourceType, MessageCategory, \n AggregationPeriod, MaxResults, or NextToken to filter \n results.

\n

This request returns a summary that contains \n Region, Account, State, ResourceType, MessageCategory, \n StartTime, EndTime, and Count of included jobs.

", + "smithy.api#documentation": "

Returns RestoreTestingSelection, which displays resources \n and elements of the restore testing plan.

", "smithy.api#http": { "method": "GET", - "uri": "/audit/backup-job-summaries", + "uri": "/restore-testing/plans/{RestoreTestingPlanName}/selections/{RestoreTestingSelectionName}", "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" } } }, - "com.amazonaws.backup#ListBackupJobSummariesInput": { + "com.amazonaws.backup#GetRestoreTestingSelectionInput": { "type": "structure", "members": { - "AccountId": { - "target": "com.amazonaws.backup#AccountId", - "traits": { - "smithy.api#documentation": "

Returns the job count for the specified account.

\n

If the request is sent from a member account or an account \n not part of Amazon Web Services Organizations, jobs within requestor's account \n will be returned.

\n

Root, admin, and delegated administrator accounts can use \n the value ANY to return job counts from every account in the \n organization.

\n

\n AGGREGATE_ALL aggregates job counts \n from all accounts within the authenticated organization, \n then returns the sum.

", - "smithy.api#httpQuery": "AccountId" - } - }, - "State": { - "target": "com.amazonaws.backup#BackupJobStatus", - "traits": { - "smithy.api#documentation": "

This parameter returns the job count for jobs \n with the specified state.

\n

The the value ANY returns count of all states.

\n

\n AGGREGATE_ALL aggregates job counts \n for all states and returns the sum.

", - "smithy.api#httpQuery": "State" - } - }, - "ResourceType": { - "target": "com.amazonaws.backup#ResourceType", - "traits": { - "smithy.api#documentation": "

Returns the job count for the specified resource type. \n Use request GetSupportedResourceTypes to obtain \n strings for supported resource types.

\n

The the value ANY returns count of all resource types.

\n

\n AGGREGATE_ALL aggregates job counts \n for all resource types and returns the sum.

\n

The type of Amazon Web Services resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

", - "smithy.api#httpQuery": "ResourceType" - } - }, - "MessageCategory": { - "target": "com.amazonaws.backup#MessageCategory", + "RestoreTestingPlanName": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

This parameter returns the job count for the specified \n message category.

\n

Example accepted strings include AccessDenied, \n Success, and InvalidParameters. See \n Monitoring \n for a list of accepted MessageCategory strings.

\n

The the value ANY returns count of all message categories.

\n

\n AGGREGATE_ALL aggregates job counts \n for all message categories and returns the sum.

", - "smithy.api#httpQuery": "MessageCategory" - } - }, - "AggregationPeriod": { - "target": "com.amazonaws.backup#AggregationPeriod", - "traits": { - "smithy.api#documentation": "

This is the period that sets the boundaries for returned \n results.

\n

Acceptable values include

\n ", - "smithy.api#httpQuery": "AggregationPeriod" - } - }, - "MaxResults": { - "target": "com.amazonaws.backup#MaxResults", - "traits": { - "smithy.api#documentation": "

This parameter sets the maximum number of items \n to be returned.

\n

The value is an integer. Range of accepted values is from \n 1 to 500.

", - "smithy.api#httpQuery": "MaxResults" + "smithy.api#documentation": "

Required unique name of the restore testing plan.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "NextToken": { - "target": "com.amazonaws.backup#string", + "RestoreTestingSelectionName": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The next item following a partial list of returned resources. For example, if a request\n is made to return maxResults number of resources, NextToken\n allows you to return more items in your list starting at the location pointed to by the\n next token.

", - "smithy.api#httpQuery": "NextToken" + "smithy.api#documentation": "

Required unique name of the restore testing selection.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } } }, @@ -6747,25 +7037,14 @@ "smithy.api#input": {} } }, - "com.amazonaws.backup#ListBackupJobSummariesOutput": { + "com.amazonaws.backup#GetRestoreTestingSelectionOutput": { "type": "structure", "members": { - "BackupJobSummaries": { - "target": "com.amazonaws.backup#BackupJobSummaryList", + "RestoreTestingSelection": { + "target": "com.amazonaws.backup#RestoreTestingSelectionForGet", "traits": { - "smithy.api#documentation": "

This request returns a summary that contains \n Region, Account, State, ResourceType, MessageCategory, \n StartTime, EndTime, and Count of included jobs.

" - } - }, - "AggregationPeriod": { - "target": "com.amazonaws.backup#string", - "traits": { - "smithy.api#documentation": "

This is the period that sets the boundaries for returned \n results.

\n " - } - }, - "NextToken": { - "target": "com.amazonaws.backup#string", - "traits": { - "smithy.api#documentation": "

The next item following a partial list of returned resources. For example, if a request\n is made to return maxResults number of resources, NextToken\n allows you to return more items in your list starting at the location pointed to by the\n next token.

" + "smithy.api#documentation": "

Unique name of the restore testing selection.

", + "smithy.api#required": {} } } }, @@ -6773,384 +7052,396 @@ "smithy.api#output": {} } }, - "com.amazonaws.backup#ListBackupJobs": { + "com.amazonaws.backup#GetSupportedResourceTypes": { "type": "operation", "input": { - "target": "com.amazonaws.backup#ListBackupJobsInput" + "target": "smithy.api#Unit" }, "output": { - "target": "com.amazonaws.backup#ListBackupJobsOutput" + "target": "com.amazonaws.backup#GetSupportedResourceTypesOutput" }, "errors": [ - { - "target": "com.amazonaws.backup#InvalidParameterValueException" - }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { - "smithy.api#documentation": "

Returns a list of existing backup jobs for an authenticated account for the last 30\n days. For a longer period of time, consider using these monitoring tools.

", + "smithy.api#documentation": "

Returns the Amazon Web Services resource types supported by Backup.

", "smithy.api#http": { "method": "GET", - "uri": "/backup-jobs", + "uri": "/supported-resource-types", "code": 200 - }, - "smithy.api#idempotent": {}, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "BackupJobs", - "pageSize": "MaxResults" } } }, - "com.amazonaws.backup#ListBackupJobsInput": { + "com.amazonaws.backup#GetSupportedResourceTypesOutput": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.backup#string", - "traits": { - "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is\n made to return maxResults number of items, NextToken allows you\n to return more items in your list starting at the location pointed to by the next\n token.

", - "smithy.api#httpQuery": "nextToken" - } - }, - "MaxResults": { - "target": "com.amazonaws.backup#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of items to be returned.

", - "smithy.api#httpQuery": "maxResults" - } - }, - "ByResourceArn": { - "target": "com.amazonaws.backup#ARN", - "traits": { - "smithy.api#documentation": "

Returns only backup jobs that match the specified resource Amazon Resource Name\n (ARN).

", - "smithy.api#httpQuery": "resourceArn" - } - }, - "ByState": { - "target": "com.amazonaws.backup#BackupJobState", - "traits": { - "smithy.api#documentation": "

Returns only backup jobs that are in the specified state.

", - "smithy.api#httpQuery": "state" - } - }, - "ByBackupVaultName": { - "target": "com.amazonaws.backup#BackupVaultName", - "traits": { - "smithy.api#documentation": "

Returns only backup jobs that will be stored in the specified backup vault. Backup\n vaults are identified by names that are unique to the account used to create them and the\n Amazon Web Services Region where they are created. They consist of lowercase letters,\n numbers, and hyphens.

", - "smithy.api#httpQuery": "backupVaultName" - } - }, - "ByCreatedBefore": { - "target": "com.amazonaws.backup#timestamp", - "traits": { - "smithy.api#documentation": "

Returns only backup jobs that were created before the specified date.

", - "smithy.api#httpQuery": "createdBefore" - } - }, - "ByCreatedAfter": { - "target": "com.amazonaws.backup#timestamp", + "ResourceTypes": { + "target": "com.amazonaws.backup#ResourceTypes", "traits": { - "smithy.api#documentation": "

Returns only backup jobs that were created after the specified date.

", - "smithy.api#httpQuery": "createdAfter" + "smithy.api#documentation": "

Contains a string with the supported Amazon Web Services resource types:

\n " } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.backup#GlobalSettings": { + "type": "map", + "key": { + "target": "com.amazonaws.backup#GlobalSettingsName" + }, + "value": { + "target": "com.amazonaws.backup#GlobalSettingsValue" + } + }, + "com.amazonaws.backup#GlobalSettingsName": { + "type": "string" + }, + "com.amazonaws.backup#GlobalSettingsValue": { + "type": "string" + }, + "com.amazonaws.backup#IAMPolicy": { + "type": "string" + }, + "com.amazonaws.backup#IAMRoleArn": { + "type": "string" + }, + "com.amazonaws.backup#InvalidParameterValueException": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.backup#string" }, - "ByResourceType": { - "target": "com.amazonaws.backup#ResourceType", - "traits": { - "smithy.api#documentation": "

Returns only backup jobs for the specified resources:

\n ", - "smithy.api#httpQuery": "resourceType" - } + "Message": { + "target": "com.amazonaws.backup#string" }, - "ByAccountId": { - "target": "com.amazonaws.backup#AccountId", + "Type": { + "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

The account ID to list the jobs from. Returns only backup jobs associated with the\n specified account ID.

\n

If used from an Organizations management account, passing * returns\n all jobs across the organization.

", - "smithy.api#httpQuery": "accountId" + "smithy.api#documentation": "

" } }, - "ByCompleteAfter": { - "target": "com.amazonaws.backup#timestamp", + "Context": { + "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

Returns only backup jobs completed after a date expressed in Unix format and Coordinated\n Universal Time (UTC).

", - "smithy.api#httpQuery": "completeAfter" + "smithy.api#documentation": "

" } + } + }, + "traits": { + "smithy.api#documentation": "

Indicates that something is wrong with a parameter's value. For example, the value is\n out of range.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.backup#InvalidRequestException": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.backup#string" }, - "ByCompleteBefore": { - "target": "com.amazonaws.backup#timestamp", - "traits": { - "smithy.api#documentation": "

Returns only backup jobs completed before a date expressed in Unix format and\n Coordinated Universal Time (UTC).

", - "smithy.api#httpQuery": "completeBefore" - } + "Message": { + "target": "com.amazonaws.backup#string" }, - "ByParentJobId": { + "Type": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

This is a filter to list child (nested) jobs based on parent job ID.

", - "smithy.api#httpQuery": "parentJobId" + "smithy.api#documentation": "

" } }, - "ByMessageCategory": { + "Context": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

This returns a list of backup jobs for the specified \n message category.

\n

Example strings may include AccessDenied, \n Success, and InvalidParameters. See \n Monitoring \n for a list of MessageCategory strings.

", - "smithy.api#httpQuery": "messageCategory" + "smithy.api#documentation": "

" } } }, "traits": { - "smithy.api#input": {} + "smithy.api#documentation": "

Indicates that something is wrong with the input to the request. For example, a\n parameter is of the wrong type.

", + "smithy.api#error": "client" } }, - "com.amazonaws.backup#ListBackupJobsOutput": { + "com.amazonaws.backup#InvalidResourceStateException": { "type": "structure", "members": { - "BackupJobs": { - "target": "com.amazonaws.backup#BackupJobsList", + "Code": { + "target": "com.amazonaws.backup#string" + }, + "Message": { + "target": "com.amazonaws.backup#string" + }, + "Type": { + "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

An array of structures containing metadata about your backup jobs returned in JSON\n format.

" + "smithy.api#documentation": "

" } }, - "NextToken": { + "Context": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is\n made to return maxResults number of items, NextToken allows you\n to return more items in your list starting at the location pointed to by the next\n token.

" + "smithy.api#documentation": "

" } } }, "traits": { - "smithy.api#output": {} + "smithy.api#documentation": "

Backup is already performing an action on this recovery point. It can't\n perform the action you requested until the first action finishes. Try again later.

", + "smithy.api#error": "client" } }, - "com.amazonaws.backup#ListBackupPlanTemplates": { - "type": "operation", - "input": { - "target": "com.amazonaws.backup#ListBackupPlanTemplatesInput" - }, - "output": { - "target": "com.amazonaws.backup#ListBackupPlanTemplatesOutput" - }, - "errors": [ - { - "target": "com.amazonaws.backup#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.backup#MissingParameterValueException" - }, - { - "target": "com.amazonaws.backup#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.backup#ServiceUnavailableException" - } - ], + "com.amazonaws.backup#IsEnabled": { + "type": "boolean", "traits": { - "smithy.api#documentation": "

Returns metadata of your saved backup plan templates, including the template ID, name,\n and the creation and deletion dates.

", - "smithy.api#http": { - "method": "GET", - "uri": "/backup/template/plans", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "BackupPlanTemplatesList", - "pageSize": "MaxResults" - } + "smithy.api#default": false } }, - "com.amazonaws.backup#ListBackupPlanTemplatesInput": { + "com.amazonaws.backup#KeyValue": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.backup#string", + "Key": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is\n made to return maxResults number of items, NextToken allows you\n to return more items in your list starting at the location pointed to by the next\n token.

", - "smithy.api#httpQuery": "nextToken" + "smithy.api#documentation": "

The tag key (String). The key can't start with \n aws:.

\n

Length Constraints: Minimum length of 1. Maximum \n length of 128.

\n

Pattern: ^(?![aA]{1}[wW]{1}[sS]{1}:)([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]+)$\n

", + "smithy.api#required": {} } }, - "MaxResults": { - "target": "com.amazonaws.backup#MaxResults", + "Value": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The maximum number of items to be returned.

", - "smithy.api#httpQuery": "maxResults" + "smithy.api#documentation": "

The value of the key.

\n

Length Constraints: Maximum length of 256.

\n

Pattern: ^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$\n

", + "smithy.api#required": {} } } }, "traits": { - "smithy.api#input": {} + "smithy.api#documentation": "

Pair of two related strings. Allowed characters \n are letters, white space, and numbers that can be \n represented in UTF-8 and the following characters: \n + - = . _ : /\n

" } }, - "com.amazonaws.backup#ListBackupPlanTemplatesOutput": { + "com.amazonaws.backup#KeyValueList": { + "type": "list", + "member": { + "target": "com.amazonaws.backup#KeyValue" + } + }, + "com.amazonaws.backup#LegalHold": { "type": "structure", "members": { - "NextToken": { + "Title": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is\n made to return maxResults number of items, NextToken allows you\n to return more items in your list starting at the location pointed to by the next\n token.

" + "smithy.api#documentation": "

This is the title of a legal hold.

" } }, - "BackupPlanTemplatesList": { - "target": "com.amazonaws.backup#BackupPlanTemplatesList", + "Status": { + "target": "com.amazonaws.backup#LegalHoldStatus", "traits": { - "smithy.api#documentation": "

An array of template list items containing metadata about your saved templates.

" + "smithy.api#documentation": "

This is the status of the legal hold. Statuses can be \n ACTIVE, CREATING, CANCELED, and \n CANCELING.

" } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.backup#ListBackupPlanVersions": { - "type": "operation", - "input": { - "target": "com.amazonaws.backup#ListBackupPlanVersionsInput" - }, - "output": { - "target": "com.amazonaws.backup#ListBackupPlanVersionsOutput" - }, - "errors": [ - { - "target": "com.amazonaws.backup#InvalidParameterValueException" }, - { - "target": "com.amazonaws.backup#MissingParameterValueException" + "Description": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

This is the description of a legal hold.

" + } }, - { - "target": "com.amazonaws.backup#ResourceNotFoundException" + "LegalHoldId": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

ID of specific legal hold on one or more recovery points.

" + } }, - { - "target": "com.amazonaws.backup#ServiceUnavailableException" + "LegalHoldArn": { + "target": "com.amazonaws.backup#ARN", + "traits": { + "smithy.api#documentation": "

This is an Amazon Resource Number (ARN) that uniquely identifies the legal hold; for example, \n arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

" + } + }, + "CreationDate": { + "target": "com.amazonaws.backup#timestamp", + "traits": { + "smithy.api#documentation": "

This is the time in number format when legal hold was created.

" + } + }, + "CancellationDate": { + "target": "com.amazonaws.backup#timestamp", + "traits": { + "smithy.api#documentation": "

This is the time in number format when legal hold was cancelled.

" + } } - ], + }, "traits": { - "smithy.api#documentation": "

Returns version metadata of your backup plans, including Amazon Resource Names (ARNs),\n backup plan IDs, creation and deletion dates, plan names, and version IDs.

", - "smithy.api#http": { - "method": "GET", - "uri": "/backup/plans/{BackupPlanId}/versions", - "code": 200 + "smithy.api#documentation": "

A legal hold is an administrative tool that helps prevent backups \n from being deleted while under a hold. While the hold is in place, \n backups under a hold cannot be deleted and lifecycle policies that \n would alter the backup status (such as transition to cold storage) are \n delayed until the legal hold is removed. A backup can have more than \n one legal hold. Legal holds are applied to one or more backups \n (also known as recovery points). These backups can be filtered by resource \n types and by resource IDs.

" + } + }, + "com.amazonaws.backup#LegalHoldStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } }, - "smithy.api#idempotent": {}, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "BackupPlanVersionsList", - "pageSize": "MaxResults" + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "CANCELING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CANCELING" + } + }, + "CANCELED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CANCELED" + } } } }, - "com.amazonaws.backup#ListBackupPlanVersionsInput": { + "com.amazonaws.backup#LegalHoldsList": { + "type": "list", + "member": { + "target": "com.amazonaws.backup#LegalHold" + } + }, + "com.amazonaws.backup#Lifecycle": { "type": "structure", "members": { - "BackupPlanId": { - "target": "com.amazonaws.backup#string", + "MoveToColdStorageAfterDays": { + "target": "com.amazonaws.backup#Long", "traits": { - "smithy.api#documentation": "

Uniquely identifies a backup plan.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

Specifies the number of days after creation that a recovery point is moved to cold\n storage.

" } }, - "NextToken": { - "target": "com.amazonaws.backup#string", + "DeleteAfterDays": { + "target": "com.amazonaws.backup#Long", "traits": { - "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is\n made to return maxResults number of items, NextToken allows you\n to return more items in your list starting at the location pointed to by the next\n token.

", - "smithy.api#httpQuery": "nextToken" + "smithy.api#documentation": "

Specifies the number of days after creation that a recovery point is deleted. Must be\n greater than 90 days plus MoveToColdStorageAfterDays.

" } }, - "MaxResults": { - "target": "com.amazonaws.backup#MaxResults", + "OptInToArchiveForSupportedResources": { + "target": "com.amazonaws.backup#Boolean", "traits": { - "smithy.api#documentation": "

The maximum number of items to be returned.

", - "smithy.api#httpQuery": "maxResults" + "smithy.api#documentation": "

Optional Boolean. If this is true, this setting will \n instruct your backup plan to transition supported resources to \n archive (cold) storage tier in accordance with your lifecycle settings.

" } } }, "traits": { - "smithy.api#input": {} + "smithy.api#documentation": "

Contains an array of Transition objects specifying how long in days before\n a recovery point transitions to cold storage or is deleted.

\n

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90\n days. Therefore, on the console, the “retention” setting must be 90 days greater than the\n “transition to cold after days” setting. The “transition to cold after days” setting cannot\n be changed after a backup has been transitioned to cold.

\n

Resource types that are able to be transitioned to cold storage are listed in the \"Lifecycle to cold storage\" \n section of the \n Feature availability by resource table. Backup ignores this expression for\n other resource types.

" } }, - "com.amazonaws.backup#ListBackupPlanVersionsOutput": { + "com.amazonaws.backup#LimitExceededException": { "type": "structure", "members": { - "NextToken": { + "Code": { + "target": "com.amazonaws.backup#string" + }, + "Message": { + "target": "com.amazonaws.backup#string" + }, + "Type": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is\n made to return maxResults number of items, NextToken allows you\n to return more items in your list starting at the location pointed to by the next\n token.

" + "smithy.api#documentation": "

" } }, - "BackupPlanVersionsList": { - "target": "com.amazonaws.backup#BackupPlanVersionsList", + "Context": { + "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

An array of version list items containing metadata about your backup plans.

" + "smithy.api#documentation": "

" } } }, "traits": { - "smithy.api#output": {} + "smithy.api#documentation": "

A limit in the request has been exceeded; for example, a maximum number of items allowed\n in a request.

", + "smithy.api#error": "client" } }, - "com.amazonaws.backup#ListBackupPlans": { + "com.amazonaws.backup#ListBackupJobSummaries": { "type": "operation", "input": { - "target": "com.amazonaws.backup#ListBackupPlansInput" + "target": "com.amazonaws.backup#ListBackupJobSummariesInput" }, "output": { - "target": "com.amazonaws.backup#ListBackupPlansOutput" + "target": "com.amazonaws.backup#ListBackupJobSummariesOutput" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, - { - "target": "com.amazonaws.backup#MissingParameterValueException" - }, - { - "target": "com.amazonaws.backup#ResourceNotFoundException" - }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { - "smithy.api#documentation": "

Returns a list of all active backup plans for an authenticated account. The list\n contains information such as Amazon Resource Names (ARNs), plan IDs, creation and deletion\n dates, version IDs, plan names, and creator request IDs.

", + "smithy.api#documentation": "

This is a request for a summary of backup jobs created \n or running within the most recent 30 days. You can \n include parameters AccountID, State, ResourceType, MessageCategory, \n AggregationPeriod, MaxResults, or NextToken to filter \n results.

\n

This request returns a summary that contains \n Region, Account, State, ResourceType, MessageCategory, \n StartTime, EndTime, and Count of included jobs.

", "smithy.api#http": { "method": "GET", - "uri": "/backup/plans", + "uri": "/audit/backup-job-summaries", "code": 200 }, - "smithy.api#idempotent": {}, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", - "items": "BackupPlansList", "pageSize": "MaxResults" } } }, - "com.amazonaws.backup#ListBackupPlansInput": { + "com.amazonaws.backup#ListBackupJobSummariesInput": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.backup#string", + "AccountId": { + "target": "com.amazonaws.backup#AccountId", "traits": { - "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is\n made to return maxResults number of items, NextToken allows you\n to return more items in your list starting at the location pointed to by the next\n token.

", - "smithy.api#httpQuery": "nextToken" + "smithy.api#documentation": "

Returns the job count for the specified account.

\n

If the request is sent from a member account or an account \n not part of Amazon Web Services Organizations, jobs within requestor's account \n will be returned.

\n

Root, admin, and delegated administrator accounts can use \n the value ANY to return job counts from every account in the \n organization.

\n

\n AGGREGATE_ALL aggregates job counts \n from all accounts within the authenticated organization, \n then returns the sum.

", + "smithy.api#httpQuery": "AccountId" + } + }, + "State": { + "target": "com.amazonaws.backup#BackupJobStatus", + "traits": { + "smithy.api#documentation": "

This parameter returns the job count for jobs \n with the specified state.

\n

The the value ANY returns count of all states.

\n

\n AGGREGATE_ALL aggregates job counts \n for all states and returns the sum.

", + "smithy.api#httpQuery": "State" + } + }, + "ResourceType": { + "target": "com.amazonaws.backup#ResourceType", + "traits": { + "smithy.api#documentation": "

Returns the job count for the specified resource type. \n Use request GetSupportedResourceTypes to obtain \n strings for supported resource types.

\n

The the value ANY returns count of all resource types.

\n

\n AGGREGATE_ALL aggregates job counts \n for all resource types and returns the sum.

\n

The type of Amazon Web Services resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

", + "smithy.api#httpQuery": "ResourceType" + } + }, + "MessageCategory": { + "target": "com.amazonaws.backup#MessageCategory", + "traits": { + "smithy.api#documentation": "

This parameter returns the job count for the specified \n message category.

\n

Example accepted strings include AccessDenied, \n Success, and InvalidParameters. See \n Monitoring \n for a list of accepted MessageCategory strings.

\n

The the value ANY returns count of all message categories.

\n

\n AGGREGATE_ALL aggregates job counts \n for all message categories and returns the sum.

", + "smithy.api#httpQuery": "MessageCategory" + } + }, + "AggregationPeriod": { + "target": "com.amazonaws.backup#AggregationPeriod", + "traits": { + "smithy.api#documentation": "

This is the period that sets the boundaries for returned \n results.

\n

Acceptable values include

\n ", + "smithy.api#httpQuery": "AggregationPeriod" } }, "MaxResults": { "target": "com.amazonaws.backup#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of items to be returned.

", - "smithy.api#httpQuery": "maxResults" + "smithy.api#documentation": "

This parameter sets the maximum number of items \n to be returned.

\n

The value is an integer. Range of accepted values is from \n 1 to 500.

", + "smithy.api#httpQuery": "MaxResults" } }, - "IncludeDeleted": { - "target": "com.amazonaws.backup#Boolean", + "NextToken": { + "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

A Boolean value with a default value of FALSE that returns deleted backup\n plans when set to TRUE.

", - "smithy.api#httpQuery": "includeDeleted" + "smithy.api#documentation": "

The next item following a partial list of returned resources. For example, if a request\n is made to return MaxResults number of resources, NextToken\n allows you to return more items in your list starting at the location pointed to by the\n next token.

", + "smithy.api#httpQuery": "NextToken" } } }, @@ -7158,19 +7449,25 @@ "smithy.api#input": {} } }, - "com.amazonaws.backup#ListBackupPlansOutput": { + "com.amazonaws.backup#ListBackupJobSummariesOutput": { "type": "structure", "members": { - "NextToken": { + "BackupJobSummaries": { + "target": "com.amazonaws.backup#BackupJobSummaryList", + "traits": { + "smithy.api#documentation": "

This request returns a summary that contains \n Region, Account, State, ResourceType, MessageCategory, \n StartTime, EndTime, and Count of included jobs.

" + } + }, + "AggregationPeriod": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is\n made to return maxResults number of items, NextToken allows you\n to return more items in your list starting at the location pointed to by the next\n token.

" + "smithy.api#documentation": "

This is the period that sets the boundaries for returned \n results.

\n " } }, - "BackupPlansList": { - "target": "com.amazonaws.backup#BackupPlansList", + "NextToken": { + "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

An array of backup plan list items containing metadata about your saved backup\n plans.

" + "smithy.api#documentation": "

The next item following a partial list of returned resources. For example, if a request\n is made to return MaxResults number of resources, NextToken\n allows you to return more items in your list starting at the location pointed to by the\n next token.

" } } }, @@ -7178,59 +7475,45 @@ "smithy.api#output": {} } }, - "com.amazonaws.backup#ListBackupSelections": { + "com.amazonaws.backup#ListBackupJobs": { "type": "operation", "input": { - "target": "com.amazonaws.backup#ListBackupSelectionsInput" + "target": "com.amazonaws.backup#ListBackupJobsInput" }, "output": { - "target": "com.amazonaws.backup#ListBackupSelectionsOutput" + "target": "com.amazonaws.backup#ListBackupJobsOutput" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, - { - "target": "com.amazonaws.backup#MissingParameterValueException" - }, - { - "target": "com.amazonaws.backup#ResourceNotFoundException" - }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { - "smithy.api#documentation": "

Returns an array containing metadata of the resources associated with the target backup\n plan.

", + "smithy.api#documentation": "

Returns a list of existing backup jobs for an authenticated account for the last 30\n days. For a longer period of time, consider using these monitoring tools.

", "smithy.api#http": { "method": "GET", - "uri": "/backup/plans/{BackupPlanId}/selections", + "uri": "/backup-jobs", "code": 200 }, "smithy.api#idempotent": {}, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", - "items": "BackupSelectionsList", + "items": "BackupJobs", "pageSize": "MaxResults" } } }, - "com.amazonaws.backup#ListBackupSelectionsInput": { + "com.amazonaws.backup#ListBackupJobsInput": { "type": "structure", "members": { - "BackupPlanId": { - "target": "com.amazonaws.backup#string", - "traits": { - "smithy.api#documentation": "

Uniquely identifies a backup plan.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, "NextToken": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is\n made to return maxResults number of items, NextToken allows you\n to return more items in your list starting at the location pointed to by the next\n token.

", + "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is \n made to return MaxResults number of items, NextToken allows you\n to return more items in your list starting at the location pointed to by the next\n token.

", "smithy.api#httpQuery": "nextToken" } }, @@ -7240,25 +7523,102 @@ "smithy.api#documentation": "

The maximum number of items to be returned.

", "smithy.api#httpQuery": "maxResults" } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.backup#ListBackupSelectionsOutput": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.backup#string", + }, + "ByResourceArn": { + "target": "com.amazonaws.backup#ARN", "traits": { - "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is\n made to return maxResults number of items, NextToken allows you\n to return more items in your list starting at the location pointed to by the next\n token.

" + "smithy.api#documentation": "

Returns only backup jobs that match the specified resource Amazon Resource Name\n (ARN).

", + "smithy.api#httpQuery": "resourceArn" } }, - "BackupSelectionsList": { - "target": "com.amazonaws.backup#BackupSelectionsList", + "ByState": { + "target": "com.amazonaws.backup#BackupJobState", "traits": { - "smithy.api#documentation": "

An array of backup selection list items containing metadata about each resource in the\n list.

" + "smithy.api#documentation": "

Returns only backup jobs that are in the specified state.

", + "smithy.api#httpQuery": "state" + } + }, + "ByBackupVaultName": { + "target": "com.amazonaws.backup#BackupVaultName", + "traits": { + "smithy.api#documentation": "

Returns only backup jobs that will be stored in the specified backup vault. Backup\n vaults are identified by names that are unique to the account used to create them and the\n Amazon Web Services Region where they are created. They consist of lowercase letters,\n numbers, and hyphens.

", + "smithy.api#httpQuery": "backupVaultName" + } + }, + "ByCreatedBefore": { + "target": "com.amazonaws.backup#timestamp", + "traits": { + "smithy.api#documentation": "

Returns only backup jobs that were created before the specified date.

", + "smithy.api#httpQuery": "createdBefore" + } + }, + "ByCreatedAfter": { + "target": "com.amazonaws.backup#timestamp", + "traits": { + "smithy.api#documentation": "

Returns only backup jobs that were created after the specified date.

", + "smithy.api#httpQuery": "createdAfter" + } + }, + "ByResourceType": { + "target": "com.amazonaws.backup#ResourceType", + "traits": { + "smithy.api#documentation": "

Returns only backup jobs for the specified resources:

\n ", + "smithy.api#httpQuery": "resourceType" + } + }, + "ByAccountId": { + "target": "com.amazonaws.backup#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID to list the jobs from. Returns only backup jobs associated with the\n specified account ID.

\n

If used from an Organizations management account, passing * returns\n all jobs across the organization.

", + "smithy.api#httpQuery": "accountId" + } + }, + "ByCompleteAfter": { + "target": "com.amazonaws.backup#timestamp", + "traits": { + "smithy.api#documentation": "

Returns only backup jobs completed after a date expressed in Unix format and Coordinated\n Universal Time (UTC).

", + "smithy.api#httpQuery": "completeAfter" + } + }, + "ByCompleteBefore": { + "target": "com.amazonaws.backup#timestamp", + "traits": { + "smithy.api#documentation": "

Returns only backup jobs completed before a date expressed in Unix format and\n Coordinated Universal Time (UTC).

", + "smithy.api#httpQuery": "completeBefore" + } + }, + "ByParentJobId": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

This is a filter to list child (nested) jobs based on parent job ID.

", + "smithy.api#httpQuery": "parentJobId" + } + }, + "ByMessageCategory": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

This is an optional parameter that can be used to \n filter out jobs with a MessageCategory which matches the \n value you input.

\n

Example strings may include AccessDenied, \n SUCCESS, AGGREGATE_ALL, and \n InvalidParameters.

\n

View Monitoring\n

\n

The wildcard () returns count of all message categories.

\n

\n AGGREGATE_ALL aggregates job counts \n for all message categories and returns the sum.

", + "smithy.api#httpQuery": "messageCategory" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.backup#ListBackupJobsOutput": { + "type": "structure", + "members": { + "BackupJobs": { + "target": "com.amazonaws.backup#BackupJobsList", + "traits": { + "smithy.api#documentation": "

An array of structures containing metadata about your backup jobs returned in JSON\n format.

" + } + }, + "NextToken": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is \n made to return MaxResults number of items, NextToken allows you\n to return more items in your list starting at the location pointed to by the next\n token.

" } } }, @@ -7266,13 +7626,13 @@ "smithy.api#output": {} } }, - "com.amazonaws.backup#ListBackupVaults": { + "com.amazonaws.backup#ListBackupPlanTemplates": { "type": "operation", "input": { - "target": "com.amazonaws.backup#ListBackupVaultsInput" + "target": "com.amazonaws.backup#ListBackupPlanTemplatesInput" }, "output": { - "target": "com.amazonaws.backup#ListBackupVaultsOutput" + "target": "com.amazonaws.backup#ListBackupPlanTemplatesOutput" }, "errors": [ { @@ -7289,43 +7649,27 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of recovery point storage containers along with information about\n them.

", + "smithy.api#documentation": "

Returns metadata of your saved backup plan templates, including the template ID, name,\n and the creation and deletion dates.

", "smithy.api#http": { "method": "GET", - "uri": "/backup-vaults", + "uri": "/backup/template/plans", "code": 200 }, - "smithy.api#idempotent": {}, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", - "items": "BackupVaultList", + "items": "BackupPlanTemplatesList", "pageSize": "MaxResults" } } }, - "com.amazonaws.backup#ListBackupVaultsInput": { + "com.amazonaws.backup#ListBackupPlanTemplatesInput": { "type": "structure", "members": { - "ByVaultType": { - "target": "com.amazonaws.backup#VaultType", - "traits": { - "smithy.api#documentation": "

This parameter will sort the list of vaults by vault type.

", - "smithy.api#httpQuery": "vaultType" - } - }, - "ByShared": { - "target": "com.amazonaws.backup#Boolean2", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

This parameter will sort the list of vaults by shared vaults.

", - "smithy.api#httpQuery": "shared" - } - }, "NextToken": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is\n made to return maxResults number of items, NextToken allows you\n to return more items in your list starting at the location pointed to by the next\n token.

", + "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is\n made to return MaxResults number of items, NextToken allows you\n to return more items in your list starting at the location pointed to by the next\n token.

", "smithy.api#httpQuery": "nextToken" } }, @@ -7341,19 +7685,19 @@ "smithy.api#input": {} } }, - "com.amazonaws.backup#ListBackupVaultsOutput": { + "com.amazonaws.backup#ListBackupPlanTemplatesOutput": { "type": "structure", "members": { - "BackupVaultList": { - "target": "com.amazonaws.backup#BackupVaultList", + "NextToken": { + "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

An array of backup vault list members containing vault metadata, including Amazon\n Resource Name (ARN), display name, creation date, number of saved recovery points, and\n encryption information if the resources saved in the backup vault are encrypted.

" + "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is\n made to return MaxResults number of items, NextToken allows you\n to return more items in your list starting at the location pointed to by the next\n token.

" } }, - "NextToken": { - "target": "com.amazonaws.backup#string", + "BackupPlanTemplatesList": { + "target": "com.amazonaws.backup#BackupPlanTemplatesList", "traits": { - "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is\n made to return maxResults number of items, NextToken allows you\n to return more items in your list starting at the location pointed to by the next\n token.

" + "smithy.api#documentation": "

An array of template list items containing metadata about your saved templates.

" } } }, @@ -7361,86 +7705,67 @@ "smithy.api#output": {} } }, - "com.amazonaws.backup#ListCopyJobSummaries": { + "com.amazonaws.backup#ListBackupPlanVersions": { "type": "operation", "input": { - "target": "com.amazonaws.backup#ListCopyJobSummariesInput" + "target": "com.amazonaws.backup#ListBackupPlanVersionsInput" }, "output": { - "target": "com.amazonaws.backup#ListCopyJobSummariesOutput" + "target": "com.amazonaws.backup#ListBackupPlanVersionsOutput" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, + { + "target": "com.amazonaws.backup#MissingParameterValueException" + }, + { + "target": "com.amazonaws.backup#ResourceNotFoundException" + }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { - "smithy.api#documentation": "

This request obtains a list of copy jobs created \n or running within the the most recent 30 days. You can \n include parameters AccountID, State, ResourceType, MessageCategory, \n AggregationPeriod, MaxResults, or NextToken to filter \n results.

\n

This request returns a summary that contains \n Region, Account, State, RestourceType, MessageCategory, \n StartTime, EndTime, and Count of included jobs.

", + "smithy.api#documentation": "

Returns version metadata of your backup plans, including Amazon Resource Names (ARNs),\n backup plan IDs, creation and deletion dates, plan names, and version IDs.

", "smithy.api#http": { "method": "GET", - "uri": "/audit/copy-job-summaries", + "uri": "/backup/plans/{BackupPlanId}/versions", "code": 200 }, + "smithy.api#idempotent": {}, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "BackupPlanVersionsList", "pageSize": "MaxResults" } } }, - "com.amazonaws.backup#ListCopyJobSummariesInput": { + "com.amazonaws.backup#ListBackupPlanVersionsInput": { "type": "structure", "members": { - "AccountId": { - "target": "com.amazonaws.backup#AccountId", - "traits": { - "smithy.api#documentation": "

Returns the job count for the specified account.

\n

If the request is sent from a member account or an account \n not part of Amazon Web Services Organizations, jobs within requestor's account \n will be returned.

\n

Root, admin, and delegated administrator accounts can use \n the value ANY to return job counts from every account in the \n organization.

\n

\n AGGREGATE_ALL aggregates job counts \n from all accounts within the authenticated organization, \n then returns the sum.

", - "smithy.api#httpQuery": "AccountId" - } - }, - "State": { - "target": "com.amazonaws.backup#CopyJobStatus", - "traits": { - "smithy.api#documentation": "

This parameter returns the job count for jobs \n with the specified state.

\n

The the value ANY returns count of all states.

\n

\n AGGREGATE_ALL aggregates job counts \n for all states and returns the sum.

", - "smithy.api#httpQuery": "State" - } - }, - "ResourceType": { - "target": "com.amazonaws.backup#ResourceType", - "traits": { - "smithy.api#documentation": "

Returns the job count for the specified resource type. \n Use request GetSupportedResourceTypes to obtain \n strings for supported resource types.

\n

The the value ANY returns count of all resource types.

\n

\n AGGREGATE_ALL aggregates job counts \n for all resource types and returns the sum.

\n

The type of Amazon Web Services resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

", - "smithy.api#httpQuery": "ResourceType" - } - }, - "MessageCategory": { - "target": "com.amazonaws.backup#MessageCategory", + "BackupPlanId": { + "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

This parameter returns the job count for the specified \n message category.

\n

Example accepted strings include AccessDenied, \n Success, and InvalidParameters. See \n Monitoring \n for a list of accepted MessageCategory strings.

\n

The the value ANY returns count of all message categories.

\n

\n AGGREGATE_ALL aggregates job counts \n for all message categories and returns the sum.

", - "smithy.api#httpQuery": "MessageCategory" + "smithy.api#documentation": "

Uniquely identifies a backup plan.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "AggregationPeriod": { - "target": "com.amazonaws.backup#AggregationPeriod", + "NextToken": { + "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

This is the period that sets the boundaries for returned \n results.

\n ", - "smithy.api#httpQuery": "AggregationPeriod" + "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is\n made to return MaxResults number of items, NextToken allows you\n to return more items in your list starting at the location pointed to by the next\n token.

", + "smithy.api#httpQuery": "nextToken" } }, "MaxResults": { "target": "com.amazonaws.backup#MaxResults", "traits": { - "smithy.api#documentation": "

This parameter sets the maximum number of items \n to be returned.

\n

The value is an integer. Range of accepted values is from \n 1 to 500.

", - "smithy.api#httpQuery": "MaxResults" - } - }, - "NextToken": { - "target": "com.amazonaws.backup#string", - "traits": { - "smithy.api#documentation": "

The next item following a partial list of returned resources. For example, if a request\n is made to return maxResults number of resources, NextToken\n allows you to return more items in your list starting at the location pointed to by the\n next token.

", - "smithy.api#httpQuery": "NextToken" + "smithy.api#documentation": "

The maximum number of items to be returned.

", + "smithy.api#httpQuery": "maxResults" } } }, @@ -7448,25 +7773,19 @@ "smithy.api#input": {} } }, - "com.amazonaws.backup#ListCopyJobSummariesOutput": { + "com.amazonaws.backup#ListBackupPlanVersionsOutput": { "type": "structure", "members": { - "CopyJobSummaries": { - "target": "com.amazonaws.backup#CopyJobSummaryList", - "traits": { - "smithy.api#documentation": "

This return shows a summary that contains \n Region, Account, State, ResourceType, MessageCategory, \n StartTime, EndTime, and Count of included jobs.

" - } - }, - "AggregationPeriod": { + "NextToken": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

This is the period that sets the boundaries for returned \n results.

\n " + "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is\n made to return MaxResults number of items, NextToken allows you\n to return more items in your list starting at the location pointed to by the next\n token.

" } }, - "NextToken": { - "target": "com.amazonaws.backup#string", + "BackupPlanVersionsList": { + "target": "com.amazonaws.backup#BackupPlanVersionsList", "traits": { - "smithy.api#documentation": "

The next item following a partial list of returned resources. For example, if a request\n is made to return maxResults number of resources, NextToken\n allows you to return more items in your list starting at the location pointed to by the\n next token.

" + "smithy.api#documentation": "

An array of version list items containing metadata about your backup plans.

" } } }, @@ -7474,44 +7793,51 @@ "smithy.api#output": {} } }, - "com.amazonaws.backup#ListCopyJobs": { + "com.amazonaws.backup#ListBackupPlans": { "type": "operation", "input": { - "target": "com.amazonaws.backup#ListCopyJobsInput" + "target": "com.amazonaws.backup#ListBackupPlansInput" }, "output": { - "target": "com.amazonaws.backup#ListCopyJobsOutput" + "target": "com.amazonaws.backup#ListBackupPlansOutput" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, + { + "target": "com.amazonaws.backup#MissingParameterValueException" + }, + { + "target": "com.amazonaws.backup#ResourceNotFoundException" + }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { - "smithy.api#documentation": "

Returns metadata about your copy jobs.

", + "smithy.api#documentation": "

Returns a list of all active backup plans for an authenticated account. The list\n contains information such as Amazon Resource Names (ARNs), plan IDs, creation and deletion\n dates, version IDs, plan names, and creator request IDs.

", "smithy.api#http": { "method": "GET", - "uri": "/copy-jobs", + "uri": "/backup/plans", "code": 200 }, + "smithy.api#idempotent": {}, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", - "items": "CopyJobs", + "items": "BackupPlansList", "pageSize": "MaxResults" } } }, - "com.amazonaws.backup#ListCopyJobsInput": { + "com.amazonaws.backup#ListBackupPlansInput": { "type": "structure", "members": { "NextToken": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is\n made to return maxResults number of items, NextToken allows you to return more items in\n your list starting at the location pointed to by the next token.

", + "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is\n made to return MaxResults number of items, NextToken allows you\n to return more items in your list starting at the location pointed to by the next\n token.

", "smithy.api#httpQuery": "nextToken" } }, @@ -7522,101 +7848,31 @@ "smithy.api#httpQuery": "maxResults" } }, - "ByResourceArn": { - "target": "com.amazonaws.backup#ARN", + "IncludeDeleted": { + "target": "com.amazonaws.backup#Boolean", "traits": { - "smithy.api#documentation": "

Returns only copy jobs that match the specified resource Amazon Resource Name (ARN).\n

", - "smithy.api#httpQuery": "resourceArn" + "smithy.api#documentation": "

A Boolean value with a default value of FALSE that returns deleted backup\n plans when set to TRUE.

", + "smithy.api#httpQuery": "includeDeleted" } - }, - "ByState": { - "target": "com.amazonaws.backup#CopyJobState", + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.backup#ListBackupPlansOutput": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

Returns only copy jobs that are in the specified state.

", - "smithy.api#httpQuery": "state" - } - }, - "ByCreatedBefore": { - "target": "com.amazonaws.backup#timestamp", - "traits": { - "smithy.api#documentation": "

Returns only copy jobs that were created before the specified date.

", - "smithy.api#httpQuery": "createdBefore" - } - }, - "ByCreatedAfter": { - "target": "com.amazonaws.backup#timestamp", - "traits": { - "smithy.api#documentation": "

Returns only copy jobs that were created after the specified date.

", - "smithy.api#httpQuery": "createdAfter" - } - }, - "ByResourceType": { - "target": "com.amazonaws.backup#ResourceType", - "traits": { - "smithy.api#documentation": "

Returns only backup jobs for the specified resources:

\n ", - "smithy.api#httpQuery": "resourceType" - } - }, - "ByDestinationVaultArn": { - "target": "com.amazonaws.backup#string", - "traits": { - "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a source backup vault to copy\n from; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.\n

", - "smithy.api#httpQuery": "destinationVaultArn" - } - }, - "ByAccountId": { - "target": "com.amazonaws.backup#AccountId", - "traits": { - "smithy.api#documentation": "

The account ID to list the jobs from. Returns only copy jobs associated with the\n specified account ID.

", - "smithy.api#httpQuery": "accountId" - } - }, - "ByCompleteBefore": { - "target": "com.amazonaws.backup#timestamp", - "traits": { - "smithy.api#documentation": "

Returns only copy jobs completed before a date expressed in Unix format and Coordinated\n Universal Time (UTC).

", - "smithy.api#httpQuery": "completeBefore" - } - }, - "ByCompleteAfter": { - "target": "com.amazonaws.backup#timestamp", - "traits": { - "smithy.api#documentation": "

Returns only copy jobs completed after a date expressed in Unix format and Coordinated\n Universal Time (UTC).

", - "smithy.api#httpQuery": "completeAfter" - } - }, - "ByParentJobId": { - "target": "com.amazonaws.backup#string", - "traits": { - "smithy.api#documentation": "

This is a filter to list child (nested) jobs based on parent job ID.

", - "smithy.api#httpQuery": "parentJobId" - } - }, - "ByMessageCategory": { - "target": "com.amazonaws.backup#string", - "traits": { - "smithy.api#documentation": "

This parameter returns the job count for the specified \n message category.

\n

Example accepted strings include AccessDenied, \n Success, and InvalidParameters. See \n Monitoring \n for a list of accepted MessageCategory strings.

\n

The the value ANY returns count of all message categories.

\n

\n AGGREGATE_ALL aggregates job counts \n for all message categories and returns the sum.

", - "smithy.api#httpQuery": "messageCategory" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.backup#ListCopyJobsOutput": { - "type": "structure", - "members": { - "CopyJobs": { - "target": "com.amazonaws.backup#CopyJobsList", - "traits": { - "smithy.api#documentation": "

An array of structures containing metadata about your copy jobs returned in JSON format.\n

" + "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is\n made to return MaxResults number of items, NextToken allows you\n to return more items in your list starting at the location pointed to by the next\n token.

" } }, - "NextToken": { - "target": "com.amazonaws.backup#string", + "BackupPlansList": { + "target": "com.amazonaws.backup#BackupPlansList", "traits": { - "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is\n made to return maxResults number of items, NextToken allows you to return more items in\n your list starting at the location pointed to by the next token.

" + "smithy.api#documentation": "

An array of backup plan list items containing metadata about your saved backup\n plans.

" } } }, @@ -7624,51 +7880,67 @@ "smithy.api#output": {} } }, - "com.amazonaws.backup#ListFrameworks": { + "com.amazonaws.backup#ListBackupSelections": { "type": "operation", "input": { - "target": "com.amazonaws.backup#ListFrameworksInput" + "target": "com.amazonaws.backup#ListBackupSelectionsInput" }, "output": { - "target": "com.amazonaws.backup#ListFrameworksOutput" + "target": "com.amazonaws.backup#ListBackupSelectionsOutput" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, + { + "target": "com.amazonaws.backup#MissingParameterValueException" + }, + { + "target": "com.amazonaws.backup#ResourceNotFoundException" + }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { - "smithy.api#documentation": "

Returns a list of all frameworks for an Amazon Web Services account and Amazon Web Services Region.

", + "smithy.api#documentation": "

Returns an array containing metadata of the resources associated with the target backup\n plan.

", "smithy.api#http": { "method": "GET", - "uri": "/audit/frameworks", + "uri": "/backup/plans/{BackupPlanId}/selections", "code": 200 }, + "smithy.api#idempotent": {}, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "BackupSelectionsList", "pageSize": "MaxResults" } } }, - "com.amazonaws.backup#ListFrameworksInput": { + "com.amazonaws.backup#ListBackupSelectionsInput": { "type": "structure", "members": { - "MaxResults": { - "target": "com.amazonaws.backup#MaxFrameworkInputs", + "BackupPlanId": { + "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

The number of desired results from 1 to 1000. Optional. If unspecified, the query will\n return 1 MB of data.

", - "smithy.api#httpQuery": "MaxResults" + "smithy.api#documentation": "

Uniquely identifies a backup plan.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

An identifier that was returned from the previous call to this operation, which can be\n used to return the next set of items in the list.

", - "smithy.api#httpQuery": "NextToken" + "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is\n made to return MaxResults number of items, NextToken allows you\n to return more items in your list starting at the location pointed to by the next\n token.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.backup#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of items to be returned.

", + "smithy.api#httpQuery": "maxResults" } } }, @@ -7676,19 +7948,19 @@ "smithy.api#input": {} } }, - "com.amazonaws.backup#ListFrameworksOutput": { + "com.amazonaws.backup#ListBackupSelectionsOutput": { "type": "structure", "members": { - "Frameworks": { - "target": "com.amazonaws.backup#FrameworkList", + "NextToken": { + "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

A list of frameworks with details for each framework, including the framework name,\n Amazon Resource Name (ARN), description, number of controls, creation time, and deployment\n status.

" + "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is\n made to return MaxResults number of items, NextToken allows you\n to return more items in your list starting at the location pointed to by the next\n token.

" } }, - "NextToken": { - "target": "com.amazonaws.backup#string", + "BackupSelectionsList": { + "target": "com.amazonaws.backup#BackupSelectionsList", "traits": { - "smithy.api#documentation": "

An identifier that was returned from the previous call to this operation, which can be\n used to return the next set of items in the list.

" + "smithy.api#documentation": "

An array of backup selection list items containing metadata about each resource in the\n list.

" } } }, @@ -7696,52 +7968,73 @@ "smithy.api#output": {} } }, - "com.amazonaws.backup#ListLegalHolds": { + "com.amazonaws.backup#ListBackupVaults": { "type": "operation", "input": { - "target": "com.amazonaws.backup#ListLegalHoldsInput" + "target": "com.amazonaws.backup#ListBackupVaultsInput" }, "output": { - "target": "com.amazonaws.backup#ListLegalHoldsOutput" + "target": "com.amazonaws.backup#ListBackupVaultsOutput" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, + { + "target": "com.amazonaws.backup#MissingParameterValueException" + }, + { + "target": "com.amazonaws.backup#ResourceNotFoundException" + }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { - "smithy.api#documentation": "

This action returns metadata about active and previous legal holds.

", + "smithy.api#documentation": "

Returns a list of recovery point storage containers along with information about\n them.

", "smithy.api#http": { "method": "GET", - "uri": "/legal-holds", + "uri": "/backup-vaults", "code": 200 }, "smithy.api#idempotent": {}, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", - "items": "LegalHolds", + "items": "BackupVaultList", "pageSize": "MaxResults" } } }, - "com.amazonaws.backup#ListLegalHoldsInput": { + "com.amazonaws.backup#ListBackupVaultsInput": { "type": "structure", "members": { + "ByVaultType": { + "target": "com.amazonaws.backup#VaultType", + "traits": { + "smithy.api#documentation": "

This parameter will sort the list of vaults by vault type.

", + "smithy.api#httpQuery": "vaultType" + } + }, + "ByShared": { + "target": "com.amazonaws.backup#Boolean2", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

This parameter will sort the list of vaults by shared vaults.

", + "smithy.api#httpQuery": "shared" + } + }, "NextToken": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

The next item following a partial list of returned resources. For example, if a request\n is made to return maxResults number of resources, NextToken\n allows you to return more items in your list starting at the location pointed to by the\n next token.

", + "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is\n made to return MaxResults number of items, NextToken allows you\n to return more items in your list starting at the location pointed to by the next\n token.

", "smithy.api#httpQuery": "nextToken" } }, "MaxResults": { "target": "com.amazonaws.backup#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of resource list items to be returned.

", + "smithy.api#documentation": "

The maximum number of items to be returned.

", "smithy.api#httpQuery": "maxResults" } } @@ -7750,19 +8043,19 @@ "smithy.api#input": {} } }, - "com.amazonaws.backup#ListLegalHoldsOutput": { + "com.amazonaws.backup#ListBackupVaultsOutput": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.backup#string", + "BackupVaultList": { + "target": "com.amazonaws.backup#BackupVaultList", "traits": { - "smithy.api#documentation": "

The next item following a partial list of returned resources. For example, if a request\n is made to return maxResults number of resources, NextToken\n allows you to return more items in your list starting at the location pointed to by the\n next token.

" + "smithy.api#documentation": "

An array of backup vault list members containing vault metadata, including Amazon\n Resource Name (ARN), display name, creation date, number of saved recovery points, and\n encryption information if the resources saved in the backup vault are encrypted.

" } }, - "LegalHolds": { - "target": "com.amazonaws.backup#LegalHoldsList", + "NextToken": { + "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

This is an array of returned legal holds, both active and previous.

" + "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is\n made to return MaxResults number of items, NextToken allows you\n to return more items in your list starting at the location pointed to by the next\n token.

" } } }, @@ -7770,150 +8063,86 @@ "smithy.api#output": {} } }, - "com.amazonaws.backup#ListOfTags": { - "type": "list", - "member": { - "target": "com.amazonaws.backup#Condition" - } - }, - "com.amazonaws.backup#ListProtectedResources": { - "type": "operation", - "input": { - "target": "com.amazonaws.backup#ListProtectedResourcesInput" - }, - "output": { - "target": "com.amazonaws.backup#ListProtectedResourcesOutput" - }, - "errors": [ - { - "target": "com.amazonaws.backup#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.backup#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns an array of resources successfully backed up by Backup, including\n the time the resource was saved, an Amazon Resource Name (ARN) of the resource, and a\n resource type.

", - "smithy.api#http": { - "method": "GET", - "uri": "/resources", - "code": 200 - }, - "smithy.api#idempotent": {}, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Results", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.backup#ListProtectedResourcesByBackupVault": { + "com.amazonaws.backup#ListCopyJobSummaries": { "type": "operation", "input": { - "target": "com.amazonaws.backup#ListProtectedResourcesByBackupVaultInput" + "target": "com.amazonaws.backup#ListCopyJobSummariesInput" }, "output": { - "target": "com.amazonaws.backup#ListProtectedResourcesByBackupVaultOutput" + "target": "com.amazonaws.backup#ListCopyJobSummariesOutput" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, - { - "target": "com.amazonaws.backup#ResourceNotFoundException" - }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { - "smithy.api#documentation": "

This request lists the protected resources corresponding to each backup vault.

", + "smithy.api#documentation": "

This request obtains a list of copy jobs created \n or running within the the most recent 30 days. You can \n include parameters AccountID, State, ResourceType, MessageCategory, \n AggregationPeriod, MaxResults, or NextToken to filter \n results.

\n

This request returns a summary that contains \n Region, Account, State, RestourceType, MessageCategory, \n StartTime, EndTime, and Count of included jobs.

", "smithy.api#http": { "method": "GET", - "uri": "/backup-vaults/{BackupVaultName}/resources", + "uri": "/audit/copy-job-summaries", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", - "items": "Results", "pageSize": "MaxResults" } } }, - "com.amazonaws.backup#ListProtectedResourcesByBackupVaultInput": { + "com.amazonaws.backup#ListCopyJobSummariesInput": { "type": "structure", "members": { - "BackupVaultName": { - "target": "com.amazonaws.backup#BackupVaultName", + "AccountId": { + "target": "com.amazonaws.backup#AccountId", "traits": { - "smithy.api#documentation": "

This is the list of protected resources by backup vault within the vault(s) you specify by name.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

Returns the job count for the specified account.

\n

If the request is sent from a member account or an account \n not part of Amazon Web Services Organizations, jobs within requestor's account \n will be returned.

\n

Root, admin, and delegated administrator accounts can use \n the value ANY to return job counts from every account in the \n organization.

\n

\n AGGREGATE_ALL aggregates job counts \n from all accounts within the authenticated organization, \n then returns the sum.

", + "smithy.api#httpQuery": "AccountId" } }, - "BackupVaultAccountId": { - "target": "com.amazonaws.backup#AccountId", + "State": { + "target": "com.amazonaws.backup#CopyJobStatus", "traits": { - "smithy.api#documentation": "

This is the list of protected resources by backup vault within the vault(s) you specify by account ID.

", - "smithy.api#httpQuery": "backupVaultAccountId" + "smithy.api#documentation": "

This parameter returns the job count for jobs \n with the specified state.

\n

The the value ANY returns count of all states.

\n

\n AGGREGATE_ALL aggregates job counts \n for all states and returns the sum.

", + "smithy.api#httpQuery": "State" } }, - "NextToken": { - "target": "com.amazonaws.backup#string", + "ResourceType": { + "target": "com.amazonaws.backup#ResourceType", "traits": { - "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is\n made to return maxResults number of items, NextToken allows you\n to return more items in your list starting at the location pointed to by the next\n token.

", - "smithy.api#httpQuery": "nextToken" + "smithy.api#documentation": "

Returns the job count for the specified resource type. \n Use request GetSupportedResourceTypes to obtain \n strings for supported resource types.

\n

The the value ANY returns count of all resource types.

\n

\n AGGREGATE_ALL aggregates job counts \n for all resource types and returns the sum.

\n

The type of Amazon Web Services resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

", + "smithy.api#httpQuery": "ResourceType" } }, - "MaxResults": { - "target": "com.amazonaws.backup#MaxResults", + "MessageCategory": { + "target": "com.amazonaws.backup#MessageCategory", "traits": { - "smithy.api#documentation": "

The maximum number of items to be returned.

", - "smithy.api#httpQuery": "maxResults" + "smithy.api#documentation": "

This parameter returns the job count for the specified \n message category.

\n

Example accepted strings include AccessDenied, \n Success, and InvalidParameters. See \n Monitoring \n for a list of accepted MessageCategory strings.

\n

The the value ANY returns count of all message categories.

\n

\n AGGREGATE_ALL aggregates job counts \n for all message categories and returns the sum.

", + "smithy.api#httpQuery": "MessageCategory" } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.backup#ListProtectedResourcesByBackupVaultOutput": { - "type": "structure", - "members": { - "Results": { - "target": "com.amazonaws.backup#ProtectedResourcesList", + }, + "AggregationPeriod": { + "target": "com.amazonaws.backup#AggregationPeriod", "traits": { - "smithy.api#documentation": "

These are the results returned for the request ListProtectedResourcesByBackupVault.

" + "smithy.api#documentation": "

This is the period that sets the boundaries for returned \n results.

\n ", + "smithy.api#httpQuery": "AggregationPeriod" } }, - "NextToken": { - "target": "com.amazonaws.backup#string", + "MaxResults": { + "target": "com.amazonaws.backup#MaxResults", "traits": { - "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is\n made to return maxResults number of items, NextToken allows you\n to return more items in your list starting at the location pointed to by the next\n token.

" + "smithy.api#documentation": "

This parameter sets the maximum number of items \n to be returned.

\n

The value is an integer. Range of accepted values is from \n 1 to 500.

", + "smithy.api#httpQuery": "MaxResults" } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.backup#ListProtectedResourcesInput": { - "type": "structure", - "members": { + }, "NextToken": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is\n made to return maxResults number of items, NextToken allows you\n to return more items in your list starting at the location pointed to by the next\n token.

", - "smithy.api#httpQuery": "nextToken" - } - }, - "MaxResults": { - "target": "com.amazonaws.backup#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of items to be returned.

", - "smithy.api#httpQuery": "maxResults" + "smithy.api#documentation": "

The next item following a partial list of returned resources. For example, if a request\n is made to return MaxResults number of resources, NextToken\n allows you to return more items in your list starting at the location pointed to by the\n next token.

", + "smithy.api#httpQuery": "NextToken" } } }, @@ -7921,19 +8150,25 @@ "smithy.api#input": {} } }, - "com.amazonaws.backup#ListProtectedResourcesOutput": { + "com.amazonaws.backup#ListCopyJobSummariesOutput": { "type": "structure", "members": { - "Results": { - "target": "com.amazonaws.backup#ProtectedResourcesList", + "CopyJobSummaries": { + "target": "com.amazonaws.backup#CopyJobSummaryList", "traits": { - "smithy.api#documentation": "

An array of resources successfully backed up by Backup including the time\n the resource was saved, an Amazon Resource Name (ARN) of the resource, and a resource\n type.

" + "smithy.api#documentation": "

This return shows a summary that contains \n Region, Account, State, ResourceType, MessageCategory, \n StartTime, EndTime, and Count of included jobs.

" + } + }, + "AggregationPeriod": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

This is the period that sets the boundaries for returned \n results.

\n " } }, "NextToken": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is\n made to return maxResults number of items, NextToken allows you\n to return more items in your list starting at the location pointed to by the next\n token.

" + "smithy.api#documentation": "

The next item following a partial list of returned resources. For example, if a request\n is made to return MaxResults number of resources, NextToken\n allows you to return more items in your list starting at the location pointed to by the\n next token.

" } } }, @@ -7941,66 +8176,44 @@ "smithy.api#output": {} } }, - "com.amazonaws.backup#ListRecoveryPointsByBackupVault": { + "com.amazonaws.backup#ListCopyJobs": { "type": "operation", "input": { - "target": "com.amazonaws.backup#ListRecoveryPointsByBackupVaultInput" + "target": "com.amazonaws.backup#ListCopyJobsInput" }, "output": { - "target": "com.amazonaws.backup#ListRecoveryPointsByBackupVaultOutput" + "target": "com.amazonaws.backup#ListCopyJobsOutput" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, - { - "target": "com.amazonaws.backup#MissingParameterValueException" - }, - { - "target": "com.amazonaws.backup#ResourceNotFoundException" - }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { - "smithy.api#documentation": "

Returns detailed information about the recovery points stored in a backup vault.

", + "smithy.api#documentation": "

Returns metadata about your copy jobs.

", "smithy.api#http": { "method": "GET", - "uri": "/backup-vaults/{BackupVaultName}/recovery-points", + "uri": "/copy-jobs", "code": 200 }, - "smithy.api#idempotent": {}, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", - "items": "RecoveryPoints", + "items": "CopyJobs", "pageSize": "MaxResults" } } }, - "com.amazonaws.backup#ListRecoveryPointsByBackupVaultInput": { + "com.amazonaws.backup#ListCopyJobsInput": { "type": "structure", "members": { - "BackupVaultName": { - "target": "com.amazonaws.backup#BackupVaultName", - "traits": { - "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Amazon Web Services\n Region where they are created. They consist of lowercase letters, numbers, and\n hyphens.

\n \n

Backup vault name might not be available when a supported service creates the\n backup.

\n ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "BackupVaultAccountId": { - "target": "com.amazonaws.backup#AccountId", - "traits": { - "smithy.api#documentation": "

This parameter will sort the list of recovery points by account ID.

", - "smithy.api#httpQuery": "backupVaultAccountId" - } - }, "NextToken": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is\n made to return maxResults number of items, NextToken allows you\n to return more items in your list starting at the location pointed to by the next\n token.

", + "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is\n made to return MaxResults number of items, NextToken allows you to return more items in\n your list starting at the location pointed to by the next token.

", "smithy.api#httpQuery": "nextToken" } }, @@ -8014,43 +8227,78 @@ "ByResourceArn": { "target": "com.amazonaws.backup#ARN", "traits": { - "smithy.api#documentation": "

Returns only recovery points that match the specified resource Amazon Resource Name\n (ARN).

", + "smithy.api#documentation": "

Returns only copy jobs that match the specified resource Amazon Resource Name (ARN).\n

", "smithy.api#httpQuery": "resourceArn" } }, + "ByState": { + "target": "com.amazonaws.backup#CopyJobState", + "traits": { + "smithy.api#documentation": "

Returns only copy jobs that are in the specified state.

", + "smithy.api#httpQuery": "state" + } + }, + "ByCreatedBefore": { + "target": "com.amazonaws.backup#timestamp", + "traits": { + "smithy.api#documentation": "

Returns only copy jobs that were created before the specified date.

", + "smithy.api#httpQuery": "createdBefore" + } + }, + "ByCreatedAfter": { + "target": "com.amazonaws.backup#timestamp", + "traits": { + "smithy.api#documentation": "

Returns only copy jobs that were created after the specified date.

", + "smithy.api#httpQuery": "createdAfter" + } + }, "ByResourceType": { "target": "com.amazonaws.backup#ResourceType", "traits": { - "smithy.api#documentation": "

Returns only recovery points that match the specified resource type.

", + "smithy.api#documentation": "

Returns only backup jobs for the specified resources:

\n ", "smithy.api#httpQuery": "resourceType" } }, - "ByBackupPlanId": { + "ByDestinationVaultArn": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

Returns only recovery points that match the specified backup plan ID.

", - "smithy.api#httpQuery": "backupPlanId" + "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a source backup vault to copy\n from; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.\n

", + "smithy.api#httpQuery": "destinationVaultArn" } }, - "ByCreatedBefore": { + "ByAccountId": { + "target": "com.amazonaws.backup#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID to list the jobs from. Returns only copy jobs associated with the\n specified account ID.

", + "smithy.api#httpQuery": "accountId" + } + }, + "ByCompleteBefore": { "target": "com.amazonaws.backup#timestamp", "traits": { - "smithy.api#documentation": "

Returns only recovery points that were created before the specified timestamp.

", - "smithy.api#httpQuery": "createdBefore" + "smithy.api#documentation": "

Returns only copy jobs completed before a date expressed in Unix format and Coordinated\n Universal Time (UTC).

", + "smithy.api#httpQuery": "completeBefore" } }, - "ByCreatedAfter": { + "ByCompleteAfter": { "target": "com.amazonaws.backup#timestamp", "traits": { - "smithy.api#documentation": "

Returns only recovery points that were created after the specified timestamp.

", - "smithy.api#httpQuery": "createdAfter" + "smithy.api#documentation": "

Returns only copy jobs completed after a date expressed in Unix format and Coordinated\n Universal Time (UTC).

", + "smithy.api#httpQuery": "completeAfter" } }, - "ByParentRecoveryPointArn": { - "target": "com.amazonaws.backup#ARN", + "ByParentJobId": { + "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

This returns only recovery points that match the specified parent (composite)\n recovery point Amazon Resource Name (ARN).

", - "smithy.api#httpQuery": "parentRecoveryPointArn" + "smithy.api#documentation": "

This is a filter to list child (nested) jobs based on parent job ID.

", + "smithy.api#httpQuery": "parentJobId" + } + }, + "ByMessageCategory": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

This is an optional parameter that can be used to \n filter out jobs with a MessageCategory which matches the \n value you input.

\n

Example strings may include AccessDenied, \n SUCCESS, AGGREGATE_ALL, and \n INVALIDPARAMETERS.

\n

View \n Monitoring\n for a list of accepted strings.

\n

The the value ANY returns count of all message categories.

\n

\n AGGREGATE_ALL aggregates job counts \n for all message categories and returns the sum.

", + "smithy.api#httpQuery": "messageCategory" } } }, @@ -8058,19 +8306,19 @@ "smithy.api#input": {} } }, - "com.amazonaws.backup#ListRecoveryPointsByBackupVaultOutput": { + "com.amazonaws.backup#ListCopyJobsOutput": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.backup#string", + "CopyJobs": { + "target": "com.amazonaws.backup#CopyJobsList", "traits": { - "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is\n made to return maxResults number of items, NextToken allows you\n to return more items in your list starting at the location pointed to by the next\n token.

" + "smithy.api#documentation": "

An array of structures containing metadata about your copy jobs returned in JSON format.\n

" } }, - "RecoveryPoints": { - "target": "com.amazonaws.backup#RecoveryPointByBackupVaultList", + "NextToken": { + "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

An array of objects that contain detailed information about recovery points saved in a\n backup vault.

" + "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is\n made to return MaxResults number of items, NextToken allows you to return more items in\n your list starting at the location pointed to by the next token.

" } } }, @@ -8078,64 +8326,51 @@ "smithy.api#output": {} } }, - "com.amazonaws.backup#ListRecoveryPointsByLegalHold": { + "com.amazonaws.backup#ListFrameworks": { "type": "operation", "input": { - "target": "com.amazonaws.backup#ListRecoveryPointsByLegalHoldInput" + "target": "com.amazonaws.backup#ListFrameworksInput" }, "output": { - "target": "com.amazonaws.backup#ListRecoveryPointsByLegalHoldOutput" + "target": "com.amazonaws.backup#ListFrameworksOutput" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, - { - "target": "com.amazonaws.backup#MissingParameterValueException" - }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { - "smithy.api#documentation": "

This action returns recovery point ARNs (Amazon Resource Names) of the \n specified legal hold.

", + "smithy.api#documentation": "

Returns a list of all frameworks for an Amazon Web Services account and Amazon Web Services Region.

", "smithy.api#http": { "method": "GET", - "uri": "/legal-holds/{LegalHoldId}/recovery-points", + "uri": "/audit/frameworks", "code": 200 }, - "smithy.api#idempotent": {}, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", - "items": "RecoveryPoints", "pageSize": "MaxResults" } } }, - "com.amazonaws.backup#ListRecoveryPointsByLegalHoldInput": { + "com.amazonaws.backup#ListFrameworksInput": { "type": "structure", "members": { - "LegalHoldId": { - "target": "com.amazonaws.backup#string", + "MaxResults": { + "target": "com.amazonaws.backup#MaxFrameworkInputs", "traits": { - "smithy.api#documentation": "

This is the ID of the legal hold.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

The number of desired results from 1 to 1000. Optional. If unspecified, the query will\n return 1 MB of data.

", + "smithy.api#httpQuery": "MaxResults" } }, "NextToken": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

This is the next item following a partial list of returned resources. For example, if a request\n is made to return maxResults number of resources, NextToken\n allows you to return more items in your list starting at the location pointed to by the\n next token.

", - "smithy.api#httpQuery": "nextToken" - } - }, - "MaxResults": { - "target": "com.amazonaws.backup#MaxResults", - "traits": { - "smithy.api#documentation": "

This is the maximum number of resource list items to be returned.

", - "smithy.api#httpQuery": "maxResults" + "smithy.api#documentation": "

An identifier that was returned from the previous call to this operation, which can be\n used to return the next set of items in the list.

", + "smithy.api#httpQuery": "NextToken" } } }, @@ -8143,19 +8378,19 @@ "smithy.api#input": {} } }, - "com.amazonaws.backup#ListRecoveryPointsByLegalHoldOutput": { + "com.amazonaws.backup#ListFrameworksOutput": { "type": "structure", "members": { - "RecoveryPoints": { - "target": "com.amazonaws.backup#RecoveryPointsList", + "Frameworks": { + "target": "com.amazonaws.backup#FrameworkList", "traits": { - "smithy.api#documentation": "

This is a list of the recovery points returned by \n ListRecoveryPointsByLegalHold.

" + "smithy.api#documentation": "

A list of frameworks with details for each framework, including the framework name,\n Amazon Resource Name (ARN), description, number of controls, creation time, and deployment\n status.

" } }, "NextToken": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

This return is the next item following a partial list of returned resources.

" + "smithy.api#documentation": "

An identifier that was returned from the previous call to this operation, which can be\n used to return the next set of items in the list.

" } } }, @@ -8163,66 +8398,52 @@ "smithy.api#output": {} } }, - "com.amazonaws.backup#ListRecoveryPointsByResource": { + "com.amazonaws.backup#ListLegalHolds": { "type": "operation", "input": { - "target": "com.amazonaws.backup#ListRecoveryPointsByResourceInput" + "target": "com.amazonaws.backup#ListLegalHoldsInput" }, "output": { - "target": "com.amazonaws.backup#ListRecoveryPointsByResourceOutput" + "target": "com.amazonaws.backup#ListLegalHoldsOutput" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, - { - "target": "com.amazonaws.backup#MissingParameterValueException" - }, - { - "target": "com.amazonaws.backup#ResourceNotFoundException" - }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { - "smithy.api#documentation": "

Returns detailed information about all the recovery points of the type specified by a\n resource Amazon Resource Name (ARN).

\n \n

For Amazon EFS and Amazon EC2, this action only lists recovery points\n created by Backup.

\n ", + "smithy.api#documentation": "

This action returns metadata about active and previous legal holds.

", "smithy.api#http": { "method": "GET", - "uri": "/resources/{ResourceArn}/recovery-points", + "uri": "/legal-holds", "code": 200 }, "smithy.api#idempotent": {}, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", - "items": "RecoveryPoints", + "items": "LegalHolds", "pageSize": "MaxResults" } } }, - "com.amazonaws.backup#ListRecoveryPointsByResourceInput": { + "com.amazonaws.backup#ListLegalHoldsInput": { "type": "structure", "members": { - "ResourceArn": { - "target": "com.amazonaws.backup#ARN", + "NextToken": { + "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

An ARN that uniquely identifies a resource. The format of the ARN depends on the\n resource type.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.backup#string", - "traits": { - "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is\n made to return maxResults number of items, NextToken allows you\n to return more items in your list starting at the location pointed to by the next\n token.

", + "smithy.api#documentation": "

The next item following a partial list of returned resources. For example, if a request\n is made to return MaxResults number of resources, NextToken\n allows you to return more items in your list starting at the location pointed to by the\n next token.

", "smithy.api#httpQuery": "nextToken" } }, "MaxResults": { "target": "com.amazonaws.backup#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of items to be returned.

\n \n

Amazon RDS requires a value of at least 20.

\n ", + "smithy.api#documentation": "

The maximum number of resource list items to be returned.

", "smithy.api#httpQuery": "maxResults" } } @@ -8231,19 +8452,19 @@ "smithy.api#input": {} } }, - "com.amazonaws.backup#ListRecoveryPointsByResourceOutput": { + "com.amazonaws.backup#ListLegalHoldsOutput": { "type": "structure", "members": { "NextToken": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is\n made to return maxResults number of items, NextToken allows you\n to return more items in your list starting at the location pointed to by the next\n token.

" + "smithy.api#documentation": "

The next item following a partial list of returned resources. For example, if a request\n is made to return MaxResults number of resources, NextToken\n allows you to return more items in your list starting at the location pointed to by the\n next token.

" } }, - "RecoveryPoints": { - "target": "com.amazonaws.backup#RecoveryPointByResourceList", + "LegalHolds": { + "target": "com.amazonaws.backup#LegalHoldsList", "traits": { - "smithy.api#documentation": "

An array of objects that contain detailed information about recovery points of the\n specified resource type.

\n \n

Only Amazon EFS and Amazon EC2 recovery points return\n BackupVaultName.

\n " + "smithy.api#documentation": "

This is an array of returned legal holds, both active and previous.

" } } }, @@ -8251,154 +8472,108 @@ "smithy.api#output": {} } }, - "com.amazonaws.backup#ListReportJobs": { + "com.amazonaws.backup#ListOfTags": { + "type": "list", + "member": { + "target": "com.amazonaws.backup#Condition" + } + }, + "com.amazonaws.backup#ListProtectedResources": { "type": "operation", "input": { - "target": "com.amazonaws.backup#ListReportJobsInput" + "target": "com.amazonaws.backup#ListProtectedResourcesInput" }, "output": { - "target": "com.amazonaws.backup#ListReportJobsOutput" + "target": "com.amazonaws.backup#ListProtectedResourcesOutput" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, - { - "target": "com.amazonaws.backup#ResourceNotFoundException" - }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { - "smithy.api#documentation": "

Returns details about your report jobs.

", + "smithy.api#documentation": "

Returns an array of resources successfully backed up by Backup, including\n the time the resource was saved, an Amazon Resource Name (ARN) of the resource, and a\n resource type.

", "smithy.api#http": { "method": "GET", - "uri": "/audit/report-jobs", + "uri": "/resources", "code": 200 }, + "smithy.api#idempotent": {}, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "Results", "pageSize": "MaxResults" } } }, - "com.amazonaws.backup#ListReportJobsInput": { - "type": "structure", - "members": { - "ByReportPlanName": { - "target": "com.amazonaws.backup#ReportPlanName", - "traits": { - "smithy.api#documentation": "

Returns only report jobs with the specified report plan name.

", - "smithy.api#httpQuery": "ReportPlanName" - } - }, - "ByCreationBefore": { - "target": "com.amazonaws.backup#timestamp", - "traits": { - "smithy.api#documentation": "

Returns only report jobs that were created before the date and time specified in Unix\n format and Coordinated Universal Time (UTC). For example, the value 1516925490 represents\n Friday, January 26, 2018 12:11:30 AM.

", - "smithy.api#httpQuery": "CreationBefore" - } - }, - "ByCreationAfter": { - "target": "com.amazonaws.backup#timestamp", - "traits": { - "smithy.api#documentation": "

Returns only report jobs that were created after the date and time specified in Unix\n format and Coordinated Universal Time (UTC). For example, the value 1516925490 represents\n Friday, January 26, 2018 12:11:30 AM.

", - "smithy.api#httpQuery": "CreationAfter" - } - }, - "ByStatus": { - "target": "com.amazonaws.backup#string", - "traits": { - "smithy.api#documentation": "

Returns only report jobs that are in the specified status. The statuses are:

\n

\n CREATED | RUNNING | COMPLETED | FAILED\n

", - "smithy.api#httpQuery": "Status" - } - }, - "MaxResults": { - "target": "com.amazonaws.backup#MaxResults", - "traits": { - "smithy.api#documentation": "

The number of desired results from 1 to 1000. Optional. If unspecified, the query will\n return 1 MB of data.

", - "smithy.api#httpQuery": "MaxResults" - } - }, - "NextToken": { - "target": "com.amazonaws.backup#string", - "traits": { - "smithy.api#documentation": "

An identifier that was returned from the previous call to this operation, which can be\n used to return the next set of items in the list.

", - "smithy.api#httpQuery": "NextToken" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.backup#ListReportJobsOutput": { - "type": "structure", - "members": { - "ReportJobs": { - "target": "com.amazonaws.backup#ReportJobList", - "traits": { - "smithy.api#documentation": "

Details about your report jobs in JSON format.

" - } - }, - "NextToken": { - "target": "com.amazonaws.backup#string", - "traits": { - "smithy.api#documentation": "

An identifier that was returned from the previous call to this operation, which can be\n used to return the next set of items in the list.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.backup#ListReportPlans": { + "com.amazonaws.backup#ListProtectedResourcesByBackupVault": { "type": "operation", "input": { - "target": "com.amazonaws.backup#ListReportPlansInput" + "target": "com.amazonaws.backup#ListProtectedResourcesByBackupVaultInput" }, "output": { - "target": "com.amazonaws.backup#ListReportPlansOutput" + "target": "com.amazonaws.backup#ListProtectedResourcesByBackupVaultOutput" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, + { + "target": "com.amazonaws.backup#ResourceNotFoundException" + }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { - "smithy.api#documentation": "

Returns a list of your report plans. For detailed information about a single report\n plan, use DescribeReportPlan.

", + "smithy.api#documentation": "

This request lists the protected resources corresponding to each backup vault.

", "smithy.api#http": { "method": "GET", - "uri": "/audit/report-plans", + "uri": "/backup-vaults/{BackupVaultName}/resources", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "Results", "pageSize": "MaxResults" } } }, - "com.amazonaws.backup#ListReportPlansInput": { + "com.amazonaws.backup#ListProtectedResourcesByBackupVaultInput": { "type": "structure", "members": { - "MaxResults": { - "target": "com.amazonaws.backup#MaxResults", + "BackupVaultName": { + "target": "com.amazonaws.backup#BackupVaultName", "traits": { - "smithy.api#documentation": "

The number of desired results from 1 to 1000. Optional. If unspecified, the query will\n return 1 MB of data.

", - "smithy.api#httpQuery": "MaxResults" + "smithy.api#documentation": "

This is the list of protected resources by backup vault within the vault(s) you specify by name.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "BackupVaultAccountId": { + "target": "com.amazonaws.backup#AccountId", + "traits": { + "smithy.api#documentation": "

This is the list of protected resources by backup vault within the vault(s) you specify by account ID.

", + "smithy.api#httpQuery": "backupVaultAccountId" } }, "NextToken": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

An identifier that was returned from the previous call to this operation, which can be\n used to return the next set of items in the list.

", - "smithy.api#httpQuery": "NextToken" + "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is\n made to return MaxResults number of items, NextToken allows you\n to return more items in your list starting at the location pointed to by the next\n token.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.backup#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of items to be returned.

", + "smithy.api#httpQuery": "maxResults" } } }, @@ -8406,19 +8581,19 @@ "smithy.api#input": {} } }, - "com.amazonaws.backup#ListReportPlansOutput": { + "com.amazonaws.backup#ListProtectedResourcesByBackupVaultOutput": { "type": "structure", "members": { - "ReportPlans": { - "target": "com.amazonaws.backup#ReportPlanList", + "Results": { + "target": "com.amazonaws.backup#ProtectedResourcesList", "traits": { - "smithy.api#documentation": "

A list of your report plans with detailed information for each plan. This information\n includes the Amazon Resource Name (ARN), report plan name, description, settings, delivery\n channel, deployment status, creation time, and last times the report plan attempted to and\n successfully ran.

" + "smithy.api#documentation": "

These are the results returned for the request ListProtectedResourcesByBackupVault.

" } }, "NextToken": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

An identifier that was returned from the previous call to this operation, which can be\n used to return the next set of items in the list.

" + "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is\n made to return MaxResults number of items, NextToken allows you\n to return more items in your list starting at the location pointed to by the next\n token.

" } } }, @@ -8426,79 +8601,21 @@ "smithy.api#output": {} } }, - "com.amazonaws.backup#ListRestoreJobSummaries": { - "type": "operation", - "input": { - "target": "com.amazonaws.backup#ListRestoreJobSummariesInput" - }, - "output": { - "target": "com.amazonaws.backup#ListRestoreJobSummariesOutput" - }, - "errors": [ - { - "target": "com.amazonaws.backup#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.backup#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "

This request obtains a summary of restore jobs created \n or running within the the most recent 30 days. You can \n include parameters AccountID, State, ResourceType, \n AggregationPeriod, MaxResults, or NextToken to filter \n results.

\n

This request returns a summary that contains \n Region, Account, State, RestourceType, MessageCategory, \n StartTime, EndTime, and Count of included jobs.

", - "smithy.api#http": { - "method": "GET", - "uri": "/audit/restore-job-summaries", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.backup#ListRestoreJobSummariesInput": { + "com.amazonaws.backup#ListProtectedResourcesInput": { "type": "structure", "members": { - "AccountId": { - "target": "com.amazonaws.backup#AccountId", - "traits": { - "smithy.api#documentation": "

Returns the job count for the specified account.

\n

If the request is sent from a member account or an account \n not part of Amazon Web Services Organizations, jobs within requestor's account \n will be returned.

\n

Root, admin, and delegated administrator accounts can use \n the value ANY to return job counts from every account in the \n organization.

\n

\n AGGREGATE_ALL aggregates job counts \n from all accounts within the authenticated organization, \n then returns the sum.

", - "smithy.api#httpQuery": "AccountId" - } - }, - "State": { - "target": "com.amazonaws.backup#RestoreJobState", - "traits": { - "smithy.api#documentation": "

This parameter returns the job count for jobs \n with the specified state.

\n

The the value ANY returns count of all states.

\n

\n AGGREGATE_ALL aggregates job counts \n for all states and returns the sum.

", - "smithy.api#httpQuery": "State" - } - }, - "ResourceType": { - "target": "com.amazonaws.backup#ResourceType", - "traits": { - "smithy.api#documentation": "

Returns the job count for the specified resource type. \n Use request GetSupportedResourceTypes to obtain \n strings for supported resource types.

\n

The the value ANY returns count of all resource types.

\n

\n AGGREGATE_ALL aggregates job counts \n for all resource types and returns the sum.

\n

The type of Amazon Web Services resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

", - "smithy.api#httpQuery": "ResourceType" - } - }, - "AggregationPeriod": { - "target": "com.amazonaws.backup#AggregationPeriod", + "NextToken": { + "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

This is the period that sets the boundaries for returned \n results.

\n

Acceptable values include

\n ", - "smithy.api#httpQuery": "AggregationPeriod" + "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is\n made to return MaxResults number of items, NextToken allows you\n to return more items in your list starting at the location pointed to by the next\n token.

", + "smithy.api#httpQuery": "nextToken" } }, "MaxResults": { "target": "com.amazonaws.backup#MaxResults", "traits": { - "smithy.api#documentation": "

This parameter sets the maximum number of items \n to be returned.

\n

The value is an integer. Range of accepted values is from \n 1 to 500.

", - "smithy.api#httpQuery": "MaxResults" - } - }, - "NextToken": { - "target": "com.amazonaws.backup#string", - "traits": { - "smithy.api#documentation": "

The next item following a partial list of returned resources. For example, if a request\n is made to return maxResults number of resources, NextToken\n allows you to return more items in your list starting at the location pointed to by the\n next token.

", - "smithy.api#httpQuery": "NextToken" + "smithy.api#documentation": "

The maximum number of items to be returned.

", + "smithy.api#httpQuery": "maxResults" } } }, @@ -8506,25 +8623,19 @@ "smithy.api#input": {} } }, - "com.amazonaws.backup#ListRestoreJobSummariesOutput": { + "com.amazonaws.backup#ListProtectedResourcesOutput": { "type": "structure", "members": { - "RestoreJobSummaries": { - "target": "com.amazonaws.backup#RestoreJobSummaryList", - "traits": { - "smithy.api#documentation": "

This return contains a summary that contains \n Region, Account, State, ResourceType, MessageCategory, \n StartTime, EndTime, and Count of included jobs.

" - } - }, - "AggregationPeriod": { - "target": "com.amazonaws.backup#string", + "Results": { + "target": "com.amazonaws.backup#ProtectedResourcesList", "traits": { - "smithy.api#documentation": "

This is the period that sets the boundaries for returned \n results.

\n " + "smithy.api#documentation": "

An array of resources successfully backed up by Backup including the time\n the resource was saved, an Amazon Resource Name (ARN) of the resource, and a resource\n type.

" } }, "NextToken": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

The next item following a partial list of returned resources. For example, if a request\n is made to return maxResults number of resources, NextToken\n allows you to return more items in your list starting at the location pointed to by the\n next token.

" + "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is\n made to return MaxResults number of items, NextToken allows you\n to return more items in your list starting at the location pointed to by the next\n token.

" } } }, @@ -8532,13 +8643,13 @@ "smithy.api#output": {} } }, - "com.amazonaws.backup#ListRestoreJobs": { + "com.amazonaws.backup#ListRecoveryPointsByBackupVault": { "type": "operation", "input": { - "target": "com.amazonaws.backup#ListRestoreJobsInput" + "target": "com.amazonaws.backup#ListRecoveryPointsByBackupVaultInput" }, "output": { - "target": "com.amazonaws.backup#ListRestoreJobsOutput" + "target": "com.amazonaws.backup#ListRecoveryPointsByBackupVaultOutput" }, "errors": [ { @@ -8555,28 +8666,43 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of jobs that Backup initiated to restore a saved resource,\n including details about the recovery process.

", + "smithy.api#documentation": "

Returns detailed information about the recovery points stored in a backup vault.

", "smithy.api#http": { "method": "GET", - "uri": "/restore-jobs", + "uri": "/backup-vaults/{BackupVaultName}/recovery-points", "code": 200 }, "smithy.api#idempotent": {}, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", - "items": "RestoreJobs", + "items": "RecoveryPoints", "pageSize": "MaxResults" } } }, - "com.amazonaws.backup#ListRestoreJobsInput": { + "com.amazonaws.backup#ListRecoveryPointsByBackupVaultInput": { "type": "structure", "members": { - "NextToken": { + "BackupVaultName": { + "target": "com.amazonaws.backup#BackupVaultName", + "traits": { + "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Amazon Web Services\n Region where they are created. They consist of lowercase letters, numbers, and\n hyphens.

\n \n

Backup vault name might not be available when a supported service creates the\n backup.

\n ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "BackupVaultAccountId": { + "target": "com.amazonaws.backup#AccountId", + "traits": { + "smithy.api#documentation": "

This parameter will sort the list of recovery points by account ID.

", + "smithy.api#httpQuery": "backupVaultAccountId" + } + }, + "NextToken": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is\n made to return maxResults number of items, NextToken allows you\n to return more items in your list starting at the location pointed to by the next\n token.

", + "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is\n made to return MaxResults number of items, NextToken allows you\n to return more items in your list starting at the location pointed to by the next\n token.

", "smithy.api#httpQuery": "nextToken" } }, @@ -8587,46 +8713,46 @@ "smithy.api#httpQuery": "maxResults" } }, - "ByAccountId": { - "target": "com.amazonaws.backup#AccountId", + "ByResourceArn": { + "target": "com.amazonaws.backup#ARN", "traits": { - "smithy.api#documentation": "

The account ID to list the jobs from. Returns only restore jobs associated with the\n specified account ID.

", - "smithy.api#httpQuery": "accountId" + "smithy.api#documentation": "

Returns only recovery points that match the specified resource Amazon Resource Name\n (ARN).

", + "smithy.api#httpQuery": "resourceArn" } }, - "ByCreatedBefore": { - "target": "com.amazonaws.backup#timestamp", + "ByResourceType": { + "target": "com.amazonaws.backup#ResourceType", "traits": { - "smithy.api#documentation": "

Returns only restore jobs that were created before the specified date.

", - "smithy.api#httpQuery": "createdBefore" + "smithy.api#documentation": "

Returns only recovery points that match the specified resource type.

", + "smithy.api#httpQuery": "resourceType" } }, - "ByCreatedAfter": { - "target": "com.amazonaws.backup#timestamp", + "ByBackupPlanId": { + "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

Returns only restore jobs that were created after the specified date.

", - "smithy.api#httpQuery": "createdAfter" + "smithy.api#documentation": "

Returns only recovery points that match the specified backup plan ID.

", + "smithy.api#httpQuery": "backupPlanId" } }, - "ByStatus": { - "target": "com.amazonaws.backup#RestoreJobStatus", + "ByCreatedBefore": { + "target": "com.amazonaws.backup#timestamp", "traits": { - "smithy.api#documentation": "

Returns only restore jobs associated with the specified job status.

", - "smithy.api#httpQuery": "status" + "smithy.api#documentation": "

Returns only recovery points that were created before the specified timestamp.

", + "smithy.api#httpQuery": "createdBefore" } }, - "ByCompleteBefore": { + "ByCreatedAfter": { "target": "com.amazonaws.backup#timestamp", "traits": { - "smithy.api#documentation": "

Returns only copy jobs completed before a date expressed in Unix format and Coordinated\n Universal Time (UTC).

", - "smithy.api#httpQuery": "completeBefore" + "smithy.api#documentation": "

Returns only recovery points that were created after the specified timestamp.

", + "smithy.api#httpQuery": "createdAfter" } }, - "ByCompleteAfter": { - "target": "com.amazonaws.backup#timestamp", + "ByParentRecoveryPointArn": { + "target": "com.amazonaws.backup#ARN", "traits": { - "smithy.api#documentation": "

Returns only copy jobs completed after a date expressed in Unix format and Coordinated\n Universal Time (UTC).

", - "smithy.api#httpQuery": "completeAfter" + "smithy.api#documentation": "

This returns only recovery points that match the specified parent (composite)\n recovery point Amazon Resource Name (ARN).

", + "smithy.api#httpQuery": "parentRecoveryPointArn" } } }, @@ -8634,19 +8760,19 @@ "smithy.api#input": {} } }, - "com.amazonaws.backup#ListRestoreJobsOutput": { + "com.amazonaws.backup#ListRecoveryPointsByBackupVaultOutput": { "type": "structure", "members": { - "RestoreJobs": { - "target": "com.amazonaws.backup#RestoreJobsList", + "NextToken": { + "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

An array of objects that contain detailed information about jobs to restore saved\n resources.

" + "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is\n made to return MaxResults number of items, NextToken allows you\n to return more items in your list starting at the location pointed to by the next\n token.

" } }, - "NextToken": { - "target": "com.amazonaws.backup#string", + "RecoveryPoints": { + "target": "com.amazonaws.backup#RecoveryPointByBackupVaultList", "traits": { - "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is\n made to return maxResults number of items, NextToken allows you\n to return more items in your list starting at the location pointed to by the next\n token.

" + "smithy.api#documentation": "

An array of objects that contain detailed information about recovery points saved in a\n backup vault.

" } } }, @@ -8654,13 +8780,13 @@ "smithy.api#output": {} } }, - "com.amazonaws.backup#ListTags": { + "com.amazonaws.backup#ListRecoveryPointsByLegalHold": { "type": "operation", "input": { - "target": "com.amazonaws.backup#ListTagsInput" + "target": "com.amazonaws.backup#ListRecoveryPointsByLegalHoldInput" }, "output": { - "target": "com.amazonaws.backup#ListTagsOutput" + "target": "com.amazonaws.backup#ListRecoveryPointsByLegalHoldOutput" }, "errors": [ { @@ -8669,35 +8795,33 @@ { "target": "com.amazonaws.backup#MissingParameterValueException" }, - { - "target": "com.amazonaws.backup#ResourceNotFoundException" - }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { - "smithy.api#documentation": "

Returns a list of key-value pairs assigned to a target recovery point, backup plan, or\n backup vault.

\n

\n ListTags only works for resource types that support full Backup\n management of their backups. Those resource types are listed in the \"Full Backup management\" section of the Feature\n availability by resource table.

", + "smithy.api#documentation": "

This action returns recovery point ARNs (Amazon Resource Names) of the \n specified legal hold.

", "smithy.api#http": { "method": "GET", - "uri": "/tags/{ResourceArn}", + "uri": "/legal-holds/{LegalHoldId}/recovery-points", "code": 200 }, "smithy.api#idempotent": {}, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "RecoveryPoints", "pageSize": "MaxResults" } } }, - "com.amazonaws.backup#ListTagsInput": { + "com.amazonaws.backup#ListRecoveryPointsByLegalHoldInput": { "type": "structure", "members": { - "ResourceArn": { - "target": "com.amazonaws.backup#ARN", + "LegalHoldId": { + "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN\n depends on the type of resource. Valid targets for ListTags are recovery\n points, backup plans, and backup vaults.

", + "smithy.api#documentation": "

This is the ID of the legal hold.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -8705,14 +8829,14 @@ "NextToken": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is\n made to return maxResults number of items, NextToken allows you\n to return more items in your list starting at the location pointed to by the next\n token.

", + "smithy.api#documentation": "

This is the next item following a partial list of returned resources. For example, if a request\n is made to return MaxResults number of resources, NextToken\n allows you to return more items in your list starting at the location pointed to by the\n next token.

", "smithy.api#httpQuery": "nextToken" } }, "MaxResults": { "target": "com.amazonaws.backup#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of items to be returned.

", + "smithy.api#documentation": "

This is the maximum number of resource list items to be returned.

", "smithy.api#httpQuery": "maxResults" } } @@ -8721,19 +8845,19 @@ "smithy.api#input": {} } }, - "com.amazonaws.backup#ListTagsOutput": { + "com.amazonaws.backup#ListRecoveryPointsByLegalHoldOutput": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.backup#string", + "RecoveryPoints": { + "target": "com.amazonaws.backup#RecoveryPointsList", "traits": { - "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is\n made to return maxResults number of items, NextToken allows you\n to return more items in your list starting at the location pointed to by the next\n token.

" + "smithy.api#documentation": "

This is a list of the recovery points returned by \n ListRecoveryPointsByLegalHold.

" } }, - "Tags": { - "target": "com.amazonaws.backup#Tags", + "NextToken": { + "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

To help organize your resources, you can assign your own metadata to the resources you\n create. Each tag is a key-value pair.

" + "smithy.api#documentation": "

This return is the next item following a partial list of returned resources.

" } } }, @@ -8741,140 +8865,106 @@ "smithy.api#output": {} } }, - "com.amazonaws.backup#Long": { - "type": "long" - }, - "com.amazonaws.backup#Long2": { - "type": "long", - "traits": { - "smithy.api#default": 0 - } - }, - "com.amazonaws.backup#MaxFrameworkInputs": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 1000 - } - } - }, - "com.amazonaws.backup#MaxResults": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 1000 - } - } - }, - "com.amazonaws.backup#MessageCategory": { - "type": "string" - }, - "com.amazonaws.backup#Metadata": { - "type": "map", - "key": { - "target": "com.amazonaws.backup#MetadataKey" + "com.amazonaws.backup#ListRecoveryPointsByResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.backup#ListRecoveryPointsByResourceInput" }, - "value": { - "target": "com.amazonaws.backup#MetadataValue" + "output": { + "target": "com.amazonaws.backup#ListRecoveryPointsByResourceOutput" }, + "errors": [ + { + "target": "com.amazonaws.backup#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.backup#MissingParameterValueException" + }, + { + "target": "com.amazonaws.backup#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.backup#ServiceUnavailableException" + } + ], "traits": { - "smithy.api#sensitive": {} + "smithy.api#documentation": "

Returns detailed information about all the recovery points of the type specified by a\n resource Amazon Resource Name (ARN).

\n \n

For Amazon EFS and Amazon EC2, this action only lists recovery points\n created by Backup.

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/resources/{ResourceArn}/recovery-points", + "code": 200 + }, + "smithy.api#idempotent": {}, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "RecoveryPoints", + "pageSize": "MaxResults" + } } }, - "com.amazonaws.backup#MetadataKey": { - "type": "string" - }, - "com.amazonaws.backup#MetadataValue": { - "type": "string" - }, - "com.amazonaws.backup#MissingParameterValueException": { + "com.amazonaws.backup#ListRecoveryPointsByResourceInput": { "type": "structure", "members": { - "Code": { - "target": "com.amazonaws.backup#string" - }, - "Message": { - "target": "com.amazonaws.backup#string" + "ResourceArn": { + "target": "com.amazonaws.backup#ARN", + "traits": { + "smithy.api#documentation": "

An ARN that uniquely identifies a resource. The format of the ARN depends on the\n resource type.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } }, - "Type": { + "NextToken": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is\n made to return MaxResults number of items, NextToken allows you\n to return more items in your list starting at the location pointed to by the next\n token.

", + "smithy.api#httpQuery": "nextToken" } }, - "Context": { - "target": "com.amazonaws.backup#string", + "MaxResults": { + "target": "com.amazonaws.backup#MaxResults", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

The maximum number of items to be returned.

\n \n

Amazon RDS requires a value of at least 20.

\n ", + "smithy.api#httpQuery": "maxResults" } } }, "traits": { - "smithy.api#documentation": "

Indicates that a required parameter is missing.

", - "smithy.api#error": "client" + "smithy.api#input": {} } }, - "com.amazonaws.backup#ParameterName": { - "type": "string" - }, - "com.amazonaws.backup#ParameterValue": { - "type": "string" - }, - "com.amazonaws.backup#ProtectedResource": { + "com.amazonaws.backup#ListRecoveryPointsByResourceOutput": { "type": "structure", "members": { - "ResourceArn": { - "target": "com.amazonaws.backup#ARN", - "traits": { - "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN\n depends on the resource type.

" - } - }, - "ResourceType": { - "target": "com.amazonaws.backup#ResourceType", - "traits": { - "smithy.api#documentation": "

The type of Amazon Web Services resource; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. For\n Windows Volume Shadow Copy Service (VSS) backups, the only supported resource type is\n Amazon EC2.

" - } - }, - "LastBackupTime": { - "target": "com.amazonaws.backup#timestamp", + "NextToken": { + "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

The date and time a resource was last backed up, in Unix format and Coordinated\n Universal Time (UTC). The value of LastBackupTime is accurate to milliseconds.\n For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.

" + "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is\n made to return MaxResults number of items, NextToken allows you\n to return more items in your list starting at the location pointed to by the next\n token.

" } }, - "ResourceName": { - "target": "com.amazonaws.backup#string", + "RecoveryPoints": { + "target": "com.amazonaws.backup#RecoveryPointByResourceList", "traits": { - "smithy.api#documentation": "

This is the non-unique name of the resource that \n belongs to the specified backup.

" + "smithy.api#documentation": "

An array of objects that contain detailed information about recovery points of the\n specified resource type.

\n \n

Only Amazon EFS and Amazon EC2 recovery points return\n BackupVaultName.

\n " } } }, "traits": { - "smithy.api#documentation": "

A structure that contains information about a backed-up resource.

" - } - }, - "com.amazonaws.backup#ProtectedResourcesList": { - "type": "list", - "member": { - "target": "com.amazonaws.backup#ProtectedResource" + "smithy.api#output": {} } }, - "com.amazonaws.backup#PutBackupVaultAccessPolicy": { + "com.amazonaws.backup#ListReportJobs": { "type": "operation", "input": { - "target": "com.amazonaws.backup#PutBackupVaultAccessPolicyInput" + "target": "com.amazonaws.backup#ListReportJobsInput" }, "output": { - "target": "smithy.api#Unit" + "target": "com.amazonaws.backup#ListReportJobsOutput" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, - { - "target": "com.amazonaws.backup#MissingParameterValueException" - }, { "target": "com.amazonaws.backup#ResourceNotFoundException" }, @@ -8883,30 +8973,62 @@ } ], "traits": { - "smithy.api#documentation": "

Sets a resource-based policy that is used to manage access permissions on the target\n backup vault. Requires a backup vault name and an access policy document in JSON\n format.

", + "smithy.api#documentation": "

Returns details about your report jobs.

", "smithy.api#http": { - "method": "PUT", - "uri": "/backup-vaults/{BackupVaultName}/access-policy", + "method": "GET", + "uri": "/audit/report-jobs", "code": 200 }, - "smithy.api#idempotent": {} + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } } }, - "com.amazonaws.backup#PutBackupVaultAccessPolicyInput": { + "com.amazonaws.backup#ListReportJobsInput": { "type": "structure", "members": { - "BackupVaultName": { - "target": "com.amazonaws.backup#BackupVaultName", + "ByReportPlanName": { + "target": "com.amazonaws.backup#ReportPlanName", "traits": { - "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Amazon Web Services\n Region where they are created. They consist of lowercase letters, numbers, and\n hyphens.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

Returns only report jobs with the specified report plan name.

", + "smithy.api#httpQuery": "ReportPlanName" } }, - "Policy": { - "target": "com.amazonaws.backup#IAMPolicy", + "ByCreationBefore": { + "target": "com.amazonaws.backup#timestamp", "traits": { - "smithy.api#documentation": "

The backup vault access policy document in JSON format.

" + "smithy.api#documentation": "

Returns only report jobs that were created before the date and time specified in Unix\n format and Coordinated Universal Time (UTC). For example, the value 1516925490 represents\n Friday, January 26, 2018 12:11:30 AM.

", + "smithy.api#httpQuery": "CreationBefore" + } + }, + "ByCreationAfter": { + "target": "com.amazonaws.backup#timestamp", + "traits": { + "smithy.api#documentation": "

Returns only report jobs that were created after the date and time specified in Unix\n format and Coordinated Universal Time (UTC). For example, the value 1516925490 represents\n Friday, January 26, 2018 12:11:30 AM.

", + "smithy.api#httpQuery": "CreationAfter" + } + }, + "ByStatus": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

Returns only report jobs that are in the specified status. The statuses are:

\n

\n CREATED | RUNNING | COMPLETED | FAILED\n

", + "smithy.api#httpQuery": "Status" + } + }, + "MaxResults": { + "target": "com.amazonaws.backup#MaxResults", + "traits": { + "smithy.api#documentation": "

The number of desired results from 1 to 1000. Optional. If unspecified, the query will\n return 1 MB of data.

", + "smithy.api#httpQuery": "MaxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

An identifier that was returned from the previous call to this operation, which can be\n used to return the next set of items in the list.

", + "smithy.api#httpQuery": "NextToken" } } }, @@ -8914,68 +9036,171 @@ "smithy.api#input": {} } }, - "com.amazonaws.backup#PutBackupVaultLockConfiguration": { + "com.amazonaws.backup#ListReportJobsOutput": { + "type": "structure", + "members": { + "ReportJobs": { + "target": "com.amazonaws.backup#ReportJobList", + "traits": { + "smithy.api#documentation": "

Details about your report jobs in JSON format.

" + } + }, + "NextToken": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

An identifier that was returned from the previous call to this operation, which can be\n used to return the next set of items in the list.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.backup#ListReportPlans": { "type": "operation", "input": { - "target": "com.amazonaws.backup#PutBackupVaultLockConfigurationInput" + "target": "com.amazonaws.backup#ListReportPlansInput" }, "output": { - "target": "smithy.api#Unit" + "target": "com.amazonaws.backup#ListReportPlansOutput" }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" }, { - "target": "com.amazonaws.backup#InvalidRequestException" + "target": "com.amazonaws.backup#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of your report plans. For detailed information about a single report\n plan, use DescribeReportPlan.

", + "smithy.api#http": { + "method": "GET", + "uri": "/audit/report-plans", + "code": 200 }, - { - "target": "com.amazonaws.backup#MissingParameterValueException" + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.backup#ListReportPlansInput": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.backup#MaxResults", + "traits": { + "smithy.api#documentation": "

The number of desired results from 1 to 1000. Optional. If unspecified, the query will\n return 1 MB of data.

", + "smithy.api#httpQuery": "MaxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

An identifier that was returned from the previous call to this operation, which can be\n used to return the next set of items in the list.

", + "smithy.api#httpQuery": "NextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.backup#ListReportPlansOutput": { + "type": "structure", + "members": { + "ReportPlans": { + "target": "com.amazonaws.backup#ReportPlanList", + "traits": { + "smithy.api#documentation": "

A list of your report plans with detailed information for each plan. This information\n includes the Amazon Resource Name (ARN), report plan name, description, settings, delivery\n channel, deployment status, creation time, and last times the report plan attempted to and\n successfully ran.

" + } }, + "NextToken": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

An identifier that was returned from the previous call to this operation, which can be\n used to return the next set of items in the list.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.backup#ListRestoreJobSummaries": { + "type": "operation", + "input": { + "target": "com.amazonaws.backup#ListRestoreJobSummariesInput" + }, + "output": { + "target": "com.amazonaws.backup#ListRestoreJobSummariesOutput" + }, + "errors": [ { - "target": "com.amazonaws.backup#ResourceNotFoundException" + "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#ServiceUnavailableException" } ], "traits": { - "smithy.api#documentation": "

Applies Backup Vault Lock to a backup vault, preventing attempts to delete\n any recovery point stored in or created in a backup vault. Vault Lock also prevents\n attempts to update the lifecycle policy that controls the retention period of any recovery\n point currently stored in a backup vault. If specified, Vault Lock enforces a minimum and\n maximum retention period for future backup and copy jobs that target a backup vault.

\n \n

Backup Vault Lock has been assessed by Cohasset Associates for use in environments \n that are subject to SEC 17a-4, CFTC, and FINRA regulations. For more information about \n how Backup Vault Lock relates to these regulations, see the \n Cohasset Associates \n Compliance Assessment.\n

\n ", + "smithy.api#documentation": "

This request obtains a summary of restore jobs created \n or running within the the most recent 30 days. You can \n include parameters AccountID, State, ResourceType, \n AggregationPeriod, MaxResults, or NextToken to filter \n results.

\n

This request returns a summary that contains \n Region, Account, State, RestourceType, MessageCategory, \n StartTime, EndTime, and Count of included jobs.

", "smithy.api#http": { - "method": "PUT", - "uri": "/backup-vaults/{BackupVaultName}/vault-lock", + "method": "GET", + "uri": "/audit/restore-job-summaries", "code": 200 }, - "smithy.api#idempotent": {} + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } } }, - "com.amazonaws.backup#PutBackupVaultLockConfigurationInput": { + "com.amazonaws.backup#ListRestoreJobSummariesInput": { "type": "structure", "members": { - "BackupVaultName": { - "target": "com.amazonaws.backup#BackupVaultName", + "AccountId": { + "target": "com.amazonaws.backup#AccountId", "traits": { - "smithy.api#documentation": "

The Backup Vault Lock configuration that specifies the name of the backup\n vault it protects.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

Returns the job count for the specified account.

\n

If the request is sent from a member account or an account \n not part of Amazon Web Services Organizations, jobs within requestor's account \n will be returned.

\n

Root, admin, and delegated administrator accounts can use \n the value ANY to return job counts from every account in the \n organization.

\n

\n AGGREGATE_ALL aggregates job counts \n from all accounts within the authenticated organization, \n then returns the sum.

", + "smithy.api#httpQuery": "AccountId" } }, - "MinRetentionDays": { - "target": "com.amazonaws.backup#Long", + "State": { + "target": "com.amazonaws.backup#RestoreJobState", "traits": { - "smithy.api#documentation": "

The Backup Vault Lock configuration that specifies the minimum retention\n period that the vault retains its recovery points. This setting can be useful if, for\n example, your organization's policies require you to retain certain data for at least seven\n years (2555 days).

\n

If this parameter is not specified, Vault Lock will not enforce a minimum retention\n period.

\n

If this parameter is specified, any backup or copy job to the vault must have a\n lifecycle policy with a retention period equal to or longer than the minimum retention\n period. If the job's retention period is shorter than that minimum retention period, then\n the vault fails that backup or copy job, and you should either modify your lifecycle\n settings or use a different vault. The shortest minimum retention period\n you can specify is 1 day. Recovery points already saved in the vault prior to\n Vault Lock are not affected.

" + "smithy.api#documentation": "

This parameter returns the job count for jobs \n with the specified state.

\n

The the value ANY returns count of all states.

\n

\n AGGREGATE_ALL aggregates job counts \n for all states and returns the sum.

", + "smithy.api#httpQuery": "State" } }, - "MaxRetentionDays": { - "target": "com.amazonaws.backup#Long", + "ResourceType": { + "target": "com.amazonaws.backup#ResourceType", "traits": { - "smithy.api#documentation": "

The Backup Vault Lock configuration that specifies the maximum retention\n period that the vault retains its recovery points. This setting can be useful if, for\n example, your organization's policies require you to destroy certain data after retaining\n it for four years (1460 days).

\n

If this parameter is not included, Vault Lock does not enforce a maximum retention\n period on the recovery points in the vault. If this parameter is included without a value,\n Vault Lock will not enforce a maximum retention period.

\n

If this parameter is specified, any backup or copy job to the vault must have a\n lifecycle policy with a retention period equal to or shorter than the maximum retention\n period. If the job's retention period is longer than that maximum retention period, then\n the vault fails the backup or copy job, and you should either modify your lifecycle\n settings or use a different vault. The longest maximum retention period\n you can specify is 36500 days (approximately 100 years).\n Recovery points already saved in the vault prior to\n Vault Lock are not affected.

" + "smithy.api#documentation": "

Returns the job count for the specified resource type. \n Use request GetSupportedResourceTypes to obtain \n strings for supported resource types.

\n

The the value ANY returns count of all resource types.

\n

\n AGGREGATE_ALL aggregates job counts \n for all resource types and returns the sum.

\n

The type of Amazon Web Services resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

", + "smithy.api#httpQuery": "ResourceType" } }, - "ChangeableForDays": { - "target": "com.amazonaws.backup#Long", + "AggregationPeriod": { + "target": "com.amazonaws.backup#AggregationPeriod", "traits": { - "smithy.api#documentation": "

The Backup Vault Lock configuration that specifies the number of days before\n the lock date. For example, setting ChangeableForDays to 30 on Jan. 1, 2022 at\n 8pm UTC will set the lock date to Jan. 31, 2022 at 8pm UTC.

\n

Backup enforces a 72-hour cooling-off period before Vault Lock takes effect\n and becomes immutable. Therefore, you must set ChangeableForDays to 3 or\n greater.

\n

Before the lock date, you can delete Vault Lock from the vault using\n DeleteBackupVaultLockConfiguration or change the Vault Lock configuration\n using PutBackupVaultLockConfiguration. On and after the lock date, the Vault\n Lock becomes immutable and cannot be changed or deleted.

\n

If this parameter is not specified, you can delete Vault Lock from the vault using\n DeleteBackupVaultLockConfiguration or change the Vault Lock configuration\n using PutBackupVaultLockConfiguration at any time.

" + "smithy.api#documentation": "

This is the period that sets the boundaries for returned \n results.

\n

Acceptable values include

\n ", + "smithy.api#httpQuery": "AggregationPeriod" + } + }, + "MaxResults": { + "target": "com.amazonaws.backup#MaxResults", + "traits": { + "smithy.api#documentation": "

This parameter sets the maximum number of items \n to be returned.

\n

The value is an integer. Range of accepted values is from \n 1 to 500.

", + "smithy.api#httpQuery": "MaxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

The next item following a partial list of returned resources. For example, if a request\n is made to return MaxResults number of resources, NextToken\n allows you to return more items in your list starting at the location pointed to by the\n next token.

", + "smithy.api#httpQuery": "NextToken" } } }, @@ -8983,13 +9208,39 @@ "smithy.api#input": {} } }, - "com.amazonaws.backup#PutBackupVaultNotifications": { + "com.amazonaws.backup#ListRestoreJobSummariesOutput": { + "type": "structure", + "members": { + "RestoreJobSummaries": { + "target": "com.amazonaws.backup#RestoreJobSummaryList", + "traits": { + "smithy.api#documentation": "

This return contains a summary that contains \n Region, Account, State, ResourceType, MessageCategory, \n StartTime, EndTime, and Count of included jobs.

" + } + }, + "AggregationPeriod": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

This is the period that sets the boundaries for returned \n results.

\n " + } + }, + "NextToken": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

The next item following a partial list of returned resources. For example, if a request\n is made to return MaxResults number of resources, NextToken\n allows you to return more items in your list starting at the location pointed to by the\n next token.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.backup#ListRestoreJobs": { "type": "operation", "input": { - "target": "com.amazonaws.backup#PutBackupVaultNotificationsInput" + "target": "com.amazonaws.backup#ListRestoreJobsInput" }, "output": { - "target": "smithy.api#Unit" + "target": "com.amazonaws.backup#ListRestoreJobsOutput" }, "errors": [ { @@ -9006,952 +9257,2423 @@ } ], "traits": { - "smithy.api#documentation": "

Turns on notifications on a backup vault for the specified topic and events.

", + "smithy.api#documentation": "

Returns a list of jobs that Backup initiated to restore a saved resource,\n including details about the recovery process.

", "smithy.api#http": { - "method": "PUT", - "uri": "/backup-vaults/{BackupVaultName}/notification-configuration", + "method": "GET", + "uri": "/restore-jobs", "code": 200 }, + "smithy.api#idempotent": {}, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "RestoreJobs", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.backup#ListRestoreJobsByProtectedResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.backup#ListRestoreJobsByProtectedResourceInput" + }, + "output": { + "target": "com.amazonaws.backup#ListRestoreJobsByProtectedResourceOutput" + }, + "errors": [ + { + "target": "com.amazonaws.backup#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.backup#MissingParameterValueException" + }, + { + "target": "com.amazonaws.backup#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.backup#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

This returns restore jobs that contain the specified protected resource.

\n

You must include ResourceArn. You can optionally include\n NextToken, ByStatus, MaxResults,\n ByRecoveryPointCreationDateAfter , and\n ByRecoveryPointCreationDateBefore.

", + "smithy.api#http": { + "method": "GET", + "uri": "/resources/{ResourceArn}/restore-jobs", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "RestoreJobs", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.backup#ListRestoreJobsByProtectedResourceInput": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.backup#ARN", + "traits": { + "smithy.api#documentation": "

Returns only restore jobs that match the specified resource \n Amazon Resource Name (ARN).

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ByStatus": { + "target": "com.amazonaws.backup#RestoreJobStatus", + "traits": { + "smithy.api#documentation": "

Returns only restore jobs associated with the specified job status.

", + "smithy.api#httpQuery": "status" + } + }, + "ByRecoveryPointCreationDateAfter": { + "target": "com.amazonaws.backup#timestamp", + "traits": { + "smithy.api#documentation": "

Returns only restore jobs of recovery points that were created after the specified date.

", + "smithy.api#httpQuery": "recoveryPointCreationDateAfter" + } + }, + "ByRecoveryPointCreationDateBefore": { + "target": "com.amazonaws.backup#timestamp", + "traits": { + "smithy.api#documentation": "

Returns only restore jobs of recovery points that were created before the specified date.

", + "smithy.api#httpQuery": "recoveryPointCreationDateBefore" + } + }, + "NextToken": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

The next item following a partial list of returned items. For example, \n if a request ismade to return MaxResults number of items, \n NextToken allows you to return more items in your list \n starting at the location pointed to by the next token.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.backup#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of items to be returned.

", + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.backup#ListRestoreJobsByProtectedResourceOutput": { + "type": "structure", + "members": { + "RestoreJobs": { + "target": "com.amazonaws.backup#RestoreJobsList", + "traits": { + "smithy.api#documentation": "

An array of objects that contain detailed information about \n jobs to restore saved resources.>

" + } + }, + "NextToken": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

The next item following a partial list of returned items. For example, \n if a request is made to return MaxResults number of items, \n NextToken allows youto return more items in your list starting \n at the location pointed to by the next token

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.backup#ListRestoreJobsInput": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is\n made to return MaxResults number of items, NextToken allows you\n to return more items in your list starting at the location pointed to by the next\n token.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.backup#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of items to be returned.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "ByAccountId": { + "target": "com.amazonaws.backup#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID to list the jobs from. Returns only restore jobs associated with the\n specified account ID.

", + "smithy.api#httpQuery": "accountId" + } + }, + "ByCreatedBefore": { + "target": "com.amazonaws.backup#timestamp", + "traits": { + "smithy.api#documentation": "

Returns only restore jobs that were created before the specified date.

", + "smithy.api#httpQuery": "createdBefore" + } + }, + "ByCreatedAfter": { + "target": "com.amazonaws.backup#timestamp", + "traits": { + "smithy.api#documentation": "

Returns only restore jobs that were created after the specified date.

", + "smithy.api#httpQuery": "createdAfter" + } + }, + "ByStatus": { + "target": "com.amazonaws.backup#RestoreJobStatus", + "traits": { + "smithy.api#documentation": "

Returns only restore jobs associated with the specified job status.

", + "smithy.api#httpQuery": "status" + } + }, + "ByCompleteBefore": { + "target": "com.amazonaws.backup#timestamp", + "traits": { + "smithy.api#documentation": "

Returns only copy jobs completed before a date expressed in Unix format and Coordinated\n Universal Time (UTC).

", + "smithy.api#httpQuery": "completeBefore" + } + }, + "ByCompleteAfter": { + "target": "com.amazonaws.backup#timestamp", + "traits": { + "smithy.api#documentation": "

Returns only copy jobs completed after a date expressed in Unix format and Coordinated\n Universal Time (UTC).

", + "smithy.api#httpQuery": "completeAfter" + } + }, + "ByRestoreTestingPlanArn": { + "target": "com.amazonaws.backup#ARN", + "traits": { + "smithy.api#documentation": "

This returns only restore testing jobs that match the \n specified resource Amazon Resource Name (ARN).

", + "smithy.api#httpQuery": "restoreTestingPlanArn" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.backup#ListRestoreJobsOutput": { + "type": "structure", + "members": { + "RestoreJobs": { + "target": "com.amazonaws.backup#RestoreJobsList", + "traits": { + "smithy.api#documentation": "

An array of objects that contain detailed information about jobs to restore saved\n resources.

" + } + }, + "NextToken": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is\n made to return MaxResults number of items, NextToken allows you\n to return more items in your list starting at the location pointed to by the next\n token.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.backup#ListRestoreTestingPlans": { + "type": "operation", + "input": { + "target": "com.amazonaws.backup#ListRestoreTestingPlansInput" + }, + "output": { + "target": "com.amazonaws.backup#ListRestoreTestingPlansOutput" + }, + "errors": [ + { + "target": "com.amazonaws.backup#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.backup#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of restore testing plans.

", + "smithy.api#http": { + "method": "GET", + "uri": "/restore-testing/plans", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "RestoreTestingPlans", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.backup#ListRestoreTestingPlansInput": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.backup#ListRestoreTestingPlansInputMaxResultsInteger", + "traits": { + "smithy.api#documentation": "

The maximum number of items to be returned.

", + "smithy.api#httpQuery": "MaxResults" + } + }, + "NextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The next item following a partial list of returned items. \n For example, if a request is made to return MaxResults \n number of items, NextToken allows you to return more items \n in your list starting at the location pointed to by the nexttoken.

", + "smithy.api#httpQuery": "NextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.backup#ListRestoreTestingPlansInputMaxResultsInteger": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.backup#ListRestoreTestingPlansOutput": { + "type": "structure", + "members": { + "NextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The next item following a partial list of returned items. \n For example, if a request is made to return MaxResults \n number of items, NextToken allows you to return more items \n in your list starting at the location pointed to by the nexttoken.

" + } + }, + "RestoreTestingPlans": { + "target": "com.amazonaws.backup#RestoreTestingPlans", + "traits": { + "smithy.api#documentation": "

This is a returned list of restore testing plans.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.backup#ListRestoreTestingSelections": { + "type": "operation", + "input": { + "target": "com.amazonaws.backup#ListRestoreTestingSelectionsInput" + }, + "output": { + "target": "com.amazonaws.backup#ListRestoreTestingSelectionsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.backup#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.backup#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.backup#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of restore testing selections. Can be filtered \n by MaxResults and RestoreTestingPlanName.

", + "smithy.api#http": { + "method": "GET", + "uri": "/restore-testing/plans/{RestoreTestingPlanName}/selections", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "RestoreTestingSelections", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.backup#ListRestoreTestingSelectionsInput": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.backup#ListRestoreTestingSelectionsInputMaxResultsInteger", + "traits": { + "smithy.api#documentation": "

The maximum number of items to be returned.

", + "smithy.api#httpQuery": "MaxResults" + } + }, + "NextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The next item following a partial list of returned items. \n For example, if a request is made to return MaxResults \n number of items, NextToken allows you to return more items \n in your list starting at the location pointed to by the nexttoken.

", + "smithy.api#httpQuery": "NextToken" + } + }, + "RestoreTestingPlanName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

Returns restore testing selections by the specified restore testing \n plan name.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.backup#ListRestoreTestingSelectionsInputMaxResultsInteger": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.backup#ListRestoreTestingSelectionsOutput": { + "type": "structure", + "members": { + "NextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The next item following a partial list of returned items. For example, \n if a request is made to return MaxResults number of items, \n NextToken allows you to return more items in your list \n starting at the location pointed to by the nexttoken.

" + } + }, + "RestoreTestingSelections": { + "target": "com.amazonaws.backup#RestoreTestingSelections", + "traits": { + "smithy.api#documentation": "

The returned restore testing selections associated with the \n restore testing plan.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.backup#ListTags": { + "type": "operation", + "input": { + "target": "com.amazonaws.backup#ListTagsInput" + }, + "output": { + "target": "com.amazonaws.backup#ListTagsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.backup#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.backup#MissingParameterValueException" + }, + { + "target": "com.amazonaws.backup#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.backup#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of key-value pairs assigned to a target recovery point, backup plan, or\n backup vault.

\n

\n ListTags only works for resource types that support full Backup\n management of their backups. Those resource types are listed in the \"Full Backup management\" section of the Feature\n availability by resource table.

", + "smithy.api#http": { + "method": "GET", + "uri": "/tags/{ResourceArn}", + "code": 200 + }, + "smithy.api#idempotent": {}, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.backup#ListTagsInput": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.backup#ARN", + "traits": { + "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN\n depends on the type of resource. Valid targets for ListTags are recovery\n points, backup plans, and backup vaults.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is\n made to return MaxResults number of items, NextToken allows you\n to return more items in your list starting at the location pointed to by the next\n token.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.backup#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of items to be returned.

", + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.backup#ListTagsOutput": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

The next item following a partial list of returned items. For example, if a request is\n made to return MaxResults number of items, NextToken allows you\n to return more items in your list starting at the location pointed to by the next\n token.

" + } + }, + "Tags": { + "target": "com.amazonaws.backup#Tags", + "traits": { + "smithy.api#documentation": "

To help organize your resources, you can assign your own metadata to the resources you\n create. Each tag is a key-value pair.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.backup#Long": { + "type": "long" + }, + "com.amazonaws.backup#Long2": { + "type": "long", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.backup#MaxFrameworkInputs": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.backup#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.backup#MessageCategory": { + "type": "string" + }, + "com.amazonaws.backup#Metadata": { + "type": "map", + "key": { + "target": "com.amazonaws.backup#MetadataKey" + }, + "value": { + "target": "com.amazonaws.backup#MetadataValue" + }, + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.backup#MetadataKey": { + "type": "string" + }, + "com.amazonaws.backup#MetadataValue": { + "type": "string" + }, + "com.amazonaws.backup#MissingParameterValueException": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.backup#string" + }, + "Message": { + "target": "com.amazonaws.backup#string" + }, + "Type": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

" + } + }, + "Context": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Indicates that a required parameter is missing.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.backup#ParameterName": { + "type": "string" + }, + "com.amazonaws.backup#ParameterValue": { + "type": "string" + }, + "com.amazonaws.backup#ProtectedResource": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.backup#ARN", + "traits": { + "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN\n depends on the resource type.

" + } + }, + "ResourceType": { + "target": "com.amazonaws.backup#ResourceType", + "traits": { + "smithy.api#documentation": "

The type of Amazon Web Services resource; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. For\n Windows Volume Shadow Copy Service (VSS) backups, the only supported resource type is\n Amazon EC2.

" + } + }, + "LastBackupTime": { + "target": "com.amazonaws.backup#timestamp", + "traits": { + "smithy.api#documentation": "

The date and time a resource was last backed up, in Unix format and Coordinated\n Universal Time (UTC). The value of LastBackupTime is accurate to milliseconds.\n For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.

" + } + }, + "ResourceName": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

This is the non-unique name of the resource that \n belongs to the specified backup.

" + } + }, + "LastBackupVaultArn": { + "target": "com.amazonaws.backup#ARN", + "traits": { + "smithy.api#documentation": "

This is the ARN (Amazon Resource Name) of the backup vault \n that contains the most recent backup recovery point.

" + } + }, + "LastRecoveryPointArn": { + "target": "com.amazonaws.backup#ARN", + "traits": { + "smithy.api#documentation": "

This is the ARN (Amazon Resource Name) of the most \n recent recovery point.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that contains information about a backed-up resource.

" + } + }, + "com.amazonaws.backup#ProtectedResourceConditions": { + "type": "structure", + "members": { + "StringEquals": { + "target": "com.amazonaws.backup#KeyValueList", + "traits": { + "smithy.api#documentation": "

Filters the values of your tagged resources for only \n those resources that you tagged with the same value. \n Also called \"exact matching.\"

" + } + }, + "StringNotEquals": { + "target": "com.amazonaws.backup#KeyValueList", + "traits": { + "smithy.api#documentation": "

Filters the values of your tagged resources for only \n those resources that you tagged that do not have the same value. \n Also called \"negated matching.\"

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A list of conditions that you define for resources in \n your restore testing plan using tags.

\n

For example, \n \"StringEquals\": { \"Key\": \"aws:ResourceTag/CreatedByCryo\", \"Value\": \"true\" },. \n Condition operators are case sensitive.

" + } + }, + "com.amazonaws.backup#ProtectedResourcesList": { + "type": "list", + "member": { + "target": "com.amazonaws.backup#ProtectedResource" + } + }, + "com.amazonaws.backup#PutBackupVaultAccessPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.backup#PutBackupVaultAccessPolicyInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.backup#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.backup#MissingParameterValueException" + }, + { + "target": "com.amazonaws.backup#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.backup#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Sets a resource-based policy that is used to manage access permissions on the target\n backup vault. Requires a backup vault name and an access policy document in JSON\n format.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/backup-vaults/{BackupVaultName}/access-policy", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.backup#PutBackupVaultAccessPolicyInput": { + "type": "structure", + "members": { + "BackupVaultName": { + "target": "com.amazonaws.backup#BackupVaultName", + "traits": { + "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Amazon Web Services\n Region where they are created. They consist of lowercase letters, numbers, and\n hyphens.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Policy": { + "target": "com.amazonaws.backup#IAMPolicy", + "traits": { + "smithy.api#documentation": "

The backup vault access policy document in JSON format.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.backup#PutBackupVaultLockConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.backup#PutBackupVaultLockConfigurationInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.backup#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.backup#InvalidRequestException" + }, + { + "target": "com.amazonaws.backup#MissingParameterValueException" + }, + { + "target": "com.amazonaws.backup#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.backup#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Applies Backup Vault Lock to a backup vault, preventing attempts to delete\n any recovery point stored in or created in a backup vault. Vault Lock also prevents\n attempts to update the lifecycle policy that controls the retention period of any recovery\n point currently stored in a backup vault. If specified, Vault Lock enforces a minimum and\n maximum retention period for future backup and copy jobs that target a backup vault.

\n \n

Backup Vault Lock has been assessed by Cohasset Associates for use in environments \n that are subject to SEC 17a-4, CFTC, and FINRA regulations. For more information about \n how Backup Vault Lock relates to these regulations, see the \n Cohasset Associates \n Compliance Assessment.\n

\n ", + "smithy.api#http": { + "method": "PUT", + "uri": "/backup-vaults/{BackupVaultName}/vault-lock", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.backup#PutBackupVaultLockConfigurationInput": { + "type": "structure", + "members": { + "BackupVaultName": { + "target": "com.amazonaws.backup#BackupVaultName", + "traits": { + "smithy.api#documentation": "

The Backup Vault Lock configuration that specifies the name of the backup\n vault it protects.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "MinRetentionDays": { + "target": "com.amazonaws.backup#Long", + "traits": { + "smithy.api#documentation": "

The Backup Vault Lock configuration that specifies the minimum retention\n period that the vault retains its recovery points. This setting can be useful if, for\n example, your organization's policies require you to retain certain data for at least seven\n years (2555 days).

\n

If this parameter is not specified, Vault Lock will not enforce a minimum retention\n period.

\n

If this parameter is specified, any backup or copy job to the vault must have a\n lifecycle policy with a retention period equal to or longer than the minimum retention\n period. If the job's retention period is shorter than that minimum retention period, then\n the vault fails that backup or copy job, and you should either modify your lifecycle\n settings or use a different vault. The shortest minimum retention period\n you can specify is 1 day. Recovery points already saved in the vault prior to\n Vault Lock are not affected.

" + } + }, + "MaxRetentionDays": { + "target": "com.amazonaws.backup#Long", + "traits": { + "smithy.api#documentation": "

The Backup Vault Lock configuration that specifies the maximum retention\n period that the vault retains its recovery points. This setting can be useful if, for\n example, your organization's policies require you to destroy certain data after retaining\n it for four years (1460 days).

\n

If this parameter is not included, Vault Lock does not enforce a maximum retention\n period on the recovery points in the vault. If this parameter is included without a value,\n Vault Lock will not enforce a maximum retention period.

\n

If this parameter is specified, any backup or copy job to the vault must have a\n lifecycle policy with a retention period equal to or shorter than the maximum retention\n period. If the job's retention period is longer than that maximum retention period, then\n the vault fails the backup or copy job, and you should either modify your lifecycle\n settings or use a different vault. The longest maximum retention period\n you can specify is 36500 days (approximately 100 years).\n Recovery points already saved in the vault prior to\n Vault Lock are not affected.

" + } + }, + "ChangeableForDays": { + "target": "com.amazonaws.backup#Long", + "traits": { + "smithy.api#documentation": "

The Backup Vault Lock configuration that specifies the number of days before\n the lock date. For example, setting ChangeableForDays to 30 on Jan. 1, 2022 at\n 8pm UTC will set the lock date to Jan. 31, 2022 at 8pm UTC.

\n

Backup enforces a 72-hour cooling-off period before Vault Lock takes effect\n and becomes immutable. Therefore, you must set ChangeableForDays to 3 or\n greater.

\n

Before the lock date, you can delete Vault Lock from the vault using\n DeleteBackupVaultLockConfiguration or change the Vault Lock configuration\n using PutBackupVaultLockConfiguration. On and after the lock date, the Vault\n Lock becomes immutable and cannot be changed or deleted.

\n

If this parameter is not specified, you can delete Vault Lock from the vault using\n DeleteBackupVaultLockConfiguration or change the Vault Lock configuration\n using PutBackupVaultLockConfiguration at any time.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.backup#PutBackupVaultNotifications": { + "type": "operation", + "input": { + "target": "com.amazonaws.backup#PutBackupVaultNotificationsInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.backup#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.backup#MissingParameterValueException" + }, + { + "target": "com.amazonaws.backup#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.backup#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Turns on notifications on a backup vault for the specified topic and events.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/backup-vaults/{BackupVaultName}/notification-configuration", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.backup#PutBackupVaultNotificationsInput": { + "type": "structure", + "members": { + "BackupVaultName": { + "target": "com.amazonaws.backup#BackupVaultName", + "traits": { + "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Amazon Web Services\n Region where they are created. They consist of lowercase letters, numbers, and\n hyphens.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "SNSTopicArn": { + "target": "com.amazonaws.backup#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that specifies the topic for a backup vault’s events; for\n example, arn:aws:sns:us-west-2:111122223333:MyVaultTopic.

", + "smithy.api#required": {} + } + }, + "BackupVaultEvents": { + "target": "com.amazonaws.backup#BackupVaultEvents", + "traits": { + "smithy.api#documentation": "

An array of events that indicate the status of jobs to back up resources to the backup\n vault.

\n

For common use cases and code samples, see Using Amazon SNS to\n track Backup events.

\n

The following events are supported:

\n \n \n

The list below shows items that are deprecated events (for reference) and are no longer \n in use. They are no longer supported and will not return statuses or notifications. \n Refer to the list above for current supported events.

\n ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.backup#PutRestoreValidationResult": { + "type": "operation", + "input": { + "target": "com.amazonaws.backup#PutRestoreValidationResultInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.backup#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.backup#InvalidRequestException" + }, + { + "target": "com.amazonaws.backup#MissingParameterValueException" + }, + { + "target": "com.amazonaws.backup#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.backup#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

This request allows you to send your independent self-run \n restore test validation results. \n RestoreJobId and ValidationStatus \n are required. Optionally, you can input a \n ValidationStatusMessage.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/restore-jobs/{RestoreJobId}/validations", + "code": 204 + }, "smithy.api#idempotent": {} } }, - "com.amazonaws.backup#PutBackupVaultNotificationsInput": { - "type": "structure", + "com.amazonaws.backup#PutRestoreValidationResultInput": { + "type": "structure", + "members": { + "RestoreJobId": { + "target": "com.amazonaws.backup#RestoreJobId", + "traits": { + "smithy.api#documentation": "

This is a unique identifier of a restore job within Backup.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ValidationStatus": { + "target": "com.amazonaws.backup#RestoreValidationStatus", + "traits": { + "smithy.api#documentation": "

This is the status of your restore validation.

", + "smithy.api#required": {} + } + }, + "ValidationStatusMessage": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

This is an optional message string you can input to \n describe the validation status for the restore test validation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.backup#RecoveryPointByBackupVault": { + "type": "structure", + "members": { + "RecoveryPointArn": { + "target": "com.amazonaws.backup#ARN", + "traits": { + "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example,\n arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

" + } + }, + "BackupVaultName": { + "target": "com.amazonaws.backup#BackupVaultName", + "traits": { + "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Amazon Web Services\n Region where they are created. They consist of lowercase letters, numbers, and\n hyphens.

" + } + }, + "BackupVaultArn": { + "target": "com.amazonaws.backup#ARN", + "traits": { + "smithy.api#documentation": "

An ARN that uniquely identifies a backup vault; for example,\n arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

" + } + }, + "SourceBackupVaultArn": { + "target": "com.amazonaws.backup#ARN", + "traits": { + "smithy.api#documentation": "

The backup vault where the recovery point was originally copied from. If the recovery\n point is restored to the same account this value will be null.

" + } + }, + "ResourceArn": { + "target": "com.amazonaws.backup#ARN", + "traits": { + "smithy.api#documentation": "

An ARN that uniquely identifies a resource. The format of the ARN depends on the\n resource type.

" + } + }, + "ResourceType": { + "target": "com.amazonaws.backup#ResourceType", + "traits": { + "smithy.api#documentation": "

The type of Amazon Web Services resource saved as a recovery point; for example, an\n Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. For Windows Volume Shadow Copy Service (VSS) backups, the only\n supported resource type is Amazon EC2.

" + } + }, + "CreatedBy": { + "target": "com.amazonaws.backup#RecoveryPointCreator", + "traits": { + "smithy.api#documentation": "

Contains identifying information about the creation of a recovery point, including the\n BackupPlanArn, BackupPlanId, BackupPlanVersion,\n and BackupRuleId of the backup plan that is used to create it.

" + } + }, + "IamRoleArn": { + "target": "com.amazonaws.backup#IAMRoleArn", + "traits": { + "smithy.api#documentation": "

Specifies the IAM role ARN used to create the target recovery point; for example,\n arn:aws:iam::123456789012:role/S3Access.

" + } + }, + "Status": { + "target": "com.amazonaws.backup#RecoveryPointStatus", + "traits": { + "smithy.api#documentation": "

A status code specifying the state of the recovery point.

" + } + }, + "StatusMessage": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

A message explaining the reason of the recovery point deletion failure.

" + } + }, + "CreationDate": { + "target": "com.amazonaws.backup#timestamp", + "traits": { + "smithy.api#documentation": "

The date and time a recovery point is created, in Unix format and Coordinated Universal\n Time (UTC). The value of CreationDate is accurate to milliseconds. For\n example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.

" + } + }, + "CompletionDate": { + "target": "com.amazonaws.backup#timestamp", + "traits": { + "smithy.api#documentation": "

The date and time a job to restore a recovery point is completed, in Unix format and\n Coordinated Universal Time (UTC). The value of CompletionDate is accurate to\n milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018\n 12:11:30.087 AM.

" + } + }, + "BackupSizeInBytes": { + "target": "com.amazonaws.backup#Long", + "traits": { + "smithy.api#documentation": "

The size, in bytes, of a backup.

" + } + }, + "CalculatedLifecycle": { + "target": "com.amazonaws.backup#CalculatedLifecycle", + "traits": { + "smithy.api#documentation": "

A CalculatedLifecycle object containing DeleteAt and\n MoveToColdStorageAt timestamps.

" + } + }, + "Lifecycle": { + "target": "com.amazonaws.backup#Lifecycle", + "traits": { + "smithy.api#documentation": "

The lifecycle defines when a protected resource is transitioned to cold storage and when\n it expires. Backup transitions and expires backups automatically according to\n the lifecycle that you define.

\n

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90\n days. Therefore, the “retention” setting must be 90 days greater than the “transition to\n cold after days” setting. The “transition to cold after days” setting cannot be changed\n after a backup has been transitioned to cold.

\n

Resource types that are able to be transitioned to cold storage are listed in the \"Lifecycle to cold storage\" \n section of the \n Feature availability by resource table. Backup ignores this expression for\n other resource types.

" + } + }, + "EncryptionKeyArn": { + "target": "com.amazonaws.backup#ARN", + "traits": { + "smithy.api#documentation": "

The server-side encryption key that is used to protect your backups; for example,\n arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.

" + } + }, + "IsEncrypted": { + "target": "com.amazonaws.backup#Boolean2", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A Boolean value that is returned as TRUE if the specified recovery point is\n encrypted, or FALSE if the recovery point is not encrypted.

" + } + }, + "LastRestoreTime": { + "target": "com.amazonaws.backup#timestamp", + "traits": { + "smithy.api#documentation": "

The date and time a recovery point was last restored, in Unix format and Coordinated\n Universal Time (UTC). The value of LastRestoreTime is accurate to\n milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018\n 12:11:30.087 AM.

" + } + }, + "ParentRecoveryPointArn": { + "target": "com.amazonaws.backup#ARN", + "traits": { + "smithy.api#documentation": "

This is the Amazon Resource Name (ARN) of the parent (composite) \n recovery point.

" + } + }, + "CompositeMemberIdentifier": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

This is the identifier of a resource within a composite group, such as \n nested (child) recovery point belonging to a composite (parent) stack. The \n ID is transferred from \n the \n logical ID within a stack.

" + } + }, + "IsParent": { + "target": "com.amazonaws.backup#Boolean2", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

This is a boolean value indicating this is \n a parent (composite) recovery point.

" + } + }, + "ResourceName": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

This is the non-unique name of the resource that \n belongs to the specified backup.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains detailed information about the recovery points stored in a backup vault.

" + } + }, + "com.amazonaws.backup#RecoveryPointByBackupVaultList": { + "type": "list", + "member": { + "target": "com.amazonaws.backup#RecoveryPointByBackupVault" + } + }, + "com.amazonaws.backup#RecoveryPointByResource": { + "type": "structure", + "members": { + "RecoveryPointArn": { + "target": "com.amazonaws.backup#ARN", + "traits": { + "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example,\n arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

" + } + }, + "CreationDate": { + "target": "com.amazonaws.backup#timestamp", + "traits": { + "smithy.api#documentation": "

The date and time a recovery point is created, in Unix format and Coordinated Universal\n Time (UTC). The value of CreationDate is accurate to milliseconds. For\n example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.

" + } + }, + "Status": { + "target": "com.amazonaws.backup#RecoveryPointStatus", + "traits": { + "smithy.api#documentation": "

A status code specifying the state of the recovery point.

" + } + }, + "StatusMessage": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

A message explaining the reason of the recovery point deletion failure.

" + } + }, + "EncryptionKeyArn": { + "target": "com.amazonaws.backup#ARN", + "traits": { + "smithy.api#documentation": "

The server-side encryption key that is used to protect your backups; for example,\n arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.

" + } + }, + "BackupSizeBytes": { + "target": "com.amazonaws.backup#Long", + "traits": { + "smithy.api#documentation": "

The size, in bytes, of a backup.

" + } + }, + "BackupVaultName": { + "target": "com.amazonaws.backup#BackupVaultName", + "traits": { + "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Amazon Web Services\n Region where they are created. They consist of lowercase letters, numbers, and\n hyphens.

" + } + }, + "IsParent": { + "target": "com.amazonaws.backup#Boolean2", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

This is a boolean value indicating this is \n a parent (composite) recovery point.

" + } + }, + "ParentRecoveryPointArn": { + "target": "com.amazonaws.backup#ARN", + "traits": { + "smithy.api#documentation": "

This is the Amazon Resource Name (ARN) of the parent (composite) \n recovery point.

" + } + }, + "ResourceName": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

This is the non-unique name of the resource that \n belongs to the specified backup.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains detailed information about a saved recovery point.

" + } + }, + "com.amazonaws.backup#RecoveryPointByResourceList": { + "type": "list", + "member": { + "target": "com.amazonaws.backup#RecoveryPointByResource" + } + }, + "com.amazonaws.backup#RecoveryPointCreator": { + "type": "structure", + "members": { + "BackupPlanId": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

Uniquely identifies a backup plan.

" + } + }, + "BackupPlanArn": { + "target": "com.amazonaws.backup#ARN", + "traits": { + "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example,\n arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.

" + } + }, + "BackupPlanVersion": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

Version IDs are unique, randomly generated, Unicode, UTF-8 encoded strings that are at\n most 1,024 bytes long. They cannot be edited.

" + } + }, + "BackupRuleId": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

Uniquely identifies a rule used to schedule the backup of a selection of\n resources.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about the backup plan and rule that Backup used to\n initiate the recovery point backup.

" + } + }, + "com.amazonaws.backup#RecoveryPointMember": { + "type": "structure", + "members": { + "RecoveryPointArn": { + "target": "com.amazonaws.backup#ARN", + "traits": { + "smithy.api#documentation": "

This is the Amazon Resource Name (ARN) of the parent (composite) \n recovery point.

" + } + }, + "ResourceArn": { + "target": "com.amazonaws.backup#ARN", + "traits": { + "smithy.api#documentation": "

This is the Amazon Resource Name (ARN) that uniquely identifies \n a saved resource.

" + } + }, + "ResourceType": { + "target": "com.amazonaws.backup#ResourceType", + "traits": { + "smithy.api#documentation": "

This is the Amazon Web Services resource type that is saved as \n a recovery point.

" + } + }, + "BackupVaultName": { + "target": "com.amazonaws.backup#BackupVaultName", + "traits": { + "smithy.api#documentation": "

This is the name of the backup vault \n (the logical container in which backups are stored).

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This is a recovery point which is a child (nested) recovery point \n of a parent (composite) recovery point. These recovery points \n can be disassociated from their parent (composite) recovery \n point, in which case they will no longer be a member.

" + } + }, + "com.amazonaws.backup#RecoveryPointSelection": { + "type": "structure", + "members": { + "VaultNames": { + "target": "com.amazonaws.backup#VaultNames", + "traits": { + "smithy.api#documentation": "

These are the names of the vaults in which the selected \n recovery points are contained.

" + } + }, + "ResourceIdentifiers": { + "target": "com.amazonaws.backup#ResourceIdentifiers", + "traits": { + "smithy.api#documentation": "

These are the resources included in the resource selection \n (including type of resources and vaults).

" + } + }, + "DateRange": { + "target": "com.amazonaws.backup#DateRange" + } + }, + "traits": { + "smithy.api#documentation": "

This specifies criteria to assign \n a set of resources, such as resource types or backup vaults.

" + } + }, + "com.amazonaws.backup#RecoveryPointStatus": { + "type": "enum", + "members": { + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" + } + }, + "PARTIAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PARTIAL" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "EXPIRED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXPIRED" + } + } + } + }, + "com.amazonaws.backup#RecoveryPointsList": { + "type": "list", + "member": { + "target": "com.amazonaws.backup#RecoveryPointMember" + } + }, + "com.amazonaws.backup#Region": { + "type": "string" + }, + "com.amazonaws.backup#ReportDeliveryChannel": { + "type": "structure", + "members": { + "S3BucketName": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

The unique name of the S3 bucket that receives your reports.

", + "smithy.api#required": {} + } + }, + "S3KeyPrefix": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

The prefix for where Backup Audit Manager delivers your reports to Amazon S3. The prefix is this part of the following path:\n s3://your-bucket-name/prefix/Backup/us-west-2/year/month/day/report-name.\n If not specified, there is no prefix.

" + } + }, + "Formats": { + "target": "com.amazonaws.backup#FormatList", + "traits": { + "smithy.api#documentation": "

A list of the format of your reports: CSV, JSON, or both. If\n not specified, the default format is CSV.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information from your report plan about where to deliver your reports,\n specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your\n reports.

" + } + }, + "com.amazonaws.backup#ReportDestination": { + "type": "structure", + "members": { + "S3BucketName": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

The unique name of the Amazon S3 bucket that receives your reports.

" + } + }, + "S3Keys": { + "target": "com.amazonaws.backup#stringList", + "traits": { + "smithy.api#documentation": "

The object key that uniquely identifies your reports in your S3 bucket.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information from your report job about your report destination.

" + } + }, + "com.amazonaws.backup#ReportJob": { + "type": "structure", + "members": { + "ReportJobId": { + "target": "com.amazonaws.backup#ReportJobId", + "traits": { + "smithy.api#documentation": "

The identifier for a report job. A unique, randomly generated, Unicode, UTF-8 encoded\n string that is at most 1,024 bytes long. Report job IDs cannot be edited.

" + } + }, + "ReportPlanArn": { + "target": "com.amazonaws.backup#ARN", + "traits": { + "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN\n depends on the resource type.

" + } + }, + "ReportTemplate": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

Identifies the report template for the report. Reports are built using a report\n template. The report templates are:

\n

\n RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT |\n COPY_JOB_REPORT | RESTORE_JOB_REPORT\n

" + } + }, + "CreationTime": { + "target": "com.amazonaws.backup#timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that a report job is created, in Unix format and Coordinated Universal\n Time (UTC). The value of CreationTime is accurate to milliseconds. For\n example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.

" + } + }, + "CompletionTime": { + "target": "com.amazonaws.backup#timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that a report job is completed, in Unix format and Coordinated\n Universal Time (UTC). The value of CompletionTime is accurate to milliseconds.\n For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.

" + } + }, + "Status": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

The status of a report job. The statuses are:

\n

\n CREATED | RUNNING | COMPLETED | FAILED\n

\n

\n COMPLETED means that the report is available for your review at your\n designated destination. If the status is FAILED, review the\n StatusMessage for the reason.

" + } + }, + "StatusMessage": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

A message explaining the status of the report job.

" + } + }, + "ReportDestination": { + "target": "com.amazonaws.backup#ReportDestination", + "traits": { + "smithy.api#documentation": "

The S3 bucket name and S3 keys for the destination where the report job publishes the\n report.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains detailed information about a report job. A report job compiles a report based\n on a report plan and publishes it to Amazon S3.

" + } + }, + "com.amazonaws.backup#ReportJobId": { + "type": "string" + }, + "com.amazonaws.backup#ReportJobList": { + "type": "list", + "member": { + "target": "com.amazonaws.backup#ReportJob" + } + }, + "com.amazonaws.backup#ReportPlan": { + "type": "structure", + "members": { + "ReportPlanArn": { + "target": "com.amazonaws.backup#ARN", + "traits": { + "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN\n depends on the resource type.

" + } + }, + "ReportPlanName": { + "target": "com.amazonaws.backup#ReportPlanName", + "traits": { + "smithy.api#documentation": "

The unique name of the report plan. This name is between 1 and 256 characters starting\n with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores\n (_).

" + } + }, + "ReportPlanDescription": { + "target": "com.amazonaws.backup#ReportPlanDescription", + "traits": { + "smithy.api#documentation": "

An optional description of the report plan with a maximum 1,024 characters.

" + } + }, + "ReportSetting": { + "target": "com.amazonaws.backup#ReportSetting", + "traits": { + "smithy.api#documentation": "

Identifies the report template for the report. Reports are built using a report\n template. The report templates are:

\n

\n RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT |\n COPY_JOB_REPORT | RESTORE_JOB_REPORT\n

\n

If the report template is RESOURCE_COMPLIANCE_REPORT or\n CONTROL_COMPLIANCE_REPORT, this API resource also describes the report\n coverage by Amazon Web Services Regions and frameworks.

" + } + }, + "ReportDeliveryChannel": { + "target": "com.amazonaws.backup#ReportDeliveryChannel", + "traits": { + "smithy.api#documentation": "

Contains information about where and how to deliver your reports, specifically your\n Amazon S3 bucket name, S3 key prefix, and the formats of your reports.

" + } + }, + "DeploymentStatus": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

The deployment status of a report plan. The statuses are:

\n

\n CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS |\n COMPLETED\n

" + } + }, + "CreationTime": { + "target": "com.amazonaws.backup#timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that a report plan is created, in Unix format and Coordinated\n Universal Time (UTC). The value of CreationTime is accurate to milliseconds.\n For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.

" + } + }, + "LastAttemptedExecutionTime": { + "target": "com.amazonaws.backup#timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that a report job associated with this report plan last attempted to\n run, in Unix format and Coordinated Universal Time (UTC). The value of\n LastAttemptedExecutionTime is accurate to milliseconds. For example, the\n value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" + } + }, + "LastSuccessfulExecutionTime": { + "target": "com.amazonaws.backup#timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that a report job associated with this report plan last successfully\n ran, in Unix format and Coordinated Universal Time (UTC). The value of\n LastSuccessfulExecutionTime is accurate to milliseconds. For example, the\n value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains detailed information about a report plan.

" + } + }, + "com.amazonaws.backup#ReportPlanDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": "\\S" + } + }, + "com.amazonaws.backup#ReportPlanList": { + "type": "list", + "member": { + "target": "com.amazonaws.backup#ReportPlan" + } + }, + "com.amazonaws.backup#ReportPlanName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z][_a-zA-Z0-9]*$" + } + }, + "com.amazonaws.backup#ReportSetting": { + "type": "structure", + "members": { + "ReportTemplate": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

Identifies the report template for the report. Reports are built using a report\n template. The report templates are:

\n

\n RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT |\n COPY_JOB_REPORT | RESTORE_JOB_REPORT\n

", + "smithy.api#required": {} + } + }, + "FrameworkArns": { + "target": "com.amazonaws.backup#stringList", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of the frameworks a report covers.

" + } + }, + "NumberOfFrameworks": { + "target": "com.amazonaws.backup#integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of frameworks a report covers.

" + } + }, + "Accounts": { + "target": "com.amazonaws.backup#stringList", + "traits": { + "smithy.api#documentation": "

These are the accounts to be included in the report.

" + } + }, + "OrganizationUnits": { + "target": "com.amazonaws.backup#stringList", + "traits": { + "smithy.api#documentation": "

These are the Organizational Units to be included in the report.

" + } + }, + "Regions": { + "target": "com.amazonaws.backup#stringList", + "traits": { + "smithy.api#documentation": "

These are the Regions to be included in the report.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains detailed information about a report setting.

" + } + }, + "com.amazonaws.backup#ResourceArns": { + "type": "list", + "member": { + "target": "com.amazonaws.backup#ARN" + } + }, + "com.amazonaws.backup#ResourceIdentifiers": { + "type": "list", + "member": { + "target": "com.amazonaws.backup#string" + } + }, + "com.amazonaws.backup#ResourceNotFoundException": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.backup#string" + }, + "Message": { + "target": "com.amazonaws.backup#string" + }, + "Type": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

" + } + }, + "Context": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A resource that is required for the action doesn't exist.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.backup#ResourceType": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z0-9\\-\\_\\.]{1,50}$" + } + }, + "com.amazonaws.backup#ResourceTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.backup#ARN" + } + }, + "com.amazonaws.backup#ResourceTypeManagementPreference": { + "type": "map", + "key": { + "target": "com.amazonaws.backup#ResourceType" + }, + "value": { + "target": "com.amazonaws.backup#IsEnabled" + } + }, + "com.amazonaws.backup#ResourceTypeOptInPreference": { + "type": "map", + "key": { + "target": "com.amazonaws.backup#ResourceType" + }, + "value": { + "target": "com.amazonaws.backup#IsEnabled" + } + }, + "com.amazonaws.backup#ResourceTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.backup#ResourceType" + } + }, + "com.amazonaws.backup#RestoreDeletionStatus": { + "type": "enum", "members": { - "BackupVaultName": { - "target": "com.amazonaws.backup#BackupVaultName", + "DELETING": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Amazon Web Services\n Region where they are created. They consist of lowercase letters, numbers, and\n hyphens.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#enumValue": "DELETING" } }, - "SNSTopicArn": { - "target": "com.amazonaws.backup#ARN", + "FAILED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that specifies the topic for a backup vault’s events; for\n example, arn:aws:sns:us-west-2:111122223333:MyVaultTopic.

", - "smithy.api#required": {} + "smithy.api#enumValue": "FAILED" } }, - "BackupVaultEvents": { - "target": "com.amazonaws.backup#BackupVaultEvents", + "SUCCESSFUL": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

An array of events that indicate the status of jobs to back up resources to the backup\n vault.

\n

For common use cases and code samples, see Using Amazon SNS to\n track Backup events.

\n

The following events are supported:

\n \n \n

The list below shows items that are deprecated events (for reference) and are no longer \n in use. They are no longer supported and will not return statuses or notifications. \n Refer to the list above for current supported events.

\n ", - "smithy.api#required": {} + "smithy.api#enumValue": "SUCCESSFUL" } } - }, - "traits": { - "smithy.api#input": {} } }, - "com.amazonaws.backup#RecoveryPointByBackupVault": { + "com.amazonaws.backup#RestoreJobCreator": { "type": "structure", "members": { - "RecoveryPointArn": { - "target": "com.amazonaws.backup#ARN", - "traits": { - "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example,\n arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

" - } - }, - "BackupVaultName": { - "target": "com.amazonaws.backup#BackupVaultName", - "traits": { - "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Amazon Web Services\n Region where they are created. They consist of lowercase letters, numbers, and\n hyphens.

" - } - }, - "BackupVaultArn": { - "target": "com.amazonaws.backup#ARN", - "traits": { - "smithy.api#documentation": "

An ARN that uniquely identifies a backup vault; for example,\n arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

" - } - }, - "SourceBackupVaultArn": { + "RestoreTestingPlanArn": { "target": "com.amazonaws.backup#ARN", "traits": { - "smithy.api#documentation": "

The backup vault where the recovery point was originally copied from. If the recovery\n point is restored to the same account this value will be null.

" - } - }, - "ResourceArn": { - "target": "com.amazonaws.backup#ARN", - "traits": { - "smithy.api#documentation": "

An ARN that uniquely identifies a resource. The format of the ARN depends on the\n resource type.

" - } - }, - "ResourceType": { - "target": "com.amazonaws.backup#ResourceType", - "traits": { - "smithy.api#documentation": "

The type of Amazon Web Services resource saved as a recovery point; for example, an\n Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. For Windows Volume Shadow Copy Service (VSS) backups, the only\n supported resource type is Amazon EC2.

" - } - }, - "CreatedBy": { - "target": "com.amazonaws.backup#RecoveryPointCreator", - "traits": { - "smithy.api#documentation": "

Contains identifying information about the creation of a recovery point, including the\n BackupPlanArn, BackupPlanId, BackupPlanVersion,\n and BackupRuleId of the backup plan that is used to create it.

" - } - }, - "IamRoleArn": { - "target": "com.amazonaws.backup#IAMRoleArn", - "traits": { - "smithy.api#documentation": "

Specifies the IAM role ARN used to create the target recovery point; for example,\n arn:aws:iam::123456789012:role/S3Access.

" - } - }, - "Status": { - "target": "com.amazonaws.backup#RecoveryPointStatus", - "traits": { - "smithy.api#documentation": "

A status code specifying the state of the recovery point.

" + "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies \n a restore testing plan.

" } - }, - "StatusMessage": { - "target": "com.amazonaws.backup#string", + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about the restore testing plan that \n Backup used to initiate the restore job.

" + } + }, + "com.amazonaws.backup#RestoreJobId": { + "type": "string" + }, + "com.amazonaws.backup#RestoreJobState": { + "type": "enum", + "members": { + "CREATED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

A message explaining the reason of the recovery point deletion failure.

" + "smithy.api#enumValue": "CREATED" } }, - "CreationDate": { - "target": "com.amazonaws.backup#timestamp", + "PENDING": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The date and time a recovery point is created, in Unix format and Coordinated Universal\n Time (UTC). The value of CreationDate is accurate to milliseconds. For\n example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.

" + "smithy.api#enumValue": "PENDING" } }, - "CompletionDate": { - "target": "com.amazonaws.backup#timestamp", + "RUNNING": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The date and time a job to restore a recovery point is completed, in Unix format and\n Coordinated Universal Time (UTC). The value of CompletionDate is accurate to\n milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018\n 12:11:30.087 AM.

" + "smithy.api#enumValue": "RUNNING" } }, - "BackupSizeInBytes": { - "target": "com.amazonaws.backup#Long", + "ABORTED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The size, in bytes, of a backup.

" + "smithy.api#enumValue": "ABORTED" } }, - "CalculatedLifecycle": { - "target": "com.amazonaws.backup#CalculatedLifecycle", + "COMPLETED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

A CalculatedLifecycle object containing DeleteAt and\n MoveToColdStorageAt timestamps.

" + "smithy.api#enumValue": "COMPLETED" } }, - "Lifecycle": { - "target": "com.amazonaws.backup#Lifecycle", + "FAILED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The lifecycle defines when a protected resource is transitioned to cold storage and when\n it expires. Backup transitions and expires backups automatically according to\n the lifecycle that you define.

\n

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90\n days. Therefore, the “retention” setting must be 90 days greater than the “transition to\n cold after days” setting. The “transition to cold after days” setting cannot be changed\n after a backup has been transitioned to cold.

\n

Resource types that are able to be transitioned to cold storage are listed in the \"Lifecycle to cold storage\" \n section of the \n Feature availability by resource table. Backup ignores this expression for\n other resource types.

" + "smithy.api#enumValue": "FAILED" } }, - "EncryptionKeyArn": { - "target": "com.amazonaws.backup#ARN", + "AGGREGATE_ALL": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The server-side encryption key that is used to protect your backups; for example,\n arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.

" + "smithy.api#enumValue": "AGGREGATE_ALL" } }, - "IsEncrypted": { - "target": "com.amazonaws.backup#Boolean2", + "ANY": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A Boolean value that is returned as TRUE if the specified recovery point is\n encrypted, or FALSE if the recovery point is not encrypted.

" + "smithy.api#enumValue": "ANY" } - }, - "LastRestoreTime": { - "target": "com.amazonaws.backup#timestamp", + } + } + }, + "com.amazonaws.backup#RestoreJobStatus": { + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The date and time a recovery point was last restored, in Unix format and Coordinated\n Universal Time (UTC). The value of LastRestoreTime is accurate to\n milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018\n 12:11:30.087 AM.

" + "smithy.api#enumValue": "PENDING" } }, - "ParentRecoveryPointArn": { - "target": "com.amazonaws.backup#ARN", + "RUNNING": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

This is the Amazon Resource Name (ARN) of the parent (composite) \n recovery point.

" + "smithy.api#enumValue": "RUNNING" } }, - "CompositeMemberIdentifier": { - "target": "com.amazonaws.backup#string", + "COMPLETED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

This is the identifier of a resource within a composite group, such as \n nested (child) recovery point belonging to a composite (parent) stack. The \n ID is transferred from \n the \n logical ID within a stack.

" + "smithy.api#enumValue": "COMPLETED" } }, - "IsParent": { - "target": "com.amazonaws.backup#Boolean2", + "ABORTED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

This is a boolean value indicating this is \n a parent (composite) recovery point.

" + "smithy.api#enumValue": "ABORTED" } }, - "ResourceName": { - "target": "com.amazonaws.backup#string", + "FAILED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

This is the non-unique name of the resource that \n belongs to the specified backup.

" + "smithy.api#enumValue": "FAILED" } } - }, - "traits": { - "smithy.api#documentation": "

Contains detailed information about the recovery points stored in a backup vault.

" - } - }, - "com.amazonaws.backup#RecoveryPointByBackupVaultList": { - "type": "list", - "member": { - "target": "com.amazonaws.backup#RecoveryPointByBackupVault" } }, - "com.amazonaws.backup#RecoveryPointByResource": { + "com.amazonaws.backup#RestoreJobSummary": { "type": "structure", "members": { - "RecoveryPointArn": { - "target": "com.amazonaws.backup#ARN", - "traits": { - "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example,\n arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

" - } - }, - "CreationDate": { - "target": "com.amazonaws.backup#timestamp", - "traits": { - "smithy.api#documentation": "

The date and time a recovery point is created, in Unix format and Coordinated Universal\n Time (UTC). The value of CreationDate is accurate to milliseconds. For\n example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.

" - } - }, - "Status": { - "target": "com.amazonaws.backup#RecoveryPointStatus", - "traits": { - "smithy.api#documentation": "

A status code specifying the state of the recovery point.

" - } - }, - "StatusMessage": { - "target": "com.amazonaws.backup#string", + "Region": { + "target": "com.amazonaws.backup#Region", "traits": { - "smithy.api#documentation": "

A message explaining the reason of the recovery point deletion failure.

" + "smithy.api#documentation": "

The Amazon Web Services Regions within the job summary.

" } }, - "EncryptionKeyArn": { - "target": "com.amazonaws.backup#ARN", + "AccountId": { + "target": "com.amazonaws.backup#AccountId", "traits": { - "smithy.api#documentation": "

The server-side encryption key that is used to protect your backups; for example,\n arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.

" + "smithy.api#documentation": "

The account ID that owns the jobs within the summary.

" } }, - "BackupSizeBytes": { - "target": "com.amazonaws.backup#Long", + "State": { + "target": "com.amazonaws.backup#RestoreJobState", "traits": { - "smithy.api#documentation": "

The size, in bytes, of a backup.

" + "smithy.api#documentation": "

This value is job count for jobs \n with the specified state.

" } }, - "BackupVaultName": { - "target": "com.amazonaws.backup#BackupVaultName", + "ResourceType": { + "target": "com.amazonaws.backup#ResourceType", "traits": { - "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Amazon Web Services\n Region where they are created. They consist of lowercase letters, numbers, and\n hyphens.

" + "smithy.api#documentation": "

This value is the job count for the specified resource type. \n The request GetSupportedResourceTypes returns \n strings for supported resource types.

" } }, - "IsParent": { - "target": "com.amazonaws.backup#Boolean2", + "Count": { + "target": "com.amazonaws.backup#integer", "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

This is a boolean value indicating this is \n a parent (composite) recovery point.

" + "smithy.api#default": 0, + "smithy.api#documentation": "

The value as a number of jobs in a job summary.

" } }, - "ParentRecoveryPointArn": { - "target": "com.amazonaws.backup#ARN", + "StartTime": { + "target": "com.amazonaws.backup#timestamp", "traits": { - "smithy.api#documentation": "

This is the Amazon Resource Name (ARN) of the parent (composite) \n recovery point.

" + "smithy.api#documentation": "

The value of time in number format of a job start time.

\n

This value is the time in Unix format, Coordinated Universal Time (UTC), and accurate to\n milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018\n 12:11:30.087 AM.

" } }, - "ResourceName": { - "target": "com.amazonaws.backup#string", + "EndTime": { + "target": "com.amazonaws.backup#timestamp", "traits": { - "smithy.api#documentation": "

This is the non-unique name of the resource that \n belongs to the specified backup.

" + "smithy.api#documentation": "

The value of time in number format of a job end time.

\n

This value is the time in Unix format, Coordinated Universal Time (UTC), and accurate to\n milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018\n 12:11:30.087 AM.

" } } }, "traits": { - "smithy.api#documentation": "

Contains detailed information about a saved recovery point.

" + "smithy.api#documentation": "

This is a summary of restore jobs created \n or running within the most recent 30 days.

\n

The returned summary may contain the following: \n Region, Account, State, ResourceType, MessageCategory, \n StartTime, EndTime, and Count of included jobs.

" + } + }, + "com.amazonaws.backup#RestoreJobSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.backup#RestoreJobSummary" } }, - "com.amazonaws.backup#RecoveryPointByResourceList": { + "com.amazonaws.backup#RestoreJobsList": { "type": "list", "member": { - "target": "com.amazonaws.backup#RecoveryPointByResource" + "target": "com.amazonaws.backup#RestoreJobsListMember" } }, - "com.amazonaws.backup#RecoveryPointCreator": { + "com.amazonaws.backup#RestoreJobsListMember": { "type": "structure", "members": { - "BackupPlanId": { + "AccountId": { + "target": "com.amazonaws.backup#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID that owns the restore job.

" + } + }, + "RestoreJobId": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

Uniquely identifies a backup plan.

" + "smithy.api#documentation": "

Uniquely identifies the job that restores a recovery point.

" } }, - "BackupPlanArn": { + "RecoveryPointArn": { "target": "com.amazonaws.backup#ARN", "traits": { - "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example,\n arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.

" + "smithy.api#documentation": "

An ARN that uniquely identifies a recovery point; for example,\n arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

" } }, - "BackupPlanVersion": { - "target": "com.amazonaws.backup#string", + "CreationDate": { + "target": "com.amazonaws.backup#timestamp", "traits": { - "smithy.api#documentation": "

Version IDs are unique, randomly generated, Unicode, UTF-8 encoded strings that are at\n most 1,024 bytes long. They cannot be edited.

" + "smithy.api#documentation": "

The date and time a restore job is created, in Unix format and Coordinated Universal\n Time (UTC). The value of CreationDate is accurate to milliseconds. For\n example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.

" } }, - "BackupRuleId": { - "target": "com.amazonaws.backup#string", + "CompletionDate": { + "target": "com.amazonaws.backup#timestamp", "traits": { - "smithy.api#documentation": "

Uniquely identifies a rule used to schedule the backup of a selection of\n resources.

" + "smithy.api#documentation": "

The date and time a job to restore a recovery point is completed, in Unix format and\n Coordinated Universal Time (UTC). The value of CompletionDate is accurate to\n milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018\n 12:11:30.087 AM.

" } - } - }, - "traits": { - "smithy.api#documentation": "

Contains information about the backup plan and rule that Backup used to\n initiate the recovery point backup.

" - } - }, - "com.amazonaws.backup#RecoveryPointMember": { - "type": "structure", - "members": { - "RecoveryPointArn": { - "target": "com.amazonaws.backup#ARN", + }, + "Status": { + "target": "com.amazonaws.backup#RestoreJobStatus", "traits": { - "smithy.api#documentation": "

This is the Amazon Resource Name (ARN) of the parent (composite) \n recovery point.

" + "smithy.api#documentation": "

A status code specifying the state of the job initiated by Backup to restore\n a recovery point.

" } }, - "ResourceArn": { - "target": "com.amazonaws.backup#ARN", + "StatusMessage": { + "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

This is the Amazon Resource Name (ARN) that uniquely identifies \n a saved resource.

" + "smithy.api#documentation": "

A detailed message explaining the status of the job to restore a recovery point.

" } }, - "ResourceType": { - "target": "com.amazonaws.backup#ResourceType", + "PercentDone": { + "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

This is the Amazon Web Services resource type that is saved as \n a recovery point.

" + "smithy.api#documentation": "

Contains an estimated percentage complete of a job at the time the job status was\n queried.

" } }, - "BackupVaultName": { - "target": "com.amazonaws.backup#BackupVaultName", + "BackupSizeInBytes": { + "target": "com.amazonaws.backup#Long", "traits": { - "smithy.api#documentation": "

This is the name of the backup vault \n (the logical container in which backups are stored).

" + "smithy.api#documentation": "

The size, in bytes, of the restored resource.

" } - } - }, - "traits": { - "smithy.api#documentation": "

This is a recovery point which is a child (nested) recovery point \n of a parent (composite) recovery point. These recovery points \n can be disassociated from their parent (composite) recovery \n point, in which case they will no longer be a member.

" - } - }, - "com.amazonaws.backup#RecoveryPointSelection": { - "type": "structure", - "members": { - "VaultNames": { - "target": "com.amazonaws.backup#VaultNames", + }, + "IamRoleArn": { + "target": "com.amazonaws.backup#IAMRoleArn", "traits": { - "smithy.api#documentation": "

These are the names of the vaults in which the selected \n recovery points are contained.

" + "smithy.api#documentation": "

Specifies the IAM role ARN used to create the target recovery point; for example,\n arn:aws:iam::123456789012:role/S3Access.

" } }, - "ResourceIdentifiers": { - "target": "com.amazonaws.backup#ResourceIdentifiers", + "ExpectedCompletionTimeMinutes": { + "target": "com.amazonaws.backup#Long", "traits": { - "smithy.api#documentation": "

These are the resources included in the resource selection \n (including type of resources and vaults).

" + "smithy.api#documentation": "

The amount of time in minutes that a job restoring a recovery point is expected to\n take.

" } }, - "DateRange": { - "target": "com.amazonaws.backup#DateRange" - } - }, - "traits": { - "smithy.api#documentation": "

This specifies criteria to assign \n a set of resources, such as resource types or backup vaults.

" - } - }, - "com.amazonaws.backup#RecoveryPointStatus": { - "type": "enum", - "members": { - "COMPLETED": { - "target": "smithy.api#Unit", + "CreatedResourceArn": { + "target": "com.amazonaws.backup#ARN", "traits": { - "smithy.api#enumValue": "COMPLETED" + "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN\n depends on the resource type.

" } }, - "PARTIAL": { - "target": "smithy.api#Unit", + "ResourceType": { + "target": "com.amazonaws.backup#ResourceType", "traits": { - "smithy.api#enumValue": "PARTIAL" + "smithy.api#documentation": "

The resource type of the listed restore jobs; for example, an Amazon Elastic Block Store\n (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.\n For Windows Volume Shadow Copy Service (VSS) backups, the only supported resource type is\n Amazon EC2.

" } }, - "DELETING": { - "target": "smithy.api#Unit", + "RecoveryPointCreationDate": { + "target": "com.amazonaws.backup#timestamp", "traits": { - "smithy.api#enumValue": "DELETING" + "smithy.api#documentation": "

The date on which a recovery point was created.

" } }, - "EXPIRED": { - "target": "smithy.api#Unit", + "CreatedBy": { + "target": "com.amazonaws.backup#RestoreJobCreator", "traits": { - "smithy.api#enumValue": "EXPIRED" + "smithy.api#documentation": "

Contains identifying information about the creation \n of a restore job.

" } - } - } - }, - "com.amazonaws.backup#RecoveryPointsList": { - "type": "list", - "member": { - "target": "com.amazonaws.backup#RecoveryPointMember" - } - }, - "com.amazonaws.backup#Region": { - "type": "string" - }, - "com.amazonaws.backup#ReportDeliveryChannel": { - "type": "structure", - "members": { - "S3BucketName": { - "target": "com.amazonaws.backup#string", + }, + "ValidationStatus": { + "target": "com.amazonaws.backup#RestoreValidationStatus", "traits": { - "smithy.api#documentation": "

The unique name of the S3 bucket that receives your reports.

", - "smithy.api#required": {} + "smithy.api#documentation": "

This is the status of validation run on the indicated \n restore job.

" } }, - "S3KeyPrefix": { + "ValidationStatusMessage": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

The prefix for where Backup Audit Manager delivers your reports to Amazon S3. The prefix is this part of the following path:\n s3://your-bucket-name/prefix/Backup/us-west-2/year/month/day/report-name.\n If not specified, there is no prefix.

" + "smithy.api#documentation": "

This describes the status of validation run on the \n indicated restore job.

" } }, - "Formats": { - "target": "com.amazonaws.backup#FormatList", - "traits": { - "smithy.api#documentation": "

A list of the format of your reports: CSV, JSON, or both. If\n not specified, the default format is CSV.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains information from your report plan about where to deliver your reports,\n specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your\n reports.

" - } - }, - "com.amazonaws.backup#ReportDestination": { - "type": "structure", - "members": { - "S3BucketName": { - "target": "com.amazonaws.backup#string", + "DeletionStatus": { + "target": "com.amazonaws.backup#RestoreDeletionStatus", "traits": { - "smithy.api#documentation": "

The unique name of the Amazon S3 bucket that receives your reports.

" + "smithy.api#documentation": "

This notes the status of the data generated by the restore \n test. The status may be Deleting, Failed, \n or Successful.

" } }, - "S3Keys": { - "target": "com.amazonaws.backup#stringList", + "DeletionStatusMessage": { + "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

The object key that uniquely identifies your reports in your S3 bucket.

" + "smithy.api#documentation": "

This describes the restore job deletion status.

" } } }, "traits": { - "smithy.api#documentation": "

Contains information from your report job about your report destination.

" + "smithy.api#documentation": "

Contains metadata about a restore job.

" } }, - "com.amazonaws.backup#ReportJob": { + "com.amazonaws.backup#RestoreTestingPlanForCreate": { "type": "structure", "members": { - "ReportJobId": { - "target": "com.amazonaws.backup#ReportJobId", - "traits": { - "smithy.api#documentation": "

The identifier for a report job. A unique, randomly generated, Unicode, UTF-8 encoded\n string that is at most 1,024 bytes long. Report job IDs cannot be edited.

" - } - }, - "ReportPlanArn": { - "target": "com.amazonaws.backup#ARN", - "traits": { - "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN\n depends on the resource type.

" - } - }, - "ReportTemplate": { - "target": "com.amazonaws.backup#string", - "traits": { - "smithy.api#documentation": "

Identifies the report template for the report. Reports are built using a report\n template. The report templates are:

\n

\n RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT |\n COPY_JOB_REPORT | RESTORE_JOB_REPORT\n

" - } - }, - "CreationTime": { - "target": "com.amazonaws.backup#timestamp", + "RecoveryPointSelection": { + "target": "com.amazonaws.backup#RestoreTestingRecoveryPointSelection", "traits": { - "smithy.api#documentation": "

The date and time that a report job is created, in Unix format and Coordinated Universal\n Time (UTC). The value of CreationTime is accurate to milliseconds. For\n example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.

" + "smithy.api#documentation": "

Required: Algorithm; Required: Recovery point types; IncludeVaults \n (one or more). Optional: SelectionWindowDays ('30' if not specified); \n ExcludeVaults (list of selectors), defaults to empty list if not listed.

", + "smithy.api#required": {} } }, - "CompletionTime": { - "target": "com.amazonaws.backup#timestamp", + "RestoreTestingPlanName": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The date and time that a report job is completed, in Unix format and Coordinated\n Universal Time (UTC). The value of CompletionTime is accurate to milliseconds.\n For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.

" + "smithy.api#documentation": "

The RestoreTestingPlanName is a unique string that is the name \n of the restore testing plan. This cannot be changed after creation, \n and it must consist of only alphanumeric characters and underscores.

", + "smithy.api#required": {} } }, - "Status": { - "target": "com.amazonaws.backup#string", + "ScheduleExpression": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The status of a report job. The statuses are:

\n

\n CREATED | RUNNING | COMPLETED | FAILED\n

\n

\n COMPLETED means that the report is available for your review at your\n designated destination. If the status is FAILED, review the\n StatusMessage for the reason.

" + "smithy.api#documentation": "

A CRON expression in specified timezone when a restore \n testing plan is executed.

", + "smithy.api#required": {} } }, - "StatusMessage": { - "target": "com.amazonaws.backup#string", + "ScheduleExpressionTimezone": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

A message explaining the status of the report job.

" + "smithy.api#documentation": "

Optional. This is the timezone in which the schedule \n expression is set. By default, ScheduleExpressions are in UTC. \n You can modify this to a specified timezone.

" } }, - "ReportDestination": { - "target": "com.amazonaws.backup#ReportDestination", + "StartWindowHours": { + "target": "com.amazonaws.backup#integer", "traits": { - "smithy.api#documentation": "

The S3 bucket name and S3 keys for the destination where the report job publishes the\n report.

" + "smithy.api#default": 0, + "smithy.api#documentation": "

Defaults to 24 hours.

\n

A value in hours after a \n restore test is scheduled before a job will be canceled if it \n doesn't start successfully. This value is optional. If this value \n is included, this parameter has a maximum value of 168 hours \n (one week).

" } } }, "traits": { - "smithy.api#documentation": "

Contains detailed information about a report job. A report job compiles a report based\n on a report plan and publishes it to Amazon S3.

" - } - }, - "com.amazonaws.backup#ReportJobId": { - "type": "string" - }, - "com.amazonaws.backup#ReportJobList": { - "type": "list", - "member": { - "target": "com.amazonaws.backup#ReportJob" + "smithy.api#documentation": "

This contains metadata about a restore testing plan.

" } }, - "com.amazonaws.backup#ReportPlan": { + "com.amazonaws.backup#RestoreTestingPlanForGet": { "type": "structure", "members": { - "ReportPlanArn": { - "target": "com.amazonaws.backup#ARN", + "CreationTime": { + "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN\n depends on the resource type.

" + "smithy.api#documentation": "

The date and time that a restore testing plan was created, \n in Unix format and Coordinated Universal Time (UTC). The value of \n CreationTime is accurate to milliseconds. For example, \n the value 1516925490.087 represents Friday, January 26, 2018 \n 12:11:30.087 AM.

", + "smithy.api#required": {} } }, - "ReportPlanName": { - "target": "com.amazonaws.backup#ReportPlanName", + "CreatorRequestId": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The unique name of the report plan. This name is between 1 and 256 characters starting\n with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores\n (_).

" + "smithy.api#documentation": "

This identifies the request and allows failed requests to \n be retried without the risk of running the operation twice. \n If the request includes a CreatorRequestId that \n matches an existing backup plan, that plan is returned. This \n parameter is optional.

\n

If used, this parameter must \n contain 1 to 50 alphanumeric or '-_.' characters.

" } }, - "ReportPlanDescription": { - "target": "com.amazonaws.backup#ReportPlanDescription", + "LastExecutionTime": { + "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

An optional description of the report plan with a maximum 1,024 characters.

" + "smithy.api#documentation": "

The last time a restore test was run with the specified \n restore testing plan. A date and time, in Unix format and \n Coordinated Universal Time (UTC). The value of \n LastExecutionDate is accurate to milliseconds. \n For example, the value 1516925490.087 represents Friday, \n January 26, 2018 12:11:30.087 AM.

" } }, - "ReportSetting": { - "target": "com.amazonaws.backup#ReportSetting", + "LastUpdateTime": { + "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

Identifies the report template for the report. Reports are built using a report\n template. The report templates are:

\n

\n RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT |\n COPY_JOB_REPORT | RESTORE_JOB_REPORT\n

\n

If the report template is RESOURCE_COMPLIANCE_REPORT or\n CONTROL_COMPLIANCE_REPORT, this API resource also describes the report\n coverage by Amazon Web Services Regions and frameworks.

" + "smithy.api#documentation": "

The date and time that the restore testing plan was updated. \n This update is in Unix format and Coordinated Universal Time (UTC). \n The value of LastUpdateTime is accurate to milliseconds. \n For example, the value 1516925490.087 represents Friday, \n January 26, 2018 12:11:30.087 AM.

" } }, - "ReportDeliveryChannel": { - "target": "com.amazonaws.backup#ReportDeliveryChannel", + "RecoveryPointSelection": { + "target": "com.amazonaws.backup#RestoreTestingRecoveryPointSelection", "traits": { - "smithy.api#documentation": "

Contains information about where and how to deliver your reports, specifically your\n Amazon S3 bucket name, S3 key prefix, and the formats of your reports.

" + "smithy.api#documentation": "

The specified criteria to assign a set of resources, such as \n recovery point types or backup vaults.

", + "smithy.api#required": {} } }, - "DeploymentStatus": { - "target": "com.amazonaws.backup#string", + "RestoreTestingPlanArn": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The deployment status of a report plan. The statuses are:

\n

\n CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS |\n COMPLETED\n

" + "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies \n a restore testing plan.

", + "smithy.api#required": {} } }, - "CreationTime": { - "target": "com.amazonaws.backup#timestamp", + "RestoreTestingPlanName": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The date and time that a report plan is created, in Unix format and Coordinated\n Universal Time (UTC). The value of CreationTime is accurate to milliseconds.\n For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.

" + "smithy.api#documentation": "

This is the restore testing plan name.

", + "smithy.api#required": {} } }, - "LastAttemptedExecutionTime": { - "target": "com.amazonaws.backup#timestamp", + "ScheduleExpression": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

A CRON expression in specified timezone when a restore \n testing plan is executed.

", + "smithy.api#required": {} + } + }, + "ScheduleExpressionTimezone": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The date and time that a report job associated with this report plan last attempted to\n run, in Unix format and Coordinated Universal Time (UTC). The value of\n LastAttemptedExecutionTime is accurate to milliseconds. For example, the\n value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" + "smithy.api#documentation": "

Optional. This is the timezone in which the schedule \n expression is set. By default, ScheduleExpressions are in UTC. \n You can modify this to a specified timezone.

" } }, - "LastSuccessfulExecutionTime": { - "target": "com.amazonaws.backup#timestamp", + "StartWindowHours": { + "target": "com.amazonaws.backup#integer", "traits": { - "smithy.api#documentation": "

The date and time that a report job associated with this report plan last successfully\n ran, in Unix format and Coordinated Universal Time (UTC). The value of\n LastSuccessfulExecutionTime is accurate to milliseconds. For example, the\n value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" + "smithy.api#default": 0, + "smithy.api#documentation": "

Defaults to 24 hours.

\n

A value in hours after a \n restore test is scheduled before a job will be canceled if it \n doesn't start successfully. This value is optional. If this value \n is included, this parameter has a maximum value of 168 hours \n (one week).

" } } }, "traits": { - "smithy.api#documentation": "

Contains detailed information about a report plan.

" - } - }, - "com.amazonaws.backup#ReportPlanDescription": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1024 - }, - "smithy.api#pattern": "\\S" - } - }, - "com.amazonaws.backup#ReportPlanList": { - "type": "list", - "member": { - "target": "com.amazonaws.backup#ReportPlan" - } - }, - "com.amazonaws.backup#ReportPlanName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - }, - "smithy.api#pattern": "^[a-zA-Z][_a-zA-Z0-9]*$" + "smithy.api#documentation": "

This contains metadata about a restore testing plan.

" } }, - "com.amazonaws.backup#ReportSetting": { + "com.amazonaws.backup#RestoreTestingPlanForList": { "type": "structure", "members": { - "ReportTemplate": { - "target": "com.amazonaws.backup#string", + "CreationTime": { + "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

Identifies the report template for the report. Reports are built using a report\n template. The report templates are:

\n

\n RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT |\n COPY_JOB_REPORT | RESTORE_JOB_REPORT\n

", + "smithy.api#documentation": "

The date and time that a restore testing plan was created, \n in Unix format and Coordinated Universal Time (UTC). The value \n of CreationTime is accurate to milliseconds. For \n example, the value 1516925490.087 represents Friday, January 26, \n 2018 12:11:30.087 AM.

", "smithy.api#required": {} } }, - "FrameworkArns": { - "target": "com.amazonaws.backup#stringList", + "LastExecutionTime": { + "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of the frameworks a report covers.

" + "smithy.api#documentation": "

The last time a restore test was run with the specified \n restore testing plan. A date and time, in Unix format and \n Coordinated Universal Time (UTC). The value of \n LastExecutionDate is accurate to milliseconds. \n For example, the value 1516925490.087 represents Friday, \n January 26, 2018 12:11:30.087 AM.

" } }, - "NumberOfFrameworks": { - "target": "com.amazonaws.backup#integer", + "LastUpdateTime": { + "target": "smithy.api#Timestamp", "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of frameworks a report covers.

" + "smithy.api#documentation": "

The date and time that the restore testing plan was updated. \n This update is in Unix format and Coordinated Universal Time (UTC). \n The value of LastUpdateTime is accurate to \n milliseconds. For example, the value 1516925490.087 represents \n Friday, January 26, 2018 12:11:30.087 AM.

" } }, - "Accounts": { - "target": "com.amazonaws.backup#stringList", + "RestoreTestingPlanArn": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

These are the accounts to be included in the report.

" + "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifiesa \n restore testing plan.

", + "smithy.api#required": {} } }, - "OrganizationUnits": { - "target": "com.amazonaws.backup#stringList", + "RestoreTestingPlanName": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

These are the Organizational Units to be included in the report.

" + "smithy.api#documentation": "

This is the restore testing plan name.

", + "smithy.api#required": {} } }, - "Regions": { - "target": "com.amazonaws.backup#stringList", + "ScheduleExpression": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

These are the Regions to be included in the report.

" + "smithy.api#documentation": "

A CRON expression in specified timezone when a restore \n testing plan is executed.

", + "smithy.api#required": {} + } + }, + "ScheduleExpressionTimezone": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

Optional. This is the timezone in which the schedule \n expression is set. By default, ScheduleExpressions are in UTC. \n You can modify this to a specified timezone.

" + } + }, + "StartWindowHours": { + "target": "com.amazonaws.backup#integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

Defaults to 24 hours.

\n

A value in hours after a restore test is scheduled before \n a job will be canceled if it doesn't start successfully. This \n value is optional. If this value is included, this parameter \n has a maximum value of 168 hours (one week).

" } } }, "traits": { - "smithy.api#documentation": "

Contains detailed information about a report setting.

" - } - }, - "com.amazonaws.backup#ResourceArns": { - "type": "list", - "member": { - "target": "com.amazonaws.backup#ARN" - } - }, - "com.amazonaws.backup#ResourceIdentifiers": { - "type": "list", - "member": { - "target": "com.amazonaws.backup#string" + "smithy.api#documentation": "

This contains metadata about a restore testing plan.

" } }, - "com.amazonaws.backup#ResourceNotFoundException": { + "com.amazonaws.backup#RestoreTestingPlanForUpdate": { "type": "structure", "members": { - "Code": { - "target": "com.amazonaws.backup#string" + "RecoveryPointSelection": { + "target": "com.amazonaws.backup#RestoreTestingRecoveryPointSelection", + "traits": { + "smithy.api#documentation": "

Required: Algorithm; RecoveryPointTypes; \n IncludeVaults (one or more).

\n

Optional: SelectionWindowDays ('30' if \n not specified); ExcludeVaults (defaults to empty \n list if not listed).

" + } }, - "Message": { - "target": "com.amazonaws.backup#string" + "ScheduleExpression": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

A CRON expression in specified timezone when a restore \n testing plan is executed.

" + } }, - "Type": { - "target": "com.amazonaws.backup#string", + "ScheduleExpressionTimezone": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

Optional. This is the timezone in which the schedule \n expression is set. By default, ScheduleExpressions are in UTC. \n You can modify this to a specified timezone.

" } }, - "Context": { - "target": "com.amazonaws.backup#string", + "StartWindowHours": { + "target": "com.amazonaws.backup#integer", "traits": { - "smithy.api#documentation": "

" + "smithy.api#default": 0, + "smithy.api#documentation": "

Defaults to 24 hours.

\n

A value in hours after a restore test is scheduled before a \n job will be canceled if it doesn't start successfully. This value \n is optional. If this value is included, this parameter has a \n maximum value of 168 hours (one week).

" } } }, "traits": { - "smithy.api#documentation": "

A resource that is required for the action doesn't exist.

", - "smithy.api#error": "client" - } - }, - "com.amazonaws.backup#ResourceType": { - "type": "string", - "traits": { - "smithy.api#pattern": "^[a-zA-Z0-9\\-\\_\\.]{1,50}$" - } - }, - "com.amazonaws.backup#ResourceTypeList": { - "type": "list", - "member": { - "target": "com.amazonaws.backup#ARN" - } - }, - "com.amazonaws.backup#ResourceTypeManagementPreference": { - "type": "map", - "key": { - "target": "com.amazonaws.backup#ResourceType" - }, - "value": { - "target": "com.amazonaws.backup#IsEnabled" - } - }, - "com.amazonaws.backup#ResourceTypeOptInPreference": { - "type": "map", - "key": { - "target": "com.amazonaws.backup#ResourceType" - }, - "value": { - "target": "com.amazonaws.backup#IsEnabled" + "smithy.api#documentation": "

This contains metadata about a restore testing plan.

" } }, - "com.amazonaws.backup#ResourceTypes": { + "com.amazonaws.backup#RestoreTestingPlans": { "type": "list", "member": { - "target": "com.amazonaws.backup#ResourceType" + "target": "com.amazonaws.backup#RestoreTestingPlanForList" } }, - "com.amazonaws.backup#RestoreJobId": { - "type": "string" - }, - "com.amazonaws.backup#RestoreJobState": { - "type": "enum", + "com.amazonaws.backup#RestoreTestingRecoveryPointSelection": { + "type": "structure", "members": { - "CREATED": { - "target": "smithy.api#Unit", + "Algorithm": { + "target": "com.amazonaws.backup#RestoreTestingRecoveryPointSelectionAlgorithm", "traits": { - "smithy.api#enumValue": "CREATED" + "smithy.api#documentation": "

Acceptable values include \"LATEST_WITHIN_WINDOW\" or \n \"RANDOM_WITHIN_WINDOW\"

" } }, - "PENDING": { - "target": "smithy.api#Unit", + "ExcludeVaults": { + "target": "com.amazonaws.backup#stringList", "traits": { - "smithy.api#enumValue": "PENDING" + "smithy.api#documentation": "

Accepted values include specific ARNs or list of selectors. \n Defaults to empty list if not listed.

" } }, - "RUNNING": { - "target": "smithy.api#Unit", + "IncludeVaults": { + "target": "com.amazonaws.backup#stringList", "traits": { - "smithy.api#enumValue": "RUNNING" + "smithy.api#documentation": "

Accepted values include wildcard [\"*\"] or by specific ARNs or \n ARN wilcard replacement \n [\"arn:aws:backup:us-west-2:123456789012:backup-vault:asdf\", ...] \n [\"arn:aws:backup:*:*:backup-vault:asdf-*\", ...]

" } }, - "ABORTED": { - "target": "smithy.api#Unit", + "RecoveryPointTypes": { + "target": "com.amazonaws.backup#RestoreTestingRecoveryPointTypeList", "traits": { - "smithy.api#enumValue": "ABORTED" + "smithy.api#documentation": "

These are the types of recovery points.

" } }, - "COMPLETED": { + "SelectionWindowDays": { + "target": "com.amazonaws.backup#integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

Accepted values are integers from 1 to 365.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Required: Algorithm; Required: Recovery point types; \n IncludeVaults(one or more). Optional: SelectionWindowDays \n ('30' if not specified);ExcludeVaults (list of selectors), \n defaults to empty list if not listed.

" + } + }, + "com.amazonaws.backup#RestoreTestingRecoveryPointSelectionAlgorithm": { + "type": "enum", + "members": { + "LATEST_WITHIN_WINDOW": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "COMPLETED" + "smithy.api#enumValue": "LATEST_WITHIN_WINDOW" } }, - "FAILED": { + "RANDOM_WITHIN_WINDOW": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "FAILED" + "smithy.api#enumValue": "RANDOM_WITHIN_WINDOW" } - }, - "AGGREGATE_ALL": { + } + } + }, + "com.amazonaws.backup#RestoreTestingRecoveryPointType": { + "type": "enum", + "members": { + "CONTINUOUS": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "AGGREGATE_ALL" + "smithy.api#enumValue": "CONTINUOUS" } }, - "ANY": { + "SNAPSHOT": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "ANY" + "smithy.api#enumValue": "SNAPSHOT" } } } }, - "com.amazonaws.backup#RestoreJobStatus": { - "type": "enum", + "com.amazonaws.backup#RestoreTestingRecoveryPointTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.backup#RestoreTestingRecoveryPointType" + } + }, + "com.amazonaws.backup#RestoreTestingSelectionForCreate": { + "type": "structure", "members": { - "PENDING": { - "target": "smithy.api#Unit", + "IamRoleArn": { + "target": "smithy.api#String", "traits": { - "smithy.api#enumValue": "PENDING" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that \n Backup uses to create the target resource; \n for example: arn:aws:iam::123456789012:role/S3Access.\n

", + "smithy.api#required": {} } }, - "RUNNING": { - "target": "smithy.api#Unit", + "ProtectedResourceArns": { + "target": "com.amazonaws.backup#stringList", "traits": { - "smithy.api#enumValue": "RUNNING" + "smithy.api#documentation": "

Each protected resource can be filtered by its specific ARNs, such as \n ProtectedResourceArns: [\"arn:aws:...\", \"arn:aws:...\"] \n or by a wildcard: ProtectedResourceArns: [\"*\"], \n but not both.

" } }, - "COMPLETED": { - "target": "smithy.api#Unit", + "ProtectedResourceConditions": { + "target": "com.amazonaws.backup#ProtectedResourceConditions", "traits": { - "smithy.api#enumValue": "COMPLETED" + "smithy.api#documentation": "

If you have included the wildcard in ProtectedResourceArns, \n you can include resource conditions, such as \n ProtectedResourceConditions: { StringEquals: [{ key: \"XXXX\", \n value: \"YYYY\" }].

" } }, - "ABORTED": { - "target": "smithy.api#Unit", + "ProtectedResourceType": { + "target": "smithy.api#String", "traits": { - "smithy.api#enumValue": "ABORTED" + "smithy.api#documentation": "

The type of Amazon Web Services resource included in a restore \n testing selection; for \n example, an Amazon EBS volume or \n an Amazon RDS database.

\n

Supported resource types accepted include:

\n ", + "smithy.api#required": {} } }, - "FAILED": { - "target": "smithy.api#Unit", + "RestoreMetadataOverrides": { + "target": "com.amazonaws.backup#SensitiveStringMap", "traits": { - "smithy.api#enumValue": "FAILED" + "smithy.api#documentation": "

You can override certain restore metadata keys by including the parameter\n RestoreMetadataOverrides in the body of\n RestoreTestingSelection. Key values are not case sensitive.

\n

See the complete list of restore testing\n inferred metadata.

" + } + }, + "RestoreTestingSelectionName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

This is the unique name of the restore testing selection \n that belongs to the related restore testing plan.

", + "smithy.api#required": {} + } + }, + "ValidationWindowHours": { + "target": "com.amazonaws.backup#integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

This is amount of hours (1 to 168) available to run a validation script on the data. The\n data will be deleted upon the completion of the validation script or the end of the\n specified retention period, whichever comes first.

" } } + }, + "traits": { + "smithy.api#documentation": "

This contains metadata about a specific restore testing selection.

\n

ProtectedResourceType is required, such as Amazon EBS or \n Amazon EC2.

\n

This consists of RestoreTestingSelectionName,\n ProtectedResourceType, and one of the following:

\n \n

Each protected resource type can have one single value.

\n

A restore testing selection can include a wildcard value (\"*\") for\n ProtectedResourceArns along with ProtectedResourceConditions.\n Alternatively, you can include up to 30 specific protected resource ARNs in\n ProtectedResourceArns.

\n

\n ProtectedResourceConditions examples include as StringEquals \n and StringNotEquals.

" } }, - "com.amazonaws.backup#RestoreJobSummary": { + "com.amazonaws.backup#RestoreTestingSelectionForGet": { "type": "structure", "members": { - "Region": { - "target": "com.amazonaws.backup#Region", + "CreationTime": { + "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

The Amazon Web Services Regions within the job summary.

" + "smithy.api#documentation": "

The date and time that a restore testing selection was created, \n in Unix format and Coordinated Universal Time (UTC). The value of \n CreationTime is accurate to milliseconds. For example, \n the value 1516925490.087 represents Friday, January 26, \n 201812:11:30.087 AM.

", + "smithy.api#required": {} } }, - "AccountId": { - "target": "com.amazonaws.backup#AccountId", + "CreatorRequestId": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The account ID that owns the jobs within the summary.

" + "smithy.api#documentation": "

This identifies the request and allows failed requests to \n be retried without the risk of running the operation twice. \n If the request includes a CreatorRequestId that \n matches an existing backup plan, that plan is returned. This \n parameter is optional.

\n

If used, this parameter must contain 1 to 50 alphanumeric \n or '-_.' characters.

" } }, - "State": { - "target": "com.amazonaws.backup#RestoreJobState", + "IamRoleArn": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

This value is job count for jobs \n with the specified state.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that \n Backup uses to create the target resource; for \n example:arn:aws:iam::123456789012:role/S3Access.

", + "smithy.api#required": {} } }, - "ResourceType": { - "target": "com.amazonaws.backup#ResourceType", + "ProtectedResourceArns": { + "target": "com.amazonaws.backup#stringList", "traits": { - "smithy.api#documentation": "

This value is the job count for the specified resource type. \n The request GetSupportedResourceTypes returns \n strings for supported resource types.

" + "smithy.api#documentation": "

You can include specific ARNs, such as \n ProtectedResourceArns: [\"arn:aws:...\", \"arn:aws:...\"] \n or you can include a wildcard: ProtectedResourceArns: [\"*\"], \n but not both.

" } }, - "Count": { - "target": "com.amazonaws.backup#integer", + "ProtectedResourceConditions": { + "target": "com.amazonaws.backup#ProtectedResourceConditions", "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The value as a number of jobs in a job summary.

" + "smithy.api#documentation": "

In a resource testing selection, this parameter filters by \n specific conditions such as StringEquals or \n StringNotEquals.

" } }, - "StartTime": { - "target": "com.amazonaws.backup#timestamp", + "ProtectedResourceType": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The value of time in number format of a job start time.

\n

This value is the time in Unix format, Coordinated Universal Time (UTC), and accurate to\n milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018\n 12:11:30.087 AM.

" + "smithy.api#documentation": "

The type of Amazon Web Services resource included in a resource \n testing selection; \n for example, an Amazon EBS volume \n or an Amazon RDS database.

", + "smithy.api#required": {} + } + }, + "RestoreMetadataOverrides": { + "target": "com.amazonaws.backup#SensitiveStringMap", + "traits": { + "smithy.api#documentation": "

You can override certain restore metadata keys by including the parameter\n RestoreMetadataOverrides in the body of\n RestoreTestingSelection. Key values are not case sensitive.

\n

See the complete list of restore testing\n inferred metadata.

" + } + }, + "RestoreTestingPlanName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The RestoreTestingPlanName is a unique string that is the name \n of the restore testing plan.

", + "smithy.api#required": {} + } + }, + "RestoreTestingSelectionName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

This is the unique name of the restore testing selection that \n belongs to the related restore testing plan.

", + "smithy.api#required": {} } }, - "EndTime": { - "target": "com.amazonaws.backup#timestamp", + "ValidationWindowHours": { + "target": "com.amazonaws.backup#integer", "traits": { - "smithy.api#documentation": "

The value of time in number format of a job end time.

\n

This value is the time in Unix format, Coordinated Universal Time (UTC), and accurate to\n milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018\n 12:11:30.087 AM.

" + "smithy.api#default": 0, + "smithy.api#documentation": "

This is amount of hours (1 to 168) available to run a validation script on the data. The\n data will be deleted upon the completion of the validation script or the end of the\n specified retention period, whichever comes first.

" } } }, "traits": { - "smithy.api#documentation": "

This is a summary of restore jobs created \n or running within the most recent 30 days.

\n

The returned summary may contain the following: \n Region, Account, State, ResourceType, MessageCategory, \n StartTime, EndTime, and Count of included jobs.

" - } - }, - "com.amazonaws.backup#RestoreJobSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.backup#RestoreJobSummary" - } - }, - "com.amazonaws.backup#RestoreJobsList": { - "type": "list", - "member": { - "target": "com.amazonaws.backup#RestoreJobsListMember" + "smithy.api#documentation": "

This contains metadata about a restore testing selection.

" } }, - "com.amazonaws.backup#RestoreJobsListMember": { + "com.amazonaws.backup#RestoreTestingSelectionForList": { "type": "structure", "members": { - "AccountId": { - "target": "com.amazonaws.backup#AccountId", + "CreationTime": { + "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

The account ID that owns the restore job.

" + "smithy.api#documentation": "

This is the date and time that a restore testing selection \n was created, in Unix format and Coordinated Universal Time (UTC). \n The value of CreationTime is accurate to milliseconds. \n For example, the value 1516925490.087 represents Friday, \n January 26,2018 12:11:30.087 AM.

", + "smithy.api#required": {} } }, - "RestoreJobId": { - "target": "com.amazonaws.backup#string", + "IamRoleArn": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

Uniquely identifies the job that restores a recovery point.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that \n Backup uses to create the target resource; for example: \n arn:aws:iam::123456789012:role/S3Access.

", + "smithy.api#required": {} } }, - "RecoveryPointArn": { - "target": "com.amazonaws.backup#ARN", + "ProtectedResourceType": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

An ARN that uniquely identifies a recovery point; for example,\n arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

" + "smithy.api#documentation": "

The type of Amazon Web Services resource included in a restore \n testing selection; for example, an \n Amazon EBS volume or an\n Amazon RDS database.

", + "smithy.api#required": {} } }, - "CreationDate": { - "target": "com.amazonaws.backup#timestamp", + "RestoreTestingPlanName": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The date and time a restore job is created, in Unix format and Coordinated Universal\n Time (UTC). The value of CreationDate is accurate to milliseconds. For\n example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.

" + "smithy.api#documentation": "

Unique string that is the name of the restore testing plan.

\n

The name cannot be changed after creation. The name must \n consist of only alphanumeric characters and underscores. \n Maximum length is 50.

", + "smithy.api#required": {} } }, - "CompletionDate": { - "target": "com.amazonaws.backup#timestamp", + "RestoreTestingSelectionName": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The date and time a job to restore a recovery point is completed, in Unix format and\n Coordinated Universal Time (UTC). The value of CompletionDate is accurate to\n milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018\n 12:11:30.087 AM.

" + "smithy.api#documentation": "

Unique name of a restore testing selection.

", + "smithy.api#required": {} } }, - "Status": { - "target": "com.amazonaws.backup#RestoreJobStatus", + "ValidationWindowHours": { + "target": "com.amazonaws.backup#integer", "traits": { - "smithy.api#documentation": "

A status code specifying the state of the job initiated by Backup to restore\n a recovery point.

" + "smithy.api#default": 0, + "smithy.api#documentation": "

This value represents the time, in hours, data is retained after \n a restore test so that optional validation can be completed.

\n

Accepted value is an integer between \n 0 and 168 (the hourly equivalent of seven days).

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This contains metadata about a restore testing selection.

" + } + }, + "com.amazonaws.backup#RestoreTestingSelectionForUpdate": { + "type": "structure", + "members": { + "IamRoleArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that \n Backup uses to create the target resource; for example: \n arn:aws:iam::123456789012:role/S3Access.

" } }, - "StatusMessage": { - "target": "com.amazonaws.backup#string", + "ProtectedResourceArns": { + "target": "com.amazonaws.backup#stringList", "traits": { - "smithy.api#documentation": "

A detailed message explaining the status of the job to restore a recovery point.

" + "smithy.api#documentation": "

You can include a list of specific ARNs, such as \n ProtectedResourceArns: [\"arn:aws:...\", \"arn:aws:...\"] \n or you can include a wildcard: ProtectedResourceArns: [\"*\"], \n but not both.

" } }, - "PercentDone": { - "target": "com.amazonaws.backup#string", + "ProtectedResourceConditions": { + "target": "com.amazonaws.backup#ProtectedResourceConditions", "traits": { - "smithy.api#documentation": "

Contains an estimated percentage complete of a job at the time the job status was\n queried.

" + "smithy.api#documentation": "

A list of conditions that you define for resources in \n your restore testing plan using tags.

\n

For example, \n \"StringEquals\": { \"Key\": \"aws:ResourceTag/CreatedByCryo\", \"Value\": \"true\" },. \n Condition operators are case sensitive.

" } }, - "BackupSizeInBytes": { - "target": "com.amazonaws.backup#Long", + "RestoreMetadataOverrides": { + "target": "com.amazonaws.backup#SensitiveStringMap", "traits": { - "smithy.api#documentation": "

The size, in bytes, of the restored resource.

" + "smithy.api#documentation": "

You can override certain restore metadata keys by including the parameter\n RestoreMetadataOverrides in the body of\n RestoreTestingSelection. Key values are not case sensitive.

\n

See the complete list of restore testing\n inferred metadata.

" } }, - "IamRoleArn": { - "target": "com.amazonaws.backup#IAMRoleArn", + "ValidationWindowHours": { + "target": "com.amazonaws.backup#integer", "traits": { - "smithy.api#documentation": "

Specifies the IAM role ARN used to create the target recovery point; for example,\n arn:aws:iam::123456789012:role/S3Access.

" + "smithy.api#default": 0, + "smithy.api#documentation": "

This value represents the time, in hours, data is retained after \n a restore test so that optional validation can be completed.

\n

Accepted value is an integer between \n 0 and 168 (the hourly equivalent of seven days).

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This contains metadata about a restore testing selection.

" + } + }, + "com.amazonaws.backup#RestoreTestingSelections": { + "type": "list", + "member": { + "target": "com.amazonaws.backup#RestoreTestingSelectionForList" + } + }, + "com.amazonaws.backup#RestoreValidationStatus": { + "type": "enum", + "members": { + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" } }, - "ExpectedCompletionTimeMinutes": { - "target": "com.amazonaws.backup#Long", + "SUCCESSFUL": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The amount of time in minutes that a job restoring a recovery point is expected to\n take.

" + "smithy.api#enumValue": "SUCCESSFUL" } }, - "CreatedResourceArn": { - "target": "com.amazonaws.backup#ARN", + "TIMED_OUT": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN\n depends on the resource type.

" + "smithy.api#enumValue": "TIMED_OUT" } }, - "ResourceType": { - "target": "com.amazonaws.backup#ResourceType", + "VALIDATING": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The resource type of the listed restore jobs; for example, an Amazon Elastic Block Store\n (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.\n For Windows Volume Shadow Copy Service (VSS) backups, the only supported resource type is\n Amazon EC2.

" + "smithy.api#enumValue": "VALIDATING" } } + } + }, + "com.amazonaws.backup#SensitiveStringMap": { + "type": "map", + "key": { + "target": "smithy.api#String" + }, + "value": { + "target": "smithy.api#String" }, "traits": { - "smithy.api#documentation": "

Contains metadata about a restore job.

" + "smithy.api#sensitive": {} } }, "com.amazonaws.backup#ServiceUnavailableException": { @@ -11095,6 +12817,209 @@ "smithy.api#output": {} } }, + "com.amazonaws.backup#UpdateRestoreTestingPlan": { + "type": "operation", + "input": { + "target": "com.amazonaws.backup#UpdateRestoreTestingPlanInput" + }, + "output": { + "target": "com.amazonaws.backup#UpdateRestoreTestingPlanOutput" + }, + "errors": [ + { + "target": "com.amazonaws.backup#ConflictException" + }, + { + "target": "com.amazonaws.backup#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.backup#MissingParameterValueException" + }, + { + "target": "com.amazonaws.backup#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.backup#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

This request will send changes to your specified restore testing \n plan. RestoreTestingPlanName \n cannot be updated after it is created.

\n

\n RecoveryPointSelection can contain:

\n ", + "smithy.api#http": { + "method": "PUT", + "uri": "/restore-testing/plans/{RestoreTestingPlanName}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.backup#UpdateRestoreTestingPlanInput": { + "type": "structure", + "members": { + "RestoreTestingPlan": { + "target": "com.amazonaws.backup#RestoreTestingPlanForUpdate", + "traits": { + "smithy.api#documentation": "

Specifies the body of a restore testing plan.

", + "smithy.api#required": {} + } + }, + "RestoreTestingPlanName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

This is the restore testing plan name you wish to update.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.backup#UpdateRestoreTestingPlanOutput": { + "type": "structure", + "members": { + "CreationTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

This is the time the resource testing plan was \n created.

", + "smithy.api#required": {} + } + }, + "RestoreTestingPlanArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

Unique ARN (Amazon Resource Name) of the restore testing plan.

", + "smithy.api#required": {} + } + }, + "RestoreTestingPlanName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The name cannot be changed after creation. The name consists of \n only alphanumeric characters and underscores. Maximum length is 50.

", + "smithy.api#required": {} + } + }, + "UpdateTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

This is the time the update completed for the restore \n testing plan.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.backup#UpdateRestoreTestingSelection": { + "type": "operation", + "input": { + "target": "com.amazonaws.backup#UpdateRestoreTestingSelectionInput" + }, + "output": { + "target": "com.amazonaws.backup#UpdateRestoreTestingSelectionOutput" + }, + "errors": [ + { + "target": "com.amazonaws.backup#ConflictException" + }, + { + "target": "com.amazonaws.backup#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.backup#MissingParameterValueException" + }, + { + "target": "com.amazonaws.backup#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.backup#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Most elements except the RestoreTestingSelectionName \n can be updated with this request.

\n

\n RestoreTestingSelection can use either protected \n resource ARNs or conditions, but not both. That is, if your selection \n has ProtectedResourceArns, requesting an update with the \n parameter ProtectedResourceConditions will be \n unsuccessful.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/restore-testing/plans/{RestoreTestingPlanName}/selections/{RestoreTestingSelectionName}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.backup#UpdateRestoreTestingSelectionInput": { + "type": "structure", + "members": { + "RestoreTestingPlanName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The restore testing plan name is required to update the \n indicated testing plan.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "RestoreTestingSelection": { + "target": "com.amazonaws.backup#RestoreTestingSelectionForUpdate", + "traits": { + "smithy.api#documentation": "

To update your restore testing selection, you can use either \n protected resource ARNs or conditions, but not both. That is, if your \n selection has ProtectedResourceArns, requesting an update \n with the parameter ProtectedResourceConditions will be \n unsuccessful.

", + "smithy.api#required": {} + } + }, + "RestoreTestingSelectionName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

This is the required restore testing selection name of the restore \n testing selection you wish to update.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.backup#UpdateRestoreTestingSelectionOutput": { + "type": "structure", + "members": { + "CreationTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

This is the time the resource testing selection was \n updated successfully.

", + "smithy.api#required": {} + } + }, + "RestoreTestingPlanArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

Unique string that is the name of the restore testing plan.

", + "smithy.api#required": {} + } + }, + "RestoreTestingPlanName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

This is the restore testing plan with which the updated restore \n testing selection is associated.

", + "smithy.api#required": {} + } + }, + "RestoreTestingSelectionName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

This is the returned restore testing selection name.

", + "smithy.api#required": {} + } + }, + "UpdateTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

This is the time the update completed for the restore \n testing selection.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.backup#VaultNames": { "type": "list", "member": { diff --git a/codegen/sdk-codegen/aws-models/controltower.json b/codegen/sdk-codegen/aws-models/controltower.json index a274e87e101..db26a007f39 100644 --- a/codegen/sdk-codegen/aws-models/controltower.json +++ b/codegen/sdk-codegen/aws-models/controltower.json @@ -28,6 +28,9 @@ }, { "target": "com.amazonaws.controltower#UntagResource" + }, + { + "target": "com.amazonaws.controltower#UpdateEnabledControl" } ], "resources": [ @@ -67,7 +70,7 @@ "x-amzn-trace-id" ] }, - "smithy.api#documentation": "

These interfaces allow you to apply the Amazon Web Services library of pre-defined\n controls to your organizational units, programmatically. In Amazon Web Services Control Tower, the terms \"control\" and \"guardrail\" are synonyms.

\n

To call these APIs, you'll need to know:

\n \n

\n To get the controlIdentifier for your AWS Control Tower\n control:\n

\n

The controlIdentifier is an ARN that is specified for each\n control. You can view the controlIdentifier in the console on the Control details page, as well as in the documentation.

\n

The controlIdentifier is unique in each Amazon Web Services Region for each control. You can\n find the controlIdentifier for each Region and control in the Tables of control metadata in the Amazon Web Services Control Tower User Guide.\n

\n

A quick-reference list of control identifers for the Amazon Web Services Control Tower legacy Strongly recommended and\n Elective controls is given in Resource identifiers for\n APIs and controls in the Controls reference guide section\n of the Amazon Web Services Control Tower User Guide. Remember that Mandatory controls\n cannot be added or removed.

\n \n

\n ARN format:\n arn:aws:controltower:{REGION}::control/{CONTROL_NAME}\n

\n

\n Example:\n

\n

\n arn:aws:controltower:us-west-2::control/AWS-GR_AUTOSCALING_LAUNCH_CONFIG_PUBLIC_IP_DISABLED\n

\n \n

\n To get the targetIdentifier:\n

\n

The targetIdentifier is the ARN for an OU.

\n

In the Amazon Web Services Organizations console, you can find the ARN for the OU on the Organizational unit details page associated with that OU.

\n \n

\n OU ARN format:\n

\n

\n arn:${Partition}:organizations::${MasterAccountId}:ou/o-${OrganizationId}/ou-${OrganizationalUnitId}\n

\n \n

\n Details and examples\n

\n \n

To view the open source resource repository on GitHub, see aws-cloudformation/aws-cloudformation-resource-providers-controltower\n

\n

\n Recording API Requests\n

\n

Amazon Web Services Control Tower supports Amazon Web Services CloudTrail, a service that records Amazon Web Services API calls for your\n Amazon Web Services account and delivers log files to an Amazon S3 bucket. By using information collected by\n CloudTrail, you can determine which requests the Amazon Web Services Control Tower service received, who made\n the request and when, and so on. For more about Amazon Web Services Control Tower and its support for\n CloudTrail, see Logging Amazon Web Services Control Tower\n Actions with Amazon Web Services CloudTrail in the Amazon Web Services Control Tower User Guide. To learn more about\n CloudTrail, including how to turn it on and find your log files, see the Amazon Web Services CloudTrail User\n Guide.

", + "smithy.api#documentation": "

These interfaces allow you to apply the Amazon Web Services library of pre-defined\n controls to your organizational units, programmatically. In Amazon Web Services Control Tower, the terms \"control\" and \"guardrail\" are synonyms.

\n

To call these APIs, you'll need to know:

\n \n

\n To get the controlIdentifier for your Amazon Web Services Control Tower\n control:\n

\n

The controlIdentifier is an ARN that is specified for each\n control. You can view the controlIdentifier in the console on the Control details page, as well as in the documentation.

\n

The controlIdentifier is unique in each Amazon Web Services Region for each control. You can\n find the controlIdentifier for each Region and control in the Tables of control metadata in the Amazon Web Services Control Tower User Guide.\n

\n

A quick-reference list of control identifers for the Amazon Web Services Control Tower legacy Strongly recommended and\n Elective controls is given in Resource identifiers for\n APIs and controls in the Controls reference guide section\n of the Amazon Web Services Control Tower User Guide. Remember that Mandatory controls\n cannot be added or removed.

\n \n

\n ARN format:\n arn:aws:controltower:{REGION}::control/{CONTROL_NAME}\n

\n

\n Example:\n

\n

\n arn:aws:controltower:us-west-2::control/AWS-GR_AUTOSCALING_LAUNCH_CONFIG_PUBLIC_IP_DISABLED\n

\n \n

\n To get the targetIdentifier:\n

\n

The targetIdentifier is the ARN for an OU.

\n

In the Amazon Web Services Organizations console, you can find the ARN for the OU on the Organizational unit details page associated with that OU.

\n \n

\n OU ARN format:\n

\n

\n arn:${Partition}:organizations::${MasterAccountId}:ou/o-${OrganizationId}/ou-${OrganizationalUnitId}\n

\n \n

\n Details and examples\n

\n \n

To view the open source resource repository on GitHub, see aws-cloudformation/aws-cloudformation-resource-providers-controltower\n

\n

\n Recording API Requests\n

\n

Amazon Web Services Control Tower supports Amazon Web Services CloudTrail, a service that records Amazon Web Services API calls for your\n Amazon Web Services account and delivers log files to an Amazon S3 bucket. By using information collected by\n CloudTrail, you can determine which requests the Amazon Web Services Control Tower service received, who made\n the request and when, and so on. For more about Amazon Web Services Control Tower and its support for\n CloudTrail, see Logging Amazon Web Services Control Tower\n Actions with Amazon Web Services CloudTrail in the Amazon Web Services Control Tower User Guide. To learn more about\n CloudTrail, including how to turn it on and find your log files, see the Amazon Web Services CloudTrail User\n Guide.

", "smithy.api#title": "AWS Control Tower", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -957,7 +960,7 @@ } }, "traits": { - "smithy.api#documentation": "

Updating or deleting a resource can cause an inconsistent state.

", + "smithy.api#documentation": "

Updating or deleting the resource can cause an inconsistent state.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -1042,6 +1045,10 @@ { "name": "DISABLE_CONTROL", "value": "DISABLE_CONTROL" + }, + { + "name": "UPDATE_ENABLED_CONTROL", + "value": "UPDATE_ENABLED_CONTROL" } ] } @@ -1072,7 +1079,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new landing zone. This starts an asynchronous operation that creates and configures a landing zone \n based on the parameters specified in the manifest JSON file.

", + "smithy.api#documentation": "

Creates a new landing zone. This API call starts an asynchronous operation that creates and configures a landing zone, \n based on the parameters specified in the manifest JSON file.

", "smithy.api#http": { "code": 200, "method": "POST", @@ -1086,7 +1093,7 @@ "version": { "target": "com.amazonaws.controltower#LandingZoneVersion", "traits": { - "smithy.api#documentation": "

The landing zone version.

", + "smithy.api#documentation": "

The landing zone version, for example, 3.0.

", "smithy.api#required": {} } }, @@ -1115,14 +1122,14 @@ "arn": { "target": "com.amazonaws.controltower#Arn", "traits": { - "smithy.api#documentation": "

The ARN of the landing zone.

", + "smithy.api#documentation": "

The ARN of the landing zone resource.

", "smithy.api#required": {} } }, "operationIdentifier": { "target": "com.amazonaws.controltower#OperationIdentifier", "traits": { - "smithy.api#documentation": "

A unique identifier assigned to a CreateLandingZone operation. You can use this \n identifier as an input of GetLandingZoneOperation to check the operation's status.

", + "smithy.api#documentation": "

A unique identifier assigned to a CreateLandingZone operation. You can use this \n identifier as an input of GetLandingZoneOperation to check the operation's status.

", "smithy.api#required": {} } } @@ -1160,7 +1167,7 @@ } ], "traits": { - "smithy.api#documentation": "

This decommissions a landing zone. This starts an asynchronous operation that deletes Amazon Web Services Control Tower \n resources deployed in Amazon Web Services Control Tower managed accounts.

", + "smithy.api#documentation": "

Decommissions a landing zone. This API call starts an asynchronous operation that deletes Amazon Web Services Control Tower \n resources deployed in accounts managed by Amazon Web Services Control Tower.

", "smithy.api#http": { "code": 200, "method": "POST", @@ -1175,7 +1182,7 @@ "landingZoneIdentifier": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The unique identifier of the landing zone.

", + "smithy.api#documentation": "

The unique identifier of the landing zone.

", "smithy.api#required": {} } } @@ -1190,7 +1197,7 @@ "operationIdentifier": { "target": "com.amazonaws.controltower#OperationIdentifier", "traits": { - "smithy.api#documentation": "

A unique identifier assigned to a DeleteLandingZone operation. You can use this \n identifier as an input of GetLandingZoneOperation to check the operation's status.

", + "smithy.api#documentation": "

>A unique identifier assigned to a DeleteLandingZone operation. You can use this \n identifier as an input parameter of GetLandingZoneOperation to check the operation's status.

", "smithy.api#required": {} } } @@ -1245,7 +1252,7 @@ "controlIdentifier": { "target": "com.amazonaws.controltower#ControlIdentifier", "traits": { - "smithy.api#documentation": "

The ARN of the control. Only Strongly recommended and\n Elective controls are permitted, with the exception of the\n Region deny control. For information on how to find the controlIdentifier, see the overview page.

", + "smithy.api#documentation": "

The ARN of the control. Only Strongly recommended and\n Elective controls are permitted, with the exception of the\n landing zone Region deny control. For information on how to find the controlIdentifier, see the overview page.

", "smithy.api#required": {} } }, @@ -1305,12 +1312,12 @@ "driftStatus": { "target": "com.amazonaws.controltower#DriftStatus", "traits": { - "smithy.api#documentation": "

The drift status of the enabled control.

\n

Valid values:

\n " + "smithy.api#documentation": "

The drift status of the enabled control.

\n

Valid values:

\n " } } }, "traits": { - "smithy.api#documentation": "

The drift summary of the enabled control.

\n

Amazon Web Services Control Tower expects the enabled control\n configuration to include all supported and governed Regions. If the enabled control differs\n from the expected configuration, it is defined to be in a state of drift. You can repair this drift by resetting the enabled control.

" + "smithy.api#documentation": "

The drift summary of the enabled control.

\n

Amazon Web Services Control Tower expects the enabled control\n configuration to include all supported and governed Regions. If the enabled control differs\n from the expected configuration, it is defined to be in a state of drift. You can repair this drift by resetting the enabled control.

" } }, "com.amazonaws.controltower#EnableControl": { @@ -1359,7 +1366,7 @@ "controlIdentifier": { "target": "com.amazonaws.controltower#ControlIdentifier", "traits": { - "smithy.api#documentation": "

The ARN of the control. Only Strongly recommended and\n Elective controls are permitted, with the exception of the\n Region deny control. For information on how to find the controlIdentifier, see the overview page.

", + "smithy.api#documentation": "

The ARN of the control. Only Strongly recommended and\n Elective controls are permitted, with the exception of the\n landing zone Region deny control. For information on how to find the controlIdentifier, see the overview page.

", "smithy.api#required": {} } }, @@ -1375,6 +1382,12 @@ "traits": { "smithy.api#documentation": "

Tags to be applied to the EnabledControl resource.

" } + }, + "parameters": { + "target": "com.amazonaws.controltower#EnabledControlParameters", + "traits": { + "smithy.api#documentation": "

An array of EnabledControlParameter objects

" + } } } }, @@ -1434,12 +1447,74 @@ "traits": { "smithy.api#documentation": "

The drift status of the enabled control.

" } + }, + "parameters": { + "target": "com.amazonaws.controltower#EnabledControlParameterSummaries", + "traits": { + "smithy.api#documentation": "

Array of EnabledControlParameter objects.

" + } } }, "traits": { "smithy.api#documentation": "

Information about the enabled control.

" } }, + "com.amazonaws.controltower#EnabledControlParameter": { + "type": "structure", + "members": { + "key": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The key of a key/value pair. It is of type string.

", + "smithy.api#required": {} + } + }, + "value": { + "target": "smithy.api#Document", + "traits": { + "smithy.api#documentation": "

The value of a key/value pair. It can be of type array\n string, number, object, or boolean.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A set of parameters that configure the behavior of the enabled control. A key/value pair, where Key is of type String and Value is of type Document.

" + } + }, + "com.amazonaws.controltower#EnabledControlParameterSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.controltower#EnabledControlParameterSummary" + } + }, + "com.amazonaws.controltower#EnabledControlParameterSummary": { + "type": "structure", + "members": { + "key": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The key of a key/value pair.

", + "smithy.api#required": {} + } + }, + "value": { + "target": "smithy.api#Document", + "traits": { + "smithy.api#documentation": "

The value of a key/value pair.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Returns a summary of information about the parameters of an enabled control.

" + } + }, + "com.amazonaws.controltower#EnabledControlParameters": { + "type": "list", + "member": { + "target": "com.amazonaws.controltower#EnabledControlParameter" + } + }, "com.amazonaws.controltower#EnabledControlSummary": { "type": "structure", "members": { @@ -1458,7 +1533,7 @@ "targetIdentifier": { "target": "com.amazonaws.controltower#TargetIdentifier", "traits": { - "smithy.api#documentation": "

\n The ARN of the organizational unit.\n

" + "smithy.api#documentation": "

The ARN of the organizational unit.

" } }, "statusSummary": { @@ -1677,7 +1752,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns details about the landing zone. Displays a message in case of error.

", + "smithy.api#documentation": "

Returns details about the landing zone. Displays a message in case of error.

", "smithy.api#http": { "code": 200, "method": "POST", @@ -1692,7 +1767,7 @@ "landingZoneIdentifier": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The unique identifier of the landing zone.

", + "smithy.api#documentation": "

The unique identifier of the landing zone.

", "smithy.api#required": {} } } @@ -1727,7 +1802,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns the status of the specified landing zone operation. Details for an operation are available for \n X days.

", + "smithy.api#documentation": "

Returns the status of the specified landing zone operation. Details for an operation are available for \n 60 days.

", "smithy.api#http": { "code": 200, "method": "POST", @@ -1742,7 +1817,7 @@ "operationIdentifier": { "target": "com.amazonaws.controltower#OperationIdentifier", "traits": { - "smithy.api#documentation": "

A unique identifier assigned to a landing zone operation.

", + "smithy.api#documentation": "

A unique identifier assigned to a landing zone operation.

", "smithy.api#required": {} } } @@ -1757,7 +1832,7 @@ "operationDetails": { "target": "com.amazonaws.controltower#LandingZoneOperationDetail", "traits": { - "smithy.api#documentation": "

The landing zone operation details.

", + "smithy.api#documentation": "

Details about a landing zone operation.

", "smithy.api#required": {} } } @@ -1772,7 +1847,7 @@ "landingZone": { "target": "com.amazonaws.controltower#LandingZoneDetail", "traits": { - "smithy.api#documentation": "

Information about the landing zone.

", + "smithy.api#documentation": "

Information about the landing zone.

", "smithy.api#required": {} } } @@ -1792,7 +1867,7 @@ } }, "traits": { - "smithy.api#documentation": "

Unexpected error during processing of request.

", + "smithy.api#documentation": "

An unexpected error occurred during processing of a request.

", "smithy.api#error": "server", "smithy.api#httpError": 500, "smithy.api#retryable": {} @@ -1804,44 +1879,44 @@ "version": { "target": "com.amazonaws.controltower#LandingZoneVersion", "traits": { - "smithy.api#documentation": "

The landing zone's current deployed version.

", + "smithy.api#documentation": "

The landing zone's current deployed version.

", "smithy.api#required": {} } }, "manifest": { "target": "com.amazonaws.controltower#Manifest", "traits": { - "smithy.api#documentation": "

The landing zone manifest.yaml text file that specifies the landing zone configurations.

", + "smithy.api#documentation": "

The landing zone manifest.yaml text file that specifies the landing zone configurations.

", "smithy.api#required": {} } }, "arn": { "target": "com.amazonaws.controltower#Arn", "traits": { - "smithy.api#documentation": "

The ARN of the landing zone.

" + "smithy.api#documentation": "

The ARN of the landing zone.

" } }, "status": { "target": "com.amazonaws.controltower#LandingZoneStatus", "traits": { - "smithy.api#documentation": "

The landing zone deployment status.

\n

Valid values:

\n " + "smithy.api#documentation": "

The landing zone deployment status.

" } }, "latestAvailableVersion": { "target": "com.amazonaws.controltower#LandingZoneVersion", "traits": { - "smithy.api#documentation": "

The latest available version of the landing zone.

" + "smithy.api#documentation": "

The latest available version of the landing zone.

" } }, "driftStatus": { "target": "com.amazonaws.controltower#LandingZoneDriftStatusSummary", "traits": { - "smithy.api#documentation": "

The drift status of the landing zone.

" + "smithy.api#documentation": "

The drift status of the landing zone.

" } } }, "traits": { - "smithy.api#documentation": "

Information about the landing zone.

" + "smithy.api#documentation": "

Information about the landing zone.

" } }, "com.amazonaws.controltower#LandingZoneDriftStatus": { @@ -1872,7 +1947,7 @@ } }, "traits": { - "smithy.api#documentation": "

The drift status summary of the landing zone.

\n

If the landing zone differs from the expected configuration, it is defined to be in a state of \n drift. You can repair this drift by resetting the landing zone.

" + "smithy.api#documentation": "

The drift status summary of the landing zone.

\n

If the landing zone differs from the expected configuration, it is defined to be in a state of \n drift. You can repair this drift by resetting the landing zone.

" } }, "com.amazonaws.controltower#LandingZoneOperationDetail": { @@ -1887,30 +1962,30 @@ "startTime": { "target": "com.amazonaws.controltower#Timestamp", "traits": { - "smithy.api#documentation": "

The landing zone operation start time.

" + "smithy.api#documentation": "

The landing zone operation start time.

" } }, "endTime": { "target": "com.amazonaws.controltower#Timestamp", "traits": { - "smithy.api#documentation": "

The landing zone operation end time.

" + "smithy.api#documentation": "

The landing zone operation end time.

" } }, "status": { "target": "com.amazonaws.controltower#LandingZoneOperationStatus", "traits": { - "smithy.api#documentation": "

The landing zone operation status.

\n

Valid values:

\n " + "smithy.api#documentation": "

Valid values:

\n " } }, "statusMessage": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

If the operation result is FAILED, this string contains a message explaining why the operation failed.

" + "smithy.api#documentation": "

If the operation result is FAILED, this string contains a message explaining why the operation failed.

" } } }, "traits": { - "smithy.api#documentation": "

Information about a landing zone operation.

" + "smithy.api#documentation": "

Information about a landing zone operation.

" } }, "com.amazonaws.controltower#LandingZoneOperationStatus": { @@ -2038,12 +2113,12 @@ "arn": { "target": "com.amazonaws.controltower#Arn", "traits": { - "smithy.api#documentation": "

The ARN of the landing zone.

" + "smithy.api#documentation": "

The ARN of the landing zone.

" } } }, "traits": { - "smithy.api#documentation": "

Returns a summary of information about a landing zone.

" + "smithy.api#documentation": "

Returns a summary of information about a landing zone.

" } }, "com.amazonaws.controltower#LandingZoneVersion": { @@ -2134,7 +2209,7 @@ "nextToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

Retrieves the next page of results. If the string is empty, the current response is the\n end of the results.

" + "smithy.api#documentation": "

Retrieves the next page of results. If the string is empty, the response is the\n end of the results.

" } } } @@ -2162,7 +2237,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns the landing zone ARN for the landing zone deployed in your managed account. This API also \n creates an ARN for existing accounts that do not yet have a landing zone ARN.

\n

The return limit is one landing zone ARN.

", + "smithy.api#documentation": "

Returns the landing zone ARN for the landing zone deployed in your managed account. This API also \n creates an ARN for existing accounts that do not yet have a landing zone ARN.

\n

Returns one landing zone ARN.

", "smithy.api#http": { "code": 200, "method": "POST", @@ -2183,13 +2258,13 @@ "nextToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The token to continue the list from a previous API call with the same parameters.

" + "smithy.api#documentation": "

The token to continue the list from a previous API call with the same parameters.

" } }, "maxResults": { "target": "com.amazonaws.controltower#ListLandingZonesMaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of returned landing zone ARNs.

" + "smithy.api#documentation": "

The maximum number of returned landing zone ARNs, which is one.

" } } }, @@ -2212,7 +2287,7 @@ "landingZones": { "target": "com.amazonaws.controltower#LandingZoneSummaries", "traits": { - "smithy.api#documentation": "

The ARN of the landing zone.

", + "smithy.api#documentation": "

The ARN of the landing zone.

", "smithy.api#length": { "min": 0, "max": 1 @@ -2223,7 +2298,7 @@ "nextToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

Retrieves the next page of results. If the string is empty, the current response is the end of the results.

" + "smithy.api#documentation": "

Retrieves the next page of results. If the string is empty, the response is the end of the results.

" } } }, @@ -2324,7 +2399,7 @@ } }, "traits": { - "smithy.api#documentation": "

An Amazon Web Services Region in which Amazon Web Services Control Tower expects to find the control deployed.

\n

The expected Regions are based on the Regions that are governed by the landing zone. In\n certain cases, a control is not actually enabled in the Region as expected, such as during\n drift, or mixed governance.

" + "smithy.api#documentation": "

An Amazon Web Services Region in which Amazon Web Services Control Tower expects to find the control deployed.

\n

The expected Regions are based on the Regions that are governed by the landing zone. In\n certain cases, a control is not actually enabled in the Region as expected, such as during\n drift, or mixed governance.

" } }, "com.amazonaws.controltower#RegionName": { @@ -2365,7 +2440,7 @@ } ], "traits": { - "smithy.api#documentation": "

This API call resets a landing zone. It starts an asynchronous operation that resets the \n landing zone to the parameters specified in its original configuration.

", + "smithy.api#documentation": "

This API call resets a landing zone. It starts an asynchronous operation that resets the \n landing zone to the parameters specified in its original configuration.

", "smithy.api#http": { "code": 200, "method": "POST", @@ -2379,7 +2454,7 @@ "landingZoneIdentifier": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The unique identifier of the landing zone.

", + "smithy.api#documentation": "

The unique identifier of the landing zone.

", "smithy.api#required": {} } } @@ -2394,7 +2469,7 @@ "operationIdentifier": { "target": "com.amazonaws.controltower#OperationIdentifier", "traits": { - "smithy.api#documentation": "

A unique identifier assigned to a ResetLandingZone operation. You can use this \n identifier as an input of GetLandingZoneOperation to check the operation's status.

", + "smithy.api#documentation": "

A unique identifier assigned to a ResetLandingZone operation. You can use this \n identifier as an input parameter of GetLandingZoneOperation to check the operation's status.

", "smithy.api#required": {} } } @@ -2414,7 +2489,7 @@ } }, "traits": { - "smithy.api#documentation": "

Request references a resource which does not exist.

", + "smithy.api#documentation": "

The request references a resource that does not exist.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } @@ -2430,7 +2505,7 @@ } }, "traits": { - "smithy.api#documentation": "

Request would cause a service quota to be exceeded. The limit is 10 concurrent operations.

", + "smithy.api#documentation": "

The request would cause a service quota to be exceeded. The limit is 10 concurrent operations.

", "smithy.api#error": "client", "smithy.api#httpError": 402 } @@ -2566,7 +2641,7 @@ "serviceCode": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The ID of the service that is associated with the error.

" + "smithy.api#documentation": "

The ID of the service that is associated with the error.\n

" } }, "quotaCode": { @@ -2578,13 +2653,13 @@ "retryAfterSeconds": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The number of seconds the caller should wait before retrying.

", + "smithy.api#documentation": "

The number of seconds to wait before retrying.

", "smithy.api#httpHeader": "Retry-After" } } }, "traits": { - "smithy.api#documentation": "

Request was denied due to request throttling.

", + "smithy.api#documentation": "

The request was denied due to request throttling.

", "smithy.api#error": "client", "smithy.api#httpError": 429, "smithy.api#retryable": { @@ -2657,6 +2732,83 @@ "smithy.api#output": {} } }, + "com.amazonaws.controltower#UpdateEnabledControl": { + "type": "operation", + "input": { + "target": "com.amazonaws.controltower#UpdateEnabledControlInput" + }, + "output": { + "target": "com.amazonaws.controltower#UpdateEnabledControlOutput" + }, + "errors": [ + { + "target": "com.amazonaws.controltower#AccessDeniedException" + }, + { + "target": "com.amazonaws.controltower#ConflictException" + }, + { + "target": "com.amazonaws.controltower#InternalServerException" + }, + { + "target": "com.amazonaws.controltower#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.controltower#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.controltower#ThrottlingException" + }, + { + "target": "com.amazonaws.controltower#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

\n Updates the configuration of an already enabled control.

\n

If the enabled control shows an EnablementStatus of SUCCEEDED, supply parameters that are different from the currently configured parameters. Otherwise, Amazon Web Services Control Tower will not accept the request.

\n

If the enabled control shows an EnablementStatus of FAILED, Amazon Web Services Control Tower will update the control to match any valid parameters that you supply.

\n

If the DriftSummary status for the control shows as DRIFTED, you cannot call this API. Instead, you can update the control by calling DisableControl and again calling EnableControl, or you can run an extending governance operation. For usage examples, see \n the Amazon Web Services Control Tower User Guide\n \n

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/update-enabled-control" + } + } + }, + "com.amazonaws.controltower#UpdateEnabledControlInput": { + "type": "structure", + "members": { + "parameters": { + "target": "com.amazonaws.controltower#EnabledControlParameters", + "traits": { + "smithy.api#documentation": "

A key/value pair, where Key is of type String and Value is of type Document.

", + "smithy.api#required": {} + } + }, + "enabledControlIdentifier": { + "target": "com.amazonaws.controltower#Arn", + "traits": { + "smithy.api#documentation": "

\n The ARN of the enabled control that will be updated.\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.controltower#UpdateEnabledControlOutput": { + "type": "structure", + "members": { + "operationIdentifier": { + "target": "com.amazonaws.controltower#OperationIdentifier", + "traits": { + "smithy.api#documentation": "

\n The operation identifier for this UpdateEnabledControl operation.\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.controltower#UpdateLandingZone": { "type": "operation", "input": { @@ -2686,7 +2838,7 @@ } ], "traits": { - "smithy.api#documentation": "

This API call updates the landing zone. It starts an asynchronous operation that updates the \n landing zone based on the new landing zone version or the updated parameters specified in the \n updated manifest file.

", + "smithy.api#documentation": "

This API call updates the landing zone. It starts an asynchronous operation that updates the \n landing zone based on the new landing zone version, or on the changed parameters specified in the \n updated manifest file.

", "smithy.api#http": { "code": 200, "method": "POST", @@ -2700,21 +2852,21 @@ "version": { "target": "com.amazonaws.controltower#LandingZoneVersion", "traits": { - "smithy.api#documentation": "

The landing zone version.

", + "smithy.api#documentation": "

The landing zone version, for example, 3.2.

", "smithy.api#required": {} } }, "manifest": { "target": "com.amazonaws.controltower#Manifest", "traits": { - "smithy.api#documentation": "

The manifest.yaml file is a text file that describes your Amazon Web Services resources. For examples, review \n The manifest file\n

", + "smithy.api#documentation": "

The manifest.yaml file is a text file that describes your Amazon Web Services resources. For examples, review \n The manifest file.

", "smithy.api#required": {} } }, "landingZoneIdentifier": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The unique identifier of the landing zone.

", + "smithy.api#documentation": "

The unique identifier of the landing zone.

", "smithy.api#required": {} } } @@ -2749,7 +2901,7 @@ } }, "traits": { - "smithy.api#documentation": "

The input fails to satisfy the constraints specified by an Amazon Web Services service.

", + "smithy.api#documentation": "

The input does not satisfy the constraints specified by an Amazon Web Services service.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } diff --git a/codegen/sdk-codegen/aws-models/efs.json b/codegen/sdk-codegen/aws-models/efs.json index 513b4f8326a..e40d01229c1 100644 --- a/codegen/sdk-codegen/aws-models/efs.json +++ b/codegen/sdk-codegen/aws-models/efs.json @@ -289,6 +289,22 @@ "smithy.api#pattern": "^.+$" } }, + "com.amazonaws.efs#ConflictException": { + "type": "structure", + "members": { + "ErrorCode": { + "target": "com.amazonaws.efs#ErrorCode" + }, + "Message": { + "target": "com.amazonaws.efs#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

Returned if the source file system in a replication is encrypted but the destination file system is unencrypted.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, "com.amazonaws.efs#CreateAccessPoint": { "type": "operation", "input": { @@ -598,6 +614,9 @@ { "target": "com.amazonaws.efs#BadRequest" }, + { + "target": "com.amazonaws.efs#ConflictException" + }, { "target": "com.amazonaws.efs#FileSystemLimitExceeded" }, @@ -627,7 +646,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a replication configuration that replicates an existing EFS file system\n to a new, read-only file system. For more information, see Amazon EFS replication in the\n Amazon EFS User Guide. The replication configuration\n specifies the following:

\n \n

The following properties are set by default:

\n \n

The following properties are turned off by default:

\n \n

For more information, see Amazon EFS replication in the\n Amazon EFS User Guide.

", + "smithy.api#documentation": "

Creates a replication configuration that replicates an existing EFS file system\n to a new, read-only file system. For more information, see Amazon EFS replication in the\n Amazon EFS User Guide. The replication configuration\n specifies the following:

\n \n \n

After the file system is created, you cannot change the KMS key.

\n \n

For new destination file systems, the following properties are set by default:

\n \n \n

For more information, see Amazon EFS replication in the\n Amazon EFS User Guide.

", "smithy.api#http": { "method": "POST", "uri": "/2015-02-01/file-systems/{SourceFileSystemId}/replication-configuration", @@ -995,7 +1014,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes an existing replication configuration. Deleting a replication configuration ends the replication process. After a\n replication configuration is deleted, the destination file system is no longer read-only. You\n can write to the destination file system after its status becomes\n Writeable.

", + "smithy.api#documentation": "

Deletes a replication configuration. Deleting a replication configuration ends the\n replication process. After a replication configuration is deleted, the destination file system\n becomes Writeable and its replication overwrite protection is re-enabled. For\n more information, see Delete a replication configuration.

\n

This operation requires permissions for the\n elasticfilesystem:DeleteReplicationConfiguration action.

", "smithy.api#http": { "method": "DELETE", "uri": "/2015-02-01/file-systems/{SourceFileSystemId}/replication-configuration", @@ -1474,7 +1493,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns the current LifecycleConfiguration object for the specified Amazon\n EFS file system. Llifecycle management uses the LifecycleConfiguration object to\n identify when to move files between storage classes. For a file system without a\n LifecycleConfiguration object, the call returns an empty array in the\n response.

\n

This operation requires permissions for the\n elasticfilesystem:DescribeLifecycleConfiguration operation.

", + "smithy.api#documentation": "

Returns the current LifecycleConfiguration object for the specified Amazon\n EFS file system. Lifecycle management uses the LifecycleConfiguration object\n to identify when to move files between storage classes. For a file system without a\n LifecycleConfiguration object, the call returns an empty array in the\n response.

\n

This operation requires permissions for the\n elasticfilesystem:DescribeLifecycleConfiguration operation.

", "smithy.api#examples": [ { "title": "To describe the lifecycle configuration for a file system", @@ -1979,12 +1998,18 @@ "KmsKeyId": { "target": "com.amazonaws.efs#KmsKeyId", "traits": { - "smithy.api#documentation": "

Specifies the Key Management Service (KMS) key that you want to use to\n encrypt the destination file system. If you do not specify a KMS key, Amazon EFS uses your default KMS key for Amazon EFS,\n /aws/elasticfilesystem. This ID can be in one of the following formats:

\n " + "smithy.api#documentation": "

Specify the Key Management Service (KMS) key that you want to use to\n encrypt the destination file system. If you do not specify a KMS key, Amazon EFS uses your default KMS key for Amazon EFS,\n /aws/elasticfilesystem. This ID can be in one of the following formats:

\n " + } + }, + "FileSystemId": { + "target": "com.amazonaws.efs#FileSystemId", + "traits": { + "smithy.api#documentation": "

The ID of the file system to use for the destination. The file system's replication\n overwrite replication must be disabled. If you do not provide an ID, then EFS creates a new\n file system for the replication destination.

" } } }, "traits": { - "smithy.api#documentation": "

Describes the destination file system to create in the replication configuration.

" + "smithy.api#documentation": "

Describes the new or existing destination file system for the replication\n configuration.

" } }, "com.amazonaws.efs#Destinations": { @@ -2159,6 +2184,12 @@ "smithy.api#documentation": "

The tags associated with the file system, presented as an array of Tag\n objects.

", "smithy.api#required": {} } + }, + "FileSystemProtection": { + "target": "com.amazonaws.efs#FileSystemProtectionDescription", + "traits": { + "smithy.api#documentation": "

Describes the protection on the file system.

" + } } }, "traits": { @@ -2263,6 +2294,20 @@ } } }, + "com.amazonaws.efs#FileSystemProtectionDescription": { + "type": "structure", + "members": { + "ReplicationOverwriteProtection": { + "target": "com.amazonaws.efs#ReplicationOverwriteProtection", + "traits": { + "smithy.api#documentation": "

The status of the file system's replication overwrite protection.

\n \n

If the replication configuration is deleted, the file system's replication overwrite\n protection is re-enabled, the file system becomes writeable.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the protection on a file system.

" + } + }, "com.amazonaws.efs#FileSystemSize": { "type": "structure", "members": { @@ -2539,7 +2584,7 @@ } }, "traits": { - "smithy.api#documentation": "

Describes a policy used by Lifecycle management that specifies when to transition files\n into and out of the Infrequent Access (IA) and Archive storage\n classes. For more information, see Managing file system storage.

\n \n

When using the put-lifecycle-configuration CLI command or the\n PutLifecycleConfiguration API action, Amazon EFS requires that each\n LifecyclePolicy object have only a single transition. This means that in a\n request body, LifecyclePolicies must be structured as an array of\n LifecyclePolicy objects, one object for each transition. For more\n information, see the request examples in PutLifecycleConfiguration.

\n " + "smithy.api#documentation": "

Describes a policy used by Lifecycle management that specifies when to transition files\n into and out of storage classes. For more information, see Managing file system\n storage.

\n \n

When using the put-lifecycle-configuration CLI command or the\n PutLifecycleConfiguration API action, Amazon EFS requires that each\n LifecyclePolicy object have only a single transition. This means that in a\n request body, LifecyclePolicies must be structured as an array of\n LifecyclePolicy objects, one object for each transition. For more\n information, see the request examples in PutLifecycleConfiguration.

\n " } }, "com.amazonaws.efs#ListTagsForResource": { @@ -2721,6 +2766,9 @@ }, { "target": "com.amazonaws.efs#UpdateFileSystem" + }, + { + "target": "com.amazonaws.efs#UpdateFileSystemProtection" } ], "traits": { @@ -4556,7 +4604,7 @@ } ], "traits": { - "smithy.api#documentation": "

Use this action to manage storage of your file system. A\n LifecycleConfiguration consists of one or more LifecyclePolicy\n objects that define the following:

\n \n

For more information, see \n Managing file system storage.

\n

Each Amazon EFS file system supports one lifecycle configuration, which applies to\n all files in the file system. If a LifecycleConfiguration object already exists\n for the specified file system, a PutLifecycleConfiguration call modifies the\n existing configuration. A PutLifecycleConfiguration call with an empty\n LifecyclePolicies array in the request body deletes any existing\n LifecycleConfiguration for the file system.

\n

In the request, specify the following:

\n \n

This operation requires permissions for the elasticfilesystem:PutLifecycleConfiguration operation.

\n

To apply a LifecycleConfiguration object to an encrypted file system, you\n need the same Key Management Service permissions as when you created the encrypted file system.

", + "smithy.api#documentation": "

Use this action to manage storage for your file system. A\n LifecycleConfiguration consists of one or more LifecyclePolicy\n objects that define the following:

\n \n \n

For more information, see Managing file system\n storage.

\n

Each Amazon EFS file system supports one lifecycle configuration, which applies to\n all files in the file system. If a LifecycleConfiguration object already exists\n for the specified file system, a PutLifecycleConfiguration call modifies the\n existing configuration. A PutLifecycleConfiguration call with an empty\n LifecyclePolicies array in the request body deletes any existing\n LifecycleConfiguration. In the request, specify the following:

\n \n

This operation requires permissions for the elasticfilesystem:PutLifecycleConfiguration operation.

\n

To apply a LifecycleConfiguration object to an encrypted file system, you\n need the same Key Management Service permissions as when you created the encrypted file system.

", "smithy.api#examples": [ { "title": "Creates a new lifecycleconfiguration object for a file system", @@ -4618,6 +4666,22 @@ "smithy.api#pattern": "^[a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-{0,1}[0-9]{0,1}$" } }, + "com.amazonaws.efs#ReplicationAlreadyExists": { + "type": "structure", + "members": { + "ErrorCode": { + "target": "com.amazonaws.efs#ErrorCode" + }, + "Message": { + "target": "com.amazonaws.efs#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

Returned if the file system is already included in a replication configuration.>

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, "com.amazonaws.efs#ReplicationConfigurationDescription": { "type": "structure", "members": { @@ -4693,6 +4757,29 @@ "smithy.api#httpError": 404 } }, + "com.amazonaws.efs#ReplicationOverwriteProtection": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + }, + "REPLICATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REPLICATING" + } + } + } + }, "com.amazonaws.efs#ReplicationStatus": { "type": "enum", "members": { @@ -5420,6 +5507,72 @@ } } }, + "com.amazonaws.efs#UpdateFileSystemProtection": { + "type": "operation", + "input": { + "target": "com.amazonaws.efs#UpdateFileSystemProtectionRequest" + }, + "output": { + "target": "com.amazonaws.efs#FileSystemProtectionDescription" + }, + "errors": [ + { + "target": "com.amazonaws.efs#BadRequest" + }, + { + "target": "com.amazonaws.efs#FileSystemNotFound" + }, + { + "target": "com.amazonaws.efs#IncorrectFileSystemLifeCycleState" + }, + { + "target": "com.amazonaws.efs#InsufficientThroughputCapacity" + }, + { + "target": "com.amazonaws.efs#InternalServerError" + }, + { + "target": "com.amazonaws.efs#ReplicationAlreadyExists" + }, + { + "target": "com.amazonaws.efs#ThroughputLimitExceeded" + }, + { + "target": "com.amazonaws.efs#TooManyRequests" + } + ], + "traits": { + "smithy.api#documentation": "

Updates protection on the file system.

\n

This operation requires permissions for the\n elasticfilesystem:UpdateFileSystemProtection action.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/2015-02-01/file-systems/{FileSystemId}/protection", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.efs#UpdateFileSystemProtectionRequest": { + "type": "structure", + "members": { + "FileSystemId": { + "target": "com.amazonaws.efs#FileSystemId", + "traits": { + "smithy.api#documentation": "

The ID of the file system to update.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ReplicationOverwriteProtection": { + "target": "com.amazonaws.efs#ReplicationOverwriteProtection", + "traits": { + "smithy.api#documentation": "

The status of the file system's replication overwrite protection.

\n \n

If the replication configuration is deleted, the file system's replication overwrite\n protection is re-enabled, the file system becomes writeable.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, "com.amazonaws.efs#UpdateFileSystemRequest": { "type": "structure", "members": { diff --git a/codegen/sdk-codegen/aws-models/fis.json b/codegen/sdk-codegen/aws-models/fis.json index a8d8ef40605..ada2101427a 100644 --- a/codegen/sdk-codegen/aws-models/fis.json +++ b/codegen/sdk-codegen/aws-models/fis.json @@ -29,6 +29,23 @@ ] }, "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": { @@ -274,7 +291,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an experiment template.

\n

An experiment template includes the following components:

\n \n

For more information, see Experiment templates\n in the Fault Injection Simulator User Guide.

", + "smithy.api#documentation": "

Creates an experiment template.

\n

An experiment template includes the following components:

\n \n

For more information, see experiment templates\n in the Fault Injection Simulator User Guide.

", "smithy.api#http": { "method": "POST", "uri": "/experimentTemplates", @@ -330,6 +347,26 @@ "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": { @@ -413,6 +450,12 @@ "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": { @@ -515,6 +558,95 @@ "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 Simulator User Guide.\n

", + "smithy.api#http": { + "method": "POST", + "uri": "/experimentTemplates/{experimentTemplateId}/targetAccountConfigurations/{accountId}", + "code": 200 + } + } + }, + "com.amazonaws.fis#CreateTargetAccountConfigurationRequest": { + "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": {} + } + }, + "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 AWS 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" }, @@ -573,6 +705,86 @@ "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 AWS 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": { @@ -657,6 +869,18 @@ "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": { @@ -869,6 +1093,12 @@ "traits": { "smithy.api#enumValue": "failed" } + }, + "skipped": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "skipped" + } } } }, @@ -954,6 +1184,26 @@ "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.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the options for an experiment.

" + } + }, "com.amazonaws.fis#ExperimentS3LogConfiguration": { "type": "structure", "members": { @@ -1168,6 +1418,64 @@ "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 AWS 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 AWS 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": { @@ -1339,6 +1647,18 @@ "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": { @@ -1515,6 +1835,26 @@ "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": { @@ -1851,33 +2191,54 @@ { "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#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" }, @@ -1895,6 +2256,9 @@ }, { "target": "com.amazonaws.fis#UpdateExperimentTemplate" + }, + { + "target": "com.amazonaws.fis#UpdateTargetAccountConfiguration" } ], "traits": { @@ -2702,6 +3066,69 @@ "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 AWS 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": { @@ -2757,6 +3184,69 @@ "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 AWS 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": { @@ -2893,6 +3383,170 @@ "smithy.api#output": {} } }, + "com.amazonaws.fis#ListExperimentResolvedTargets": { + "type": "operation", + "input": { + "target": "com.amazonaws.fis#ListExperimentResolvedTargetsRequest" + }, + "output": { + "target": "com.amazonaws.fis#ListExperimentResolvedTargetsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.fis#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.fis#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

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": { @@ -3096,6 +3750,95 @@ "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": { @@ -3187,6 +3930,38 @@ "smithy.api#pattern": "^[\\S]+$" } }, + "com.amazonaws.fis#ResolvedTarget": { + "type": "structure", + "members": { + "resourceType": { + "target": "com.amazonaws.fis#TargetResourceTypeId", + "traits": { + "smithy.api#documentation": "

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": { @@ -3510,6 +4285,131 @@ "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 AWS 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 AWS 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": { @@ -3760,6 +4660,20 @@ "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": { @@ -3832,6 +4746,12 @@ "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": { @@ -3934,6 +4854,81 @@ "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 AWS 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": { diff --git a/codegen/sdk-codegen/aws-models/glue.json b/codegen/sdk-codegen/aws-models/glue.json index 5a1be97a0f0..2ec741a47f5 100644 --- a/codegen/sdk-codegen/aws-models/glue.json +++ b/codegen/sdk-codegen/aws-models/glue.json @@ -1737,6 +1737,12 @@ "traits": { "smithy.api#enumValue": "performanceTuning.caching" } + }, + "ObservationsOption": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "observations.scope" + } } } }, @@ -6901,7 +6907,7 @@ "ConnectionType": { "target": "com.amazonaws.glue#EnclosedInStringProperty", "traits": { - "smithy.api#documentation": "

The connectionType, as provided to the underlying Glue library. This node type supports\nthe following connection types:

\n ", + "smithy.api#documentation": "

The connectionType, as provided to the underlying Glue library. This node type supports\nthe following connection types:

\n ", "smithy.api#required": {} } }, @@ -6936,7 +6942,7 @@ "ConnectionType": { "target": "com.amazonaws.glue#EnclosedInStringProperty", "traits": { - "smithy.api#documentation": "

The connectionType, as provided to the underlying Glue library. This node type supports\nthe following connection types:

\n ", + "smithy.api#documentation": "

The connectionType, as provided to the underlying Glue library. This node type supports\nthe following connection types:

\n ", "smithy.api#required": {} } }, diff --git a/codegen/sdk-codegen/aws-models/rds.json b/codegen/sdk-codegen/aws-models/rds.json index bb444720ab7..ff0b283d5d2 100644 --- a/codegen/sdk-codegen/aws-models/rds.json +++ b/codegen/sdk-codegen/aws-models/rds.json @@ -935,7 +935,7 @@ "name": "rds" }, "aws.protocols#awsQuery": {}, - "smithy.api#documentation": "Amazon Relational Database Service\n

\n

Amazon Relational Database Service (Amazon RDS) is a web service that makes it easier to set up, operate, and \n scale a relational database in the cloud. It provides cost-efficient, resizeable capacity for an industry-standard relational \n database and manages common database administration tasks, freeing up developers to focus on what makes their applications \n and businesses unique.

\n

Amazon RDS gives you access to the capabilities of a MySQL, MariaDB, PostgreSQL, Microsoft SQL Server, \n Oracle, or Amazon Aurora database server. These capabilities mean that the code, applications, and tools \n you already use today with your existing databases work with Amazon RDS without modification. Amazon RDS \n automatically backs up your database and maintains the database software that powers your DB instance. Amazon RDS \n is flexible: you can scale your DB instance's compute resources and storage capacity to meet your \n application's demand. As with all Amazon Web Services, there are no up-front investments, and you pay only for \n the resources you use.

\n

This interface reference for Amazon RDS contains documentation for a programming or command line interface \n you can use to manage Amazon RDS. Amazon RDS is asynchronous, which means that some interfaces might \n require techniques such as polling or callback functions to determine when a command has been applied. In this \n reference, the parameter descriptions indicate whether a command is applied immediately, on the next instance reboot, \n or during the maintenance window. The reference structure is as follows, and we list following some related topics \n from the user guide.

\n

\n Amazon RDS API Reference\n

\n \n

\n Amazon RDS User Guide\n

\n ", + "smithy.api#documentation": "Amazon Relational Database Service\n

\n

Amazon Relational Database Service (Amazon RDS) is a web service that makes it easier to set up, operate, and \n scale a relational database in the cloud. It provides cost-efficient, resizeable capacity for an industry-standard relational \n database and manages common database administration tasks, freeing up developers to focus on what makes their applications \n and businesses unique.

\n

Amazon RDS gives you access to the capabilities of a MySQL, MariaDB, PostgreSQL, Microsoft SQL Server, \n Oracle, Db2, or Amazon Aurora database server. These capabilities mean that the code, applications, and tools \n you already use today with your existing databases work with Amazon RDS without modification. Amazon RDS \n automatically backs up your database and maintains the database software that powers your DB instance. Amazon RDS \n is flexible: you can scale your DB instance's compute resources and storage capacity to meet your \n application's demand. As with all Amazon Web Services, there are no up-front investments, and you pay only for \n the resources you use.

\n

This interface reference for Amazon RDS contains documentation for a programming or command line interface \n you can use to manage Amazon RDS. Amazon RDS is asynchronous, which means that some interfaces might \n require techniques such as polling or callback functions to determine when a command has been applied. In this \n reference, the parameter descriptions indicate whether a command is applied immediately, on the next instance reboot, \n or during the maintenance window. The reference structure is as follows, and we list following some related topics \n from the user guide.

\n

\n Amazon RDS API Reference\n

\n \n

\n Amazon RDS User Guide\n

\n ", "smithy.api#title": "Amazon Relational Database Service", "smithy.api#xmlNamespace": { "uri": "http://rds.amazonaws.com/doc/2014-10-31/" @@ -4766,7 +4766,7 @@ "DBName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The meaning of this parameter differs according to the database engine you use.

\n

\n MySQL\n

\n

The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.

\n

Constraints:

\n \n

\n MariaDB\n

\n

The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.

\n

Constraints:

\n \n

\n PostgreSQL\n

\n

The name of the database to create when the DB instance is created. If this parameter isn't specified, a database named postgres \n is created in the DB instance.

\n

Constraints:

\n \n

\n Oracle\n

\n

The Oracle System ID (SID) of the created DB instance. If you don't specify a value, \n the default value is ORCL. You can't specify the \n string null, or any other reserved word, for DBName.

\n

Default: ORCL\n

\n

Constraints:

\n \n

\n Amazon RDS Custom for Oracle\n

\n

The Oracle System ID (SID) of the created RDS Custom DB instance.\n If you don't specify a value, the default value is ORCL for non-CDBs and\n RDSCDB for CDBs.

\n

Default: ORCL\n

\n

Constraints:

\n \n

\n Amazon RDS Custom for SQL Server\n

\n

Not applicable. Must be null.

\n

\n SQL Server\n

\n

Not applicable. Must be null.

\n

\n Amazon Aurora MySQL\n

\n

The name of the database to create when the primary DB instance of the Aurora MySQL DB cluster is\n created. If this parameter isn't specified for an Aurora MySQL DB cluster, no database is created \n in the DB cluster.

\n

Constraints:

\n \n

\n Amazon Aurora PostgreSQL\n

\n

The name of the database to create when the primary DB instance of the Aurora PostgreSQL DB cluster is\n created. If this parameter isn't specified for an Aurora PostgreSQL DB cluster, \n a database named postgres is created in the DB cluster.

\n

Constraints:

\n " + "smithy.api#documentation": "

The meaning of this parameter differs according to the database engine you use.

\n
\n
Amazon Aurora MySQL
\n
\n

The name of the database to create when the primary DB instance of the Aurora MySQL DB cluster is\n created. If this parameter isn't specified for an Aurora MySQL DB cluster, no database is created \n in the DB cluster.

\n

Constraints:

\n
    \n
  • \n

    Must contain 1 to 64 alphanumeric characters.

    \n
    • \n
  • \n

    Can't be a word reserved by the database engine.

    \n
    • \n
\n
\n
Amazon Aurora PostgreSQL
\n
\n

The name of the database to create when the primary DB instance of the Aurora PostgreSQL DB cluster is\n created. If this parameter isn't specified for an Aurora PostgreSQL DB cluster, \n a database named postgres is created in the DB cluster.

\n

Constraints:

\n
    \n
  • \n

    It must contain 1 to 63 alphanumeric characters.

    \n
    • \n
  • \n

    Must begin with a letter. Subsequent characters can be letters, underscores, or digits\n (0 to 9).

    \n
    • \n
  • \n

    Can't be a word reserved by the database engine.

    \n
    • \n
\n
\n
Amazon RDS Custom for Oracle
\n
\n

The Oracle System ID (SID) of the created RDS Custom DB instance. If you don't specify a value, the default value is ORCL for non-CDBs and\n RDSCDB for CDBs.

\n

Default: ORCL\n

\n

Constraints:

\n
    \n
  • \n

    Must contain 1 to 8 alphanumeric characters.

    \n
    • \n
  • \n

    Must contain a letter.

    \n
    • \n
  • \n

    Can't be a word reserved by the database engine.

    \n
    • \n
\n
\n
Amazon RDS Custom for SQL Server
\n
\n

Not applicable. Must be null.

\n
\n
RDS for Db2
\n
\n

The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.

\n

Constraints:

\n
    \n
  • \n

    Must contain 1 to 64 letters or numbers.

    \n
    • \n
  • \n

    Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).

    \n
    • \n
  • \n

    Can't be a word reserved by the specified database engine.

    \n
    • \n
\n
\n
RDS for MariaDB
\n
\n

The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.

\n

Constraints:

\n
    \n
  • \n

    Must contain 1 to 64 letters or numbers.

    \n
    • \n
  • \n

    Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).

    \n
    • \n
  • \n

    Can't be a word reserved by the specified database engine.

    \n
    • \n
\n
\n
RDS for MySQL
\n
\n

The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.

\n

Constraints:

\n
    \n
  • \n

    Must contain 1 to 64 letters or numbers.

    \n
    • \n
  • \n

    Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).

    \n
    • \n
  • \n

    Can't be a word reserved by the specified database engine.

    \n
    • \n
\n
\n
RDS for Oracle
\n
\n

The Oracle System ID (SID) of the created DB instance. If you don't specify a value, \n the default value is ORCL. You can't specify the \n string null, or any other reserved word, for DBName.

\n

Default: ORCL\n

\n

Constraints:

\n
    \n
  • \n

    Can't be longer than 8 characters.

    \n
    • \n
\n
\n
RDS for PostgreSQL
\n
\n

The name of the database to create when the DB instance is created. If this parameter isn't specified, a database named postgres \n is created in the DB instance.

\n

Constraints:

\n
    \n
  • \n

    Must contain 1 to 63 letters, numbers, or underscores.

    \n
    • \n
  • \n

    Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).

    \n
    • \n
  • \n

    Can't be a word reserved by the specified database engine.

    \n
    • \n
\n
\n
RDS for SQL Server
\n
\n

Not applicable. Must be null.

\n
\n
" } }, "DBInstanceIdentifier": { @@ -4780,7 +4780,7 @@ "AllocatedStorage": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The amount of storage in gibibytes (GiB) to allocate for the DB instance.

\n

This setting doesn't apply to Amazon Aurora DB instances. Aurora cluster volumes automatically grow as the amount of data in your \n database increases, though you are only charged for the space that you use in an Aurora cluster volume.

\n
\n
Amazon RDS Custom
\n
\n

Constraints to the amount of storage for each storage type are the following:

\n
    \n
  • \n

    General Purpose (SSD) storage (gp2, gp3): Must be an integer from 40 to 65536 for RDS Custom for Oracle, \n 16384 for RDS Custom for SQL Server.

    \n
    • \n
  • \n

    Provisioned IOPS storage (io1): Must be an integer from 40 to 65536 for RDS Custom for Oracle, \n 16384 for RDS Custom for SQL Server.

    \n
    • \n
\n
\n
RDS for MariaDB
\n
\n

Constraints to the amount of storage for each storage type are the following:

\n
    \n
  • \n

    General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.

    \n
    • \n
  • \n

    Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.

    \n
    • \n
  • \n

    Magnetic storage (standard): Must be an integer from 5 to 3072.

    \n
    • \n
\n
\n
RDS for MySQL
\n
\n

Constraints to the amount of storage for each storage type are the following:

\n
    \n
  • \n

    General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.

    \n
    • \n
  • \n

    Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.

    \n
    • \n
  • \n

    Magnetic storage (standard): Must be an integer from 5 to 3072.

    \n
    • \n
\n
\n
RDS for Oracle
\n
\n

Constraints to the amount of storage for each storage type are the following:

\n
    \n
  • \n

    General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.

    \n
    • \n
  • \n

    Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.

    \n
    • \n
  • \n

    Magnetic storage (standard): Must be an integer from 10 to 3072.

    \n
    • \n
\n
\n
RDS for PostgreSQL
\n
\n

Constraints to the amount of storage for each storage type are the following:

\n
    \n
  • \n

    General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.

    \n
    • \n
  • \n

    Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.

    \n
    • \n
  • \n

    Magnetic storage (standard): Must be an integer from 5 to 3072.

    \n
    • \n
\n
\n
RDS for SQL Server
\n
\n

Constraints to the amount of storage for each storage type are the following:

\n
    \n
  • \n

    General Purpose (SSD) storage (gp2, gp3):

    \n
      \n
    • \n

      Enterprise and Standard editions: Must be an integer from 20 to 16384.

      \n
      • \n
    • \n

      Web and Express editions: Must be an integer from 20 to 16384.

      \n
      • \n
    \n
    • \n
  • \n

    Provisioned IOPS storage (io1):

    \n
      \n
    • \n

      Enterprise and Standard editions: Must be an integer from 100 to 16384.

      \n
      • \n
    • \n

      Web and Express editions: Must be an integer from 100 to 16384.

      \n
      • \n
    \n
    • \n
  • \n

    Magnetic storage (standard):

    \n
      \n
    • \n

      Enterprise and Standard editions: Must be an integer from 20 to 1024.

      \n
      • \n
    • \n

      Web and Express editions: Must be an integer from 20 to 1024.

      \n
      • \n
    \n
    • \n
\n
\n
" + "smithy.api#documentation": "

The amount of storage in gibibytes (GiB) to allocate for the DB instance.

\n

This setting doesn't apply to Amazon Aurora DB instances. Aurora cluster volumes automatically grow as the amount of data in your \n database increases, though you are only charged for the space that you use in an Aurora cluster volume.

\n
\n
Amazon RDS Custom
\n
\n

Constraints to the amount of storage for each storage type are the following:

\n
    \n
  • \n

    General Purpose (SSD) storage (gp2, gp3): Must be an integer from 40 to 65536 for RDS Custom for Oracle, \n 16384 for RDS Custom for SQL Server.

    \n
    • \n
  • \n

    Provisioned IOPS storage (io1): Must be an integer from 40 to 65536 for RDS Custom for Oracle, \n 16384 for RDS Custom for SQL Server.

    \n
    • \n
\n
\n
RDS for Db2
\n
\n

Constraints to the amount of storage for each storage type are the following:

\n
    \n
  • \n

    General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 64000.

    \n
    • \n
  • \n

    Provisioned IOPS storage (io1): Must be an integer from 100 to 64000.

    \n
    • \n
\n
\n
RDS for MariaDB
\n
\n

Constraints to the amount of storage for each storage type are the following:

\n
    \n
  • \n

    General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.

    \n
    • \n
  • \n

    Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.

    \n
    • \n
  • \n

    Magnetic storage (standard): Must be an integer from 5 to 3072.

    \n
    • \n
\n
\n
RDS for MySQL
\n
\n

Constraints to the amount of storage for each storage type are the following:

\n
    \n
  • \n

    General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.

    \n
    • \n
  • \n

    Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.

    \n
    • \n
  • \n

    Magnetic storage (standard): Must be an integer from 5 to 3072.

    \n
    • \n
\n
\n
RDS for Oracle
\n
\n

Constraints to the amount of storage for each storage type are the following:

\n
    \n
  • \n

    General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.

    \n
    • \n
  • \n

    Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.

    \n
    • \n
  • \n

    Magnetic storage (standard): Must be an integer from 10 to 3072.

    \n
    • \n
\n
\n
RDS for PostgreSQL
\n
\n

Constraints to the amount of storage for each storage type are the following:

\n
    \n
  • \n

    General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.

    \n
    • \n
  • \n

    Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.

    \n
    • \n
  • \n

    Magnetic storage (standard): Must be an integer from 5 to 3072.

    \n
    • \n
\n
\n
RDS for SQL Server
\n
\n

Constraints to the amount of storage for each storage type are the following:

\n
    \n
  • \n

    General Purpose (SSD) storage (gp2, gp3):

    \n
      \n
    • \n

      Enterprise and Standard editions: Must be an integer from 20 to 16384.

      \n
      • \n
    • \n

      Web and Express editions: Must be an integer from 20 to 16384.

      \n
      • \n
    \n
    • \n
  • \n

    Provisioned IOPS storage (io1):

    \n
      \n
    • \n

      Enterprise and Standard editions: Must be an integer from 100 to 16384.

      \n
      • \n
    • \n

      Web and Express editions: Must be an integer from 100 to 16384.

      \n
      • \n
    \n
    • \n
  • \n

    Magnetic storage (standard):

    \n
      \n
    • \n

      Enterprise and Standard editions: Must be an integer from 20 to 1024.

      \n
      • \n
    • \n

      Web and Express editions: Must be an integer from 20 to 1024.

      \n
      • \n
    \n
    • \n
\n
\n
" } }, "DBInstanceClass": { @@ -4795,7 +4795,7 @@ "target": "com.amazonaws.rds#String", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The database engine to use for this DB instance.

\n

Not every database engine is available in every Amazon Web Services Region.

\n

Valid Values:

\n ", + "smithy.api#documentation": "

The database engine to use for this DB instance.

\n

Not every database engine is available in every Amazon Web Services Region.

\n

Valid Values:

\n ", "smithy.api#required": {} } }, @@ -4808,7 +4808,7 @@ "MasterUserPassword": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The password for the master user.

\n

This setting doesn't apply to Amazon Aurora DB instances. The password for the master user is managed by the DB\n cluster.

\n

Constraints:

\n \n

Length Constraints:

\n " + "smithy.api#documentation": "

The password for the master user.

\n

This setting doesn't apply to Amazon Aurora DB instances. The password for the master user is managed by the DB\n cluster.

\n

Constraints:

\n \n

Length Constraints:

\n " } }, "DBSecurityGroups": { @@ -4862,7 +4862,7 @@ "Port": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The port number on which the database accepts connections.

\n

This setting doesn't apply to Aurora DB instances. The port number is managed by the cluster.

\n

Valid Values: 1150-65535\n

\n

Default:

\n \n

Constraints:

\n " + "smithy.api#documentation": "

The port number on which the database accepts connections.

\n

This setting doesn't apply to Aurora DB instances. The port number is managed by the cluster.

\n

Valid Values: 1150-65535\n

\n

Default:

\n \n

Constraints:

\n " } }, "MultiAZ": { @@ -4874,7 +4874,7 @@ "EngineVersion": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The version number of the database engine to use.

\n

This setting doesn't apply to Amazon Aurora DB instances. The version number of the database engine the DB\n instance uses is managed by the DB cluster.

\n

For a list of valid engine versions, use the DescribeDBEngineVersions\n operation.

\n

The following are the database engines and links to information about the major and minor versions that are available with \n Amazon RDS. Not every database engine is available for every Amazon Web Services Region.

\n
\n
Amazon RDS Custom for Oracle
\n
\n

A custom engine version (CEV) that you have previously created. This setting is required for RDS Custom for Oracle. The CEV \n name has the following format: 19.customized_string. A valid CEV name is \n 19.my_cev1. For more information, see \n Creating an RDS Custom for Oracle DB instance in the Amazon RDS User Guide.

\n
\n
Amazon RDS Custom for SQL Server
\n
\n

See RDS Custom for SQL Server general requirements \n in the Amazon RDS User Guide.

\n
\n
RDS for MariaDB
\n
\n

For information, see MariaDB on Amazon RDS versions in the \n Amazon RDS User Guide.

\n
\n
RDS for Microsoft SQL Server
\n
\n

For information, see Microsoft SQL Server versions on Amazon RDS in the \n Amazon RDS User Guide.

\n
\n
RDS for MySQL
\n
\n

For information, see MySQL on Amazon RDS versions in the \n Amazon RDS User Guide.

\n
\n
RDS for Oracle
\n
\n

For information, see Oracle Database Engine release notes in the \n Amazon RDS User Guide.

\n
\n
RDS for PostgreSQL
\n
\n

For information, see Amazon RDS for PostgreSQL versions and extensions in the \n Amazon RDS User Guide.

\n
\n
" + "smithy.api#documentation": "

The version number of the database engine to use.

\n

This setting doesn't apply to Amazon Aurora DB instances. The version number of the database engine the DB\n instance uses is managed by the DB cluster.

\n

For a list of valid engine versions, use the DescribeDBEngineVersions\n operation.

\n

The following are the database engines and links to information about the major and minor versions that are available with \n Amazon RDS. Not every database engine is available for every Amazon Web Services Region.

\n
\n
Amazon RDS Custom for Oracle
\n
\n

A custom engine version (CEV) that you have previously created. This setting is required for RDS Custom for Oracle. The CEV \n name has the following format: 19.customized_string. A valid CEV name is \n 19.my_cev1. For more information, see \n Creating an RDS Custom for Oracle DB instance in the Amazon RDS User Guide.

\n
\n
Amazon RDS Custom for SQL Server
\n
\n

See RDS Custom for SQL Server general requirements \n in the Amazon RDS User Guide.

\n
\n
RDS for Db2
\n
\n

For information, see Db2 on Amazon RDS versions in the \n Amazon RDS User Guide.

\n
\n
RDS for MariaDB
\n
\n

For information, see MariaDB on Amazon RDS versions in the \n Amazon RDS User Guide.

\n
\n
RDS for Microsoft SQL Server
\n
\n

For information, see Microsoft SQL Server versions on Amazon RDS in the \n Amazon RDS User Guide.

\n
\n
RDS for MySQL
\n
\n

For information, see MySQL on Amazon RDS versions in the \n Amazon RDS User Guide.

\n
\n
RDS for Oracle
\n
\n

For information, see Oracle Database Engine release notes in the \n Amazon RDS User Guide.

\n
\n
RDS for PostgreSQL
\n
\n

For information, see Amazon RDS for PostgreSQL versions and extensions in the \n Amazon RDS User Guide.

\n
\n
" } }, "AutoMinorVersionUpgrade": { @@ -4886,13 +4886,13 @@ "LicenseModel": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The license model information for this DB instance.

\n

This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.

\n

Valid Values:

\n " + "smithy.api#documentation": "

The license model information for this DB instance.

\n

This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.

\n

Valid Values:

\n " } }, "Iops": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The amount of Provisioned IOPS (input/output operations per second) to initially allocate for the DB instance.\n For information about valid IOPS values, see \n Amazon RDS DB instance storage \n in the Amazon RDS User Guide.

\n

This setting doesn't apply to Amazon Aurora DB instances. Storage is managed by the DB cluster.

\n

Constraints:

\n " + "smithy.api#documentation": "

The amount of Provisioned IOPS (input/output operations per second) to initially allocate for the DB instance.\n For information about valid IOPS values, see \n Amazon RDS DB instance storage \n in the Amazon RDS User Guide.

\n

This setting doesn't apply to Amazon Aurora DB instances. Storage is managed by the DB cluster.

\n

Constraints:

\n " } }, "OptionGroupName": { @@ -4964,7 +4964,7 @@ "Domain": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The Active Directory directory ID to create the DB instance in. Currently, only Microsoft SQL \n Server, MySQL, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.

\n

For more information, see \n Kerberos Authentication in the Amazon RDS User Guide.

\n

This setting doesn't apply to the following DB instances:

\n " + "smithy.api#documentation": "

The Active Directory directory ID to create the DB instance in. Currently, you can create only Db2, MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.

\n

For more information, see \n Kerberos Authentication in the Amazon RDS User Guide.

\n

This setting doesn't apply to the following DB instances:

\n " } }, "DomainFqdn": { @@ -5054,7 +5054,7 @@ "EnableCloudwatchLogsExports": { "target": "com.amazonaws.rds#LogTypeList", "traits": { - "smithy.api#documentation": "

The list of log types that need to be enabled for exporting to CloudWatch Logs. For more information, see \n \n Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

\n

This setting doesn't apply to the following DB instances:

\n \n

The following values are valid for each DB engine:

\n " + "smithy.api#documentation": "

The list of log types to enable for exporting to CloudWatch Logs. For more information, see \n \n Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

\n

This setting doesn't apply to the following DB instances:

\n \n

The following values are valid for each DB engine:

\n " } }, "ProcessorFeatures": { @@ -5090,7 +5090,7 @@ "BackupTarget": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The location for storing automated backups and manual snapshots.

\n

Valie Values:

\n \n

Default: region\n

\n

For more information, see Working \n with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.

" + "smithy.api#documentation": "

The location for storing automated backups and manual snapshots.

\n

Valid Values:

\n \n

Default: region\n

\n

For more information, see Working \n with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.

" } }, "NetworkType": { @@ -5227,7 +5227,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new DB instance that acts as a read replica for an existing source DB\n instance or Multi-AZ DB cluster. You can create a read replica for a DB instance running\n MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server. You can create a read replica for a\n Multi-AZ DB cluster running MySQL or PostgreSQL. For more information, see Working\n with read replicas and Migrating from a Multi-AZ DB cluster to a DB instance using a read replica in the Amazon RDS User Guide.

\n

Amazon Aurora doesn't support this operation. To create a DB instance for an Aurora DB cluster, use the CreateDBInstance\n operation.

\n

All read replica DB instances are created with backups disabled. All other attributes\n (including DB security groups and DB parameter groups) are inherited from the source DB\n instance or cluster, except as specified.

\n \n

Your source DB instance or cluster must have backup retention enabled.

\n ", + "smithy.api#documentation": "

Creates a new DB instance that acts as a read replica for an existing source DB\n instance or Multi-AZ DB cluster. You can create a read replica for a DB instance running\n Db2, MariaDB, MySQL, Oracle, PostgreSQL, or SQL Server. You can create a read replica for a\n Multi-AZ DB cluster running MySQL or PostgreSQL. For more information, see Working\n with read replicas and Migrating from a Multi-AZ DB cluster to a DB instance using a read replica in the Amazon RDS User Guide.

\n

Amazon Aurora doesn't support this operation. To create a DB instance for an Aurora DB cluster, use the CreateDBInstance\n operation.

\n

All read replica DB instances are created with backups disabled. All other attributes\n (including DB security groups and DB parameter groups) are inherited from the source DB\n instance or cluster, except as specified.

\n \n

Your source DB instance or cluster must have backup retention enabled.

\n ", "smithy.api#examples": [ { "title": "To create a DB instance read replica", @@ -5263,7 +5263,7 @@ "SourceDBInstanceIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The identifier of the DB instance that will act as the source for the read replica.\n Each DB instance can have up to 15 read replicas, with the exception of Oracle and SQL\n Server, which can have up to five.

\n

Constraints:

\n " + "smithy.api#documentation": "

The identifier of the DB instance that will act as the source for the read replica.\n Each DB instance can have up to 15 read replicas, with the exception of Oracle and SQL\n Server, which can have up to five.

\n

Constraints:

\n " } }, "DBInstanceClass": { @@ -5596,7 +5596,7 @@ "target": "com.amazonaws.rds#String", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a database engine and engine version compatible with that DB parameter group family.

\n

To list all of the available parameter group families for a DB engine, use the following command:

\n

\n aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\" --engine \n

\n

For example, to list all of the available parameter group families for the MySQL DB engine, use the following command:

\n

\n aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\" --engine mysql\n

\n \n

The output contains duplicates.

\n \n

The following are the valid DB engine values:

\n ", + "smithy.api#documentation": "

The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a database engine and engine version compatible with that DB parameter group family.

\n

To list all of the available parameter group families for a DB engine, use the following command:

\n

\n aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\" --engine \n

\n

For example, to list all of the available parameter group families for the MySQL DB engine, use the following command:

\n

\n aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\" --engine mysql\n

\n \n

The output contains duplicates.

\n \n

The following are the valid DB engine values:

\n ", "smithy.api#required": {} } }, @@ -6518,7 +6518,7 @@ "target": "com.amazonaws.rds#String", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

Specifies the name of the engine that this option group should be associated with.

\n

Valid Values:

\n ", + "smithy.api#documentation": "

The name of the engine to associate this option group with.

\n

Valid Values:

\n ", "smithy.api#required": {} } }, @@ -9730,7 +9730,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains the result of a successful invocation of the \n ModifyDBParameterGroup or ResetDBParameterGroup action.

" + "smithy.api#documentation": "

Contains the result of a successful invocation of the \n ModifyDBParameterGroup or ResetDBParameterGroup operation.

" } }, "com.amazonaws.rds#DBParameterGroupNotFoundFault": { @@ -13953,7 +13953,7 @@ "Engine": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The database engine to return version details for.

\n

Valid Values:

\n " + "smithy.api#documentation": "

The database engine to return version details for.

\n

Valid Values:

\n " } }, "EngineVersion": { @@ -15730,7 +15730,7 @@ "target": "com.amazonaws.rds#String", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name of the DB parameter group family.

\n

Valid Values:

\n ", + "smithy.api#documentation": "

The name of the DB parameter group family.

\n

Valid Values:

\n ", "smithy.api#required": {} } }, @@ -16329,7 +16329,7 @@ "target": "com.amazonaws.rds#OptionGroupOptionsMessage" }, "traits": { - "smithy.api#documentation": "

Describes all available options.

", + "smithy.api#documentation": "

Describes all available options for the specified engine.

", "smithy.api#examples": [ { "title": "To describe all available options", @@ -16391,7 +16391,7 @@ "target": "com.amazonaws.rds#String", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

A required parameter. Options available for the given engine name are described.

\n

Valid Values:

\n ", + "smithy.api#documentation": "

The name of the engine to describe options for.

\n

Valid Values:

\n ", "smithy.api#required": {} } }, @@ -16501,7 +16501,7 @@ "EngineName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Filters the list of option groups to only include groups associated with a specific database engine.

\n

Valid Values:

\n " + "smithy.api#documentation": "

A filter to only include option groups associated with this database engine.

\n

Valid Values:

\n " } }, "MajorEngineVersion": { @@ -16525,7 +16525,7 @@ "target": "com.amazonaws.rds#OrderableDBInstanceOptionsMessage" }, "traits": { - "smithy.api#documentation": "

Returns a list of orderable DB instance options for the specified DB engine, DB engine version, and DB instance class.

", + "smithy.api#documentation": "

Describes the orderable DB instance options for a specified DB engine.

", "smithy.api#examples": [ { "title": "To describe orderable DB instance options", @@ -16585,32 +16585,32 @@ "target": "com.amazonaws.rds#String", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name of the engine to retrieve DB instance options for.

\n

Valid Values:

\n ", + "smithy.api#documentation": "

The name of the engine to describe DB instance options for.

\n

Valid Values:

\n ", "smithy.api#required": {} } }, "EngineVersion": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The engine version filter value. Specify this parameter to show only the available offerings matching the specified engine version.

" + "smithy.api#documentation": "

A filter to include only the available options for the specified engine version.

" } }, "DBInstanceClass": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class.

" + "smithy.api#documentation": "

A filter to include only the available options for the specified DB instance class.

" } }, "LicenseModel": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The license model filter value. Specify this parameter to show only the available offerings \n matching the specified license model.

\n

RDS Custom supports only the BYOL licensing model.

" + "smithy.api#documentation": "

A filter to include only the available options for the specified license model.

\n

RDS Custom supports only the BYOL licensing model.

" } }, "AvailabilityZoneGroup": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The Availability Zone group associated with a Local Zone. Specify this parameter to retrieve available offerings for the Local Zones in the group.

\n

Omit this parameter to show the available offerings in the specified Amazon Web Services Region.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

The Availability Zone group associated with a Local Zone. Specify this parameter to retrieve available options for the Local Zones in the group.

\n

Omit this parameter to show the available options in the specified Amazon Web Services Region.

\n

This setting doesn't apply to RDS Custom DB instances.

" } }, "Vpc": { @@ -19950,7 +19950,7 @@ } ], "traits": { - "smithy.api#documentation": "

Set the capacity of an Aurora Serverless v1 DB cluster to a specific value.

\n

Aurora Serverless v1 scales seamlessly based on the workload on the DB cluster. In some cases, the capacity might not scale \n fast enough to meet a sudden change in workload, such as a large number of new transactions. Call ModifyCurrentDBClusterCapacity \n to set the capacity explicitly.

\n

After this call sets the DB cluster capacity, Aurora Serverless v1 can automatically scale\n the DB cluster based on the cooldown period for scaling up and the cooldown period\n for scaling down.

\n

For more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the \n Amazon Aurora User Guide.

\n \n

If you call ModifyCurrentDBClusterCapacity with the default TimeoutAction, connections that \n prevent Aurora Serverless v1 from finding a scaling point might be dropped. For more information about scaling points, \n see \n Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide.

\n \n \n

This action only applies to Aurora Serverless v1 DB clusters.

\n ", + "smithy.api#documentation": "

Set the capacity of an Aurora Serverless v1 DB cluster to a specific value.

\n

Aurora Serverless v1 scales seamlessly based on the workload on the DB cluster. In some cases, the capacity might not scale \n fast enough to meet a sudden change in workload, such as a large number of new transactions. Call ModifyCurrentDBClusterCapacity \n to set the capacity explicitly.

\n

After this call sets the DB cluster capacity, Aurora Serverless v1 can automatically scale\n the DB cluster based on the cooldown period for scaling up and the cooldown period\n for scaling down.

\n

For more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the \n Amazon Aurora User Guide.

\n \n

If you call ModifyCurrentDBClusterCapacity with the default TimeoutAction, connections that \n prevent Aurora Serverless v1 from finding a scaling point might be dropped. For more information about scaling points, \n see \n Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide.

\n \n \n

This operation only applies to Aurora Serverless v1 DB clusters.

\n ", "smithy.api#examples": [ { "title": "To scale the capacity of an Aurora Serverless DB cluster", @@ -20213,7 +20213,7 @@ } ], "traits": { - "smithy.api#documentation": "

Modifies the properties of an endpoint in an Amazon Aurora DB cluster.

\n \n

This action only applies to Aurora DB clusters.

\n ", + "smithy.api#documentation": "

Modifies the properties of an endpoint in an Amazon Aurora DB cluster.

\n \n

This operation only applies to Aurora DB clusters.

\n ", "smithy.api#examples": [ { "title": "To modify a custom DB cluster endpoint", @@ -20563,7 +20563,7 @@ } ], "traits": { - "smithy.api#documentation": "

Modifies the parameters of a DB cluster parameter group. To modify more than one parameter,\n submit a list of the following: ParameterName, ParameterValue, \n and ApplyMethod. A maximum of 20\n parameters can be modified in a single request.

\n \n

After you create a DB cluster parameter group, you should wait at least 5 minutes\n before creating your first DB cluster that uses that DB cluster parameter group as the default parameter \n group. This allows Amazon RDS to fully complete the create action before the parameter \n group is used as the default for a new DB cluster. This is especially important for parameters \n that are critical when creating the default database for a DB cluster, such as the character set \n for the default database defined by the character_set_database parameter. You can use the \n Parameter Groups option of the Amazon RDS console or the \n DescribeDBClusterParameters operation to verify \n that your DB cluster parameter group has been created or modified.

\n

If the modified DB cluster parameter group is used by an Aurora Serverless v1 cluster, Aurora\n applies the update immediately. The cluster restart might interrupt your workload. In that case,\n your application must reopen any connections and retry any transactions that were active\n when the parameter changes took effect.

\n \n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.\n

", + "smithy.api#documentation": "

Modifies the parameters of a DB cluster parameter group. To modify more than one parameter,\n submit a list of the following: ParameterName, ParameterValue, \n and ApplyMethod. A maximum of 20\n parameters can be modified in a single request.

\n \n

After you create a DB cluster parameter group, you should wait at least 5 minutes\n before creating your first DB cluster that uses that DB cluster parameter group as the default parameter \n group. This allows Amazon RDS to fully complete the create operation before the parameter \n group is used as the default for a new DB cluster. This is especially important for parameters \n that are critical when creating the default database for a DB cluster, such as the character set \n for the default database defined by the character_set_database parameter. You can use the \n Parameter Groups option of the Amazon RDS console or the \n DescribeDBClusterParameters operation to verify \n that your DB cluster parameter group has been created or modified.

\n

If the modified DB cluster parameter group is used by an Aurora Serverless v1 cluster, Aurora\n applies the update immediately. The cluster restart might interrupt your workload. In that case,\n your application must reopen any connections and retry any transactions that were active\n when the parameter changes took effect.

\n \n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.\n

", "smithy.api#examples": [ { "title": "To modify parameters in a DB cluster parameter group", @@ -20859,7 +20859,7 @@ "AllocatedStorage": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The new amount of storage in gibibytes (GiB) to allocate for the DB instance.

\n

For RDS for MariaDB, RDS for MySQL, RDS for Oracle, and RDS for PostgreSQL, \n the value supplied must be at least 10% greater than the current value. \n Values that are not at least 10% greater than the existing value are rounded up \n so that they are 10% greater than the current value.

\n

For the valid values for allocated storage for each engine,\n see CreateDBInstance.

" + "smithy.api#documentation": "

The new amount of storage in gibibytes (GiB) to allocate for the DB instance.

\n

For RDS for Db2, MariaDB, RDS for MySQL, RDS for Oracle, and RDS for PostgreSQL, \n the value supplied must be at least 10% greater than the current value. \n Values that are not at least 10% greater than the existing value are rounded up \n so that they are 10% greater than the current value.

\n

For the valid values for allocated storage for each engine,\n see CreateDBInstance.

" } }, "DBInstanceClass": { @@ -20895,7 +20895,7 @@ "MasterUserPassword": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The new password for the master user.

\n

Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. \n Between the time of the request and the completion of the request,\n the MasterUserPassword element exists in the\n PendingModifiedValues element of the operation response.

\n \n

Amazon RDS API operations never return the password, \n so this action provides a way to regain access to a primary instance user if the password is lost. \n This includes restoring privileges that might have been accidentally revoked.

\n \n

This setting doesn't apply to the following DB instances:

\n \n

Default: Uses existing setting

\n

Constraints:

\n \n

Length Constraints:

\n " + "smithy.api#documentation": "

The new password for the master user.

\n

Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. \n Between the time of the request and the completion of the request,\n the MasterUserPassword element exists in the\n PendingModifiedValues element of the operation response.

\n \n

Amazon RDS API operations never return the password, \n so this operation provides a way to regain access to a primary instance user if the password is lost. \n This includes restoring privileges that might have been accidentally revoked.

\n \n

This setting doesn't apply to the following DB instances:

\n \n

Default: Uses existing setting

\n

Constraints:

\n \n

Length Constraints:

\n " } }, "DBParameterGroupName": { @@ -20949,7 +20949,7 @@ "LicenseModel": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The license model for the DB instance.

\n

This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.

\n

Valid Values:

\n " + "smithy.api#documentation": "

The license model for the DB instance.

\n

This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.

\n

Valid Values:

\n " } }, "Iops": { @@ -20997,7 +20997,7 @@ "Domain": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The Active Directory directory ID to move the DB instance to. \n Specify none to remove the instance from its current domain.\n You must create the domain before this operation. Currently, you can create only MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.

\n

For more information, see \n Kerberos Authentication in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom DB instances.

" + "smithy.api#documentation": "

The Active Directory directory ID to move the DB instance to. \n Specify none to remove the instance from its current domain.\n You must create the domain before this operation. Currently, you can create only Db2, MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.

\n

For more information, see \n Kerberos Authentication in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom DB instances.

" } }, "DomainFqdn": { @@ -21039,7 +21039,7 @@ "DBPortNumber": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The port number on which the database accepts connections.

\n

The value of the DBPortNumber parameter must not match any of the port values \n specified for options in the option group for the DB instance.

\n

If you change the DBPortNumber value, your database restarts regardless of \n the value of the ApplyImmediately parameter.

\n

This setting doesn't apply to RDS Custom DB instances.

\n

Valid Values: 1150-65535\n

\n

Default:

\n \n

Constraints:

\n " + "smithy.api#documentation": "

The port number on which the database accepts connections.

\n

The value of the DBPortNumber parameter must not match any of the port values \n specified for options in the option group for the DB instance.

\n

If you change the DBPortNumber value, your database restarts regardless of \n the value of the ApplyImmediately parameter.

\n

This setting doesn't apply to RDS Custom DB instances.

\n

Valid Values: 1150-65535\n

\n

Default:

\n \n

Constraints:

\n " } }, "PubliclyAccessible": { @@ -21244,7 +21244,7 @@ } ], "traits": { - "smithy.api#documentation": "

Modifies the parameters of a DB parameter group. To modify more than one parameter,\n submit a list of the following: ParameterName, ParameterValue, and \n ApplyMethod. A maximum of 20 parameters can be modified in a single request.

\n \n

After you modify a DB parameter group, you should wait at least 5 minutes\n before creating your first DB instance that uses that DB parameter group as the default parameter \n group. This allows Amazon RDS to fully complete the modify action before the parameter \n group is used as the default for a new DB instance. This is especially important for parameters \n that are critical when creating the default database for a DB instance, such as the character set \n for the default database defined by the character_set_database parameter. You can use the \n Parameter Groups option of the Amazon RDS console or the \n DescribeDBParameters command to verify \n that your DB parameter group has been created or modified.

\n ", + "smithy.api#documentation": "

Modifies the parameters of a DB parameter group. To modify more than one parameter,\n submit a list of the following: ParameterName, ParameterValue, and \n ApplyMethod. A maximum of 20 parameters can be modified in a single request.

\n \n

After you modify a DB parameter group, you should wait at least 5 minutes\n before creating your first DB instance that uses that DB parameter group as the default parameter \n group. This allows Amazon RDS to fully complete the modify operation before the parameter \n group is used as the default for a new DB instance. This is especially important for parameters \n that are critical when creating the default database for a DB instance, such as the character set \n for the default database defined by the character_set_database parameter. You can use the \n Parameter Groups option of the Amazon RDS console or the \n DescribeDBParameters command to verify \n that your DB parameter group has been created or modified.

\n ", "smithy.api#examples": [ { "title": "To modify a DB parameter group", @@ -21541,7 +21541,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates a manual DB snapshot with a new engine version. The snapshot can be encrypted\n or unencrypted, but not shared or public.\n \n

\n

Amazon RDS supports upgrading DB snapshots for MySQL, PostgreSQL, and Oracle. This command\n doesn't apply to RDS Custom.

", + "smithy.api#documentation": "

Updates a manual DB snapshot with a new engine version. The snapshot can be encrypted\n or unencrypted, but not shared or public.\n \n

\n

Amazon RDS supports upgrading DB snapshots for MySQL, PostgreSQL, and Oracle. This operation\n doesn't apply to RDS Custom or RDS for Db2.

", "smithy.api#examples": [ { "title": "To modify a DB snapshot", @@ -24114,7 +24114,7 @@ } ], "traits": { - "smithy.api#documentation": "

Detaches an Aurora secondary cluster from an Aurora global database cluster. The cluster becomes a\n standalone cluster with read-write capability instead of being read-only and receiving data from a\n primary cluster in a different Region.

\n \n

This action only applies to Aurora DB clusters.

\n ", + "smithy.api#documentation": "

Detaches an Aurora secondary cluster from an Aurora global database cluster. The cluster becomes a\n standalone cluster with read-write capability instead of being read-only and receiving data from a\n primary cluster in a different Region.

\n \n

This operation only applies to Aurora DB clusters.

\n ", "smithy.api#examples": [ { "title": "To detach an Aurora secondary cluster from an Aurora global database cluster", @@ -25001,7 +25001,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an Amazon Aurora DB cluster from MySQL data stored in an Amazon S3 bucket.\n Amazon RDS must be authorized to access the Amazon S3 bucket and the data must be\n created using the Percona XtraBackup utility as described in Migrating Data from MySQL by Using an Amazon S3 Bucket in the\n Amazon Aurora User Guide.

\n \n

This action only restores the DB cluster, not the DB instances for that DB\n cluster. You must invoke the CreateDBInstance action to create DB\n instances for the restored DB cluster, specifying the identifier of the restored DB\n cluster in DBClusterIdentifier. You can create DB instances only after\n the RestoreDBClusterFromS3 action has completed and the DB\n cluster is available.

\n \n

For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n \n

This action only applies to Aurora DB clusters. The source DB engine must be MySQL.

\n ", + "smithy.api#documentation": "

Creates an Amazon Aurora DB cluster from MySQL data stored in an Amazon S3 bucket.\n Amazon RDS must be authorized to access the Amazon S3 bucket and the data must be\n created using the Percona XtraBackup utility as described in Migrating Data from MySQL by Using an Amazon S3 Bucket in the\n Amazon Aurora User Guide.

\n \n

This operation only restores the DB cluster, not the DB instances for that DB\n cluster. You must invoke the CreateDBInstance operation to create DB\n instances for the restored DB cluster, specifying the identifier of the restored DB\n cluster in DBClusterIdentifier. You can create DB instances only after\n the RestoreDBClusterFromS3 operation has completed and the DB\n cluster is available.

\n \n

For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n \n

This operation only applies to Aurora DB clusters. The source DB engine must be MySQL.

\n ", "smithy.api#examples": [ { "title": "To restore an Amazon Aurora DB cluster from Amazon S3", @@ -25377,7 +25377,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new DB cluster from a DB snapshot or DB cluster snapshot.

\n

The target DB cluster is created from the source snapshot with a default\n configuration. If you don't specify a security group, the new DB cluster is\n associated with the default security group.

\n \n

This action only restores the DB cluster, not the DB instances for that DB\n cluster. You must invoke the CreateDBInstance action to create DB\n instances for the restored DB cluster, specifying the identifier of the restored DB\n cluster in DBClusterIdentifier. You can create DB instances only after\n the RestoreDBClusterFromSnapshot action has completed and the DB\n cluster is available.

\n \n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.\n

", + "smithy.api#documentation": "

Creates a new DB cluster from a DB snapshot or DB cluster snapshot.

\n

The target DB cluster is created from the source snapshot with a default\n configuration. If you don't specify a security group, the new DB cluster is\n associated with the default security group.

\n \n

This operation only restores the DB cluster, not the DB instances for that DB\n cluster. You must invoke the CreateDBInstance operation to create DB\n instances for the restored DB cluster, specifying the identifier of the restored DB\n cluster in DBClusterIdentifier. You can create DB instances only after\n the RestoreDBClusterFromSnapshot operation has completed and the DB\n cluster is available.

\n \n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.\n

", "smithy.api#examples": [ { "title": "To restore a DB cluster from a snapshot", @@ -25704,7 +25704,7 @@ } ], "traits": { - "smithy.api#documentation": "

Restores a DB cluster to an arbitrary point in time. Users can restore to any point\n in time before LatestRestorableTime for up to\n BackupRetentionPeriod days. The target DB cluster is created from the\n source DB cluster with the same configuration as the original DB cluster, except that\n the new DB cluster is created with the default DB security group.

\n \n

For Aurora, this action only restores the DB cluster, not the DB instances for that DB\n cluster. You must invoke the CreateDBInstance action to create DB\n instances for the restored DB cluster, specifying the identifier of the restored DB\n cluster in DBClusterIdentifier. You can create DB instances only after\n the RestoreDBClusterToPointInTime action has completed and the DB\n cluster is available.

\n \n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.\n

", + "smithy.api#documentation": "

Restores a DB cluster to an arbitrary point in time. Users can restore to any point\n in time before LatestRestorableTime for up to\n BackupRetentionPeriod days. The target DB cluster is created from the\n source DB cluster with the same configuration as the original DB cluster, except that\n the new DB cluster is created with the default DB security group.

\n \n

For Aurora, this operation only restores the DB cluster, not the DB instances for that DB\n cluster. You must invoke the CreateDBInstance operation to create DB\n instances for the restored DB cluster, specifying the identifier of the restored DB\n cluster in DBClusterIdentifier. You can create DB instances only after\n the RestoreDBClusterToPointInTime operation has completed and the DB\n cluster is available.

\n \n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.\n

", "smithy.api#examples": [ { "title": "To restore a DB cluster to a specified time", @@ -26036,7 +26036,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new DB instance from a DB snapshot. The target database is created from the source database restore point with most\n of the source's original configuration, including the default security group and DB parameter group. By default, the new DB\n instance is created as a Single-AZ deployment, except when the instance is a SQL Server instance that has an option group\n associated with mirroring. In this case, the instance becomes a Multi-AZ deployment, not a Single-AZ deployment.

\n

If you want to replace your original DB instance with the new, restored DB instance, then rename your original DB instance\n before you call the RestoreDBInstanceFromDBSnapshot action. RDS doesn't allow two DB instances with the same name. After you\n have renamed your original DB instance with a different identifier, then you can pass the original name of the DB instance as\n the DBInstanceIdentifier in the call to the RestoreDBInstanceFromDBSnapshot action. The result is that you replace the original\n DB instance with the DB instance created from the snapshot.

\n

If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier\n must be the ARN of the shared DB snapshot.

\n \n

This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterFromSnapshot.

\n ", + "smithy.api#documentation": "

Creates a new DB instance from a DB snapshot. The target database is created from the source database restore point with most\n of the source's original configuration, including the default security group and DB parameter group. By default, the new DB\n instance is created as a Single-AZ deployment, except when the instance is a SQL Server instance that has an option group\n associated with mirroring. In this case, the instance becomes a Multi-AZ deployment, not a Single-AZ deployment.

\n

If you want to replace your original DB instance with the new, restored DB instance, then rename your original DB instance\n before you call the RestoreDBInstanceFromDBSnapshot operation. RDS doesn't allow two DB instances with the same name. After you\n have renamed your original DB instance with a different identifier, then you can pass the original name of the DB instance as\n the DBInstanceIdentifier in the call to the RestoreDBInstanceFromDBSnapshot operation. The result is that you replace the original\n DB instance with the DB instance created from the snapshot.

\n

If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier\n must be the ARN of the shared DB snapshot.

\n \n

This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterFromSnapshot.

\n ", "smithy.api#examples": [ { "title": "To restore a DB instance from a DB snapshot", @@ -26077,14 +26077,14 @@ "target": "com.amazonaws.rds#String", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

Name of the DB instance to create from the DB snapshot. This parameter isn't case-sensitive.

\n

Constraints:

\n \n

Example: my-snapshot-id\n

", + "smithy.api#documentation": "

The name of the DB instance to create from the DB snapshot. This parameter isn't case-sensitive.

\n

Constraints:

\n \n

Example: my-snapshot-id\n

", "smithy.api#required": {} } }, "DBSnapshotIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The identifier for the DB snapshot to restore from.

\n

Constraints:

\n " + "smithy.api#documentation": "

The identifier for the DB snapshot to restore from.

\n

Constraints:

\n " } }, "DBInstanceClass": { @@ -26108,7 +26108,7 @@ "DBSubnetGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The DB subnet group name to use for the new instance.

\n

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

\n

Example: mydbsubnetgroup\n

" + "smithy.api#documentation": "

The name of the DB subnet group to use for the new instance.

\n

Constraints:

\n \n

Example: mydbsubnetgroup\n

" } }, "MultiAZ": { @@ -26138,13 +26138,13 @@ "DBName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The database name for the restored DB instance.

\n

This parameter doesn't apply to the MySQL, PostgreSQL, or MariaDB engines. It also doesn't apply to RDS\n Custom DB instances.

" + "smithy.api#documentation": "

The name of the database for the restored DB instance.

\n

This parameter only applies to RDS for Oracle and RDS for SQL Server DB instances. It doesn't apply to the other engines or to RDS\n Custom DB instances.

" } }, "Engine": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The database engine to use for the new instance.

\n

This setting doesn't apply to RDS Custom.

\n

Default: The same as source

\n

Constraint: Must be compatible with the engine of the source. For example, you can restore a MariaDB 10.1 DB instance from a MySQL 5.6 snapshot.

\n

Valid Values:

\n " + "smithy.api#documentation": "

The database engine to use for the new instance.

\n

This setting doesn't apply to RDS Custom.

\n

Default: The same as source

\n

Constraint: Must be compatible with the engine of the source. For example, you can restore a MariaDB 10.1 DB instance from a MySQL 5.6 snapshot.

\n

Valid Values:

\n " } }, "Iops": { @@ -26189,7 +26189,7 @@ "Domain": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Specify the Active Directory directory ID to restore the DB instance in.\n The domain/ must be created prior to this operation. Currently, you can create only MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.

\n

For more information, see \n Kerberos Authentication in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

The Active Directory directory ID to restore the DB instance in.\n The domain/ must be created prior to this operation. Currently, you can create only Db2, MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.

\n

For more information, see \n Kerberos Authentication in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom.

" } }, "DomainFqdn": { @@ -26237,7 +26237,7 @@ "EnableCloudwatchLogsExports": { "target": "com.amazonaws.rds#LogTypeList", "traits": { - "smithy.api#documentation": "

The list of logs that the restored DB instance is to export to CloudWatch Logs. The values\n in the list depend on the DB engine being used. For more information, see \n Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

The list of logs for the restored DB instance to export to CloudWatch Logs. The values\n in the list depend on the DB engine. For more information, see \n Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom.

" } }, "ProcessorFeatures": { @@ -26255,7 +26255,7 @@ "DBParameterGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of the DB parameter group to associate with this DB instance.

\n

If you don't specify a value for DBParameterGroupName, then RDS uses the default DBParameterGroup \n for the specified DB engine.

\n

This setting doesn't apply to RDS Custom.

\n

Constraints:

\n " + "smithy.api#documentation": "

The name of the DB parameter group to associate with this DB instance.

\n

If you don't specify a value for DBParameterGroupName, then RDS uses the default DBParameterGroup \n for the specified DB engine.

\n

This setting doesn't apply to RDS Custom.

\n

Constraints:

\n " } }, "DeletionProtection": { @@ -26394,7 +26394,7 @@ } ], "traits": { - "smithy.api#documentation": "

Amazon Relational Database Service (Amazon RDS) \n supports importing MySQL databases by using backup files. \n You can create a backup of your on-premises database, \n store it on Amazon Simple Storage Service (Amazon S3), \n and then restore the backup file onto a new Amazon RDS DB instance running MySQL.\n For more information, see Importing Data into an Amazon RDS MySQL DB Instance \n in the Amazon RDS User Guide.\n

\n

This command doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

Amazon Relational Database Service (Amazon RDS) \n supports importing MySQL databases by using backup files. \n You can create a backup of your on-premises database, \n store it on Amazon Simple Storage Service (Amazon S3), \n and then restore the backup file onto a new Amazon RDS DB instance running MySQL.\n For more information, see Importing Data into an Amazon RDS MySQL DB Instance \n in the Amazon RDS User Guide.\n

\n

This operation doesn't apply to RDS Custom.

" } }, "com.amazonaws.rds#RestoreDBInstanceFromS3Message": { @@ -26445,7 +26445,7 @@ "MasterUserPassword": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The password for the master user. \n The password can include any printable ASCII character except \"/\", \"\"\", or \"@\".

\n

Constraints: Can't be specified if ManageMasterUserPassword is turned on.

\n

\n MariaDB\n

\n

Constraints: Must contain from 8 to 41 characters.

\n

\n Microsoft SQL Server\n

\n

Constraints: Must contain from 8 to 128 characters.

\n

\n MySQL\n

\n

Constraints: Must contain from 8 to 41 characters.

\n

\n Oracle\n

\n

Constraints: Must contain from 8 to 30 characters.

\n

\n PostgreSQL\n

\n

Constraints: Must contain from 8 to 128 characters.

" + "smithy.api#documentation": "

The password for the master user.

\n

Constraints:

\n \n

Length Constraints:

\n " } }, "DBSecurityGroups": { @@ -26807,7 +26807,7 @@ } ], "traits": { - "smithy.api#documentation": "

Restores a DB instance to an arbitrary point in time. You can restore to any point in time before the time identified by the LatestRestorableTime property. You can restore to a point up to the number of days specified by the BackupRetentionPeriod property.

\n

The target database is created with most of the original configuration, but in a\n system-selected Availability Zone, with the default security group, the default subnet\n group, and the default DB parameter group. By default, the new DB instance is created as\n a single-AZ deployment except when the instance is a SQL Server instance that has an\n option group that is associated with mirroring; in this case, the instance becomes a\n mirrored deployment and not a single-AZ deployment.

\n \n

This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterToPointInTime.

\n ", + "smithy.api#documentation": "

Restores a DB instance to an arbitrary point in time. You can restore to any point in time before the time identified by the LatestRestorableTime property. You can restore to a point up to the number of days specified by the BackupRetentionPeriod property.

\n

The target database is created with most of the original configuration, but in a\n system-selected Availability Zone, with the default security group, the default subnet\n group, and the default DB parameter group. By default, the new DB instance is created as\n a single-AZ deployment except when the instance is a SQL Server instance that has an\n option group that is associated with mirroring; in this case, the instance becomes a\n mirrored deployment and not a single-AZ deployment.

\n \n

This operation doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterToPointInTime.

\n ", "smithy.api#examples": [ { "title": "To restore a DB instance to a point in time", @@ -26980,13 +26980,13 @@ "DBName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The database name for the restored DB instance.

\n \n

This parameter isn't supported for the MySQL or MariaDB engines. It also doesn't apply to RDS Custom.

\n " + "smithy.api#documentation": "

The database name for the restored DB instance.

\n

This parameter doesn't apply to the following DB instances:

\n " } }, "Engine": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The database engine to use for the new instance.

\n

This setting doesn't apply to RDS Custom.

\n

Valid Values:

\n \n

Default: The same as source

\n

Constraints:

\n " + "smithy.api#documentation": "

The database engine to use for the new instance.

\n

This setting doesn't apply to RDS Custom.

\n

Valid Values:

\n \n

Default: The same as source

\n

Constraints:

\n " } }, "Iops": { @@ -27139,7 +27139,7 @@ "BackupTarget": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Specifies where automated backups and manual snapshots are stored for the restored DB instance.

\n

Possible values are outposts (Amazon Web Services Outposts) and region (Amazon Web Services Region). The default is region.

\n

For more information, see Working \n with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.

" + "smithy.api#documentation": "

The location for storing automated backups and manual snapshots for the restored DB instance.

\n

Valid Values:

\n \n

Default: region\n

\n

For more information, see Working \n with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.

" } }, "NetworkType": { @@ -27860,7 +27860,7 @@ } ], "traits": { - "smithy.api#documentation": "

Starts an Amazon Aurora DB cluster that was stopped using the Amazon Web Services console, the stop-db-cluster\n CLI command, or the StopDBCluster action.

\n

For more information, see \n \n Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide.

\n \n

This action only applies to Aurora DB clusters.

\n ", + "smithy.api#documentation": "

Starts an Amazon Aurora DB cluster that was stopped using the Amazon Web Services console, the stop-db-cluster\n CLI command, or the StopDBCluster operation.

\n

For more information, see \n \n Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide.

\n \n

This operation only applies to Aurora DB clusters.

\n ", "smithy.api#examples": [ { "title": "To start a DB cluster", @@ -27956,7 +27956,7 @@ } ], "traits": { - "smithy.api#documentation": "

Starts an Amazon RDS DB instance that was stopped using the Amazon Web Services console, the stop-db-instance CLI command, or the StopDBInstance action.

\n

For more information, see \n \n Starting an Amazon RDS DB instance That Was Previously Stopped in the \n Amazon RDS User Guide.\n

\n \n

This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL.\n For Aurora DB clusters, use StartDBCluster instead.

\n ", + "smithy.api#documentation": "

Starts an Amazon RDS DB instance that was stopped using the Amazon Web Services console, the stop-db-instance CLI command, or the StopDBInstance operation.

\n

For more information, see \n \n Starting an Amazon RDS DB instance That Was Previously Stopped in the \n Amazon RDS User Guide.\n

\n \n

This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL.\n For Aurora DB clusters, use StartDBCluster instead.

\n ", "smithy.api#examples": [ { "title": "To start a DB instance", @@ -28148,7 +28148,7 @@ } ], "traits": { - "smithy.api#documentation": "

Starts an export of DB snapshot or DB cluster data to Amazon S3. \n The provided IAM role must have access to the S3 bucket.

\n

You can't export snapshot data from RDS Custom DB instances.

\n

You can't export cluster data from Multi-AZ DB clusters.

\n

For more information on exporting DB snapshot data, see \n Exporting DB snapshot \n data to Amazon S3 in the Amazon RDS User Guide\n or Exporting DB \n cluster snapshot data to Amazon S3 in the Amazon Aurora User Guide.

\n

For more information on exporting DB cluster data, see \n Exporting DB \n cluster data to Amazon S3 in the Amazon Aurora User Guide.

", + "smithy.api#documentation": "

Starts an export of DB snapshot or DB cluster data to Amazon S3. \n The provided IAM role must have access to the S3 bucket.

\n

You can't export snapshot data from Db2 or RDS Custom DB instances.

\n

You can't export cluster data from Multi-AZ DB clusters.

\n

For more information on exporting DB snapshot data, see \n Exporting DB snapshot \n data to Amazon S3 in the Amazon RDS User Guide\n or Exporting DB \n cluster snapshot data to Amazon S3 in the Amazon Aurora User Guide.

\n

For more information on exporting DB cluster data, see \n Exporting DB \n cluster data to Amazon S3 in the Amazon Aurora User Guide.

", "smithy.api#examples": [ { "title": "To export a snapshot to Amazon S3", @@ -28261,7 +28261,7 @@ } ], "traits": { - "smithy.api#documentation": "

Stops a database activity stream that was started using the Amazon Web Services console, \n the start-activity-stream CLI command, or the StartActivityStream action.

\n

For more information, see \n \n Monitoring Amazon Aurora with Database Activity Streams\n in the Amazon Aurora User Guide\n or \n Monitoring Amazon RDS with Database Activity Streams\n in the Amazon RDS User Guide.

", + "smithy.api#documentation": "

Stops a database activity stream that was started using the Amazon Web Services console, \n the start-activity-stream CLI command, or the StartActivityStream operation.

\n

For more information, see \n \n Monitoring Amazon Aurora with Database Activity Streams\n in the Amazon Aurora User Guide\n or \n Monitoring Amazon RDS with Database Activity Streams\n in the Amazon RDS User Guide.

", "smithy.api#examples": [ { "title": "To stop a database activity stream", @@ -28347,7 +28347,7 @@ } ], "traits": { - "smithy.api#documentation": "

Stops an Amazon Aurora DB cluster. When you stop a DB cluster, Aurora retains the DB cluster's\n metadata, including its endpoints and DB parameter groups. Aurora also\n retains the transaction logs so you can do a point-in-time restore if necessary.

\n

For more information, see \n \n Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide.

\n \n

This action only applies to Aurora DB clusters.

\n ", + "smithy.api#documentation": "

Stops an Amazon Aurora DB cluster. When you stop a DB cluster, Aurora retains the DB cluster's\n metadata, including its endpoints and DB parameter groups. Aurora also\n retains the transaction logs so you can do a point-in-time restore if necessary.

\n

For more information, see \n \n Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide.

\n \n

This operation only applies to Aurora DB clusters.

\n ", "smithy.api#examples": [ { "title": "To stop a DB cluster", diff --git a/codegen/sdk-codegen/aws-models/securityhub.json b/codegen/sdk-codegen/aws-models/securityhub.json index 11a773d16f3..9b030b8b7a8 100644 --- a/codegen/sdk-codegen/aws-models/securityhub.json +++ b/codegen/sdk-codegen/aws-models/securityhub.json @@ -515,6 +515,32 @@ "target": "com.amazonaws.securityhub#AssociatedStandard" } }, + "com.amazonaws.securityhub#AssociationFilters": { + "type": "structure", + "members": { + "ConfigurationPolicyId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The ARN or UUID of the configuration policy.\n

" + } + }, + "AssociationType": { + "target": "com.amazonaws.securityhub#AssociationType", + "traits": { + "smithy.api#documentation": "

\n Indicates whether the association between a target and a configuration was directly applied by the \n Security Hub delegated administrator or inherited from a parent.\n

" + } + }, + "AssociationStatus": { + "target": "com.amazonaws.securityhub#ConfigurationPolicyAssociationStatus", + "traits": { + "smithy.api#documentation": "

\n The current status of the association between a target and a configuration policy.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Options for filtering the ListConfigurationPolicyAssociations response. You can filter by the Amazon Resource Name (ARN) or \n universally unique identifier (UUID) of a configuration policy, AssociationType, or AssociationStatus.\n

" + } + }, "com.amazonaws.securityhub#AssociationSetDetails": { "type": "structure", "members": { @@ -602,6 +628,23 @@ } } }, + "com.amazonaws.securityhub#AssociationType": { + "type": "enum", + "members": { + "INHERITED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INHERITED" + } + }, + "APPLIED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "APPLIED" + } + } + } + }, "com.amazonaws.securityhub#AutoEnableStandards": { "type": "enum", "members": { @@ -807,7 +850,7 @@ "AwsAccountId": { "target": "com.amazonaws.securityhub#StringFilterList", "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID in which a finding was generated.

\n

\n \t\tArray Members: Minimum number of 1 item. Maximum number of 100 items.\n \t

" + "smithy.api#documentation": "

The Amazon Web Services account ID in which a finding was generated.

\n

\n \t\tArray Members: Minimum number of 1 item. Maximum number of 100 items.\n \t

" } }, "Id": { @@ -1007,6 +1050,24 @@ "traits": { "smithy.api#documentation": "

\n A list of user-defined name and value string pairs added to a finding.\n

\n

\n \t\tArray Members: Minimum number of 1 item. Maximum number of 20 items.\n \t

" } + }, + "ResourceApplicationArn": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the application that is related to a finding.\n

\n

\n Array Members: Minimum number of 1 item. Maximum number of 20 items.\n

" + } + }, + "ResourceApplicationName": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "

\n The name of the application that is related to a finding.\n

\n

\n Array Members: Minimum number of 1 item. Maximum number of 20 items.\n

" + } + }, + "AwsAccountName": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "

The name of the Amazon Web Services account in which a finding was generated.\n

\n

\n Array Members: Minimum number of 1 item. Maximum number of 20 items.\n

" + } } }, "traits": { @@ -18042,6 +18103,18 @@ "traits": { "smithy.api#documentation": "

Provides metadata for the Amazon CodeGuru detector associated with a finding. This field pertains to \nfindings that relate to Lambda functions. Amazon Inspector identifies policy violations and \nvulnerabilities in Lambda function code based on internal detectors developed \nin collaboration with Amazon CodeGuru. Security Hub receives those findings.\n

" } + }, + "ProcessedAt": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

An ISO8601-formatted timestamp that indicates when Security Hub received a finding and begins to process it.

\n

A correctly formatted example is 2020-05-21T20:16:34.724Z. The value cannot contain spaces, and date and time should be separated by T. For more information, see RFC 3339 section 5.6, Internet Date/Time Format.

" + } + }, + "AwsAccountName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the Amazon Web Services account from which a finding was generated.\n

" + } } }, "traits": { @@ -18060,7 +18133,7 @@ "AwsAccountId": { "target": "com.amazonaws.securityhub#StringFilterList", "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID that a finding is generated in.

" + "smithy.api#documentation": "

The Amazon Web Services account ID in which a finding is generated.

" } }, "Id": { @@ -18668,6 +18741,24 @@ "traits": { "smithy.api#documentation": "

\n The current value of a security control parameter.\n

" } + }, + "AwsAccountName": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "

The name of the Amazon Web Services account in which a finding is generated.

" + } + }, + "ResourceApplicationName": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "

\n The name of the application that is related to a finding.\n

" + } + }, + "ResourceApplicationArn": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "

\n The ARN of the application that is related to a finding.\n

" + } } }, "traits": { @@ -20281,6 +20372,9 @@ "target": "com.amazonaws.securityhub#BatchDisableStandardsResponse" }, "errors": [ + { + "target": "com.amazonaws.securityhub#AccessDeniedException" + }, { "target": "com.amazonaws.securityhub#InternalException" }, @@ -20363,6 +20457,9 @@ "target": "com.amazonaws.securityhub#BatchEnableStandardsResponse" }, "errors": [ + { + "target": "com.amazonaws.securityhub#AccessDeniedException" + }, { "target": "com.amazonaws.securityhub#InternalException" }, @@ -20603,6 +20700,123 @@ "smithy.api#output": {} } }, + "com.amazonaws.securityhub#BatchGetConfigurationPolicyAssociations": { + "type": "operation", + "input": { + "target": "com.amazonaws.securityhub#BatchGetConfigurationPolicyAssociationsRequest" + }, + "output": { + "target": "com.amazonaws.securityhub#BatchGetConfigurationPolicyAssociationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.securityhub#AccessDeniedException" + }, + { + "target": "com.amazonaws.securityhub#InternalException" + }, + { + "target": "com.amazonaws.securityhub#InvalidAccessException" + }, + { + "target": "com.amazonaws.securityhub#InvalidInputException" + }, + { + "target": "com.amazonaws.securityhub#LimitExceededException" + }, + { + "target": "com.amazonaws.securityhub#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

\n Returns associations between an Security Hub configuration and a batch of target accounts, organizational units, or the root. \n Only the Security Hub delegated administrator can invoke this operation from the home Region. A configuration \n can refer to a configuration policy or to a self-managed configuration.\n

", + "smithy.api#examples": [ + { + "title": "To get configuration associations for a batch of targets", + "documentation": "This operation provides details about configuration associations for a batch of target accounts, organizational units, or the root.", + "input": { + "ConfigurationPolicyAssociationIdentifiers": [ + { + "Target": { + "AccountId": "111122223333" + } + }, + { + "Target": { + "RootId": "r-f6g7h8i9j0example" + } + } + ] + }, + "output": { + "ConfigurationPolicyAssociations": [ + { + "ConfigurationPolicyId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "TargetId": "111122223333", + "TargetType": "ACCOUNT", + "AssociationType": "INHERITED", + "UpdatedAt": "2023-01-11T06:17:17.154Z", + "AssociationStatus": "SUCCESS", + "AssociationStatusMessage": "This field is only populated for a failed association" + } + ], + "UnprocessedConfigurationPolicyAssociations": [ + { + "ErrorCode": "400", + "ErrorReason": "You do not have sufficient access to perform this action.", + "ConfigurationPolicyAssociationIdentifiers": { + "Target": { + "RootId": "r-f6g7h8i9j0example" + } + } + } + ] + } + } + ], + "smithy.api#http": { + "method": "POST", + "uri": "/configurationPolicyAssociation/batchget", + "code": 200 + } + } + }, + "com.amazonaws.securityhub#BatchGetConfigurationPolicyAssociationsRequest": { + "type": "structure", + "members": { + "ConfigurationPolicyAssociationIdentifiers": { + "target": "com.amazonaws.securityhub#ConfigurationPolicyAssociationsList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

\n Specifies one or more target account IDs, organizational unit (OU) IDs, or the root ID to retrieve associations for. \n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.securityhub#BatchGetConfigurationPolicyAssociationsResponse": { + "type": "structure", + "members": { + "ConfigurationPolicyAssociations": { + "target": "com.amazonaws.securityhub#ConfigurationPolicyAssociationList", + "traits": { + "smithy.api#documentation": "

\n Describes associations for the target accounts, OUs, or the root.\n

" + } + }, + "UnprocessedConfigurationPolicyAssociations": { + "target": "com.amazonaws.securityhub#UnprocessedConfigurationPolicyAssociationList", + "traits": { + "smithy.api#documentation": "

\n An array of configuration policy associations, one for each configuration policy association identifier, that was \n specified in the request but couldn’t be processed due to an error.\n

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.securityhub#BatchGetSecurityControls": { "type": "operation", "input": { @@ -21247,6 +21461,9 @@ "target": "com.amazonaws.securityhub#BatchUpdateStandardsControlAssociationsResponse" }, "errors": [ + { + "target": "com.amazonaws.securityhub#AccessDeniedException" + }, { "target": "com.amazonaws.securityhub#InternalException" }, @@ -21713,6 +21930,161 @@ "smithy.api#documentation": "

\n The options for customizing a security control parameter.\n

" } }, + "com.amazonaws.securityhub#ConfigurationPolicyAssociation": { + "type": "structure", + "members": { + "Target": { + "target": "com.amazonaws.securityhub#Target", + "traits": { + "smithy.api#documentation": "

\n The target account, organizational unit, or the root.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Provides details about the association between an Security Hub configuration and a target account, organizational unit, or \n the root. An association can exist between a target and a configuration policy, or between a target and self-managed \n behavior.\n

" + } + }, + "com.amazonaws.securityhub#ConfigurationPolicyAssociationList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#ConfigurationPolicyAssociationSummary" + } + }, + "com.amazonaws.securityhub#ConfigurationPolicyAssociationStatus": { + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "SUCCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCESS" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } + } + }, + "com.amazonaws.securityhub#ConfigurationPolicyAssociationSummary": { + "type": "structure", + "members": { + "ConfigurationPolicyId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The universally unique identifier (UUID) of the configuration policy.\n

" + } + }, + "TargetId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The identifier of the target account, organizational unit, or the root.\n

" + } + }, + "TargetType": { + "target": "com.amazonaws.securityhub#TargetType", + "traits": { + "smithy.api#documentation": "

\n Specifies whether the target is an Amazon Web Services account, organizational unit, or the root.\n

" + } + }, + "AssociationType": { + "target": "com.amazonaws.securityhub#AssociationType", + "traits": { + "smithy.api#documentation": "

\n Indicates whether the association between the specified target and the configuration was directly applied by the \n Security Hub delegated administrator or inherited from a parent.\n

" + } + }, + "UpdatedAt": { + "target": "com.amazonaws.securityhub#Timestamp", + "traits": { + "smithy.api#documentation": "

\n The date and time, in UTC and ISO 8601 format, that the configuration policy association was last updated.\n

" + } + }, + "AssociationStatus": { + "target": "com.amazonaws.securityhub#ConfigurationPolicyAssociationStatus", + "traits": { + "smithy.api#documentation": "

\n The current status of the association between the specified target and the configuration.\n

" + } + }, + "AssociationStatusMessage": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The explanation for a FAILED value for AssociationStatus.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n An object that contains the details of a configuration policy association that’s returned in a \n ListConfigurationPolicyAssociations request.\n

" + } + }, + "com.amazonaws.securityhub#ConfigurationPolicyAssociationSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#ConfigurationPolicyAssociationSummary" + } + }, + "com.amazonaws.securityhub#ConfigurationPolicyAssociationsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#ConfigurationPolicyAssociation" + } + }, + "com.amazonaws.securityhub#ConfigurationPolicySummary": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the configuration policy.\n

" + } + }, + "Id": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The universally unique identifier (UUID) of the configuration policy.\n

" + } + }, + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The name of the configuration policy.\n

" + } + }, + "Description": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The description of the configuration policy.\n

" + } + }, + "UpdatedAt": { + "target": "com.amazonaws.securityhub#Timestamp", + "traits": { + "smithy.api#documentation": "

\n The date and time, in UTC and ISO 8601 format, that the configuration policy was last updated.\n

" + } + }, + "ServiceEnabled": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#documentation": "

\n Indicates whether the service that the configuration policy applies to is enabled in the policy.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n An object that contains the details of an Security Hub configuration policy that’s returned in a \n ListConfigurationPolicies request.\n

" + } + }, + "com.amazonaws.securityhub#ConfigurationPolicySummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#ConfigurationPolicySummary" + } + }, "com.amazonaws.securityhub#ContainerDetails": { "type": "structure", "members": { @@ -22018,7 +22390,7 @@ "Tags": { "target": "com.amazonaws.securityhub#TagMap", "traits": { - "smithy.api#documentation": "

\n User-defined tags that help you label the purpose of a rule. \n

" + "smithy.api#documentation": "

\n User-defined tags associated with an automation rule. \n

" } }, "RuleStatus": { @@ -22092,6 +22464,201 @@ "smithy.api#output": {} } }, + "com.amazonaws.securityhub#CreateConfigurationPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.securityhub#CreateConfigurationPolicyRequest" + }, + "output": { + "target": "com.amazonaws.securityhub#CreateConfigurationPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.securityhub#AccessDeniedException" + }, + { + "target": "com.amazonaws.securityhub#InternalException" + }, + { + "target": "com.amazonaws.securityhub#InvalidAccessException" + }, + { + "target": "com.amazonaws.securityhub#InvalidInputException" + }, + { + "target": "com.amazonaws.securityhub#LimitExceededException" + }, + { + "target": "com.amazonaws.securityhub#ResourceConflictException" + } + ], + "traits": { + "smithy.api#documentation": "

\n Creates a configuration policy with the defined configuration. Only the Security Hub delegated administrator \n can invoke this operation from the home Region.\n

", + "smithy.api#examples": [ + { + "title": "To create a configuration policy", + "documentation": "This operation creates a configuration policy in Security Hub.", + "input": { + "Name": "TestConfigurationPolicy", + "Description": "Configuration policy for testing FSBP and CIS", + "ConfigurationPolicy": { + "SecurityHub": { + "ServiceEnabled": true, + "EnabledStandardIdentifiers": [ + "arn:aws:securityhub:us-east-1::standards/aws-foundational-security-best-practices/v/1.0.0", + "arn:aws:securityhub:::ruleset/cis-aws-foundations-benchmark/v/1.2.0" + ], + "SecurityControlsConfiguration": { + "DisabledSecurityControlIdentifiers": [ + "CloudWatch.1" + ], + "SecurityControlCustomParameters": [ + { + "SecurityControlId": "ACM.1", + "Parameters": { + "daysToExpiration": { + "ValueType": "CUSTOM", + "Value": { + "Integer": 14 + } + } + } + } + ] + } + } + } + }, + "output": { + "Arn": "arn:aws:securityhub:us-east-1:123456789012:configuration-policy/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "Id": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "Name": "TestConfigurationPolicy", + "Description": "Configuration policy for testing FSBP and CIS", + "UpdatedAt": "2023-01-11T06:17:17.154Z", + "CreatedAt": "2023-01-11T06:17:17.154Z", + "ConfigurationPolicy": { + "SecurityHub": { + "ServiceEnabled": true, + "EnabledStandardIdentifiers": [ + "arn:aws:securityhub:us-east-1::standards/aws-foundational-security-best-practices/v/1.0.0", + "arn:aws:securityhub:::ruleset/cis-aws-foundations-benchmark/v/1.2.0" + ], + "SecurityControlsConfiguration": { + "DisabledSecurityControlIdentifiers": [ + "CloudWatch.1" + ], + "SecurityControlCustomParameters": [ + { + "SecurityControlId": "ACM.1", + "Parameters": { + "daysToExpiration": { + "ValueType": "CUSTOM", + "Value": { + "Integer": 14 + } + } + } + } + ] + } + } + } + } + } + ], + "smithy.api#http": { + "method": "POST", + "uri": "/configurationPolicy/create", + "code": 200 + } + } + }, + "com.amazonaws.securityhub#CreateConfigurationPolicyRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

\n The name of the configuration policy.\n

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The description of the configuration policy.\n

" + } + }, + "ConfigurationPolicy": { + "target": "com.amazonaws.securityhub#Policy", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

\n An object that defines how Security Hub is configured. It includes whether Security Hub is enabled or \n disabled, a list of enabled security standards, a list of enabled or disabled security controls, and a list of custom parameter values for specified controls. \n If you provide a list of security controls that are enabled in the configuration policy, Security Hub disables all other controls (including newly \n released controls). If you provide a list of security controls that are disabled in the configuration policy, Security Hub \n enables all other controls (including newly released controls).\n

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.securityhub#TagMap", + "traits": { + "smithy.api#documentation": "

\n User-defined tags associated with a configuration policy. For more information, see \n Tagging Security Hub resources \n in the Security Hub user guide.\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.securityhub#CreateConfigurationPolicyResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the configuration policy.\n

" + } + }, + "Id": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The universally unique identifier (UUID) of the configuration policy.\n

" + } + }, + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The name of the configuration policy.\n

" + } + }, + "Description": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The description of the configuration policy.\n

" + } + }, + "UpdatedAt": { + "target": "com.amazonaws.securityhub#Timestamp", + "traits": { + "smithy.api#documentation": "

\n The date and time, in UTC and ISO 8601 format, that the configuration policy was last updated.\n

" + } + }, + "CreatedAt": { + "target": "com.amazonaws.securityhub#Timestamp", + "traits": { + "smithy.api#documentation": "

\n The date and time, in UTC and ISO 8601 format, that the configuration policy was created.\n

" + } + }, + "ConfigurationPolicy": { + "target": "com.amazonaws.securityhub#Policy", + "traits": { + "smithy.api#documentation": "

\n An object that defines how Security Hub is configured. It includes whether Security Hub is enabled or disabled, a \n list of enabled security standards, a list of enabled or disabled security controls, and a list of custom parameter values for specified controls. \n If the request included a list of security controls that are enabled in the configuration policy, Security Hub disables all other controls (including newly \n released controls). If the request included a list of security controls that are disabled in the configuration policy, \n Security Hub enables all other controls (including newly released controls).\n

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.securityhub#CreateFindingAggregator": { "type": "operation", "input": { @@ -22320,6 +22887,9 @@ "target": "com.amazonaws.securityhub#CreateMembersResponse" }, "errors": [ + { + "target": "com.amazonaws.securityhub#AccessDeniedException" + }, { "target": "com.amazonaws.securityhub#InternalException" }, @@ -22745,6 +23315,78 @@ "smithy.api#output": {} } }, + "com.amazonaws.securityhub#DeleteConfigurationPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.securityhub#DeleteConfigurationPolicyRequest" + }, + "output": { + "target": "com.amazonaws.securityhub#DeleteConfigurationPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.securityhub#AccessDeniedException" + }, + { + "target": "com.amazonaws.securityhub#InternalException" + }, + { + "target": "com.amazonaws.securityhub#InvalidAccessException" + }, + { + "target": "com.amazonaws.securityhub#InvalidInputException" + }, + { + "target": "com.amazonaws.securityhub#LimitExceededException" + }, + { + "target": "com.amazonaws.securityhub#ResourceConflictException" + }, + { + "target": "com.amazonaws.securityhub#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

\n Deletes a configuration policy. Only the Security Hub delegated administrator can invoke this operation \n from the home Region. For the deletion to succeed, you must first disassociate a configuration policy from target accounts, \n organizational units, or the root by invoking the StartConfigurationPolicyDisassociation operation.\n

", + "smithy.api#examples": [ + { + "title": "To delete a configuration policy", + "documentation": "This operation deletes the specified configuration policy.", + "input": { + "Identifier": "arn:aws:securityhub:us-east-1:123456789012:configuration-policy/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" + } + } + ], + "smithy.api#http": { + "method": "DELETE", + "uri": "/configurationPolicy/{Identifier}", + "code": 200 + } + } + }, + "com.amazonaws.securityhub#DeleteConfigurationPolicyRequest": { + "type": "structure", + "members": { + "Identifier": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) or universally unique identifier (UUID) of the configuration policy.\n

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.securityhub#DeleteConfigurationPolicyResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.securityhub#DeleteFindingAggregator": { "type": "operation", "input": { @@ -23273,15 +23915,19 @@ } ], "traits": { - "smithy.api#documentation": "

Returns information about the Organizations configuration for Security Hub. Can only be\n called from a Security Hub administrator account.

", + "smithy.api#documentation": "

Returns information about the way your organization is configured in Security Hub. Only the \n Security Hub administrator account can invoke this operation.

", "smithy.api#examples": [ { - "title": "To get information about Organizations configuration", - "documentation": "The following example returns details about the way in which AWS Organizations is configured for a Security Hub account that belongs to an organization. Only a Security Hub administrator account can call this operation.", + "title": "To get information about organization configuration", + "documentation": "This operation provides information about the way your organization is configured in Security Hub. Only a Security Hub administrator account can invoke this operation.", "output": { - "AutoEnable": true, - "MemberAccountLimitReached": true, - "AutoEnableStandards": "DEFAULT" + "AutoEnable": false, + "MemberAccountLimitReached": false, + "AutoEnableStandards": "NONE", + "OrganizationConfiguration": { + "ConfigurationType": "CENTRAL", + "Status": "ENABLED" + } } } ], @@ -23305,7 +23951,7 @@ "AutoEnable": { "target": "com.amazonaws.securityhub#Boolean", "traits": { - "smithy.api#documentation": "

Whether to automatically enable Security Hub for new accounts in the organization.

\n

If set to true, then Security Hub is enabled for new accounts. If set to false,\n then new accounts are not added automatically.

" + "smithy.api#documentation": "

Whether to automatically enable Security Hub in new member accounts when they join the organization.

\n

If set to true, then Security Hub is automatically enabled in new accounts. If set to false,\n then Security Hub isn't enabled in new accounts automatically. The default value is false.

\n

If the ConfigurationType of your organization is set to CENTRAL, then this field is set \n to false and can't be changed in the home Region and linked Regions. However, in that case, the delegated administrator can create a configuration \n policy in which Security Hub is enabled and associate the policy with new organization accounts.

" } }, "MemberAccountLimitReached": { @@ -23317,8 +23963,11 @@ "AutoEnableStandards": { "target": "com.amazonaws.securityhub#AutoEnableStandards", "traits": { - "smithy.api#documentation": "

Whether to automatically enable Security Hub default standards \n for new member accounts in the organization.

\n

The default value of this parameter is equal to DEFAULT.

\n

If equal to DEFAULT, then Security Hub default standards are automatically enabled for new member \n accounts. If equal to NONE, then default standards are not automatically enabled for new member \n accounts.

" + "smithy.api#documentation": "

Whether to automatically enable Security Hub default standards \n in new member accounts when they join the organization.

\n

If equal to DEFAULT, then Security Hub default standards are automatically enabled for new member \n accounts. If equal to NONE, then default standards are not automatically enabled for new member \n accounts. The default value of this parameter is equal to DEFAULT.

\n

If the ConfigurationType of your organization is set to CENTRAL, then this field is set \n to NONE and can't be changed in the home Region and linked Regions. However, in that case, the delegated administrator can create a configuration \n policy in which specific security standards are enabled and associate the policy with new organization accounts.

" } + }, + "OrganizationConfiguration": { + "target": "com.amazonaws.securityhub#OrganizationConfiguration" } }, "traits": { @@ -23720,6 +24369,9 @@ "target": "com.amazonaws.securityhub#DisableOrganizationAdminAccountResponse" }, "errors": [ + { + "target": "com.amazonaws.securityhub#AccessDeniedException" + }, { "target": "com.amazonaws.securityhub#InternalException" }, @@ -23783,6 +24435,9 @@ "target": "com.amazonaws.securityhub#DisableSecurityHubResponse" }, "errors": [ + { + "target": "com.amazonaws.securityhub#AccessDeniedException" + }, { "target": "com.amazonaws.securityhub#InternalException" }, @@ -23825,6 +24480,12 @@ "smithy.api#output": {} } }, + "com.amazonaws.securityhub#DisabledSecurityControlIdentifierList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#NonEmptyString" + } + }, "com.amazonaws.securityhub#DisassociateFromAdministratorAccount": { "type": "operation", "input": { @@ -23939,6 +24600,9 @@ "target": "com.amazonaws.securityhub#DisassociateMembersResponse" }, "errors": [ + { + "target": "com.amazonaws.securityhub#AccessDeniedException" + }, { "target": "com.amazonaws.securityhub#InternalException" }, @@ -24139,6 +24803,9 @@ "target": "com.amazonaws.securityhub#EnableOrganizationAdminAccountResponse" }, "errors": [ + { + "target": "com.amazonaws.securityhub#AccessDeniedException" + }, { "target": "com.amazonaws.securityhub#InternalException" }, @@ -24272,6 +24939,18 @@ "smithy.api#output": {} } }, + "com.amazonaws.securityhub#EnabledSecurityControlIdentifierList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#NonEmptyString" + } + }, + "com.amazonaws.securityhub#EnabledStandardIdentifierList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#NonEmptyString" + } + }, "com.amazonaws.securityhub#EnumConfigurationOptions": { "type": "structure", "members": { @@ -24767,15 +25446,18 @@ "smithy.api#output": {} } }, - "com.amazonaws.securityhub#GetEnabledStandards": { + "com.amazonaws.securityhub#GetConfigurationPolicy": { "type": "operation", "input": { - "target": "com.amazonaws.securityhub#GetEnabledStandardsRequest" + "target": "com.amazonaws.securityhub#GetConfigurationPolicyRequest" }, "output": { - "target": "com.amazonaws.securityhub#GetEnabledStandardsResponse" + "target": "com.amazonaws.securityhub#GetConfigurationPolicyResponse" }, "errors": [ + { + "target": "com.amazonaws.securityhub#AccessDeniedException" + }, { "target": "com.amazonaws.securityhub#InternalException" }, @@ -24787,97 +25469,364 @@ }, { "target": "com.amazonaws.securityhub#LimitExceededException" + }, + { + "target": "com.amazonaws.securityhub#ResourceNotFoundException" } ], "traits": { - "smithy.api#documentation": "

Returns a list of the standards that are currently enabled.

", + "smithy.api#documentation": "

\n Provides information about a configuration policy. Only the Security Hub delegated administrator can invoke \n this operation from the home Region.\n

", "smithy.api#examples": [ { - "title": "To return a list of enabled standards", - "documentation": "The following example returns a list of Security Hub standards that are currently enabled in your account. ", + "title": "To get details about a configuration policy", + "documentation": "This operation provides details about the specified configuration policy.", "input": { - "StandardsSubscriptionArns": [ - "arn:aws:securityhub:us-west-1:123456789012:subscription/pci-dss/v/3.2.1" - ] + "Identifier": "arn:aws:securityhub:us-east-1:123456789012:configuration-policy/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" }, "output": { - "StandardsSubscriptions": [ - { - "StandardsArn": "arn:aws:securityhub:us-west-1::standards/pci-dss/v/3.2.1", - "StandardsInput": {}, - "StandardsStatus": "READY", - "StandardsSubscriptionArn": "arn:aws:securityhub:us-west-1:123456789012:subscription/pci-dss/v/3.2.1" + "Arn": "arn:aws:securityhub:us-east-1:123456789012:configuration-policy/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "Id": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "Name": "TestConfigurationPolicy", + "Description": "Configuration policy for testing FSBP and CIS", + "UpdatedAt": "2023-01-11T06:17:17.154Z", + "CreatedAt": "2023-01-11T06:17:17.154Z", + "ConfigurationPolicy": { + "SecurityHub": { + "ServiceEnabled": true, + "EnabledStandardIdentifiers": [ + "arn:aws:securityhub:us-east-1::standards/aws-foundational-security-best-practices/v/1.0.0", + "arn:aws:securityhub:::ruleset/cis-aws-foundations-benchmark/v/1.2.0" + ], + "SecurityControlsConfiguration": { + "DisabledSecurityControlIdentifiers": [ + "CloudWatch.1" + ], + "SecurityControlCustomParameters": [ + { + "SecurityControlId": "ACM.1", + "Parameters": { + "daysToExpiration": { + "ValueType": "CUSTOM", + "Value": { + "Integer": 14 + } + } + } + } + ] + } } - ] + } } } ], "smithy.api#http": { - "method": "POST", - "uri": "/standards/get", + "method": "GET", + "uri": "/configurationPolicy/get/{Identifier}", "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "StandardsSubscriptions", - "pageSize": "MaxResults" } } }, - "com.amazonaws.securityhub#GetEnabledStandardsRequest": { - "type": "structure", - "members": { - "StandardsSubscriptionArns": { - "target": "com.amazonaws.securityhub#StandardsSubscriptionArns", - "traits": { - "smithy.api#documentation": "

The list of the standards subscription ARNs for the standards to retrieve.

" - } - }, - "NextToken": { - "target": "com.amazonaws.securityhub#NextToken", - "traits": { - "smithy.api#documentation": "

The token that is required for pagination. On your first call to the\n GetEnabledStandards operation, set the value of this parameter to\n NULL.

\n

For subsequent calls to the operation, to continue listing data, set the value of this\n parameter to the value returned from the previous response.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.securityhub#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to return in the response.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.securityhub#GetEnabledStandardsResponse": { - "type": "structure", - "members": { - "StandardsSubscriptions": { - "target": "com.amazonaws.securityhub#StandardsSubscriptions", - "traits": { - "smithy.api#documentation": "

The list of StandardsSubscriptions objects that include information about\n the enabled standards.

" - } - }, - "NextToken": { - "target": "com.amazonaws.securityhub#NextToken", - "traits": { - "smithy.api#documentation": "

The pagination token to use to request the next page of results.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.securityhub#GetFindingAggregator": { + "com.amazonaws.securityhub#GetConfigurationPolicyAssociation": { "type": "operation", "input": { - "target": "com.amazonaws.securityhub#GetFindingAggregatorRequest" + "target": "com.amazonaws.securityhub#GetConfigurationPolicyAssociationRequest" }, "output": { - "target": "com.amazonaws.securityhub#GetFindingAggregatorResponse" + "target": "com.amazonaws.securityhub#GetConfigurationPolicyAssociationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.securityhub#AccessDeniedException" + }, + { + "target": "com.amazonaws.securityhub#InternalException" + }, + { + "target": "com.amazonaws.securityhub#InvalidAccessException" + }, + { + "target": "com.amazonaws.securityhub#InvalidInputException" + }, + { + "target": "com.amazonaws.securityhub#LimitExceededException" + }, + { + "target": "com.amazonaws.securityhub#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

\n Returns the association between a configuration and a target account, organizational unit, or the root. The \n configuration can be a configuration policy or self-managed behavior. Only the Security Hub delegated administrator can \n invoke this operation from the home Region.\n

", + "smithy.api#examples": [ + { + "title": "To get details about a configuration association", + "documentation": "This operation provides details about configuration associations for a specific target account, organizational unit, or the root.", + "input": { + "Target": { + "AccountId": "111122223333" + } + }, + "output": { + "ConfigurationPolicyId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "TargetId": "111122223333", + "TargetType": "ACCOUNT", + "AssociationType": "INHERITED", + "UpdatedAt": "2023-01-11T06:17:17.154Z", + "AssociationStatus": "FAILED", + "AssociationStatusMessage": "Configuration Policy a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 couldn’t be applied to account 111122223333 in us-east-1 Region. Retry your request." + } + } + ], + "smithy.api#http": { + "method": "POST", + "uri": "/configurationPolicyAssociation/get", + "code": 200 + } + } + }, + "com.amazonaws.securityhub#GetConfigurationPolicyAssociationRequest": { + "type": "structure", + "members": { + "Target": { + "target": "com.amazonaws.securityhub#Target", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

\n The target account ID, organizational unit ID, or the root ID to retrieve the association for. \n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.securityhub#GetConfigurationPolicyAssociationResponse": { + "type": "structure", + "members": { + "ConfigurationPolicyId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The universally unique identifier (UUID) of a configuration policy. For self-managed behavior, the value is \n SELF_MANAGED_SECURITY_HUB.\n

" + } + }, + "TargetId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The target account ID, organizational unit ID, or the root ID for which the association is retrieved.\n

" + } + }, + "TargetType": { + "target": "com.amazonaws.securityhub#TargetType", + "traits": { + "smithy.api#documentation": "

\n Specifies whether the target is an Amazon Web Services account, organizational unit, or the organization root.\n

" + } + }, + "AssociationType": { + "target": "com.amazonaws.securityhub#AssociationType", + "traits": { + "smithy.api#documentation": "

\n Indicates whether the association between the specified target and the configuration was directly applied by the \n Security Hub delegated administrator or inherited from a parent.\n

" + } + }, + "UpdatedAt": { + "target": "com.amazonaws.securityhub#Timestamp", + "traits": { + "smithy.api#documentation": "

\n The date and time, in UTC and ISO 8601 format, that the configuration policy association was last updated.\n

" + } + }, + "AssociationStatus": { + "target": "com.amazonaws.securityhub#ConfigurationPolicyAssociationStatus", + "traits": { + "smithy.api#documentation": "

\n The current status of the association between the specified target and the configuration.\n

" + } + }, + "AssociationStatusMessage": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The explanation for a FAILED value for AssociationStatus.\n

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.securityhub#GetConfigurationPolicyRequest": { + "type": "structure", + "members": { + "Identifier": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) or universally unique identifier (UUID) of the configuration policy.\n

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.securityhub#GetConfigurationPolicyResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The ARN of the configuration policy.\n

" + } + }, + "Id": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The UUID of the configuration policy.\n

" + } + }, + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The name of the configuration policy.\n

" + } + }, + "Description": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The description of the configuration policy.\n

" + } + }, + "UpdatedAt": { + "target": "com.amazonaws.securityhub#Timestamp", + "traits": { + "smithy.api#documentation": "

\n The date and time, in UTC and ISO 8601 format, that the configuration policy was last updated.\n

" + } + }, + "CreatedAt": { + "target": "com.amazonaws.securityhub#Timestamp", + "traits": { + "smithy.api#documentation": "

\n The date and time, in UTC and ISO 8601 format, that the configuration policy was created.\n

" + } + }, + "ConfigurationPolicy": { + "target": "com.amazonaws.securityhub#Policy", + "traits": { + "smithy.api#documentation": "

\n An object that defines how Security Hub is configured. It includes whether Security Hub is enabled or \n disabled, a list of enabled security standards, a list of enabled or disabled security controls, and a list of custom parameter values for specified controls. \n If the policy includes a list of security controls that are enabled, Security Hub disables all other controls (including newly released controls). \n If the policy includes a list of security controls that are disabled, Security Hub enables all other controls (including \n newly released controls).\n

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.securityhub#GetEnabledStandards": { + "type": "operation", + "input": { + "target": "com.amazonaws.securityhub#GetEnabledStandardsRequest" + }, + "output": { + "target": "com.amazonaws.securityhub#GetEnabledStandardsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.securityhub#InternalException" + }, + { + "target": "com.amazonaws.securityhub#InvalidAccessException" + }, + { + "target": "com.amazonaws.securityhub#InvalidInputException" + }, + { + "target": "com.amazonaws.securityhub#LimitExceededException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of the standards that are currently enabled.

", + "smithy.api#examples": [ + { + "title": "To return a list of enabled standards", + "documentation": "The following example returns a list of Security Hub standards that are currently enabled in your account. ", + "input": { + "StandardsSubscriptionArns": [ + "arn:aws:securityhub:us-west-1:123456789012:subscription/pci-dss/v/3.2.1" + ] + }, + "output": { + "StandardsSubscriptions": [ + { + "StandardsArn": "arn:aws:securityhub:us-west-1::standards/pci-dss/v/3.2.1", + "StandardsInput": {}, + "StandardsStatus": "READY", + "StandardsSubscriptionArn": "arn:aws:securityhub:us-west-1:123456789012:subscription/pci-dss/v/3.2.1" + } + ] + } + } + ], + "smithy.api#http": { + "method": "POST", + "uri": "/standards/get", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "StandardsSubscriptions", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.securityhub#GetEnabledStandardsRequest": { + "type": "structure", + "members": { + "StandardsSubscriptionArns": { + "target": "com.amazonaws.securityhub#StandardsSubscriptionArns", + "traits": { + "smithy.api#documentation": "

The list of the standards subscription ARNs for the standards to retrieve.

" + } + }, + "NextToken": { + "target": "com.amazonaws.securityhub#NextToken", + "traits": { + "smithy.api#documentation": "

The token that is required for pagination. On your first call to the\n GetEnabledStandards operation, set the value of this parameter to\n NULL.

\n

For subsequent calls to the operation, to continue listing data, set the value of this\n parameter to the value returned from the previous response.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.securityhub#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return in the response.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.securityhub#GetEnabledStandardsResponse": { + "type": "structure", + "members": { + "StandardsSubscriptions": { + "target": "com.amazonaws.securityhub#StandardsSubscriptions", + "traits": { + "smithy.api#documentation": "

The list of StandardsSubscriptions objects that include information about\n the enabled standards.

" + } + }, + "NextToken": { + "target": "com.amazonaws.securityhub#NextToken", + "traits": { + "smithy.api#documentation": "

The pagination token to use to request the next page of results.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.securityhub#GetFindingAggregator": { + "type": "operation", + "input": { + "target": "com.amazonaws.securityhub#GetFindingAggregatorRequest" + }, + "output": { + "target": "com.amazonaws.securityhub#GetFindingAggregatorResponse" }, "errors": [ { @@ -26425,6 +27374,223 @@ "smithy.api#output": {} } }, + "com.amazonaws.securityhub#ListConfigurationPolicies": { + "type": "operation", + "input": { + "target": "com.amazonaws.securityhub#ListConfigurationPoliciesRequest" + }, + "output": { + "target": "com.amazonaws.securityhub#ListConfigurationPoliciesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.securityhub#AccessDeniedException" + }, + { + "target": "com.amazonaws.securityhub#InternalException" + }, + { + "target": "com.amazonaws.securityhub#InvalidAccessException" + }, + { + "target": "com.amazonaws.securityhub#InvalidInputException" + }, + { + "target": "com.amazonaws.securityhub#LimitExceededException" + } + ], + "traits": { + "smithy.api#documentation": "

\n Lists the configuration policies that the Security Hub delegated administrator has created for your \n organization. Only the delegated administrator can invoke this operation from the home Region.\n

", + "smithy.api#examples": [ + { + "title": "To view a list of configuration policies", + "documentation": "This operation provides a list of your configuration policies, including metadata for each policy.", + "input": { + "NextToken": "U1FsdGVkX19nBV2zoh+Gou9NgnulLJHWpn9xnG4hqSOhvw3o2JqjI86QDxdf", + "MaxResults": 1 + }, + "output": { + "ConfigurationPolicySummaries": [ + { + "Arn": "arn:aws:securityhub:us-east-1:123456789012:configuration-policy/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "Id": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "Name": "TestConfigurationPolicy", + "Description": "Configuration policy for testing FSBP and CIS", + "UpdatedAt": "2023-01-11T06:17:17.154Z", + "ServiceEnabled": true + } + ], + "NextToken": "U1FsdGVkX19nBV2zoh+Gou9NgnulLJHWpn9xnG4hqSOfvw3o2JqjI86QDxef" + } + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/configurationPolicy/list", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ConfigurationPolicySummaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.securityhub#ListConfigurationPoliciesRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.securityhub#NextToken", + "traits": { + "smithy.api#documentation": "

\n The NextToken value that's returned from a previous paginated ListConfigurationPolicies request where \n MaxResults was used but the results exceeded the value of that parameter. Pagination continues from the \n MaxResults was used but the results exceeded the value of that parameter. Pagination continues from the \n end of the previous response that returned the NextToken value. This value is null when \n there are no more results to return.\n

", + "smithy.api#httpQuery": "NextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.securityhub#MaxResults", + "traits": { + "smithy.api#documentation": "

\n The maximum number of results that's returned by ListConfigurationPolicies in each page of the response. \n When this parameter is used, ListConfigurationPolicies returns the specified number of results in a \n single page and a NextToken response element. You can see the remaining results of the initial request \n by sending another ListConfigurationPolicies request with the returned NextToken value. A \n valid range for MaxResults is between 1 and 100.\n

", + "smithy.api#httpQuery": "MaxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.securityhub#ListConfigurationPoliciesResponse": { + "type": "structure", + "members": { + "ConfigurationPolicySummaries": { + "target": "com.amazonaws.securityhub#ConfigurationPolicySummaryList", + "traits": { + "smithy.api#documentation": "

\n Provides metadata for each of your configuration policies.\n

" + } + }, + "NextToken": { + "target": "com.amazonaws.securityhub#NextToken", + "traits": { + "smithy.api#documentation": "

\n The NextToken value to include in the next ListConfigurationPolicies request. When the \n results of a ListConfigurationPolicies request exceed MaxResults, this value can be used to \n retrieve the next page of results. This value is null when there are no more results to return.\n

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.securityhub#ListConfigurationPolicyAssociations": { + "type": "operation", + "input": { + "target": "com.amazonaws.securityhub#ListConfigurationPolicyAssociationsRequest" + }, + "output": { + "target": "com.amazonaws.securityhub#ListConfigurationPolicyAssociationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.securityhub#AccessDeniedException" + }, + { + "target": "com.amazonaws.securityhub#InternalException" + }, + { + "target": "com.amazonaws.securityhub#InvalidAccessException" + }, + { + "target": "com.amazonaws.securityhub#InvalidInputException" + }, + { + "target": "com.amazonaws.securityhub#LimitExceededException" + } + ], + "traits": { + "smithy.api#documentation": "

\n Provides information about the associations for your configuration policies and self-managed behavior. Only the \n Security Hub delegated administrator can invoke this operation from the home Region.\n

", + "smithy.api#examples": [ + { + "title": "To list configuration associations", + "documentation": "This operation lists all of the associations between targets and configuration policies or self-managed behavior. Targets can include accounts, organizational units, or the root.", + "input": { + "NextToken": "U1FsdGVkX19nBV2zoh+Gou9NgnulLJHWpn9xnG4hqSOhvw3o2JqjI86QDxdf", + "MaxResults": 1, + "Filters": { + "AssociationType": "APPLIED" + } + }, + "output": { + "ConfigurationPolicyAssociationSummaries": [ + { + "ConfigurationPolicyId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "TargetId": "123456789012", + "TargetType": "ACCOUNT", + "AssociationType": "APPLIED", + "UpdatedAt": "2023-01-11T06:17:17.154Z", + "AssociationStatus": "PENDING" + } + ], + "NextToken": "U1FsdGVkX19nBV2zoh+Gou9NgnulLJHWpn9xnG4hqSOfvw3o2JqjI86QDxef" + } + } + ], + "smithy.api#http": { + "method": "POST", + "uri": "/configurationPolicyAssociation/list", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ConfigurationPolicyAssociationSummaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.securityhub#ListConfigurationPolicyAssociationsRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.securityhub#NextToken", + "traits": { + "smithy.api#documentation": "

\n The NextToken value that's returned from a previous paginated ListConfigurationPolicyAssociations \n request where MaxResults was used but the results exceeded the value of that parameter. Pagination \n continues from the end of the previous response that returned the NextToken value. This value is null \n when there are no more results to return.\n

" + } + }, + "MaxResults": { + "target": "com.amazonaws.securityhub#MaxResults", + "traits": { + "smithy.api#documentation": "

\n The maximum number of results that's returned by ListConfigurationPolicies in each page of the response. \n When this parameter is used, ListConfigurationPolicyAssociations returns the specified number of results \n in a single page and a NextToken response element. You can see the remaining results of the initial \n request by sending another ListConfigurationPolicyAssociations request with the returned NextToken \n value. A valid range for MaxResults is between 1 and 100.\n

" + } + }, + "Filters": { + "target": "com.amazonaws.securityhub#AssociationFilters", + "traits": { + "smithy.api#documentation": "

\n Options for filtering the ListConfigurationPolicyAssociations response. You can filter by the Amazon Resource Name (ARN) or \n universally unique identifier (UUID) of a configuration, AssociationType, or AssociationStatus.\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.securityhub#ListConfigurationPolicyAssociationsResponse": { + "type": "structure", + "members": { + "ConfigurationPolicyAssociationSummaries": { + "target": "com.amazonaws.securityhub#ConfigurationPolicyAssociationSummaryList", + "traits": { + "smithy.api#documentation": "

\n An object that contains the details of each configuration policy association that’s returned in a \n ListConfigurationPolicyAssociations request.\n

" + } + }, + "NextToken": { + "target": "com.amazonaws.securityhub#NextToken", + "traits": { + "smithy.api#documentation": "

\n The NextToken value to include in the next ListConfigurationPolicyAssociations request. When \n the results of a ListConfigurationPolicyAssociations request exceed MaxResults, this value \n can be used to retrieve the next page of results. This value is null when there are no more results to return.\n

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.securityhub#ListEnabledProductsForImport": { "type": "operation", "input": { @@ -27853,6 +29019,72 @@ "smithy.api#documentation": "

The detected occurrences of sensitive data.

" } }, + "com.amazonaws.securityhub#OrganizationConfiguration": { + "type": "structure", + "members": { + "ConfigurationType": { + "target": "com.amazonaws.securityhub#OrganizationConfigurationConfigurationType", + "traits": { + "smithy.api#documentation": "

\n Indicates whether the organization uses local or central configuration.\n

\n

If you use local configuration, the \n Security Hub delegated administrator can set AutoEnable to true and \n AutoEnableStandards to DEFAULT. This automatically enables Security Hub and \n default security standards in new organization accounts. These new account settings must be set separately in \n each Amazon Web Services Region, and settings may be different in each Region.\n

\n

\n If you use central configuration, the delegated administrator can create configuration policies. Configuration \n policies can be used to configure Security Hub, security standards, and security controls in multiple \n accounts and Regions. If you want new organization accounts to use a specific configuration, you can create a \n configuration policy and associate it with the root or specific organizational units (OUs). New accounts will \n inherit the policy from the root or their assigned OU.\n

" + } + }, + "Status": { + "target": "com.amazonaws.securityhub#OrganizationConfigurationStatus", + "traits": { + "smithy.api#documentation": "

\n Describes whether central configuration could be enabled as the ConfigurationType for the \n organization. If your ConfigurationType is local configuration, then the value of Status \n is always ENABLED.\n

" + } + }, + "StatusMessage": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n Provides an explanation if the value of Status is equal to FAILED when ConfigurationType \n is equal to CENTRAL.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Provides information about the way an organization is configured in Security Hub.\n

" + } + }, + "com.amazonaws.securityhub#OrganizationConfigurationConfigurationType": { + "type": "enum", + "members": { + "CENTRAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CENTRAL" + } + }, + "LOCAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LOCAL" + } + } + } + }, + "com.amazonaws.securityhub#OrganizationConfigurationStatus": { + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } + } + }, "com.amazonaws.securityhub#Page": { "type": "structure", "members": { @@ -28121,6 +29353,20 @@ "smithy.api#documentation": "

Provides an overview of the patch compliance status for an instance against a selected\n compliance standard.

" } }, + "com.amazonaws.securityhub#Policy": { + "type": "union", + "members": { + "SecurityHub": { + "target": "com.amazonaws.securityhub#SecurityHubPolicy", + "traits": { + "smithy.api#documentation": "

\n The Amazon Web Service that the configuration policy applies to.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n An object that defines how Security Hub is configured. It includes whether Security Hub is \n enabled or disabled, a list of enabled security standards, a list of enabled or disabled security controls, and a list of custom parameter values for specified controls. \n If you provide a list of security controls that are enabled in the configuration policy, Security Hub \n disables all other controls (including newly released controls). If you provide a list of security controls that \n are disabled in the configuration policy, Security Hub enables all other controls (including newly \n released controls).\n

" + } + }, "com.amazonaws.securityhub#PortProbeAction": { "type": "structure", "members": { @@ -28584,6 +29830,18 @@ "traits": { "smithy.api#documentation": "

Additional details about the resource related to a finding.

" } + }, + "ApplicationName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The name of the application that is related to a finding.\n

" + } + }, + "ApplicationArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the application that is related to a finding.\n

" + } } }, "traits": { @@ -29966,6 +31224,32 @@ "smithy.api#documentation": "

\n A security control in Security Hub describes a security best practice related to a specific resource. \n

" } }, + "com.amazonaws.securityhub#SecurityControlCustomParameter": { + "type": "structure", + "members": { + "SecurityControlId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The ID of the security control.\n

" + } + }, + "Parameters": { + "target": "com.amazonaws.securityhub#Parameters", + "traits": { + "smithy.api#documentation": "

\n An object that specifies parameter values for a control in a configuration policy.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n A list of security controls and control parameter values that are included in a configuration policy.\n

" + } + }, + "com.amazonaws.securityhub#SecurityControlCustomParametersList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#SecurityControlCustomParameter" + } + }, "com.amazonaws.securityhub#SecurityControlDefinition": { "type": "structure", "members": { @@ -30083,6 +31367,32 @@ "target": "com.amazonaws.securityhub#SecurityControl" } }, + "com.amazonaws.securityhub#SecurityControlsConfiguration": { + "type": "structure", + "members": { + "EnabledSecurityControlIdentifiers": { + "target": "com.amazonaws.securityhub#EnabledSecurityControlIdentifierList", + "traits": { + "smithy.api#documentation": "

\n A list of security controls that are enabled in the configuration policy. Security Hub disables all other \n controls (including newly released controls) other than the listed controls.\n

" + } + }, + "DisabledSecurityControlIdentifiers": { + "target": "com.amazonaws.securityhub#DisabledSecurityControlIdentifierList", + "traits": { + "smithy.api#documentation": "

\n A list of security controls that are disabled in the configuration policy. Security Hub enables all other \n controls (including newly released controls) other than the listed controls.\n

" + } + }, + "SecurityControlCustomParameters": { + "target": "com.amazonaws.securityhub#SecurityControlCustomParametersList", + "traits": { + "smithy.api#documentation": "

\n A list of security controls and control parameter values that are included in a configuration policy.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n An object that defines which security controls are enabled in an Security Hub configuration policy. \n The enablement status of a control is aligned across all of the enabled standards in an account.\n

" + } + }, "com.amazonaws.securityhub#SecurityGroups": { "type": "list", "member": { @@ -30111,6 +31421,9 @@ { "target": "com.amazonaws.securityhub#BatchGetAutomationRules" }, + { + "target": "com.amazonaws.securityhub#BatchGetConfigurationPolicyAssociations" + }, { "target": "com.amazonaws.securityhub#BatchGetSecurityControls" }, @@ -30135,6 +31448,9 @@ { "target": "com.amazonaws.securityhub#CreateAutomationRule" }, + { + "target": "com.amazonaws.securityhub#CreateConfigurationPolicy" + }, { "target": "com.amazonaws.securityhub#CreateFindingAggregator" }, @@ -30150,6 +31466,9 @@ { "target": "com.amazonaws.securityhub#DeleteActionTarget" }, + { + "target": "com.amazonaws.securityhub#DeleteConfigurationPolicy" + }, { "target": "com.amazonaws.securityhub#DeleteFindingAggregator" }, @@ -30210,6 +31529,12 @@ { "target": "com.amazonaws.securityhub#GetAdministratorAccount" }, + { + "target": "com.amazonaws.securityhub#GetConfigurationPolicy" + }, + { + "target": "com.amazonaws.securityhub#GetConfigurationPolicyAssociation" + }, { "target": "com.amazonaws.securityhub#GetEnabledStandards" }, @@ -30246,6 +31571,12 @@ { "target": "com.amazonaws.securityhub#ListAutomationRules" }, + { + "target": "com.amazonaws.securityhub#ListConfigurationPolicies" + }, + { + "target": "com.amazonaws.securityhub#ListConfigurationPolicyAssociations" + }, { "target": "com.amazonaws.securityhub#ListEnabledProductsForImport" }, @@ -30270,6 +31601,12 @@ { "target": "com.amazonaws.securityhub#ListTagsForResource" }, + { + "target": "com.amazonaws.securityhub#StartConfigurationPolicyAssociation" + }, + { + "target": "com.amazonaws.securityhub#StartConfigurationPolicyDisassociation" + }, { "target": "com.amazonaws.securityhub#TagResource" }, @@ -30279,6 +31616,9 @@ { "target": "com.amazonaws.securityhub#UpdateActionTarget" }, + { + "target": "com.amazonaws.securityhub#UpdateConfigurationPolicy" + }, { "target": "com.amazonaws.securityhub#UpdateFindingAggregator" }, @@ -31296,6 +32636,32 @@ } } }, + "com.amazonaws.securityhub#SecurityHubPolicy": { + "type": "structure", + "members": { + "ServiceEnabled": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#documentation": "

\n Indicates whether Security Hub is enabled in the policy.\n

" + } + }, + "EnabledStandardIdentifiers": { + "target": "com.amazonaws.securityhub#EnabledStandardIdentifierList", + "traits": { + "smithy.api#documentation": "

\n A list that defines which security standards are enabled in the configuration policy.\n

" + } + }, + "SecurityControlsConfiguration": { + "target": "com.amazonaws.securityhub#SecurityControlsConfiguration", + "traits": { + "smithy.api#documentation": "

\n An object that defines which security controls are enabled in the configuration policy. The enablement status \n of a control is aligned across all of the enabled standards in an account.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n An object that defines how Security Hub is configured. The configuration policy includes whether \n Security Hub is enabled or disabled, a list of enabled security standards, a list of enabled or \n disabled security controls, and a list of custom parameter values for specified controls. If you provide a list of security controls that are enabled in the configuration \n policy, Security Hub disables all other controls (including newly released controls). If you provide a \n list of security controls that are disabled in the configuration policy, Security Hub enables all other \n controls (including newly released controls).\n

" + } + }, "com.amazonaws.securityhub#SensitiveDataDetections": { "type": "structure", "members": { @@ -31888,13 +33254,13 @@ "UpdatedAt": { "target": "com.amazonaws.securityhub#Timestamp", "traits": { - "smithy.api#documentation": "

The last time that a control's enablement status in a specified standard was updated.

" + "smithy.api#documentation": "

The last time that a control's enablement status in a specified standard was updated.

" } }, "UpdatedReason": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The reason for updating the control's enablement status in a specified standard.

" + "smithy.api#documentation": "

The reason for updating a control's enablement status in a specified standard.

" } }, "StandardsControlTitle": { @@ -32142,6 +33508,216 @@ "target": "com.amazonaws.securityhub#StandardsSubscription" } }, + "com.amazonaws.securityhub#StartConfigurationPolicyAssociation": { + "type": "operation", + "input": { + "target": "com.amazonaws.securityhub#StartConfigurationPolicyAssociationRequest" + }, + "output": { + "target": "com.amazonaws.securityhub#StartConfigurationPolicyAssociationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.securityhub#AccessDeniedException" + }, + { + "target": "com.amazonaws.securityhub#InternalException" + }, + { + "target": "com.amazonaws.securityhub#InvalidAccessException" + }, + { + "target": "com.amazonaws.securityhub#InvalidInputException" + }, + { + "target": "com.amazonaws.securityhub#LimitExceededException" + }, + { + "target": "com.amazonaws.securityhub#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

\n Associates a target account, organizational unit, or the root with a specified configuration. The target can be \n associated with a configuration policy or self-managed behavior. Only the Security Hub delegated administrator can \n invoke this operation from the home Region.\n

", + "smithy.api#examples": [ + { + "title": "To associate a configuration with a target", + "documentation": "This operation associates a configuration policy or self-managed behavior with the target account, organizational unit, or the root.", + "input": { + "ConfigurationPolicyIdentifier": "arn:aws:securityhub:us-east-1:123456789012:configuration-policy/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "Target": { + "AccountId": "111122223333" + } + }, + "output": { + "ConfigurationPolicyId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "TargetId": "111122223333", + "TargetType": "ACCOUNT", + "AssociationType": "APPLIED", + "UpdatedAt": "2023-01-11T06:17:17.154Z", + "AssociationStatus": "SUCCESS", + "AssociationStatusMessage": "This field is populated only if the association fails" + } + } + ], + "smithy.api#http": { + "method": "POST", + "uri": "/configurationPolicyAssociation/associate", + "code": 200 + } + } + }, + "com.amazonaws.securityhub#StartConfigurationPolicyAssociationRequest": { + "type": "structure", + "members": { + "ConfigurationPolicyIdentifier": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) or universally unique identifier (UUID) of the configuration policy.\n

", + "smithy.api#required": {} + } + }, + "Target": { + "target": "com.amazonaws.securityhub#Target", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

\n The identifier of the target account, organizational unit, or the root to associate with the specified configuration.\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.securityhub#StartConfigurationPolicyAssociationResponse": { + "type": "structure", + "members": { + "ConfigurationPolicyId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The UUID of the configuration policy.\n

" + } + }, + "TargetId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The identifier of the target account, organizational unit, or the organization root with which the configuration is associated.\n

" + } + }, + "TargetType": { + "target": "com.amazonaws.securityhub#TargetType", + "traits": { + "smithy.api#documentation": "

\n Indicates whether the target is an Amazon Web Services account, organizational unit, or the organization root.\n

" + } + }, + "AssociationType": { + "target": "com.amazonaws.securityhub#AssociationType", + "traits": { + "smithy.api#documentation": "

\n Indicates whether the association between the specified target and the configuration was directly applied by the \n Security Hub delegated administrator or inherited from a parent.\n

" + } + }, + "UpdatedAt": { + "target": "com.amazonaws.securityhub#Timestamp", + "traits": { + "smithy.api#documentation": "

\n The date and time, in UTC and ISO 8601 format, that the configuration policy association was last updated.\n

" + } + }, + "AssociationStatus": { + "target": "com.amazonaws.securityhub#ConfigurationPolicyAssociationStatus", + "traits": { + "smithy.api#documentation": "

\n The current status of the association between the specified target and the configuration.\n

" + } + }, + "AssociationStatusMessage": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n An explanation for a FAILED value for AssociationStatus.\n

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.securityhub#StartConfigurationPolicyDisassociation": { + "type": "operation", + "input": { + "target": "com.amazonaws.securityhub#StartConfigurationPolicyDisassociationRequest" + }, + "output": { + "target": "com.amazonaws.securityhub#StartConfigurationPolicyDisassociationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.securityhub#AccessDeniedException" + }, + { + "target": "com.amazonaws.securityhub#InternalException" + }, + { + "target": "com.amazonaws.securityhub#InvalidAccessException" + }, + { + "target": "com.amazonaws.securityhub#InvalidInputException" + }, + { + "target": "com.amazonaws.securityhub#LimitExceededException" + }, + { + "target": "com.amazonaws.securityhub#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

\n Disassociates a target account, organizational unit, or the root from a specified configuration. When you \n disassociate a configuration from its target, the target inherits the configuration of the closest parent. If there’s no \n configuration to inherit, the target retains its settings but becomes a self-managed account. A target can be disassociated from \n a configuration policy or self-managed behavior. Only the Security Hub delegated administrator can invoke this \n operation from the home Region.\n

", + "smithy.api#examples": [ + { + "title": "To disassociate a configuration from a target", + "documentation": "This operation disassociates a configuration policy or self-managed behavior from the target account, organizational unit, or the root.", + "input": { + "Target": { + "RootId": "r-f6g7h8i9j0example" + }, + "ConfigurationPolicyIdentifier": "SELF_MANAGED_SECURITY_HUB" + } + } + ], + "smithy.api#http": { + "method": "POST", + "uri": "/configurationPolicyAssociation/disassociate", + "code": 200 + } + } + }, + "com.amazonaws.securityhub#StartConfigurationPolicyDisassociationRequest": { + "type": "structure", + "members": { + "Target": { + "target": "com.amazonaws.securityhub#Target", + "traits": { + "smithy.api#documentation": "

\n The identifier of the target account, organizational unit, or the root to disassociate from the specified configuration.\n

" + } + }, + "ConfigurationPolicyIdentifier": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) or universally unique identifier (UUID) of the configuration policy.\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.securityhub#StartConfigurationPolicyDisassociationResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.securityhub#StatelessCustomActionDefinition": { "type": "structure", "members": { @@ -32484,6 +34060,49 @@ } } }, + "com.amazonaws.securityhub#Target": { + "type": "union", + "members": { + "AccountId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The Amazon Web Services account ID of the target account.\n

" + } + }, + "OrganizationalUnitId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The organizational unit ID of the target organizational unit.\n

" + } + }, + "RootId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The ID of the organization root.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n The target account, organizational unit, or the root that is associated with an Security Hub configuration. The configuration \n can be a configuration policy or self-managed behavior. \n

" + } + }, + "com.amazonaws.securityhub#TargetType": { + "type": "enum", + "members": { + "ACCOUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACCOUNT" + } + }, + "ORGANIZATIONAL_UNIT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ORGANIZATIONAL_UNIT" + } + } + } + }, "com.amazonaws.securityhub#Threat": { "type": "structure", "members": { @@ -32728,6 +34347,38 @@ "target": "com.amazonaws.securityhub#UnprocessedAutomationRule" } }, + "com.amazonaws.securityhub#UnprocessedConfigurationPolicyAssociation": { + "type": "structure", + "members": { + "ConfigurationPolicyAssociationIdentifiers": { + "target": "com.amazonaws.securityhub#ConfigurationPolicyAssociation", + "traits": { + "smithy.api#documentation": "

\n Configuration policy association identifiers that were specified in a BatchGetConfigurationPolicyAssociations \n request but couldn’t be processed due to an error.\n

" + } + }, + "ErrorCode": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n An HTTP status code that identifies why the configuration policy association failed.\n

" + } + }, + "ErrorReason": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n A string that identifies why the configuration policy association failed.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n An array of configuration policy associations, one for each configuration policy association identifier, that \n was specified in a BatchGetConfigurationPolicyAssociations request but couldn’t be processed due \n to an error.\n

" + } + }, + "com.amazonaws.securityhub#UnprocessedConfigurationPolicyAssociationList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#UnprocessedConfigurationPolicyAssociation" + } + }, "com.amazonaws.securityhub#UnprocessedErrorCode": { "type": "enum", "members": { @@ -33084,6 +34735,212 @@ } } }, + "com.amazonaws.securityhub#UpdateConfigurationPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.securityhub#UpdateConfigurationPolicyRequest" + }, + "output": { + "target": "com.amazonaws.securityhub#UpdateConfigurationPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.securityhub#AccessDeniedException" + }, + { + "target": "com.amazonaws.securityhub#InternalException" + }, + { + "target": "com.amazonaws.securityhub#InvalidAccessException" + }, + { + "target": "com.amazonaws.securityhub#InvalidInputException" + }, + { + "target": "com.amazonaws.securityhub#LimitExceededException" + }, + { + "target": "com.amazonaws.securityhub#ResourceConflictException" + }, + { + "target": "com.amazonaws.securityhub#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

\n Updates a configuration policy. Only the Security Hub delegated \n administrator can invoke this operation from the home Region.\n

", + "smithy.api#examples": [ + { + "title": "To update a configuration policy", + "documentation": "This operation updates the specified configuration policy.", + "input": { + "Identifier": "arn:aws:securityhub:us-east-1:123456789012:configuration-policy/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "Name": "TestConfigurationPolicy", + "Description": "Updated configuration policy for testing FSBP and CIS", + "UpdatedReason": "Enabling ACM.2", + "ConfigurationPolicy": { + "SecurityHub": { + "ServiceEnabled": true, + "EnabledStandardIdentifiers": [ + "arn:aws:securityhub:us-east-1::standards/aws-foundational-security-best-practices/v/1.0.0", + "arn:aws:securityhub:::ruleset/cis-aws-foundations-benchmark/v/1.2.0" + ], + "SecurityControlsConfiguration": { + "DisabledSecurityControlIdentifiers": [ + "CloudWatch.1", + "CloudWatch.2" + ], + "SecurityControlCustomParameters": [ + { + "SecurityControlId": "ACM.1", + "Parameters": { + "daysToExpiration": { + "ValueType": "CUSTOM", + "Value": { + "Integer": 21 + } + } + } + } + ] + } + } + } + }, + "output": { + "Arn": "arn:aws:securityhub:us-east-1:123456789012:configuration-policy/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "Id": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "Name": "TestConfigurationPolicy", + "Description": "Updated configuration policy for testing FSBP and CIS", + "UpdatedAt": "2023-01-12T06:17:17.154Z", + "CreatedAt": "2023-01-11T06:17:17.154Z", + "ConfigurationPolicy": { + "SecurityHub": { + "ServiceEnabled": true, + "EnabledStandardIdentifiers": [ + "arn:aws:securityhub:us-east-1::standards/aws-foundational-security-best-practices/v/1.0.0", + "arn:aws:securityhub:::ruleset/cis-aws-foundations-benchmark/v/1.2.0" + ], + "SecurityControlsConfiguration": { + "DisabledSecurityControlIdentifiers": [ + "CloudWatch.1", + "CloudWatch.2" + ], + "SecurityControlCustomParameters": [ + { + "SecurityControlId": "ACM.1", + "Parameters": { + "daysToExpiration": { + "ValueType": "CUSTOM", + "Value": { + "Integer": 21 + } + } + } + } + ] + } + } + } + } + } + ], + "smithy.api#http": { + "method": "PATCH", + "uri": "/configurationPolicy/{Identifier}", + "code": 200 + } + } + }, + "com.amazonaws.securityhub#UpdateConfigurationPolicyRequest": { + "type": "structure", + "members": { + "Identifier": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) or universally unique identifier (UUID) of the configuration policy.\n

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The name of the configuration policy.\n

" + } + }, + "Description": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The description of the configuration policy.\n

" + } + }, + "UpdatedReason": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The reason for updating the configuration policy.\n

" + } + }, + "ConfigurationPolicy": { + "target": "com.amazonaws.securityhub#Policy", + "traits": { + "smithy.api#documentation": "

\n An object that defines how Security Hub is configured. It includes whether Security Hub is enabled or \n disabled, a list of enabled security standards, a list of enabled or disabled security controls, and a list of custom parameter values for specified controls. \n If you provide a list of security controls that are enabled in the configuration policy, Security Hub disables all other controls (including newly \n released controls). If you provide a list of security controls that are disabled in the configuration policy, Security Hub \n enables all other controls (including newly released controls).\n

\n

When updating a configuration policy, provide a complete list of standards that you want to enable and a complete list \n of controls that you want to enable or disable. The updated configuration replaces the current configuration.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.securityhub#UpdateConfigurationPolicyResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The ARN of the configuration policy.\n

" + } + }, + "Id": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The UUID of the configuration policy.\n

" + } + }, + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The name of the configuration policy.\n

" + } + }, + "Description": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The description of the configuration policy.\n

" + } + }, + "UpdatedAt": { + "target": "com.amazonaws.securityhub#Timestamp", + "traits": { + "smithy.api#documentation": "

\n The date and time, in UTC and ISO 8601 format, that the configuration policy was last updated.\n

" + } + }, + "CreatedAt": { + "target": "com.amazonaws.securityhub#Timestamp", + "traits": { + "smithy.api#documentation": "

\n The date and time, in UTC and ISO 8601 format, that the configuration policy was created.\n

" + } + }, + "ConfigurationPolicy": { + "target": "com.amazonaws.securityhub#Policy", + "traits": { + "smithy.api#documentation": "

\n An object that defines how Security Hub is configured. It includes whether Security Hub is enabled or \n disabled, a list of enabled security standards, a list of enabled or disabled security controls, and a list of custom parameter values for specified controls. If the request included a \n list of security controls that are enabled in the configuration policy, Security Hub disables all other controls (including \n newly released controls). If the request included a list of security controls that are disabled in the configuration policy, \n Security Hub enables all other controls (including newly released controls).\n

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.securityhub#UpdateFindingAggregator": { "type": "operation", "input": { @@ -33383,6 +35240,9 @@ "target": "com.amazonaws.securityhub#UpdateOrganizationConfigurationResponse" }, "errors": [ + { + "target": "com.amazonaws.securityhub#AccessDeniedException" + }, { "target": "com.amazonaws.securityhub#InternalException" }, @@ -33394,16 +35254,26 @@ }, { "target": "com.amazonaws.securityhub#LimitExceededException" + }, + { + "target": "com.amazonaws.securityhub#ResourceConflictException" + }, + { + "target": "com.amazonaws.securityhub#ResourceNotFoundException" } ], "traits": { - "smithy.api#documentation": "

Used to update the configuration related to Organizations. Can only be called from a\n Security Hub administrator account.

", + "smithy.api#documentation": "

Updates the configuration of your organization in Security Hub. Only the\n Security Hub administrator account can invoke this operation.

", "smithy.api#examples": [ { "title": "To update organization configuration", - "documentation": "The following example updates the configuration for an organization so that Security Hub is automatically activated for new member accounts. Only the Security Hub administrator account can call this operation.", + "documentation": "This operation updates the way your organization is configured in Security Hub. Only a Security Hub administrator account can invoke this operation.", "input": { - "AutoEnable": true + "AutoEnable": false, + "AutoEnableStandards": "NONE", + "OrganizationConfiguration": { + "ConfigurationType": "CENTRAL" + } } } ], @@ -33421,15 +35291,18 @@ "target": "com.amazonaws.securityhub#Boolean", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

Whether to automatically enable Security Hub for new accounts in the organization.

\n

By default, this is false, and new accounts are not added\n automatically.

\n

To automatically enable Security Hub for new accounts, set this to true.

", + "smithy.api#documentation": "

Whether to automatically enable Security Hub in new member accounts when they join the organization.

\n

If set to true, then Security Hub is automatically enabled in new accounts. If set to false,\n then Security Hub isn't enabled in new accounts automatically. The default value is false.

\n

If the ConfigurationType of your organization is set to CENTRAL, then this field is set \n to false and can't be changed in the home Region and linked Regions. However, in that case, the delegated administrator can create a configuration \n policy in which Security Hub is enabled and associate the policy with new organization accounts.

", "smithy.api#required": {} } }, "AutoEnableStandards": { "target": "com.amazonaws.securityhub#AutoEnableStandards", "traits": { - "smithy.api#documentation": "

Whether to automatically enable Security Hub default standards \n for new member accounts in the organization.

\n

By default, this parameter is equal to DEFAULT, and new member accounts are automatically enabled with default Security Hub standards.

\n

To opt out of enabling default standards for new member accounts, set this parameter equal to NONE.

" + "smithy.api#documentation": "

Whether to automatically enable Security Hub default standards \n in new member accounts when they join the organization.

\n

The default value of this parameter is equal to DEFAULT.

\n

If equal to DEFAULT, then Security Hub default standards are automatically enabled for new member \n accounts. If equal to NONE, then default standards are not automatically enabled for new member \n accounts.

\n

If the ConfigurationType of your organization is set to CENTRAL, then this field is set \n to NONE and can't be changed in the home Region and linked Regions. However, in that case, the delegated administrator can create a configuration \n policy in which specific security standards are enabled and associate the policy with new organization accounts.

" } + }, + "OrganizationConfiguration": { + "target": "com.amazonaws.securityhub#OrganizationConfiguration" } }, "traits": { @@ -33452,6 +35325,9 @@ "target": "com.amazonaws.securityhub#UpdateSecurityControlResponse" }, "errors": [ + { + "target": "com.amazonaws.securityhub#AccessDeniedException" + }, { "target": "com.amazonaws.securityhub#InternalException" }, @@ -33545,6 +35421,9 @@ "target": "com.amazonaws.securityhub#UpdateSecurityHubConfigurationResponse" }, "errors": [ + { + "target": "com.amazonaws.securityhub#AccessDeniedException" + }, { "target": "com.amazonaws.securityhub#InternalException" }, @@ -33616,6 +35495,9 @@ "target": "com.amazonaws.securityhub#UpdateStandardsControlResponse" }, "errors": [ + { + "target": "com.amazonaws.securityhub#AccessDeniedException" + }, { "target": "com.amazonaws.securityhub#InternalException" }, diff --git a/codegen/sdk-codegen/aws-models/transcribe.json b/codegen/sdk-codegen/aws-models/transcribe.json index de4524b4288..61361b501d7 100644 --- a/codegen/sdk-codegen/aws-models/transcribe.json +++ b/codegen/sdk-codegen/aws-models/transcribe.json @@ -159,7 +159,7 @@ "LanguageCode": { "target": "com.amazonaws.transcribe#LanguageCode", "traits": { - "smithy.api#documentation": "

The language code used to create your Call Analytics job. For a list of supported\n languages and their associated language codes, refer to the Supported languages\n table.

\n

If you don't know the language spoken in your media file, you can omit this field and\n let Amazon Transcribe automatically identify the language of your media. To improve the\n accuracy of language identification, you can include several language codes and Amazon Transcribe chooses the closest match for your transcription.

" + "smithy.api#documentation": "

The language code used to create your Call Analytics job. For a list of supported\n languages and their associated language codes, refer to the Supported languages\n table.

\n

If you do not know the language spoken in your media file, you can omit this field and\n let Amazon Transcribe automatically identify the language of your media. To improve the\n accuracy of language identification, you can include several language codes and Amazon Transcribe chooses the closest match for your transcription.

" } }, "MediaSampleRateHertz": { @@ -204,7 +204,7 @@ "FailureReason": { "target": "com.amazonaws.transcribe#FailureReason", "traits": { - "smithy.api#documentation": "

If CallAnalyticsJobStatus is FAILED,\n FailureReason contains information about why the Call Analytics job\n request failed.

\n

The FailureReason field contains one of the following values:

\n " + "smithy.api#documentation": "

If CallAnalyticsJobStatus is FAILED,\n FailureReason contains information about why the Call Analytics job\n request failed.

\n

The FailureReason field contains one of the following values:

\n " } }, "DataAccessRoleArn": { @@ -270,7 +270,7 @@ "LanguageModelName": { "target": "com.amazonaws.transcribe#ModelName", "traits": { - "smithy.api#documentation": "

The name of the custom language model you want to use when processing your Call\n Analytics job. Note that custom language model names are case sensitive.

\n

The language of the specified custom language model must match the language code that\n you specify in your transcription request. If the languages don't match, the custom\n language model isn't applied. There are no errors or warnings associated with a language\n mismatch.

" + "smithy.api#documentation": "

The name of the custom language model you want to use when processing your Call\n Analytics job. Note that custom language model names are case sensitive.

\n

The language of the specified custom language model must match the language code that\n you specify in your transcription request. If the languages do not match, the custom\n language model isn't applied. There are no errors or warnings associated with a language\n mismatch.

" } }, "ContentRedaction": { @@ -500,7 +500,7 @@ "RedactionType": { "target": "com.amazonaws.transcribe#RedactionType", "traits": { - "smithy.api#documentation": "

Specify the category of information you want to redact; PII (personally\n identifiable information) is the only valid value. You can use\n PiiEntityTypes to choose which types of PII you want to redact.

", + "smithy.api#documentation": "

Specify the category of information you want to redact; PII (personally\n identifiable information) is the only valid value. You can use PiiEntityTypes to \n choose which types of PII you want to redact. If you do not include PiiEntityTypes in \n your request, all PII is redacted.

", "smithy.api#required": {} } }, @@ -514,12 +514,12 @@ "PiiEntityTypes": { "target": "com.amazonaws.transcribe#PiiEntityTypes", "traits": { - "smithy.api#documentation": "

Specify which types of personally identifiable information (PII) you want to redact in\n your transcript. You can include as many types as you'd like, or you can select\n ALL.

" + "smithy.api#documentation": "

Specify which types of personally identifiable information (PII) you want to redact in\n your transcript. You can include as many types as you'd like, or you can select\n ALL. If you do not include PiiEntityTypes in your request, all PII is \n redacted.

" } } }, "traits": { - "smithy.api#documentation": "

Makes it possible to redact or flag specified personally identifiable information\n (PII) in your transcript. If you use ContentRedaction, you must also\n include the sub-parameters: PiiEntityTypes, RedactionOutput,\n and RedactionType.

" + "smithy.api#documentation": "

Makes it possible to redact or flag specified personally identifiable information (PII) in \n your transcript. If you use ContentRedaction, you must also include the \n sub-parameters: RedactionOutput and RedactionType. You can \n optionally include PiiEntityTypes to choose which types of PII you want to \n redact.

" } }, "com.amazonaws.transcribe#CreateCallAnalyticsCategory": { @@ -633,7 +633,7 @@ "LanguageCode": { "target": "com.amazonaws.transcribe#CLMLanguageCode", "traits": { - "smithy.api#documentation": "

The language code that represents the language of your model. Each custom language\n model must contain terms in only one language, and the language you select for your\n custom language model must match the language of your training and tuning data.

\n

For a list of supported languages and their associated language codes, refer to the\n Supported languages table. Note that\n US English\n (en-US) is the only language supported with Amazon Transcribe\n Medical.

\n

A custom language model can only be used to transcribe files in the same language as\n the model. For example, if you create a custom language model using US English\n (en-US), you can only apply this model to files that contain English\n audio.

", + "smithy.api#documentation": "

The language code that represents the language of your model. Each custom language\n model must contain terms in only one language, and the language you select for your\n custom language model must match the language of your training and tuning data.

\n

For a list of supported languages and their associated language codes, refer to the\n Supported languages table. Note that US English (en-US) is the \n only language supported with Amazon Transcribe Medical.

\n

A custom language model can only be used to transcribe files in the same language as\n the model. For example, if you create a custom language model using US English\n (en-US), you can only apply this model to files that contain English\n audio.

", "smithy.api#required": {} } }, @@ -1195,6 +1195,50 @@ "smithy.api#input": {} } }, + "com.amazonaws.transcribe#DeleteMedicalScribeJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.transcribe#DeleteMedicalScribeJobRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.transcribe#BadRequestException" + }, + { + "target": "com.amazonaws.transcribe#InternalFailureException" + }, + { + "target": "com.amazonaws.transcribe#LimitExceededException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a Medical Scribe job. To use this operation, specify the name of the\n job you want to delete using MedicalScribeJobName. Job names are\n case sensitive.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/medicalscribejobs/{MedicalScribeJobName}", + "code": 204 + } + } + }, + "com.amazonaws.transcribe#DeleteMedicalScribeJobRequest": { + "type": "structure", + "members": { + "MedicalScribeJobName": { + "target": "com.amazonaws.transcribe#TranscriptionJobName", + "traits": { + "smithy.api#documentation": "

The name of the Medical Scribe job you want to delete. Job names are case\n sensitive.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, "com.amazonaws.transcribe#DeleteMedicalTranscriptionJob": { "type": "operation", "input": { @@ -1613,6 +1657,67 @@ "smithy.api#output": {} } }, + "com.amazonaws.transcribe#GetMedicalScribeJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.transcribe#GetMedicalScribeJobRequest" + }, + "output": { + "target": "com.amazonaws.transcribe#GetMedicalScribeJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.transcribe#BadRequestException" + }, + { + "target": "com.amazonaws.transcribe#InternalFailureException" + }, + { + "target": "com.amazonaws.transcribe#LimitExceededException" + }, + { + "target": "com.amazonaws.transcribe#NotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Provides information about the specified Medical Scribe job.

\n

To view the status of the specified medical transcription job, check the\n MedicalScribeJobStatus field. If the status is COMPLETED,\n the job is finished. You can find the results at the location specified in\n MedicalScribeOutput. \n If the status is FAILED, FailureReason provides details on why your Medical Scribe job\n failed.

\n

To get a list of your Medical Scribe jobs, use the operation.

", + "smithy.api#http": { + "method": "GET", + "uri": "/medicalscribejobs/{MedicalScribeJobName}", + "code": 200 + } + } + }, + "com.amazonaws.transcribe#GetMedicalScribeJobRequest": { + "type": "structure", + "members": { + "MedicalScribeJobName": { + "target": "com.amazonaws.transcribe#TranscriptionJobName", + "traits": { + "smithy.api#documentation": "

The name of the Medical Scribe job you want information about. Job names are\n case sensitive.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.transcribe#GetMedicalScribeJobResponse": { + "type": "structure", + "members": { + "MedicalScribeJob": { + "target": "com.amazonaws.transcribe#MedicalScribeJob", + "traits": { + "smithy.api#documentation": "

Provides detailed information about the specified Medical Scribe job, including \n job status and, if applicable, failure reason

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.transcribe#GetMedicalTranscriptionJob": { "type": "operation", "input": { @@ -1757,7 +1862,7 @@ "DownloadUri": { "target": "com.amazonaws.transcribe#Uri", "traits": { - "smithy.api#documentation": "

The S3 location where the specified custom medical vocabulary is stored; use this URI\n to view or download the custom vocabulary.

" + "smithy.api#documentation": "

The Amazon S3 location where the specified custom medical vocabulary is stored; use this URI\n to view or download the custom vocabulary.

" } } }, @@ -1988,7 +2093,7 @@ "DownloadUri": { "target": "com.amazonaws.transcribe#Uri", "traits": { - "smithy.api#documentation": "

The S3 location where the custom vocabulary is stored; use this URI to view or\n download the custom vocabulary.

" + "smithy.api#documentation": "

The Amazon S3 location where the custom vocabulary is stored; use this URI to view or\n download the custom vocabulary.

" } } }, @@ -2795,19 +2900,19 @@ "VocabularyName": { "target": "com.amazonaws.transcribe#VocabularyName", "traits": { - "smithy.api#documentation": "

The name of the custom vocabulary you want to use when processing your transcription\n job. Custom vocabulary names are case sensitive.

\n

The language of the specified custom vocabulary must match the language code that you\n specify in your transcription request. If the languages don't match, the custom\n vocabulary isn't applied. There are no errors or warnings associated with a language\n mismatch.

" + "smithy.api#documentation": "

The name of the custom vocabulary you want to use when processing your transcription\n job. Custom vocabulary names are case sensitive.

\n

The language of the specified custom vocabulary must match the language code that you\n specify in your transcription request. If the languages do not match, the custom\n vocabulary isn't applied. There are no errors or warnings associated with a language\n mismatch.

" } }, "VocabularyFilterName": { "target": "com.amazonaws.transcribe#VocabularyFilterName", "traits": { - "smithy.api#documentation": "

The name of the custom vocabulary filter you want to use when processing your\n transcription job. Custom vocabulary filter names are case sensitive.

\n

The language of the specified custom vocabulary filter must match the language code\n that you specify in your transcription request. If the languages don't match, the custom\n vocabulary filter isn't applied. There are no errors or warnings associated with a\n language mismatch.

\n

Note that if you include VocabularyFilterName in your request, you must\n also include VocabularyFilterMethod.

" + "smithy.api#documentation": "

The name of the custom vocabulary filter you want to use when processing your\n transcription job. Custom vocabulary filter names are case sensitive.

\n

The language of the specified custom vocabulary filter must match the language code\n that you specify in your transcription request. If the languages do not match, the custom\n vocabulary filter isn't applied. There are no errors or warnings associated with a\n language mismatch.

\n

Note that if you include VocabularyFilterName in your request, you must\n also include VocabularyFilterMethod.

" } }, "LanguageModelName": { "target": "com.amazonaws.transcribe#ModelName", "traits": { - "smithy.api#documentation": "

The name of the custom language model you want to use when processing your\n transcription job. Note that custom language model names are case sensitive.

\n

The language of the specified custom language model must match the language code that\n you specify in your transcription request. If the languages don't match, the custom\n language model isn't applied. There are no errors or warnings associated with a language\n mismatch.

" + "smithy.api#documentation": "

The name of the custom language model you want to use when processing your\n transcription job. Note that custom language model names are case sensitive.

\n

The language of the specified custom language model must match the language code that\n you specify in your transcription request. If the languages do not match, the custom\n language model isn't applied. There are no errors or warnings associated with a language\n mismatch.

" } } }, @@ -2854,7 +2959,7 @@ "LanguageCode": { "target": "com.amazonaws.transcribe#CLMLanguageCode", "traits": { - "smithy.api#documentation": "

The language code used to create your custom language model. Each custom language\n model must contain terms in only one language, and the language you select for your\n custom language model must match the language of your training and tuning data.

\n

For a list of supported languages and their associated language codes, refer to the\n Supported languages table. Note that U.S. English (en-US) is\n the only language supported with Amazon Transcribe Medical.

" + "smithy.api#documentation": "

The language code used to create your custom language model. Each custom language\n model must contain terms in only one language, and the language you select for your\n custom language model must match the language of your training and tuning data.

\n

For a list of supported languages and their associated language codes, refer to the\n Supported languages table. Note that US English (en-US) is\n the only language supported with Amazon Transcribe Medical.

" } }, "BaseModelName": { @@ -2962,7 +3067,7 @@ "MaxResults": { "target": "com.amazonaws.transcribe#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of Call Analytics categories to return in each page of results. If\n there are fewer results than the value that you specify, only the actual results are\n returned. If you don't specify a value, a default of 5 is used.

", + "smithy.api#documentation": "

The maximum number of Call Analytics categories to return in each page of results. If\n there are fewer results than the value that you specify, only the actual results are\n returned. If you do not specify a value, a default of 5 is used.

", "smithy.api#httpQuery": "MaxResults" } } @@ -3030,7 +3135,7 @@ "Status": { "target": "com.amazonaws.transcribe#CallAnalyticsJobStatus", "traits": { - "smithy.api#documentation": "

Returns only Call Analytics jobs with the specified status. Jobs are ordered by\n creation date, with the newest job first. If you don't include Status, all\n Call Analytics jobs are returned.

", + "smithy.api#documentation": "

Returns only Call Analytics jobs with the specified status. Jobs are ordered by\n creation date, with the newest job first. If you do not include Status, all\n Call Analytics jobs are returned.

", "smithy.api#httpQuery": "Status" } }, @@ -3051,7 +3156,7 @@ "MaxResults": { "target": "com.amazonaws.transcribe#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of Call Analytics jobs to return in each page of results. If there\n are fewer results than the value that you specify, only the actual results are returned.\n If you don't specify a value, a default of 5 is used.

", + "smithy.api#documentation": "

The maximum number of Call Analytics jobs to return in each page of results. If there\n are fewer results than the value that you specify, only the actual results are returned.\n If you do not specify a value, a default of 5 is used.

", "smithy.api#httpQuery": "MaxResults" } } @@ -3125,7 +3230,7 @@ "StatusEquals": { "target": "com.amazonaws.transcribe#ModelStatus", "traits": { - "smithy.api#documentation": "

Returns only custom language models with the specified status. Language models are\n ordered by creation date, with the newest model first. If you don't include\n StatusEquals, all custom language models are returned.

", + "smithy.api#documentation": "

Returns only custom language models with the specified status. Language models are\n ordered by creation date, with the newest model first. If you do not include\n StatusEquals, all custom language models are returned.

", "smithy.api#httpQuery": " StatusEquals" } }, @@ -3146,7 +3251,7 @@ "MaxResults": { "target": "com.amazonaws.transcribe#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of custom language models to return in each page of results. If\n there are fewer results than the value that you specify, only the actual results are\n returned. If you don't specify a value, a default of 5 is used.

", + "smithy.api#documentation": "

The maximum number of custom language models to return in each page of results. If\n there are fewer results than the value that you specify, only the actual results are\n returned. If you do not specify a value, a default of 5 is used.

", "smithy.api#httpQuery": "MaxResults" } } @@ -3175,6 +3280,101 @@ "smithy.api#output": {} } }, + "com.amazonaws.transcribe#ListMedicalScribeJobs": { + "type": "operation", + "input": { + "target": "com.amazonaws.transcribe#ListMedicalScribeJobsRequest" + }, + "output": { + "target": "com.amazonaws.transcribe#ListMedicalScribeJobsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.transcribe#BadRequestException" + }, + { + "target": "com.amazonaws.transcribe#InternalFailureException" + }, + { + "target": "com.amazonaws.transcribe#LimitExceededException" + } + ], + "traits": { + "smithy.api#documentation": "

Provides a list of Medical Scribe jobs that match the specified criteria. If no\n criteria are specified, all Medical Scribe jobs are returned.

\n

To get detailed information about a specific Medical Scribe job, use the operation.

", + "smithy.api#http": { + "method": "GET", + "uri": "/medicalscribejobs", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.transcribe#ListMedicalScribeJobsRequest": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.transcribe#MedicalScribeJobStatus", + "traits": { + "smithy.api#documentation": "

Returns only Medical Scribe jobs with the specified status. Jobs are ordered by\n creation date, with the newest job first. If you do not include Status, all\n Medical Scribe jobs are returned.

", + "smithy.api#httpQuery": "Status" + } + }, + "JobNameContains": { + "target": "com.amazonaws.transcribe#TranscriptionJobName", + "traits": { + "smithy.api#documentation": "

Returns only the Medical Scribe jobs that contain the specified string. The\n search is not case sensitive.

", + "smithy.api#httpQuery": "JobNameContains" + } + }, + "NextToken": { + "target": "com.amazonaws.transcribe#NextToken", + "traits": { + "smithy.api#documentation": "

If your ListMedicalScribeJobs request returns more results than\n can be displayed, NextToken is displayed in the response with an associated\n string. To get the next page of results, copy this string and repeat your request,\n including NextToken with the value of the copied string. Repeat as needed\n to view all your results.

", + "smithy.api#httpQuery": "NextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.transcribe#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of Medical Scribe jobs to return in each page of results. If\n there are fewer results than the value that you specify, only the actual results are\n returned. If you do not specify a value, a default of 5 is used.

", + "smithy.api#httpQuery": "MaxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.transcribe#ListMedicalScribeJobsResponse": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.transcribe#MedicalScribeJobStatus", + "traits": { + "smithy.api#documentation": "

Lists all Medical Scribe jobs that have the status specified in your request.\n Jobs are ordered by creation date, with the newest job first.

" + } + }, + "NextToken": { + "target": "com.amazonaws.transcribe#NextToken", + "traits": { + "smithy.api#documentation": "

If NextToken is present in your response, it indicates that not all\n results are displayed. To view the next set of results, copy the string associated with\n the NextToken parameter in your results output, then run your request again\n including NextToken with the value of the copied string. Repeat as needed\n to view all your results.

" + } + }, + "MedicalScribeJobSummaries": { + "target": "com.amazonaws.transcribe#MedicalScribeJobSummaries", + "traits": { + "smithy.api#documentation": "

Provides a summary of information about each result.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.transcribe#ListMedicalTranscriptionJobs": { "type": "operation", "input": { @@ -3214,7 +3414,7 @@ "Status": { "target": "com.amazonaws.transcribe#TranscriptionJobStatus", "traits": { - "smithy.api#documentation": "

Returns only medical transcription jobs with the specified status. Jobs are ordered by\n creation date, with the newest job first. If you don't include Status, all\n medical transcription jobs are returned.

", + "smithy.api#documentation": "

Returns only medical transcription jobs with the specified status. Jobs are ordered by\n creation date, with the newest job first. If you do not include Status, all\n medical transcription jobs are returned.

", "smithy.api#httpQuery": "Status" } }, @@ -3235,7 +3435,7 @@ "MaxResults": { "target": "com.amazonaws.transcribe#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of medical transcription jobs to return in each page of results. If\n there are fewer results than the value that you specify, only the actual results are\n returned. If you don't specify a value, a default of 5 is used.

", + "smithy.api#documentation": "

The maximum number of medical transcription jobs to return in each page of results. If\n there are fewer results than the value that you specify, only the actual results are\n returned. If you do not specify a value, a default of 5 is used.

", "smithy.api#httpQuery": "MaxResults" } } @@ -3316,14 +3516,14 @@ "MaxResults": { "target": "com.amazonaws.transcribe#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of custom medical vocabularies to return in each page of results.\n If there are fewer results than the value that you specify, only the actual results are\n returned. If you don't specify a value, a default of 5 is used.

", + "smithy.api#documentation": "

The maximum number of custom medical vocabularies to return in each page of results.\n If there are fewer results than the value that you specify, only the actual results are\n returned. If you do not specify a value, a default of 5 is used.

", "smithy.api#httpQuery": "MaxResults" } }, "StateEquals": { "target": "com.amazonaws.transcribe#VocabularyState", "traits": { - "smithy.api#documentation": "

Returns only custom medical vocabularies with the specified state. Custom vocabularies\n are ordered by creation date, with the newest vocabulary first. If you don't include\n StateEquals, all custom medical vocabularies are returned.

", + "smithy.api#documentation": "

Returns only custom medical vocabularies with the specified state. Custom vocabularies\n are ordered by creation date, with the newest vocabulary first. If you do not include\n StateEquals, all custom medical vocabularies are returned.

", "smithy.api#httpQuery": "StateEquals" } }, @@ -3471,7 +3671,7 @@ "Status": { "target": "com.amazonaws.transcribe#TranscriptionJobStatus", "traits": { - "smithy.api#documentation": "

Returns only transcription jobs with the specified status. Jobs are ordered by\n creation date, with the newest job first. If you don't include Status, all\n transcription jobs are returned.

", + "smithy.api#documentation": "

Returns only transcription jobs with the specified status. Jobs are ordered by\n creation date, with the newest job first. If you do not include Status, all\n transcription jobs are returned.

", "smithy.api#httpQuery": "Status" } }, @@ -3492,7 +3692,7 @@ "MaxResults": { "target": "com.amazonaws.transcribe#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of transcription jobs to return in each page of results. If there\n are fewer results than the value that you specify, only the actual results are returned.\n If you don't specify a value, a default of 5 is used.

", + "smithy.api#documentation": "

The maximum number of transcription jobs to return in each page of results. If there\n are fewer results than the value that you specify, only the actual results are returned.\n If you do not specify a value, a default of 5 is used.

", "smithy.api#httpQuery": "MaxResults" } } @@ -3573,14 +3773,14 @@ "MaxResults": { "target": "com.amazonaws.transcribe#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of custom vocabularies to return in each page of results. If there\n are fewer results than the value that you specify, only the actual results are returned.\n If you don't specify a value, a default of 5 is used.

", + "smithy.api#documentation": "

The maximum number of custom vocabularies to return in each page of results. If there\n are fewer results than the value that you specify, only the actual results are returned.\n If you do not specify a value, a default of 5 is used.

", "smithy.api#httpQuery": "MaxResults" } }, "StateEquals": { "target": "com.amazonaws.transcribe#VocabularyState", "traits": { - "smithy.api#documentation": "

Returns only custom vocabularies with the specified state. Vocabularies are ordered by\n creation date, with the newest vocabulary first. If you don't include\n StateEquals, all custom medical vocabularies are returned.

", + "smithy.api#documentation": "

Returns only custom vocabularies with the specified state. Vocabularies are ordered by\n creation date, with the newest vocabulary first. If you do not include\n StateEquals, all custom medical vocabularies are returned.

", "smithy.api#httpQuery": "StateEquals" } }, @@ -3668,7 +3868,7 @@ "MaxResults": { "target": "com.amazonaws.transcribe#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of custom vocabulary filters to return in each page of results. If\n there are fewer results than the value that you specify, only the actual results are\n returned. If you don't specify a value, a default of 5 is used.

", + "smithy.api#documentation": "

The maximum number of custom vocabulary filters to return in each page of results. If\n there are fewer results than the value that you specify, only the actual results are\n returned. If you do not specify a value, a default of 5 is used.

", "smithy.api#httpQuery": "MaxResults" } }, @@ -3748,7 +3948,7 @@ } }, "traits": { - "smithy.api#documentation": "

Describes the Amazon S3 location of the media file you want to use in your\n request.

\n

For information on supported media formats, refer to the MediaFormat parameter or the Media formats section \n in the Amazon S3 Developer Guide.

" + "smithy.api#documentation": "

Describes the Amazon S3 location of the media file you want to use in your\n request.

\n

For information on supported media formats, refer to the MediaFormat \n parameter or the Media formats section \n in the Amazon S3 Developer Guide.

" } }, "com.amazonaws.transcribe#MediaFormat": { @@ -3833,6 +4033,313 @@ } } }, + "com.amazonaws.transcribe#MedicalScribeChannelDefinition": { + "type": "structure", + "members": { + "ChannelId": { + "target": "com.amazonaws.transcribe#MedicalScribeChannelId", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

Specify the audio channel you want to define.

", + "smithy.api#required": {} + } + }, + "ParticipantRole": { + "target": "com.amazonaws.transcribe#MedicalScribeParticipantRole", + "traits": { + "smithy.api#documentation": "

Specify the participant that you want to flag. \n The options are CLINICIAN and PATIENT\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Indicates which speaker is on which channel. The options are \n CLINICIAN and PATIENT\n

" + } + }, + "com.amazonaws.transcribe#MedicalScribeChannelDefinitions": { + "type": "list", + "member": { + "target": "com.amazonaws.transcribe#MedicalScribeChannelDefinition" + }, + "traits": { + "smithy.api#length": { + "min": 2, + "max": 2 + } + } + }, + "com.amazonaws.transcribe#MedicalScribeChannelId": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.transcribe#MedicalScribeJob": { + "type": "structure", + "members": { + "MedicalScribeJobName": { + "target": "com.amazonaws.transcribe#TranscriptionJobName", + "traits": { + "smithy.api#documentation": "

The name of the Medical Scribe job. Job names are case sensitive and must be\n unique within an Amazon Web Services account.

" + } + }, + "MedicalScribeJobStatus": { + "target": "com.amazonaws.transcribe#MedicalScribeJobStatus", + "traits": { + "smithy.api#documentation": "

Provides the status of the specified Medical Scribe job.

\n

If the status is COMPLETED, the job is finished and you can find the\n results at the location specified in MedicalScribeOutput If\n the status is FAILED, FailureReason provides details on why\n your Medical Scribe job failed.

" + } + }, + "LanguageCode": { + "target": "com.amazonaws.transcribe#MedicalScribeLanguageCode", + "traits": { + "smithy.api#documentation": "

The language code used to create your Medical Scribe job. US English\n (en-US) is the only supported language for Medical Scribe jobs.

" + } + }, + "Media": { + "target": "com.amazonaws.transcribe#Media" + }, + "MedicalScribeOutput": { + "target": "com.amazonaws.transcribe#MedicalScribeOutput", + "traits": { + "smithy.api#documentation": "

The location of the output of your Medical Scribe job. \n ClinicalDocumentUri holds the Amazon S3 URI for the Clinical Document \n and TranscriptFileUri holds the Amazon S3 URI for the Transcript.

" + } + }, + "StartTime": { + "target": "com.amazonaws.transcribe#DateTime", + "traits": { + "smithy.api#documentation": "

The date and time your Medical Scribe job began processing.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.789000-07:00 represents a Medical Scribe job\n that started processing at 12:32 PM UTC-7 on May 4, 2022.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.transcribe#DateTime", + "traits": { + "smithy.api#documentation": "

The date and time the specified Medical Scribe job request was made.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents a Medical Scribe job\n that started processing at 12:32 PM UTC-7 on May 4, 2022.

" + } + }, + "CompletionTime": { + "target": "com.amazonaws.transcribe#DateTime", + "traits": { + "smithy.api#documentation": "

The date and time the specified Medical Scribe job finished processing.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents a Medical Scribe job\n that finished processing at 12:32 PM UTC-7 on May 4, 2022.

" + } + }, + "FailureReason": { + "target": "com.amazonaws.transcribe#FailureReason", + "traits": { + "smithy.api#documentation": "

If MedicalScribeJobStatus is FAILED,\n FailureReason contains information about why the transcription job\n failed. See also: Common Errors.

" + } + }, + "Settings": { + "target": "com.amazonaws.transcribe#MedicalScribeSettings", + "traits": { + "smithy.api#documentation": "

Makes it possible to control how your Medical Scribe job is processed using a\n MedicalScribeSettings object. Specify ChannelIdentification if \n ChannelDefinitions are set. Enabled ShowSpeakerLabels if ChannelIdentification \n and ChannelDefinitions are not set. One and only one of ChannelIdentification and ShowSpeakerLabels\n must be set. If ShowSpeakerLabels is set, MaxSpeakerLabels must also be set. Use Settings\n to specify a vocabulary or vocabulary filter or both using VocabularyName, VocabularyFilterName. \n VocabularyFilterMethod must be specified if VocabularyFilterName is set.\n

" + } + }, + "DataAccessRoleArn": { + "target": "com.amazonaws.transcribe#DataAccessRoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM role that has permissions to\n access the Amazon S3 bucket that contains your input files, \n write to the output bucket, and use your KMS key if supplied. \n If the role that you specify doesn’t have the appropriate permissions your request fails.

\n

IAM role ARNs have the format\n arn:partition:iam::account:role/role-name-with-path. For example:\n arn:aws:iam::111122223333:role/Admin.

\n

For more information, see IAM\n ARNs.

" + } + }, + "ChannelDefinitions": { + "target": "com.amazonaws.transcribe#MedicalScribeChannelDefinitions", + "traits": { + "smithy.api#documentation": "

Makes it possible to specify which speaker is on which channel. For example, if the clinician\n is the first participant to speak, you would set ChannelId of the first ChannelDefinition \n in the list to 0 (to indicate the first channel) and ParticipantRole to\n CLINICIAN (to indicate that it's the clinician speaking).\n Then you would set the ChannelId of the second ChannelDefinition in the list to\n 1 (to indicate the second channel) and ParticipantRole to\n PATIENT (to indicate that it's the patient speaking).\n

" + } + }, + "Tags": { + "target": "com.amazonaws.transcribe#TagList", + "traits": { + "smithy.api#documentation": "

Adds one or more custom tags, each in the form of a key:value pair, to the Medica Scribe job.

\n

To learn more about using tags with Amazon Transcribe, refer to Tagging\n resources.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides detailed information about a Medical Scribe job.

\n

To view the status of the specified Medical Scribe job, check the\n MedicalScribeJobStatus field. If the status is COMPLETED,\n the job is finished and you can find the results at the locations specified in\n MedicalScribeOutput. If the status is FAILED,\n FailureReason provides details on why your Medical Scribe job\n failed.

" + } + }, + "com.amazonaws.transcribe#MedicalScribeJobStatus": { + "type": "enum", + "members": { + "QUEUED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QUEUED" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" + } + } + } + }, + "com.amazonaws.transcribe#MedicalScribeJobSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.transcribe#MedicalScribeJobSummary" + } + }, + "com.amazonaws.transcribe#MedicalScribeJobSummary": { + "type": "structure", + "members": { + "MedicalScribeJobName": { + "target": "com.amazonaws.transcribe#TranscriptionJobName", + "traits": { + "smithy.api#documentation": "

The name of the Medical Scribe job. Job names are case sensitive and must be\n unique within an Amazon Web Services account.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.transcribe#DateTime", + "traits": { + "smithy.api#documentation": "

The date and time the specified Medical Scribe job request was made.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents a Medical Scribe job\n that started processing at 12:32 PM UTC-7 on May 4, 2022.

" + } + }, + "StartTime": { + "target": "com.amazonaws.transcribe#DateTime", + "traits": { + "smithy.api#documentation": "

The date and time your Medical Scribe job began processing.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.789000-07:00 represents a Medical Scribe job\n that started processing at 12:32 PM UTC-7 on May 4, 2022.

" + } + }, + "CompletionTime": { + "target": "com.amazonaws.transcribe#DateTime", + "traits": { + "smithy.api#documentation": "

The date and time the specified Medical Scribe job finished processing.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents a Medical Scribe job\n that finished processing at 12:32 PM UTC-7 on May 4, 2022.

" + } + }, + "LanguageCode": { + "target": "com.amazonaws.transcribe#MedicalScribeLanguageCode", + "traits": { + "smithy.api#documentation": "

The language code used to create your Medical Scribe job. US English\n (en-US) is the only supported language for Medical Scribe jobs.

" + } + }, + "MedicalScribeJobStatus": { + "target": "com.amazonaws.transcribe#MedicalScribeJobStatus", + "traits": { + "smithy.api#documentation": "

Provides the status of the specified Medical Scribe job.

\n

If the status is COMPLETED, the job is finished and you can find the\n results at the location specified in MedicalScribeOutput If\n the status is FAILED, FailureReason provides details on why\n your Medical Scribe job failed.

" + } + }, + "FailureReason": { + "target": "com.amazonaws.transcribe#FailureReason", + "traits": { + "smithy.api#documentation": "

If MedicalScribeJobStatus is FAILED,\n FailureReason contains information about why the transcription job\n failed. See also: Common Errors.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides detailed information about a specific Medical Scribe job.

" + } + }, + "com.amazonaws.transcribe#MedicalScribeLanguageCode": { + "type": "enum", + "members": { + "EN_US": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "en-US" + } + } + } + }, + "com.amazonaws.transcribe#MedicalScribeOutput": { + "type": "structure", + "members": { + "TranscriptFileUri": { + "target": "com.amazonaws.transcribe#Uri", + "traits": { + "smithy.api#documentation": "

Holds the Amazon S3 URI for the Transcript.

", + "smithy.api#required": {} + } + }, + "ClinicalDocumentUri": { + "target": "com.amazonaws.transcribe#Uri", + "traits": { + "smithy.api#documentation": "

Holds the Amazon S3 URI for the Clinical Document.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The location of the output of your Medical Scribe job. \n ClinicalDocumentUri holds the Amazon S3 URI for the Clinical Document \n and TranscriptFileUri holds the Amazon S3 URI for the Transcript.

" + } + }, + "com.amazonaws.transcribe#MedicalScribeParticipantRole": { + "type": "enum", + "members": { + "PATIENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PATIENT" + } + }, + "CLINICIAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CLINICIAN" + } + } + } + }, + "com.amazonaws.transcribe#MedicalScribeSettings": { + "type": "structure", + "members": { + "ShowSpeakerLabels": { + "target": "com.amazonaws.transcribe#Boolean", + "traits": { + "smithy.api#documentation": "

Enables speaker partitioning (diarization) in your Medical Scribe output. Speaker\n partitioning labels the speech from individual speakers in your media file.

\n

If you enable ShowSpeakerLabels in your request, you must also include\n MaxSpeakerLabels.

\n

For more information, see Partitioning speakers\n (diarization).

" + } + }, + "MaxSpeakerLabels": { + "target": "com.amazonaws.transcribe#MaxSpeakers", + "traits": { + "smithy.api#documentation": "

Specify the maximum number of speakers you want to partition in your media.

\n

Note that if your media contains more speakers than the specified number, multiple\n speakers are treated as a single speaker.

\n

If you specify the MaxSpeakerLabels field, you must set the\n ShowSpeakerLabels field to true.

" + } + }, + "ChannelIdentification": { + "target": "com.amazonaws.transcribe#Boolean", + "traits": { + "smithy.api#documentation": "

Enables channel identification in multi-channel audio.

\n

Channel identification transcribes the audio on each channel independently, then\n appends the output for each channel into one transcript.

\n

For more information, see Transcribing multi-channel\n audio.

" + } + }, + "VocabularyName": { + "target": "com.amazonaws.transcribe#VocabularyName", + "traits": { + "smithy.api#documentation": "

The name of the custom vocabulary you want to include in your Medical Scribe\n request. Custom vocabulary names are case sensitive.

" + } + }, + "VocabularyFilterName": { + "target": "com.amazonaws.transcribe#VocabularyFilterName", + "traits": { + "smithy.api#documentation": "

The name of the custom vocabulary filter you want to include in your Medical Scribe\n request. Custom vocabulary filter names are case sensitive.

\n

Note that if you include VocabularyFilterName in your request, you must\n also include VocabularyFilterMethod.

" + } + }, + "VocabularyFilterMethod": { + "target": "com.amazonaws.transcribe#VocabularyFilterMethod", + "traits": { + "smithy.api#documentation": "

Specify how you want your custom vocabulary filter applied to your transcript.

\n

To replace words with ***, choose mask.

\n

To delete words, choose remove.

\n

To flag words without changing them, choose tag.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Makes it possible to control how your Medical Scribe job is processed using a\n MedicalScribeSettings object. Specify ChannelIdentification if \n ChannelDefinitions are set. Enabled ShowSpeakerLabels if ChannelIdentification \n and ChannelDefinitions are not set. One and only one of ChannelIdentification and ShowSpeakerLabels\n must be set. If ShowSpeakerLabels is set, MaxSpeakerLabels must also be set. Use Settings\n to specify a vocabulary or vocabulary filter or both using VocabularyName, VocabularyFilterName. \n VocabularyFilterMethod must be specified if VocabularyFilterName is set.\n

" + } + }, "com.amazonaws.transcribe#MedicalTranscript": { "type": "structure", "members": { @@ -3910,7 +4417,7 @@ "FailureReason": { "target": "com.amazonaws.transcribe#FailureReason", "traits": { - "smithy.api#documentation": "

If TranscriptionJobStatus is FAILED,\n FailureReason contains information about why the transcription job\n request failed.

\n

The FailureReason field contains one of the following values:

\n " + "smithy.api#documentation": "

If TranscriptionJobStatus is FAILED,\n FailureReason contains information about why the transcription job\n request failed.

\n

The FailureReason field contains one of the following values:

\n " } }, "Settings": { @@ -4034,7 +4541,7 @@ "ShowSpeakerLabels": { "target": "com.amazonaws.transcribe#Boolean", "traits": { - "smithy.api#documentation": "

Enables speaker partitioning (diarization) in your transcription output. Speaker\n partitioning labels the speech from individual speakers in your media file.

\n

If you enable ShowSpeakerLabels in your request, you must also include\n MaxSpeakerLabels.

\n

You can't include ShowSpeakerLabels and\n ChannelIdentification in the same request. Including both parameters\n returns a BadRequestException.

\n

For more information, see Partitioning speakers\n (diarization).

" + "smithy.api#documentation": "

Enables speaker partitioning (diarization) in your transcription output. Speaker\n partitioning labels the speech from individual speakers in your media file.

\n

If you enable ShowSpeakerLabels in your request, you must also include\n MaxSpeakerLabels.

\n

For more information, see Partitioning speakers\n (diarization).

" } }, "MaxSpeakerLabels": { @@ -4046,7 +4553,7 @@ "ChannelIdentification": { "target": "com.amazonaws.transcribe#Boolean", "traits": { - "smithy.api#documentation": "

Enables channel identification in multi-channel audio.

\n

Channel identification transcribes the audio on each channel independently, then\n appends the output for each channel into one transcript.

\n

If you have multi-channel audio and do not enable channel identification, your audio\n is transcribed in a continuous manner and your transcript does not separate the speech\n by channel.

\n

You can't include both ShowSpeakerLabels and\n ChannelIdentification in the same request. Including both parameters\n returns a BadRequestException.

\n

For more information, see Transcribing multi-channel\n audio.

" + "smithy.api#documentation": "

Enables channel identification in multi-channel audio.

\n

Channel identification transcribes the audio on each channel independently, then\n appends the output for each channel into one transcript.

\n

If you have multi-channel audio and do not enable channel identification, your audio\n is transcribed in a continuous manner and your transcript does not separate the speech\n by channel.

\n

For more information, see Transcribing multi-channel\n audio.

" } }, "ShowAlternatives": { @@ -4064,7 +4571,7 @@ "VocabularyName": { "target": "com.amazonaws.transcribe#VocabularyName", "traits": { - "smithy.api#documentation": "

The name of the custom vocabulary you want to use when processing your medical\n transcription job. Custom vocabulary names are case sensitive.

\n

The language of the specified custom vocabulary must match the language code that you\n specify in your transcription request. If the languages don't match, the custom\n vocabulary isn't applied. There are no errors or warnings associated with a language\n mismatch. US English (en-US) is the only valid language for Amazon Transcribe Medical.

" + "smithy.api#documentation": "

The name of the custom vocabulary you want to use when processing your medical\n transcription job. Custom vocabulary names are case sensitive.

\n

The language of the specified custom vocabulary must match the language code that you\n specify in your transcription request. If the languages do not match, the custom\n vocabulary isn't applied. There are no errors or warnings associated with a language\n mismatch. US English (en-US) is the only valid language for Amazon Transcribe Medical.

" } } }, @@ -4088,7 +4595,7 @@ "LanguageModelName": { "target": "com.amazonaws.transcribe#ModelName", "traits": { - "smithy.api#documentation": "

The name of the custom language model you want to use when processing your\n transcription job. Note that custom language model names are case sensitive.

\n

The language of the specified custom language model must match the language code that\n you specify in your transcription request. If the languages don't match, the custom\n language model isn't applied. There are no errors or warnings associated with a language\n mismatch.

" + "smithy.api#documentation": "

The name of the custom language model you want to use when processing your\n transcription job. Note that custom language model names are case sensitive.

\n

The language of the specified custom language model must match the language code that\n you specify in your transcription request. If the languages do not match, the custom\n language model isn't applied. There are no errors or warnings associated with a language\n mismatch.

" } } }, @@ -4554,7 +5061,7 @@ "ShowSpeakerLabels": { "target": "com.amazonaws.transcribe#Boolean", "traits": { - "smithy.api#documentation": "

Enables speaker partitioning (diarization) in your transcription output. Speaker\n partitioning labels the speech from individual speakers in your media file.

\n

If you enable ShowSpeakerLabels in your request, you must also include\n MaxSpeakerLabels.

\n

You can't include both ShowSpeakerLabels and\n ChannelIdentification in the same request. Including both parameters\n returns a BadRequestException.

\n

For more information, see Partitioning speakers\n (diarization).

" + "smithy.api#documentation": "

Enables speaker partitioning (diarization) in your transcription output. Speaker\n partitioning labels the speech from individual speakers in your media file.

\n

If you enable ShowSpeakerLabels in your request, you must also include\n MaxSpeakerLabels.

\n

For more information, see Partitioning speakers\n (diarization).

" } }, "MaxSpeakerLabels": { @@ -4566,7 +5073,7 @@ "ChannelIdentification": { "target": "com.amazonaws.transcribe#Boolean", "traits": { - "smithy.api#documentation": "

Enables channel identification in multi-channel audio.

\n

Channel identification transcribes the audio on each channel independently, then\n appends the output for each channel into one transcript.

\n

You can't include both ShowSpeakerLabels and\n ChannelIdentification in the same request. Including both parameters\n returns a BadRequestException.

\n

For more information, see Transcribing multi-channel\n audio.

" + "smithy.api#documentation": "

Enables channel identification in multi-channel audio.

\n

Channel identification transcribes the audio on each channel independently, then\n appends the output for each channel into one transcript.

\n

For more information, see Transcribing multi-channel\n audio.

" } }, "ShowAlternatives": { @@ -4595,7 +5102,7 @@ } }, "traits": { - "smithy.api#documentation": "

Allows additional optional settings in your request, including channel identification, alternative transcriptions, and speaker\n partitioning. You can use that to apply custom vocabularies to your transcription\n job.

" + "smithy.api#documentation": "

Allows additional optional settings in your \n request, including channel identification, alternative transcriptions, and speaker\n partitioning. You can use that to apply custom vocabularies to your transcription\n job.

" } }, "com.amazonaws.transcribe#Specialty": { @@ -4661,13 +5168,13 @@ "OutputLocation": { "target": "com.amazonaws.transcribe#Uri", "traits": { - "smithy.api#documentation": "

The Amazon S3 location where you want your Call Analytics transcription output\n stored. You can use any of the following formats to specify the output location:

\n
    \n
  1. \n

    s3://DOC-EXAMPLE-BUCKET

    \n
    2. \n
  2. \n

    s3://DOC-EXAMPLE-BUCKET/my-output-folder/

    \n
    3. \n
  3. \n

    s3://DOC-EXAMPLE-BUCKET/my-output-folder/my-call-analytics-job.json

    \n
    4. \n
\n

Unless you specify a file name (option 3), the name of your output file has a default\n value that matches the name you specified for your transcription job using the\n CallAnalyticsJobName parameter.

\n

You can specify a KMS key to encrypt your output using the\n OutputEncryptionKMSKeyId parameter. If you don't specify a KMS key, Amazon Transcribe uses the default Amazon S3 key for\n server-side encryption.

\n

If you don't specify OutputLocation, your transcript is placed in a\n service-managed Amazon S3 bucket and you are provided with a URI to access your\n transcript.

" + "smithy.api#documentation": "

The Amazon S3 location where you want your Call Analytics transcription output\n stored. You can use any of the following formats to specify the output location:

\n
    \n
  1. \n

    s3://DOC-EXAMPLE-BUCKET

    \n
    2. \n
  2. \n

    s3://DOC-EXAMPLE-BUCKET/my-output-folder/

    \n
    3. \n
  3. \n

    s3://DOC-EXAMPLE-BUCKET/my-output-folder/my-call-analytics-job.json

    \n
    4. \n
\n

Unless you specify a file name (option 3), the name of your output file has a default\n value that matches the name you specified for your transcription job using the\n CallAnalyticsJobName parameter.

\n

You can specify a KMS key to encrypt your output using the\n OutputEncryptionKMSKeyId parameter. If you do not specify a KMS key, Amazon Transcribe uses the default Amazon S3 key for\n server-side encryption.

\n

If you do not specify OutputLocation, your transcript is placed in a\n service-managed Amazon S3 bucket and you are provided with a URI to access your\n transcript.

" } }, "OutputEncryptionKMSKeyId": { "target": "com.amazonaws.transcribe#KMSKeyId", "traits": { - "smithy.api#documentation": "

The KMS key you want to use to encrypt your Call Analytics\n output.

\n

If using a key located in the current\n Amazon Web Services account, you can specify your KMS key in one of four\n ways:

\n
    \n
  1. \n

    Use the KMS key ID itself. For example,\n 1234abcd-12ab-34cd-56ef-1234567890ab.

    \n
    2. \n
  2. \n

    Use an alias for the KMS key ID. For example,\n alias/ExampleAlias.

    \n
    3. \n
  3. \n

    Use the Amazon Resource Name (ARN) for the KMS key ID. For\n example,\n arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.

    \n
    4. \n
  4. \n

    Use the ARN for the KMS key alias. For example,\n arn:aws:kms:region:account-ID:alias/ExampleAlias.

    \n
    5. \n
\n

If using a key located in a different\n Amazon Web Services account than the current Amazon Web Services account, you can specify\n your KMS key in one of two ways:

\n
    \n
  1. \n

    Use the ARN for the KMS key ID. For example,\n arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.

    \n
    2. \n
  2. \n

    Use the ARN for the KMS key alias. For example,\n arn:aws:kms:region:account-ID:alias/ExampleAlias.

    \n
    3. \n
\n

If you don't specify an encryption key, your output is encrypted with the default\n Amazon S3 key (SSE-S3).

\n

If you specify a KMS key to encrypt your output, you must also specify\n an output location using the OutputLocation parameter.

\n

Note that the role making the request must\n have permission to use the specified KMS key.

" + "smithy.api#documentation": "

The KMS key you want to use to encrypt your Call Analytics\n output.

\n

If using a key located in the current\n Amazon Web Services account, you can specify your KMS key in one of four\n ways:

\n
    \n
  1. \n

    Use the KMS key ID itself. For example,\n 1234abcd-12ab-34cd-56ef-1234567890ab.

    \n
    2. \n
  2. \n

    Use an alias for the KMS key ID. For example,\n alias/ExampleAlias.

    \n
    3. \n
  3. \n

    Use the Amazon Resource Name (ARN) for the KMS key ID. For\n example,\n arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.

    \n
    4. \n
  4. \n

    Use the ARN for the KMS key alias. For example,\n arn:aws:kms:region:account-ID:alias/ExampleAlias.

    \n
    5. \n
\n

If using a key located in a different\n Amazon Web Services account than the current Amazon Web Services account, you can specify\n your KMS key in one of two ways:

\n
    \n
  1. \n

    Use the ARN for the KMS key ID. For example,\n arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.

    \n
    2. \n
  2. \n

    Use the ARN for the KMS key alias. For example,\n arn:aws:kms:region:account-ID:alias/ExampleAlias.

    \n
    3. \n
\n

If you do not specify an encryption key, your output is encrypted with the default\n Amazon S3 key (SSE-S3).

\n

If you specify a KMS key to encrypt your output, you must also specify\n an output location using the OutputLocation parameter.

\n

Note that the role making the request must\n have permission to use the specified KMS key.

" } }, "DataAccessRoleArn": { @@ -4707,6 +5214,118 @@ "smithy.api#output": {} } }, + "com.amazonaws.transcribe#StartMedicalScribeJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.transcribe#StartMedicalScribeJobRequest" + }, + "output": { + "target": "com.amazonaws.transcribe#StartMedicalScribeJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.transcribe#BadRequestException" + }, + { + "target": "com.amazonaws.transcribe#ConflictException" + }, + { + "target": "com.amazonaws.transcribe#InternalFailureException" + }, + { + "target": "com.amazonaws.transcribe#LimitExceededException" + } + ], + "traits": { + "smithy.api#documentation": "

Transcribes patient-clinician conversations and generates clinical notes.

\n

Amazon Web Services HealthScribe automatically provides rich conversation transcripts, identifies speaker roles, \n classifies dialogues, extracts medical terms, and generates preliminary clinical notes.\n To learn more about these features, refer to Amazon Web Services HealthScribe.

\n

To make a StartMedicalScribeJob request, you must first upload\n your media file into an Amazon S3 bucket; you can then specify the Amazon S3 location\n of the file using the Media parameter.

\n

You must include the following parameters in your\n StartMedicalTranscriptionJob request:

\n ", + "smithy.api#http": { + "method": "PUT", + "uri": "/medicalscribejobs/{MedicalScribeJobName}", + "code": 200 + } + } + }, + "com.amazonaws.transcribe#StartMedicalScribeJobRequest": { + "type": "structure", + "members": { + "MedicalScribeJobName": { + "target": "com.amazonaws.transcribe#TranscriptionJobName", + "traits": { + "smithy.api#documentation": "

A unique name, chosen by you, for your Medical Scribe job.

\n

This name is case sensitive, cannot contain spaces, and must be unique within an\n Amazon Web Services account. If you try to create a new job with the same name as an\n existing job, you get a ConflictException error.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Media": { + "target": "com.amazonaws.transcribe#Media", + "traits": { + "smithy.api#required": {} + } + }, + "OutputBucketName": { + "target": "com.amazonaws.transcribe#OutputBucketName", + "traits": { + "smithy.api#documentation": "

The name of the Amazon S3 bucket where you want your Medical Scribe\n output stored. Do not include the S3:// prefix of the specified\n bucket.

\n

Note that the role specified in the DataAccessRoleArn request parameter \n must have permission to use the specified location. You\n can change Amazon S3 permissions using the Amazon Web Services Management Console. See also Permissions Required for IAM User Roles.

", + "smithy.api#required": {} + } + }, + "OutputEncryptionKMSKeyId": { + "target": "com.amazonaws.transcribe#KMSKeyId", + "traits": { + "smithy.api#documentation": "

The KMS key you want to use to encrypt your Medical Scribe\n output.

\n

If using a key located in the current\n Amazon Web Services account, you can specify your KMS key in one of four\n ways:

\n
    \n
  1. \n

    Use the KMS key ID itself. For example,\n 1234abcd-12ab-34cd-56ef-1234567890ab.

    \n
    2. \n
  2. \n

    Use an alias for the KMS key ID. For example,\n alias/ExampleAlias.

    \n
    3. \n
  3. \n

    Use the Amazon Resource Name (ARN) for the KMS key ID. For\n example,\n arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.

    \n
    4. \n
  4. \n

    Use the ARN for the KMS key alias. For example,\n arn:aws:kms:region:account-ID:alias/ExampleAlias.

    \n
    5. \n
\n

If using a key located in a different\n Amazon Web Services account than the current Amazon Web Services account, you can specify\n your KMS key in one of two ways:

\n
    \n
  1. \n

    Use the ARN for the KMS key ID. For example,\n arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.

    \n
    2. \n
  2. \n

    Use the ARN for the KMS key alias. For example,\n arn:aws:kms:region:account-ID:alias/ExampleAlias.

    \n
    3. \n
\n

If you do not specify an encryption key, your output is encrypted with the default\n Amazon S3 key (SSE-S3).

\n

Note that the role specified in the DataAccessRoleArn request parameter \n must have permission to use the specified KMS key.

" + } + }, + "KMSEncryptionContext": { + "target": "com.amazonaws.transcribe#KMSEncryptionContextMap", + "traits": { + "smithy.api#documentation": "

A map of plain text, non-secret key:value pairs, known as encryption context pairs,\n that provide an added layer of security for your data. For more information, see KMS encryption context and Asymmetric keys in KMS.

" + } + }, + "DataAccessRoleArn": { + "target": "com.amazonaws.transcribe#DataAccessRoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM role that has permissions to\n access the Amazon S3 bucket that contains your input files, \n write to the output bucket, and use your KMS key if supplied. \n If the role that you specify doesn’t have the appropriate permissions your request fails.

\n

IAM role ARNs have the format\n arn:partition:iam::account:role/role-name-with-path. For example:\n arn:aws:iam::111122223333:role/Admin.

\n

For more information, see IAM\n ARNs.

", + "smithy.api#required": {} + } + }, + "Settings": { + "target": "com.amazonaws.transcribe#MedicalScribeSettings", + "traits": { + "smithy.api#documentation": "

Makes it possible to control how your Medical Scribe job is processed using a\n MedicalScribeSettings object. Specify ChannelIdentification if \n ChannelDefinitions are set. Enabled ShowSpeakerLabels if ChannelIdentification \n and ChannelDefinitions are not set. One and only one of ChannelIdentification and ShowSpeakerLabels\n must be set. If ShowSpeakerLabels is set, MaxSpeakerLabels must also be set. Use Settings\n to specify a vocabulary or vocabulary filter or both using VocabularyName, VocabularyFilterName. \n VocabularyFilterMethod must be specified if VocabularyFilterName is set.\n

", + "smithy.api#required": {} + } + }, + "ChannelDefinitions": { + "target": "com.amazonaws.transcribe#MedicalScribeChannelDefinitions", + "traits": { + "smithy.api#documentation": "

Makes it possible to specify which speaker is on which channel. For example, if the clinician\n is the first participant to speak, you would set ChannelId of the first ChannelDefinition \n in the list to 0 (to indicate the first channel) and ParticipantRole to\n CLINICIAN (to indicate that it's the clinician speaking).\n Then you would set the ChannelId of the second ChannelDefinition in the list to\n 1 (to indicate the second channel) and ParticipantRole to\n PATIENT (to indicate that it's the patient speaking).\n

" + } + }, + "Tags": { + "target": "com.amazonaws.transcribe#TagList", + "traits": { + "smithy.api#documentation": "

Adds one or more custom tags, each in the form of a key:value pair, to the Medica Scribe job.

\n

To learn more about using tags with Amazon Transcribe, refer to Tagging\n resources.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.transcribe#StartMedicalScribeJobResponse": { + "type": "structure", + "members": { + "MedicalScribeJob": { + "target": "com.amazonaws.transcribe#MedicalScribeJob", + "traits": { + "smithy.api#documentation": "

Provides detailed information about the current Medical Scribe job, including\n job status and, if applicable, failure reason.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.transcribe#StartMedicalTranscriptionJob": { "type": "operation", "input": { @@ -4730,7 +5349,7 @@ } ], "traits": { - "smithy.api#documentation": "

Transcribes the audio from a medical dictation or conversation and applies any\n additional Request Parameters you choose to include in your request.

\n

In addition to many standard transcription features, Amazon Transcribe Medical\n provides you with a robust medical vocabulary and, optionally, content identification,\n which adds flags to personal health information (PHI). To learn more about these\n features, refer to How Amazon Transcribe Medical\n works.

\n

To make a StartMedicalTranscriptionJob request, you must first upload\n your media file into an Amazon S3 bucket; you can then specify the S3 location\n of the file using the Media parameter.

\n

You must include the following parameters in your\n StartMedicalTranscriptionJob request:

\n ", + "smithy.api#documentation": "

Transcribes the audio from a medical dictation or conversation and applies any\n additional Request Parameters you choose to include in your request.

\n

In addition to many standard transcription features, Amazon Transcribe Medical\n provides you with a robust medical vocabulary and, optionally, content identification,\n which adds flags to personal health information (PHI). To learn more about these\n features, refer to How Amazon Transcribe Medical\n works.

\n

To make a StartMedicalTranscriptionJob request, you must first upload\n your media file into an Amazon S3 bucket; you can then specify the Amazon S3 location\n of the file using the Media parameter.

\n

You must include the following parameters in your\n StartMedicalTranscriptionJob request:

\n ", "smithy.api#http": { "method": "PUT", "uri": "/medicaltranscriptionjobs/{MedicalTranscriptionJobName}", @@ -4759,7 +5378,7 @@ "MediaSampleRateHertz": { "target": "com.amazonaws.transcribe#MedicalMediaSampleRateHertz", "traits": { - "smithy.api#documentation": "

The sample rate, in hertz, of the audio track in your input media file.

\n

If you don't specify the media sample rate, Amazon Transcribe Medical determines it\n for you. If you specify the sample rate, it must match the rate detected by Amazon Transcribe Medical; if there's a mismatch between the value that you specify and the\n value detected, your job fails. Therefore, in most cases, it's advised to omit\n MediaSampleRateHertz and let Amazon Transcribe Medical determine the\n sample rate.

" + "smithy.api#documentation": "

The sample rate, in hertz, of the audio track in your input media file.

\n

If you do not specify the media sample rate, Amazon Transcribe Medical determines it\n for you. If you specify the sample rate, it must match the rate detected by Amazon Transcribe Medical; if there's a mismatch between the value that you specify and the\n value detected, your job fails. Therefore, in most cases, it's advised to omit\n MediaSampleRateHertz and let Amazon Transcribe Medical determine the\n sample rate.

" } }, "MediaFormat": { @@ -4790,7 +5409,7 @@ "OutputEncryptionKMSKeyId": { "target": "com.amazonaws.transcribe#KMSKeyId", "traits": { - "smithy.api#documentation": "

The KMS key you want to use to encrypt your medical transcription\n output.

\n

If using a key located in the current\n Amazon Web Services account, you can specify your KMS key in one of four\n ways:

\n
    \n
  1. \n

    Use the KMS key ID itself. For example,\n 1234abcd-12ab-34cd-56ef-1234567890ab.

    \n
    2. \n
  2. \n

    Use an alias for the KMS key ID. For example,\n alias/ExampleAlias.

    \n
    3. \n
  3. \n

    Use the Amazon Resource Name (ARN) for the KMS key ID. For\n example,\n arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.

    \n
    4. \n
  4. \n

    Use the ARN for the KMS key alias. For example,\n arn:aws:kms:region:account-ID:alias/ExampleAlias.

    \n
    5. \n
\n

If using a key located in a different\n Amazon Web Services account than the current Amazon Web Services account, you can specify\n your KMS key in one of two ways:

\n
    \n
  1. \n

    Use the ARN for the KMS key ID. For example,\n arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.

    \n
    2. \n
  2. \n

    Use the ARN for the KMS key alias. For example,\n arn:aws:kms:region:account-ID:alias/ExampleAlias.

    \n
    3. \n
\n

If you don't specify an encryption key, your output is encrypted with the default\n Amazon S3 key (SSE-S3).

\n

If you specify a KMS key to encrypt your output, you must also specify\n an output location using the OutputLocation parameter.

\n

Note that the role making the request must\n have permission to use the specified KMS key.

" + "smithy.api#documentation": "

The KMS key you want to use to encrypt your medical transcription\n output.

\n

If using a key located in the current\n Amazon Web Services account, you can specify your KMS key in one of four\n ways:

\n
    \n
  1. \n

    Use the KMS key ID itself. For example,\n 1234abcd-12ab-34cd-56ef-1234567890ab.

    \n
    2. \n
  2. \n

    Use an alias for the KMS key ID. For example,\n alias/ExampleAlias.

    \n
    3. \n
  3. \n

    Use the Amazon Resource Name (ARN) for the KMS key ID. For\n example,\n arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.

    \n
    4. \n
  4. \n

    Use the ARN for the KMS key alias. For example,\n arn:aws:kms:region:account-ID:alias/ExampleAlias.

    \n
    5. \n
\n

If using a key located in a different\n Amazon Web Services account than the current Amazon Web Services account, you can specify\n your KMS key in one of two ways:

\n
    \n
  1. \n

    Use the ARN for the KMS key ID. For example,\n arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.

    \n
    2. \n
  2. \n

    Use the ARN for the KMS key alias. For example,\n arn:aws:kms:region:account-ID:alias/ExampleAlias.

    \n
    3. \n
\n

If you do not specify an encryption key, your output is encrypted with the default\n Amazon S3 key (SSE-S3).

\n

If you specify a KMS key to encrypt your output, you must also specify\n an output location using the OutputLocation parameter.

\n

Note that the role making the request must\n have permission to use the specified KMS key.

" } }, "KMSEncryptionContext": { @@ -4873,7 +5492,7 @@ } ], "traits": { - "smithy.api#documentation": "

Transcribes the audio from a media file and applies any additional Request Parameters\n you choose to include in your request.

\n

To make a StartTranscriptionJob request, you must first upload your media\n file into an Amazon S3 bucket; you can then specify the Amazon S3\n location of the file using the Media parameter.

\n

You must include the following parameters in your StartTranscriptionJob\n request:

\n ", + "smithy.api#documentation": "

Transcribes the audio from a media file and applies any additional Request Parameters\n you choose to include in your request.

\n

To make a StartTranscriptionJob request, you must first upload your media\n file into an Amazon S3 bucket; you can then specify the Amazon S3\n location of the file using the Media parameter.

\n

You must include the following parameters in your StartTranscriptionJob\n request:

\n ", "smithy.api#http": { "method": "PUT", "uri": "/transcriptionjobs/{TranscriptionJobName}", @@ -4901,7 +5520,7 @@ "MediaSampleRateHertz": { "target": "com.amazonaws.transcribe#MediaSampleRateHertz", "traits": { - "smithy.api#documentation": "

The sample rate, in hertz, of the audio track in your input media file.

\n

If you don't specify the media sample rate, Amazon Transcribe determines it for you.\n If you specify the sample rate, it must match the rate detected by Amazon Transcribe.\n If there's a mismatch between the value that you specify and the value detected, your\n job fails. In most cases, you can omit MediaSampleRateHertz and let Amazon Transcribe determine the sample rate.

" + "smithy.api#documentation": "

The sample rate, in hertz, of the audio track in your input media file.

\n

If you do not specify the media sample rate, Amazon Transcribe determines it for you.\n If you specify the sample rate, it must match the rate detected by Amazon Transcribe.\n If there's a mismatch between the value that you specify and the value detected, your\n job fails. In most cases, you can omit MediaSampleRateHertz and let Amazon Transcribe determine the sample rate.

" } }, "MediaFormat": { @@ -4920,7 +5539,7 @@ "OutputBucketName": { "target": "com.amazonaws.transcribe#OutputBucketName", "traits": { - "smithy.api#documentation": "

The name of the Amazon S3 bucket where you want your transcription output\n stored. Do not include the S3:// prefix of the specified bucket.

\n

If you want your output to go to a sub-folder of this bucket, specify it using the\n OutputKey parameter; OutputBucketName only accepts the\n name of a bucket.

\n

For example, if you want your output stored in S3://DOC-EXAMPLE-BUCKET,\n set OutputBucketName to DOC-EXAMPLE-BUCKET. However, if you\n want your output stored in S3://DOC-EXAMPLE-BUCKET/test-files/, set\n OutputBucketName to DOC-EXAMPLE-BUCKET and\n OutputKey to test-files/.

\n

Note that Amazon Transcribe must have permission to use the specified location. You\n can change Amazon S3 permissions using the Amazon Web Services Management Console. See also Permissions Required for IAM User Roles.

\n

If you don't specify OutputBucketName, your transcript is placed in a\n service-managed Amazon S3 bucket and you are provided with a URI to access your\n transcript.

" + "smithy.api#documentation": "

The name of the Amazon S3 bucket where you want your transcription output\n stored. Do not include the S3:// prefix of the specified bucket.

\n

If you want your output to go to a sub-folder of this bucket, specify it using the\n OutputKey parameter; OutputBucketName only accepts the\n name of a bucket.

\n

For example, if you want your output stored in S3://DOC-EXAMPLE-BUCKET,\n set OutputBucketName to DOC-EXAMPLE-BUCKET. However, if you\n want your output stored in S3://DOC-EXAMPLE-BUCKET/test-files/, set\n OutputBucketName to DOC-EXAMPLE-BUCKET and\n OutputKey to test-files/.

\n

Note that Amazon Transcribe must have permission to use the specified location. You\n can change Amazon S3 permissions using the Amazon Web Services Management Console. See also Permissions Required for IAM User Roles.

\n

If you do not specify OutputBucketName, your transcript is placed in a\n service-managed Amazon S3 bucket and you are provided with a URI to access your\n transcript.

" } }, "OutputKey": { @@ -4932,7 +5551,7 @@ "OutputEncryptionKMSKeyId": { "target": "com.amazonaws.transcribe#KMSKeyId", "traits": { - "smithy.api#documentation": "

The KMS key you want to use to encrypt your transcription\n output.

\n

If using a key located in the current\n Amazon Web Services account, you can specify your KMS key in one of four\n ways:

\n
    \n
  1. \n

    Use the KMS key ID itself. For example,\n 1234abcd-12ab-34cd-56ef-1234567890ab.

    \n
    2. \n
  2. \n

    Use an alias for the KMS key ID. For example,\n alias/ExampleAlias.

    \n
    3. \n
  3. \n

    Use the Amazon Resource Name (ARN) for the KMS key ID. For\n example,\n arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.

    \n
    4. \n
  4. \n

    Use the ARN for the KMS key alias. For example,\n arn:aws:kms:region:account-ID:alias/ExampleAlias.

    \n
    5. \n
\n

If using a key located in a different\n Amazon Web Services account than the current Amazon Web Services account, you can specify\n your KMS key in one of two ways:

\n
    \n
  1. \n

    Use the ARN for the KMS key ID. For example,\n arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.

    \n
    2. \n
  2. \n

    Use the ARN for the KMS key alias. For example,\n arn:aws:kms:region:account-ID:alias/ExampleAlias.

    \n
    3. \n
\n

If you don't specify an encryption key, your output is encrypted with the default\n Amazon S3 key (SSE-S3).

\n

If you specify a KMS key to encrypt your output, you must also specify\n an output location using the OutputLocation parameter.

\n

Note that the role making the request must\n have permission to use the specified KMS key.

" + "smithy.api#documentation": "

The KMS key you want to use to encrypt your transcription\n output.

\n

If using a key located in the current\n Amazon Web Services account, you can specify your KMS key in one of four\n ways:

\n
    \n
  1. \n

    Use the KMS key ID itself. For example,\n 1234abcd-12ab-34cd-56ef-1234567890ab.

    \n
    2. \n
  2. \n

    Use an alias for the KMS key ID. For example,\n alias/ExampleAlias.

    \n
    3. \n
  3. \n

    Use the Amazon Resource Name (ARN) for the KMS key ID. For\n example,\n arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.

    \n
    4. \n
  4. \n

    Use the ARN for the KMS key alias. For example,\n arn:aws:kms:region:account-ID:alias/ExampleAlias.

    \n
    5. \n
\n

If using a key located in a different\n Amazon Web Services account than the current Amazon Web Services account, you can specify\n your KMS key in one of two ways:

\n
    \n
  1. \n

    Use the ARN for the KMS key ID. For example,\n arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.

    \n
    2. \n
  2. \n

    Use the ARN for the KMS key alias. For example,\n arn:aws:kms:region:account-ID:alias/ExampleAlias.

    \n
    3. \n
\n

If you do not specify an encryption key, your output is encrypted with the default\n Amazon S3 key (SSE-S3).

\n

If you specify a KMS key to encrypt your output, you must also specify\n an output location using the OutputLocation parameter.

\n

Note that the role making the request must\n have permission to use the specified KMS key.

" } }, "KMSEncryptionContext": { @@ -4944,7 +5563,7 @@ "Settings": { "target": "com.amazonaws.transcribe#Settings", "traits": { - "smithy.api#documentation": "

Specify additional optional settings in your request, including channel identification, alternative transcriptions, speaker\n partitioning. You can use that to apply custom vocabularies and vocabulary filters.

\n

If you want to include a custom vocabulary or a custom vocabulary filter (or both)\n with your request but do not want to use automatic\n language identification, use Settings with the VocabularyName\n or VocabularyFilterName (or both) sub-parameter.

\n

If you're using automatic language identification with your request and want to\n include a custom language model, a custom vocabulary, or a custom vocabulary filter, use\n instead the parameter with the\n LanguageModelName, VocabularyName or\n VocabularyFilterName sub-parameters.

" + "smithy.api#documentation": "

Specify additional optional settings in your \n request, including channel identification, alternative transcriptions, speaker\n partitioning. You can use that to apply custom vocabularies and vocabulary filters.

\n

If you want to include a custom vocabulary or a custom vocabulary filter (or both)\n with your request but do not want to use automatic\n language identification, use Settings with the VocabularyName\n or VocabularyFilterName (or both) sub-parameter.

\n

If you're using automatic language identification with your request and want to\n include a custom language model, a custom vocabulary, or a custom vocabulary filter, use\n instead the parameter with the\n LanguageModelName, VocabularyName or\n VocabularyFilterName sub-parameters.

" } }, "ModelSettings": { @@ -4962,7 +5581,7 @@ "ContentRedaction": { "target": "com.amazonaws.transcribe#ContentRedaction", "traits": { - "smithy.api#documentation": "

Makes it possible to redact or flag specified personally identifiable information\n (PII) in your transcript. If you use ContentRedaction, you must also\n include the sub-parameters: PiiEntityTypes, RedactionOutput,\n and RedactionType.

" + "smithy.api#documentation": "

Makes it possible to redact or flag specified personally identifiable information (PII) in \n your transcript. If you use ContentRedaction, you must also include the \n sub-parameters: RedactionOutput and RedactionType. You can \n optionally include PiiEntityTypes to choose which types of PII you want to redact.\n If you do not include PiiEntityTypes in your request, all PII is redacted.

" } }, "IdentifyLanguage": { @@ -5354,6 +5973,9 @@ { "target": "com.amazonaws.transcribe#DeleteLanguageModel" }, + { + "target": "com.amazonaws.transcribe#DeleteMedicalScribeJob" + }, { "target": "com.amazonaws.transcribe#DeleteMedicalTranscriptionJob" }, @@ -5378,6 +6000,9 @@ { "target": "com.amazonaws.transcribe#GetCallAnalyticsJob" }, + { + "target": "com.amazonaws.transcribe#GetMedicalScribeJob" + }, { "target": "com.amazonaws.transcribe#GetMedicalTranscriptionJob" }, @@ -5402,6 +6027,9 @@ { "target": "com.amazonaws.transcribe#ListLanguageModels" }, + { + "target": "com.amazonaws.transcribe#ListMedicalScribeJobs" + }, { "target": "com.amazonaws.transcribe#ListMedicalTranscriptionJobs" }, @@ -5423,6 +6051,9 @@ { "target": "com.amazonaws.transcribe#StartCallAnalyticsJob" }, + { + "target": "com.amazonaws.transcribe#StartMedicalScribeJob" + }, { "target": "com.amazonaws.transcribe#StartMedicalTranscriptionJob" }, @@ -6658,7 +7289,7 @@ "FailureReason": { "target": "com.amazonaws.transcribe#FailureReason", "traits": { - "smithy.api#documentation": "

If TranscriptionJobStatus is FAILED,\n FailureReason contains information about why the transcription job\n request failed.

\n

The FailureReason field contains one of the following values:

\n " + "smithy.api#documentation": "

If TranscriptionJobStatus is FAILED,\n FailureReason contains information about why the transcription job\n request failed.

\n

The FailureReason field contains one of the following values:

\n " } }, "Settings": {