From 1db9e527cb4fd9d0e36ed876f1851046e224055f Mon Sep 17 00:00:00 2001 From: Jason Del Ponte Date: Wed, 23 Dec 2020 15:37:57 -0800 Subject: [PATCH] update API models --- .../aws-models/apigateway.2015-07-09.json | 33 +- .../applicationinsights.2018-11-25.json | 114 +- .../aws-models/appstream.2016-12-01.json | 9 +- .../aws-models/batch.2016-08-10.json | 181 +- .../aws-models/cloudformation.2010-05-15.json | 132 +- .../aws-models/cloudfront.2020-05-31.json | 216 +- .../aws-models/cloudsearch.2013-01-01.json | 195 +- .../cloudsearchdomain.2013-01-01.json | 18 +- .../aws-models/cloudwatch.2010-08-01.json | 150 +- .../aws-models/codedeploy.2014-10-06.json | 6 +- .../aws-models/cognitosync.2014-06-30.json | 24 +- .../aws-models/connect.2017-08-08.json | 789 +- .../connectparticipant.2018-09-07.json | 505 +- .../aws-models/costexplorer.2017-10-25.json | 18 +- .../customerprofiles.2020-08-15.json | 3730 +++ .../databasemigrationservice.2016-01-01.json | 129 +- .../aws-models/dax.2017-04-19.json | 42 +- .../aws-models/devopsguru.2020-12-01.json | 2279 +- .../aws-models/directconnect.2012-10-25.json | 150 +- .../aws-models/dlm.2018-01-12.json | 304 +- .../aws-models/docdb.2014-10-31.json | 24 +- .../aws-models/dynamodb.2012-08-10.json | 306 +- .../dynamodbstreams.2012-08-10.json | 51 +- .../aws-models/ec2.2016-11-15.json | 3024 +- .../aws-models/eks.2017-11-01.json | 93 +- .../aws-models/elasticache.2015-02-02.json | 46 +- .../elasticbeanstalk.2010-12-01.json | 201 +- .../elasticinference.2017-07-25.json | 9 +- .../elasticloadbalancingv2.2015-12-01.json | 21 +- .../elasticsearchservice.2015-01-01.json | 297 +- .../aws-models/emr.2009-03-31.json | 45 +- .../aws-models/firehose.2015-08-04.json | 63 +- .../aws-models/gamelift.2015-10-01.json | 429 +- .../globalaccelerator.2018-08-08.json | 34 +- .../aws-models/glue.2017-03-31.json | 35 +- .../aws-models/greengrassv2.2020-11-30.json | 3676 +++ .../aws-models/iam.2010-05-08.json | 117 +- .../aws-models/imagebuilder.2019-12-02.json | 1083 +- .../aws-models/iotanalytics.2017-11-27.json | 332 +- .../iotdeviceadvisor.2020-09-18.json | 1771 ++ .../aws-models/iotfleethub.2020-11-03.json | 925 + .../aws-models/iotwireless.2020-11-22.json | 5916 ++++ .../aws-models/kms.2014-11-01.json | 140 +- .../aws-models/lambda.2015-03-31.json | 214 +- .../managedblockchain.2018-09-24.json | 208 +- ...rketplacecommerceanalytics.2015-07-01.json | 6 +- .../aws-models/neptune.2014-10-31.json | 24 +- .../aws-models/opsworks.2013-02-18.json | 516 +- .../aws-models/outposts.2019-12-03.json | 192 +- .../personalizeruntime.2018-05-22.json | 2 +- .../aws-models/polly.2016-06-10.json | 279 +- .../aws-models/qldbsession.2019-07-11.json | 117 +- .../aws-models/quicksight.2018-04-01.json | 42 +- .../aws-models/ram.2018-01-04.json | 72 +- .../aws-models/rds.2014-10-31.json | 179 +- .../aws-models/redshift.2012-12-01.json | 51 +- .../aws-models/rekognition.2016-06-27.json | 27 +- .../aws-models/route53.2013-04-01.json | 1361 +- .../aws-models/route53domains.2014-05-15.json | 741 +- .../sdk-codegen/aws-models/s3.2006-03-01.json | 25498 ++++++++-------- .../aws-models/s3control.2018-08-20.json | 75 +- .../aws-models/savingsplans.2019-06-28.json | 6 +- .../aws-models/secretsmanager.2017-10-17.json | 15 +- .../aws-models/securityhub.2018-10-26.json | 4 +- .../aws-models/servicecatalog.2015-12-10.json | 279 +- .../servicecatalogappregistry.2020-06-24.json | 94 +- .../aws-models/servicequotas.2019-06-24.json | 548 +- .../aws-models/ses.2010-12-01.json | 36 +- .../aws-models/sfn.2016-11-23.json | 213 +- .../aws-models/signer.2017-08-25.json | 51 +- .../aws-models/sqs.2012-11-05.json | 115 +- .../aws-models/ssm.2014-11-06.json | 1540 +- .../aws-models/storagegateway.2013-06-30.json | 294 +- .../aws-models/swf.2012-01-25.json | 444 +- .../wellarchitected.2020-03-31.json | 4024 +++ .../aws-models/workmail.2017-10-01.json | 2270 +- 76 files changed, 49690 insertions(+), 17509 deletions(-) create mode 100644 codegen/sdk-codegen/aws-models/customerprofiles.2020-08-15.json create mode 100644 codegen/sdk-codegen/aws-models/greengrassv2.2020-11-30.json create mode 100644 codegen/sdk-codegen/aws-models/iotdeviceadvisor.2020-09-18.json create mode 100644 codegen/sdk-codegen/aws-models/iotfleethub.2020-11-03.json create mode 100644 codegen/sdk-codegen/aws-models/iotwireless.2020-11-22.json create mode 100644 codegen/sdk-codegen/aws-models/wellarchitected.2020-03-31.json diff --git a/codegen/sdk-codegen/aws-models/apigateway.2015-07-09.json b/codegen/sdk-codegen/aws-models/apigateway.2015-07-09.json index ead05d0c75c..17b8d1d53c2 100644 --- a/codegen/sdk-codegen/aws-models/apigateway.2015-07-09.json +++ b/codegen/sdk-codegen/aws-models/apigateway.2015-07-09.json @@ -3868,13 +3868,16 @@ "smithy.api#documentation": "

The endpoint type. The valid values are EDGE for edge-optimized API setup, most suitable for mobile applications; REGIONAL for regional API endpoint setup, most suitable for calling from AWS Region; and PRIVATE for private APIs.

", "smithy.api#enum": [ { - "value": "REGIONAL" + "value": "REGIONAL", + "name": "REGIONAL" }, { - "value": "EDGE" + "value": "EDGE", + "name": "EDGE" }, { - "value": "PRIVATE" + "value": "PRIVATE", + "name": "PRIVATE" } ] } @@ -7883,22 +7886,28 @@ "traits": { "smithy.api#enum": [ { - "value": "add" + "value": "add", + "name": "add" }, { - "value": "remove" + "value": "remove", + "name": "remove" }, { - "value": "replace" + "value": "replace", + "name": "replace" }, { - "value": "move" + "value": "move", + "name": "move" }, { - "value": "copy" + "value": "copy", + "name": "copy" }, { - "value": "test" + "value": "test", + "name": "test" } ] } @@ -8954,10 +8963,12 @@ "traits": { "smithy.api#enum": [ { - "value": "TLS_1_0" + "value": "TLS_1_0", + "name": "TLS_1_0" }, { - "value": "TLS_1_2" + "value": "TLS_1_2", + "name": "TLS_1_2" } ] } diff --git a/codegen/sdk-codegen/aws-models/applicationinsights.2018-11-25.json b/codegen/sdk-codegen/aws-models/applicationinsights.2018-11-25.json index b9c24a84f73..c768154927b 100644 --- a/codegen/sdk-codegen/aws-models/applicationinsights.2018-11-25.json +++ b/codegen/sdk-codegen/aws-models/applicationinsights.2018-11-25.json @@ -191,16 +191,20 @@ "traits": { "smithy.api#enum": [ { - "value": "EC2" + "value": "EC2", + "name": "EC2" }, { - "value": "CODE_DEPLOY" + "value": "CODE_DEPLOY", + "name": "CODE_DEPLOY" }, { - "value": "HEALTH" + "value": "HEALTH", + "name": "HEALTH" }, { - "value": "RDS" + "value": "RDS", + "name": "RDS" } ] } @@ -304,16 +308,20 @@ "traits": { "smithy.api#enum": [ { - "value": "CLOUDWATCH_ALARM" + "value": "CLOUDWATCH_ALARM", + "name": "CLOUDWATCH_ALARM" }, { - "value": "CLOUDWATCH_LOG" + "value": "CLOUDWATCH_LOG", + "name": "CLOUDWATCH_LOG" }, { - "value": "CLOUDFORMATION" + "value": "CLOUDFORMATION", + "name": "CLOUDFORMATION" }, { - "value": "SSM_ASSOCIATION" + "value": "SSM_ASSOCIATION", + "name": "SSM_ASSOCIATION" } ] } @@ -323,13 +331,16 @@ "traits": { "smithy.api#enum": [ { - "value": "INFO" + "value": "INFO", + "name": "INFO" }, { - "value": "WARN" + "value": "WARN", + "name": "WARN" }, { - "value": "ERROR" + "value": "ERROR", + "name": "ERROR" } ] } @@ -1295,7 +1306,8 @@ "traits": { "smithy.api#enum": [ { - "value": "INSIGHTS_FEEDBACK" + "value": "INSIGHTS_FEEDBACK", + "name": "INSIGHTS_FEEDBACK" } ] } @@ -1305,13 +1317,16 @@ "traits": { "smithy.api#enum": [ { - "value": "NOT_SPECIFIED" + "value": "NOT_SPECIFIED", + "name": "NOT_SPECIFIED" }, { - "value": "USEFUL" + "value": "USEFUL", + "name": "USEFUL" }, { - "value": "NOT_USEFUL" + "value": "NOT_USEFUL", + "name": "NOT_USEFUL" } ] } @@ -1851,13 +1866,16 @@ "traits": { "smithy.api#enum": [ { - "value": "ERROR" + "value": "ERROR", + "name": "ERROR" }, { - "value": "WARN" + "value": "WARN", + "name": "WARN" }, { - "value": "INFO" + "value": "INFO", + "name": "INFO" } ] } @@ -2288,10 +2306,12 @@ "traits": { "smithy.api#enum": [ { - "value": "WINDOWS" + "value": "WINDOWS", + "name": "WINDOWS" }, { - "value": "LINUX" + "value": "LINUX", + "name": "LINUX" } ] } @@ -2489,13 +2509,16 @@ "traits": { "smithy.api#enum": [ { - "value": "Low" + "value": "Low", + "name": "Low" }, { - "value": "Medium" + "value": "Medium", + "name": "Medium" }, { - "value": "High" + "value": "High", + "name": "High" } ] } @@ -2526,13 +2549,16 @@ "traits": { "smithy.api#enum": [ { - "value": "IGNORE" + "value": "IGNORE", + "name": "IGNORE" }, { - "value": "RESOLVED" + "value": "RESOLVED", + "name": "RESOLVED" }, { - "value": "PENDING" + "value": "PENDING", + "name": "PENDING" } ] } @@ -2667,40 +2693,52 @@ "traits": { "smithy.api#enum": [ { - "value": "CUSTOM" + "value": "CUSTOM", + "name": "CUSTOM" }, { - "value": "DEFAULT" + "value": "DEFAULT", + "name": "DEFAULT" }, { - "value": "DOT_NET_CORE" + "value": "DOT_NET_CORE", + "name": "DOT_NET_CORE" }, { - "value": "DOT_NET_WORKER" + "value": "DOT_NET_WORKER", + "name": "DOT_NET_WORKER" }, { - "value": "DOT_NET_WEB_TIER" + "value": "DOT_NET_WEB_TIER", + "name": "DOT_NET_WEB_TIER" }, { - "value": "DOT_NET_WEB" + "value": "DOT_NET_WEB", + "name": "DOT_NET_WEB" }, { - "value": "SQL_SERVER" + "value": "SQL_SERVER", + "name": "SQL_SERVER" }, { - "value": "SQL_SERVER_ALWAYSON_AVAILABILITY_GROUP" + "value": "SQL_SERVER_ALWAYSON_AVAILABILITY_GROUP", + "name": "SQL_SERVER_ALWAYSON_AVAILABILITY_GROUP" }, { - "value": "MYSQL" + "value": "MYSQL", + "name": "MYSQL" }, { - "value": "POSTGRESQL" + "value": "POSTGRESQL", + "name": "POSTGRESQL" }, { - "value": "JAVA_JMX" + "value": "JAVA_JMX", + "name": "JAVA_JMX" }, { - "value": "ORACLE" + "value": "ORACLE", + "name": "ORACLE" } ], "smithy.api#length": { diff --git a/codegen/sdk-codegen/aws-models/appstream.2016-12-01.json b/codegen/sdk-codegen/aws-models/appstream.2016-12-01.json index 2164aa1cb7a..762bdff8cf6 100644 --- a/codegen/sdk-codegen/aws-models/appstream.2016-12-01.json +++ b/codegen/sdk-codegen/aws-models/appstream.2016-12-01.json @@ -3919,13 +3919,16 @@ "traits": { "smithy.api#enum": [ { - "value": "WINDOWS" + "value": "WINDOWS", + "name": "WINDOWS" }, { - "value": "WINDOWS_SERVER_2016" + "value": "WINDOWS_SERVER_2016", + "name": "WINDOWS_SERVER_2016" }, { - "value": "WINDOWS_SERVER_2019" + "value": "WINDOWS_SERVER_2019", + "name": "WINDOWS_SERVER_2019" } ] } diff --git a/codegen/sdk-codegen/aws-models/batch.2016-08-10.json b/codegen/sdk-codegen/aws-models/batch.2016-08-10.json index b3e8c98606a..d46319fc71e 100644 --- a/codegen/sdk-codegen/aws-models/batch.2016-08-10.json +++ b/codegen/sdk-codegen/aws-models/batch.2016-08-10.json @@ -166,7 +166,7 @@ "index": { "target": "com.amazonaws.batch#Integer", "traits": { - "smithy.api#documentation": "

The job index within the array that is associated with this job. This parameter is returned for array job\n children.

" + "smithy.api#documentation": "

The job index within the array that's associated with this job. This parameter is returned for array job\n children.

" } } }, @@ -186,7 +186,7 @@ "index": { "target": "com.amazonaws.batch#Integer", "traits": { - "smithy.api#documentation": "

The job index within the array that is associated with this job. This parameter is returned for children of\n array jobs.

" + "smithy.api#documentation": "

The job index within the array that's associated with this job. This parameter is returned for children of array\n jobs.

" } } }, @@ -221,7 +221,7 @@ "taskArn": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon ECS task that is associated with the job attempt. Each container attempt receives a task\n ARN when they reach the STARTING status.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon ECS task that's associated with the job attempt. Each container attempt receives a task\n ARN when they reach the STARTING status.

" } }, "exitCode": { @@ -250,7 +250,7 @@ } }, "traits": { - "smithy.api#documentation": "

An object representing the details of a container that is part of a job attempt.

" + "smithy.api#documentation": "

An object representing the details of a container that's part of a job attempt.

" } }, "com.amazonaws.batch#AttemptDetail": { @@ -439,6 +439,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for CancelJob.

" } }, "com.amazonaws.batch#CancelJobResponse": { @@ -453,7 +456,7 @@ } }, "traits": { - "smithy.api#documentation": "

These errors are usually caused by a client action, such as using an action or resource on behalf of a user that\n doesn't have permissions to use the action or resource, or specifying an identifier that isn't valid.

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

These errors are usually caused by a client action, such as using an action or resource on behalf of a user that\n doesn't have permissions to use the action or resource, or specifying an identifier that's not valid.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -464,7 +467,7 @@ "computeEnvironmentName": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The name of the compute environment.

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

The name of the compute environment. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and\n underscores are allowed.

", "smithy.api#required": {} } }, @@ -491,13 +494,13 @@ "type": { "target": "com.amazonaws.batch#CEType", "traits": { - "smithy.api#documentation": "

The type of compute environment: EC2, SPOT, FARGATE, or\n FARGATE_SPOT. For more information, see Compute Environments in the\n AWS Batch User Guide.

" + "smithy.api#documentation": "

The type of the compute environment: MANAGED or UNMANAGED. For more information, see\n Compute Environments in\n the AWS Batch User Guide.

" } }, "state": { "target": "com.amazonaws.batch#CEState", "traits": { - "smithy.api#documentation": "

The state of the compute environment. The valid values are ENABLED or DISABLED.

\n

If the state is ENABLED, then the AWS Batch scheduler can attempt to place jobs from an associated\n job queue on the compute resources within the environment. If the compute environment is managed, then it can scale\n its instances out or in automatically, based on the job queue demand.

\n

If the state is DISABLED, then the AWS Batch scheduler doesn't attempt to place jobs within the\n environment. Jobs in a STARTING or RUNNING state continue to progress normally. Managed\n compute environments in the DISABLED state do not scale out. However, they scale in to\n minvCpus value after instances become idle.

" + "smithy.api#documentation": "

The state of the compute environment. The valid values are ENABLED or DISABLED.

\n

If the state is ENABLED, then the AWS Batch scheduler can attempt to place jobs from an associated\n job queue on the compute resources within the environment. If the compute environment is managed, then it can scale\n its instances out or in automatically, based on the job queue demand.

\n

If the state is DISABLED, then the AWS Batch scheduler doesn't attempt to place jobs within the\n environment. Jobs in a STARTING or RUNNING state continue to progress normally. Managed\n compute environments in the DISABLED state don't scale out. However, they scale in to\n minvCpus value after instances become idle.

" } }, "status": { @@ -515,13 +518,13 @@ "computeResources": { "target": "com.amazonaws.batch#ComputeResource", "traits": { - "smithy.api#documentation": "

The compute resources defined for the compute environment.

" + "smithy.api#documentation": "

The compute resources defined for the compute environment. For more information, see Compute Environments in the\n AWS Batch User Guide.

" } }, "serviceRole": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The service role associated with the compute environment that allows AWS Batch to make calls to AWS API\n operations on your behalf.

" + "smithy.api#documentation": "

The service role associated with the compute environment that allows AWS Batch to make calls to AWS API\n operations on your behalf. For more information, see AWS Batch service IAM role in the\n AWS Batch User Guide.

" } } }, @@ -554,7 +557,7 @@ } }, "traits": { - "smithy.api#documentation": "

The order in which compute environments are tried for job placement within a queue. Compute environments are\n tried in ascending order. For example, if two compute environments are associated with a job queue, the compute\n environment with a lower order integer value is tried for job placement first.

" + "smithy.api#documentation": "

The order in which compute environments are tried for job placement within a queue. Compute environments are\n tried in ascending order. For example, if two compute environments are associated with a job queue, the compute\n environment with a lower order integer value is tried for job placement first. Compute environments must be in the\n VALID state before you can associate them with a job queue. All of the compute environments must be\n either EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT);\n EC2 and Fargate compute environments can't be mixed.

\n \n

All compute environments that are associated with a job queue must share the same architecture. AWS Batch doesn't\n support mixing compute environment architecture types in a single job queue.

\n " } }, "com.amazonaws.batch#ComputeEnvironmentOrders": { @@ -569,7 +572,7 @@ "type": { "target": "com.amazonaws.batch#CRType", "traits": { - "smithy.api#documentation": "

The type of compute environment: EC2, SPOT, FARGATE, or\n FARGATE_SPOT. For more information, see Compute Environments in the\n AWS Batch User Guide.

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

The type of compute environment: EC2, SPOT, FARGATE, or\n FARGATE_SPOT. For more information, see Compute Environments in the\n AWS Batch User Guide.

\n \n

If you choose SPOT, you must also specify an Amazon EC2 Spot Fleet role with the\n spotIamFleetRole parameter. For more information, see Amazon EC2 Spot Fleet role in the\n AWS Batch User Guide.

", "smithy.api#required": {} } }, @@ -588,7 +591,7 @@ "maxvCpus": { "target": "com.amazonaws.batch#Integer", "traits": { - "smithy.api#documentation": "

The maximum number of Amazon EC2 vCPUs that an environment can reach.

\n \n

With both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED allocation strategies,\n AWS Batch may need to go above maxvCpus to meet your capacity requirements. In this event, AWS Batch will\n never go above maxvCpus by more than a single instance (e.g., no more than a single instance from among\n those specified in your compute environment).

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

The maximum number of Amazon EC2 vCPUs that a compute environment can reach.

\n \n

With both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED allocation strategies,\n AWS Batch might need to go above maxvCpus to meet your capacity requirements. In this event, AWS Batch will\n never go above maxvCpus by more than a single instance (e.g., no more than a single instance from among\n those specified in your compute environment).

\n ", "smithy.api#required": {} } }, @@ -601,7 +604,7 @@ "instanceTypes": { "target": "com.amazonaws.batch#StringList", "traits": { - "smithy.api#documentation": "

The instances types that may be launched. You can specify instance families to launch any instance type within\n those families (for example, c5 or p3), or you can specify specific sizes within a family\n (such as c5.8xlarge). You can also choose optimal to select instance types (from the C, M,\n and R instance families) on the fly that match the demand of your job queues.

\n \n

This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.

\n \n \n

When you create a compute environment, the instance types that you select for the compute environment must\n share the same architecture. For example, you can't mix x86 and ARM instances in the same compute\n environment.

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

The instances types that can be launched. You can specify instance families to launch any instance type within\n those families (for example, c5 or p3), or you can specify specific sizes within a family\n (such as c5.8xlarge). You can also choose optimal to select instance types (from the C4,\n M4, and R4 instance families) on the fly that match the demand of your job queues.

\n \n

This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.

\n \n \n

When you create a compute environment, the instance types that you select for the compute environment must\n share the same architecture. For example, you can't mix x86 and ARM instances in the same compute\n environment.

\n \n \n \n

Currently, optimal uses instance types from the C4, M4, and R4 instance families. In Regions that\n don't have instance types from those instance families, instance types from the C5, M5. and R5 instance families are\n used.

\n " } }, "imageId": { @@ -629,7 +632,7 @@ "ec2KeyPair": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The Amazon EC2 key pair that is used for instances launched in the compute environment. You can use this key pair to\n log in to your instances with SSH.

\n \n

This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.

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

The Amazon EC2 key pair that's used for instances launched in the compute environment. You can use this key pair to\n log in to your instances with SSH.

\n \n

This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.

\n " } }, "instanceRole": { @@ -641,7 +644,7 @@ "tags": { "target": "com.amazonaws.batch#TagsMap", "traits": { - "smithy.api#documentation": "

Key-value pair tags to be applied to EC2 resources that are launched in the compute environment. For AWS Batch,\n these take the form of \"String1\": \"String2\", where String1 is the tag key and String2 is the tag value—for example, {\n \"Name\": \"AWS Batch Instance - C4OnDemand\" }. This is helpful for recognizing your AWS Batch instances in the Amazon EC2\n console. These tags can not be updated or removed after the compute environment has been created; any changes require\n creating a new compute environment and removing the old compute environment. These tags are not seen when using the\n AWS Batch ListTagsForResource API operation.

" + "smithy.api#documentation": "

Key-value pair tags to be applied to EC2 resources that are launched in the compute environment. For AWS Batch,\n these take the form of \"String1\": \"String2\", where String1 is the tag key and String2 is the tag value−for\n example, { \"Name\": \"AWS Batch Instance - C4OnDemand\" }. This is helpful for recognizing your AWS Batch instances in the\n Amazon EC2 console. These tags can't be updated or removed after the compute environment has been created; any changes\n require creating a new compute environment and removing the old compute environment. These tags are not seen when\n using the AWS Batch ListTagsForResource API operation.

\n \n

This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.

\n " } }, "placementGroup": { @@ -653,7 +656,7 @@ "bidPercentage": { "target": "com.amazonaws.batch#Integer", "traits": { - "smithy.api#documentation": "

The maximum percentage that a Spot Instance price can be when compared with the On-Demand price for that\n instance type before instances are launched. For example, if your maximum percentage is 20%, then the Spot price must\n be below 20% of the current On-Demand price for that Amazon EC2 instance. You always pay the lowest (market) price and\n never more than your maximum percentage. If you leave this field empty, the default value is 100% of the On-Demand\n price.

\n \n

This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.

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

The maximum percentage that a Spot Instance price can be when compared with the On-Demand price for that\n instance type before instances are launched. For example, if your maximum percentage is 20%, then the Spot price must\n be less than 20% of the current On-Demand price for that Amazon EC2 instance. You always pay the lowest (market) price and\n never more than your maximum percentage. If you leave this field empty, the default value is 100% of the On-Demand\n price.

\n \n

This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.

\n " } }, "spotIamFleetRole": { @@ -671,12 +674,12 @@ "ec2Configuration": { "target": "com.amazonaws.batch#Ec2ConfigurationList", "traits": { - "smithy.api#documentation": "

Provides information used to select Amazon Machine Images (AMIs) for instances in the compute environment. If\n Ec2Configuration isn't specified, the default is ECS_AL1.

\n \n

This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.

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

Provides information used to select Amazon Machine Images (AMIs) for EC2 instances in the compute environment.\n If Ec2Configuration isn't specified, the default is ECS_AL1.

\n \n

This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.

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

An object representing an AWS Batch compute resource.

" + "smithy.api#documentation": "

An object representing an AWS Batch compute resource. For more information, see Compute Environments in the\n AWS Batch User Guide.

" } }, "com.amazonaws.batch#ComputeResourceUpdate": { @@ -685,13 +688,13 @@ "minvCpus": { "target": "com.amazonaws.batch#Integer", "traits": { - "smithy.api#documentation": "

The minimum number of Amazon EC2 vCPUs that an environment should maintain.

\n \n

This parameter isnt applicable to jobs running on Fargate resources, and shouldn't be specified.

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

The minimum number of Amazon EC2 vCPUs that an environment should maintain.

\n \n

This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.

\n " } }, "maxvCpus": { "target": "com.amazonaws.batch#Integer", "traits": { - "smithy.api#documentation": "

The maximum number of Amazon EC2 vCPUs that an environment can reach.

" + "smithy.api#documentation": "

The maximum number of Amazon EC2 vCPUs that an environment can reach.

\n \n

With both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED allocation strategies,\n AWS Batch might need to go above maxvCpus to meet your capacity requirements. In this event, AWS Batch will\n never go above maxvCpus by more than a single instance (e.g., no more than a single instance from among\n those specified in your compute environment).

\n " } }, "desiredvCpus": { @@ -709,12 +712,12 @@ "securityGroupIds": { "target": "com.amazonaws.batch#StringList", "traits": { - "smithy.api#documentation": "

The Amazon EC2 security groups associated with instances launched in the compute environment. This parameter is\n required for Fargate compute resources, where it can contain up to 5 security groups. This can't be specified for\n EC2 compute resources. Providing an empty list is handled as if this parameter wasn't specified and no changeis\n made.

" + "smithy.api#documentation": "

The Amazon EC2 security groups associated with instances launched in the compute environment. This parameter is\n required for Fargate compute resources, where it can contain up to 5 security groups. This can't be specified for\n EC2 compute resources. Providing an empty list is handled as if this parameter wasn't specified and no change is\n made.

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

An object representing the attributes of a compute environment that can be updated.

" + "smithy.api#documentation": "

An object representing the attributes of a compute environment that can be updated. For more information, see\n Compute Environments in\n the AWS Batch User Guide.

" } }, "com.amazonaws.batch#ContainerDetail": { @@ -741,7 +744,7 @@ "command": { "target": "com.amazonaws.batch#StringList", "traits": { - "smithy.api#documentation": "

The command that is passed to the container.

" + "smithy.api#documentation": "

The command that's passed to the container.

" } }, "jobRoleArn": { @@ -819,7 +822,7 @@ "taskArn": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon ECS task that is associated with the container job. Each container attempt receives a\n task ARN when they reach the STARTING status.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon ECS task that's associated with the container job. Each container attempt receives a task\n ARN when they reach the STARTING status.

" } }, "logStreamName": { @@ -855,7 +858,7 @@ "logConfiguration": { "target": "com.amazonaws.batch#LogConfiguration", "traits": { - "smithy.api#documentation": "

The log configuration specification for the container.

\n

This parameter maps to LogConfig in the Create a container section of the\n Docker Remote API and the --log-driver option to docker run.\n By default, containers use the same logging driver that the Docker daemon uses. However the container might use a\n different logging driver than the Docker daemon by specifying a log driver with this parameter in the container\n definition. To use a different logging driver for a container, the log system must be configured properly on the\n container instance. Or, alternatively, it must be configured on a different log server for remote logging options.\n For more information on the options for different supported log drivers, see Configure logging drivers in the Docker\n documentation.

\n \n

AWS Batch currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Additional log drivers may be available in future releases of the Amazon ECS\n container agent.

\n \n

This parameter requires version 1.18 of the Docker Remote API or greater on your\n container instance. To check the Docker Remote API version on your container instance, log into your\n container instance and run the following command: sudo docker version | grep \"Server API version\"\n

\n \n

The Amazon ECS container agent running on a container instance must register the logging drivers available on that\n instance with the ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on that\n instance can use these log configuration options. For more information, see Amazon ECS Container Agent Configuration in the\n Amazon Elastic Container Service Developer Guide.

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

The log configuration specification for the container.

\n

This parameter maps to LogConfig in the Create a container section of the\n Docker Remote API and the --log-driver option to docker run.\n By default, containers use the same logging driver that the Docker daemon uses. However the container might use a\n different logging driver than the Docker daemon by specifying a log driver with this parameter in the container\n definition. To use a different logging driver for a container, the log system must be configured properly on the\n container instance. Or, alternatively, it must be configured on a different log server for remote logging options.\n For more information on the options for different supported log drivers, see Configure logging drivers in the Docker\n documentation.

\n \n

AWS Batch currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Additional log drivers might be available in future releases of the Amazon ECS\n container agent.

\n \n

This parameter requires version 1.18 of the Docker Remote API or greater on your\n container instance. To check the Docker Remote API version on your container instance, log into your\n container instance and run the following command: sudo docker version | grep \"Server API version\"\n

\n \n

The Amazon ECS container agent running on a container instance must register the logging drivers available on that\n instance with the ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on that\n instance can use these log configuration options. For more information, see Amazon ECS Container Agent Configuration in the\n Amazon Elastic Container Service Developer Guide.

\n " } }, "secrets": { @@ -878,7 +881,7 @@ } }, "traits": { - "smithy.api#documentation": "

An object representing the details of a container that is part of a job.

" + "smithy.api#documentation": "

An object representing the details of a container that's part of a job.

" } }, "com.amazonaws.batch#ContainerOverrides": { @@ -961,7 +964,7 @@ "command": { "target": "com.amazonaws.batch#StringList", "traits": { - "smithy.api#documentation": "

The command that is passed to the container. This parameter maps to Cmd in the\n Create a container section of the Docker Remote API and the COMMAND parameter to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#cmd.

" + "smithy.api#documentation": "

The command that's passed to the container. This parameter maps to Cmd in the\n Create a container section of the Docker Remote API and the COMMAND parameter to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#cmd.

" } }, "jobRoleArn": { @@ -1062,7 +1065,7 @@ } }, "traits": { - "smithy.api#documentation": "

Container properties are used in job definitions to describe the container that is launched as part of a\n job.

" + "smithy.api#documentation": "

Container properties are used in job definitions to describe the container that's launched as part of a\n job.

" } }, "com.amazonaws.batch#ContainerSummary": { @@ -1102,7 +1105,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an AWS Batch compute environment. You can create MANAGED or UNMANAGED compute\n environments. MANAGED compute environments can use Amazon EC2 or AWS Fargate resources.\n UNMANAGED compute environments can only use EC2 resources.

\n

In a managed compute environment, AWS Batch manages the capacity and instance types of the compute resources\n within the environment. This is based on the compute resource specification that you define or the launch template that you\n specify when you create the compute environment. You can choose either to use EC2 On-Demand Instances and EC2 Spot\n Instances, or to use Fargate and Fargate Spot capacity in your managed compute environment. You can optionally\n set a maximum price so that Spot Instances only launch when the Spot Instance price is below a specified percentage\n of the On-Demand price.

\n \n

Multi-node parallel jobs are not supported on Spot Instances.

\n \n

In an unmanaged compute environment, you can manage your own EC2 compute resources and have a lot of flexibility\n with how you configure your compute resources. For example, you can use custom AMI. However, you need to verify that\n your AMI meets the Amazon ECS container instance AMI specification. For more information, see container instance AMIs in the\n Amazon Elastic Container Service Developer Guide. After you have created your unmanaged compute environment, you can use the\n DescribeComputeEnvironments operation to find the Amazon ECS cluster that is associated with it. Then,\n manually launch your container instances into that Amazon ECS cluster. For more information, see Launching an Amazon ECS\n container instance in the Amazon Elastic Container Service Developer Guide.

\n \n

AWS Batch doesn't upgrade the AMIs in a compute environment after it's created. For example, it doesn't update\n the AMIs when a newer version of the Amazon ECS-optimized AMI is available. Therefore, you're responsible for the\n management of the guest operating system (including updates and security patches) and any additional application\n software or utilities that you install on the compute resources. To use a new AMI for your AWS Batch jobs, complete\n these steps:

\n
    \n
  1. \n

    Create a new compute environment with the new AMI.

    \n
    2. \n
  2. \n

    Add the compute environment to an existing job queue.

    \n
    3. \n
  3. \n

    Remove the earlier compute environment from your job queue.

    \n
    4. \n
  4. \n

    Delete the earlier compute environment.

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

Creates an AWS Batch compute environment. You can create MANAGED or UNMANAGED compute\n environments. MANAGED compute environments can use Amazon EC2 or AWS Fargate resources.\n UNMANAGED compute environments can only use EC2 resources.

\n

In a managed compute environment, AWS Batch manages the capacity and instance types of the compute resources\n within the environment. This is based on the compute resource specification that you define or the launch template that you\n specify when you create the compute environment. You can choose either to use EC2 On-Demand Instances and EC2 Spot\n Instances, or to use Fargate and Fargate Spot capacity in your managed compute environment. You can optionally\n set a maximum price so that Spot Instances only launch when the Spot Instance price is less than a specified\n percentage of the On-Demand price.

\n \n

Multi-node parallel jobs are not supported on Spot Instances.

\n \n

In an unmanaged compute environment, you can manage your own EC2 compute resources and have a lot of flexibility\n with how you configure your compute resources. For example, you can use custom AMI. However, you need to verify that\n your AMI meets the Amazon ECS container instance AMI specification. For more information, see container instance AMIs in the\n Amazon Elastic Container Service Developer Guide. After you have created your unmanaged compute environment, you can use the\n DescribeComputeEnvironments operation to find the Amazon ECS cluster that's associated with it. Then,\n manually launch your container instances into that Amazon ECS cluster. For more information, see Launching an Amazon ECS\n container instance in the Amazon Elastic Container Service Developer Guide.

\n \n

AWS Batch doesn't upgrade the AMIs in a compute environment after it's created. For example, it doesn't update\n the AMIs when a newer version of the Amazon ECS-optimized AMI is available. Therefore, you're responsible for the\n management of the guest operating system (including updates and security patches) and any additional application\n software or utilities that you install on the compute resources. To use a new AMI for your AWS Batch jobs, complete\n these steps:

\n
    \n
  1. \n

    Create a new compute environment with the new AMI.

    \n
    2. \n
  2. \n

    Add the compute environment to an existing job queue.

    \n
    3. \n
  3. \n

    Remove the earlier compute environment from your job queue.

    \n
    4. \n
  4. \n

    Delete the earlier compute environment.

    \n
    5. \n
\n ", "smithy.api#http": { "method": "POST", "uri": "/v1/createcomputeenvironment", @@ -1130,7 +1133,7 @@ "state": { "target": "com.amazonaws.batch#CEState", "traits": { - "smithy.api#documentation": "

The state of the compute environment. If the state is ENABLED, then the compute environment accepts\n jobs from a queue and can scale out automatically based on queues.

" + "smithy.api#documentation": "

The state of the compute environment. If the state is ENABLED, then the compute environment accepts\n jobs from a queue and can scale out automatically based on queues.

\n

If the state is ENABLED, then the AWS Batch scheduler can attempt to place jobs from an associated\n job queue on the compute resources within the environment. If the compute environment is managed, then it can scale\n its instances out or in automatically, based on the job queue demand.

\n

If the state is DISABLED, then the AWS Batch scheduler doesn't attempt to place jobs within the\n environment. Jobs in a STARTING or RUNNING state continue to progress normally. Managed\n compute environments in the DISABLED state don't scale out. However, they scale in to\n minvCpus value after instances become idle.

" } }, "computeResources": { @@ -1142,7 +1145,7 @@ "serviceRole": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to make calls to other AWS services on your\n behalf.

\n

If your specified role has a path other than /, then you must either specify the full role ARN\n (this is recommended) or prefix the role name with the path.

\n \n

Depending on how you created your AWS Batch service role, its ARN may contain the service-role path\n prefix. When you only specify the name of the service role, AWS Batch assumes that your ARN doesn't use the\n service-role path prefix. Because of this, we recommend that you specify the full ARN of your service\n role when you create compute environments.

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

The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to make calls to other AWS services on your behalf. For\n more information, see AWS Batch service\n IAM role in the AWS Batch User Guide.

\n

If your specified role has a path other than /, then you must either specify the full role ARN\n (this is recommended) or prefix the role name with the path.

\n \n

Depending on how you created your AWS Batch service role, its ARN might contain the service-role\n path prefix. When you only specify the name of the service role, AWS Batch assumes that your ARN doesn't use the\n service-role path prefix. Because of this, we recommend that you specify the full ARN of your service\n role when you create compute environments.

\n ", "smithy.api#required": {} } }, @@ -1152,6 +1155,9 @@ "smithy.api#documentation": "

The tags that you apply to the compute environment to help you categorize and organize your resources. Each tag\n consists of a key and an optional value. For more information, see Tagging AWS Resources in AWS General\n Reference.

\n

These tags can be updated or removed using the TagResource and UntagResource API operations. These tags don't\n propagate to the underlying compute resources.

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

Contains the parameters for CreateComputeEnvironment.

" } }, "com.amazonaws.batch#CreateComputeEnvironmentResponse": { @@ -1160,7 +1166,7 @@ "computeEnvironmentName": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The name of the compute environment.

" + "smithy.api#documentation": "

The name of the compute environment. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and\n underscores are allowed.

" } }, "computeEnvironmentArn": { @@ -1202,7 +1208,7 @@ "jobQueueName": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The name of the job queue.

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

The name of the job queue. Up to 128 letters (uppercase and lowercase), numbers, and underscores are\n allowed.

", "smithy.api#required": {} } }, @@ -1215,23 +1221,26 @@ "priority": { "target": "com.amazonaws.batch#Integer", "traits": { - "smithy.api#documentation": "

The priority of the job queue. Job queues with a higher priority (or a higher integer value for the\n priority parameter) are evaluated first when associated with the same compute environment. Priority is\n determined in descending order. For example, a job queue with a priority value of 10 is given scheduling\n preference over a job queue with a priority value of 1.

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

The priority of the job queue. Job queues with a higher priority (or a higher integer value for the\n priority parameter) are evaluated first when associated with the same compute environment. Priority is\n determined in descending order. For example, a job queue with a priority value of 10 is given scheduling\n preference over a job queue with a priority value of 1. All of the compute environments must be either\n EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT); EC2 and\n Fargate compute environments cannot be mixed.

", "smithy.api#required": {} } }, "computeEnvironmentOrder": { "target": "com.amazonaws.batch#ComputeEnvironmentOrders", "traits": { - "smithy.api#documentation": "

The set of compute environments mapped to a job queue and their order relative to each other. The job scheduler\n uses this parameter to determine which compute environment should run a specific job. Compute environments must be in\n the VALID state before you can associate them with a job queue. You can associate up to three compute\n environments with a job queue. All of the compute environments must be either EC2 (EC2 or\n SPOT) or Fargate (FARGATE or FARGATE_SPOT); EC2 and Fargate compute\n environments can't be mixed.

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

The set of compute environments mapped to a job queue and their order relative to each other. The job scheduler\n uses this parameter to determine which compute environment should run a specific job. Compute environments must be in\n the VALID state before you can associate them with a job queue. You can associate up to three compute\n environments with a job queue. All of the compute environments must be either EC2 (EC2 or\n SPOT) or Fargate (FARGATE or FARGATE_SPOT); EC2 and Fargate compute\n environments can't be mixed.

\n \n

All compute environments that are associated with a job queue must share the same architecture. AWS Batch doesn't\n support mixing compute environment architecture types in a single job queue.

\n ", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.batch#TagrisTagsMap", "traits": { - "smithy.api#documentation": "

The tags that you apply to the job queue to help you categorize and organize your resources. Each tag consists\n of a key and an optional value. For more information, see Tagging AWS Resources in AWS General\n Reference.

" + "smithy.api#documentation": "

The tags that you apply to the job queue to help you categorize and organize your resources. Each tag consists\n of a key and an optional value. For more information, see Tagging your AWS Batch resources in\n AWS Batch User Guide.

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

Contains the parameters for CreateJobQueue.

" } }, "com.amazonaws.batch#CreateJobQueueResponse": { @@ -1288,6 +1297,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for DeleteComputeEnvironment.

" } }, "com.amazonaws.batch#DeleteComputeEnvironmentResponse": { @@ -1311,7 +1323,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes the specified job queue. You must first disable submissions for a queue with the UpdateJobQueue operation. All jobs in the queue are terminated when you delete a job queue.

\n

It's not necessary to disassociate compute environments from a queue before submitting a\n DeleteJobQueue request.

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

Deletes the specified job queue. You must first disable submissions for a queue with the UpdateJobQueue operation. All jobs in the queue are\n eventually terminated when\n you delete a job queue. The jobs are\n terminated at a rate of about 16 jobs each second.

\n

It's not necessary to disassociate compute environments from a queue before submitting a\n DeleteJobQueue request.

", "smithy.api#http": { "method": "POST", "uri": "/v1/deletejobqueue", @@ -1329,6 +1341,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for DeleteJobQueue.

" } }, "com.amazonaws.batch#DeleteJobQueueResponse": { @@ -1424,9 +1439,12 @@ "nextToken": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The nextToken value returned from a previous paginated DescribeComputeEnvironments\n request where maxResults was used and the results exceeded the value of that parameter. Pagination\n continues from the end of the previous results that returned the nextToken value. This value is\n null when there are no more results to return.

\n \n

This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.

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

The nextToken value returned from a previous paginated DescribeComputeEnvironments\n request where maxResults was used and the results exceeded the value of that parameter. Pagination\n continues from the end of the previous results that returned the nextToken value. This value is\n null when there are no more results to return.

\n \n

This token should be treated as an opaque identifier that's only used to\n retrieve the next items in a list and not for other programmatic purposes.

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

Contains the parameters for DescribeComputeEnvironments.

" } }, "com.amazonaws.batch#DescribeComputeEnvironmentsResponse": { @@ -1506,9 +1524,12 @@ "nextToken": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The nextToken value returned from a previous paginated DescribeJobDefinitions request\n where maxResults was used and the results exceeded the value of that parameter. Pagination continues\n from the end of the previous results that returned the nextToken value. This value is null\n when there are no more results to return.

\n \n

This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.

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

The nextToken value returned from a previous paginated DescribeJobDefinitions request\n where maxResults was used and the results exceeded the value of that parameter. Pagination continues\n from the end of the previous results that returned the nextToken value. This value is null\n when there are no more results to return.

\n \n

This token should be treated as an opaque identifier that's only used to\n retrieve the next items in a list and not for other programmatic purposes.

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

Contains the parameters for DescribeJobDefinitions.

" } }, "com.amazonaws.batch#DescribeJobDefinitionsResponse": { @@ -1576,9 +1597,12 @@ "nextToken": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The nextToken value returned from a previous paginated DescribeJobQueues request where\n maxResults was used and the results exceeded the value of that parameter. Pagination continues from the\n end of the previous results that returned the nextToken value. This value is null when\n there are no more results to return.

\n \n

This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.

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

The nextToken value returned from a previous paginated DescribeJobQueues request where\n maxResults was used and the results exceeded the value of that parameter. Pagination continues from the\n end of the previous results that returned the nextToken value. This value is null when\n there are no more results to return.

\n \n

This token should be treated as an opaque identifier that's only used to\n retrieve the next items in a list and not for other programmatic purposes.

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

Contains the parameters for DescribeJobQueues.

" } }, "com.amazonaws.batch#DescribeJobQueuesResponse": { @@ -1633,6 +1657,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for DescribeJobs.

" } }, "com.amazonaws.batch#DescribeJobsResponse": { @@ -1710,7 +1737,7 @@ "imageType": { "target": "com.amazonaws.batch#ImageType", "traits": { - "smithy.api#documentation": "

The image type to match with the instance type to select an AMI. If the imageIdOverride parameter\n isn't specified, then a recent Amazon ECS-optimized AMI is used.

\n
\n
ECS_AL2
\n
\n

\n Amazon Linux\n 2− Default for all AWS Graviton-based instance families (for example, C6g,\n M6g, R6g, and T4g) and can be used for all non-GPU instance types.

\n
\n
ECS_AL2_NVIDIA
\n
\n

\n Amazon Linux\n 2 (GPU)−Default for all GPU instance families (for example P4 and G4) and\n can be used for all non-AWS Graviton-based instance types.

\n
\n
ECS_AL1
\n
\n

\n Amazon\n Linux−Default for all non-GPU, non-AWS-Graviton instance families. Amazon Linux is reaching the\n end-of-life of standard support. For more information, see Amazon\n Linux AMI.

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

The image type to match with the instance type to select an AMI. If the imageIdOverride parameter\n isn't specified, then a recent Amazon ECS-optimized AMI is used.

\n
\n
ECS_AL2
\n
\n

\n Amazon Linux\n 2− Default for all AWS Graviton-based instance families (for example, C6g,\n M6g, R6g, and T4g) and can be used for all non-GPU instance types.

\n
\n
ECS_AL2_NVIDIA
\n
\n

\n Amazon Linux\n 2 (GPU)−Default for all GPU instance families (for example P4 and G4) and\n can be used for all non-AWS Graviton-based instance types.

\n
\n
ECS_AL1
\n
\n

\n Amazon\n Linux−Default for all non-GPU, non-AWS Graviton instance families. Amazon Linux is reaching the\n end-of-life of standard support. For more information, see Amazon\n Linux AMI.

\n
\n
", "smithy.api#required": {} } }, @@ -1796,7 +1823,7 @@ "sourcePath": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The path on the host container instance that is presented to the container. If this parameter is empty, then the\n Docker daemon has assigned a host path for you. If this parameter contains a file location, then the data volume\n persists at the specified location on the host container instance until you delete it manually. If the source path\n location does not exist on the host container instance, the Docker daemon creates it. If the location does exist, the\n contents of the source path folder are exported.

\n \n

This parameter isn't applicable to jobs running on Fargate resources and shouldn't be provided.

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

The path on the host container instance that's presented to the container. If this parameter is empty, then the\n Docker daemon has assigned a host path for you. If this parameter contains a file location, then the data volume\n persists at the specified location on the host container instance until you delete it manually. If the source path\n location does not exist on the host container instance, the Docker daemon creates it. If the location does exist, the\n contents of the source path folder are exported.

\n \n

This parameter isn't applicable to jobs running on Fargate resources and shouldn't be provided.

\n " } } }, @@ -2041,7 +2068,7 @@ "status": { "target": "com.amazonaws.batch#JobStatus", "traits": { - "smithy.api#documentation": "

The current status for the job.

\n \n

If your jobs do not progress to STARTING, see Jobs Stuck in RUNNABLE Status in\n the troubleshooting section of the AWS Batch User Guide.

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

The current status for the job.

\n \n

If your jobs don't progress to STARTING, see Jobs Stuck in RUNNABLE Status in\n the troubleshooting section of the AWS Batch User Guide.

\n ", "smithy.api#required": {} } }, @@ -2091,7 +2118,7 @@ "jobDefinition": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The job definition that is used by this job.

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

The job definition that's used by this job.

", "smithy.api#required": {} } }, @@ -2110,7 +2137,7 @@ "nodeDetails": { "target": "com.amazonaws.batch#NodeDetails", "traits": { - "smithy.api#documentation": "

An object representing the details of a node that is associated with a multi-node parallel job.

" + "smithy.api#documentation": "

An object representing the details of a node that's associated with a multi-node parallel job.

" } }, "nodeProperties": { @@ -2199,7 +2226,7 @@ "priority": { "target": "com.amazonaws.batch#Integer", "traits": { - "smithy.api#documentation": "

The priority of the job queue.

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

The priority of the job queue. Job queues with a higher priority (or a higher integer value for the\n priority parameter) are evaluated first when associated with the same compute environment. Priority is\n determined in descending order, for example, a job queue with a priority value of 10 is given scheduling\n preference over a job queue with a priority value of 1. All of the compute environments must be either\n EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT); EC2 and\n Fargate compute environments cannot be mixed.

", "smithy.api#required": {} } }, @@ -2213,7 +2240,7 @@ "tags": { "target": "com.amazonaws.batch#TagrisTagsMap", "traits": { - "smithy.api#documentation": "

The tags applied to the job queue.

" + "smithy.api#documentation": "

The tags applied to the job queue. For more information, see Tagging your AWS Batch resources in\n AWS Batch User Guide.

" } } }, @@ -2318,7 +2345,7 @@ "container": { "target": "com.amazonaws.batch#ContainerSummary", "traits": { - "smithy.api#documentation": "

An object representing the details of the container that is associated with the job.

" + "smithy.api#documentation": "

An object representing the details of the container that's associated with the job.

" } }, "arrayProperties": { @@ -2440,7 +2467,7 @@ "swappiness": { "target": "com.amazonaws.batch#Integer", "traits": { - "smithy.api#documentation": "

This allows you to tune a container's memory swappiness behavior. A swappiness value of\n 0 causes swapping not to happen unless absolutely necessary. A swappiness value of\n 100 causes pages to be swapped very aggressively. Accepted values are whole numbers between\n 0 and 100. If the swappiness parameter isn't specified, a default value of\n 60 is used. If a value isn't specified for maxSwap then this parameter is ignored. This\n parameter maps to the --memory-swappiness option to docker\n run.

\n \n

This parameter isn't applicable to jobs running on Fargate resources and shouldn't be provided.

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

This allows you to tune a container's memory swappiness behavior. A swappiness value of\n 0 causes swapping not to happen unless absolutely necessary. A swappiness value of\n 100 causes pages to be swapped very aggressively. Accepted values are whole numbers between\n 0 and 100. If the swappiness parameter isn't specified, a default value of\n 60 is used. If a value isn't specified for maxSwap then this parameter is ignored.\n If maxSwap is set to 0, the\n container doesn't use swap. This parameter maps to the --memory-swappiness option to\n docker run.

\n \n

Consider the following when you use a per-container swap configuration.

\n \n \n \n

This parameter isn't applicable to jobs running on Fargate resources and shouldn't be provided.

\n " } } }, @@ -2514,9 +2541,12 @@ "nextToken": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The nextToken value returned from a previous paginated ListJobs request where\n maxResults was used and the results exceeded the value of that parameter. Pagination continues from the\n end of the previous results that returned the nextToken value. This value is null when\n there are no more results to return.

\n \n

This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.

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

The nextToken value returned from a previous paginated ListJobs request where\n maxResults was used and the results exceeded the value of that parameter. Pagination continues from the\n end of the previous results that returned the nextToken value. This value is null when\n there are no more results to return.

\n \n

This token should be treated as an opaque identifier that's only used to\n retrieve the next items in a list and not for other programmatic purposes.

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

Contains the parameters for ListJobs.

" } }, "com.amazonaws.batch#ListJobsResponse": { @@ -2592,7 +2622,7 @@ "logDriver": { "target": "com.amazonaws.batch#LogDriver", "traits": { - "smithy.api#documentation": "

The log driver to use for the container. The valid values listed for this parameter are log drivers that the\n Amazon ECS container agent can communicate with by default.

\n

The supported log drivers are awslogs, fluentd, gelf,\n json-file, journald, logentries, syslog, and\n splunk.

\n \n

Jobs running on Fargate resources are restricted to the awslogs and splunk log\n drivers.

\n \n
\n
awslogs
\n
\n

Specifies the Amazon CloudWatch Logs logging driver. For more information, see Using the awslogs Log Driver in the\n AWS Batch User Guide and Amazon CloudWatch Logs logging driver in the Docker documentation.

\n
\n
fluentd
\n
\n

Specifies the Fluentd logging driver. For more information, including usage and options, see Fluentd logging driver in the Docker\n documentation.

\n
\n
gelf
\n
\n

Specifies the Graylog Extended Format (GELF) logging driver. For more information, including usage and\n options, see Graylog Extended Format logging\n driver in the Docker documentation.

\n
\n
journald
\n
\n

Specifies the journald logging driver. For more information, including usage and options, see Journald logging driver in the Docker\n documentation.

\n
\n
json-file
\n
\n

Specifies the JSON file logging driver. For more information, including usage and options, see JSON File logging driver in the Docker\n documentation.

\n
\n
splunk
\n
\n

Specifies the Splunk logging driver. For more information, including usage and options, see Splunk logging driver in the Docker\n documentation.

\n
\n
syslog
\n
\n

Specifies the syslog logging driver. For more information, including usage and options, see Syslog logging driver in the Docker\n documentation.

\n
\n
\n \n

If you have a custom driver that isn't listed earlier that you want to work with the Amazon ECS container agent, you\n can fork the Amazon ECS container agent project that is available on\n GitHub and customize it to work with that driver. We encourage you to submit pull requests for changes that\n you want to have included. However, Amazon Web Services doesn't currently support running modified copies of this\n software.

\n \n

This parameter requires version 1.18 of the Docker Remote API or greater on your\n container instance. To check the Docker Remote API version on your container instance, log into your\n container instance and run the following command: sudo docker version | grep \"Server API version\" \n

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

The log driver to use for the container. The valid values listed for this parameter are log drivers that the\n Amazon ECS container agent can communicate with by default.

\n

The supported log drivers are awslogs, fluentd, gelf,\n json-file, journald, logentries, syslog, and\n splunk.

\n \n

Jobs running on Fargate resources are restricted to the awslogs and splunk log\n drivers.

\n \n
\n
awslogs
\n
\n

Specifies the Amazon CloudWatch Logs logging driver. For more information, see Using the awslogs Log Driver in the\n AWS Batch User Guide and Amazon CloudWatch Logs logging driver in the Docker documentation.

\n
\n
fluentd
\n
\n

Specifies the Fluentd logging driver. For more information, including usage and options, see Fluentd logging driver in the Docker\n documentation.

\n
\n
gelf
\n
\n

Specifies the Graylog Extended Format (GELF) logging driver. For more information, including usage and\n options, see Graylog Extended Format logging\n driver in the Docker documentation.

\n
\n
journald
\n
\n

Specifies the journald logging driver. For more information, including usage and options, see Journald logging driver in the Docker\n documentation.

\n
\n
json-file
\n
\n

Specifies the JSON file logging driver. For more information, including usage and options, see JSON File logging driver in the Docker\n documentation.

\n
\n
splunk
\n
\n

Specifies the Splunk logging driver. For more information, including usage and options, see Splunk logging driver in the Docker\n documentation.

\n
\n
syslog
\n
\n

Specifies the syslog logging driver. For more information, including usage and options, see Syslog logging driver in the Docker\n documentation.

\n
\n
\n \n

If you have a custom driver that'sn't listed earlier that you want to work with the Amazon ECS container agent, you\n can fork the Amazon ECS container agent project that's available on\n GitHub and customize it to work with that driver. We encourage you to submit pull requests for changes that\n you want to have included. However, Amazon Web Services doesn't currently support running modified copies of this\n software.

\n \n

This parameter requires version 1.18 of the Docker Remote API or greater on your\n container instance. To check the Docker Remote API version on your container instance, log into your\n container instance and run the following command: sudo docker version | grep \"Server API version\" \n

", "smithy.api#required": {} } }, @@ -2683,7 +2713,7 @@ } }, "traits": { - "smithy.api#documentation": "

Details on a Docker volume mount point that is used in a job's container properties. This parameter maps to\n Volumes in the Create a\n container section of the Docker Remote API and the --volume option to docker run.

" + "smithy.api#documentation": "

Details on a Docker volume mount point that's used in a job's container properties. This parameter maps to\n Volumes in the Create a\n container section of the Docker Remote API and the --volume option to docker run.

" } }, "com.amazonaws.batch#MountPoints": { @@ -2775,7 +2805,7 @@ } }, "traits": { - "smithy.api#documentation": "

Object representing any node overrides to a job definition that is used in a SubmitJob API\n operation.

\n \n

This isn't applicable to jobs running on Fargate resources and shouldn't be provided; use\n containerOverrides instead.

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

Object representing any node overrides to a job definition that's used in a SubmitJob API\n operation.

\n \n

This isn't applicable to jobs running on Fargate resources and shouldn't be provided; use\n containerOverrides instead.

\n " } }, "com.amazonaws.batch#NodeProperties": { @@ -2830,7 +2860,7 @@ } }, "traits": { - "smithy.api#documentation": "

An object representing the properties of a node that is associated with a multi-node parallel job.

" + "smithy.api#documentation": "

An object representing the properties of a node that's associated with a multi-node parallel job.

" } }, "com.amazonaws.batch#NodePropertyOverride": { @@ -2851,7 +2881,7 @@ } }, "traits": { - "smithy.api#documentation": "

Object representing any node overrides to a job definition that is used in a SubmitJob API\n operation.

" + "smithy.api#documentation": "

Object representing any node overrides to a job definition that's used in a SubmitJob API\n operation.

" } }, "com.amazonaws.batch#NodePropertyOverrides": { @@ -2872,7 +2902,7 @@ "targetNodes": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The range of nodes, using node index values. A range of 0:3 indicates nodes with index values of\n 0 through 3. If the starting range value is omitted (:n), then 0\n is used to start the range. If the ending range value is omitted (n:), then the highest possible node\n index is used to end the range. Your accumulative node ranges must account for all nodes (0:n). You may\n nest node ranges, for example 0:10 and 4:5, in which case the 4:5 range\n properties override the 0:10 properties.

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

The range of nodes, using node index values. A range of 0:3 indicates nodes with index values of\n 0 through 3. If the starting range value is omitted (:n), then 0\n is used to start the range. If the ending range value is omitted (n:), then the highest possible node\n index is used to end the range. Your accumulative node ranges must account for all nodes (0:n). You can\n nest node ranges, for example 0:10 and 4:5, in which case the 4:5 range\n properties override the 0:10 properties.

", "smithy.api#required": {} } }, @@ -2980,7 +3010,7 @@ "retryStrategy": { "target": "com.amazonaws.batch#RetryStrategy", "traits": { - "smithy.api#documentation": "

The retry strategy to use for failed jobs that are submitted with this job definition. Any retry strategy that\n is specified during a SubmitJob operation overrides the retry strategy defined here. If a job is\n terminated due to a timeout, it isn't retried.

" + "smithy.api#documentation": "

The retry strategy to use for failed jobs that are submitted with this job definition. Any retry strategy that's\n specified during a SubmitJob operation overrides the retry strategy defined here. If a job is\n terminated due to a timeout, it isn't retried.

" } }, "propagateTags": { @@ -2992,7 +3022,7 @@ "timeout": { "target": "com.amazonaws.batch#JobTimeout", "traits": { - "smithy.api#documentation": "

The timeout configuration for jobs that are submitted with this job definition, after which AWS Batch terminates\n your jobs if they have not finished. If a job is terminated due to a timeout, it isn't retried. The minimum value for\n the timeout is 60 seconds. Any timeout configuration that is specified during a SubmitJob operation\n overrides the timeout configuration defined here. For more information, see Job Timeouts in the\n AWS Batch User Guide.

" + "smithy.api#documentation": "

The timeout configuration for jobs that are submitted with this job definition, after which AWS Batch terminates\n your jobs if they have not finished. If a job is terminated due to a timeout, it isn't retried. The minimum value for\n the timeout is 60 seconds. Any timeout configuration that's specified during a SubmitJob operation\n overrides the timeout configuration defined here. For more information, see Job Timeouts in the\n AWS Batch User Guide.

" } }, "tags": { @@ -3007,6 +3037,9 @@ "smithy.api#documentation": "

The platform capabilities required by the job definition. If no value is specified, it defaults to\n EC2. To run the job on Fargate resources, specify FARGATE.

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

Contains the parameters for RegisterJobDefinition.

" } }, "com.amazonaws.batch#RegisterJobDefinitionResponse": { @@ -3041,7 +3074,7 @@ "value": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The quantity of the specified resource to reserve for the container. The values vary based on the\n type specified.

\n
\n
type=\"GPU\"
\n
\n

The number of physical GPUs to reserve for the container. The number of GPUs reserved for all containers in a\n job shouldn't exceed the number of available GPUs on the compute resource that the job is launched on.

\n \n

GPUs are not available for jobs running on Fargate resources.

\n \n
\n
type=\"MEMORY\"
\n
\n

For jobs running on EC2 resources, the hard limit (in MiB) of memory to present to the container. If your\n container attempts to exceed the memory specified here, the container is killed. This parameter maps to\n Memory in the Create a container section of the Docker Remote API and the\n --memory option to docker run. You must specify at least\n 4 MiB of memory for a job. This is required but can be specified in several places for multi-node parallel (MNP)\n jobs. It must be specified for each node at least once. This parameter maps to Memory in the\n Create a container section of the Docker Remote API and the --memory option to docker run. You must specify at least 4 MiB of memory for a job.

\n \n

If you're trying to maximize your resource utilization by providing your jobs as much memory as possible for\n a particular instance type, see Memory\n Management in the AWS Batch User Guide.

\n \n

For jobs running on Fargate resources, then value is the hard limit (in GiB), represented in\n decimal form, and must match one of the supported values (0.5 and whole numbers between 1 and 30, inclusive) and\n the VCPU values must be one of the values supported for that memory value.

\n
\n
value = 0.5
\n
\n

\n VCPU = 0.25

\n
\n
value = 1
\n
\n

\n VCPU = 0.25 or 0.5

\n
\n
value = 2
\n
\n

\n VCPU = 0.25, 0.5, or 1

\n
\n
value = 3
\n
\n

\n VCPU = 0.5, or 1

\n
\n
value = 4
\n
\n

\n VCPU = 0.5, 1, or 2

\n
\n
value = 5, 6, or 7
\n
\n

\n VCPU = 1 or 2

\n
\n
value = 8
\n
\n

\n VCPU = 1, 2, or 4

\n
\n
value = 9, 10, 11, 12, 13, 14, 15, or 16
\n
\n

\n VCPU = 2 or 4

\n
\n
value = 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, or 30
\n
\n

\n VCPU = 4

\n
\n
\n
\n
type=\"VCPU\"
\n
\n

The number of vCPUs reserved for the container. This parameter maps to CpuShares in the\n Create a container section of the Docker Remote API and the --cpu-shares option to\n docker run. Each vCPU is equivalent to 1,024 CPU shares. You must\n specify at least one vCPU. This is required but can be specified in several places; it must be specified for each\n node at least once.

\n

For jobs running on Fargate resources, then value must match one of the supported values and\n the MEMORY values must be one of the values supported for that VCPU value. The supported values are\n 0.25, 0.5, 1, 2, and 4

\n
\n
value = 0.25
\n
\n

\n MEMORY = 0.5, 1, or 2

\n
\n
value = 0.5
\n
\n

\n MEMORY = 1, 2, 3, or 4

\n
\n
value = 1
\n
\n

\n MEMORY = 2, 3, 4, 5, 6, 7, or 8

\n
\n
value = 2
\n
\n

\n MEMORY = 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, or 16

\n
\n
value = 4
\n
\n

\n MEMORY = 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, or 30

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

The quantity of the specified resource to reserve for the container. The values vary based on the\n type specified.

\n
\n
type=\"GPU\"
\n
\n

The number of physical GPUs to reserve for the container. The number of GPUs reserved for all containers in a\n job shouldn't exceed the number of available GPUs on the compute resource that the job is launched on.

\n \n

GPUs are not available for jobs running on Fargate resources.

\n \n
\n
type=\"MEMORY\"
\n
\n

For jobs running on EC2 resources, the hard limit (in MiB) of memory to present to the container. If your\n container attempts to exceed the memory specified here, the container is killed. This parameter maps to\n Memory in the Create a container section of the Docker Remote API and the\n --memory option to docker run. You must specify at least\n 4 MiB of memory for a job. This is required but can be specified in several places for multi-node parallel (MNP)\n jobs. It must be specified for each node at least once. This parameter maps to Memory in the\n Create a container section of the Docker Remote API and the --memory option to docker run.

\n \n

If you're trying to maximize your resource utilization by providing your jobs as much memory as possible for\n a particular instance type, see Memory\n Management in the AWS Batch User Guide.

\n \n

For jobs running on Fargate resources, then value is the hard limit (in MiB), and must match\n one of the supported values and the VCPU values must be one of the values supported for that memory\n value.

\n
\n
value = 512
\n
\n

\n VCPU = 0.25

\n
\n
value = 1024
\n
\n

\n VCPU = 0.25 or 0.5

\n
\n
value = 2048
\n
\n

\n VCPU = 0.25, 0.5, or 1

\n
\n
value = 3072
\n
\n

\n VCPU = 0.5, or 1

\n
\n
value = 4096
\n
\n

\n VCPU = 0.5, 1, or 2

\n
\n
value = 5120, 6144, or 7168
\n
\n

\n VCPU = 1 or 2

\n
\n
value = 8192
\n
\n

\n VCPU = 1, 2, or 4

\n
\n
value = 9216, 10240, 11264, 12288, 13312, 14336, 15360, or 16384
\n
\n

\n VCPU = 2 or 4

\n
\n
value = 17408, 18432, 19456, 20480, 21504, 22528, 23552, 24576, 25600, 26624, 27648, 28672, 29696, or 30720
\n
\n

\n VCPU = 4

\n
\n
\n
\n
type=\"VCPU\"
\n
\n

The number of vCPUs reserved for the container. This parameter maps to CpuShares in the\n Create a container section of the Docker Remote API and the --cpu-shares option to\n docker run. Each vCPU is equivalent to 1,024 CPU shares. For EC2\n resources, you must specify at least one vCPU. This is required but can be specified in several places; it must be\n specified for each node at least once.

\n

For jobs running on Fargate resources, then value must match one of the supported values and\n the MEMORY values must be one of the values supported for that VCPU value. The supported values are\n 0.25, 0.5, 1, 2, and 4

\n
\n
value = 0.25
\n
\n

\n MEMORY = 512, 1024, or 2048

\n
\n
value = 0.5
\n
\n

\n MEMORY = 1024, 2048, 3072, or 4096

\n
\n
value = 1
\n
\n

\n MEMORY = 2048, 3072, 4096, 5120, 6144, 7168, or 8192

\n
\n
value = 2
\n
\n

\n MEMORY = 4096, 5120, 6144, 7168, 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, or 16384

\n
\n
value = 4
\n
\n

\n MEMORY = 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, 16384, 17408, 18432, 19456,\n 20480, 21504, 22528, 23552, 24576, 25600, 26624, 27648, 28672, 29696, or 30720

\n
\n
\n
\n
", "smithy.api#required": {} } }, @@ -3103,7 +3136,7 @@ "attempts": { "target": "com.amazonaws.batch#Integer", "traits": { - "smithy.api#documentation": "

The number of times to move a job to the RUNNABLE status. You may specify between 1 and 10\n attempts. If the value of attempts is greater than one, the job is retried on failure the same number of\n attempts as the value.

" + "smithy.api#documentation": "

The number of times to move a job to the RUNNABLE status. You can specify between 1 and 10\n attempts. If the value of attempts is greater than one, the job is retried on failure the same number of\n attempts as the value.

" } }, "evaluateOnExit": { @@ -3237,7 +3270,7 @@ "containerOverrides": { "target": "com.amazonaws.batch#ContainerOverrides", "traits": { - "smithy.api#documentation": "

A list of container overrides in JSON format that specify the name of a container in the specified job\n definition and the overrides it should receive. You can override the default command for a container (that is\n specified in the job definition or the Docker image) with a command override. You can also override\n existing environment variables (that are specified in the job definition or Docker image) on a container or add new\n environment variables to it with an environment override.

" + "smithy.api#documentation": "

A list of container overrides in JSON format that specify the name of a container in the specified job\n definition and the overrides it should receive. You can override the default command for a container (that's\n specified in the job definition or the Docker image) with a command override. You can also override\n existing environment variables (that are specified in the job definition or Docker image) on a container or add new\n environment variables to it with an environment override.

" } }, "nodeOverrides": { @@ -3270,6 +3303,9 @@ "smithy.api#documentation": "

The tags that you apply to the job request to help you categorize and organize your resources. Each tag consists\n of a key and an optional value. For more information, see Tagging AWS Resources in AWS General\n Reference.

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

Contains the parameters for SubmitJob.

" } }, "com.amazonaws.batch#SubmitJobResponse": { @@ -3442,6 +3478,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for TerminateJob.

" } }, "com.amazonaws.batch#TerminateJobResponse": { @@ -3605,21 +3644,24 @@ "state": { "target": "com.amazonaws.batch#CEState", "traits": { - "smithy.api#documentation": "

The state of the compute environment. Compute environments in the ENABLED state can accept jobs\n from a queue and scale in or out automatically based on the workload demand of its associated queues.

" + "smithy.api#documentation": "

The state of the compute environment. Compute environments in the ENABLED state can accept jobs\n from a queue and scale in or out automatically based on the workload demand of its associated queues.

\n

If the state is ENABLED, then the AWS Batch scheduler can attempt to place jobs from an associated\n job queue on the compute resources within the environment. If the compute environment is managed, then it can scale\n its instances out or in automatically, based on the job queue demand.

\n

If the state is DISABLED, then the AWS Batch scheduler doesn't attempt to place jobs within the\n environment. Jobs in a STARTING or RUNNING state continue to progress normally. Managed\n compute environments in the DISABLED state don't scale out. However, they scale in to\n minvCpus value after instances become idle.

" } }, "computeResources": { "target": "com.amazonaws.batch#ComputeResourceUpdate", "traits": { - "smithy.api#documentation": "

Details of the compute resources managed by the compute environment. Required for a managed compute\n environment.

" + "smithy.api#documentation": "

Details of the compute resources managed by the compute environment. Required for a managed compute environment.\n For more information, see Compute\n Environments in the AWS Batch User Guide.

" } }, "serviceRole": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to make calls to other AWS services on your\n behalf.

\n

If your specified role has a path other than /, then you must either specify the full role ARN\n (this is recommended) or prefix the role name with the path.

\n \n

Depending on how you created your AWS Batch service role, its ARN might contain the service-role\n path prefix. When you only specify the name of the service role, AWS Batch assumes that your ARN does not use the\n service-role path prefix. Because of this, we recommend that you specify the full ARN of your service\n role when you create compute environments.

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

The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to make calls to other AWS services on your behalf. For\n more information, see AWS Batch service\n IAM role in the AWS Batch User Guide.

\n

If your specified role has a path other than /, then you must either specify the full role ARN\n (this is recommended) or prefix the role name with the path.

\n \n

Depending on how you created your AWS Batch service role, its ARN might contain the service-role\n path prefix. When you only specify the name of the service role, AWS Batch assumes that your ARN does not use the\n service-role path prefix. Because of this, we recommend that you specify the full ARN of your service\n role when you create compute environments.

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

Contains the parameters for UpdateComputeEnvironment.

" } }, "com.amazonaws.batch#UpdateComputeEnvironmentResponse": { @@ -3628,7 +3670,7 @@ "computeEnvironmentName": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The name of the compute environment.

" + "smithy.api#documentation": "

The name of the compute environment. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and\n underscores are allowed.

" } }, "computeEnvironmentArn": { @@ -3683,15 +3725,18 @@ "priority": { "target": "com.amazonaws.batch#Integer", "traits": { - "smithy.api#documentation": "

The priority of the job queue. Job queues with a higher priority (or a higher integer value for the\n priority parameter) are evaluated first when associated with the same compute environment. Priority is\n determined in descending order, for example, a job queue with a priority value of 10 is given scheduling\n preference over a job queue with a priority value of 1.

" + "smithy.api#documentation": "

The priority of the job queue. Job queues with a higher priority (or a higher integer value for the\n priority parameter) are evaluated first when associated with the same compute environment. Priority is\n determined in descending order, for example, a job queue with a priority value of 10 is given scheduling\n preference over a job queue with a priority value of 1. All of the compute environments must be either\n EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT); EC2 and\n Fargate compute environments cannot be mixed.

" } }, "computeEnvironmentOrder": { "target": "com.amazonaws.batch#ComputeEnvironmentOrders", "traits": { - "smithy.api#documentation": "

Details the set of compute environments mapped to a job queue and their order relative to each other. This is\n one of the parameters used by the job scheduler to determine which compute environment should run a given job. All of\n the compute environments must be either EC2 (EC2 or SPOT) or Fargate\n (FARGATE or FARGATE_SPOT); EC2 and Fargate compute environments can't be mixed.

" + "smithy.api#documentation": "

Details the set of compute environments mapped to a job queue and their order relative to each other. This is\n one of the parameters used by the job scheduler to determine which compute environment should run a given job.\n Compute environments must be in the VALID state before you can associate them with a job queue. All of\n the compute environments must be either EC2 (EC2 or SPOT) or Fargate\n (FARGATE or FARGATE_SPOT); EC2 and Fargate compute environments can't be mixed.

\n \n

All compute environments that are associated with a job queue must share the same architecture. AWS Batch doesn't\n support mixing compute environment architecture types in a single job queue.

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

Contains the parameters for UpdateJobQueue.

" } }, "com.amazonaws.batch#UpdateJobQueueResponse": { diff --git a/codegen/sdk-codegen/aws-models/cloudformation.2010-05-15.json b/codegen/sdk-codegen/aws-models/cloudformation.2010-05-15.json index 333538c7450..ab2b92b7405 100644 --- a/codegen/sdk-codegen/aws-models/cloudformation.2010-05-15.json +++ b/codegen/sdk-codegen/aws-models/cloudformation.2010-05-15.json @@ -60,13 +60,16 @@ "traits": { "smithy.api#enum": [ { - "value": "SUCCEEDED" + "value": "SUCCEEDED", + "name": "SUCCEEDED" }, { - "value": "FAILED" + "value": "FAILED", + "name": "FAILED" }, { - "value": "SKIPPED" + "value": "SKIPPED", + "name": "SKIPPED" } ] } @@ -1572,10 +1575,12 @@ "traits": { "smithy.api#enum": [ { - "value": "LIVE" + "value": "LIVE", + "name": "LIVE" }, { - "value": "DEPRECATED" + "value": "DEPRECATED", + "name": "DEPRECATED" } ] } @@ -4637,10 +4642,12 @@ "traits": { "smithy.api#enum": [ { - "value": "SERVICE_MANAGED" + "value": "SERVICE_MANAGED", + "name": "SERVICE_MANAGED" }, { - "value": "SELF_MANAGED" + "value": "SELF_MANAGED", + "name": "SELF_MANAGED" } ] } @@ -4751,13 +4758,16 @@ "traits": { "smithy.api#enum": [ { - "value": "NON_PROVISIONABLE" + "value": "NON_PROVISIONABLE", + "name": "NON_PROVISIONABLE" }, { - "value": "IMMUTABLE" + "value": "IMMUTABLE", + "name": "IMMUTABLE" }, { - "value": "FULLY_MUTABLE" + "value": "FULLY_MUTABLE", + "name": "FULLY_MUTABLE" } ] } @@ -4928,13 +4938,16 @@ "traits": { "smithy.api#enum": [ { - "value": "COMPLETE" + "value": "COMPLETE", + "name": "COMPLETE" }, { - "value": "IN_PROGRESS" + "value": "IN_PROGRESS", + "name": "IN_PROGRESS" }, { - "value": "FAILED" + "value": "FAILED", + "name": "FAILED" } ] } @@ -4960,10 +4973,12 @@ "traits": { "smithy.api#enum": [ { - "value": "RESOURCE" + "value": "RESOURCE", + "name": "RESOURCE" }, { - "value": "MODULE" + "value": "MODULE", + "name": "MODULE" } ] } @@ -6085,22 +6100,28 @@ "traits": { "smithy.api#enum": [ { - "value": "PENDING" + "value": "PENDING", + "name": "PENDING" }, { - "value": "RUNNING" + "value": "RUNNING", + "name": "RUNNING" }, { - "value": "SUCCEEDED" + "value": "SUCCEEDED", + "name": "SUCCEEDED" }, { - "value": "FAILED" + "value": "FAILED", + "name": "FAILED" }, { - "value": "CANCELLED" + "value": "CANCELLED", + "name": "CANCELLED" }, { - "value": "INOPERABLE" + "value": "INOPERABLE", + "name": "INOPERABLE" } ] } @@ -6130,7 +6151,8 @@ "traits": { "smithy.api#enum": [ { - "value": "DETAILED_STATUS" + "value": "DETAILED_STATUS", + "name": "DETAILED_STATUS" } ] } @@ -6174,13 +6196,16 @@ "traits": { "smithy.api#enum": [ { - "value": "CURRENT" + "value": "CURRENT", + "name": "CURRENT" }, { - "value": "OUTDATED" + "value": "OUTDATED", + "name": "OUTDATED" }, { - "value": "INOPERABLE" + "value": "INOPERABLE", + "name": "INOPERABLE" } ] } @@ -7029,16 +7054,20 @@ "traits": { "smithy.api#enum": [ { - "value": "CREATE" + "value": "CREATE", + "name": "CREATE" }, { - "value": "UPDATE" + "value": "UPDATE", + "name": "UPDATE" }, { - "value": "DELETE" + "value": "DELETE", + "name": "DELETE" }, { - "value": "DETECT_DRIFT" + "value": "DETECT_DRIFT", + "name": "DETECT_DRIFT" } ] } @@ -7086,19 +7115,24 @@ "traits": { "smithy.api#enum": [ { - "value": "PENDING" + "value": "PENDING", + "name": "PENDING" }, { - "value": "RUNNING" + "value": "RUNNING", + "name": "RUNNING" }, { - "value": "SUCCEEDED" + "value": "SUCCEEDED", + "name": "SUCCEEDED" }, { - "value": "FAILED" + "value": "FAILED", + "name": "FAILED" }, { - "value": "CANCELLED" + "value": "CANCELLED", + "name": "CANCELLED" } ] } @@ -7158,22 +7192,28 @@ "traits": { "smithy.api#enum": [ { - "value": "RUNNING" + "value": "RUNNING", + "name": "RUNNING" }, { - "value": "SUCCEEDED" + "value": "SUCCEEDED", + "name": "SUCCEEDED" }, { - "value": "FAILED" + "value": "FAILED", + "name": "FAILED" }, { - "value": "STOPPING" + "value": "STOPPING", + "name": "STOPPING" }, { - "value": "STOPPED" + "value": "STOPPED", + "name": "STOPPED" }, { - "value": "QUEUED" + "value": "QUEUED", + "name": "QUEUED" } ] } @@ -7227,10 +7267,12 @@ "traits": { "smithy.api#enum": [ { - "value": "ACTIVE" + "value": "ACTIVE", + "name": "ACTIVE" }, { - "value": "DELETED" + "value": "DELETED", + "name": "DELETED" } ] } @@ -8417,10 +8459,12 @@ "traits": { "smithy.api#enum": [ { - "value": "PUBLIC" + "value": "PUBLIC", + "name": "PUBLIC" }, { - "value": "PRIVATE" + "value": "PRIVATE", + "name": "PRIVATE" } ] } diff --git a/codegen/sdk-codegen/aws-models/cloudfront.2020-05-31.json b/codegen/sdk-codegen/aws-models/cloudfront.2020-05-31.json index c905d15f6ef..35741e2bc7f 100644 --- a/codegen/sdk-codegen/aws-models/cloudfront.2020-05-31.json +++ b/codegen/sdk-codegen/aws-models/cloudfront.2020-05-31.json @@ -454,16 +454,20 @@ "traits": { "smithy.api#enum": [ { - "value": "none" + "value": "none", + "name": "none" }, { - "value": "whitelist" + "value": "whitelist", + "name": "whitelist" }, { - "value": "allExcept" + "value": "allExcept", + "name": "allExcept" }, { - "value": "all" + "value": "all", + "name": "all" } ] } @@ -491,10 +495,12 @@ "traits": { "smithy.api#enum": [ { - "value": "none" + "value": "none", + "name": "none" }, { - "value": "whitelist" + "value": "whitelist", + "name": "whitelist" } ] } @@ -569,16 +575,20 @@ "traits": { "smithy.api#enum": [ { - "value": "none" + "value": "none", + "name": "none" }, { - "value": "whitelist" + "value": "whitelist", + "name": "whitelist" }, { - "value": "allExcept" + "value": "allExcept", + "name": "allExcept" }, { - "value": "all" + "value": "all", + "name": "all" } ] } @@ -640,10 +650,12 @@ "traits": { "smithy.api#enum": [ { - "value": "managed" + "value": "managed", + "name": "managed" }, { - "value": "custom" + "value": "custom", + "name": "custom" } ] } @@ -688,13 +700,16 @@ "traits": { "smithy.api#enum": [ { - "value": "cloudfront" + "value": "cloudfront", + "name": "cloudfront" }, { - "value": "iam" + "value": "iam", + "name": "iam" }, { - "value": "acm" + "value": "acm", + "name": "acm" } ] } @@ -4040,16 +4055,20 @@ "traits": { "smithy.api#enum": [ { - "value": "viewer-request" + "value": "viewer-request", + "name": "viewer_request" }, { - "value": "viewer-response" + "value": "viewer-response", + "name": "viewer_response" }, { - "value": "origin-request" + "value": "origin-request", + "name": "origin_request" }, { - "value": "origin-response" + "value": "origin-response", + "name": "origin_response" } ] } @@ -4457,7 +4476,8 @@ "traits": { "smithy.api#enum": [ { - "value": "URLEncoded" + "value": "URLEncoded", + "name": "URLEncoded" } ] } @@ -4529,13 +4549,16 @@ "traits": { "smithy.api#enum": [ { - "value": "blacklist" + "value": "blacklist", + "name": "blacklist" }, { - "value": "whitelist" + "value": "whitelist", + "name": "whitelist" }, { - "value": "none" + "value": "none", + "name": "none" } ] } @@ -5858,10 +5881,12 @@ "traits": { "smithy.api#enum": [ { - "value": "http1.1" + "value": "http1.1", + "name": "http1_1" }, { - "value": "http2" + "value": "http2", + "name": "http2" } ] } @@ -5871,13 +5896,16 @@ "traits": { "smithy.api#enum": [ { - "value": "APPROVED" + "value": "APPROVED", + "name": "APPROVED" }, { - "value": "SUSPENDED" + "value": "SUSPENDED", + "name": "SUSPENDED" }, { - "value": "PENDING" + "value": "PENDING", + "name": "PENDING" } ] } @@ -6382,13 +6410,16 @@ "traits": { "smithy.api#enum": [ { - "value": "none" + "value": "none", + "name": "none" }, { - "value": "whitelist" + "value": "whitelist", + "name": "whitelist" }, { - "value": "all" + "value": "all", + "name": "all" } ] } @@ -7779,25 +7810,32 @@ "traits": { "smithy.api#enum": [ { - "value": "GET" + "value": "GET", + "name": "GET" }, { - "value": "HEAD" + "value": "HEAD", + "name": "HEAD" }, { - "value": "POST" + "value": "POST", + "name": "POST" }, { - "value": "PUT" + "value": "PUT", + "name": "PUT" }, { - "value": "PATCH" + "value": "PATCH", + "name": "PATCH" }, { - "value": "OPTIONS" + "value": "OPTIONS", + "name": "OPTIONS" }, { - "value": "DELETE" + "value": "DELETE", + "name": "DELETE" } ] } @@ -7816,22 +7854,28 @@ "traits": { "smithy.api#enum": [ { - "value": "SSLv3" + "value": "SSLv3", + "name": "SSLv3" }, { - "value": "TLSv1" + "value": "TLSv1", + "name": "TLSv1" }, { - "value": "TLSv1_2016" + "value": "TLSv1_2016", + "name": "TLSv1_2016" }, { - "value": "TLSv1.1_2016" + "value": "TLSv1.1_2016", + "name": "TLSv1_1_2016" }, { - "value": "TLSv1.2_2018" + "value": "TLSv1.2_2018", + "name": "TLSv1_2_2018" }, { - "value": "TLSv1.2_2019" + "value": "TLSv1.2_2019", + "name": "TLSv1_2_2019" } ] } @@ -8263,13 +8307,16 @@ "traits": { "smithy.api#enum": [ { - "value": "http-only" + "value": "http-only", + "name": "http_only" }, { - "value": "match-viewer" + "value": "match-viewer", + "name": "match_viewer" }, { - "value": "https-only" + "value": "https-only", + "name": "https_only" } ] } @@ -8363,13 +8410,16 @@ "traits": { "smithy.api#enum": [ { - "value": "none" + "value": "none", + "name": "none" }, { - "value": "whitelist" + "value": "whitelist", + "name": "whitelist" }, { - "value": "all" + "value": "all", + "name": "all" } ] } @@ -8397,16 +8447,20 @@ "traits": { "smithy.api#enum": [ { - "value": "none" + "value": "none", + "name": "none" }, { - "value": "whitelist" + "value": "whitelist", + "name": "whitelist" }, { - "value": "allViewer" + "value": "allViewer", + "name": "allViewer" }, { - "value": "allViewerAndWhitelistCloudFront" + "value": "allViewerAndWhitelistCloudFront", + "name": "allViewerAndWhitelistCloudFront" } ] } @@ -8481,13 +8535,16 @@ "traits": { "smithy.api#enum": [ { - "value": "none" + "value": "none", + "name": "none" }, { - "value": "whitelist" + "value": "whitelist", + "name": "whitelist" }, { - "value": "all" + "value": "all", + "name": "all" } ] } @@ -8549,10 +8606,12 @@ "traits": { "smithy.api#enum": [ { - "value": "managed" + "value": "managed", + "name": "managed" }, { - "value": "custom" + "value": "custom", + "name": "custom" } ] } @@ -8722,13 +8781,16 @@ "traits": { "smithy.api#enum": [ { - "value": "PriceClass_100" + "value": "PriceClass_100", + "name": "PriceClass_100" }, { - "value": "PriceClass_200" + "value": "PriceClass_200", + "name": "PriceClass_200" }, { - "value": "PriceClass_All" + "value": "PriceClass_All", + "name": "PriceClass_All" } ] } @@ -9285,13 +9347,16 @@ "traits": { "smithy.api#enum": [ { - "value": "sni-only" + "value": "sni-only", + "name": "sni_only" }, { - "value": "vip" + "value": "vip", + "name": "vip" }, { - "value": "static-ip" + "value": "static-ip", + "name": "static_ip" } ] } @@ -9330,16 +9395,20 @@ "traits": { "smithy.api#enum": [ { - "value": "SSLv3" + "value": "SSLv3", + "name": "SSLv3" }, { - "value": "TLSv1" + "value": "TLSv1", + "name": "TLSv1" }, { - "value": "TLSv1.1" + "value": "TLSv1.1", + "name": "TLSv1_1" }, { - "value": "TLSv1.2" + "value": "TLSv1.2", + "name": "TLSv1_2" } ] } @@ -11678,13 +11747,16 @@ "traits": { "smithy.api#enum": [ { - "value": "allow-all" + "value": "allow-all", + "name": "allow_all" }, { - "value": "https-only" + "value": "https-only", + "name": "https_only" }, { - "value": "redirect-to-https" + "value": "redirect-to-https", + "name": "redirect_to_https" } ] } diff --git a/codegen/sdk-codegen/aws-models/cloudsearch.2013-01-01.json b/codegen/sdk-codegen/aws-models/cloudsearch.2013-01-01.json index 2f28c1bd3ab..f88c24ef912 100644 --- a/codegen/sdk-codegen/aws-models/cloudsearch.2013-01-01.json +++ b/codegen/sdk-codegen/aws-models/cloudsearch.2013-01-01.json @@ -168,16 +168,20 @@ "traits": { "smithy.api#enum": [ { - "value": "none" + "value": "none", + "name": "none" }, { - "value": "minimal" + "value": "minimal", + "name": "minimal" }, { - "value": "light" + "value": "light", + "name": "light" }, { - "value": "full" + "value": "full", + "name": "full" } ] } @@ -249,109 +253,144 @@ "smithy.api#documentation": "

An IETF RFC 4646 language code or mul for multiple languages.

", "smithy.api#enum": [ { - "value": "ar" + "value": "ar", + "name": "ar" }, { - "value": "bg" + "value": "bg", + "name": "bg" }, { - "value": "ca" + "value": "ca", + "name": "ca" }, { - "value": "cs" + "value": "cs", + "name": "cs" }, { - "value": "da" + "value": "da", + "name": "da" }, { - "value": "de" + "value": "de", + "name": "de" }, { - "value": "el" + "value": "el", + "name": "el" }, { - "value": "en" + "value": "en", + "name": "en" }, { - "value": "es" + "value": "es", + "name": "es" }, { - "value": "eu" + "value": "eu", + "name": "eu" }, { - "value": "fa" + "value": "fa", + "name": "fa" }, { - "value": "fi" + "value": "fi", + "name": "fi" }, { - "value": "fr" + "value": "fr", + "name": "fr" }, { - "value": "ga" + "value": "ga", + "name": "ga" }, { - "value": "gl" + "value": "gl", + "name": "gl" }, { - "value": "he" + "value": "he", + "name": "he" }, { - "value": "hi" + "value": "hi", + "name": "hi" }, { - "value": "hu" + "value": "hu", + "name": "hu" }, { - "value": "hy" + "value": "hy", + "name": "hy" }, { - "value": "id" + "value": "id", + "name": "id" }, { - "value": "it" + "value": "it", + "name": "it" }, { - "value": "ja" + "value": "ja", + "name": "ja" }, { - "value": "ko" + "value": "ko", + "name": "ko" }, { - "value": "lv" + "value": "lv", + "name": "lv" }, { - "value": "mul" + "value": "mul", + "name": "mul" }, { - "value": "nl" + "value": "nl", + "name": "nl" }, { - "value": "no" + "value": "no", + "name": "no" }, { - "value": "pt" + "value": "pt", + "name": "pt" }, { - "value": "ro" + "value": "ro", + "name": "ro" }, { - "value": "ru" + "value": "ru", + "name": "ru" }, { - "value": "sv" + "value": "sv", + "name": "sv" }, { - "value": "th" + "value": "th", + "name": "th" }, { - "value": "tr" + "value": "tr", + "name": "tr" }, { - "value": "zh-Hans" + "value": "zh-Hans", + "name": "zh_Hans" }, { - "value": "zh-Hant" + "value": "zh-Hant", + "name": "zh_Hant" } ] } @@ -2268,37 +2307,48 @@ "smithy.api#documentation": "

The type of field. The valid options for a field depend on the field type. For more information about the supported field types, see Configuring Index Fields in the Amazon CloudSearch Developer Guide.

", "smithy.api#enum": [ { - "value": "int" + "value": "int", + "name": "int" }, { - "value": "double" + "value": "double", + "name": "double" }, { - "value": "literal" + "value": "literal", + "name": "literal" }, { - "value": "text" + "value": "text", + "name": "text" }, { - "value": "date" + "value": "date", + "name": "date" }, { - "value": "latlon" + "value": "latlon", + "name": "latlon" }, { - "value": "int-array" + "value": "int-array", + "name": "int_array" }, { - "value": "double-array" + "value": "double-array", + "name": "double_array" }, { - "value": "literal-array" + "value": "literal-array", + "name": "literal_array" }, { - "value": "text-array" + "value": "text-array", + "name": "text_array" }, { - "value": "date-array" + "value": "date-array", + "name": "date_array" } ] } @@ -2637,16 +2687,20 @@ "smithy.api#documentation": "

The state of processing a change to an option. One of:

\n ", "smithy.api#enum": [ { - "value": "RequiresIndexDocuments" + "value": "RequiresIndexDocuments", + "name": "RequiresIndexDocuments" }, { - "value": "Processing" + "value": "Processing", + "name": "Processing" }, { - "value": "Active" + "value": "Active", + "name": "Active" }, { - "value": "FailedToValidate" + "value": "FailedToValidate", + "name": "FailedToValidate" } ] } @@ -2707,28 +2761,36 @@ "smithy.api#documentation": "

The instance type (such as search.m1.small) on which an index partition is hosted.

", "smithy.api#enum": [ { - "value": "search.m1.small" + "value": "search.m1.small", + "name": "search_m1_small" }, { - "value": "search.m1.large" + "value": "search.m1.large", + "name": "search_m1_large" }, { - "value": "search.m2.xlarge" + "value": "search.m2.xlarge", + "name": "search_m2_xlarge" }, { - "value": "search.m2.2xlarge" + "value": "search.m2.2xlarge", + "name": "search_m2_2xlarge" }, { - "value": "search.m3.medium" + "value": "search.m3.medium", + "name": "search_m3_medium" }, { - "value": "search.m3.large" + "value": "search.m3.large", + "name": "search_m3_large" }, { - "value": "search.m3.xlarge" + "value": "search.m3.xlarge", + "name": "search_m3_xlarge" }, { - "value": "search.m3.2xlarge" + "value": "search.m3.2xlarge", + "name": "search_m3_2xlarge" } ] } @@ -2869,13 +2931,16 @@ "traits": { "smithy.api#enum": [ { - "value": "none" + "value": "none", + "name": "none" }, { - "value": "low" + "value": "low", + "name": "low" }, { - "value": "high" + "value": "high", + "name": "high" } ] } diff --git a/codegen/sdk-codegen/aws-models/cloudsearchdomain.2013-01-01.json b/codegen/sdk-codegen/aws-models/cloudsearchdomain.2013-01-01.json index e6c484c74ee..b49197dc562 100644 --- a/codegen/sdk-codegen/aws-models/cloudsearchdomain.2013-01-01.json +++ b/codegen/sdk-codegen/aws-models/cloudsearchdomain.2013-01-01.json @@ -116,10 +116,12 @@ "traits": { "smithy.api#enum": [ { - "value": "application/json" + "value": "application/json", + "name": "application_json" }, { - "value": "application/xml" + "value": "application/xml", + "name": "application_xml" } ] } @@ -371,16 +373,20 @@ "traits": { "smithy.api#enum": [ { - "value": "simple" + "value": "simple", + "name": "simple" }, { - "value": "structured" + "value": "structured", + "name": "structured" }, { - "value": "lucene" + "value": "lucene", + "name": "lucene" }, { - "value": "dismax" + "value": "dismax", + "name": "dismax" } ] } diff --git a/codegen/sdk-codegen/aws-models/cloudwatch.2010-08-01.json b/codegen/sdk-codegen/aws-models/cloudwatch.2010-08-01.json index 3b4512da1d5..27d45ae9adb 100644 --- a/codegen/sdk-codegen/aws-models/cloudwatch.2010-08-01.json +++ b/codegen/sdk-codegen/aws-models/cloudwatch.2010-08-01.json @@ -156,10 +156,12 @@ "traits": { "smithy.api#enum": [ { - "value": "CompositeAlarm" + "value": "CompositeAlarm", + "name": "CompositeAlarm" }, { - "value": "MetricAlarm" + "value": "MetricAlarm", + "name": "MetricAlarm" } ] } @@ -270,13 +272,16 @@ "traits": { "smithy.api#enum": [ { - "value": "PENDING_TRAINING" + "value": "PENDING_TRAINING", + "name": "PENDING_TRAINING" }, { - "value": "TRAINED_INSUFFICIENT_DATA" + "value": "TRAINED_INSUFFICIENT_DATA", + "name": "TRAINED_INSUFFICIENT_DATA" }, { - "value": "TRAINED" + "value": "TRAINED", + "name": "TRAINED" } ] } @@ -301,25 +306,32 @@ "traits": { "smithy.api#enum": [ { - "value": "GreaterThanOrEqualToThreshold" + "value": "GreaterThanOrEqualToThreshold", + "name": "GreaterThanOrEqualToThreshold" }, { - "value": "GreaterThanThreshold" + "value": "GreaterThanThreshold", + "name": "GreaterThanThreshold" }, { - "value": "LessThanThreshold" + "value": "LessThanThreshold", + "name": "LessThanThreshold" }, { - "value": "LessThanOrEqualToThreshold" + "value": "LessThanOrEqualToThreshold", + "name": "LessThanOrEqualToThreshold" }, { - "value": "LessThanLowerOrGreaterThanUpperThreshold" + "value": "LessThanLowerOrGreaterThanUpperThreshold", + "name": "LessThanLowerOrGreaterThanUpperThreshold" }, { - "value": "LessThanLowerThreshold" + "value": "LessThanLowerThreshold", + "name": "LessThanLowerThreshold" }, { - "value": "GreaterThanUpperThreshold" + "value": "GreaterThanUpperThreshold", + "name": "GreaterThanUpperThreshold" } ] } @@ -2066,13 +2078,16 @@ "traits": { "smithy.api#enum": [ { - "value": "ConfigurationUpdate" + "value": "ConfigurationUpdate", + "name": "ConfigurationUpdate" }, { - "value": "StateUpdate" + "value": "StateUpdate", + "name": "StateUpdate" }, { - "value": "Action" + "value": "Action", + "name": "Action" } ] } @@ -3852,85 +3867,112 @@ "traits": { "smithy.api#enum": [ { - "value": "Seconds" + "value": "Seconds", + "name": "Seconds" }, { - "value": "Microseconds" + "value": "Microseconds", + "name": "Microseconds" }, { - "value": "Milliseconds" + "value": "Milliseconds", + "name": "Milliseconds" }, { - "value": "Bytes" + "value": "Bytes", + "name": "Bytes" }, { - "value": "Kilobytes" + "value": "Kilobytes", + "name": "Kilobytes" }, { - "value": "Megabytes" + "value": "Megabytes", + "name": "Megabytes" }, { - "value": "Gigabytes" + "value": "Gigabytes", + "name": "Gigabytes" }, { - "value": "Terabytes" + "value": "Terabytes", + "name": "Terabytes" }, { - "value": "Bits" + "value": "Bits", + "name": "Bits" }, { - "value": "Kilobits" + "value": "Kilobits", + "name": "Kilobits" }, { - "value": "Megabits" + "value": "Megabits", + "name": "Megabits" }, { - "value": "Gigabits" + "value": "Gigabits", + "name": "Gigabits" }, { - "value": "Terabits" + "value": "Terabits", + "name": "Terabits" }, { - "value": "Percent" + "value": "Percent", + "name": "Percent" }, { - "value": "Count" + "value": "Count", + "name": "Count" }, { - "value": "Bytes/Second" + "value": "Bytes/Second", + "name": "Bytes_Second" }, { - "value": "Kilobytes/Second" + "value": "Kilobytes/Second", + "name": "Kilobytes_Second" }, { - "value": "Megabytes/Second" + "value": "Megabytes/Second", + "name": "Megabytes_Second" }, { - "value": "Gigabytes/Second" + "value": "Gigabytes/Second", + "name": "Gigabytes_Second" }, { - "value": "Terabytes/Second" + "value": "Terabytes/Second", + "name": "Terabytes_Second" }, { - "value": "Bits/Second" + "value": "Bits/Second", + "name": "Bits_Second" }, { - "value": "Kilobits/Second" + "value": "Kilobits/Second", + "name": "Kilobits_Second" }, { - "value": "Megabits/Second" + "value": "Megabits/Second", + "name": "Megabits_Second" }, { - "value": "Gigabits/Second" + "value": "Gigabits/Second", + "name": "Gigabits_Second" }, { - "value": "Terabits/Second" + "value": "Terabits/Second", + "name": "Terabits_Second" }, { - "value": "Count/Second" + "value": "Count/Second", + "name": "Count_Second" }, { - "value": "None" + "value": "None", + "name": "None" } ] } @@ -3961,13 +4003,16 @@ "traits": { "smithy.api#enum": [ { - "value": "OK" + "value": "OK", + "name": "OK" }, { - "value": "ALARM" + "value": "ALARM", + "name": "ALARM" }, { - "value": "INSUFFICIENT_DATA" + "value": "INSUFFICIENT_DATA", + "name": "INSUFFICIENT_DATA" } ] } @@ -3977,19 +4022,24 @@ "traits": { "smithy.api#enum": [ { - "value": "SampleCount" + "value": "SampleCount", + "name": "SampleCount" }, { - "value": "Average" + "value": "Average", + "name": "Average" }, { - "value": "Sum" + "value": "Sum", + "name": "Sum" }, { - "value": "Minimum" + "value": "Minimum", + "name": "Minimum" }, { - "value": "Maximum" + "value": "Maximum", + "name": "Maximum" } ] } diff --git a/codegen/sdk-codegen/aws-models/codedeploy.2014-10-06.json b/codegen/sdk-codegen/aws-models/codedeploy.2014-10-06.json index 27d19130ddd..611baf195ba 100644 --- a/codegen/sdk-codegen/aws-models/codedeploy.2014-10-06.json +++ b/codegen/sdk-codegen/aws-models/codedeploy.2014-10-06.json @@ -6609,10 +6609,12 @@ "traits": { "smithy.api#enum": [ { - "value": "HOST_COUNT" + "value": "HOST_COUNT", + "name": "HOST_COUNT" }, { - "value": "FLEET_PERCENT" + "value": "FLEET_PERCENT", + "name": "FLEET_PERCENT" } ] } diff --git a/codegen/sdk-codegen/aws-models/cognitosync.2014-06-30.json b/codegen/sdk-codegen/aws-models/cognitosync.2014-06-30.json index a6ffeb28503..6c5e2c03225 100644 --- a/codegen/sdk-codegen/aws-models/cognitosync.2014-06-30.json +++ b/codegen/sdk-codegen/aws-models/cognitosync.2014-06-30.json @@ -1518,10 +1518,12 @@ "traits": { "smithy.api#enum": [ { - "value": "replace" + "value": "replace", + "name": "replace" }, { - "value": "remove" + "value": "remove", + "name": "remove" } ] } @@ -1531,16 +1533,20 @@ "traits": { "smithy.api#enum": [ { - "value": "APNS" + "value": "APNS", + "name": "APNS" }, { - "value": "APNS_SANDBOX" + "value": "APNS_SANDBOX", + "name": "APNS_SANDBOX" }, { - "value": "GCM" + "value": "GCM", + "name": "GCM" }, { - "value": "ADM" + "value": "ADM", + "name": "ADM" } ] } @@ -1975,10 +1981,12 @@ "traits": { "smithy.api#enum": [ { - "value": "ENABLED" + "value": "ENABLED", + "name": "ENABLED" }, { - "value": "DISABLED" + "value": "DISABLED", + "name": "DISABLED" } ] } diff --git a/codegen/sdk-codegen/aws-models/connect.2017-08-08.json b/codegen/sdk-codegen/aws-models/connect.2017-08-08.json index e7df0685614..25c77ef3b08 100644 --- a/codegen/sdk-codegen/aws-models/connect.2017-08-08.json +++ b/codegen/sdk-codegen/aws-models/connect.2017-08-08.json @@ -98,6 +98,9 @@ { "target": "com.amazonaws.connect#CreateIntegrationAssociation" }, + { + "target": "com.amazonaws.connect#CreateQuickConnect" + }, { "target": "com.amazonaws.connect#CreateRoutingProfile" }, @@ -116,6 +119,9 @@ { "target": "com.amazonaws.connect#DeleteIntegrationAssociation" }, + { + "target": "com.amazonaws.connect#DeleteQuickConnect" + }, { "target": "com.amazonaws.connect#DeleteUseCase" }, @@ -137,6 +143,9 @@ { "target": "com.amazonaws.connect#DescribeInstanceStorageConfig" }, + { + "target": "com.amazonaws.connect#DescribeQuickConnect" + }, { "target": "com.amazonaws.connect#DescribeRoutingProfile" }, @@ -215,6 +224,9 @@ { "target": "com.amazonaws.connect#ListQueues" }, + { + "target": "com.amazonaws.connect#ListQuickConnects" + }, { "target": "com.amazonaws.connect#ListRoutingProfileQueues" }, @@ -284,6 +296,12 @@ { "target": "com.amazonaws.connect#UpdateInstanceStorageConfig" }, + { + "target": "com.amazonaws.connect#UpdateQuickConnectConfig" + }, + { + "target": "com.amazonaws.connect#UpdateQuickConnectName" + }, { "target": "com.amazonaws.connect#UpdateRoutingProfileConcurrency" }, @@ -363,7 +381,7 @@ } ], "traits": { - "smithy.api#documentation": "

Associates an approved origin to an Amazon Connect instance.

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

This API is in preview release for Amazon Connect and is subject to change.

\n

Associates an approved origin to an Amazon Connect instance.

", "smithy.api#http": { "method": "PUT", "uri": "/instance/{InstanceId}/approved-origin", @@ -420,7 +438,7 @@ } ], "traits": { - "smithy.api#documentation": "

Associates a storage resource type for the first time. You can only associate one type of\n storage configuration in a single call. This means, for example, that you can't define an\n instance with multiple S3 buckets for storing chat transcripts.

\n

This API does not create a resource that doesn't exist. It only associates it to the\n instance. Ensure that the resource being specified in the storage configuration, like an Amazon\n S3 bucket, exists when being used for association.

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

This API is in preview release for Amazon Connect and is subject to change.

\n

Associates a storage resource type for the first time. You can only associate one type of\n storage configuration in a single call. This means, for example, that you can't define an\n instance with multiple S3 buckets for storing chat transcripts.

\n

This API does not create a resource that doesn't exist. It only associates it to the\n instance. Ensure that the resource being specified in the storage configuration, like an Amazon\n S3 bucket, exists when being used for association.

", "smithy.api#http": { "method": "PUT", "uri": "/instance/{InstanceId}/storage-config", @@ -495,7 +513,7 @@ } ], "traits": { - "smithy.api#documentation": "

Allows the specified Amazon Connect instance to access the specified Lambda function.

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

This API is in preview release for Amazon Connect and is subject to change.

\n

Allows the specified Amazon Connect instance to access the specified Lambda function.

", "smithy.api#http": { "method": "PUT", "uri": "/instance/{InstanceId}/lambda-function", @@ -552,7 +570,7 @@ } ], "traits": { - "smithy.api#documentation": "

Allows the specified Amazon Connect instance to access the specified Amazon Lex bot.

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

This API is in preview release for Amazon Connect and is subject to change.

\n

Allows the specified Amazon Connect instance to access the specified Amazon Lex bot.

", "smithy.api#http": { "method": "PUT", "uri": "/instance/{InstanceId}/lex-bot", @@ -671,7 +689,7 @@ } ], "traits": { - "smithy.api#documentation": "

Associates a security key to the instance.

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

This API is in preview release for Amazon Connect and is subject to change.

\n

Associates a security key to the instance.

", "smithy.api#http": { "method": "PUT", "uri": "/instance/{InstanceId}/security-key", @@ -1333,7 +1351,7 @@ } ], "traits": { - "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Create an AppIntegration association with anAmazon Connect instance.

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

This API is in preview release for Amazon Connect and is subject to change.

\n

Create an AppIntegration association with an Amazon Connect instance.

", "smithy.api#http": { "method": "PUT", "uri": "/instance/{InstanceId}/integration-associations", @@ -1406,6 +1424,102 @@ } } }, + "com.amazonaws.connect#CreateQuickConnect": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#CreateQuickConnectRequest" + }, + "output": { + "target": "com.amazonaws.connect#CreateQuickConnectResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#DuplicateResourceException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#LimitExceededException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Creates a quick connect for the specified Amazon Connect instance.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/quick-connects/{InstanceId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#CreateQuickConnectRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.connect#QuickConnectName", + "traits": { + "smithy.api#documentation": "

The name of the quick connect.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.connect#QuickConnectDescription", + "traits": { + "smithy.api#documentation": "

The description of the quick connect.

" + } + }, + "QuickConnectConfig": { + "target": "com.amazonaws.connect#QuickConnectConfig", + "traits": { + "smithy.api#documentation": "

Configuration settings for the quick connect.

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

One or more tags.

" + } + } + } + }, + "com.amazonaws.connect#CreateQuickConnectResponse": { + "type": "structure", + "members": { + "QuickConnectARN": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the quick connect.

" + } + }, + "QuickConnectId": { + "target": "com.amazonaws.connect#QuickConnectId", + "traits": { + "smithy.api#documentation": "

The identifier for the quick connect.

" + } + } + } + }, "com.amazonaws.connect#CreateRoutingProfile": { "type": "operation", "input": { @@ -2073,6 +2187,58 @@ } } }, + "com.amazonaws.connect#DeleteQuickConnect": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#DeleteQuickConnectRequest" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Deletes a quick connect.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/quick-connects/{InstanceId}/{QuickConnectId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#DeleteQuickConnectRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "QuickConnectId": { + "target": "com.amazonaws.connect#QuickConnectId", + "traits": { + "smithy.api#documentation": "

The identifier for the quick connect.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, "com.amazonaws.connect#DeleteUseCase": { "type": "operation", "input": { @@ -2326,7 +2492,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns the current state of the specified instance identifier. It tracks the instance while\n it is being created and returns an error status if applicable.

\n

If an instance is not created successfully, the instance status reason field returns details\n relevant to the reason. The instance in a failed state is returned only for 24 hours after the\n CreateInstance API was invoked.

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

This API is in preview release for Amazon Connect and is subject to change.

\n

Returns the current state of the specified instance identifier. It tracks the instance while\n it is being created and returns an error status if applicable.

\n

If an instance is not created successfully, the instance status reason field returns details\n relevant to the reason. The instance in a failed state is returned only for 24 hours after the\n CreateInstance API was invoked.

", "smithy.api#http": { "method": "GET", "uri": "/instance/{InstanceId}", @@ -2360,7 +2526,7 @@ } ], "traits": { - "smithy.api#documentation": "

Describes the specified instance attribute.

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

This API is in preview release for Amazon Connect and is subject to change.

\n

Describes the specified instance attribute.

", "smithy.api#http": { "method": "GET", "uri": "/instance/{InstanceId}/attribute/{AttributeType}", @@ -2450,7 +2616,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves the current storage configurations for the specified resource type, association\n ID, and instance ID.

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

This API is in preview release for Amazon Connect and is subject to change.

\n

Retrieves the current storage configurations for the specified resource type, association\n ID, and instance ID.

", "smithy.api#http": { "method": "GET", "uri": "/instance/{InstanceId}/storage-config/{AssociationId}", @@ -2498,6 +2664,72 @@ } } }, + "com.amazonaws.connect#DescribeQuickConnect": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#DescribeQuickConnectRequest" + }, + "output": { + "target": "com.amazonaws.connect#DescribeQuickConnectResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Describes the quick connect.

", + "smithy.api#http": { + "method": "GET", + "uri": "/quick-connects/{InstanceId}/{QuickConnectId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#DescribeQuickConnectRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "QuickConnectId": { + "target": "com.amazonaws.connect#QuickConnectId", + "traits": { + "smithy.api#documentation": "

The identifier for the quick connect.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#DescribeQuickConnectResponse": { + "type": "structure", + "members": { + "QuickConnect": { + "target": "com.amazonaws.connect#QuickConnect", + "traits": { + "smithy.api#documentation": "

Information about the quick connect.

" + } + } + } + }, "com.amazonaws.connect#DescribeRoutingProfile": { "type": "operation", "input": { @@ -2865,7 +3097,7 @@ } ], "traits": { - "smithy.api#documentation": "

Revokes access to integrated applications from Amazon Connect.

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

This API is in preview release for Amazon Connect and is subject to change.

\n

Revokes access to integrated applications from Amazon Connect.

", "smithy.api#http": { "method": "DELETE", "uri": "/instance/{InstanceId}/approved-origin", @@ -2917,7 +3149,7 @@ } ], "traits": { - "smithy.api#documentation": "

Removes the storage type configurations for the specified resource type and association\n ID.

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

This API is in preview release for Amazon Connect and is subject to change.

\n

Removes the storage type configurations for the specified resource type and association\n ID.

", "smithy.api#http": { "method": "DELETE", "uri": "/instance/{InstanceId}/storage-config/{AssociationId}", @@ -2977,7 +3209,7 @@ } ], "traits": { - "smithy.api#documentation": "

Remove the Lambda function from the drop-down options available in the relevant contact flow\n blocks.

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

This API is in preview release for Amazon Connect and is subject to change.

\n

Remove the Lambda function from the drop-down options available in the relevant contact flow\n blocks.

", "smithy.api#http": { "method": "DELETE", "uri": "/instance/{InstanceId}/lambda-function", @@ -3029,7 +3261,7 @@ } ], "traits": { - "smithy.api#documentation": "

Revokes authorization from the specified instance to access the specified Amazon Lex bot.

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

This API is in preview release for Amazon Connect and is subject to change.

\n

Revokes authorization from the specified instance to access the specified Amazon Lex bot.

", "smithy.api#http": { "method": "DELETE", "uri": "/instance/{InstanceId}/lex-bot", @@ -3148,7 +3380,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes the specified security key.

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

This API is in preview release for Amazon Connect and is subject to change.

\n

Deletes the specified security key.

", "smithy.api#http": { "method": "DELETE", "uri": "/instance/{InstanceId}/security-key/{AssociationId}", @@ -4726,7 +4958,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a paginated list of all approved origins associated with the instance.

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

This API is in preview release for Amazon Connect and is subject to change.

\n

Returns a paginated list of all approved origins associated with the instance.

", "smithy.api#http": { "method": "GET", "uri": "/instance/{InstanceId}/approved-origins", @@ -5314,7 +5546,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a paginated list of all the Lambda functions that show up in the drop-down options\n in the relevant contact flow blocks.

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

This API is in preview release for Amazon Connect and is subject to change.

\n

Returns a paginated list of all the Lambda functions that show up in the drop-down options\n in the relevant contact flow blocks.

", "smithy.api#http": { "method": "GET", "uri": "/instance/{InstanceId}/lambda-functions", @@ -5399,7 +5631,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a paginated list of all the Amazon Lex bots currently associated with the\n instance.

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

This API is in preview release for Amazon Connect and is subject to change.

\n

Returns a paginated list of all the Amazon Lex bots currently associated with the\n instance.

", "smithy.api#http": { "method": "GET", "uri": "/instance/{InstanceId}/lex-bots", @@ -5732,13 +5964,13 @@ } } }, - "com.amazonaws.connect#ListRoutingProfileQueues": { + "com.amazonaws.connect#ListQuickConnects": { "type": "operation", "input": { - "target": "com.amazonaws.connect#ListRoutingProfileQueuesRequest" + "target": "com.amazonaws.connect#ListQuickConnectsRequest" }, "output": { - "target": "com.amazonaws.connect#ListRoutingProfileQueuesResponse" + "target": "com.amazonaws.connect#ListQuickConnectsResponse" }, "errors": [ { @@ -5758,21 +5990,21 @@ } ], "traits": { - "smithy.api#documentation": "

List the queues associated with a routing profile.

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

This API is in preview release for Amazon Connect and is subject to change.

\n

Provides information about the quick connects for the specified Amazon Connect instance.

", "smithy.api#http": { "method": "GET", - "uri": "/routing-profiles/{InstanceId}/{RoutingProfileId}/queues", + "uri": "/quick-connects/{InstanceId}", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", - "items": "RoutingProfileQueueConfigSummaryList", + "items": "QuickConnectSummaryList", "pageSize": "MaxResults" } } }, - "com.amazonaws.connect#ListRoutingProfileQueuesRequest": { + "com.amazonaws.connect#ListQuickConnectsRequest": { "type": "structure", "members": { "InstanceId": { @@ -5783,14 +6015,6 @@ "smithy.api#required": {} } }, - "RoutingProfileId": { - "target": "com.amazonaws.connect#RoutingProfileId", - "traits": { - "smithy.api#documentation": "

The identifier of the routing profile.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, "NextToken": { "target": "com.amazonaws.connect#NextToken", "traits": { @@ -5799,39 +6023,46 @@ } }, "MaxResults": { - "target": "com.amazonaws.connect#MaxResult100", + "target": "com.amazonaws.connect#MaxResult1000", "traits": { "smithy.api#box": {}, "smithy.api#documentation": "

The maximimum number of results to return per page.

", "smithy.api#httpQuery": "maxResults" } + }, + "QuickConnectTypes": { + "target": "com.amazonaws.connect#QuickConnectTypes", + "traits": { + "smithy.api#documentation": "

The type of quick connect. In the Amazon Connect console, when you create a quick connect, you are\n prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).

", + "smithy.api#httpQuery": "QuickConnectTypes" + } } } }, - "com.amazonaws.connect#ListRoutingProfileQueuesResponse": { + "com.amazonaws.connect#ListQuickConnectsResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.connect#NextToken", + "QuickConnectSummaryList": { + "target": "com.amazonaws.connect#QuickConnectSummaryList", "traits": { - "smithy.api#documentation": "

If there are additional results, this is the token for the next set of results.

" + "smithy.api#documentation": "

Information about the quick connects.

" } }, - "RoutingProfileQueueConfigSummaryList": { - "target": "com.amazonaws.connect#RoutingProfileQueueConfigSummaryList", + "NextToken": { + "target": "com.amazonaws.connect#NextToken", "traits": { - "smithy.api#documentation": "

Information about the routing profiles.

" + "smithy.api#documentation": "

If there are additional results, this is the token for the next set of results.

" } } } }, - "com.amazonaws.connect#ListRoutingProfiles": { + "com.amazonaws.connect#ListRoutingProfileQueues": { "type": "operation", "input": { - "target": "com.amazonaws.connect#ListRoutingProfilesRequest" + "target": "com.amazonaws.connect#ListRoutingProfileQueuesRequest" }, "output": { - "target": "com.amazonaws.connect#ListRoutingProfilesResponse" + "target": "com.amazonaws.connect#ListRoutingProfileQueuesResponse" }, "errors": [ { @@ -5851,21 +6082,21 @@ } ], "traits": { - "smithy.api#documentation": "

Provides summary information about the routing profiles for the specified Amazon Connect\n instance.

\n

For more information about routing profiles, see Routing Profiles and Create a Routing\n Profile in the Amazon Connect Administrator Guide.

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

List the queues associated with a routing profile.

", "smithy.api#http": { "method": "GET", - "uri": "/routing-profiles-summary/{InstanceId}", + "uri": "/routing-profiles/{InstanceId}/{RoutingProfileId}/queues", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", - "items": "RoutingProfileSummaryList", + "items": "RoutingProfileQueueConfigSummaryList", "pageSize": "MaxResults" } } }, - "com.amazonaws.connect#ListRoutingProfilesRequest": { + "com.amazonaws.connect#ListRoutingProfileQueuesRequest": { "type": "structure", "members": { "InstanceId": { @@ -5876,6 +6107,14 @@ "smithy.api#required": {} } }, + "RoutingProfileId": { + "target": "com.amazonaws.connect#RoutingProfileId", + "traits": { + "smithy.api#documentation": "

The identifier of the routing profile.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "NextToken": { "target": "com.amazonaws.connect#NextToken", "traits": { @@ -5884,7 +6123,7 @@ } }, "MaxResults": { - "target": "com.amazonaws.connect#MaxResult1000", + "target": "com.amazonaws.connect#MaxResult100", "traits": { "smithy.api#box": {}, "smithy.api#documentation": "

The maximimum number of results to return per page.

", @@ -5893,24 +6132,109 @@ } } }, - "com.amazonaws.connect#ListRoutingProfilesResponse": { + "com.amazonaws.connect#ListRoutingProfileQueuesResponse": { "type": "structure", "members": { - "RoutingProfileSummaryList": { - "target": "com.amazonaws.connect#RoutingProfileSummaryList", - "traits": { - "smithy.api#documentation": "

Information about the routing profiles.

" - } - }, "NextToken": { "target": "com.amazonaws.connect#NextToken", "traits": { "smithy.api#documentation": "

If there are additional results, this is the token for the next set of results.

" } + }, + "RoutingProfileQueueConfigSummaryList": { + "target": "com.amazonaws.connect#RoutingProfileQueueConfigSummaryList", + "traits": { + "smithy.api#documentation": "

Information about the routing profiles.

" + } } } }, - "com.amazonaws.connect#ListSecurityKeys": { + "com.amazonaws.connect#ListRoutingProfiles": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#ListRoutingProfilesRequest" + }, + "output": { + "target": "com.amazonaws.connect#ListRoutingProfilesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Provides summary information about the routing profiles for the specified Amazon Connect\n instance.

\n

For more information about routing profiles, see Routing Profiles and Create a Routing\n Profile in the Amazon Connect Administrator Guide.

", + "smithy.api#http": { + "method": "GET", + "uri": "/routing-profiles-summary/{InstanceId}", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "RoutingProfileSummaryList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.connect#ListRoutingProfilesRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.connect#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.connect#MaxResult1000", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

The maximimum number of results to return per page.

", + "smithy.api#httpQuery": "maxResults" + } + } + } + }, + "com.amazonaws.connect#ListRoutingProfilesResponse": { + "type": "structure", + "members": { + "RoutingProfileSummaryList": { + "target": "com.amazonaws.connect#RoutingProfileSummaryList", + "traits": { + "smithy.api#documentation": "

Information about the routing profiles.

" + } + }, + "NextToken": { + "target": "com.amazonaws.connect#NextToken", + "traits": { + "smithy.api#documentation": "

If there are additional results, this is the token for the next set of results.

" + } + } + } + }, + "com.amazonaws.connect#ListSecurityKeys": { "type": "operation", "input": { "target": "com.amazonaws.connect#ListSecurityKeysRequest" @@ -5936,7 +6260,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a paginated list of all security keys associated with the instance.

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

This API is in preview release for Amazon Connect and is subject to change.

\n

Returns a paginated list of all security keys associated with the instance.

", "smithy.api#http": { "method": "GET", "uri": "/instance/{InstanceId}/security-keys", @@ -7556,6 +7880,21 @@ "com.amazonaws.connect#PhoneNumberId": { "type": "string" }, + "com.amazonaws.connect#PhoneNumberQuickConnectConfig": { + "type": "structure", + "members": { + "PhoneNumber": { + "target": "com.amazonaws.connect#PhoneNumber", + "traits": { + "smithy.api#documentation": "

The phone number in E.164 format.

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

Contains information about a phone number for a quick connect.

" + } + }, "com.amazonaws.connect#PhoneNumberSummary": { "type": "structure", "members": { @@ -7757,6 +8096,28 @@ } } }, + "com.amazonaws.connect#QueueQuickConnectConfig": { + "type": "structure", + "members": { + "QueueId": { + "target": "com.amazonaws.connect#QueueId", + "traits": { + "smithy.api#documentation": "

The identifier of the queue.

", + "smithy.api#required": {} + } + }, + "ContactFlowId": { + "target": "com.amazonaws.connect#ContactFlowId", + "traits": { + "smithy.api#documentation": "

The identifier of the contact flow.

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

Contains information about a queue for a quick connect. The contact flow must be of type Transfer to Queue.

" + } + }, "com.amazonaws.connect#QueueReference": { "type": "structure", "members": { @@ -7854,6 +8215,173 @@ } } }, + "com.amazonaws.connect#QuickConnect": { + "type": "structure", + "members": { + "QuickConnectARN": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the quick connect.

" + } + }, + "QuickConnectId": { + "target": "com.amazonaws.connect#QuickConnectId", + "traits": { + "smithy.api#documentation": "

The identifier for the quick connect.

" + } + }, + "Name": { + "target": "com.amazonaws.connect#QuickConnectName", + "traits": { + "smithy.api#documentation": "

The name of the quick connect.

" + } + }, + "Description": { + "target": "com.amazonaws.connect#QuickConnectDescription", + "traits": { + "smithy.api#documentation": "

The description.

" + } + }, + "QuickConnectConfig": { + "target": "com.amazonaws.connect#QuickConnectConfig", + "traits": { + "smithy.api#documentation": "

Contains information about the quick connect.

" + } + }, + "Tags": { + "target": "com.amazonaws.connect#TagMap", + "traits": { + "smithy.api#documentation": "

One or more tags.

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

Contains information about a quick connect.

" + } + }, + "com.amazonaws.connect#QuickConnectConfig": { + "type": "structure", + "members": { + "QuickConnectType": { + "target": "com.amazonaws.connect#QuickConnectType", + "traits": { + "smithy.api#documentation": "

The type of quick connect. In the Amazon Connect console, when you create a quick connect, you are\n prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).\n

", + "smithy.api#required": {} + } + }, + "UserConfig": { + "target": "com.amazonaws.connect#UserQuickConnectConfig", + "traits": { + "smithy.api#documentation": "

The user configuration. This is required only if QuickConnectType is USER.

" + } + }, + "QueueConfig": { + "target": "com.amazonaws.connect#QueueQuickConnectConfig", + "traits": { + "smithy.api#documentation": "

The queue configuration. This is required only if QuickConnectType is QUEUE.

" + } + }, + "PhoneConfig": { + "target": "com.amazonaws.connect#PhoneNumberQuickConnectConfig", + "traits": { + "smithy.api#documentation": "

The phone configuration. This is required only if QuickConnectType is PHONE_NUMBER.

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

Contains configuration settings for a quick connect.

" + } + }, + "com.amazonaws.connect#QuickConnectDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 250 + } + } + }, + "com.amazonaws.connect#QuickConnectId": { + "type": "string" + }, + "com.amazonaws.connect#QuickConnectName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 127 + } + } + }, + "com.amazonaws.connect#QuickConnectSummary": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.connect#QuickConnectId", + "traits": { + "smithy.api#documentation": "

The identifier for the quick connect.

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

The Amazon Resource Name (ARN).

" + } + }, + "Name": { + "target": "com.amazonaws.connect#QuickConnectName", + "traits": { + "smithy.api#documentation": "

The name.

" + } + }, + "QuickConnectType": { + "target": "com.amazonaws.connect#QuickConnectType", + "traits": { + "smithy.api#documentation": "

The type of quick connect. In the Amazon Connect console, when you create a quick connect, you are\n prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).

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

Contains summary information about a quick connect.

" + } + }, + "com.amazonaws.connect#QuickConnectSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#QuickConnectSummary" + } + }, + "com.amazonaws.connect#QuickConnectType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "USER", + "name": "USER" + }, + { + "value": "QUEUE", + "name": "QUEUE" + }, + { + "value": "PHONE_NUMBER", + "name": "PHONE_NUMBER" + } + ] + } + }, + "com.amazonaws.connect#QuickConnectTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#QuickConnectType" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 3 + } + } + }, "com.amazonaws.connect#Reference": { "type": "structure", "members": { @@ -9097,7 +9625,7 @@ } ], "traits": { - "smithy.api#documentation": "

Adds the specified tags to the specified resource.

\n

The supported resource types are users, routing profiles, and contact flows.

\n

For sample policies that use tags, see Amazon Connect Identity-Based\n Policy Examples in the Amazon Connect Administrator Guide.

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

Adds the specified tags to the specified resource.

\n

The supported resource types are users, routing profiles, quick connects, and contact flows.

\n

For sample policies that use tags, see Amazon Connect Identity-Based\n Policy Examples in the Amazon Connect Administrator Guide.

", "smithy.api#http": { "method": "POST", "uri": "/tags/{resourceArn}", @@ -9572,6 +10100,129 @@ } } }, + "com.amazonaws.connect#UpdateQuickConnectConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#UpdateQuickConnectConfigRequest" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Updates the configuration settings for the specified quick connect.

", + "smithy.api#http": { + "method": "POST", + "uri": "/quick-connects/{InstanceId}/{QuickConnectId}/config", + "code": 200 + } + } + }, + "com.amazonaws.connect#UpdateQuickConnectConfigRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "QuickConnectId": { + "target": "com.amazonaws.connect#QuickConnectId", + "traits": { + "smithy.api#documentation": "

The identifier for the quick connect.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "QuickConnectConfig": { + "target": "com.amazonaws.connect#QuickConnectConfig", + "traits": { + "smithy.api#documentation": "

Information about the configuration settings for the quick connect.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#UpdateQuickConnectName": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#UpdateQuickConnectNameRequest" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Updates the name and description of a quick connect. The request accepts the following data\n in JSON format. At least Name or Description must be provided.

", + "smithy.api#http": { + "method": "POST", + "uri": "/quick-connects/{InstanceId}/{QuickConnectId}/name", + "code": 200 + } + } + }, + "com.amazonaws.connect#UpdateQuickConnectNameRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "QuickConnectId": { + "target": "com.amazonaws.connect#QuickConnectId", + "traits": { + "smithy.api#documentation": "

The identifier for the quick connect.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.connect#QuickConnectName", + "traits": { + "smithy.api#documentation": "

The name of the quick connect.

" + } + }, + "Description": { + "target": "com.amazonaws.connect#QuickConnectDescription", + "traits": { + "smithy.api#documentation": "

The description of the quick connect.

" + } + } + } + }, "com.amazonaws.connect#UpdateRoutingProfileConcurrency": { "type": "operation", "input": { @@ -10421,6 +11072,28 @@ "smithy.api#documentation": "

Contains information about the phone configuration settings for a user.

" } }, + "com.amazonaws.connect#UserQuickConnectConfig": { + "type": "structure", + "members": { + "UserId": { + "target": "com.amazonaws.connect#UserId", + "traits": { + "smithy.api#documentation": "

The identifier of the user.

", + "smithy.api#required": {} + } + }, + "ContactFlowId": { + "target": "com.amazonaws.connect#ContactFlowId", + "traits": { + "smithy.api#documentation": "

The identifier of the contact flow.

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

Contains information about the quick connect configuration settings for a user. The contact flow must be of type Transfer to Agent.

" + } + }, "com.amazonaws.connect#UserSummary": { "type": "structure", "members": { diff --git a/codegen/sdk-codegen/aws-models/connectparticipant.2018-09-07.json b/codegen/sdk-codegen/aws-models/connectparticipant.2018-09-07.json index 199513b7bce..8ed4265c698 100644 --- a/codegen/sdk-codegen/aws-models/connectparticipant.2018-09-07.json +++ b/codegen/sdk-codegen/aws-models/connectparticipant.2018-09-07.json @@ -49,12 +49,18 @@ "type": "service", "version": "2018-09-07", "operations": [ + { + "target": "com.amazonaws.connectparticipant#CompleteAttachmentUpload" + }, { "target": "com.amazonaws.connectparticipant#CreateParticipantConnection" }, { "target": "com.amazonaws.connectparticipant#DisconnectParticipant" }, + { + "target": "com.amazonaws.connectparticipant#GetAttachment" + }, { "target": "com.amazonaws.connectparticipant#GetTranscript" }, @@ -63,6 +69,9 @@ }, { "target": "com.amazonaws.connectparticipant#SendMessage" + }, + { + "target": "com.amazonaws.connectparticipant#StartAttachmentUpload" } ], "traits": { @@ -81,6 +90,101 @@ "smithy.api#title": "Amazon Connect Participant Service" } }, + "com.amazonaws.connectparticipant#ArtifactId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.connectparticipant#ArtifactStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "APPROVED", + "name": "APPROVED" + }, + { + "value": "REJECTED", + "name": "REJECTED" + }, + { + "value": "IN_PROGRESS", + "name": "IN_PROGRESS" + } + ] + } + }, + "com.amazonaws.connectparticipant#AttachmentIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.connectparticipant#ArtifactId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.connectparticipant#AttachmentItem": { + "type": "structure", + "members": { + "ContentType": { + "target": "com.amazonaws.connectparticipant#ContentType", + "traits": { + "smithy.api#documentation": "

Describes the MIME file type of the attachment. For a list of supported file types, see Feature specifications in the Amazon Connect Administrator Guide.

" + } + }, + "AttachmentId": { + "target": "com.amazonaws.connectparticipant#ArtifactId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the attachment.

" + } + }, + "AttachmentName": { + "target": "com.amazonaws.connectparticipant#AttachmentName", + "traits": { + "smithy.api#documentation": "

A case-sensitive name of the attachment being uploaded.

" + } + }, + "Status": { + "target": "com.amazonaws.connectparticipant#ArtifactStatus", + "traits": { + "smithy.api#documentation": "

Status of the attachment.

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

The case-insensitive input to indicate standard MIME type that describes the format of the file\n that will be uploaded.

" + } + }, + "com.amazonaws.connectparticipant#AttachmentName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.connectparticipant#AttachmentSizeInBytes": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.connectparticipant#Attachments": { + "type": "list", + "member": { + "target": "com.amazonaws.connectparticipant#AttachmentItem" + } + }, "com.amazonaws.connectparticipant#ChatContent": { "type": "string", "traits": { @@ -112,6 +216,30 @@ "type": "string", "traits": { "smithy.api#enum": [ + { + "value": "TYPING", + "name": "TYPING" + }, + { + "value": "PARTICIPANT_JOINED", + "name": "PARTICIPANT_JOINED" + }, + { + "value": "PARTICIPANT_LEFT", + "name": "PARTICIPANT_LEFT" + }, + { + "value": "CHAT_ENDED", + "name": "CHAT_ENDED" + }, + { + "value": "TRANSFER_SUCCEEDED", + "name": "TRANSFER_SUCCEEDED" + }, + { + "value": "TRANSFER_FAILED", + "name": "TRANSFER_FAILED" + }, { "value": "MESSAGE", "name": "MESSAGE" @@ -120,6 +248,10 @@ "value": "EVENT", "name": "EVENT" }, + { + "value": "ATTACHMENT", + "name": "ATTACHMENT" + }, { "value": "CONNECTION_ACK", "name": "CONNECTION_ACK" @@ -136,6 +268,91 @@ } } }, + "com.amazonaws.connectparticipant#CompleteAttachmentUpload": { + "type": "operation", + "input": { + "target": "com.amazonaws.connectparticipant#CompleteAttachmentUploadRequest" + }, + "output": { + "target": "com.amazonaws.connectparticipant#CompleteAttachmentUploadResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connectparticipant#AccessDeniedException" + }, + { + "target": "com.amazonaws.connectparticipant#ConflictException" + }, + { + "target": "com.amazonaws.connectparticipant#InternalServerException" + }, + { + "target": "com.amazonaws.connectparticipant#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.connectparticipant#ThrottlingException" + }, + { + "target": "com.amazonaws.connectparticipant#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Allows you to confirm that the attachment has been uploaded using the pre-signed URL\n provided in StartAttachmentUpload API.

", + "smithy.api#http": { + "method": "POST", + "uri": "/participant/complete-attachment-upload", + "code": 200 + } + } + }, + "com.amazonaws.connectparticipant#CompleteAttachmentUploadRequest": { + "type": "structure", + "members": { + "AttachmentIds": { + "target": "com.amazonaws.connectparticipant#AttachmentIdList", + "traits": { + "smithy.api#documentation": "

A list of unique identifiers for the attachments.

", + "smithy.api#required": {} + } + }, + "ClientToken": { + "target": "com.amazonaws.connectparticipant#NonEmptyClientToken", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request.

", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + }, + "ConnectionToken": { + "target": "com.amazonaws.connectparticipant#ParticipantToken", + "traits": { + "smithy.api#documentation": "

The authentication token associated with the participant's connection.

", + "smithy.api#httpHeader": "X-Amz-Bearer", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connectparticipant#CompleteAttachmentUploadResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.connectparticipant#ConflictException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.connectparticipant#Reason", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

An attachment with that identifier is already being uploaded.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, "com.amazonaws.connectparticipant#ConnectionCredentials": { "type": "structure", "members": { @@ -191,6 +408,15 @@ } } }, + "com.amazonaws.connectparticipant#ContentType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, "com.amazonaws.connectparticipant#CreateParticipantConnection": { "type": "operation", "input": { @@ -214,7 +440,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates the participant's connection. Note that ParticipantToken is used for invoking\n this API instead of ConnectionToken.

\n

The participant token is valid for the lifetime of the participant – until the they\n are part of a contact.

\n

The response URL for WEBSOCKET Type has a connect expiry timeout of 100s. Clients must\n manually connect to the returned websocket URL and subscribe to the desired topic.

\n

For\n chat, you need to publish the following on the established websocket connection:

\n \n \n

\n {\"topic\":\"aws/subscribe\",\"content\":{\"topics\":[\"aws/chat\"]}}\n

\n \n

Upon websocket URL expiry, as\n specified in the response ConnectionExpiry parameter, clients need to call this API\n again to obtain a new websocket URL and perform the same steps as before.

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

Creates the participant's connection. Note that ParticipantToken is used for invoking\n this API instead of ConnectionToken.

\n

The participant token is valid for the lifetime of the participant – until they are\n part of a contact.

\n

The response URL for WEBSOCKET Type has a connect expiry timeout of 100s.\n Clients must manually connect to the returned websocket URL and subscribe to the desired\n topic.

\n

For chat, you need to publish the following on the established websocket\n connection:

\n\n\n

\n {\"topic\":\"aws/subscribe\",\"content\":{\"topics\":[\"aws/chat\"]}}\n

\n\n

Upon websocket URL expiry, as specified in the response ConnectionExpiry parameter,\n clients need to call this API again to obtain a new websocket URL and perform the same\n steps as before.

\n\n \n

The Amazon Connect Participant Service APIs do not use Signature Version 4\n authentication.

\n ", "smithy.api#http": { "method": "POST", "uri": "/participant/connection", @@ -235,7 +461,7 @@ "ParticipantToken": { "target": "com.amazonaws.connectparticipant#ParticipantToken", "traits": { - "smithy.api#documentation": "

Participant Token as obtained from StartChatContact API response.

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

This is a header parameter.

\n

The Participant Token as obtained from StartChatContact\n API response.

", "smithy.api#httpHeader": "X-Amz-Bearer", "smithy.api#required": {} } @@ -282,7 +508,7 @@ } ], "traits": { - "smithy.api#documentation": "

Disconnects a participant. Note that ConnectionToken is used for invoking this API\n instead of ParticipantToken.

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

Disconnects a participant. Note that ConnectionToken is used for invoking this API\n instead of ParticipantToken.

\n

The Amazon Connect Participant Service APIs do not use Signature Version 4\n authentication.

", "smithy.api#http": { "method": "POST", "uri": "/participant/disconnect", @@ -323,6 +549,74 @@ } } }, + "com.amazonaws.connectparticipant#GetAttachment": { + "type": "operation", + "input": { + "target": "com.amazonaws.connectparticipant#GetAttachmentRequest" + }, + "output": { + "target": "com.amazonaws.connectparticipant#GetAttachmentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connectparticipant#AccessDeniedException" + }, + { + "target": "com.amazonaws.connectparticipant#InternalServerException" + }, + { + "target": "com.amazonaws.connectparticipant#ThrottlingException" + }, + { + "target": "com.amazonaws.connectparticipant#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Provides a pre-signed URL for download of a completed attachment. This is an\n asynchronous API for use with active contacts.

", + "smithy.api#http": { + "method": "POST", + "uri": "/participant/attachment", + "code": 200 + } + } + }, + "com.amazonaws.connectparticipant#GetAttachmentRequest": { + "type": "structure", + "members": { + "AttachmentId": { + "target": "com.amazonaws.connectparticipant#ArtifactId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the attachment.

", + "smithy.api#required": {} + } + }, + "ConnectionToken": { + "target": "com.amazonaws.connectparticipant#ParticipantToken", + "traits": { + "smithy.api#documentation": "

The authentication token associated with the participant's connection.

", + "smithy.api#httpHeader": "X-Amz-Bearer", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connectparticipant#GetAttachmentResponse": { + "type": "structure", + "members": { + "Url": { + "target": "com.amazonaws.connectparticipant#PreSignedAttachmentUrl", + "traits": { + "smithy.api#documentation": "

The pre-signed URL using which file would be downloaded from Amazon S3 by the API caller.

" + } + }, + "UrlExpiry": { + "target": "com.amazonaws.connectparticipant#ISO8601Datetime", + "traits": { + "smithy.api#documentation": "

The expiration time of the URL in ISO timestamp. It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.

" + } + } + } + }, "com.amazonaws.connectparticipant#GetTranscript": { "type": "operation", "input": { @@ -346,7 +640,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves a transcript of the session. Note that ConnectionToken is used for invoking\n this API instead of ParticipantToken.

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

Retrieves a transcript of the session, including details about any attachments. Note\n that ConnectionToken is used for invoking this API instead of ParticipantToken.

\n

The Amazon Connect Participant Service APIs do not use Signature Version 4\n authentication.

", "smithy.api#http": { "method": "POST", "uri": "/participant/transcript", @@ -372,7 +666,7 @@ "target": "com.amazonaws.connectparticipant#MaxResults", "traits": { "smithy.api#box": {}, - "smithy.api#documentation": "

The maximum number of results to return in the page. Default: 10. \n

" + "smithy.api#documentation": "

The maximum number of results to return in the page. Default: 10.

" } }, "NextToken": { @@ -384,7 +678,7 @@ "ScanDirection": { "target": "com.amazonaws.connectparticipant#ScanDirection", "traits": { - "smithy.api#documentation": "

The direction from StartPosition from which to retrieve message. Default: BACKWARD when no StartPosition is provided, FORWARD with StartPosition.

" + "smithy.api#documentation": "

The direction from StartPosition from which to retrieve message. Default: BACKWARD\n when no StartPosition is provided, FORWARD with StartPosition.

" } }, "SortOrder": { @@ -510,6 +804,12 @@ "traits": { "smithy.api#documentation": "

The role of the sender. For example, is it a customer, agent, or system.

" } + }, + "Attachments": { + "target": "com.amazonaws.connectparticipant#Attachments", + "traits": { + "smithy.api#documentation": "

Provides information about the attachments.

" + } } }, "traits": { @@ -546,6 +846,15 @@ } } }, + "com.amazonaws.connectparticipant#NonEmptyClientToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 500 + } + } + }, "com.amazonaws.connectparticipant#ParticipantId": { "type": "string", "traits": { @@ -583,6 +892,15 @@ } } }, + "com.amazonaws.connectparticipant#PreSignedAttachmentUrl": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2000 + } + } + }, "com.amazonaws.connectparticipant#PreSignedConnectionUrl": { "type": "string", "traits": { @@ -639,7 +957,7 @@ } ], "traits": { - "smithy.api#documentation": "

Sends an event. Note that ConnectionToken is used for invoking this API instead of\n ParticipantToken.

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

Sends an event. Note that ConnectionToken is used for invoking this API instead of\n ParticipantToken.

\n

The Amazon Connect Participant Service APIs do not use Signature Version 4\n authentication.

", "smithy.api#http": { "method": "POST", "uri": "/participant/event", @@ -720,7 +1038,7 @@ } ], "traits": { - "smithy.api#documentation": "

Sends a message. Note that ConnectionToken is used for invoking this API instead of\n ParticipantToken.

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

Sends a message. Note that ConnectionToken is used for invoking this API instead of\n ParticipantToken.

\n \n

The Amazon Connect Participant Service APIs do not use Signature Version 4\n authentication.

\n ", "smithy.api#http": { "method": "POST", "uri": "/participant/message", @@ -779,6 +1097,22 @@ } } }, + "com.amazonaws.connectparticipant#ServiceQuotaExceededException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.connectparticipant#Message", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The number of attachments per contact exceeds the quota.

", + "smithy.api#error": "client", + "smithy.api#httpError": 402 + } + }, "com.amazonaws.connectparticipant#SortKey": { "type": "string", "traits": { @@ -794,6 +1128,99 @@ ] } }, + "com.amazonaws.connectparticipant#StartAttachmentUpload": { + "type": "operation", + "input": { + "target": "com.amazonaws.connectparticipant#StartAttachmentUploadRequest" + }, + "output": { + "target": "com.amazonaws.connectparticipant#StartAttachmentUploadResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connectparticipant#AccessDeniedException" + }, + { + "target": "com.amazonaws.connectparticipant#InternalServerException" + }, + { + "target": "com.amazonaws.connectparticipant#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.connectparticipant#ThrottlingException" + }, + { + "target": "com.amazonaws.connectparticipant#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Provides a pre-signed Amazon S3 URL in response for uploading the file directly to\n S3.

", + "smithy.api#http": { + "method": "POST", + "uri": "/participant/start-attachment-upload", + "code": 200 + } + } + }, + "com.amazonaws.connectparticipant#StartAttachmentUploadRequest": { + "type": "structure", + "members": { + "ContentType": { + "target": "com.amazonaws.connectparticipant#ContentType", + "traits": { + "smithy.api#documentation": "

Describes the MIME file type of the attachment. For a list of supported file types, see Feature specifications in the Amazon Connect Administrator Guide.

", + "smithy.api#required": {} + } + }, + "AttachmentSizeInBytes": { + "target": "com.amazonaws.connectparticipant#AttachmentSizeInBytes", + "traits": { + "smithy.api#documentation": "

The size of the attachment in bytes.

", + "smithy.api#required": {} + } + }, + "AttachmentName": { + "target": "com.amazonaws.connectparticipant#AttachmentName", + "traits": { + "smithy.api#documentation": "

A case-sensitive name of the attachment being uploaded.

", + "smithy.api#required": {} + } + }, + "ClientToken": { + "target": "com.amazonaws.connectparticipant#NonEmptyClientToken", + "traits": { + "smithy.api#documentation": "

A unique case sensitive identifier to support idempotency of request.

", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + }, + "ConnectionToken": { + "target": "com.amazonaws.connectparticipant#ParticipantToken", + "traits": { + "smithy.api#documentation": "

The authentication token associated with the participant's connection.

", + "smithy.api#httpHeader": "X-Amz-Bearer", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connectparticipant#StartAttachmentUploadResponse": { + "type": "structure", + "members": { + "AttachmentId": { + "target": "com.amazonaws.connectparticipant#ArtifactId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the attachment.

" + } + }, + "UploadMetadata": { + "target": "com.amazonaws.connectparticipant#UploadMetadata", + "traits": { + "smithy.api#documentation": "

Fields to be used while uploading the attachment.

" + } + } + } + }, "com.amazonaws.connectparticipant#StartPosition": { "type": "structure", "members": { @@ -842,6 +1269,68 @@ "target": "com.amazonaws.connectparticipant#Item" } }, + "com.amazonaws.connectparticipant#UploadMetadata": { + "type": "structure", + "members": { + "Url": { + "target": "com.amazonaws.connectparticipant#UploadMetadataUrl", + "traits": { + "smithy.api#documentation": "

The pre-signed URL using which file would be downloaded from Amazon S3 by the API caller.

" + } + }, + "UrlExpiry": { + "target": "com.amazonaws.connectparticipant#ISO8601Datetime", + "traits": { + "smithy.api#documentation": "

The expiration time of the URL in ISO timestamp. It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.

" + } + }, + "HeadersToInclude": { + "target": "com.amazonaws.connectparticipant#UploadMetadataSignedHeaders", + "traits": { + "smithy.api#documentation": "

The headers to be provided while uploading the file to the URL.

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

Fields to be used while uploading the attachment.

" + } + }, + "com.amazonaws.connectparticipant#UploadMetadataSignedHeaders": { + "type": "map", + "key": { + "target": "com.amazonaws.connectparticipant#UploadMetadataSignedHeadersKey" + }, + "value": { + "target": "com.amazonaws.connectparticipant#UploadMetadataSignedHeadersValue" + } + }, + "com.amazonaws.connectparticipant#UploadMetadataSignedHeadersKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.connectparticipant#UploadMetadataSignedHeadersValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.connectparticipant#UploadMetadataUrl": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2000 + } + } + }, "com.amazonaws.connectparticipant#ValidationException": { "type": "structure", "members": { diff --git a/codegen/sdk-codegen/aws-models/costexplorer.2017-10-25.json b/codegen/sdk-codegen/aws-models/costexplorer.2017-10-25.json index 4e212497230..6cf2375aa3d 100644 --- a/codegen/sdk-codegen/aws-models/costexplorer.2017-10-25.json +++ b/codegen/sdk-codegen/aws-models/costexplorer.2017-10-25.json @@ -375,7 +375,7 @@ } }, "MonitorArnList": { - "target": "com.amazonaws.costexplorer#Values", + "target": "com.amazonaws.costexplorer#MonitorArnList", "traits": { "smithy.api#documentation": "

\n A list of cost anomaly monitors.\n

", "smithy.api#required": {} @@ -3767,6 +3767,12 @@ "smithy.api#documentation": "

Details on the modification recommendation.

" } }, + "com.amazonaws.costexplorer#MonitorArnList": { + "type": "list", + "member": { + "target": "com.amazonaws.costexplorer#Arn" + } + }, "com.amazonaws.costexplorer#MonitorDimension": { "type": "string", "traits": { @@ -4672,6 +4678,12 @@ "traits": { "smithy.api#documentation": "

How many days of previous usage that AWS considers when making this\n recommendation.

" } + }, + "AdditionalMetadata": { + "target": "com.amazonaws.costexplorer#GenericString", + "traits": { + "smithy.api#documentation": "

Additional metadata that may be applicable to the recommendation.

" + } } }, "traits": { @@ -5744,9 +5756,9 @@ } }, "MonitorArnList": { - "target": "com.amazonaws.costexplorer#Values", + "target": "com.amazonaws.costexplorer#MonitorArnList", "traits": { - "smithy.api#documentation": "

\n A list of cost anomaly subscription ARNs.\n

" + "smithy.api#documentation": "

\n A list of cost anomaly monitor ARNs.\n

" } }, "Subscribers": { diff --git a/codegen/sdk-codegen/aws-models/customerprofiles.2020-08-15.json b/codegen/sdk-codegen/aws-models/customerprofiles.2020-08-15.json new file mode 100644 index 00000000000..023a3db7a5c --- /dev/null +++ b/codegen/sdk-codegen/aws-models/customerprofiles.2020-08-15.json @@ -0,0 +1,3730 @@ +{ + "smithy": "1.0", + "metadata": { + "suppressions": [ + { + "id": "HttpMethodSemantics", + "namespace": "*" + }, + { + "id": "HttpResponseCodeSemantics", + "namespace": "*" + }, + { + "id": "PaginatedTrait", + "namespace": "*" + }, + { + "id": "HttpHeaderTrait", + "namespace": "*" + }, + { + "id": "HttpUriConflict", + "namespace": "*" + }, + { + "id": "Service", + "namespace": "*" + } + ] + }, + "shapes": { + "com.amazonaws.customerprofiles#AccessDeniedException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.customerprofiles#message" + } + }, + "traits": { + "smithy.api#documentation": "

You do not have sufficient access to perform this action.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.customerprofiles#AddProfileKey": { + "type": "operation", + "input": { + "target": "com.amazonaws.customerprofiles#AddProfileKeyRequest" + }, + "output": { + "target": "com.amazonaws.customerprofiles#AddProfileKeyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.customerprofiles#AccessDeniedException" + }, + { + "target": "com.amazonaws.customerprofiles#BadRequestException" + }, + { + "target": "com.amazonaws.customerprofiles#InternalServerException" + }, + { + "target": "com.amazonaws.customerprofiles#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.customerprofiles#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Associates a new key value with a specific profile, such as a Contact Trace Record (CTR)\n ContactId.

\n

A profile object can have a single unique key and any number of additional keys that can\n be used to identify the profile that it belongs to.

", + "smithy.api#http": { + "method": "POST", + "uri": "/domains/{DomainName}/profiles/keys", + "code": 200 + } + } + }, + "com.amazonaws.customerprofiles#AddProfileKeyRequest": { + "type": "structure", + "members": { + "ProfileId": { + "target": "com.amazonaws.customerprofiles#uuid", + "traits": { + "smithy.api#documentation": "

The unique identifier of a customer profile.

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

A searchable identifier of a customer profile.

", + "smithy.api#required": {} + } + }, + "Values": { + "target": "com.amazonaws.customerprofiles#requestValueList", + "traits": { + "smithy.api#documentation": "

A list of key values.

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

The unique name of the domain.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.customerprofiles#AddProfileKeyResponse": { + "type": "structure", + "members": { + "KeyName": { + "target": "com.amazonaws.customerprofiles#name", + "traits": { + "smithy.api#documentation": "

A searchable identifier of a customer profile.

" + } + }, + "Values": { + "target": "com.amazonaws.customerprofiles#requestValueList", + "traits": { + "smithy.api#documentation": "

A list of key values.

" + } + } + } + }, + "com.amazonaws.customerprofiles#Address": { + "type": "structure", + "members": { + "Address1": { + "target": "com.amazonaws.customerprofiles#string1To255", + "traits": { + "smithy.api#documentation": "

The first line of a customer address.

" + } + }, + "Address2": { + "target": "com.amazonaws.customerprofiles#string1To255", + "traits": { + "smithy.api#documentation": "

The second line of a customer address.

" + } + }, + "Address3": { + "target": "com.amazonaws.customerprofiles#string1To255", + "traits": { + "smithy.api#documentation": "

The third line of a customer address.

" + } + }, + "Address4": { + "target": "com.amazonaws.customerprofiles#string1To255", + "traits": { + "smithy.api#documentation": "

The fourth line of a customer address.

" + } + }, + "City": { + "target": "com.amazonaws.customerprofiles#string1To255", + "traits": { + "smithy.api#documentation": "

The city in which a customer lives.

" + } + }, + "County": { + "target": "com.amazonaws.customerprofiles#string1To255", + "traits": { + "smithy.api#documentation": "

The county in which a customer lives.

" + } + }, + "State": { + "target": "com.amazonaws.customerprofiles#string1To255", + "traits": { + "smithy.api#documentation": "

The state in which a customer lives.

" + } + }, + "Province": { + "target": "com.amazonaws.customerprofiles#string1To255", + "traits": { + "smithy.api#documentation": "

The province in which a customer lives.

" + } + }, + "Country": { + "target": "com.amazonaws.customerprofiles#string1To255", + "traits": { + "smithy.api#documentation": "

The country in which a customer lives.

" + } + }, + "PostalCode": { + "target": "com.amazonaws.customerprofiles#string1To255", + "traits": { + "smithy.api#documentation": "

The postal code of a customer address.

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

A generic address associated with the customer that is not mailing, shipping, or\n billing.

" + } + }, + "com.amazonaws.customerprofiles#Attributes": { + "type": "map", + "key": { + "target": "com.amazonaws.customerprofiles#string1To255" + }, + "value": { + "target": "com.amazonaws.customerprofiles#string1To255" + } + }, + "com.amazonaws.customerprofiles#BadRequestException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.customerprofiles#message" + } + }, + "traits": { + "smithy.api#documentation": "

The input you provided is invalid.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.customerprofiles#CreateDomain": { + "type": "operation", + "input": { + "target": "com.amazonaws.customerprofiles#CreateDomainRequest" + }, + "output": { + "target": "com.amazonaws.customerprofiles#CreateDomainResponse" + }, + "errors": [ + { + "target": "com.amazonaws.customerprofiles#AccessDeniedException" + }, + { + "target": "com.amazonaws.customerprofiles#BadRequestException" + }, + { + "target": "com.amazonaws.customerprofiles#InternalServerException" + }, + { + "target": "com.amazonaws.customerprofiles#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.customerprofiles#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a domain, which is a container for all customer data, such as customer profile\n attributes, object types, profile keys, and encryption keys. You can create multiple\n domains, and each domain can have multiple third-party integrations.

\n

Each Amazon Connect instance can be associated with only one domain. Multiple Amazon\n Connect instances can be associated with one domain.

", + "smithy.api#http": { + "method": "POST", + "uri": "/domains/{DomainName}", + "code": 200 + } + } + }, + "com.amazonaws.customerprofiles#CreateDomainRequest": { + "type": "structure", + "members": { + "DomainName": { + "target": "com.amazonaws.customerprofiles#name", + "traits": { + "smithy.api#documentation": "

The unique name of the domain.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DefaultExpirationDays": { + "target": "com.amazonaws.customerprofiles#expirationDaysInteger", + "traits": { + "smithy.api#documentation": "

The default number of days until the data within the domain expires.

", + "smithy.api#required": {} + } + }, + "DefaultEncryptionKey": { + "target": "com.amazonaws.customerprofiles#encryptionKey", + "traits": { + "smithy.api#documentation": "

The default encryption key, which is an AWS managed key, is used when no specific type\n of encryption key is specified. It is used to encrypt all data before it is placed in\n permanent or semi-permanent storage.

" + } + }, + "DeadLetterQueueUrl": { + "target": "com.amazonaws.customerprofiles#sqsQueueUrl", + "traits": { + "smithy.api#documentation": "

The URL of the SQS dead letter queue, which is used for reporting errors associated with\n ingesting data from third party applications. You must set up a policy on the\n DeadLetterQueue for the SendMessage operation to enable Amazon Connect Customer Profiles to\n send messages to the DeadLetterQueue.

" + } + }, + "Tags": { + "target": "com.amazonaws.customerprofiles#TagMap", + "traits": { + "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource.

" + } + } + } + }, + "com.amazonaws.customerprofiles#CreateDomainResponse": { + "type": "structure", + "members": { + "DomainName": { + "target": "com.amazonaws.customerprofiles#name", + "traits": { + "smithy.api#documentation": "

The unique name of the domain.

", + "smithy.api#required": {} + } + }, + "DefaultExpirationDays": { + "target": "com.amazonaws.customerprofiles#expirationDaysInteger", + "traits": { + "smithy.api#documentation": "

The default number of days until the data within the domain expires.

", + "smithy.api#required": {} + } + }, + "DefaultEncryptionKey": { + "target": "com.amazonaws.customerprofiles#encryptionKey", + "traits": { + "smithy.api#documentation": "

The default encryption key, which is an AWS managed key, is used when no specific type\n of encryption key is specified. It is used to encrypt all data before it is placed in\n permanent or semi-permanent storage.

" + } + }, + "DeadLetterQueueUrl": { + "target": "com.amazonaws.customerprofiles#sqsQueueUrl", + "traits": { + "smithy.api#documentation": "

The URL of the SQS dead letter queue, which is used for reporting errors associated with\n ingesting data from third party applications.

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

The timestamp of when the domain was created.

", + "smithy.api#required": {} + } + }, + "LastUpdatedAt": { + "target": "com.amazonaws.customerprofiles#timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp of when the domain was most recently edited.

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

The tags used to organize, track, or control access for this resource.

" + } + } + } + }, + "com.amazonaws.customerprofiles#CreateProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.customerprofiles#CreateProfileRequest" + }, + "output": { + "target": "com.amazonaws.customerprofiles#CreateProfileResponse" + }, + "errors": [ + { + "target": "com.amazonaws.customerprofiles#AccessDeniedException" + }, + { + "target": "com.amazonaws.customerprofiles#BadRequestException" + }, + { + "target": "com.amazonaws.customerprofiles#InternalServerException" + }, + { + "target": "com.amazonaws.customerprofiles#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.customerprofiles#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a standard profile.

\n

A standard profile represents the following attributes for a customer profile in a\n domain.

", + "smithy.api#http": { + "method": "POST", + "uri": "/domains/{DomainName}/profiles", + "code": 200 + } + } + }, + "com.amazonaws.customerprofiles#CreateProfileRequest": { + "type": "structure", + "members": { + "DomainName": { + "target": "com.amazonaws.customerprofiles#name", + "traits": { + "smithy.api#documentation": "

The unique name of the domain.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AccountNumber": { + "target": "com.amazonaws.customerprofiles#string1To255", + "traits": { + "smithy.api#documentation": "

A unique account number that you have given to the customer.

" + } + }, + "AdditionalInformation": { + "target": "com.amazonaws.customerprofiles#string1To1000", + "traits": { + "smithy.api#documentation": "

Any additional information relevant to the customer's profile.

" + } + }, + "PartyType": { + "target": "com.amazonaws.customerprofiles#PartyType", + "traits": { + "smithy.api#documentation": "

The type of profile used to describe the customer.

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

The name of the customer’s business.

" + } + }, + "FirstName": { + "target": "com.amazonaws.customerprofiles#string1To255", + "traits": { + "smithy.api#documentation": "

The customer’s first name.

" + } + }, + "MiddleName": { + "target": "com.amazonaws.customerprofiles#string1To255", + "traits": { + "smithy.api#documentation": "

The customer’s middle name.

" + } + }, + "LastName": { + "target": "com.amazonaws.customerprofiles#string1To255", + "traits": { + "smithy.api#documentation": "

The customer’s last name.

" + } + }, + "BirthDate": { + "target": "com.amazonaws.customerprofiles#string1To255", + "traits": { + "smithy.api#documentation": "

The customer’s birth date.

" + } + }, + "Gender": { + "target": "com.amazonaws.customerprofiles#Gender", + "traits": { + "smithy.api#documentation": "

The gender with which the customer identifies.

" + } + }, + "PhoneNumber": { + "target": "com.amazonaws.customerprofiles#string1To255", + "traits": { + "smithy.api#documentation": "

The customer's phone number, which has not been specified as a mobile, home, or business\n number.

" + } + }, + "MobilePhoneNumber": { + "target": "com.amazonaws.customerprofiles#string1To255", + "traits": { + "smithy.api#documentation": "

The customer’s mobile phone number.

" + } + }, + "HomePhoneNumber": { + "target": "com.amazonaws.customerprofiles#string1To255", + "traits": { + "smithy.api#documentation": "

The customer’s home phone number.

" + } + }, + "BusinessPhoneNumber": { + "target": "com.amazonaws.customerprofiles#string1To255", + "traits": { + "smithy.api#documentation": "

The customer’s business phone number.

" + } + }, + "EmailAddress": { + "target": "com.amazonaws.customerprofiles#string1To255", + "traits": { + "smithy.api#documentation": "

The customer's email address, which has not been specified as a personal or business\n address.

" + } + }, + "PersonalEmailAddress": { + "target": "com.amazonaws.customerprofiles#string1To255", + "traits": { + "smithy.api#documentation": "

The customer’s personal email address.

" + } + }, + "BusinessEmailAddress": { + "target": "com.amazonaws.customerprofiles#string1To255", + "traits": { + "smithy.api#documentation": "

The customer’s business email address.

" + } + }, + "Address": { + "target": "com.amazonaws.customerprofiles#Address", + "traits": { + "smithy.api#documentation": "

A generic address associated with the customer that is not mailing, shipping, or\n billing.

" + } + }, + "ShippingAddress": { + "target": "com.amazonaws.customerprofiles#Address", + "traits": { + "smithy.api#documentation": "

The customer’s shipping address.

" + } + }, + "MailingAddress": { + "target": "com.amazonaws.customerprofiles#Address", + "traits": { + "smithy.api#documentation": "

The customer’s mailing address.

" + } + }, + "BillingAddress": { + "target": "com.amazonaws.customerprofiles#Address", + "traits": { + "smithy.api#documentation": "

The customer’s billing address.

" + } + }, + "Attributes": { + "target": "com.amazonaws.customerprofiles#Attributes", + "traits": { + "smithy.api#documentation": "

A key value pair of attributes of a customer profile.

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

The unique identifier of a customer profile.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.customerprofiles#CustomerProfiles_20200815": { + "type": "service", + "version": "2020-08-15", + "operations": [ + { + "target": "com.amazonaws.customerprofiles#AddProfileKey" + }, + { + "target": "com.amazonaws.customerprofiles#CreateDomain" + }, + { + "target": "com.amazonaws.customerprofiles#CreateProfile" + }, + { + "target": "com.amazonaws.customerprofiles#DeleteDomain" + }, + { + "target": "com.amazonaws.customerprofiles#DeleteIntegration" + }, + { + "target": "com.amazonaws.customerprofiles#DeleteProfile" + }, + { + "target": "com.amazonaws.customerprofiles#DeleteProfileKey" + }, + { + "target": "com.amazonaws.customerprofiles#DeleteProfileObject" + }, + { + "target": "com.amazonaws.customerprofiles#DeleteProfileObjectType" + }, + { + "target": "com.amazonaws.customerprofiles#GetDomain" + }, + { + "target": "com.amazonaws.customerprofiles#GetIntegration" + }, + { + "target": "com.amazonaws.customerprofiles#GetProfileObjectType" + }, + { + "target": "com.amazonaws.customerprofiles#GetProfileObjectTypeTemplate" + }, + { + "target": "com.amazonaws.customerprofiles#ListAccountIntegrations" + }, + { + "target": "com.amazonaws.customerprofiles#ListDomains" + }, + { + "target": "com.amazonaws.customerprofiles#ListIntegrations" + }, + { + "target": "com.amazonaws.customerprofiles#ListProfileObjects" + }, + { + "target": "com.amazonaws.customerprofiles#ListProfileObjectTypes" + }, + { + "target": "com.amazonaws.customerprofiles#ListProfileObjectTypeTemplates" + }, + { + "target": "com.amazonaws.customerprofiles#ListTagsForResource" + }, + { + "target": "com.amazonaws.customerprofiles#PutIntegration" + }, + { + "target": "com.amazonaws.customerprofiles#PutProfileObject" + }, + { + "target": "com.amazonaws.customerprofiles#PutProfileObjectType" + }, + { + "target": "com.amazonaws.customerprofiles#SearchProfiles" + }, + { + "target": "com.amazonaws.customerprofiles#TagResource" + }, + { + "target": "com.amazonaws.customerprofiles#UntagResource" + }, + { + "target": "com.amazonaws.customerprofiles#UpdateDomain" + }, + { + "target": "com.amazonaws.customerprofiles#UpdateProfile" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "Customer Profiles", + "arnNamespace": "profile", + "cloudFormationName": "CustomerProfiles", + "cloudTrailEventSource": "customerprofiles.amazonaws.com", + "endpointPrefix": "profile" + }, + "aws.auth#sigv4": { + "name": "profile" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "Amazon Connect Customer Profiles\n

Welcome to the Amazon Connect Customer Profiles API Reference. This guide provides\n information about the Amazon Connect Customer Profiles API, including supported operations,\n data types, parameters, and schemas.

\n

Amazon Connect Customer Profiles is a unified customer profile for your contact center\n that has pre-built connectors powered by AppFlow that make it easy to combine customer\n information from third party applications, such as Salesforce (CRM), ServiceNow (ITSM), and\n your enterprise resource planning (ERP), with contact history from your Amazon Connect\n contact center.

\n

If you're new to Amazon Connect, you might find it helpful to also review the Amazon Connect Administrator Guide.

", + "smithy.api#title": "Amazon Connect Customer Profiles" + } + }, + "com.amazonaws.customerprofiles#DeleteDomain": { + "type": "operation", + "input": { + "target": "com.amazonaws.customerprofiles#DeleteDomainRequest" + }, + "output": { + "target": "com.amazonaws.customerprofiles#DeleteDomainResponse" + }, + "errors": [ + { + "target": "com.amazonaws.customerprofiles#AccessDeniedException" + }, + { + "target": "com.amazonaws.customerprofiles#BadRequestException" + }, + { + "target": "com.amazonaws.customerprofiles#InternalServerException" + }, + { + "target": "com.amazonaws.customerprofiles#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.customerprofiles#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a specific domain and all of its customer data, such as customer profile\n attributes and their related objects.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/domains/{DomainName}", + "code": 200 + } + } + }, + "com.amazonaws.customerprofiles#DeleteDomainRequest": { + "type": "structure", + "members": { + "DomainName": { + "target": "com.amazonaws.customerprofiles#name", + "traits": { + "smithy.api#documentation": "

The unique name of the domain.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.customerprofiles#DeleteDomainResponse": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.customerprofiles#message", + "traits": { + "smithy.api#documentation": "

A message that indicates the delete request is done.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.customerprofiles#DeleteIntegration": { + "type": "operation", + "input": { + "target": "com.amazonaws.customerprofiles#DeleteIntegrationRequest" + }, + "output": { + "target": "com.amazonaws.customerprofiles#DeleteIntegrationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.customerprofiles#AccessDeniedException" + }, + { + "target": "com.amazonaws.customerprofiles#BadRequestException" + }, + { + "target": "com.amazonaws.customerprofiles#InternalServerException" + }, + { + "target": "com.amazonaws.customerprofiles#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.customerprofiles#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes an integration from a specific domain.

", + "smithy.api#http": { + "method": "POST", + "uri": "/domains/{DomainName}/integrations/delete", + "code": 200 + } + } + }, + "com.amazonaws.customerprofiles#DeleteIntegrationRequest": { + "type": "structure", + "members": { + "DomainName": { + "target": "com.amazonaws.customerprofiles#name", + "traits": { + "smithy.api#documentation": "

The unique name of the domain.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Uri": { + "target": "com.amazonaws.customerprofiles#string1To255", + "traits": { + "smithy.api#documentation": "

The URI of the S3 bucket or any other type of data source.

" + } + } + } + }, + "com.amazonaws.customerprofiles#DeleteIntegrationResponse": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.customerprofiles#message", + "traits": { + "smithy.api#documentation": "

A message that indicates the delete request is done.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.customerprofiles#DeleteProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.customerprofiles#DeleteProfileRequest" + }, + "output": { + "target": "com.amazonaws.customerprofiles#DeleteProfileResponse" + }, + "errors": [ + { + "target": "com.amazonaws.customerprofiles#AccessDeniedException" + }, + { + "target": "com.amazonaws.customerprofiles#BadRequestException" + }, + { + "target": "com.amazonaws.customerprofiles#InternalServerException" + }, + { + "target": "com.amazonaws.customerprofiles#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.customerprofiles#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the standard customer profile and all data pertaining to the profile.

", + "smithy.api#http": { + "method": "POST", + "uri": "/domains/{DomainName}/profiles/delete", + "code": 200 + } + } + }, + "com.amazonaws.customerprofiles#DeleteProfileKey": { + "type": "operation", + "input": { + "target": "com.amazonaws.customerprofiles#DeleteProfileKeyRequest" + }, + "output": { + "target": "com.amazonaws.customerprofiles#DeleteProfileKeyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.customerprofiles#AccessDeniedException" + }, + { + "target": "com.amazonaws.customerprofiles#BadRequestException" + }, + { + "target": "com.amazonaws.customerprofiles#InternalServerException" + }, + { + "target": "com.amazonaws.customerprofiles#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.customerprofiles#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes a searchable key from a customer profile.

", + "smithy.api#http": { + "method": "POST", + "uri": "/domains/{DomainName}/profiles/keys/delete", + "code": 200 + } + } + }, + "com.amazonaws.customerprofiles#DeleteProfileKeyRequest": { + "type": "structure", + "members": { + "ProfileId": { + "target": "com.amazonaws.customerprofiles#uuid", + "traits": { + "smithy.api#documentation": "

The unique identifier of a customer profile.

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

A searchable identifier of a customer profile.

", + "smithy.api#required": {} + } + }, + "Values": { + "target": "com.amazonaws.customerprofiles#requestValueList", + "traits": { + "smithy.api#documentation": "

A list of key values.

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

The unique name of the domain.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.customerprofiles#DeleteProfileKeyResponse": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.customerprofiles#message", + "traits": { + "smithy.api#documentation": "

A message that indicates the delete request is done.

" + } + } + } + }, + "com.amazonaws.customerprofiles#DeleteProfileObject": { + "type": "operation", + "input": { + "target": "com.amazonaws.customerprofiles#DeleteProfileObjectRequest" + }, + "output": { + "target": "com.amazonaws.customerprofiles#DeleteProfileObjectResponse" + }, + "errors": [ + { + "target": "com.amazonaws.customerprofiles#AccessDeniedException" + }, + { + "target": "com.amazonaws.customerprofiles#BadRequestException" + }, + { + "target": "com.amazonaws.customerprofiles#InternalServerException" + }, + { + "target": "com.amazonaws.customerprofiles#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.customerprofiles#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes an object associated with a profile of a given ProfileObjectType.

", + "smithy.api#http": { + "method": "POST", + "uri": "/domains/{DomainName}/profiles/objects/delete", + "code": 200 + } + } + }, + "com.amazonaws.customerprofiles#DeleteProfileObjectRequest": { + "type": "structure", + "members": { + "ProfileId": { + "target": "com.amazonaws.customerprofiles#uuid", + "traits": { + "smithy.api#documentation": "

The unique identifier of a customer profile.

", + "smithy.api#required": {} + } + }, + "ProfileObjectUniqueKey": { + "target": "com.amazonaws.customerprofiles#string1To255", + "traits": { + "smithy.api#documentation": "

The unique identifier of the profile object generated by the service.

", + "smithy.api#required": {} + } + }, + "ObjectTypeName": { + "target": "com.amazonaws.customerprofiles#typeName", + "traits": { + "smithy.api#documentation": "

The name of the profile object type.

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

The unique name of the domain.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.customerprofiles#DeleteProfileObjectResponse": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.customerprofiles#message", + "traits": { + "smithy.api#documentation": "

A message that indicates the delete request is done.

" + } + } + } + }, + "com.amazonaws.customerprofiles#DeleteProfileObjectType": { + "type": "operation", + "input": { + "target": "com.amazonaws.customerprofiles#DeleteProfileObjectTypeRequest" + }, + "output": { + "target": "com.amazonaws.customerprofiles#DeleteProfileObjectTypeResponse" + }, + "errors": [ + { + "target": "com.amazonaws.customerprofiles#AccessDeniedException" + }, + { + "target": "com.amazonaws.customerprofiles#BadRequestException" + }, + { + "target": "com.amazonaws.customerprofiles#InternalServerException" + }, + { + "target": "com.amazonaws.customerprofiles#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.customerprofiles#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes a ProfileObjectType from a specific domain as well as removes all the\n ProfileObjects of that type. It also disables integrations from this specific\n ProfileObjectType. In addition, it scrubs all of the fields of the standard profile that\n were populated from this ProfileObjectType.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/domains/{DomainName}/object-types/{ObjectTypeName}", + "code": 200 + } + } + }, + "com.amazonaws.customerprofiles#DeleteProfileObjectTypeRequest": { + "type": "structure", + "members": { + "DomainName": { + "target": "com.amazonaws.customerprofiles#name", + "traits": { + "smithy.api#documentation": "

The unique name of the domain.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ObjectTypeName": { + "target": "com.amazonaws.customerprofiles#typeName", + "traits": { + "smithy.api#documentation": "

The name of the profile object type.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.customerprofiles#DeleteProfileObjectTypeResponse": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.customerprofiles#message", + "traits": { + "smithy.api#documentation": "

A message that indicates the delete request is done.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.customerprofiles#DeleteProfileRequest": { + "type": "structure", + "members": { + "ProfileId": { + "target": "com.amazonaws.customerprofiles#uuid", + "traits": { + "smithy.api#documentation": "

The unique identifier of a customer profile.

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

The unique name of the domain.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.customerprofiles#DeleteProfileResponse": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.customerprofiles#message", + "traits": { + "smithy.api#documentation": "

A message that indicates the delete request is done.

" + } + } + } + }, + "com.amazonaws.customerprofiles#DomainList": { + "type": "list", + "member": { + "target": "com.amazonaws.customerprofiles#ListDomainItem" + } + }, + "com.amazonaws.customerprofiles#DomainStats": { + "type": "structure", + "members": { + "ProfileCount": { + "target": "com.amazonaws.customerprofiles#long", + "traits": { + "smithy.api#documentation": "

The total number of profiles currently in the domain.

" + } + }, + "MeteringProfileCount": { + "target": "com.amazonaws.customerprofiles#long", + "traits": { + "smithy.api#documentation": "

The number of profiles that you are currently paying for in the domain. If you have more\n than 100 objects associated with a single profile, that profile counts as two profiles. If\n you have more than 200 objects, that profile counts as three, and so on.

" + } + }, + "ObjectCount": { + "target": "com.amazonaws.customerprofiles#long", + "traits": { + "smithy.api#documentation": "

The total number of objects in domain.

" + } + }, + "TotalSize": { + "target": "com.amazonaws.customerprofiles#long", + "traits": { + "smithy.api#documentation": "

The total size, in bytes, of all objects in the domain.

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

Usage-specific statistics about the domain.

" + } + }, + "com.amazonaws.customerprofiles#FieldContentType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "STRING", + "name": "STRING" + }, + { + "value": "NUMBER", + "name": "NUMBER" + }, + { + "value": "PHONE_NUMBER", + "name": "PHONE_NUMBER" + }, + { + "value": "EMAIL_ADDRESS", + "name": "EMAIL_ADDRESS" + }, + { + "value": "NAME", + "name": "NAME" + } + ] + } + }, + "com.amazonaws.customerprofiles#FieldMap": { + "type": "map", + "key": { + "target": "com.amazonaws.customerprofiles#name" + }, + "value": { + "target": "com.amazonaws.customerprofiles#ObjectTypeField" + } + }, + "com.amazonaws.customerprofiles#FieldNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.customerprofiles#name" + } + }, + "com.amazonaws.customerprofiles#Gender": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "MALE", + "name": "MALE" + }, + { + "value": "FEMALE", + "name": "FEMALE" + }, + { + "value": "UNSPECIFIED", + "name": "UNSPECIFIED" + } + ] + } + }, + "com.amazonaws.customerprofiles#GetDomain": { + "type": "operation", + "input": { + "target": "com.amazonaws.customerprofiles#GetDomainRequest" + }, + "output": { + "target": "com.amazonaws.customerprofiles#GetDomainResponse" + }, + "errors": [ + { + "target": "com.amazonaws.customerprofiles#AccessDeniedException" + }, + { + "target": "com.amazonaws.customerprofiles#BadRequestException" + }, + { + "target": "com.amazonaws.customerprofiles#InternalServerException" + }, + { + "target": "com.amazonaws.customerprofiles#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.customerprofiles#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about a specific domain.

", + "smithy.api#http": { + "method": "GET", + "uri": "/domains/{DomainName}", + "code": 200 + } + } + }, + "com.amazonaws.customerprofiles#GetDomainRequest": { + "type": "structure", + "members": { + "DomainName": { + "target": "com.amazonaws.customerprofiles#name", + "traits": { + "smithy.api#documentation": "

A unique name for the domain.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.customerprofiles#GetDomainResponse": { + "type": "structure", + "members": { + "DomainName": { + "target": "com.amazonaws.customerprofiles#name", + "traits": { + "smithy.api#documentation": "

The unique name of the domain.

", + "smithy.api#required": {} + } + }, + "DefaultExpirationDays": { + "target": "com.amazonaws.customerprofiles#expirationDaysInteger", + "traits": { + "smithy.api#documentation": "

The default number of days until the data within the domain expires.

" + } + }, + "DefaultEncryptionKey": { + "target": "com.amazonaws.customerprofiles#encryptionKey", + "traits": { + "smithy.api#documentation": "

The default encryption key, which is an AWS managed key, is used when no specific type\n of encryption key is specified. It is used to encrypt all data before it is placed in\n permanent or semi-permanent storage.

" + } + }, + "DeadLetterQueueUrl": { + "target": "com.amazonaws.customerprofiles#sqsQueueUrl", + "traits": { + "smithy.api#documentation": "

The URL of the SQS dead letter queue, which is used for reporting errors associated with\n ingesting data from third party applications.

" + } + }, + "Stats": { + "target": "com.amazonaws.customerprofiles#DomainStats", + "traits": { + "smithy.api#documentation": "

Usage-specific statistics about the domain.

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

The timestamp of when the domain was created.

", + "smithy.api#required": {} + } + }, + "LastUpdatedAt": { + "target": "com.amazonaws.customerprofiles#timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp of when the domain was most recently edited.

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

The tags used to organize, track, or control access for this resource.

" + } + } + } + }, + "com.amazonaws.customerprofiles#GetIntegration": { + "type": "operation", + "input": { + "target": "com.amazonaws.customerprofiles#GetIntegrationRequest" + }, + "output": { + "target": "com.amazonaws.customerprofiles#GetIntegrationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.customerprofiles#AccessDeniedException" + }, + { + "target": "com.amazonaws.customerprofiles#BadRequestException" + }, + { + "target": "com.amazonaws.customerprofiles#InternalServerException" + }, + { + "target": "com.amazonaws.customerprofiles#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.customerprofiles#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns an integration for a domain.

", + "smithy.api#http": { + "method": "POST", + "uri": "/domains/{DomainName}/integrations", + "code": 200 + } + } + }, + "com.amazonaws.customerprofiles#GetIntegrationRequest": { + "type": "structure", + "members": { + "DomainName": { + "target": "com.amazonaws.customerprofiles#name", + "traits": { + "smithy.api#documentation": "

The unique name of the domain.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Uri": { + "target": "com.amazonaws.customerprofiles#string1To255", + "traits": { + "smithy.api#documentation": "

The URI of the S3 bucket or any other type of data source.

" + } + } + } + }, + "com.amazonaws.customerprofiles#GetIntegrationResponse": { + "type": "structure", + "members": { + "DomainName": { + "target": "com.amazonaws.customerprofiles#name", + "traits": { + "smithy.api#documentation": "

The unique name of the domain.

", + "smithy.api#required": {} + } + }, + "Uri": { + "target": "com.amazonaws.customerprofiles#string1To255", + "traits": { + "smithy.api#documentation": "

The URI of the S3 bucket or any other type of data source.

", + "smithy.api#required": {} + } + }, + "ObjectTypeName": { + "target": "com.amazonaws.customerprofiles#typeName", + "traits": { + "smithy.api#documentation": "

The name of the profile object type.

", + "smithy.api#required": {} + } + }, + "CreatedAt": { + "target": "com.amazonaws.customerprofiles#timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp of when the domain was created.

", + "smithy.api#required": {} + } + }, + "LastUpdatedAt": { + "target": "com.amazonaws.customerprofiles#timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp of when the domain was most recently edited.

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

The tags used to organize, track, or control access for this resource.

" + } + } + } + }, + "com.amazonaws.customerprofiles#GetProfileObjectType": { + "type": "operation", + "input": { + "target": "com.amazonaws.customerprofiles#GetProfileObjectTypeRequest" + }, + "output": { + "target": "com.amazonaws.customerprofiles#GetProfileObjectTypeResponse" + }, + "errors": [ + { + "target": "com.amazonaws.customerprofiles#AccessDeniedException" + }, + { + "target": "com.amazonaws.customerprofiles#BadRequestException" + }, + { + "target": "com.amazonaws.customerprofiles#InternalServerException" + }, + { + "target": "com.amazonaws.customerprofiles#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.customerprofiles#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the object types for a specific domain.

", + "smithy.api#http": { + "method": "GET", + "uri": "/domains/{DomainName}/object-types/{ObjectTypeName}", + "code": 200 + } + } + }, + "com.amazonaws.customerprofiles#GetProfileObjectTypeRequest": { + "type": "structure", + "members": { + "DomainName": { + "target": "com.amazonaws.customerprofiles#name", + "traits": { + "smithy.api#documentation": "

The unique name of the domain.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ObjectTypeName": { + "target": "com.amazonaws.customerprofiles#typeName", + "traits": { + "smithy.api#documentation": "

The name of the profile object type.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.customerprofiles#GetProfileObjectTypeResponse": { + "type": "structure", + "members": { + "ObjectTypeName": { + "target": "com.amazonaws.customerprofiles#typeName", + "traits": { + "smithy.api#documentation": "

The name of the profile object type.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.customerprofiles#text", + "traits": { + "smithy.api#documentation": "

The description of the profile object type.

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

A unique identifier for the object template.

" + } + }, + "ExpirationDays": { + "target": "com.amazonaws.customerprofiles#expirationDaysInteger", + "traits": { + "smithy.api#documentation": "

The number of days until the data in the object expires.

" + } + }, + "EncryptionKey": { + "target": "com.amazonaws.customerprofiles#encryptionKey", + "traits": { + "smithy.api#documentation": "

The customer-provided key to encrypt the profile object that will be created in this\n profile object type.

" + } + }, + "AllowProfileCreation": { + "target": "com.amazonaws.customerprofiles#boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether a profile should be created when data is received if one doesn’t exist\n for an object of this type. The default is FALSE. If the AllowProfileCreation\n flag is set to FALSE, then the service tries to fetch a standard profile and\n associate this object with the profile. If it is set to TRUE, and if no match\n is found, then the service creates a new standard profile.

" + } + }, + "Fields": { + "target": "com.amazonaws.customerprofiles#FieldMap", + "traits": { + "smithy.api#documentation": "

A map of the name and ObjectType field.

" + } + }, + "Keys": { + "target": "com.amazonaws.customerprofiles#KeyMap", + "traits": { + "smithy.api#documentation": "

A list of unique keys that can be used to map data to the profile.

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

The timestamp of when the domain was created.

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

The timestamp of when the domain was most recently edited.

" + } + }, + "Tags": { + "target": "com.amazonaws.customerprofiles#TagMap", + "traits": { + "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource.

" + } + } + } + }, + "com.amazonaws.customerprofiles#GetProfileObjectTypeTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.customerprofiles#GetProfileObjectTypeTemplateRequest" + }, + "output": { + "target": "com.amazonaws.customerprofiles#GetProfileObjectTypeTemplateResponse" + }, + "errors": [ + { + "target": "com.amazonaws.customerprofiles#AccessDeniedException" + }, + { + "target": "com.amazonaws.customerprofiles#BadRequestException" + }, + { + "target": "com.amazonaws.customerprofiles#InternalServerException" + }, + { + "target": "com.amazonaws.customerprofiles#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.customerprofiles#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the template information for a specific object type.

\n

A template is a predefined ProfileObjectType, such as “Salesforce-Account” or\n “Salesforce-Contact.” When a user sends a ProfileObject, using the PutProfileObject API,\n with an ObjectTypeName that matches one of the TemplateIds, it uses the mappings from the\n template.

", + "smithy.api#http": { + "method": "GET", + "uri": "/templates/{TemplateId}", + "code": 200 + } + } + }, + "com.amazonaws.customerprofiles#GetProfileObjectTypeTemplateRequest": { + "type": "structure", + "members": { + "TemplateId": { + "target": "com.amazonaws.customerprofiles#name", + "traits": { + "smithy.api#documentation": "

A unique identifier for the object template.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.customerprofiles#GetProfileObjectTypeTemplateResponse": { + "type": "structure", + "members": { + "TemplateId": { + "target": "com.amazonaws.customerprofiles#name", + "traits": { + "smithy.api#documentation": "

A unique identifier for the object template.

" + } + }, + "SourceName": { + "target": "com.amazonaws.customerprofiles#name", + "traits": { + "smithy.api#documentation": "

The name of the source of the object template.

" + } + }, + "SourceObject": { + "target": "com.amazonaws.customerprofiles#name", + "traits": { + "smithy.api#documentation": "

The source of the object template.

" + } + }, + "AllowProfileCreation": { + "target": "com.amazonaws.customerprofiles#boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether a profile should be created when data is received if one doesn’t exist\n for an object of this type. The default is FALSE. If the AllowProfileCreation\n flag is set to FALSE, then the service tries to fetch a standard profile and\n associate this object with the profile. If it is set to TRUE, and if no match\n is found, then the service creates a new standard profile.

" + } + }, + "Fields": { + "target": "com.amazonaws.customerprofiles#FieldMap", + "traits": { + "smithy.api#documentation": "

A map of the name and ObjectType field.

" + } + }, + "Keys": { + "target": "com.amazonaws.customerprofiles#KeyMap", + "traits": { + "smithy.api#documentation": "

A list of unique keys that can be used to map data to the profile.

" + } + } + } + }, + "com.amazonaws.customerprofiles#IntegrationList": { + "type": "list", + "member": { + "target": "com.amazonaws.customerprofiles#ListIntegrationItem" + } + }, + "com.amazonaws.customerprofiles#InternalServerException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.customerprofiles#message" + } + }, + "traits": { + "smithy.api#documentation": "

An internal service error occurred.

", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.customerprofiles#KeyMap": { + "type": "map", + "key": { + "target": "com.amazonaws.customerprofiles#name" + }, + "value": { + "target": "com.amazonaws.customerprofiles#ObjectTypeKeyList" + } + }, + "com.amazonaws.customerprofiles#ListAccountIntegrations": { + "type": "operation", + "input": { + "target": "com.amazonaws.customerprofiles#ListAccountIntegrationsRequest" + }, + "output": { + "target": "com.amazonaws.customerprofiles#ListAccountIntegrationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.customerprofiles#AccessDeniedException" + }, + { + "target": "com.amazonaws.customerprofiles#BadRequestException" + }, + { + "target": "com.amazonaws.customerprofiles#InternalServerException" + }, + { + "target": "com.amazonaws.customerprofiles#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.customerprofiles#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all of the integrations associated to a specific URI in the AWS account.

", + "smithy.api#http": { + "method": "POST", + "uri": "/integrations", + "code": 200 + } + } + }, + "com.amazonaws.customerprofiles#ListAccountIntegrationsRequest": { + "type": "structure", + "members": { + "Uri": { + "target": "com.amazonaws.customerprofiles#string1To255", + "traits": { + "smithy.api#documentation": "

The URI of the S3 bucket or any other type of data source.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.customerprofiles#token", + "traits": { + "smithy.api#documentation": "

The pagination token from the previous ListAccountIntegrations API call.

", + "smithy.api#httpQuery": "next-token" + } + }, + "MaxResults": { + "target": "com.amazonaws.customerprofiles#maxSize100", + "traits": { + "smithy.api#documentation": "

The maximum number of objects returned per page.

", + "smithy.api#httpQuery": "max-results" + } + } + } + }, + "com.amazonaws.customerprofiles#ListAccountIntegrationsResponse": { + "type": "structure", + "members": { + "Items": { + "target": "com.amazonaws.customerprofiles#IntegrationList", + "traits": { + "smithy.api#documentation": "

The list of ListAccountIntegration instances.

" + } + }, + "NextToken": { + "target": "com.amazonaws.customerprofiles#token", + "traits": { + "smithy.api#documentation": "

The pagination token from the previous ListAccountIntegrations API call.

" + } + } + } + }, + "com.amazonaws.customerprofiles#ListDomainItem": { + "type": "structure", + "members": { + "DomainName": { + "target": "com.amazonaws.customerprofiles#name", + "traits": { + "smithy.api#documentation": "

The unique name of the domain.

", + "smithy.api#required": {} + } + }, + "CreatedAt": { + "target": "com.amazonaws.customerprofiles#timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp of when the domain was created.

", + "smithy.api#required": {} + } + }, + "LastUpdatedAt": { + "target": "com.amazonaws.customerprofiles#timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp of when the domain was most recently edited.

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

The tags used to organize, track, or control access for this resource.

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

An object in a list that represents a domain.

" + } + }, + "com.amazonaws.customerprofiles#ListDomains": { + "type": "operation", + "input": { + "target": "com.amazonaws.customerprofiles#ListDomainsRequest" + }, + "output": { + "target": "com.amazonaws.customerprofiles#ListDomainsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.customerprofiles#AccessDeniedException" + }, + { + "target": "com.amazonaws.customerprofiles#BadRequestException" + }, + { + "target": "com.amazonaws.customerprofiles#InternalServerException" + }, + { + "target": "com.amazonaws.customerprofiles#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.customerprofiles#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of all the domains for an AWS account that have been created.

", + "smithy.api#http": { + "method": "GET", + "uri": "/domains", + "code": 200 + } + } + }, + "com.amazonaws.customerprofiles#ListDomainsRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.customerprofiles#token", + "traits": { + "smithy.api#documentation": "

The pagination token from the previous ListDomain API call.

", + "smithy.api#httpQuery": "next-token" + } + }, + "MaxResults": { + "target": "com.amazonaws.customerprofiles#maxSize100", + "traits": { + "smithy.api#documentation": "

The maximum number of objects returned per page.

", + "smithy.api#httpQuery": "max-results" + } + } + } + }, + "com.amazonaws.customerprofiles#ListDomainsResponse": { + "type": "structure", + "members": { + "Items": { + "target": "com.amazonaws.customerprofiles#DomainList", + "traits": { + "smithy.api#documentation": "

The list of ListDomains instances.

" + } + }, + "NextToken": { + "target": "com.amazonaws.customerprofiles#token", + "traits": { + "smithy.api#documentation": "

The pagination token from the previous ListDomains API call.

" + } + } + } + }, + "com.amazonaws.customerprofiles#ListIntegrationItem": { + "type": "structure", + "members": { + "DomainName": { + "target": "com.amazonaws.customerprofiles#name", + "traits": { + "smithy.api#documentation": "

The unique name of the domain.

", + "smithy.api#required": {} + } + }, + "Uri": { + "target": "com.amazonaws.customerprofiles#string1To255", + "traits": { + "smithy.api#documentation": "

The URI of the S3 bucket or any other type of data source.

", + "smithy.api#required": {} + } + }, + "ObjectTypeName": { + "target": "com.amazonaws.customerprofiles#typeName", + "traits": { + "smithy.api#documentation": "

The name of the profile object type.

", + "smithy.api#required": {} + } + }, + "CreatedAt": { + "target": "com.amazonaws.customerprofiles#timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp of when the domain was created.

", + "smithy.api#required": {} + } + }, + "LastUpdatedAt": { + "target": "com.amazonaws.customerprofiles#timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp of when the domain was most recently edited.

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

The tags used to organize, track, or control access for this resource.

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

An integration in list of integrations.

" + } + }, + "com.amazonaws.customerprofiles#ListIntegrations": { + "type": "operation", + "input": { + "target": "com.amazonaws.customerprofiles#ListIntegrationsRequest" + }, + "output": { + "target": "com.amazonaws.customerprofiles#ListIntegrationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.customerprofiles#AccessDeniedException" + }, + { + "target": "com.amazonaws.customerprofiles#BadRequestException" + }, + { + "target": "com.amazonaws.customerprofiles#InternalServerException" + }, + { + "target": "com.amazonaws.customerprofiles#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.customerprofiles#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all of the integrations in your domain.

", + "smithy.api#http": { + "method": "GET", + "uri": "/domains/{DomainName}/integrations", + "code": 200 + } + } + }, + "com.amazonaws.customerprofiles#ListIntegrationsRequest": { + "type": "structure", + "members": { + "DomainName": { + "target": "com.amazonaws.customerprofiles#name", + "traits": { + "smithy.api#documentation": "

The unique name of the domain.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.customerprofiles#token", + "traits": { + "smithy.api#documentation": "

The pagination token from the previous ListIntegrations API call.

", + "smithy.api#httpQuery": "next-token" + } + }, + "MaxResults": { + "target": "com.amazonaws.customerprofiles#maxSize100", + "traits": { + "smithy.api#documentation": "

The maximum number of objects returned per page.

", + "smithy.api#httpQuery": "max-results" + } + } + } + }, + "com.amazonaws.customerprofiles#ListIntegrationsResponse": { + "type": "structure", + "members": { + "Items": { + "target": "com.amazonaws.customerprofiles#IntegrationList", + "traits": { + "smithy.api#documentation": "

The list of ListIntegrations instances.

" + } + }, + "NextToken": { + "target": "com.amazonaws.customerprofiles#token", + "traits": { + "smithy.api#documentation": "

The pagination token from the previous ListIntegrations API call.

" + } + } + } + }, + "com.amazonaws.customerprofiles#ListProfileObjectTypeItem": { + "type": "structure", + "members": { + "ObjectTypeName": { + "target": "com.amazonaws.customerprofiles#typeName", + "traits": { + "smithy.api#documentation": "

The name of the profile object type.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.customerprofiles#text", + "traits": { + "smithy.api#documentation": "

Description of the profile object type.

", + "smithy.api#required": {} + } + }, + "CreatedAt": { + "target": "com.amazonaws.customerprofiles#timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp of when the domain was created.

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

The timestamp of when the domain was most recently edited.

" + } + }, + "Tags": { + "target": "com.amazonaws.customerprofiles#TagMap", + "traits": { + "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource.

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

A ProfileObjectType instance.

" + } + }, + "com.amazonaws.customerprofiles#ListProfileObjectTypeTemplateItem": { + "type": "structure", + "members": { + "TemplateId": { + "target": "com.amazonaws.customerprofiles#name", + "traits": { + "smithy.api#documentation": "

A unique identifier for the object template.

" + } + }, + "SourceName": { + "target": "com.amazonaws.customerprofiles#name", + "traits": { + "smithy.api#documentation": "

The name of the source of the object template.

" + } + }, + "SourceObject": { + "target": "com.amazonaws.customerprofiles#name", + "traits": { + "smithy.api#documentation": "

The source of the object template.

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

A ProfileObjectTypeTemplate in a list of ProfileObjectTypeTemplates.

" + } + }, + "com.amazonaws.customerprofiles#ListProfileObjectTypeTemplates": { + "type": "operation", + "input": { + "target": "com.amazonaws.customerprofiles#ListProfileObjectTypeTemplatesRequest" + }, + "output": { + "target": "com.amazonaws.customerprofiles#ListProfileObjectTypeTemplatesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.customerprofiles#AccessDeniedException" + }, + { + "target": "com.amazonaws.customerprofiles#BadRequestException" + }, + { + "target": "com.amazonaws.customerprofiles#InternalServerException" + }, + { + "target": "com.amazonaws.customerprofiles#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.customerprofiles#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all of the template information for object types.

", + "smithy.api#http": { + "method": "GET", + "uri": "/templates", + "code": 200 + } + } + }, + "com.amazonaws.customerprofiles#ListProfileObjectTypeTemplatesRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.customerprofiles#token", + "traits": { + "smithy.api#documentation": "

The pagination token from the previous ListObjectTypeTemplates API call.

", + "smithy.api#httpQuery": "next-token" + } + }, + "MaxResults": { + "target": "com.amazonaws.customerprofiles#maxSize100", + "traits": { + "smithy.api#documentation": "

The maximum number of objects returned per page.

", + "smithy.api#httpQuery": "max-results" + } + } + } + }, + "com.amazonaws.customerprofiles#ListProfileObjectTypeTemplatesResponse": { + "type": "structure", + "members": { + "Items": { + "target": "com.amazonaws.customerprofiles#ProfileObjectTypeTemplateList", + "traits": { + "smithy.api#documentation": "

The list of ListProfileObjectType template instances.

" + } + }, + "NextToken": { + "target": "com.amazonaws.customerprofiles#token", + "traits": { + "smithy.api#documentation": "

The pagination token from the previous ListObjectTypeTemplates API call.

" + } + } + } + }, + "com.amazonaws.customerprofiles#ListProfileObjectTypes": { + "type": "operation", + "input": { + "target": "com.amazonaws.customerprofiles#ListProfileObjectTypesRequest" + }, + "output": { + "target": "com.amazonaws.customerprofiles#ListProfileObjectTypesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.customerprofiles#AccessDeniedException" + }, + { + "target": "com.amazonaws.customerprofiles#BadRequestException" + }, + { + "target": "com.amazonaws.customerprofiles#InternalServerException" + }, + { + "target": "com.amazonaws.customerprofiles#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.customerprofiles#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all of the templates available within the service.

", + "smithy.api#http": { + "method": "GET", + "uri": "/domains/{DomainName}/object-types", + "code": 200 + } + } + }, + "com.amazonaws.customerprofiles#ListProfileObjectTypesRequest": { + "type": "structure", + "members": { + "DomainName": { + "target": "com.amazonaws.customerprofiles#name", + "traits": { + "smithy.api#documentation": "

The unique name of the domain.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.customerprofiles#token", + "traits": { + "smithy.api#documentation": "

Identifies the next page of results to return.

", + "smithy.api#httpQuery": "next-token" + } + }, + "MaxResults": { + "target": "com.amazonaws.customerprofiles#maxSize100", + "traits": { + "smithy.api#documentation": "

The maximum number of objects returned per page.

", + "smithy.api#httpQuery": "max-results" + } + } + } + }, + "com.amazonaws.customerprofiles#ListProfileObjectTypesResponse": { + "type": "structure", + "members": { + "Items": { + "target": "com.amazonaws.customerprofiles#ProfileObjectTypeList", + "traits": { + "smithy.api#documentation": "

The list of ListProfileObjectTypes instances.

" + } + }, + "NextToken": { + "target": "com.amazonaws.customerprofiles#token", + "traits": { + "smithy.api#documentation": "

Identifies the next page of results to return.

" + } + } + } + }, + "com.amazonaws.customerprofiles#ListProfileObjects": { + "type": "operation", + "input": { + "target": "com.amazonaws.customerprofiles#ListProfileObjectsRequest" + }, + "output": { + "target": "com.amazonaws.customerprofiles#ListProfileObjectsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.customerprofiles#AccessDeniedException" + }, + { + "target": "com.amazonaws.customerprofiles#BadRequestException" + }, + { + "target": "com.amazonaws.customerprofiles#InternalServerException" + }, + { + "target": "com.amazonaws.customerprofiles#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.customerprofiles#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of objects associated with a profile of a given ProfileObjectType.

", + "smithy.api#http": { + "method": "POST", + "uri": "/domains/{DomainName}/profiles/objects", + "code": 200 + } + } + }, + "com.amazonaws.customerprofiles#ListProfileObjectsItem": { + "type": "structure", + "members": { + "ObjectTypeName": { + "target": "com.amazonaws.customerprofiles#typeName", + "traits": { + "smithy.api#documentation": "

Specifies the kind of object being added to a profile, such as\n \"Salesforce-Account.\"

" + } + }, + "ProfileObjectUniqueKey": { + "target": "com.amazonaws.customerprofiles#string1To255", + "traits": { + "smithy.api#documentation": "

The unique identifier of the ProfileObject generated by the service.

" + } + }, + "Object": { + "target": "com.amazonaws.customerprofiles#stringifiedJson", + "traits": { + "smithy.api#documentation": "

A JSON representation of a ProfileObject that belongs to a profile.

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

A ProfileObject in a list of ProfileObjects.

" + } + }, + "com.amazonaws.customerprofiles#ListProfileObjectsRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.customerprofiles#token", + "traits": { + "smithy.api#documentation": "

The pagination token from the previous call to ListProfileObjects.

", + "smithy.api#httpQuery": "next-token" + } + }, + "MaxResults": { + "target": "com.amazonaws.customerprofiles#maxSize100", + "traits": { + "smithy.api#documentation": "

The maximum number of objects returned per page.

", + "smithy.api#httpQuery": "max-results" + } + }, + "DomainName": { + "target": "com.amazonaws.customerprofiles#name", + "traits": { + "smithy.api#documentation": "

The unique name of the domain.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ObjectTypeName": { + "target": "com.amazonaws.customerprofiles#typeName", + "traits": { + "smithy.api#documentation": "

The name of the profile object type.

", + "smithy.api#required": {} + } + }, + "ProfileId": { + "target": "com.amazonaws.customerprofiles#uuid", + "traits": { + "smithy.api#documentation": "

The unique identifier of a customer profile.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.customerprofiles#ListProfileObjectsResponse": { + "type": "structure", + "members": { + "Items": { + "target": "com.amazonaws.customerprofiles#ProfileObjectList", + "traits": { + "smithy.api#documentation": "

The list of ListProfileObject instances.

" + } + }, + "NextToken": { + "target": "com.amazonaws.customerprofiles#token", + "traits": { + "smithy.api#documentation": "

The pagination token from the previous call to ListProfileObjects.

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

Displays the tags associated with an Amazon Connect Customer Profiles resource. In\n Connect Customer Profiles, domains, profile object types, and integrations can be\n tagged.

", + "smithy.api#http": { + "method": "GET", + "uri": "/tags/{resourceArn}", + "code": 200 + } + } + }, + "com.amazonaws.customerprofiles#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.customerprofiles#TagArn", + "traits": { + "smithy.api#documentation": "

The ARN of the resource for which you want to view tags.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.customerprofiles#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "tags": { + "target": "com.amazonaws.customerprofiles#TagMap", + "traits": { + "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource.

" + } + } + } + }, + "com.amazonaws.customerprofiles#ObjectTypeField": { + "type": "structure", + "members": { + "Source": { + "target": "com.amazonaws.customerprofiles#text", + "traits": { + "smithy.api#documentation": "

A field of a ProfileObject. For example: _source.FirstName, where “_source” is a\n ProfileObjectType of a Zendesk user and “FirstName” is a field in that ObjectType.

" + } + }, + "Target": { + "target": "com.amazonaws.customerprofiles#text", + "traits": { + "smithy.api#documentation": "

The location of the data in the standard ProfileObject model. For example:\n _profile.Address.PostalCode.

" + } + }, + "ContentType": { + "target": "com.amazonaws.customerprofiles#FieldContentType", + "traits": { + "smithy.api#documentation": "

The content type of the field. Used for determining equality when searching.

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

Represents a field in a ProfileObjectType.

" + } + }, + "com.amazonaws.customerprofiles#ObjectTypeKey": { + "type": "structure", + "members": { + "StandardIdentifiers": { + "target": "com.amazonaws.customerprofiles#StandardIdentifierList", + "traits": { + "smithy.api#documentation": "

The types of keys that a ProfileObject can have. Each ProfileObject can have only 1\n UNIQUE key but multiple PROFILE keys. PROFILE means that this key can be used to tie an\n object to a PROFILE. UNIQUE means that it can be used to uniquely identify an object. If a\n key a is marked as SECONDARY, it will be used to search for profiles after all other\n PROFILE keys have been searched. A LOOKUP_ONLY key is only used to match a profile but is\n not persisted to be used for searching of the profile. A NEW_ONLY key is only used if the\n profile does not already exist before the object is ingested, otherwise it is only used for\n matching objects to profiles.

" + } + }, + "FieldNames": { + "target": "com.amazonaws.customerprofiles#FieldNameList", + "traits": { + "smithy.api#documentation": "

The reference for the key name of the fields map.

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

An object that defines the Key element of a ProfileObject. A Key is a special element\n that can be used to search for a customer profile.

" + } + }, + "com.amazonaws.customerprofiles#ObjectTypeKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.customerprofiles#ObjectTypeKey" + } + }, + "com.amazonaws.customerprofiles#PartyType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "INDIVIDUAL", + "name": "INDIVIDUAL" + }, + { + "value": "BUSINESS", + "name": "BUSINESS" + }, + { + "value": "OTHER", + "name": "OTHER" + } + ] + } + }, + "com.amazonaws.customerprofiles#Profile": { + "type": "structure", + "members": { + "ProfileId": { + "target": "com.amazonaws.customerprofiles#uuid", + "traits": { + "smithy.api#documentation": "

The unique identifier of a customer profile.

" + } + }, + "AccountNumber": { + "target": "com.amazonaws.customerprofiles#string1To255", + "traits": { + "smithy.api#documentation": "

A unique account number that you have given to the customer.

" + } + }, + "AdditionalInformation": { + "target": "com.amazonaws.customerprofiles#string1To1000", + "traits": { + "smithy.api#documentation": "

Any additional information relevant to the customer's profile.

" + } + }, + "PartyType": { + "target": "com.amazonaws.customerprofiles#PartyType", + "traits": { + "smithy.api#documentation": "

The type of profile used to describe the customer.

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

The name of the customer’s business.

" + } + }, + "FirstName": { + "target": "com.amazonaws.customerprofiles#string1To255", + "traits": { + "smithy.api#documentation": "

The customer’s first name.

" + } + }, + "MiddleName": { + "target": "com.amazonaws.customerprofiles#string1To255", + "traits": { + "smithy.api#documentation": "

The customer’s middle name.

" + } + }, + "LastName": { + "target": "com.amazonaws.customerprofiles#string1To255", + "traits": { + "smithy.api#documentation": "

The customer’s last name.

" + } + }, + "BirthDate": { + "target": "com.amazonaws.customerprofiles#string1To255", + "traits": { + "smithy.api#documentation": "

The customer’s birth date.

" + } + }, + "Gender": { + "target": "com.amazonaws.customerprofiles#Gender", + "traits": { + "smithy.api#documentation": "

The gender with which the customer identifies.

" + } + }, + "PhoneNumber": { + "target": "com.amazonaws.customerprofiles#string1To255", + "traits": { + "smithy.api#documentation": "

The customer's phone number, which has not been specified as a mobile, home, or business\n number.

" + } + }, + "MobilePhoneNumber": { + "target": "com.amazonaws.customerprofiles#string1To255", + "traits": { + "smithy.api#documentation": "

The customer’s mobile phone number.

" + } + }, + "HomePhoneNumber": { + "target": "com.amazonaws.customerprofiles#string1To255", + "traits": { + "smithy.api#documentation": "

The customer’s home phone number.

" + } + }, + "BusinessPhoneNumber": { + "target": "com.amazonaws.customerprofiles#string1To255", + "traits": { + "smithy.api#documentation": "

The customer’s home phone number.

" + } + }, + "EmailAddress": { + "target": "com.amazonaws.customerprofiles#string1To255", + "traits": { + "smithy.api#documentation": "

The customer's email address, which has not been specified as a personal or business\n address.

" + } + }, + "PersonalEmailAddress": { + "target": "com.amazonaws.customerprofiles#string1To255", + "traits": { + "smithy.api#documentation": "

The customer’s personal email address.

" + } + }, + "BusinessEmailAddress": { + "target": "com.amazonaws.customerprofiles#string1To255", + "traits": { + "smithy.api#documentation": "

The customer’s business email address.

" + } + }, + "Address": { + "target": "com.amazonaws.customerprofiles#Address", + "traits": { + "smithy.api#documentation": "

A generic address associated with the customer that is not mailing, shipping, or\n billing.

" + } + }, + "ShippingAddress": { + "target": "com.amazonaws.customerprofiles#Address", + "traits": { + "smithy.api#documentation": "

The customer’s shipping address.

" + } + }, + "MailingAddress": { + "target": "com.amazonaws.customerprofiles#Address", + "traits": { + "smithy.api#documentation": "

The customer’s mailing address.

" + } + }, + "BillingAddress": { + "target": "com.amazonaws.customerprofiles#Address", + "traits": { + "smithy.api#documentation": "

The customer’s billing address.

" + } + }, + "Attributes": { + "target": "com.amazonaws.customerprofiles#Attributes", + "traits": { + "smithy.api#documentation": "

A key value pair of attributes of a customer profile.

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

The standard profile of a customer.

" + } + }, + "com.amazonaws.customerprofiles#ProfileList": { + "type": "list", + "member": { + "target": "com.amazonaws.customerprofiles#Profile" + } + }, + "com.amazonaws.customerprofiles#ProfileObjectList": { + "type": "list", + "member": { + "target": "com.amazonaws.customerprofiles#ListProfileObjectsItem" + } + }, + "com.amazonaws.customerprofiles#ProfileObjectTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.customerprofiles#ListProfileObjectTypeItem" + } + }, + "com.amazonaws.customerprofiles#ProfileObjectTypeTemplateList": { + "type": "list", + "member": { + "target": "com.amazonaws.customerprofiles#ListProfileObjectTypeTemplateItem" + } + }, + "com.amazonaws.customerprofiles#PutIntegration": { + "type": "operation", + "input": { + "target": "com.amazonaws.customerprofiles#PutIntegrationRequest" + }, + "output": { + "target": "com.amazonaws.customerprofiles#PutIntegrationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.customerprofiles#AccessDeniedException" + }, + { + "target": "com.amazonaws.customerprofiles#BadRequestException" + }, + { + "target": "com.amazonaws.customerprofiles#InternalServerException" + }, + { + "target": "com.amazonaws.customerprofiles#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.customerprofiles#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Adds an integration between the service and a third-party service, which includes Amazon\n AppFlow and Amazon Connect.

\n

An integration can belong to only one domain.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/domains/{DomainName}/integrations", + "code": 200 + } + } + }, + "com.amazonaws.customerprofiles#PutIntegrationRequest": { + "type": "structure", + "members": { + "DomainName": { + "target": "com.amazonaws.customerprofiles#name", + "traits": { + "smithy.api#documentation": "

The unique name of the domain.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Uri": { + "target": "com.amazonaws.customerprofiles#string1To255", + "traits": { + "smithy.api#documentation": "

The URI of the S3 bucket or any other type of data source.

", + "smithy.api#required": {} + } + }, + "ObjectTypeName": { + "target": "com.amazonaws.customerprofiles#typeName", + "traits": { + "smithy.api#documentation": "

The name of the profile object type.

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

The tags used to organize, track, or control access for this resource.

" + } + } + } + }, + "com.amazonaws.customerprofiles#PutIntegrationResponse": { + "type": "structure", + "members": { + "DomainName": { + "target": "com.amazonaws.customerprofiles#name", + "traits": { + "smithy.api#documentation": "

The unique name of the domain.

", + "smithy.api#required": {} + } + }, + "Uri": { + "target": "com.amazonaws.customerprofiles#string1To255", + "traits": { + "smithy.api#documentation": "

The URI of the S3 bucket or any other type of data source.

", + "smithy.api#required": {} + } + }, + "ObjectTypeName": { + "target": "com.amazonaws.customerprofiles#typeName", + "traits": { + "smithy.api#documentation": "

The name of the profile object type.

", + "smithy.api#required": {} + } + }, + "CreatedAt": { + "target": "com.amazonaws.customerprofiles#timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp of when the domain was created.

", + "smithy.api#required": {} + } + }, + "LastUpdatedAt": { + "target": "com.amazonaws.customerprofiles#timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp of when the domain was most recently edited.

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

The tags used to organize, track, or control access for this resource.

" + } + } + } + }, + "com.amazonaws.customerprofiles#PutProfileObject": { + "type": "operation", + "input": { + "target": "com.amazonaws.customerprofiles#PutProfileObjectRequest" + }, + "output": { + "target": "com.amazonaws.customerprofiles#PutProfileObjectResponse" + }, + "errors": [ + { + "target": "com.amazonaws.customerprofiles#AccessDeniedException" + }, + { + "target": "com.amazonaws.customerprofiles#BadRequestException" + }, + { + "target": "com.amazonaws.customerprofiles#InternalServerException" + }, + { + "target": "com.amazonaws.customerprofiles#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.customerprofiles#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Adds additional objects to customer profiles of a given ObjectType.

\n

When adding a specific profile object, like a Contact Trace Record (CTR), an inferred\n profile can get created if it is not mapped to an existing profile. The resulting profile\n will only have a phone number populated in the standard ProfileObject. Any additional CTRs\n with the same phone number will be mapped to the same inferred profile.

\n

When a ProfileObject is created and if a ProfileObjectType already exists for the\n ProfileObject, it will provide data to a standard profile depending on the\n ProfileObjectType definition.

\n

PutProfileObject needs an ObjectType, which can be created using\n PutProfileObjectType.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/domains/{DomainName}/profiles/objects", + "code": 200 + } + } + }, + "com.amazonaws.customerprofiles#PutProfileObjectRequest": { + "type": "structure", + "members": { + "ObjectTypeName": { + "target": "com.amazonaws.customerprofiles#typeName", + "traits": { + "smithy.api#documentation": "

The name of the profile object type.

", + "smithy.api#required": {} + } + }, + "Object": { + "target": "com.amazonaws.customerprofiles#stringifiedJson", + "traits": { + "smithy.api#documentation": "

A string that is serialized from a JSON object.

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

The unique name of the domain.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.customerprofiles#PutProfileObjectResponse": { + "type": "structure", + "members": { + "ProfileObjectUniqueKey": { + "target": "com.amazonaws.customerprofiles#string1To255", + "traits": { + "smithy.api#documentation": "

The unique identifier of the profile object generated by the service.

" + } + } + } + }, + "com.amazonaws.customerprofiles#PutProfileObjectType": { + "type": "operation", + "input": { + "target": "com.amazonaws.customerprofiles#PutProfileObjectTypeRequest" + }, + "output": { + "target": "com.amazonaws.customerprofiles#PutProfileObjectTypeResponse" + }, + "errors": [ + { + "target": "com.amazonaws.customerprofiles#AccessDeniedException" + }, + { + "target": "com.amazonaws.customerprofiles#BadRequestException" + }, + { + "target": "com.amazonaws.customerprofiles#InternalServerException" + }, + { + "target": "com.amazonaws.customerprofiles#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.customerprofiles#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Defines a ProfileObjectType.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/domains/{DomainName}/object-types/{ObjectTypeName}", + "code": 200 + } + } + }, + "com.amazonaws.customerprofiles#PutProfileObjectTypeRequest": { + "type": "structure", + "members": { + "DomainName": { + "target": "com.amazonaws.customerprofiles#name", + "traits": { + "smithy.api#documentation": "

The unique name of the domain.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ObjectTypeName": { + "target": "com.amazonaws.customerprofiles#typeName", + "traits": { + "smithy.api#documentation": "

The name of the profile object type.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.customerprofiles#text", + "traits": { + "smithy.api#documentation": "

Description of the profile object type.

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

A unique identifier for the object template.

" + } + }, + "ExpirationDays": { + "target": "com.amazonaws.customerprofiles#expirationDaysInteger", + "traits": { + "smithy.api#documentation": "

The number of days until the data in the object expires.

" + } + }, + "EncryptionKey": { + "target": "com.amazonaws.customerprofiles#encryptionKey", + "traits": { + "smithy.api#documentation": "

The customer-provided key to encrypt the profile object that will be created in this\n profile object type.

" + } + }, + "AllowProfileCreation": { + "target": "com.amazonaws.customerprofiles#boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether a profile should be created when data is received if one doesn’t exist\n for an object of this type. The default is FALSE. If the AllowProfileCreation\n flag is set to FALSE, then the service tries to fetch a standard profile and\n associate this object with the profile. If it is set to TRUE, and if no match\n is found, then the service creates a new standard profile.

" + } + }, + "Fields": { + "target": "com.amazonaws.customerprofiles#FieldMap", + "traits": { + "smithy.api#documentation": "

A map of the name and ObjectType field.

" + } + }, + "Keys": { + "target": "com.amazonaws.customerprofiles#KeyMap", + "traits": { + "smithy.api#documentation": "

A list of unique keys that can be used to map data to the profile.

" + } + }, + "Tags": { + "target": "com.amazonaws.customerprofiles#TagMap", + "traits": { + "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource.

" + } + } + } + }, + "com.amazonaws.customerprofiles#PutProfileObjectTypeResponse": { + "type": "structure", + "members": { + "ObjectTypeName": { + "target": "com.amazonaws.customerprofiles#typeName", + "traits": { + "smithy.api#documentation": "

The name of the profile object type.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.customerprofiles#text", + "traits": { + "smithy.api#documentation": "

Description of the profile object type.

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

A unique identifier for the object template.

" + } + }, + "ExpirationDays": { + "target": "com.amazonaws.customerprofiles#expirationDaysInteger", + "traits": { + "smithy.api#documentation": "

The number of days until the data in the object expires.

" + } + }, + "EncryptionKey": { + "target": "com.amazonaws.customerprofiles#encryptionKey", + "traits": { + "smithy.api#documentation": "

The customer-provided key to encrypt the profile object that will be created in this\n profile object type.

" + } + }, + "AllowProfileCreation": { + "target": "com.amazonaws.customerprofiles#boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether a profile should be created when data is received if one doesn’t exist\n for an object of this type. The default is FALSE. If the AllowProfileCreation\n flag is set to FALSE, then the service tries to fetch a standard profile and\n associate this object with the profile. If it is set to TRUE, and if no match\n is found, then the service creates a new standard profile.

" + } + }, + "Fields": { + "target": "com.amazonaws.customerprofiles#FieldMap", + "traits": { + "smithy.api#documentation": "

A map of the name and ObjectType field.

" + } + }, + "Keys": { + "target": "com.amazonaws.customerprofiles#KeyMap", + "traits": { + "smithy.api#documentation": "

A list of unique keys that can be used to map data to the profile.

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

The timestamp of when the domain was created.

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

The timestamp of when the domain was most recently edited.

" + } + }, + "Tags": { + "target": "com.amazonaws.customerprofiles#TagMap", + "traits": { + "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource.

" + } + } + } + }, + "com.amazonaws.customerprofiles#ResourceNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.customerprofiles#message" + } + }, + "traits": { + "smithy.api#documentation": "

The requested resource does not exist, or access was denied.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.customerprofiles#SearchProfiles": { + "type": "operation", + "input": { + "target": "com.amazonaws.customerprofiles#SearchProfilesRequest" + }, + "output": { + "target": "com.amazonaws.customerprofiles#SearchProfilesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.customerprofiles#AccessDeniedException" + }, + { + "target": "com.amazonaws.customerprofiles#BadRequestException" + }, + { + "target": "com.amazonaws.customerprofiles#InternalServerException" + }, + { + "target": "com.amazonaws.customerprofiles#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.customerprofiles#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Searches for profiles within a specific domain name using name, phone number, email\n address, account number, or a custom defined index.

", + "smithy.api#http": { + "method": "POST", + "uri": "/domains/{DomainName}/profiles/search", + "code": 200 + } + } + }, + "com.amazonaws.customerprofiles#SearchProfilesRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.customerprofiles#token", + "traits": { + "smithy.api#documentation": "

The pagination token from the previous SearchProfiles API call.

", + "smithy.api#httpQuery": "next-token" + } + }, + "MaxResults": { + "target": "com.amazonaws.customerprofiles#maxSize100", + "traits": { + "smithy.api#documentation": "

The maximum number of objects returned per page.

", + "smithy.api#httpQuery": "max-results" + } + }, + "DomainName": { + "target": "com.amazonaws.customerprofiles#name", + "traits": { + "smithy.api#documentation": "

The unique name of the domain.

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

A searchable identifier of a customer profile. The predefined keys you can use to search\n include: _account, _profileId, _fullName, _phone, _email, _ctrContactId, _marketoLeadId,\n _salesforceAccountId, _salesforceContactId, _zendeskUserId, _zendeskExternalId,\n _serviceNowSystemId.

", + "smithy.api#required": {} + } + }, + "Values": { + "target": "com.amazonaws.customerprofiles#requestValueList", + "traits": { + "smithy.api#documentation": "

A list of key values.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.customerprofiles#SearchProfilesResponse": { + "type": "structure", + "members": { + "Items": { + "target": "com.amazonaws.customerprofiles#ProfileList", + "traits": { + "smithy.api#documentation": "

The list of SearchProfiles instances.

" + } + }, + "NextToken": { + "target": "com.amazonaws.customerprofiles#token", + "traits": { + "smithy.api#documentation": "

The pagination token from the previous SearchProfiles API call.

" + } + } + } + }, + "com.amazonaws.customerprofiles#StandardIdentifier": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PROFILE", + "name": "PROFILE" + }, + { + "value": "UNIQUE", + "name": "UNIQUE" + }, + { + "value": "SECONDARY", + "name": "SECONDARY" + }, + { + "value": "LOOKUP_ONLY", + "name": "LOOKUP_ONLY" + }, + { + "value": "NEW_ONLY", + "name": "NEW_ONLY" + } + ] + } + }, + "com.amazonaws.customerprofiles#StandardIdentifierList": { + "type": "list", + "member": { + "target": "com.amazonaws.customerprofiles#StandardIdentifier" + } + }, + "com.amazonaws.customerprofiles#TagArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^arn:[a-z0-9]{1,10}:profile" + } + }, + "com.amazonaws.customerprofiles#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$" + } + }, + "com.amazonaws.customerprofiles#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.customerprofiles#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.customerprofiles#TagMap": { + "type": "map", + "key": { + "target": "com.amazonaws.customerprofiles#TagKey" + }, + "value": { + "target": "com.amazonaws.customerprofiles#TagValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.customerprofiles#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.customerprofiles#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.customerprofiles#TagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.customerprofiles#BadRequestException" + }, + { + "target": "com.amazonaws.customerprofiles#InternalServerException" + }, + { + "target": "com.amazonaws.customerprofiles#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Assigns one or more tags (key-value pairs) to the specified Amazon Connect Customer\n Profiles resource. Tags can help you organize and categorize your resources. You can also\n use them to scope user permissions by granting a user permission to access or change only\n resources with certain tag values. In Connect Customer Profiles, domains, profile object\n types, and integrations can be tagged.

\n

Tags don't have any semantic meaning to AWS and are interpreted strictly as strings of\n characters.

\n

You can use the TagResource action with a resource that already has tags. If you specify\n a new tag key, this tag is appended to the list of tags associated with the resource. If\n you specify a tag key that is already associated with the resource, the new tag value that\n you specify replaces the previous value for that tag.

\n

You can associate as many as 50 tags with a resource.

", + "smithy.api#http": { + "method": "POST", + "uri": "/tags/{resourceArn}", + "code": 200 + } + } + }, + "com.amazonaws.customerprofiles#TagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.customerprofiles#TagArn", + "traits": { + "smithy.api#documentation": "

The ARN of the resource that you're adding tags to.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.customerprofiles#TagMap", + "traits": { + "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.customerprofiles#TagResourceResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.customerprofiles#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.customerprofiles#ThrottlingException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.customerprofiles#message" + } + }, + "traits": { + "smithy.api#documentation": "

You exceeded the maximum number of requests.

", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, + "com.amazonaws.customerprofiles#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.customerprofiles#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.customerprofiles#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.customerprofiles#BadRequestException" + }, + { + "target": "com.amazonaws.customerprofiles#InternalServerException" + }, + { + "target": "com.amazonaws.customerprofiles#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes one or more tags from the specified Amazon Connect Customer Profiles resource.\n In Connect Customer Profiles, domains, profile object types, and integrations can be\n tagged.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/tags/{resourceArn}", + "code": 200 + } + } + }, + "com.amazonaws.customerprofiles#UntagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.customerprofiles#TagArn", + "traits": { + "smithy.api#documentation": "

The ARN of the resource from which you are removing tags.

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

The list of tag keys to remove from the resource.

", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.customerprofiles#UntagResourceResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.customerprofiles#UpdateAddress": { + "type": "structure", + "members": { + "Address1": { + "target": "com.amazonaws.customerprofiles#string0To255", + "traits": { + "smithy.api#documentation": "

The first line of a customer address.

" + } + }, + "Address2": { + "target": "com.amazonaws.customerprofiles#string0To255", + "traits": { + "smithy.api#documentation": "

The second line of a customer address.

" + } + }, + "Address3": { + "target": "com.amazonaws.customerprofiles#string0To255", + "traits": { + "smithy.api#documentation": "

The third line of a customer address.

" + } + }, + "Address4": { + "target": "com.amazonaws.customerprofiles#string0To255", + "traits": { + "smithy.api#documentation": "

The fourth line of a customer address.

" + } + }, + "City": { + "target": "com.amazonaws.customerprofiles#string0To255", + "traits": { + "smithy.api#documentation": "

The city in which a customer lives.

" + } + }, + "County": { + "target": "com.amazonaws.customerprofiles#string0To255", + "traits": { + "smithy.api#documentation": "

The county in which a customer lives.

" + } + }, + "State": { + "target": "com.amazonaws.customerprofiles#string0To255", + "traits": { + "smithy.api#documentation": "

The state in which a customer lives.

" + } + }, + "Province": { + "target": "com.amazonaws.customerprofiles#string0To255", + "traits": { + "smithy.api#documentation": "

The province in which a customer lives.

" + } + }, + "Country": { + "target": "com.amazonaws.customerprofiles#string0To255", + "traits": { + "smithy.api#documentation": "

The country in which a customer lives.

" + } + }, + "PostalCode": { + "target": "com.amazonaws.customerprofiles#string0To255", + "traits": { + "smithy.api#documentation": "

The postal code of a customer address.

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

Updates associated with the address properties of a customer profile.

" + } + }, + "com.amazonaws.customerprofiles#UpdateAttributes": { + "type": "map", + "key": { + "target": "com.amazonaws.customerprofiles#string1To255" + }, + "value": { + "target": "com.amazonaws.customerprofiles#string0To255" + } + }, + "com.amazonaws.customerprofiles#UpdateDomain": { + "type": "operation", + "input": { + "target": "com.amazonaws.customerprofiles#UpdateDomainRequest" + }, + "output": { + "target": "com.amazonaws.customerprofiles#UpdateDomainResponse" + }, + "errors": [ + { + "target": "com.amazonaws.customerprofiles#AccessDeniedException" + }, + { + "target": "com.amazonaws.customerprofiles#BadRequestException" + }, + { + "target": "com.amazonaws.customerprofiles#InternalServerException" + }, + { + "target": "com.amazonaws.customerprofiles#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.customerprofiles#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the properties of a domain, including creating or selecting a dead letter queue\n or an encryption key.

\n

Once a domain is created, the name can’t be changed.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/domains/{DomainName}", + "code": 200 + } + } + }, + "com.amazonaws.customerprofiles#UpdateDomainRequest": { + "type": "structure", + "members": { + "DomainName": { + "target": "com.amazonaws.customerprofiles#name", + "traits": { + "smithy.api#documentation": "

The unique name for the domain.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DefaultExpirationDays": { + "target": "com.amazonaws.customerprofiles#expirationDaysInteger", + "traits": { + "smithy.api#documentation": "

The default number of days until the data within the domain expires.

" + } + }, + "DefaultEncryptionKey": { + "target": "com.amazonaws.customerprofiles#encryptionKey", + "traits": { + "smithy.api#documentation": "

The default encryption key, which is an AWS managed key, is used when no specific type\n of encryption key is specified. It is used to encrypt all data before it is placed in\n permanent or semi-permanent storage. If specified as an empty string, it will clear any\n existing value.

" + } + }, + "DeadLetterQueueUrl": { + "target": "com.amazonaws.customerprofiles#sqsQueueUrl", + "traits": { + "smithy.api#documentation": "

The URL of the SQS dead letter queue, which is used for reporting errors associated with\n ingesting data from third party applications. If specified as an empty string, it will\n clear any existing value. You must set up a policy on the DeadLetterQueue for the\n SendMessage operation to enable Amazon Connect Customer Profiles to send messages to the\n DeadLetterQueue.

" + } + }, + "Tags": { + "target": "com.amazonaws.customerprofiles#TagMap", + "traits": { + "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource.

" + } + } + } + }, + "com.amazonaws.customerprofiles#UpdateDomainResponse": { + "type": "structure", + "members": { + "DomainName": { + "target": "com.amazonaws.customerprofiles#name", + "traits": { + "smithy.api#documentation": "

The unique name for the domain.

", + "smithy.api#required": {} + } + }, + "DefaultExpirationDays": { + "target": "com.amazonaws.customerprofiles#expirationDaysInteger", + "traits": { + "smithy.api#documentation": "

The default number of days until the data within the domain expires.

" + } + }, + "DefaultEncryptionKey": { + "target": "com.amazonaws.customerprofiles#encryptionKey", + "traits": { + "smithy.api#documentation": "

The default encryption key, which is an AWS managed key, is used when no specific type\n of encryption key is specified. It is used to encrypt all data before it is placed in\n permanent or semi-permanent storage.

" + } + }, + "DeadLetterQueueUrl": { + "target": "com.amazonaws.customerprofiles#sqsQueueUrl", + "traits": { + "smithy.api#documentation": "

The URL of the SQS dead letter queue, which is used for reporting errors associated with\n ingesting data from third party applications.

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

The timestamp of when the domain was created.

", + "smithy.api#required": {} + } + }, + "LastUpdatedAt": { + "target": "com.amazonaws.customerprofiles#timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp of when the domain was most recently edited.

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

The tags used to organize, track, or control access for this resource.

" + } + } + } + }, + "com.amazonaws.customerprofiles#UpdateProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.customerprofiles#UpdateProfileRequest" + }, + "output": { + "target": "com.amazonaws.customerprofiles#UpdateProfileResponse" + }, + "errors": [ + { + "target": "com.amazonaws.customerprofiles#AccessDeniedException" + }, + { + "target": "com.amazonaws.customerprofiles#BadRequestException" + }, + { + "target": "com.amazonaws.customerprofiles#InternalServerException" + }, + { + "target": "com.amazonaws.customerprofiles#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.customerprofiles#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the properties of a profile. The ProfileId is required for updating a customer\n profile.

\n

When calling the UpdateProfile API, specifying an empty string value means that any\n existing value will be removed. Not specifying a string value means that any value already\n there will be kept.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/domains/{DomainName}/profiles", + "code": 200 + } + } + }, + "com.amazonaws.customerprofiles#UpdateProfileRequest": { + "type": "structure", + "members": { + "DomainName": { + "target": "com.amazonaws.customerprofiles#name", + "traits": { + "smithy.api#documentation": "

The unique name of the domain.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ProfileId": { + "target": "com.amazonaws.customerprofiles#uuid", + "traits": { + "smithy.api#documentation": "

The unique identifier of a customer profile.

", + "smithy.api#required": {} + } + }, + "AdditionalInformation": { + "target": "com.amazonaws.customerprofiles#string0To1000", + "traits": { + "smithy.api#documentation": "

Any additional information relevant to the customer's profile.

" + } + }, + "AccountNumber": { + "target": "com.amazonaws.customerprofiles#string0To255", + "traits": { + "smithy.api#documentation": "

A unique account number that you have given to the customer.

" + } + }, + "PartyType": { + "target": "com.amazonaws.customerprofiles#PartyType", + "traits": { + "smithy.api#documentation": "

The type of profile used to describe the customer.

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

The name of the customer’s business.

" + } + }, + "FirstName": { + "target": "com.amazonaws.customerprofiles#string0To255", + "traits": { + "smithy.api#documentation": "

The customer’s first name.

" + } + }, + "MiddleName": { + "target": "com.amazonaws.customerprofiles#string0To255", + "traits": { + "smithy.api#documentation": "

The customer’s middle name.

" + } + }, + "LastName": { + "target": "com.amazonaws.customerprofiles#string0To255", + "traits": { + "smithy.api#documentation": "

The customer’s last name.

" + } + }, + "BirthDate": { + "target": "com.amazonaws.customerprofiles#string0To255", + "traits": { + "smithy.api#documentation": "

The customer’s birth date.

" + } + }, + "Gender": { + "target": "com.amazonaws.customerprofiles#Gender", + "traits": { + "smithy.api#documentation": "

The gender with which the customer identifies.

" + } + }, + "PhoneNumber": { + "target": "com.amazonaws.customerprofiles#string0To255", + "traits": { + "smithy.api#documentation": "

The customer's phone number, which has not been specified as a mobile, home, or business\n number.

" + } + }, + "MobilePhoneNumber": { + "target": "com.amazonaws.customerprofiles#string0To255", + "traits": { + "smithy.api#documentation": "

The customer’s mobile phone number.

" + } + }, + "HomePhoneNumber": { + "target": "com.amazonaws.customerprofiles#string0To255", + "traits": { + "smithy.api#documentation": "

The customer’s home phone number.

" + } + }, + "BusinessPhoneNumber": { + "target": "com.amazonaws.customerprofiles#string0To255", + "traits": { + "smithy.api#documentation": "

The customer’s business phone number.

" + } + }, + "EmailAddress": { + "target": "com.amazonaws.customerprofiles#string0To255", + "traits": { + "smithy.api#documentation": "

The customer's email address, which has not been specified as a personal or business\n address.

" + } + }, + "PersonalEmailAddress": { + "target": "com.amazonaws.customerprofiles#string0To255", + "traits": { + "smithy.api#documentation": "

The customer’s personal email address.

" + } + }, + "BusinessEmailAddress": { + "target": "com.amazonaws.customerprofiles#string0To255", + "traits": { + "smithy.api#documentation": "

The customer’s business email address.

" + } + }, + "Address": { + "target": "com.amazonaws.customerprofiles#UpdateAddress", + "traits": { + "smithy.api#documentation": "

A generic address associated with the customer that is not mailing, shipping, or\n billing.

" + } + }, + "ShippingAddress": { + "target": "com.amazonaws.customerprofiles#UpdateAddress", + "traits": { + "smithy.api#documentation": "

The customer’s shipping address.

" + } + }, + "MailingAddress": { + "target": "com.amazonaws.customerprofiles#UpdateAddress", + "traits": { + "smithy.api#documentation": "

The customer’s mailing address.

" + } + }, + "BillingAddress": { + "target": "com.amazonaws.customerprofiles#UpdateAddress", + "traits": { + "smithy.api#documentation": "

The customer’s billing address.

" + } + }, + "Attributes": { + "target": "com.amazonaws.customerprofiles#UpdateAttributes", + "traits": { + "smithy.api#documentation": "

A key value pair of attributes of a customer profile.

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

The unique identifier of a customer profile.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.customerprofiles#boolean": { + "type": "boolean" + }, + "com.amazonaws.customerprofiles#encryptionKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + } + } + }, + "com.amazonaws.customerprofiles#expirationDaysInteger": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1, + "max": 1098 + } + } + }, + "com.amazonaws.customerprofiles#long": { + "type": "long" + }, + "com.amazonaws.customerprofiles#maxSize100": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.customerprofiles#message": { + "type": "string" + }, + "com.amazonaws.customerprofiles#name": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_-]+$" + } + }, + "com.amazonaws.customerprofiles#requestValueList": { + "type": "list", + "member": { + "target": "com.amazonaws.customerprofiles#string1To255" + } + }, + "com.amazonaws.customerprofiles#sqsQueueUrl": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + } + } + }, + "com.amazonaws.customerprofiles#string0To1000": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1000 + } + } + }, + "com.amazonaws.customerprofiles#string0To255": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + } + } + }, + "com.amazonaws.customerprofiles#string1To1000": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.customerprofiles#string1To255": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.customerprofiles#stringifiedJson": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256000 + } + } + }, + "com.amazonaws.customerprofiles#text": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.customerprofiles#timestamp": { + "type": "timestamp" + }, + "com.amazonaws.customerprofiles#token": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.customerprofiles#typeName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[a-zA-Z_][a-zA-Z_0-9-]*$" + } + }, + "com.amazonaws.customerprofiles#uuid": { + "type": "string", + "traits": { + "smithy.api#pattern": "[a-f0-9]{32}" + } + } + } +} diff --git a/codegen/sdk-codegen/aws-models/databasemigrationservice.2016-01-01.json b/codegen/sdk-codegen/aws-models/databasemigrationservice.2016-01-01.json index 45f34f105be..1ec406715bc 100644 --- a/codegen/sdk-codegen/aws-models/databasemigrationservice.2016-01-01.json +++ b/codegen/sdk-codegen/aws-models/databasemigrationservice.2016-01-01.json @@ -3881,6 +3881,18 @@ "traits": { "smithy.api#documentation": "

The AWS KMS key identifier that is used to encrypt the content on the replication\n instance. If you don't specify a value for the KmsKeyId parameter, then\n AWS DMS uses your default encryption key. AWS KMS creates the default encryption key for\n your AWS account. Your AWS account has a different default encryption key for each AWS\n Region.

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

The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the\n trusted entity and grants the required permissions to access the value in\n SecretsManagerSecret. SecretsManagerSecret has the value of the AWS Secrets\n Manager secret that allows access to the DocumentDB endpoint.

\n \n

You can specify one of two sets of values for these permissions. You can specify the\n values for this setting and SecretsManagerSecretId. Or you can specify\n clear-text values for UserName, Password,\n ServerName, and Port. You can't specify both. For more\n information on creating this SecretsManagerSecret and the\n SecretsManagerAccessRoleArn and SecretsManagerSecretId\n required to access it, see Using secrets to access AWS Database Migration Service\n resources in the AWS Database Migration Service User\n Guide.

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

The full ARN, partial ARN, or friendly name of the SecretsManagerSecret\n that contains the DocumentDB endpoint connection details.

" + } } }, "traits": { @@ -4366,7 +4378,7 @@ } }, "traits": { - "smithy.api#documentation": "

Identifies the name and value of a filter object. This filter is used to limit the\n number and type of AWS DMS objects that are returned for a particular\n Describe* call or similar operation. Filters are used as an \n optional parameter to the following APIs.

" + "smithy.api#documentation": "

Identifies the name and value of a filter object. This filter is used to limit the\n number and type of AWS DMS objects that are returned for a particular\n Describe* call or similar operation. Filters are used as an optional\n parameter for certain API operations.

" } }, "com.amazonaws.databasemigrationservice#FilterList": { @@ -4437,6 +4449,18 @@ "traits": { "smithy.api#documentation": "

Endpoint connection user name.

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

The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the\n trusted entity and grants the required permissions to access the value in\n SecretsManagerSecret. SecretsManagerSecret has the value of\n the AWS Secrets Manager secret that allows access to the Db2 LUW endpoint.

\n \n

You can specify one of two sets of values for these permissions. You can specify the\n values for this setting and SecretsManagerSecretId. Or you can specify\n clear-text values for UserName, Password,\n ServerName, and Port. You can't specify both. For more\n information on creating this SecretsManagerSecret and the\n SecretsManagerAccessRoleArn and SecretsManagerSecretId\n required to access it, see Using secrets to access AWS Database Migration Service\n resources in the AWS Database Migration Service User\n Guide.

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

The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the Db2 LUW endpoint connection details.

" + } } }, "traits": { @@ -4896,7 +4920,7 @@ "ControlTablesFileGroup": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

Specify a filegroup for the AWS DMS internal tables.\n When the replication task starts, all the internal AWS DMS\n control tables (awsdms_ apply_exception, awsdms_apply,\n awsdms_changes) are created on the specified filegroup.

" + "smithy.api#documentation": "

Specifies a file group for the AWS DMS internal tables. When the replication task\n starts, all the internal AWS DMS control tables (awsdms_ apply_exception, awsdms_apply,\n awsdms_changes) are created for the specified file group.

" } }, "Password": { @@ -4934,6 +4958,18 @@ "traits": { "smithy.api#documentation": "

Use this to attribute to transfer data for full-load operations\n using BCP. When the target table contains an identity\n column that does not exist in the source table, you must\n disable the use BCP for loading table option.

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

The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the\n trusted entity and grants the required permissions to access the value in\n SecretsManagerSecret. SecretsManagerSecret has the value of the AWS Secrets\n Manager secret that allows access to the SQL Server endpoint.

\n \n

You can specify one of two sets of values for these permissions. You can specify the\n values for this setting and SecretsManagerSecretId. Or you can specify\n clear-text values for UserName, Password,\n ServerName, and Port. You can't specify both. For more\n information on creating this SecretsManagerSecret and the\n SecretsManagerAccessRoleArn and SecretsManagerSecretId\n required to access it, see Using secrets to access AWS Database Migration Service\n resources in the AWS Database Migration Service User\n Guide.

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

The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the SQL Server endpoint connection details.

" + } } }, "traits": { @@ -5378,7 +5414,7 @@ "AutoMinorVersionUpgrade": { "target": "com.amazonaws.databasemigrationservice#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates that minor version upgrades are applied automatically to the\n replication instance during the maintenance window. Changing this parameter doesn't result\n in an outage, except in the case dsecribed following. The change is asynchronously applied\n as soon as possible.

\n

An outage does result if these factors apply:

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

A value that indicates that minor version upgrades are applied automatically to the\n replication instance during the maintenance window. Changing this parameter doesn't result\n in an outage, except in the case described following. The change is asynchronously applied\n as soon as possible.

\n

An outage does result if these factors apply:

\n " } }, "ReplicationInstanceIdentifier": { @@ -5657,6 +5693,18 @@ "traits": { "smithy.api#documentation": "

The AWS KMS key identifier that is used to encrypt the content on the replication\n instance. If you don't specify a value for the KmsKeyId parameter, then\n AWS DMS uses your default encryption key. AWS KMS creates the default encryption key for\n your AWS account. Your AWS account has a different default encryption key for each AWS\n Region.

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

The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the\n trusted entity and grants the required permissions to access the value in\n SecretsManagerSecret. SecretsManagerSecret has the value of the AWS Secrets\n Manager secret that allows access to the MongoDB endpoint.

\n \n

You can specify one of two sets of values for these permissions. You can specify the\n values for this setting and SecretsManagerSecretId. Or you can specify\n clear-text values for UserName, Password,\n ServerName, and Port. You can't specify both. For more\n information on creating this SecretsManagerSecret and the\n SecretsManagerAccessRoleArn and SecretsManagerSecretId\n required to access it, see Using secrets to access AWS Database Migration Service\n resources in the AWS Database Migration Service User\n Guide.

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

The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the MongoDB endpoint connection details.

" + } } }, "traits": { @@ -5758,7 +5806,7 @@ "ParallelLoadThreads": { "target": "com.amazonaws.databasemigrationservice#IntegerOptional", "traits": { - "smithy.api#documentation": "

Improves performance when loading data into the MySQLcompatible\n target database. Specifies how many threads\n to use to load the data into the MySQL-compatible target\n database. Setting a large number of threads can have an\n adverse effect on database performance, because a separate\n connection is required for each thread.

\n

Example: parallelLoadThreads=1\n

" + "smithy.api#documentation": "

Improves performance when loading data into the MySQL-compatible target database.\n Specifies how many threads to use to load the data into the MySQL-compatible target\n database. Setting a large number of threads can have an adverse effect on database\n performance, because a separate connection is required for each thread.

\n

Example: parallelLoadThreads=1\n

" } }, "Password": { @@ -5790,6 +5838,18 @@ "traits": { "smithy.api#documentation": "

Endpoint connection user name.

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

The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the\n trusted entity and grants the required permissions to access the value in\n SecretsManagerSecret. SecretsManagerSecret has the value of the AWS Secrets\n Manager secret that allows access to the MySQL endpoint.

\n \n

You can specify one of two sets of values for these permissions. You can specify the\n values for this setting and SecretsManagerSecretId. Or you can specify\n clear-text values for UserName, Password,\n ServerName, and Port. You can't specify both. For more\n information on creating this SecretsManagerSecret and the\n SecretsManagerAccessRoleArn and SecretsManagerSecretId\n required to access it, see Using secrets to access AWS Database Migration Service\n resources in the AWS Database Migration Service User\n Guide.

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

The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the MySQL endpoint connection details.

" + } } }, "traits": { @@ -6045,6 +6105,18 @@ "traits": { "smithy.api#documentation": "

Endpoint connection user name.

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

The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the\n trusted entity and grants the required permissions to access the value in\n SecretsManagerSecret. SecretsManagerSecret has the value of the AWS Secrets\n Manager secret that allows access to the Oracle endpoint.

\n \n

You can specify one of two sets of values for these permissions. You can specify the\n values for this setting and SecretsManagerSecretId. Or you can specify\n clear-text values for UserName, Password,\n ServerName, and Port. You can't specify both. For more\n information on creating this SecretsManagerSecret and the\n SecretsManagerAccessRoleArn and SecretsManagerSecretId\n required to access it, see Using secrets to access AWS Database Migration Service\n resources in the AWS Database Migration Service User\n Guide.

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

The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the Oracle endpoint connection details.

" + } } }, "traits": { @@ -6273,6 +6345,18 @@ "traits": { "smithy.api#documentation": "

Sets the name of a previously created logical replication slot\n for a CDC load of the PostgreSQL source instance.

\n

When used with the AWS DMS API CdcStartPosition\n request parameter, this attribute also enables using native\n CDC start points.

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

The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the\n trusted entity and grants the required permissions to access the value in\n SecretsManagerSecret. SecretsManagerSecret has the value of the AWS Secrets\n Manager secret that allows access to the PostgreSQL endpoint.

\n \n

You can specify one of two sets of values for these permissions. You can specify the\n values for this setting and SecretsManagerSecretId. Or you can specify\n clear-text values for UserName, Password,\n ServerName, and Port. You can't specify both. For more\n information on creating this SecretsManagerSecret and the\n SecretsManagerAccessRoleArn and SecretsManagerSecretId\n required to access it, see Using secrets to access AWS Database Migration Service\n resources in the AWS Database Migration Service User\n Guide.

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

The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the PostgreSQL endpoint connection details.

" + } } }, "traits": { @@ -6346,7 +6430,7 @@ "BucketFolder": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

An S3 folder where the comma-separated-value (.csv) files are stored before being \n uploaded to the target Redshift cluster.

\n

For full load mode, AWS DMS converts source records into .csv files and loads them to\n the BucketFolder/TableID path. AWS DMS uses the Redshift\n COPY command to upload the .csv files to the target table. The files are\n deleted once the COPY operation has finished. For more information, see Amazon Redshift Database\n Developer Guide\n

\n

For change-data-capture (CDC) mode, AWS DMS creates a NetChanges table, \n and loads the .csv files to this BucketFolder/NetChangesTableID path.

" + "smithy.api#documentation": "

An S3 folder where the comma-separated-value (.csv) files are stored before being \n uploaded to the target Redshift cluster.

\n

For full load mode, AWS DMS converts source records into .csv files and loads them to\n the BucketFolder/TableID path. AWS DMS uses the Redshift\n COPY command to upload the .csv files to the target table. The files are\n deleted once the COPY operation has finished. For more information, see COPY in the\n Amazon Redshift Database Developer Guide.

\n

For change-data-capture (CDC) mode, AWS DMS creates a NetChanges table, \n and loads the .csv files to this BucketFolder/NetChangesTableID path.

" } }, "BucketName": { @@ -6498,6 +6582,18 @@ "traits": { "smithy.api#documentation": "

The size (in KB) of the in-memory file write buffer used when generating .csv files \n on the local disk at the DMS replication instance. The default value is 1000 \n (buffer size is 1000KB).

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

The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the\n trusted entity and grants the required permissions to access the value in\n SecretsManagerSecret. SecretsManagerSecret has the value of the AWS Secrets\n Manager secret that allows access to the Amazon Redshift endpoint.

\n \n

You can specify one of two sets of values for these permissions. You can specify the\n values for this setting and SecretsManagerSecretId. Or you can specify\n clear-text values for UserName, Password,\n ServerName, and Port. You can't specify both. For more\n information on creating this SecretsManagerSecret and the\n SecretsManagerAccessRoleArn and SecretsManagerSecretId\n required to access it, see Using secrets to access AWS Database Migration Service\n resources in the AWS Database Migration Service User\n Guide.

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

The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the Amazon Redshift endpoint connection details.

" + } } }, "traits": { @@ -7720,25 +7816,25 @@ "UseCsvNoSupValue": { "target": "com.amazonaws.databasemigrationservice#BooleanOptional", "traits": { - "smithy.api#documentation": "

This setting applies if the S3 output files during a change data capture (CDC) load are\n written in .csv format. If set to true for columns not included in the\n supplemental log, AWS DMS uses the value specified by \n CsvNoSupValue\n . If not set or set to false, AWS DMS\n uses the null value for these columns.

\n \n

This setting is supported in AWS DMS versions 3.4.1 and later.

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

This setting applies if the S3 output files during a change data capture (CDC) load are\n written in .csv format. If set to true for columns not included in the\n supplemental log, AWS DMS uses the value specified by \n CsvNoSupValue\n . If not set or set to\n false, AWS DMS uses the null value for these columns.

\n \n

This setting is supported in AWS DMS versions 3.4.1 and later.

\n " } }, "CsvNoSupValue": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

This setting only applies if your Amazon S3 output files during a change data capture\n (CDC) load are written in .csv format. If \n UseCsvNoSupValue\n is set to true, specify a string value that\n you want AWS DMS to use for all columns not included in the supplemental log. If you do not\n specify a string value, AWS DMS uses the null value for these columns regardless of the\n UseCsvNoSupValue setting.

\n \n

This setting is supported in AWS DMS versions 3.4.1 and later.

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

This setting only applies if your Amazon S3 output files during a change data capture\n (CDC) load are written in .csv format. If \n UseCsvNoSupValue\n is set to true, specify a\n string value that you want AWS DMS to use for all columns not included in the supplemental\n log. If you do not specify a string value, AWS DMS uses the null value for these columns\n regardless of the UseCsvNoSupValue setting.

\n \n

This setting is supported in AWS DMS versions 3.4.1 and later.

\n " } }, "PreserveTransactions": { "target": "com.amazonaws.databasemigrationservice#BooleanOptional", "traits": { - "smithy.api#documentation": "

If set to true, AWS DMS saves the transaction order for a change data\n capture (CDC) load on the Amazon S3 target specified by \n CdcPath\n .

\n \n

This setting is supported in AWS DMS versions 3.4.2 and later.

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

If set to true, AWS DMS saves the transaction order for a change data\n capture (CDC) load on the Amazon S3 target specified by \n CdcPath\n . For more information, see Capturing data changes (CDC) including transaction order on the S3\n target.

\n \n

This setting is supported in AWS DMS versions 3.4.2 and later.

\n " } }, "CdcPath": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

Specifies the folder path of CDC files. For an S3 source, this setting is required if a\n task captures change data; otherwise, it's optional. If CdcPath is set, AWS\n DMS reads CDC files from this path and replicates the data changes to the target endpoint.\n For an S3 target, if CdcPathis set, it is the folder path where data changes\n are replicated. If you set \n PreserveTransactions\n to true, AWS DMS verifies\n that you have set this parameter to a folder path on your S3 target where AWS DMS can save\n the transaction order for the CDC load. AWS DMS creates this CDC folder path in either your\n S3 target working directory or the S3 target location specified by \n BucketFolder\n and \n BucketName\n .

\n

For example, if you specify CdcPath as MyChangedData, and you\n specify BucketName as MyTargetBucket but do not specify\n BucketFolder, AWS DMS creates the CDC folder path following:\n MyTargetBucket/MyChangedData.

\n

If you specify the same CdcPath, and you specify BucketName as\n MyTargetBucket and BucketFolder as MyTargetData,\n AWS DMS creates the CDC folder path following:\n MyTargetBucket/MyTargetData/MyChangedData.

\n \n

This setting is supported in AWS DMS versions 3.4.2 and later.

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

Specifies the folder path of CDC files. For an S3 source, this setting is required if a\n task captures change data; otherwise, it's optional. If CdcPath is set, AWS\n DMS reads CDC files from this path and replicates the data changes to the target endpoint.\n For an S3 target if you set \n PreserveTransactions\n to true, AWS\n DMS verifies that you have set this parameter to a folder path on your S3 target where AWS\n DMS can save the transaction order for the CDC load. AWS DMS creates this CDC folder path\n in either your S3 target working directory or the S3 target location specified by \n BucketFolder\n and \n BucketName\n .

\n

For example, if you specify CdcPath as MyChangedData, and you\n specify BucketName as MyTargetBucket but do not specify\n BucketFolder, AWS DMS creates the CDC folder path following:\n MyTargetBucket/MyChangedData.

\n

If you specify the same CdcPath, and you specify BucketName as\n MyTargetBucket and BucketFolder as MyTargetData,\n AWS DMS creates the CDC folder path following:\n MyTargetBucket/MyTargetData/MyChangedData.

\n

For more information on CDC including transaction order on an S3 target, see Capturing data changes (CDC) including transaction order on the S3\n target.

\n \n

This setting is supported in AWS DMS versions 3.4.2 and later.

\n " } } }, @@ -7821,7 +7917,8 @@ "traits": { "smithy.api#enum": [ { - "value": "replication-instance" + "value": "replication-instance", + "name": "replication_instance" } ] } @@ -8306,6 +8403,18 @@ "traits": { "smithy.api#documentation": "

Endpoint connection user name.

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

The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the\n trusted entity and grants the required permissions to access the value in\n SecretsManagerSecret. SecretsManagerSecret has the value of the AWS Secrets\n Manager secret that allows access to the SAP ASE endpoint.

\n \n

You can specify one of two sets of values for these permissions. You can specify the\n values for this setting and SecretsManagerSecretId. Or you can specify\n clear-text values for UserName, Password,\n ServerName, and Port. You can't specify both. For more\n information on creating this SecretsManagerSecret and the\n SecretsManagerAccessRoleArn and SecretsManagerSecretId\n required to access it, see Using secrets to access AWS Database Migration Service\n resources in the AWS Database Migration Service User\n Guide.

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

The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the SAP SAE endpoint connection details.

" + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/dax.2017-04-19.json b/codegen/sdk-codegen/aws-models/dax.2017-04-19.json index 9e4bd527455..2aa32a417b3 100644 --- a/codegen/sdk-codegen/aws-models/dax.2017-04-19.json +++ b/codegen/sdk-codegen/aws-models/dax.2017-04-19.json @@ -130,10 +130,12 @@ "traits": { "smithy.api#enum": [ { - "value": "IMMEDIATE" + "value": "IMMEDIATE", + "name": "IMMEDIATE" }, { - "value": "REQUIRES_REBOOT" + "value": "REQUIRES_REBOOT", + "name": "REQUIRES_REBOOT" } ] } @@ -1468,13 +1470,16 @@ "traits": { "smithy.api#enum": [ { - "value": "TRUE" + "value": "TRUE", + "name": "TRUE" }, { - "value": "FALSE" + "value": "FALSE", + "name": "FALSE" }, { - "value": "CONDITIONAL" + "value": "CONDITIONAL", + "name": "CONDITIONAL" } ] } @@ -1895,10 +1900,12 @@ "traits": { "smithy.api#enum": [ { - "value": "DEFAULT" + "value": "DEFAULT", + "name": "DEFAULT" }, { - "value": "NODE_TYPE_SPECIFIC" + "value": "NODE_TYPE_SPECIFIC", + "name": "NODE_TYPE_SPECIFIC" } ] } @@ -2005,16 +2012,20 @@ "traits": { "smithy.api#enum": [ { - "value": "ENABLING" + "value": "ENABLING", + "name": "ENABLING" }, { - "value": "ENABLED" + "value": "ENABLED", + "name": "ENABLED" }, { - "value": "DISABLING" + "value": "DISABLING", + "name": "DISABLING" }, { - "value": "DISABLED" + "value": "DISABLED", + "name": "DISABLED" } ] } @@ -2069,13 +2080,16 @@ "traits": { "smithy.api#enum": [ { - "value": "CLUSTER" + "value": "CLUSTER", + "name": "CLUSTER" }, { - "value": "PARAMETER_GROUP" + "value": "PARAMETER_GROUP", + "name": "PARAMETER_GROUP" }, { - "value": "SUBNET_GROUP" + "value": "SUBNET_GROUP", + "name": "SUBNET_GROUP" } ] } diff --git a/codegen/sdk-codegen/aws-models/devopsguru.2020-12-01.json b/codegen/sdk-codegen/aws-models/devopsguru.2020-12-01.json index c512ff9ff85..d9e95ade69d 100644 --- a/codegen/sdk-codegen/aws-models/devopsguru.2020-12-01.json +++ b/codegen/sdk-codegen/aws-models/devopsguru.2020-12-01.json @@ -33,13 +33,14 @@ "type": "structure", "members": { "Message": { - "target": "com.amazonaws.devopsguru#__string", + "target": "com.amazonaws.devopsguru#ErrorMessageString", "traits": { "smithy.api#required": {} } } }, "traits": { + "smithy.api#documentation": "

You don't have permissions to perform the requested operation. The user or role that is making the request must have at \n\t\t\tleast one IAM permissions policy attached that grants the required permissions. For more information, see \n\t\t\tAccess Management in the IAM User Guide.

", "smithy.api#error": "client", "smithy.api#httpError": 403 } @@ -76,6 +77,7 @@ } ], "traits": { + "smithy.api#documentation": "

\n\t\t\tAdds a notification channel to DevOps Guru. A notification channel is used to notify you about important DevOps Guru events, such as when an insight is generated.\n\t\t

\n\t\t\n\t\t

If you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission \n\t\t\t\tto it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. \n\t\t\t\tFor more information, see Permissions \n\t\t\t\tfor cross account Amazon SNS topics.

\n\t\t\t\t

If you use an Amazon SNS topic that is encrypted by an AWS Key Management Service customer-managed key (CMK), then you must add permissions \n\t\t\t\tto the CMK. For more information, see Permissions for \n\t\t\t\tAWS KMS–encrypted Amazon SNS topics.

", "smithy.api#http": { "method": "PUT", "uri": "/channels", @@ -89,6 +91,7 @@ "Config": { "target": "com.amazonaws.devopsguru#NotificationChannelConfig", "traits": { + "smithy.api#documentation": "

A NotificationChannelConfig object that specifies what type of\n \t\tnotification channel to add. The one \n \tsupported notification channel is Amazon Simple Notification Service (Amazon SNS).

", "smithy.api#required": {} } } @@ -98,10 +101,30 @@ "type": "structure", "members": { "Id": { - "target": "com.amazonaws.devopsguru#__stringMin36Max36PatternAF098AF094AF094AF094AF0912" + "target": "com.amazonaws.devopsguru#NotificationChannelId", + "traits": { + "smithy.api#documentation": "

\n \t\tThe ID of the added notification channel.\n \t

", + "smithy.api#required": {} + } } } }, + "com.amazonaws.devopsguru#AnomalyId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[\\w-]*$" + } + }, + "com.amazonaws.devopsguru#AnomalyLimit": { + "type": "double", + "traits": { + "smithy.api#box": {} + } + }, "com.amazonaws.devopsguru#AnomalySeverity": { "type": "string", "traits": { @@ -125,8 +148,14 @@ "type": "structure", "members": { "CloudWatchMetrics": { - "target": "com.amazonaws.devopsguru#__listOfCloudWatchMetricsDetail" + "target": "com.amazonaws.devopsguru#CloudWatchMetricsDetails", + "traits": { + "smithy.api#documentation": "

An array of CloudWatchMetricsDetail object that contains information\n\t\t\tabout the analyzed metrics that displayed anomalous behavior.

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

Details about the source of the anomalous operational data that triggered the anomaly. The\n\t\t\tone supported source is Amazon CloudWatch metrics.

" } }, "com.amazonaws.devopsguru#AnomalyStatus": { @@ -147,140 +176,318 @@ "com.amazonaws.devopsguru#AnomalyTimeRange": { "type": "structure", "members": { - "EndTime": { - "target": "com.amazonaws.devopsguru#__timestampUnix" - }, "StartTime": { - "target": "com.amazonaws.devopsguru#__timestampUnix", + "target": "com.amazonaws.devopsguru#Timestamp", "traits": { + "smithy.api#documentation": "

\n\t\t\tThe time when the anomalous behavior started.\n\t\t

", "smithy.api#required": {} } + }, + "EndTime": { + "target": "com.amazonaws.devopsguru#Timestamp", + "traits": { + "smithy.api#documentation": "

The time when the anomalous behavior ended.

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

\n\t\t\tA time range that specifies when the observed unusual behavior in an anomaly started and ended.\n\t\t

" + } + }, + "com.amazonaws.devopsguru#CapstoneControlPlaneService": { + "type": "service", + "version": "2020-12-01", + "operations": [ + { + "target": "com.amazonaws.devopsguru#AddNotificationChannel" + }, + { + "target": "com.amazonaws.devopsguru#DescribeAccountHealth" + }, + { + "target": "com.amazonaws.devopsguru#DescribeAccountOverview" + }, + { + "target": "com.amazonaws.devopsguru#DescribeAnomaly" + }, + { + "target": "com.amazonaws.devopsguru#DescribeInsight" + }, + { + "target": "com.amazonaws.devopsguru#DescribeResourceCollectionHealth" + }, + { + "target": "com.amazonaws.devopsguru#DescribeServiceIntegration" + }, + { + "target": "com.amazonaws.devopsguru#GetResourceCollection" + }, + { + "target": "com.amazonaws.devopsguru#ListAnomaliesForInsight" + }, + { + "target": "com.amazonaws.devopsguru#ListEvents" + }, + { + "target": "com.amazonaws.devopsguru#ListInsights" + }, + { + "target": "com.amazonaws.devopsguru#ListNotificationChannels" + }, + { + "target": "com.amazonaws.devopsguru#ListRecommendations" + }, + { + "target": "com.amazonaws.devopsguru#PutFeedback" + }, + { + "target": "com.amazonaws.devopsguru#RemoveNotificationChannel" + }, + { + "target": "com.amazonaws.devopsguru#SearchInsights" + }, + { + "target": "com.amazonaws.devopsguru#UpdateResourceCollection" + }, + { + "target": "com.amazonaws.devopsguru#UpdateServiceIntegration" } + ], + "traits": { + "aws.api#service": { + "sdkId": "DevOps Guru", + "arnNamespace": "devops-guru", + "cloudFormationName": "DevOpsGuru", + "cloudTrailEventSource": "devopsguru.amazonaws.com", + "endpointPrefix": "devops-guru" + }, + "aws.auth#sigv4": { + "name": "devops-guru" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "

Amazon DevOps Guru is a fully managed service that helps you identify anomalous behavior in business\n\t\t\tcritical operational applications. You specify the AWS resources that you want DevOps Guru to cover,\n\t\t\tthen the Amazon CloudWatch metrics and AWS CloudTrail events related to those resources are analyzed. When\n\t\t\tanomalous behavior is detected, DevOps Guru creates an insight that includes\n\t\t\trecommendations, related events, and related metrics that can help you improve your\n\t\t\toperational applications. For more information, see What is Amazon DevOps Guru.

\n\t\t\n\t\t

\n\t\t\tYou can specify 1 or 2 Amazon Simple Notification Service topics so you are notified every time a new insight is created. You can also enable DevOps Guru to generate \n\t\t\tan OpsItem in AWS Systems Manager for each insight to help you manage and track your work addressing insights.\n\t\t

\n\t\t\n\t\t

\n\t\t\tTo learn about the DevOps Guru workflow, see How DevOps Guru works. To \n\t\t\tlearn about DevOps Guru concepts, see Concepts in DevOps Guru.\n\t\t

", + "smithy.api#title": "Amazon DevOps Guru" + } + }, + "com.amazonaws.devopsguru#Channels": { + "type": "list", + "member": { + "target": "com.amazonaws.devopsguru#NotificationChannel" } }, "com.amazonaws.devopsguru#CloudFormationCollection": { "type": "structure", "members": { "StackNames": { - "target": "com.amazonaws.devopsguru#__listOf__stringMin1Max128PatternAZAZAZAZ09" + "target": "com.amazonaws.devopsguru#StackNames", + "traits": { + "smithy.api#documentation": "

\n\t\t\tAn array of CloudFormation stack names.\n\t\t

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

\n\t\t\tInformation about AWS CloudFormation stacks. You can use stacks to specify which AWS resources in your account to analyze. \n\t\t\tFor more information, see Stacks \n\t\t\tin the AWS CloudFormation User Guide.\n\t\t

" } }, "com.amazonaws.devopsguru#CloudFormationCollectionFilter": { "type": "structure", "members": { "StackNames": { - "target": "com.amazonaws.devopsguru#__listOf__stringMin1Max128PatternAZAZAZAZ09" + "target": "com.amazonaws.devopsguru#StackNames", + "traits": { + "smithy.api#documentation": "

\n\t\t\tAn array of CloudFormation stack names.\n\t\t

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

\n\t\t\tInformation about AWS CloudFormation stacks. You can use stacks to specify which AWS resources in your account to analyze. \n\t\t\tFor more information, see Stacks \n\t\t\tin the AWS CloudFormation User Guide.\n\t\t

" } }, "com.amazonaws.devopsguru#CloudFormationHealth": { "type": "structure", "members": { - "Insight": { - "target": "com.amazonaws.devopsguru#InsightHealth" - }, "StackName": { - "target": "com.amazonaws.devopsguru#__stringMin1Max128PatternAZAZAZAZ09" + "target": "com.amazonaws.devopsguru#StackName", + "traits": { + "smithy.api#documentation": "

\n \t\tThe name of the CloudFormation stack.\n \t

" + } + }, + "Insight": { + "target": "com.amazonaws.devopsguru#InsightHealth", + "traits": { + "smithy.api#documentation": "

\n \t\tInformation about the health of the AWS resources in your account that are specified by an AWS CloudFormation stack, including \n \t\tthe number of open proactive, open reactive insights, and the Mean Time to Recover (MTTR) of closed insights.\n \t

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

\n \t\tInformation about the health of AWS resources in your account that are specified by an AWS CloudFormation stack.\n \t

" + } + }, + "com.amazonaws.devopsguru#CloudFormationHealths": { + "type": "list", + "member": { + "target": "com.amazonaws.devopsguru#CloudFormationHealth" } }, "com.amazonaws.devopsguru#CloudWatchMetricsDetail": { "type": "structure", "members": { - "Dimensions": { - "target": "com.amazonaws.devopsguru#__listOfCloudWatchMetricsDimension" - }, "MetricName": { - "target": "com.amazonaws.devopsguru#__string" + "target": "com.amazonaws.devopsguru#CloudWatchMetricsMetricName", + "traits": { + "smithy.api#documentation": "

\n\t\t\tThe name of the CloudWatch metric.\n\t\t

" + } }, "Namespace": { - "target": "com.amazonaws.devopsguru#__string" + "target": "com.amazonaws.devopsguru#CloudWatchMetricsNamespace", + "traits": { + "smithy.api#documentation": "

\n\t\t\tThe namespace of the CloudWatch metric. A namespace is a container for CloudWatch metrics.\n\t\t

" + } }, - "Period": { - "target": "com.amazonaws.devopsguru#__integer" + "Dimensions": { + "target": "com.amazonaws.devopsguru#CloudWatchMetricsDimensions", + "traits": { + "smithy.api#documentation": "

\n\t\t\tAn array of CloudWatch dimensions associated with \n\t\t

" + } }, "Stat": { - "target": "com.amazonaws.devopsguru#CloudWatchMetricsStat" + "target": "com.amazonaws.devopsguru#CloudWatchMetricsStat", + "traits": { + "smithy.api#documentation": "

\n\t\t\tThe type of statistic associated with the CloudWatch metric. For more information, see \n\t\t\tStatistics in the \n\t\t\tAmazon CloudWatch User Guide.\n\t\t

" + } }, "Unit": { - "target": "com.amazonaws.devopsguru#__string" + "target": "com.amazonaws.devopsguru#CloudWatchMetricsUnit", + "traits": { + "smithy.api#documentation": "

\n\t\t\tThe unit of measure used for the CloudWatch metric. For example, Bytes, Seconds, \n\t\t\tCount, and Percent.\n\t\t

" + } + }, + "Period": { + "target": "com.amazonaws.devopsguru#CloudWatchMetricsPeriod", + "traits": { + "smithy.api#documentation": "

\n\t\t\tThe length of time associated with the CloudWatch metric in number of seconds.\n\t\t

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

\n\t\t\tInformation about an Amazon CloudWatch metric.\n\t\t

" + } + }, + "com.amazonaws.devopsguru#CloudWatchMetricsDetails": { + "type": "list", + "member": { + "target": "com.amazonaws.devopsguru#CloudWatchMetricsDetail" } }, "com.amazonaws.devopsguru#CloudWatchMetricsDimension": { "type": "structure", "members": { "Name": { - "target": "com.amazonaws.devopsguru#__string" + "target": "com.amazonaws.devopsguru#CloudWatchMetricsDimensionName", + "traits": { + "smithy.api#documentation": "

\n\t\t\tThe name of the CloudWatch dimension.\n\t\t

" + } }, "Value": { - "target": "com.amazonaws.devopsguru#__string" + "target": "com.amazonaws.devopsguru#CloudWatchMetricsDimensionValue", + "traits": { + "smithy.api#documentation": "

\n\t\t\tThe value of the CloudWatch dimension.\n\t\t

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

The dimension of a Amazon CloudWatch metric that is used when DevOps Guru analyzes the resources in your\n\t\t\taccount for operational problems and anomalous behaviour. A dimension is a name/value pair\n\t\t\tthat is part of the identity of a metric. A metric can have up to 10 dimensions. For more\n\t\t\tinformation, see Dimensions in the Amazon CloudWatch User Guide.

" + } + }, + "com.amazonaws.devopsguru#CloudWatchMetricsDimensionName": { + "type": "string" + }, + "com.amazonaws.devopsguru#CloudWatchMetricsDimensionValue": { + "type": "string" + }, + "com.amazonaws.devopsguru#CloudWatchMetricsDimensions": { + "type": "list", + "member": { + "target": "com.amazonaws.devopsguru#CloudWatchMetricsDimension" } }, + "com.amazonaws.devopsguru#CloudWatchMetricsMetricName": { + "type": "string" + }, + "com.amazonaws.devopsguru#CloudWatchMetricsNamespace": { + "type": "string" + }, + "com.amazonaws.devopsguru#CloudWatchMetricsPeriod": { + "type": "integer" + }, "com.amazonaws.devopsguru#CloudWatchMetricsStat": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "Sum", - "name": "Sum" + "name": "SUM" }, { "value": "Average", - "name": "Average" + "name": "AVERAGE" }, { "value": "SampleCount", - "name": "SampleCount" + "name": "SAMPLE_COUNT" }, { "value": "Minimum", - "name": "Minimum" + "name": "MINIMUM" }, { "value": "Maximum", - "name": "Maximum" + "name": "MAXIMUM" }, { "value": "p99", - "name": "p99" + "name": "P99" }, { "value": "p90", - "name": "p90" + "name": "P90" }, { "value": "p50", - "name": "p50" + "name": "P50" } ] } }, + "com.amazonaws.devopsguru#CloudWatchMetricsUnit": { + "type": "string" + }, "com.amazonaws.devopsguru#ConflictException": { "type": "structure", "members": { "Message": { - "target": "com.amazonaws.devopsguru#__string", + "target": "com.amazonaws.devopsguru#ErrorMessageString", "traits": { "smithy.api#required": {} } }, "ResourceId": { - "target": "com.amazonaws.devopsguru#__string", + "target": "com.amazonaws.devopsguru#ResourceIdString", "traits": { + "smithy.api#documentation": "

\n\t\t\tThe ID of the AWS resource in which a conflict occurred.\n\t\t

", "smithy.api#required": {} } }, "ResourceType": { - "target": "com.amazonaws.devopsguru#__string", + "target": "com.amazonaws.devopsguru#ResourceIdType", "traits": { + "smithy.api#documentation": "

\n\t\t\tThe type of the AWS resource in which a conflict occurred.\n\t\t

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

\n\t\t\tAn exception that is thrown when a conflict occurs.\n\t\t

", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -308,6 +515,7 @@ } ], "traits": { + "smithy.api#documentation": "

\n \t\tReturns the number of open reactive insights, the number of open proactive insights, and the number of metrics analyzed in your AWS account. \n \t\tUse these numbers to gauge the health of operations in your AWS account.\n \t

", "smithy.api#http": { "method": "GET", "uri": "/accounts/health", @@ -322,14 +530,26 @@ "com.amazonaws.devopsguru#DescribeAccountHealthResponse": { "type": "structure", "members": { - "MetricsAnalyzed": { - "target": "com.amazonaws.devopsguru#__integer" + "OpenReactiveInsights": { + "target": "com.amazonaws.devopsguru#NumOpenReactiveInsights", + "traits": { + "smithy.api#documentation": "

\n \t\tAn integer that specifies the number of open reactive insights in your AWS account. \n \t

", + "smithy.api#required": {} + } }, "OpenProactiveInsights": { - "target": "com.amazonaws.devopsguru#__integer" + "target": "com.amazonaws.devopsguru#NumOpenProactiveInsights", + "traits": { + "smithy.api#documentation": "

\n \t\tAn integer that specifies the number of open proactive insights in your AWS account.\n \t

", + "smithy.api#required": {} + } }, - "OpenReactiveInsights": { - "target": "com.amazonaws.devopsguru#__integer" + "MetricsAnalyzed": { + "target": "com.amazonaws.devopsguru#NumMetricsAnalyzed", + "traits": { + "smithy.api#documentation": "

\n \t\tAn integer that specifies the number of metrics that have been analyzed in your AWS account.\n \t

", + "smithy.api#required": {} + } } } }, @@ -356,6 +576,7 @@ } ], "traits": { + "smithy.api#documentation": "

\n \t\tFor the time range passed in, returns the number of open reactive insight that were created, the number of open proactive insights \n \t\tthat were created, and the Mean Time to Recover (MTTR) for all closed reactive insights.\n \t

", "smithy.api#http": { "method": "POST", "uri": "/accounts/overview", @@ -367,27 +588,43 @@ "type": "structure", "members": { "FromTime": { - "target": "com.amazonaws.devopsguru#__timestampUnix", + "target": "com.amazonaws.devopsguru#Timestamp", "traits": { + "smithy.api#documentation": "

\n \t\tThe start of the time range passed in. The start time granularity is at the \n \t\tday level. The floor of the start time is used. Returned information occurred after this day. \n \t

", "smithy.api#required": {} } }, "ToTime": { - "target": "com.amazonaws.devopsguru#__timestampUnix" + "target": "com.amazonaws.devopsguru#Timestamp", + "traits": { + "smithy.api#documentation": "

\n \t\tThe end of the time range passed in. The start time granularity is at the \n \t\tday level. The floor of the start time is used. Returned information occurred before this day. If this is not specified, then the current day is used.\n \t

" + } } } }, "com.amazonaws.devopsguru#DescribeAccountOverviewResponse": { "type": "structure", "members": { - "MeanTimeToRecoverInMilliseconds": { - "target": "com.amazonaws.devopsguru#__long" + "ReactiveInsights": { + "target": "com.amazonaws.devopsguru#NumReactiveInsights", + "traits": { + "smithy.api#documentation": "

\n \t\tAn integer that specifies the number of open reactive insights in your AWS account that were created during the \n \t\ttime range passed in.\n \t

", + "smithy.api#required": {} + } }, "ProactiveInsights": { - "target": "com.amazonaws.devopsguru#__integer" + "target": "com.amazonaws.devopsguru#NumProactiveInsights", + "traits": { + "smithy.api#documentation": "

\n \t\tAn integer that specifies the number of open proactive insights in your AWS account that were created during the \n \t\ttime range passed in.\n \t

", + "smithy.api#required": {} + } }, - "ReactiveInsights": { - "target": "com.amazonaws.devopsguru#__integer" + "MeanTimeToRecoverInMilliseconds": { + "target": "com.amazonaws.devopsguru#MeanTimeToRecoverInMilliseconds", + "traits": { + "smithy.api#documentation": "

\n \t\tThe Mean Time to Recover (MTTR) for all closed insights that were created during the \n \t\ttime range passed in.\n \t

", + "smithy.api#required": {} + } } } }, @@ -417,6 +654,7 @@ } ], "traits": { + "smithy.api#documentation": "

\n \t\tReturns details about an anomaly that you specify using its ID.\n \t

", "smithy.api#http": { "method": "GET", "uri": "/anomalies/{Id}", @@ -428,8 +666,9 @@ "type": "structure", "members": { "Id": { - "target": "com.amazonaws.devopsguru#__string", + "target": "com.amazonaws.devopsguru#AnomalyId", "traits": { + "smithy.api#documentation": "

\n \t\tThe ID of the anomaly.\n \t

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -440,10 +679,16 @@ "type": "structure", "members": { "ProactiveAnomaly": { - "target": "com.amazonaws.devopsguru#ProactiveAnomaly" + "target": "com.amazonaws.devopsguru#ProactiveAnomaly", + "traits": { + "smithy.api#documentation": "

\n\t\t\tAn ReactiveAnomaly object that represents the requested anomaly.\n\t\t

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

\n\t\t\tAn ProactiveAnomaly object that represents the requested anomaly.\n\t\t

" + } } } }, @@ -473,6 +718,7 @@ } ], "traits": { + "smithy.api#documentation": "

\n \t\tReturns details about an insight that you specify using its ID.\n \t

", "smithy.api#http": { "method": "GET", "uri": "/insights/{Id}", @@ -484,8 +730,9 @@ "type": "structure", "members": { "Id": { - "target": "com.amazonaws.devopsguru#__string", + "target": "com.amazonaws.devopsguru#InsightId", "traits": { + "smithy.api#documentation": "

\n \t\tThe ID of the insight.\n \t

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -496,10 +743,16 @@ "type": "structure", "members": { "ProactiveInsight": { - "target": "com.amazonaws.devopsguru#ProactiveInsight" + "target": "com.amazonaws.devopsguru#ProactiveInsight", + "traits": { + "smithy.api#documentation": "

\n\t\t\tAn ProactiveInsight object that represents the requested insight.\n\t\t

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

\n\t\t\tAn ReactiveInsight object that represents the requested insight.\n\t\t

" + } } } }, @@ -526,6 +779,7 @@ } ], "traits": { + "smithy.api#documentation": "

\n \t\tReturns the number of open proactive insights, open reactive insights, and the Mean Time to Recover (MTTR) for all closed insights in \n \t\tresource collections in your account. You specify the type of AWS resources collection. The one type of AWS resource collection supported is AWS CloudFormation stacks. DevOps Guru can be configured to analyze \n \tonly the AWS resources that are defined in the stacks.\n \t

", "smithy.api#http": { "method": "GET", "uri": "/accounts/health/resource-collection/{ResourceCollectionType}", @@ -540,18 +794,20 @@ "com.amazonaws.devopsguru#DescribeResourceCollectionHealthRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.devopsguru#__string", - "traits": { - "smithy.api#httpQuery": "NextToken" - } - }, "ResourceCollectionType": { - "target": "com.amazonaws.devopsguru#__string", + "target": "com.amazonaws.devopsguru#ResourceCollectionType", "traits": { + "smithy.api#documentation": "

\n \t\tAn AWS resource collection type. This type specifies how analyzed AWS resources are defined. The one type of AWS resource collection supported is AWS CloudFormation stacks. DevOps Guru can be configured to analyze \n \tonly the AWS resources that are defined in the stacks. \n \t

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "NextToken": { + "target": "com.amazonaws.devopsguru#UuidNextToken", + "traits": { + "smithy.api#documentation": "

The pagination token to use to retrieve \n the next page of results for this operation. If this value is null, it retrieves the first page.

", + "smithy.api#httpQuery": "NextToken" + } } } }, @@ -559,10 +815,17 @@ "type": "structure", "members": { "CloudFormation": { - "target": "com.amazonaws.devopsguru#__listOfCloudFormationHealth" + "target": "com.amazonaws.devopsguru#CloudFormationHealths", + "traits": { + "smithy.api#documentation": "

\n \t\tThe returned CloudFormationHealthOverview object that contains an InsightHealthOverview object with \n \t\tthe requested system health information.\n \t

", + "smithy.api#required": {} + } }, "NextToken": { - "target": "com.amazonaws.devopsguru#__stringMin36Max36PatternAF098AF094AF094AF094AF0912" + "target": "com.amazonaws.devopsguru#UuidNextToken", + "traits": { + "smithy.api#documentation": "

The pagination token to use to retrieve \n the next page of results for this operation. If there are no more pages, this value is null.

" + } } } }, @@ -589,6 +852,7 @@ } ], "traits": { + "smithy.api#documentation": "

\n\t\t\tReturns the integration status of services that are integrated with DevOps Guru. \n\t\t\tThe one service that can be integrated with DevOps Guru \n \tis AWS Systems Manager, which can be used to create an OpsItem for each generated insight.\n\t\t

", "smithy.api#http": { "method": "GET", "uri": "/service-integrations", @@ -608,118 +872,89 @@ } } }, - "com.amazonaws.devopsguru#DevOpsGuru": { - "type": "service", - "version": "2020-12-01", - "operations": [ - { - "target": "com.amazonaws.devopsguru#AddNotificationChannel" - }, - { - "target": "com.amazonaws.devopsguru#DescribeAccountHealth" - }, - { - "target": "com.amazonaws.devopsguru#DescribeAccountOverview" - }, - { - "target": "com.amazonaws.devopsguru#DescribeAnomaly" - }, - { - "target": "com.amazonaws.devopsguru#DescribeInsight" - }, - { - "target": "com.amazonaws.devopsguru#DescribeResourceCollectionHealth" - }, - { - "target": "com.amazonaws.devopsguru#DescribeServiceIntegration" + "com.amazonaws.devopsguru#EndTimeRange": { + "type": "structure", + "members": { + "FromTime": { + "target": "com.amazonaws.devopsguru#Timestamp", + "traits": { + "smithy.api#documentation": "

\n \tThe earliest end time in the time range.\n

" + } }, - { - "target": "com.amazonaws.devopsguru#GetResourceCollection" - }, - { - "target": "com.amazonaws.devopsguru#ListAnomaliesForInsight" - }, - { - "target": "com.amazonaws.devopsguru#ListEvents" - }, - { - "target": "com.amazonaws.devopsguru#ListInsights" - }, - { - "target": "com.amazonaws.devopsguru#ListNotificationChannels" - }, - { - "target": "com.amazonaws.devopsguru#ListRecommendations" - }, - { - "target": "com.amazonaws.devopsguru#PutFeedback" - }, - { - "target": "com.amazonaws.devopsguru#RemoveNotificationChannel" - }, - { - "target": "com.amazonaws.devopsguru#SearchInsights" - }, - { - "target": "com.amazonaws.devopsguru#UpdateResourceCollection" - }, - { - "target": "com.amazonaws.devopsguru#UpdateServiceIntegration" + "ToTime": { + "target": "com.amazonaws.devopsguru#Timestamp", + "traits": { + "smithy.api#documentation": "

\n \tThe latest end time in the time range.\n

" + } } - ], + }, "traits": { - "aws.api#service": { - "sdkId": "DevOps Guru", - "arnNamespace": "devops-guru", - "cloudFormationName": "DevOpsGuru", - "cloudTrailEventSource": "devopsguru.amazonaws.com", - "endpointPrefix": "devops-guru" - }, - "aws.auth#sigv4": { - "name": "devops-guru" - }, - "aws.protocols#restJson1": {}, - "smithy.api#title": "Amazon DevOps Guru" + "smithy.api#documentation": "

\n \tA range of time that specifies when anomalous behavior in an anomaly or insight ended.\n

" } }, - "com.amazonaws.devopsguru#EndTimeRange": { - "type": "structure", - "members": { - "FromTime": { - "target": "com.amazonaws.devopsguru#__timestampUnix" - }, - "ToTime": { - "target": "com.amazonaws.devopsguru#__timestampUnix" - } - } + "com.amazonaws.devopsguru#ErrorMessageString": { + "type": "string" + }, + "com.amazonaws.devopsguru#ErrorNameString": { + "type": "string" + }, + "com.amazonaws.devopsguru#ErrorQuotaCodeString": { + "type": "string" + }, + "com.amazonaws.devopsguru#ErrorServiceCodeString": { + "type": "string" }, "com.amazonaws.devopsguru#Event": { "type": "structure", "members": { - "DataSource": { - "target": "com.amazonaws.devopsguru#EventDataSource" + "ResourceCollection": { + "target": "com.amazonaws.devopsguru#ResourceCollection" }, - "EventClass": { - "target": "com.amazonaws.devopsguru#EventClass" + "Id": { + "target": "com.amazonaws.devopsguru#EventId", + "traits": { + "smithy.api#documentation": "

\n\t\t\tThe ID of the event.\n\t\t

" + } }, - "EventSource": { - "target": "com.amazonaws.devopsguru#__stringMin10Max50PatternAZAZ09AmazonawsComAwsEvents" + "Time": { + "target": "com.amazonaws.devopsguru#Timestamp", + "traits": { + "smithy.api#documentation": "

A Timestamp that specifies the time the event occurred.

" + } }, - "Id": { - "target": "com.amazonaws.devopsguru#__string" + "EventSource": { + "target": "com.amazonaws.devopsguru#EventSource", + "traits": { + "smithy.api#documentation": "

\n\t\t\tThe AWS source that emitted the event.\n\t\t

" + } }, "Name": { - "target": "com.amazonaws.devopsguru#__stringMin0Max50" + "target": "com.amazonaws.devopsguru#EventName", + "traits": { + "smithy.api#documentation": "

\n\t\t\tThe name of the event.\n\t\t

" + } }, - "ResourceCollection": { - "target": "com.amazonaws.devopsguru#ResourceCollection" + "DataSource": { + "target": "com.amazonaws.devopsguru#EventDataSource", + "traits": { + "smithy.api#documentation": "

\n\t\t\tThe source, AWS_CLOUD_TRAIL or AWS_CODE_DEPLOY, where DevOps Guru analysis found the event.\n\t\t

" + } }, - "Resources": { - "target": "com.amazonaws.devopsguru#__listOfEventResource" + "EventClass": { + "target": "com.amazonaws.devopsguru#EventClass", + "traits": { + "smithy.api#documentation": "

\n\t\t\tThe class of the event. The class specifies what the event is related to, such as an infrastructure change, a deployment, or a schema change.\n\t\t

" + } }, - "Time": { - "target": "com.amazonaws.devopsguru#__timestampUnix" + "Resources": { + "target": "com.amazonaws.devopsguru#EventResources", + "traits": { + "smithy.api#documentation": "

\n\t\t\tAn EventResource object that contains information about the resource that emitted the event.\n\t\t

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

\n\t\t\tAn AWS resource event. AWS resource events and metrics are analyzed by DevOps Guru to find anomalous behavior and \n\t\t\tprovide recommendations to improve your operational solutions.\n\t\t

" } }, "com.amazonaws.devopsguru#EventClass": { @@ -764,35 +999,116 @@ ] } }, + "com.amazonaws.devopsguru#EventId": { + "type": "string" + }, + "com.amazonaws.devopsguru#EventName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, "com.amazonaws.devopsguru#EventResource": { "type": "structure", "members": { - "Arn": { - "target": "com.amazonaws.devopsguru#__stringMin36Max2048PatternArnAwsAZAZ09AZ09D12" + "Type": { + "target": "com.amazonaws.devopsguru#EventResourceType", + "traits": { + "smithy.api#documentation": "

\n\t\t\tThe type of resource that emitted an event.\n\t\t

" + } }, "Name": { - "target": "com.amazonaws.devopsguru#__stringMin0Max2048Pattern" + "target": "com.amazonaws.devopsguru#EventResourceName", + "traits": { + "smithy.api#documentation": "

\n\t\t\tThe name of the resource that emitted an event.\n\t\t

" + } }, - "Type": { - "target": "com.amazonaws.devopsguru#__stringMin0Max2048Pattern" + "Arn": { + "target": "com.amazonaws.devopsguru#EventResourceArn", + "traits": { + "smithy.api#documentation": "

\n\t\t\tThe Amazon Resource Name (ARN) of the resource that emitted an event.\n\t\t

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

\n\t\t\tThe AWS resource that emitted an event. AWS resource events and metrics are analyzed by DevOps Guru to find anomalous behavior and \n\t\t\tprovide recommendations to improve your operational solutions.\n\t\t

" + } + }, + "com.amazonaws.devopsguru#EventResourceArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 36, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws[-a-z]*:[a-z0-9-]*:[a-z0-9-]*:\\d{12}:.*$" + } + }, + "com.amazonaws.devopsguru#EventResourceName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + }, + "smithy.api#pattern": "^.*$" + } + }, + "com.amazonaws.devopsguru#EventResourceType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + }, + "smithy.api#pattern": "^.*$" + } + }, + "com.amazonaws.devopsguru#EventResources": { + "type": "list", + "member": { + "target": "com.amazonaws.devopsguru#EventResource" + } + }, + "com.amazonaws.devopsguru#EventSource": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 10, + "max": 50 + }, + "smithy.api#pattern": "^[a-z]+[a-z0-9]*\\.amazonaws\\.com|aws\\.events$" } }, "com.amazonaws.devopsguru#EventTimeRange": { "type": "structure", "members": { "FromTime": { - "target": "com.amazonaws.devopsguru#__timestampUnix", + "target": "com.amazonaws.devopsguru#Timestamp", "traits": { + "smithy.api#documentation": "

\n\t\t\tThe time when the event started.\n\t\t

", "smithy.api#required": {} } }, "ToTime": { - "target": "com.amazonaws.devopsguru#__timestampUnix", + "target": "com.amazonaws.devopsguru#Timestamp", "traits": { + "smithy.api#documentation": "

\n\t\t\tThe time when the event ended.\n\t\t

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

\n\t\t\tThe time range during which an AWS event occurred. AWS resource events and metrics are analyzed by DevOps Guru to find anomalous behavior and \n\t\t\tprovide recommendations to improve your operational solutions.\n\t\t

" + } + }, + "com.amazonaws.devopsguru#Events": { + "type": "list", + "member": { + "target": "com.amazonaws.devopsguru#Event" } }, "com.amazonaws.devopsguru#GetResourceCollection": { @@ -821,6 +1137,7 @@ } ], "traits": { + "smithy.api#documentation": "

\n \t\tReturns lists AWS resources that are of the specified resource collection type. The one type of AWS resource collection supported is AWS CloudFormation stacks. DevOps Guru can be configured to analyze \n \tonly the AWS resources that are defined in the stacks.\n \t

", "smithy.api#http": { "method": "GET", "uri": "/resource-collections/{ResourceCollectionType}", @@ -835,41 +1152,58 @@ "com.amazonaws.devopsguru#GetResourceCollectionRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.devopsguru#__string", - "traits": { - "smithy.api#httpQuery": "NextToken" - } - }, "ResourceCollectionType": { - "target": "com.amazonaws.devopsguru#__string", + "target": "com.amazonaws.devopsguru#ResourceCollectionType", "traits": { + "smithy.api#documentation": "

\n \t\tThe type of AWS resource collections to return. The one valid value is CLOUD_FORMATION for \n \t\tAWS CloudFormation stacks.\n \t

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "NextToken": { + "target": "com.amazonaws.devopsguru#UuidNextToken", + "traits": { + "smithy.api#documentation": "

The pagination token to use to retrieve \n the next page of results for this operation. If this value is null, it retrieves the first page.

", + "smithy.api#httpQuery": "NextToken" + } } } }, "com.amazonaws.devopsguru#GetResourceCollectionResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.devopsguru#__stringMin36Max36PatternAF098AF094AF094AF094AF0912" - }, "ResourceCollection": { - "target": "com.amazonaws.devopsguru#ResourceCollectionFilter" + "target": "com.amazonaws.devopsguru#ResourceCollectionFilter", + "traits": { + "smithy.api#documentation": "

\n \t\tThe requested list of AWS resource collections. The one type of AWS resource collection supported is AWS CloudFormation stacks. DevOps Guru can be configured to analyze \n \tonly the AWS resources that are defined in the stacks.\n \t

" + } + }, + "NextToken": { + "target": "com.amazonaws.devopsguru#UuidNextToken", + "traits": { + "smithy.api#documentation": "

The pagination token to use to retrieve \n the next page of results for this operation. If there are no more pages, this value is null.

" + } } } }, "com.amazonaws.devopsguru#InsightFeedback": { "type": "structure", "members": { - "Feedback": { - "target": "com.amazonaws.devopsguru#InsightFeedbackOption" - }, "Id": { - "target": "com.amazonaws.devopsguru#__stringMin1Max100PatternW" + "target": "com.amazonaws.devopsguru#InsightId", + "traits": { + "smithy.api#documentation": "

\n \tThe insight feedback ID.\n

" + } + }, + "Feedback": { + "target": "com.amazonaws.devopsguru#InsightFeedbackOption", + "traits": { + "smithy.api#documentation": "

\n \tThe feedback provided by the customer.\n

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

\n \tInformation about insight feedback received from a customer.\n

" } }, "com.amazonaws.devopsguru#InsightFeedbackOption": { @@ -902,14 +1236,58 @@ "com.amazonaws.devopsguru#InsightHealth": { "type": "structure", "members": { - "MeanTimeToRecoverInMilliseconds": { - "target": "com.amazonaws.devopsguru#__long" - }, "OpenProactiveInsights": { - "target": "com.amazonaws.devopsguru#__integer" + "target": "com.amazonaws.devopsguru#NumOpenProactiveInsights", + "traits": { + "smithy.api#documentation": "

\n \tThe number of open proactive insights.\n

" + } }, "OpenReactiveInsights": { - "target": "com.amazonaws.devopsguru#__integer" + "target": "com.amazonaws.devopsguru#NumOpenReactiveInsights", + "traits": { + "smithy.api#documentation": "

\n \tThe number of open reactive insights.\n

" + } + }, + "MeanTimeToRecoverInMilliseconds": { + "target": "com.amazonaws.devopsguru#MeanTimeToRecoverInMilliseconds", + "traits": { + "smithy.api#documentation": "

\n \tThe Meant Time to Recover (MTTR) for the insight.\t\n

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

\n \tInformation about the number of open reactive and proactive insights that can be \n \tused to gauge the health of your system.\n

" + } + }, + "com.amazonaws.devopsguru#InsightId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[\\w-]*$" + } + }, + "com.amazonaws.devopsguru#InsightName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 530 + }, + "smithy.api#pattern": "^[\\s\\S]*$" + } + }, + "com.amazonaws.devopsguru#InsightSeverities": { + "type": "list", + "member": { + "target": "com.amazonaws.devopsguru#InsightSeverity" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 3 } } }, @@ -947,18 +1325,37 @@ ] } }, + "com.amazonaws.devopsguru#InsightStatuses": { + "type": "list", + "member": { + "target": "com.amazonaws.devopsguru#InsightStatus" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2 + } + } + }, "com.amazonaws.devopsguru#InsightTimeRange": { "type": "structure", "members": { - "EndTime": { - "target": "com.amazonaws.devopsguru#__timestampUnix" - }, "StartTime": { - "target": "com.amazonaws.devopsguru#__timestampUnix", + "target": "com.amazonaws.devopsguru#Timestamp", "traits": { + "smithy.api#documentation": "

\n\t\t\tThe time when the behavior described in an insight started.\n\t\t

", "smithy.api#required": {} } + }, + "EndTime": { + "target": "com.amazonaws.devopsguru#Timestamp", + "traits": { + "smithy.api#documentation": "

\n\t\t\tThe time when the behavior described in an insight ended.\n\t\t

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

A time ranged that specifies when the observed behavior in an insight started and\n\t\t\tended.

" } }, "com.amazonaws.devopsguru#InsightType": { @@ -980,13 +1377,21 @@ "type": "structure", "members": { "Message": { - "target": "com.amazonaws.devopsguru#__string", + "target": "com.amazonaws.devopsguru#ErrorMessageString", "traits": { "smithy.api#required": {} } + }, + "RetryAfterSeconds": { + "target": "com.amazonaws.devopsguru#RetryAfterSeconds", + "traits": { + "smithy.api#documentation": "

\n\t\t\tThe number of seconds after which the action that caused the internal server \n\t\t\texception can be retried.\n\t\t

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

An internal failure in an Amazon service occurred.

", "smithy.api#error": "server", "smithy.api#httpError": 500 } @@ -1017,6 +1422,7 @@ } ], "traits": { + "smithy.api#documentation": "

\n \t\tReturns a list of the anomalies that belong to an insight that you specify using its ID.\n \t

", "smithy.api#http": { "method": "POST", "uri": "/anomalies/insight/{InsightId}", @@ -1029,38 +1435,67 @@ } } }, - "com.amazonaws.devopsguru#ListAnomaliesForInsightRequest": { + "com.amazonaws.devopsguru#ListAnomaliesForInsightMaxResults": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1, + "max": 500 + } + } + }, + "com.amazonaws.devopsguru#ListAnomaliesForInsightRequest": { "type": "structure", "members": { "InsightId": { - "target": "com.amazonaws.devopsguru#__string", + "target": "com.amazonaws.devopsguru#InsightId", "traits": { + "smithy.api#documentation": "

\n\t\t\tThe ID of the insight. The returned anomalies belong to this insight.\n\t\t

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, + "StartTimeRange": { + "target": "com.amazonaws.devopsguru#StartTimeRange", + "traits": { + "smithy.api#documentation": "

\n \t\tA time range used to specify when the requested anomalies started. All returned anomalies started \n \t\tduring this time range.\n \t

" + } + }, "MaxResults": { - "target": "com.amazonaws.devopsguru#__integerMin1Max500" + "target": "com.amazonaws.devopsguru#ListAnomaliesForInsightMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } }, "NextToken": { - "target": "com.amazonaws.devopsguru#__stringMin36Max36PatternAF098AF094AF094AF094AF0912" - }, - "StartTimeRange": { - "target": "com.amazonaws.devopsguru#StartTimeRange" + "target": "com.amazonaws.devopsguru#UuidNextToken", + "traits": { + "smithy.api#documentation": "

The pagination token to use to retrieve \n the next page of results for this operation. If this value is null, it retrieves the first page.

" + } } } }, "com.amazonaws.devopsguru#ListAnomaliesForInsightResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.devopsguru#__stringMin36Max36PatternAF098AF094AF094AF094AF0912" - }, "ProactiveAnomalies": { - "target": "com.amazonaws.devopsguru#__listOfProactiveAnomalySummary" + "target": "com.amazonaws.devopsguru#ProactiveAnomalies", + "traits": { + "smithy.api#documentation": "

\n\t\t\tAn array of ProactiveAnomalySummary objects that represent the requested anomalies\n\t\t

" + } }, "ReactiveAnomalies": { - "target": "com.amazonaws.devopsguru#__listOfReactiveAnomalySummary" + "target": "com.amazonaws.devopsguru#ReactiveAnomalies", + "traits": { + "smithy.api#documentation": "

\n\t\t\tAn array of ReactiveAnomalySummary objects that represent the requested anomalies\n\t\t

" + } + }, + "NextToken": { + "target": "com.amazonaws.devopsguru#UuidNextToken", + "traits": { + "smithy.api#documentation": "

The pagination token to use to retrieve \n the next page of results for this operation. If there are no more pages, this value is null.

" + } } } }, @@ -1090,6 +1525,7 @@ } ], "traits": { + "smithy.api#documentation": "

\n \t\tReturns a list of the events emitted by the resources that are evaluated by DevOps Guru. You can use filters to specify which events are returned.\n \t

", "smithy.api#http": { "method": "POST", "uri": "/events", @@ -1106,24 +1542,52 @@ "com.amazonaws.devopsguru#ListEventsFilters": { "type": "structure", "members": { - "DataSource": { - "target": "com.amazonaws.devopsguru#EventDataSource" + "InsightId": { + "target": "com.amazonaws.devopsguru#InsightId", + "traits": { + "smithy.api#documentation": "

\n\t\t\tAn ID of an insight that is related to the events you want to filter for.\n\t\t

" + } + }, + "EventTimeRange": { + "target": "com.amazonaws.devopsguru#EventTimeRange", + "traits": { + "smithy.api#documentation": "

A time range during which you want the filtered events to have occurred.

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

\n\t\t\tThe class of the events you want to filter for, such as an infrastructure change, a deployment, or a schema change. \t\n\t\t

" + } }, "EventSource": { - "target": "com.amazonaws.devopsguru#__stringMin10Max50PatternAZAZ09AmazonawsComAwsEvents" - }, - "EventTimeRange": { - "target": "com.amazonaws.devopsguru#EventTimeRange" + "target": "com.amazonaws.devopsguru#EventSource", + "traits": { + "smithy.api#documentation": "

\n\t\t\tThe AWS source that emitted the events you want to filter for.\n\t\t

" + } }, - "InsightId": { - "target": "com.amazonaws.devopsguru#__stringMin1Max100PatternW" + "DataSource": { + "target": "com.amazonaws.devopsguru#EventDataSource", + "traits": { + "smithy.api#documentation": "

\n\t\t\tThe source, AWS_CLOUD_TRAIL or AWS_CODE_DEPLOY, of the events you want returned.\n\t\t

" + } }, "ResourceCollection": { "target": "com.amazonaws.devopsguru#ResourceCollection" } + }, + "traits": { + "smithy.api#documentation": "

\n\t\t\tFilters you can use to specify which events are returned when ListEvents is called.\n\t\t

" + } + }, + "com.amazonaws.devopsguru#ListEventsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1, + "max": 200 + } } }, "com.amazonaws.devopsguru#ListEventsRequest": { @@ -1132,14 +1596,21 @@ "Filters": { "target": "com.amazonaws.devopsguru#ListEventsFilters", "traits": { + "smithy.api#documentation": "

\n \t\tA ListEventsFilters object used to specify which events to return.\n \t

", "smithy.api#required": {} } }, "MaxResults": { - "target": "com.amazonaws.devopsguru#__integerMin1Max200" + "target": "com.amazonaws.devopsguru#ListEventsMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } }, "NextToken": { - "target": "com.amazonaws.devopsguru#__stringMin36Max36PatternAF098AF094AF094AF094AF0912" + "target": "com.amazonaws.devopsguru#UuidNextToken", + "traits": { + "smithy.api#documentation": "

The pagination token to use to retrieve \n the next page of results for this operation. If this value is null, it retrieves the first page.

" + } } } }, @@ -1147,10 +1618,17 @@ "type": "structure", "members": { "Events": { - "target": "com.amazonaws.devopsguru#__listOfEvent" + "target": "com.amazonaws.devopsguru#Events", + "traits": { + "smithy.api#documentation": "

\n \t\tA list of the requested events.\n \t

", + "smithy.api#required": {} + } }, "NextToken": { - "target": "com.amazonaws.devopsguru#__stringMin36Max36PatternAF098AF094AF094AF094AF0912" + "target": "com.amazonaws.devopsguru#UuidNextToken", + "traits": { + "smithy.api#documentation": "

The pagination token to use to retrieve \n the next page of results for this operation. If there are no more pages, this value is null.

" + } } } }, @@ -1177,6 +1655,7 @@ } ], "traits": { + "smithy.api#documentation": "

\n \t\tReturns a list of insights in your AWS account. You can specify which insights are returned by their start time and \n \t\tstatus (ONGOING, CLOSED, or ANY).\n \t

", "smithy.api#http": { "method": "POST", "uri": "/insights", @@ -1192,35 +1671,55 @@ "com.amazonaws.devopsguru#ListInsightsAnyStatusFilter": { "type": "structure", "members": { - "StartTimeRange": { - "target": "com.amazonaws.devopsguru#StartTimeRange", + "Type": { + "target": "com.amazonaws.devopsguru#InsightType", "traits": { + "smithy.api#documentation": "

\n \t\tUse to filter for either REACTIVE or PROACTIVE insights.\n \t

", "smithy.api#required": {} } }, - "Type": { - "target": "com.amazonaws.devopsguru#InsightType", + "StartTimeRange": { + "target": "com.amazonaws.devopsguru#StartTimeRange", "traits": { + "smithy.api#documentation": "

\n \t\tA time range used to specify when the behavior of the filtered insights started.\n \t

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

\n \t\tUsed to filter for insights that have any status.\n \t

" } }, "com.amazonaws.devopsguru#ListInsightsClosedStatusFilter": { "type": "structure", "members": { - "EndTimeRange": { - "target": "com.amazonaws.devopsguru#EndTimeRange", + "Type": { + "target": "com.amazonaws.devopsguru#InsightType", "traits": { + "smithy.api#documentation": "

\n \tUse to filter for either REACTIVE or PROACTIVE insights.\n

", "smithy.api#required": {} } }, - "Type": { - "target": "com.amazonaws.devopsguru#InsightType", + "EndTimeRange": { + "target": "com.amazonaws.devopsguru#EndTimeRange", "traits": { + "smithy.api#documentation": "

\n \t\tA time range used to specify when the behavior of the filtered insights ended.\n \t

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

\n \t\tUsed to filter for insights that have the status CLOSED.\n \t

" + } + }, + "com.amazonaws.devopsguru#ListInsightsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1, + "max": 100 + } } }, "com.amazonaws.devopsguru#ListInsightsOngoingStatusFilter": { @@ -1229,54 +1728,86 @@ "Type": { "target": "com.amazonaws.devopsguru#InsightType", "traits": { + "smithy.api#documentation": "

\n \t\tUse to filter for either REACTIVE or PROACTIVE insights.\n \t

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

\n \tUsed to filter for insights that have the status ONGOING.\n

" } }, "com.amazonaws.devopsguru#ListInsightsRequest": { "type": "structure", "members": { - "MaxResults": { - "target": "com.amazonaws.devopsguru#__integerMin1Max100" - }, - "NextToken": { - "target": "com.amazonaws.devopsguru#__stringMin36Max36PatternAF098AF094AF094AF094AF0912" - }, "StatusFilter": { "target": "com.amazonaws.devopsguru#ListInsightsStatusFilter", "traits": { + "smithy.api#documentation": "

\n \tA filter used to filter the returned insights by their status. You can specify one status filter.\n

", "smithy.api#required": {} } + }, + "MaxResults": { + "target": "com.amazonaws.devopsguru#ListInsightsMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.devopsguru#UuidNextToken", + "traits": { + "smithy.api#documentation": "

The pagination token to use to retrieve \n the next page of results for this operation. If this value is null, it retrieves the first page.

" + } } } }, "com.amazonaws.devopsguru#ListInsightsResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.devopsguru#__stringMin36Max36PatternAF098AF094AF094AF094AF0912" - }, "ProactiveInsights": { - "target": "com.amazonaws.devopsguru#__listOfProactiveInsightSummary" + "target": "com.amazonaws.devopsguru#ProactiveInsights", + "traits": { + "smithy.api#documentation": "

\n\t\t\tThe returned list of proactive insights.\n\t\t

" + } }, "ReactiveInsights": { - "target": "com.amazonaws.devopsguru#__listOfReactiveInsightSummary" + "target": "com.amazonaws.devopsguru#ReactiveInsights", + "traits": { + "smithy.api#documentation": "

\n\t\t\tThe returned list of reactive insights.\t\n\t\t

" + } + }, + "NextToken": { + "target": "com.amazonaws.devopsguru#UuidNextToken", + "traits": { + "smithy.api#documentation": "

The pagination token to use to retrieve \n the next page of results for this operation. If there are no more pages, this value is null.

" + } } } }, "com.amazonaws.devopsguru#ListInsightsStatusFilter": { "type": "structure", "members": { - "Any": { - "target": "com.amazonaws.devopsguru#ListInsightsAnyStatusFilter" + "Ongoing": { + "target": "com.amazonaws.devopsguru#ListInsightsOngoingStatusFilter", + "traits": { + "smithy.api#documentation": "

\n \tA ListInsightsAnyStatusFilter that specifies ongoing insights \n \tthat are either REACTIVE or PROACTIVE.\n

" + } }, "Closed": { - "target": "com.amazonaws.devopsguru#ListInsightsClosedStatusFilter" + "target": "com.amazonaws.devopsguru#ListInsightsClosedStatusFilter", + "traits": { + "smithy.api#documentation": "

\n \t\tA ListInsightsClosedStatusFilter that specifies closed insights that are \n \t\teither REACTIVE or PROACTIVE.\n \t

" + } }, - "Ongoing": { - "target": "com.amazonaws.devopsguru#ListInsightsOngoingStatusFilter" + "Any": { + "target": "com.amazonaws.devopsguru#ListInsightsAnyStatusFilter", + "traits": { + "smithy.api#documentation": "

\n \t\tA ListInsightsAnyStatusFilter that specifies insights of any status \n \t\tthat are either REACTIVE or PROACTIVE.\n \t

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

\n \tA filter used by ListInsights to specify which insights to return.\n

" } }, "com.amazonaws.devopsguru#ListNotificationChannels": { @@ -1302,6 +1833,7 @@ } ], "traits": { + "smithy.api#documentation": "

\n \t\tReturns a list of notification channels configured for DevOps Guru. Each notification channel is used to notify you when \n \t\tDevOps Guru generates an insight that contains information about how to improve your operations. The one \n \tsupported notification channel is Amazon Simple Notification Service (Amazon SNS).\n \t

", "smithy.api#http": { "method": "POST", "uri": "/channels", @@ -1318,7 +1850,10 @@ "type": "structure", "members": { "NextToken": { - "target": "com.amazonaws.devopsguru#__stringMin36Max36PatternAF098AF094AF094AF094AF0912" + "target": "com.amazonaws.devopsguru#UuidNextToken", + "traits": { + "smithy.api#documentation": "

The pagination token to use to retrieve \n the next page of results for this operation. If this value is null, it retrieves the first page.

" + } } } }, @@ -1326,10 +1861,16 @@ "type": "structure", "members": { "Channels": { - "target": "com.amazonaws.devopsguru#__listOfNotificationChannel" + "target": "com.amazonaws.devopsguru#Channels", + "traits": { + "smithy.api#documentation": "

\n \t\tAn array that contains the requested notification channels.\n \t

" + } }, "NextToken": { - "target": "com.amazonaws.devopsguru#__stringMin36Max36PatternAF098AF094AF094AF094AF0912" + "target": "com.amazonaws.devopsguru#UuidNextToken", + "traits": { + "smithy.api#documentation": "

The pagination token to use to retrieve \n the next page of results for this operation. If there are no more pages, this value is null.

" + } } } }, @@ -1359,6 +1900,7 @@ } ], "traits": { + "smithy.api#documentation": "

\n \t\tReturns a list of a specified insight's recommendations. Each recommendation includes a list of related metrics and a list of related events.\n \t

", "smithy.api#http": { "method": "POST", "uri": "/recommendations", @@ -1375,36 +1917,61 @@ "type": "structure", "members": { "InsightId": { - "target": "com.amazonaws.devopsguru#__stringMin1Max100PatternW", + "target": "com.amazonaws.devopsguru#InsightId", "traits": { + "smithy.api#documentation": "

\n\t\t\tThe ID of the requested insight.\n\t\t

", "smithy.api#required": {} } }, "NextToken": { - "target": "com.amazonaws.devopsguru#__stringMin36Max36PatternAF098AF094AF094AF094AF0912" + "target": "com.amazonaws.devopsguru#UuidNextToken", + "traits": { + "smithy.api#documentation": "

The pagination token to use to retrieve \n the next page of results for this operation. If this value is null, it retrieves the first page.

" + } } } }, "com.amazonaws.devopsguru#ListRecommendationsResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.devopsguru#__stringMin36Max36PatternAF098AF094AF094AF094AF0912" - }, "Recommendations": { - "target": "com.amazonaws.devopsguru#__listOfRecommendation" + "target": "com.amazonaws.devopsguru#Recommendations", + "traits": { + "smithy.api#documentation": "

\n \t\tAn array of the requested recommendations.\n \t

" + } + }, + "NextToken": { + "target": "com.amazonaws.devopsguru#UuidNextToken", + "traits": { + "smithy.api#documentation": "

The pagination token to use to retrieve \n the next page of results for this operation. If there are no more pages, this value is null.

" + } } } }, + "com.amazonaws.devopsguru#MeanTimeToRecoverInMilliseconds": { + "type": "long", + "traits": { + "smithy.api#box": {} + } + }, "com.amazonaws.devopsguru#NotificationChannel": { "type": "structure", "members": { - "Config": { - "target": "com.amazonaws.devopsguru#NotificationChannelConfig" - }, "Id": { - "target": "com.amazonaws.devopsguru#__stringMin36Max36PatternAF098AF094AF094AF094AF0912" + "target": "com.amazonaws.devopsguru#NotificationChannelId", + "traits": { + "smithy.api#documentation": "

\n\t\t\tThe ID of a notification channel.\n\t\t

" + } + }, + "Config": { + "target": "com.amazonaws.devopsguru#NotificationChannelConfig", + "traits": { + "smithy.api#documentation": "

\n\t\t\tA NotificationChannelConfig object that contains information about configured notification channels.\n\t\t

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

\n\t\t\tInformation about a notification channel. A notification channel is used to notify you when DevOps Guru creates an insight. \n\t\t\tThe one \n \tsupported notification channel is Amazon Simple Notification Service (Amazon SNS).\n\t\t

\n\t\t\n\t\t

If you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission \n\t\t\t\tto it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. \n\t\t\t\tFor more information, see Permissions \n\t\t\t\tfor cross account Amazon SNS topics.

\n\t\t\t\t

If you use an Amazon SNS topic that is encrypted by an AWS Key Management Service customer-managed key (CMK), then you must add permissions \n\t\t\t\tto the CMK. For more information, see Permissions for \n\t\t\t\tAWS KMS–encrypted Amazon SNS topics.

" } }, "com.amazonaws.devopsguru#NotificationChannelConfig": { @@ -1413,30 +1980,72 @@ "Sns": { "target": "com.amazonaws.devopsguru#SnsChannelConfig", "traits": { + "smithy.api#documentation": "

\n\t\t\tInformation about a notification channel configured in DevOps Guru to send notifications when insights are created.\n\t\t

\n\t\t\n\t\t

If you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission \n\t\t\t\tto it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. \n\t\t\t\tFor more information, see Permissions \n\t\t\t\tfor cross account Amazon SNS topics.

\n\t\t\t\t

If you use an Amazon SNS topic that is encrypted by an AWS Key Management Service customer-managed key (CMK), then you must add permissions \n\t\t\t\tto the CMK. For more information, see Permissions for \n\t\t\t\tAWS KMS–encrypted Amazon SNS topics.

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

Information about notification channels you have configured with DevOps Guru.\n\t\t\tThe one \n \tsupported notification channel is Amazon Simple Notification Service (Amazon SNS).

" + } + }, + "com.amazonaws.devopsguru#NotificationChannelId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 36, + "max": 36 + }, + "smithy.api#pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" } }, + "com.amazonaws.devopsguru#NumMetricsAnalyzed": { + "type": "integer" + }, + "com.amazonaws.devopsguru#NumOpenProactiveInsights": { + "type": "integer" + }, + "com.amazonaws.devopsguru#NumOpenReactiveInsights": { + "type": "integer" + }, + "com.amazonaws.devopsguru#NumProactiveInsights": { + "type": "integer" + }, + "com.amazonaws.devopsguru#NumReactiveInsights": { + "type": "integer" + }, "com.amazonaws.devopsguru#OpsCenterIntegration": { "type": "structure", "members": { "OptInStatus": { - "target": "com.amazonaws.devopsguru#OptInStatus" + "target": "com.amazonaws.devopsguru#OptInStatus", + "traits": { + "smithy.api#documentation": "

\n\t\t\tSpecifies if DevOps Guru is enabled to create an AWS Systems Manager OpsItem for each created insight.\n\t\t

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

\n\t\t\tInformation about whether DevOps Guru is configured to create an OpsItem in AWS Systems Manager OpsCenter for each created insight.\n\t\t

" } }, "com.amazonaws.devopsguru#OpsCenterIntegrationConfig": { "type": "structure", "members": { "OptInStatus": { - "target": "com.amazonaws.devopsguru#OptInStatus" + "target": "com.amazonaws.devopsguru#OptInStatus", + "traits": { + "smithy.api#documentation": "

\n\t\t\tSpecifies if DevOps Guru is enabled to create an AWS Systems Manager OpsItem for each created insight.\n\t\t

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

\n\t\t\tInformation about whether DevOps Guru is configured to create an OpsItem in AWS Systems Manager OpsCenter for each created insight.\n\t\t

" } }, "com.amazonaws.devopsguru#OptInStatus": { "type": "string", "traits": { + "smithy.api#documentation": "

\n\t\t\tSpecifies if DevOps Guru is enabled to create an AWS Systems Manager OpsItem for each created insight.\n\t\t

", "smithy.api#enum": [ { "value": "ENABLED", @@ -1452,140 +2061,240 @@ "com.amazonaws.devopsguru#PredictionTimeRange": { "type": "structure", "members": { - "EndTime": { - "target": "com.amazonaws.devopsguru#__timestampUnix" - }, "StartTime": { - "target": "com.amazonaws.devopsguru#__timestampUnix", + "target": "com.amazonaws.devopsguru#Timestamp", "traits": { + "smithy.api#documentation": "

\n\t\t\tThe time range during which a metric limit is expected to be exceeded. This applies to proactive insights only.\n\t\t

", "smithy.api#required": {} } + }, + "EndTime": { + "target": "com.amazonaws.devopsguru#Timestamp", + "traits": { + "smithy.api#documentation": "

\n\t\t\tThe time when the behavior in a proactive insight is expected to end.\n\t\t

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

\n\t\t\tThe time range during which anomalous behavior in a proactive anomaly or an insight is expected to occur. \n\t\t

" + } + }, + "com.amazonaws.devopsguru#ProactiveAnomalies": { + "type": "list", + "member": { + "target": "com.amazonaws.devopsguru#ProactiveAnomalySummary" } }, "com.amazonaws.devopsguru#ProactiveAnomaly": { "type": "structure", "members": { - "AnomalyTimeRange": { - "target": "com.amazonaws.devopsguru#AnomalyTimeRange" + "Id": { + "target": "com.amazonaws.devopsguru#AnomalyId", + "traits": { + "smithy.api#documentation": "

\n\t\t\tThe ID of a proactive anomaly.\n\t\t

" + } }, - "AssociatedInsightId": { - "target": "com.amazonaws.devopsguru#__stringMin1Max100PatternW" + "Severity": { + "target": "com.amazonaws.devopsguru#AnomalySeverity", + "traits": { + "smithy.api#documentation": "

\n\t\t\tThe severity of a proactive anomaly.\n\t\t

" + } }, - "Id": { - "target": "com.amazonaws.devopsguru#__stringMin1Max100PatternW" + "Status": { + "target": "com.amazonaws.devopsguru#AnomalyStatus", + "traits": { + "smithy.api#documentation": "

\n\t\t\tThe status of a proactive anomaly.\n\t\t

" + } }, - "Limit": { - "target": "com.amazonaws.devopsguru#__double" + "UpdateTime": { + "target": "com.amazonaws.devopsguru#Timestamp", + "traits": { + "smithy.api#documentation": "

\n\t\t\tThe time of the anomaly's most recent update.\n\t\t

" + } + }, + "AnomalyTimeRange": { + "target": "com.amazonaws.devopsguru#AnomalyTimeRange" }, "PredictionTimeRange": { "target": "com.amazonaws.devopsguru#PredictionTimeRange" }, - "ResourceCollection": { - "target": "com.amazonaws.devopsguru#ResourceCollection" - }, - "Severity": { - "target": "com.amazonaws.devopsguru#AnomalySeverity" - }, "SourceDetails": { - "target": "com.amazonaws.devopsguru#AnomalySourceDetails" + "target": "com.amazonaws.devopsguru#AnomalySourceDetails", + "traits": { + "smithy.api#documentation": "

\n\t\t\tDetails about the source of the analyzed operational data that triggered the anomaly. The one supported source is Amazon CloudWatch metrics. \n\t\t

" + } }, - "Status": { - "target": "com.amazonaws.devopsguru#AnomalyStatus" + "AssociatedInsightId": { + "target": "com.amazonaws.devopsguru#InsightId", + "traits": { + "smithy.api#documentation": "

\n\t\t\tThe ID of the insight that contains this anomaly. An insight is composed of related anomalies.\n\t\t

" + } }, - "UpdateTime": { - "target": "com.amazonaws.devopsguru#__timestampUnix" + "ResourceCollection": { + "target": "com.amazonaws.devopsguru#ResourceCollection" + }, + "Limit": { + "target": "com.amazonaws.devopsguru#AnomalyLimit", + "traits": { + "smithy.api#documentation": "

\n\t\t\tA threshold that was exceeded by behavior in analyzed resources. Exceeding this\n\t\t\tthreshold is related to the anomalous behavior that generated this anomaly.\n\t\t

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

Information about an anomaly. This object is returned by ListAnomalies.

" } }, "com.amazonaws.devopsguru#ProactiveAnomalySummary": { "type": "structure", "members": { - "AnomalyTimeRange": { - "target": "com.amazonaws.devopsguru#AnomalyTimeRange" - }, - "AssociatedInsightId": { - "target": "com.amazonaws.devopsguru#__stringMin1Max100PatternW" - }, "Id": { - "target": "com.amazonaws.devopsguru#__stringMin1Max100PatternW" + "target": "com.amazonaws.devopsguru#AnomalyId", + "traits": { + "smithy.api#documentation": "

The ID of the anomaly.

" + } }, - "Limit": { - "target": "com.amazonaws.devopsguru#__double" + "Severity": { + "target": "com.amazonaws.devopsguru#AnomalySeverity", + "traits": { + "smithy.api#documentation": "

The severity of the anomaly.

" + } }, - "PredictionTimeRange": { - "target": "com.amazonaws.devopsguru#PredictionTimeRange" + "Status": { + "target": "com.amazonaws.devopsguru#AnomalyStatus", + "traits": { + "smithy.api#documentation": "

The status of the anomaly.

" + } }, - "ResourceCollection": { - "target": "com.amazonaws.devopsguru#ResourceCollection" + "UpdateTime": { + "target": "com.amazonaws.devopsguru#Timestamp", + "traits": { + "smithy.api#documentation": "

\n\t\t\tThe time of the anomaly's most recent update.\n\t\t

" + } }, - "Severity": { - "target": "com.amazonaws.devopsguru#AnomalySeverity" + "AnomalyTimeRange": { + "target": "com.amazonaws.devopsguru#AnomalyTimeRange" + }, + "PredictionTimeRange": { + "target": "com.amazonaws.devopsguru#PredictionTimeRange" }, "SourceDetails": { - "target": "com.amazonaws.devopsguru#AnomalySourceDetails" + "target": "com.amazonaws.devopsguru#AnomalySourceDetails", + "traits": { + "smithy.api#documentation": "

\n\t\t\tDetails about the source of the analyzed operational data that triggered the anomaly. The one supported source is Amazon CloudWatch metrics. \n\t\t

" + } }, - "Status": { - "target": "com.amazonaws.devopsguru#AnomalyStatus" + "AssociatedInsightId": { + "target": "com.amazonaws.devopsguru#InsightId", + "traits": { + "smithy.api#documentation": "

\n\t\t\tThe ID of the insight that contains this anomaly. An insight is composed of related anomalies.\n\t\t

" + } }, - "UpdateTime": { - "target": "com.amazonaws.devopsguru#__timestampUnix" + "ResourceCollection": { + "target": "com.amazonaws.devopsguru#ResourceCollection" + }, + "Limit": { + "target": "com.amazonaws.devopsguru#AnomalyLimit", + "traits": { + "smithy.api#documentation": "

\n\t\t\tA threshold that was exceeded by behavior in analyzed resources. Exceeding this\n\t\t\tthreshold is related to the anomalous behavior that generated this anomaly.\n\t\t

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

Details about a proactive anomaly. This object is returned by\n\t\t\tDescribeAnomaly.\n

" } }, "com.amazonaws.devopsguru#ProactiveInsight": { "type": "structure", "members": { "Id": { - "target": "com.amazonaws.devopsguru#__stringMin1Max100PatternW" + "target": "com.amazonaws.devopsguru#InsightId", + "traits": { + "smithy.api#documentation": "

The ID of the proactive insight.

" + } + }, + "Name": { + "target": "com.amazonaws.devopsguru#InsightName", + "traits": { + "smithy.api#documentation": "

The name of the proactive insight.

" + } + }, + "Severity": { + "target": "com.amazonaws.devopsguru#InsightSeverity", + "traits": { + "smithy.api#documentation": "

The severity of the proactive insight.

" + } + }, + "Status": { + "target": "com.amazonaws.devopsguru#InsightStatus", + "traits": { + "smithy.api#documentation": "

The status of the proactive insight.

" + } }, "InsightTimeRange": { "target": "com.amazonaws.devopsguru#InsightTimeRange" }, - "Name": { - "target": "com.amazonaws.devopsguru#__stringMin1Max530PatternSS" - }, "PredictionTimeRange": { "target": "com.amazonaws.devopsguru#PredictionTimeRange" }, "ResourceCollection": { "target": "com.amazonaws.devopsguru#ResourceCollection" }, - "Severity": { - "target": "com.amazonaws.devopsguru#InsightSeverity" - }, "SsmOpsItemId": { - "target": "com.amazonaws.devopsguru#__stringMin1Max100Pattern" - }, - "Status": { - "target": "com.amazonaws.devopsguru#InsightStatus" + "target": "com.amazonaws.devopsguru#SsmOpsItemId", + "traits": { + "smithy.api#documentation": "

\n\t\t\tThe ID of the AWS System Manager OpsItem created for this insight. You must enable \n\t\t\tthe creation of OpstItems insights before they are created for each insight.\n\t\t

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

Details about a proactive insight. This object is returned by ListInsights.

" } }, "com.amazonaws.devopsguru#ProactiveInsightSummary": { "type": "structure", "members": { "Id": { - "target": "com.amazonaws.devopsguru#__stringMin1Max100PatternW" + "target": "com.amazonaws.devopsguru#InsightId", + "traits": { + "smithy.api#documentation": "

The ID of the proactive insight.

" + } + }, + "Name": { + "target": "com.amazonaws.devopsguru#InsightName", + "traits": { + "smithy.api#documentation": "

The name of the proactive insight.

" + } + }, + "Severity": { + "target": "com.amazonaws.devopsguru#InsightSeverity", + "traits": { + "smithy.api#documentation": "

The severity of the proactive insight.

" + } + }, + "Status": { + "target": "com.amazonaws.devopsguru#InsightStatus", + "traits": { + "smithy.api#documentation": "

The status of the proactive insight.

" + } }, "InsightTimeRange": { "target": "com.amazonaws.devopsguru#InsightTimeRange" }, - "Name": { - "target": "com.amazonaws.devopsguru#__stringMin1Max530PatternSS" - }, "PredictionTimeRange": { "target": "com.amazonaws.devopsguru#PredictionTimeRange" }, "ResourceCollection": { "target": "com.amazonaws.devopsguru#ResourceCollection" - }, - "Severity": { - "target": "com.amazonaws.devopsguru#InsightSeverity" - }, - "Status": { - "target": "com.amazonaws.devopsguru#InsightStatus" } + }, + "traits": { + "smithy.api#documentation": "

Details about a proactive insight. This object is returned by\n\t\t\tDescribeInsight.\n

" + } + }, + "com.amazonaws.devopsguru#ProactiveInsights": { + "type": "list", + "member": { + "target": "com.amazonaws.devopsguru#ProactiveInsightSummary" } }, "com.amazonaws.devopsguru#PutFeedback": { @@ -1617,6 +2326,7 @@ } ], "traits": { + "smithy.api#documentation": "

\n \t\tCollects customer feedback about the specified insight.\n \t

", "smithy.api#http": { "method": "PUT", "uri": "/feedback", @@ -1628,7 +2338,10 @@ "type": "structure", "members": { "InsightFeedback": { - "target": "com.amazonaws.devopsguru#InsightFeedback" + "target": "com.amazonaws.devopsguru#InsightFeedback", + "traits": { + "smithy.api#documentation": "

\n \t\tThe feedback from customers is about the recommendations in this insight.\n \t

" + } } } }, @@ -1636,193 +2349,427 @@ "type": "structure", "members": {} }, + "com.amazonaws.devopsguru#ReactiveAnomalies": { + "type": "list", + "member": { + "target": "com.amazonaws.devopsguru#ReactiveAnomalySummary" + } + }, "com.amazonaws.devopsguru#ReactiveAnomaly": { "type": "structure", "members": { + "Id": { + "target": "com.amazonaws.devopsguru#AnomalyId", + "traits": { + "smithy.api#documentation": "

The ID of the reactive anomaly.

" + } + }, + "Severity": { + "target": "com.amazonaws.devopsguru#AnomalySeverity", + "traits": { + "smithy.api#documentation": "

The severity of the anomaly.

" + } + }, + "Status": { + "target": "com.amazonaws.devopsguru#AnomalyStatus", + "traits": { + "smithy.api#documentation": "

\n\t\t\tThe status of the anomaly.\n\t\t

" + } + }, "AnomalyTimeRange": { "target": "com.amazonaws.devopsguru#AnomalyTimeRange" }, - "AssociatedInsightId": { - "target": "com.amazonaws.devopsguru#__stringMin1Max100PatternW" + "SourceDetails": { + "target": "com.amazonaws.devopsguru#AnomalySourceDetails", + "traits": { + "smithy.api#documentation": "

\n\t\t\tDetails about the source of the analyzed operational data that triggered the anomaly. The one supported source is Amazon CloudWatch metrics. \n\t\t

" + } }, - "Id": { - "target": "com.amazonaws.devopsguru#__stringMin1Max100PatternW" + "AssociatedInsightId": { + "target": "com.amazonaws.devopsguru#InsightId", + "traits": { + "smithy.api#documentation": "

\n\t\t\tThe ID of the insight that contains this anomaly. An insight is composed of related anomalies.\n\t\t

" + } }, "ResourceCollection": { "target": "com.amazonaws.devopsguru#ResourceCollection" - }, - "Severity": { - "target": "com.amazonaws.devopsguru#AnomalySeverity" - }, - "SourceDetails": { - "target": "com.amazonaws.devopsguru#AnomalySourceDetails" - }, - "Status": { - "target": "com.amazonaws.devopsguru#AnomalyStatus" } + }, + "traits": { + "smithy.api#documentation": "

Details about a reactive anomaly. This object is returned by ListAnomalies.

" } }, "com.amazonaws.devopsguru#ReactiveAnomalySummary": { "type": "structure", "members": { + "Id": { + "target": "com.amazonaws.devopsguru#AnomalyId", + "traits": { + "smithy.api#documentation": "

\n\t\t\tThe ID of the reactive anomaly.\n\t\t

" + } + }, + "Severity": { + "target": "com.amazonaws.devopsguru#AnomalySeverity", + "traits": { + "smithy.api#documentation": "

\n\t\t\tThe severity of the reactive anomaly.\t\t\t\n\t\t

" + } + }, + "Status": { + "target": "com.amazonaws.devopsguru#AnomalyStatus", + "traits": { + "smithy.api#documentation": "

\n\t\t\tThe status of the reactive anomaly.\n\t\t

" + } + }, "AnomalyTimeRange": { "target": "com.amazonaws.devopsguru#AnomalyTimeRange" }, - "AssociatedInsightId": { - "target": "com.amazonaws.devopsguru#__stringMin1Max100PatternW" + "SourceDetails": { + "target": "com.amazonaws.devopsguru#AnomalySourceDetails", + "traits": { + "smithy.api#documentation": "

\n\t\t\tDetails about the source of the analyzed operational data that triggered the anomaly. The one supported source is Amazon CloudWatch metrics. \n\t\t

" + } }, - "Id": { - "target": "com.amazonaws.devopsguru#__stringMin1Max100PatternW" + "AssociatedInsightId": { + "target": "com.amazonaws.devopsguru#InsightId", + "traits": { + "smithy.api#documentation": "

\n\t\t\tThe ID of the insight that contains this anomaly. An insight is composed of related anomalies.\n\t\t

" + } }, "ResourceCollection": { "target": "com.amazonaws.devopsguru#ResourceCollection" - }, - "Severity": { - "target": "com.amazonaws.devopsguru#AnomalySeverity" - }, - "SourceDetails": { - "target": "com.amazonaws.devopsguru#AnomalySourceDetails" - }, - "Status": { - "target": "com.amazonaws.devopsguru#AnomalyStatus" } + }, + "traits": { + "smithy.api#documentation": "

Details about a reactive anomaly. This object is returned by\n\t\t\tDescribeAnomaly.\n

" } }, "com.amazonaws.devopsguru#ReactiveInsight": { "type": "structure", "members": { "Id": { - "target": "com.amazonaws.devopsguru#__stringMin1Max100PatternW" + "target": "com.amazonaws.devopsguru#InsightId", + "traits": { + "smithy.api#documentation": "

\n\t\t\tThe ID of a reactive insight.\n\t\t

" + } + }, + "Name": { + "target": "com.amazonaws.devopsguru#InsightName", + "traits": { + "smithy.api#documentation": "

\n\t\t\tThe name of a reactive insight.\n\t\t

" + } + }, + "Severity": { + "target": "com.amazonaws.devopsguru#InsightSeverity", + "traits": { + "smithy.api#documentation": "

\n\t\t\tThe severity of a reactive insight.\n\t\t

" + } + }, + "Status": { + "target": "com.amazonaws.devopsguru#InsightStatus", + "traits": { + "smithy.api#documentation": "

\n\t\t\tThe status of a reactive insight.\n\t\t

" + } }, "InsightTimeRange": { "target": "com.amazonaws.devopsguru#InsightTimeRange" }, - "Name": { - "target": "com.amazonaws.devopsguru#__stringMin1Max530PatternSS" - }, "ResourceCollection": { "target": "com.amazonaws.devopsguru#ResourceCollection" }, - "Severity": { - "target": "com.amazonaws.devopsguru#InsightSeverity" - }, "SsmOpsItemId": { - "target": "com.amazonaws.devopsguru#__stringMin1Max100Pattern" - }, - "Status": { - "target": "com.amazonaws.devopsguru#InsightStatus" + "target": "com.amazonaws.devopsguru#SsmOpsItemId", + "traits": { + "smithy.api#documentation": "

\n\t\t\tThe ID of the AWS System Manager OpsItem created for this insight. You must enable \n\t\t\tthe creation of OpstItems insights before they are created for each insight.\n\t\t

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

\n\t\t\tInformation about a reactive insight. This object is returned by ListInsights.\n\t\t

" } }, "com.amazonaws.devopsguru#ReactiveInsightSummary": { "type": "structure", "members": { "Id": { - "target": "com.amazonaws.devopsguru#__stringMin1Max100PatternW" - }, - "InsightTimeRange": { - "target": "com.amazonaws.devopsguru#InsightTimeRange" + "target": "com.amazonaws.devopsguru#InsightId", + "traits": { + "smithy.api#documentation": "

\n\t\t\tThe ID of a reactive summary.\n\t\t

" + } }, "Name": { - "target": "com.amazonaws.devopsguru#__stringMin1Max530PatternSS" - }, - "ResourceCollection": { - "target": "com.amazonaws.devopsguru#ResourceCollection" + "target": "com.amazonaws.devopsguru#InsightName", + "traits": { + "smithy.api#documentation": "

\n\t\t\tThe name of a reactive insight.\n\t\t

" + } }, "Severity": { - "target": "com.amazonaws.devopsguru#InsightSeverity" + "target": "com.amazonaws.devopsguru#InsightSeverity", + "traits": { + "smithy.api#documentation": "

\n\t\t\tThe severity of a reactive insight.\n\t\t

" + } }, "Status": { - "target": "com.amazonaws.devopsguru#InsightStatus" + "target": "com.amazonaws.devopsguru#InsightStatus", + "traits": { + "smithy.api#documentation": "

\n\t\t\tThe status of a reactive insight.\n\t\t

" + } + }, + "InsightTimeRange": { + "target": "com.amazonaws.devopsguru#InsightTimeRange" + }, + "ResourceCollection": { + "target": "com.amazonaws.devopsguru#ResourceCollection" } + }, + "traits": { + "smithy.api#documentation": "

Information about a reactive insight. This object is returned by\n\t\t\t\tDescribeInsight.\n

" + } + }, + "com.amazonaws.devopsguru#ReactiveInsights": { + "type": "list", + "member": { + "target": "com.amazonaws.devopsguru#ReactiveInsightSummary" } }, "com.amazonaws.devopsguru#Recommendation": { "type": "structure", "members": { "Description": { - "target": "com.amazonaws.devopsguru#__string" + "target": "com.amazonaws.devopsguru#RecommendationDescription", + "traits": { + "smithy.api#documentation": "

\n\t\t\tA description of the problem.\n\t\t

" + } }, "Link": { - "target": "com.amazonaws.devopsguru#__string" + "target": "com.amazonaws.devopsguru#RecommendationLink", + "traits": { + "smithy.api#documentation": "

\n\t\t\tA hyperlink to information to help you address the problem.\n\t\t

" + } }, "Name": { - "target": "com.amazonaws.devopsguru#__string" + "target": "com.amazonaws.devopsguru#RecommendationName", + "traits": { + "smithy.api#documentation": "

\n\t\t\tThe name of the recommendation.\n\t\t

" + } }, "Reason": { - "target": "com.amazonaws.devopsguru#__string" - }, - "RelatedAnomalies": { - "target": "com.amazonaws.devopsguru#__listOfRecommendationRelatedAnomaly" + "target": "com.amazonaws.devopsguru#RecommendationReason", + "traits": { + "smithy.api#documentation": "

\n\t\t\tThe reason DevOps Guru flagged the anomalous behavior as a problem.\n\t\t

" + } }, "RelatedEvents": { - "target": "com.amazonaws.devopsguru#__listOfRecommendationRelatedEvent" + "target": "com.amazonaws.devopsguru#RecommendationRelatedEvents", + "traits": { + "smithy.api#documentation": "

\n\t\t\tEvents that are related to the problem. Use these events to learn more about what's happening and to help address the issue.\n\t\t

" + } + }, + "RelatedAnomalies": { + "target": "com.amazonaws.devopsguru#RecommendationRelatedAnomalies", + "traits": { + "smithy.api#documentation": "

\n\t\t\tAnomalies that are related to the problem. Use these Anomalies to learn more about what's happening and to help address the issue.\n\t\t

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

Recommendation information to help you remediate detected anomalous behavior that\n\t\t\tgenerated an insight.

" + } + }, + "com.amazonaws.devopsguru#RecommendationDescription": { + "type": "string" + }, + "com.amazonaws.devopsguru#RecommendationLink": { + "type": "string" + }, + "com.amazonaws.devopsguru#RecommendationName": { + "type": "string" + }, + "com.amazonaws.devopsguru#RecommendationReason": { + "type": "string" + }, + "com.amazonaws.devopsguru#RecommendationRelatedAnomalies": { + "type": "list", + "member": { + "target": "com.amazonaws.devopsguru#RecommendationRelatedAnomaly" } }, "com.amazonaws.devopsguru#RecommendationRelatedAnomaly": { "type": "structure", "members": { "Resources": { - "target": "com.amazonaws.devopsguru#__listOfRecommendationRelatedAnomalyResource" + "target": "com.amazonaws.devopsguru#RecommendationRelatedAnomalyResources", + "traits": { + "smithy.api#documentation": "

\n\t\t\tAn array of objects that represent resources in which DevOps Guru detected anomalous behavior. Each object contains the name \n\t\t\tand type of the resource.\n\t\t

" + } }, "SourceDetails": { - "target": "com.amazonaws.devopsguru#__listOfRecommendationRelatedAnomalySourceDetail" + "target": "com.amazonaws.devopsguru#RelatedAnomalySourceDetails", + "traits": { + "smithy.api#documentation": "

\n\t\t\tInformation about where the anomalous behavior related the recommendation was found. For example, details in Amazon CloudWatch metrics.\n\t\t

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

\n\t\t\tInformation about an anomaly that is related to a recommendation.\n\t\t

" } }, "com.amazonaws.devopsguru#RecommendationRelatedAnomalyResource": { "type": "structure", "members": { "Name": { - "target": "com.amazonaws.devopsguru#__string" + "target": "com.amazonaws.devopsguru#RecommendationRelatedAnomalyResourceName", + "traits": { + "smithy.api#documentation": "

\n\t\t\tThe name of the resource.\n\t\t

" + } }, "Type": { - "target": "com.amazonaws.devopsguru#__string" + "target": "com.amazonaws.devopsguru#RecommendationRelatedAnomalyResourceType", + "traits": { + "smithy.api#documentation": "

\n\t\t\tThe type of the resource.\n\t\t

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

\n\t\t\tInformation about a resource in which DevOps Guru detected anomalous behavior.\n\t\t

" + } + }, + "com.amazonaws.devopsguru#RecommendationRelatedAnomalyResourceName": { + "type": "string" + }, + "com.amazonaws.devopsguru#RecommendationRelatedAnomalyResourceType": { + "type": "string" + }, + "com.amazonaws.devopsguru#RecommendationRelatedAnomalyResources": { + "type": "list", + "member": { + "target": "com.amazonaws.devopsguru#RecommendationRelatedAnomalyResource" } }, "com.amazonaws.devopsguru#RecommendationRelatedAnomalySourceDetail": { "type": "structure", "members": { "CloudWatchMetrics": { - "target": "com.amazonaws.devopsguru#__listOfRecommendationRelatedCloudWatchMetricsSourceDetail" + "target": "com.amazonaws.devopsguru#RecommendationRelatedCloudWatchMetricsSourceDetails", + "traits": { + "smithy.api#documentation": "

An array of CloudWatchMetricsDetail objects that contains information\n\t\t\tabout the analyzed metrics that displayed anomalous behavior.

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

\n\t\t\tContains an array of RecommendationRelatedCloudWatchMetricsSourceDetail objects that contain the name \n\t\t\tand namespace of an Amazon CloudWatch metric.\n\t\t

" } }, "com.amazonaws.devopsguru#RecommendationRelatedCloudWatchMetricsSourceDetail": { "type": "structure", "members": { "MetricName": { - "target": "com.amazonaws.devopsguru#__string" + "target": "com.amazonaws.devopsguru#RecommendationRelatedCloudWatchMetricsSourceMetricName", + "traits": { + "smithy.api#documentation": "

The name of the CloudWatch metric.

" + } }, "Namespace": { - "target": "com.amazonaws.devopsguru#__string" + "target": "com.amazonaws.devopsguru#RecommendationRelatedCloudWatchMetricsSourceNamespace", + "traits": { + "smithy.api#documentation": "

The namespace of the CloudWatch metric. A namespace is a container for CloudWatch metrics.

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

\n\t\t\tInformation about an Amazon CloudWatch metric that is analyzed by DevOps Guru. It is one of many analyzed metrics \n\t\t\tthat are used to generate insights.\n\t\t

" } }, + "com.amazonaws.devopsguru#RecommendationRelatedCloudWatchMetricsSourceDetails": { + "type": "list", + "member": { + "target": "com.amazonaws.devopsguru#RecommendationRelatedCloudWatchMetricsSourceDetail" + } + }, + "com.amazonaws.devopsguru#RecommendationRelatedCloudWatchMetricsSourceMetricName": { + "type": "string" + }, + "com.amazonaws.devopsguru#RecommendationRelatedCloudWatchMetricsSourceNamespace": { + "type": "string" + }, "com.amazonaws.devopsguru#RecommendationRelatedEvent": { "type": "structure", "members": { "Name": { - "target": "com.amazonaws.devopsguru#__string" + "target": "com.amazonaws.devopsguru#RecommendationRelatedEventName", + "traits": { + "smithy.api#documentation": "

\n\t\t\tThe name of the event. This corresponds to the Name field in an \n\t\t\tEvent object.\n\t\t

" + } }, "Resources": { - "target": "com.amazonaws.devopsguru#__listOfRecommendationRelatedEventResource" + "target": "com.amazonaws.devopsguru#RecommendationRelatedEventResources", + "traits": { + "smithy.api#documentation": "

\n\t\t\tA ResourceCollection object that contains arrays of the names of AWS \n\t\t\tCloudFormation stacks.\n\t\t

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

\n\t\t\tInformation about an event that is related to a recommendation.\n\t\t

" } }, + "com.amazonaws.devopsguru#RecommendationRelatedEventName": { + "type": "string" + }, "com.amazonaws.devopsguru#RecommendationRelatedEventResource": { "type": "structure", "members": { "Name": { - "target": "com.amazonaws.devopsguru#__string" + "target": "com.amazonaws.devopsguru#RecommendationRelatedEventResourceName", + "traits": { + "smithy.api#documentation": "

\n\t\t\tThe name of the resource that emitted the event. This corresponds to the Name field in an \n\t\t\tEventResource object.\n\t\t

" + } }, "Type": { - "target": "com.amazonaws.devopsguru#__string" + "target": "com.amazonaws.devopsguru#RecommendationRelatedEventResourceType", + "traits": { + "smithy.api#documentation": "

\n\t\t\tThe type of the resource that emitted the event. This corresponds to the Type field in an \n\t\t\tEventResource object.\n\t\t

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

\n\t\t\tInformation about an AWS resource that emitted and event that is related to a recommendation in an insight. \n\t\t

" + } + }, + "com.amazonaws.devopsguru#RecommendationRelatedEventResourceName": { + "type": "string" + }, + "com.amazonaws.devopsguru#RecommendationRelatedEventResourceType": { + "type": "string" + }, + "com.amazonaws.devopsguru#RecommendationRelatedEventResources": { + "type": "list", + "member": { + "target": "com.amazonaws.devopsguru#RecommendationRelatedEventResource" + } + }, + "com.amazonaws.devopsguru#RecommendationRelatedEvents": { + "type": "list", + "member": { + "target": "com.amazonaws.devopsguru#RecommendationRelatedEvent" + } + }, + "com.amazonaws.devopsguru#Recommendations": { + "type": "list", + "member": { + "target": "com.amazonaws.devopsguru#Recommendation" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 } } }, + "com.amazonaws.devopsguru#RelatedAnomalySourceDetails": { + "type": "list", + "member": { + "target": "com.amazonaws.devopsguru#RecommendationRelatedAnomalySourceDetail" + } + }, "com.amazonaws.devopsguru#RemoveNotificationChannel": { "type": "operation", "input": { @@ -1852,6 +2799,7 @@ } ], "traits": { + "smithy.api#documentation": "

\n \t\tRemoves a notification channel from DevOps Guru. A notification channel is used to notify you when DevOps Guru generates an insight \n \t\tthat contains information about how to improve your operations.\n \t

", "smithy.api#http": { "method": "DELETE", "uri": "/channels/{Id}", @@ -1863,8 +2811,9 @@ "type": "structure", "members": { "Id": { - "target": "com.amazonaws.devopsguru#__string", + "target": "com.amazonaws.devopsguru#NotificationChannelId", "traits": { + "smithy.api#documentation": "

\n \t\tThe ID of the notification channel to be removed.\n \t

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1879,45 +2828,80 @@ "type": "structure", "members": { "CloudFormation": { - "target": "com.amazonaws.devopsguru#CloudFormationCollection" + "target": "com.amazonaws.devopsguru#CloudFormationCollection", + "traits": { + "smithy.api#documentation": "

An array of the names of AWS CloudFormation stacks. The stacks define AWS resources\n \t\tthat DevOps Guru analyzes. \n \t

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

\n\t\t\tA collection of AWS resources supported by DevOps Guru. The one type of AWS resource collection supported is AWS CloudFormation stacks. DevOps Guru can be configured to analyze \n \tonly the AWS resources that are defined in the stacks.\n\t\t

" } }, "com.amazonaws.devopsguru#ResourceCollectionFilter": { "type": "structure", "members": { "CloudFormation": { - "target": "com.amazonaws.devopsguru#CloudFormationCollectionFilter" + "target": "com.amazonaws.devopsguru#CloudFormationCollectionFilter", + "traits": { + "smithy.api#documentation": "

\n\t\t\tInformation about AWS CloudFormation stacks. You can use stacks to specify which AWS resources in your account to analyze. \n\t\t\tFor more information, see Stacks \n\t\t\tin the AWS CloudFormation User Guide.\n\t\t

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

\n\t\t\tInformation about a filter used to specify which AWS resources are analyzed for anomalous behavior by DevOps Guru.\n\t\t

" + } + }, + "com.amazonaws.devopsguru#ResourceCollectionType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "AWS_CLOUD_FORMATION", + "name": "AWS_CLOUD_FORMATION" + } + ] } }, + "com.amazonaws.devopsguru#ResourceIdString": { + "type": "string" + }, + "com.amazonaws.devopsguru#ResourceIdType": { + "type": "string" + }, "com.amazonaws.devopsguru#ResourceNotFoundException": { "type": "structure", "members": { "Message": { - "target": "com.amazonaws.devopsguru#__string", + "target": "com.amazonaws.devopsguru#ErrorMessageString", "traits": { "smithy.api#required": {} } }, "ResourceId": { - "target": "com.amazonaws.devopsguru#__string", + "target": "com.amazonaws.devopsguru#ResourceIdString", "traits": { + "smithy.api#documentation": "

\n\t\t\tThe ID of the AWS resource that could not be found.\n\t\t

", "smithy.api#required": {} } }, "ResourceType": { - "target": "com.amazonaws.devopsguru#__string", + "target": "com.amazonaws.devopsguru#ResourceIdType", "traits": { + "smithy.api#documentation": "

\n\t\t\tThe type of the AWS resource that could not be found.\n\t\t

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

A requested resource could not be found

", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, + "com.amazonaws.devopsguru#RetryAfterSeconds": { + "type": "integer" + }, "com.amazonaws.devopsguru#SearchInsights": { "type": "operation", "input": { @@ -1941,6 +2925,7 @@ } ], "traits": { + "smithy.api#documentation": "

\n \t\tReturns a list of insights in your AWS account. You can specify which insights are returned by their start time, one or more statuses \n \t\t(ONGOING, CLOSED, and CLOSED), one or more severities (LOW, MEDIUM, \n \t\tand HIGH), and type (REACTIVE or PROACTIVE).\n \t

\n \t

\n \t\tUse the Filters parameter to specify status and severity \n \t\tsearch parameters. Use the Type parameter to specify REACTIVE or PROACTIVE in your search.\n \t

", "smithy.api#http": { "method": "POST", "uri": "/insights/search", @@ -1956,38 +2941,68 @@ "com.amazonaws.devopsguru#SearchInsightsFilters": { "type": "structure", "members": { - "ResourceCollection": { - "target": "com.amazonaws.devopsguru#ResourceCollection" - }, "Severities": { - "target": "com.amazonaws.devopsguru#__listOfInsightSeverity" + "target": "com.amazonaws.devopsguru#InsightSeverities", + "traits": { + "smithy.api#documentation": "

\n \t\tAn array of severity values used to search for insights.\n \t

" + } }, "Statuses": { - "target": "com.amazonaws.devopsguru#__listOfInsightStatus" + "target": "com.amazonaws.devopsguru#InsightStatuses", + "traits": { + "smithy.api#documentation": "

\n \t\tAn array of status values used to search for insights.\n \t

" + } + }, + "ResourceCollection": { + "target": "com.amazonaws.devopsguru#ResourceCollection" + } + }, + "traits": { + "smithy.api#documentation": "

\n \t\tSpecifies one or more severity values and one or more status values that are used to search \n \t\tfor insights. \n \t

" + } + }, + "com.amazonaws.devopsguru#SearchInsightsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1, + "max": 100 } } }, "com.amazonaws.devopsguru#SearchInsightsRequest": { "type": "structure", "members": { + "StartTimeRange": { + "target": "com.amazonaws.devopsguru#StartTimeRange", + "traits": { + "smithy.api#documentation": "

\n \t\tThe start of the time range passed in. Returned insights occurred after this time.\n \t

", + "smithy.api#required": {} + } + }, "Filters": { - "target": "com.amazonaws.devopsguru#SearchInsightsFilters" + "target": "com.amazonaws.devopsguru#SearchInsightsFilters", + "traits": { + "smithy.api#documentation": "

\n \t\tA SearchInsightsFilters object that is used to set the severity and status filters on your insight search.\n \t

" + } }, "MaxResults": { - "target": "com.amazonaws.devopsguru#__integerMin1Max100" + "target": "com.amazonaws.devopsguru#SearchInsightsMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } }, "NextToken": { - "target": "com.amazonaws.devopsguru#__stringMin36Max36PatternAF098AF094AF094AF094AF0912" - }, - "StartTimeRange": { - "target": "com.amazonaws.devopsguru#StartTimeRange", + "target": "com.amazonaws.devopsguru#UuidNextToken", "traits": { - "smithy.api#required": {} + "smithy.api#documentation": "

The pagination token to use to retrieve \n the next page of results for this operation. If this value is null, it retrieves the first page.

" } }, "Type": { "target": "com.amazonaws.devopsguru#InsightType", "traits": { + "smithy.api#documentation": "

\n \t\tThe type of insights you are searching for (REACTIVE or PROACTIVE).\n \t

", "smithy.api#required": {} } } @@ -1996,14 +3011,23 @@ "com.amazonaws.devopsguru#SearchInsightsResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.devopsguru#__stringMin36Max36PatternAF098AF094AF094AF094AF0912" - }, "ProactiveInsights": { - "target": "com.amazonaws.devopsguru#__listOfProactiveInsightSummary" + "target": "com.amazonaws.devopsguru#ProactiveInsights", + "traits": { + "smithy.api#documentation": "

\n\t\t\tThe returned proactive insights.\n\t\t

" + } }, "ReactiveInsights": { - "target": "com.amazonaws.devopsguru#__listOfReactiveInsightSummary" + "target": "com.amazonaws.devopsguru#ReactiveInsights", + "traits": { + "smithy.api#documentation": "

\n\t\t\tThe returned reactive insights.\n\t\t

" + } + }, + "NextToken": { + "target": "com.amazonaws.devopsguru#UuidNextToken", + "traits": { + "smithy.api#documentation": "

The pagination token to use to retrieve \n the next page of results for this operation. If there are no more pages, this value is null.

" + } } } }, @@ -2011,18 +3035,25 @@ "type": "structure", "members": { "OpsCenter": { - "target": "com.amazonaws.devopsguru#OpsCenterIntegration" + "target": "com.amazonaws.devopsguru#OpsCenterIntegration", + "traits": { + "smithy.api#documentation": "

\n\t\t\tInformation about whether DevOps Guru is configured to create an OpsItem in AWS Systems Manager OpsCenter for each created insight. \n\t\t

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

\n\t\t\tInformation about the integration of DevOps Guru with another AWS service, such as AWS Systems Manager.\n\t\t

" } }, "com.amazonaws.devopsguru#ServiceQuotaExceededException": { "type": "structure", "members": { "Message": { - "target": "com.amazonaws.devopsguru#__string" + "target": "com.amazonaws.devopsguru#ErrorMessageString" } }, "traits": { + "smithy.api#documentation": "

The request contains a value that exceeds a maximum quota.

", "smithy.api#error": "client", "smithy.api#httpError": 402 } @@ -2031,48 +3062,122 @@ "type": "structure", "members": { "TopicArn": { - "target": "com.amazonaws.devopsguru#__stringMin36Max1024PatternArnAwsAZ09SnsAZ09D12" + "target": "com.amazonaws.devopsguru#TopicArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an Amazon Simple Notification Service topic.

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

Contains the Amazon Resource Name (ARN) of an Amazon Simple Notification Service topic.

\n\t\t\n\t\t

If you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission \n\t\t\t\tto it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. \n\t\t\t\tFor more information, see Permissions \n\t\t\t\tfor cross account Amazon SNS topics.

\n\t\t\t\t

If you use an Amazon SNS topic that is encrypted by an AWS Key Management Service customer-managed key (CMK), then you must add permissions \n\t\t\t\tto the CMK. For more information, see Permissions for \n\t\t\t\tAWS KMS–encrypted Amazon SNS topics.

" + } + }, + "com.amazonaws.devopsguru#SsmOpsItemId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^.*$" + } + }, + "com.amazonaws.devopsguru#StackName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z*]+[a-zA-Z0-9-]*$" + } + }, + "com.amazonaws.devopsguru#StackNames": { + "type": "list", + "member": { + "target": "com.amazonaws.devopsguru#StackName" } }, "com.amazonaws.devopsguru#StartTimeRange": { "type": "structure", "members": { "FromTime": { - "target": "com.amazonaws.devopsguru#__timestampUnix" + "target": "com.amazonaws.devopsguru#Timestamp", + "traits": { + "smithy.api#documentation": "

\n\t\t\tThe start time of the time range.\n\t\t

" + } }, "ToTime": { - "target": "com.amazonaws.devopsguru#__timestampUnix" + "target": "com.amazonaws.devopsguru#Timestamp", + "traits": { + "smithy.api#documentation": "

\n\t\t\tThe end time of the time range.\n\t\t

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

\n\t\t\tA time range used to specify when the behavior of an insight or anomaly started. \n\t\t

" } }, "com.amazonaws.devopsguru#ThrottlingException": { "type": "structure", "members": { "Message": { - "target": "com.amazonaws.devopsguru#__string", + "target": "com.amazonaws.devopsguru#ErrorMessageString", "traits": { "smithy.api#required": {} } }, "QuotaCode": { - "target": "com.amazonaws.devopsguru#__string" + "target": "com.amazonaws.devopsguru#ErrorQuotaCodeString", + "traits": { + "smithy.api#documentation": "

\n\t\t\tThe code of the quota that was exceeded, causing the throttling exception.\n\t\t

" + } }, "ServiceCode": { - "target": "com.amazonaws.devopsguru#__string" + "target": "com.amazonaws.devopsguru#ErrorServiceCodeString", + "traits": { + "smithy.api#documentation": "

\n\t\t\tThe code of the service that caused the throttling exception.\n\t\t

" + } + }, + "RetryAfterSeconds": { + "target": "com.amazonaws.devopsguru#RetryAfterSeconds", + "traits": { + "smithy.api#documentation": "

\n\t\t\tThe number of seconds after which the action that caused the throttling \n\t\t\texception can be retried.\n\t\t

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

The request was denied due to a request throttling.

", "smithy.api#error": "client", "smithy.api#httpError": 429 } }, + "com.amazonaws.devopsguru#Timestamp": { + "type": "timestamp" + }, + "com.amazonaws.devopsguru#TopicArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 36, + "max": 1024 + }, + "smithy.api#pattern": "^arn:aws[a-z0-9-]*:sns:[a-z0-9-]+:\\d{12}:[^:]+$" + } + }, "com.amazonaws.devopsguru#UpdateCloudFormationCollectionFilter": { "type": "structure", "members": { "StackNames": { - "target": "com.amazonaws.devopsguru#__listOf__stringMin1Max128PatternAZAZAZAZ09" + "target": "com.amazonaws.devopsguru#UpdateStackNames", + "traits": { + "smithy.api#documentation": "

\n\t\t\tAn array of the name of stacks to update.\n\t\t

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

Contains the names of AWS CloudFormation stacks used to update a collection of stacks.

" } }, "com.amazonaws.devopsguru#UpdateResourceCollection": { @@ -2101,6 +3206,7 @@ } ], "traits": { + "smithy.api#documentation": "

Updates the collection of resources that DevOps Guru analyzes.\n\t\t\tThe one type of AWS resource collection supported is AWS CloudFormation stacks. DevOps Guru can be configured to analyze \n \tonly the AWS resources that are defined in the stacks. This method also creates the IAM role required for you\n\t\t\tto use DevOps Guru.

", "smithy.api#http": { "method": "PUT", "uri": "/resource-collections", @@ -2127,8 +3233,14 @@ "type": "structure", "members": { "CloudFormation": { - "target": "com.amazonaws.devopsguru#UpdateCloudFormationCollectionFilter" + "target": "com.amazonaws.devopsguru#UpdateCloudFormationCollectionFilter", + "traits": { + "smithy.api#documentation": "

\n\t\t\tAn collection of AWS CloudFormation stacks. \n\t\t

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

\n\t\t\tContains information used to update a collection of AWS resources.\n\t\t

" } }, "com.amazonaws.devopsguru#UpdateResourceCollectionRequest": { @@ -2137,6 +3249,7 @@ "Action": { "target": "com.amazonaws.devopsguru#UpdateResourceCollectionAction", "traits": { + "smithy.api#documentation": "

\n\t\t\tSpecifies if the resource collection in the request is added or deleted to the resource collection. \n\t\t

", "smithy.api#required": {} } }, @@ -2178,6 +3291,7 @@ } ], "traits": { + "smithy.api#documentation": "

\n\t\t\tEnables or disables integration with a service that can be integrated with DevOps Guru. The one service that can be integrated with\n\t\t\tDevOps Guru is AWS Systems Manager, which can be used to create an OpsItem for each generated insight.\n\t\t

", "smithy.api#http": { "method": "PUT", "uri": "/service-integrations", @@ -2191,6 +3305,9 @@ "OpsCenter": { "target": "com.amazonaws.devopsguru#OpsCenterIntegrationConfig" } + }, + "traits": { + "smithy.api#documentation": "

\n\t\t\tInformation about updating the integration status of an AWS service, such as AWS Systems Manager, with DevOps Guru. \n\t\t

" } }, "com.amazonaws.devopsguru#UpdateServiceIntegrationRequest": { @@ -2199,6 +3316,7 @@ "ServiceIntegration": { "target": "com.amazonaws.devopsguru#UpdateServiceIntegrationConfig", "traits": { + "smithy.api#documentation": "

\n\t\t\tAn IntegratedServiceConfig object used to specify the integrated service you want to update, and whether you \n\t\t\twant to update it to enabled or disabled.\n\t\t

", "smithy.api#required": {} } } @@ -2208,23 +3326,50 @@ "type": "structure", "members": {} }, + "com.amazonaws.devopsguru#UpdateStackNames": { + "type": "list", + "member": { + "target": "com.amazonaws.devopsguru#StackName" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.devopsguru#UuidNextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 36, + "max": 36 + }, + "smithy.api#pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" + } + }, "com.amazonaws.devopsguru#ValidationException": { "type": "structure", "members": { - "Fields": { - "target": "com.amazonaws.devopsguru#__listOfValidationExceptionField" - }, "Message": { - "target": "com.amazonaws.devopsguru#__string", + "target": "com.amazonaws.devopsguru#ErrorMessageString", "traits": { + "smithy.api#documentation": "

\n\t\t\tA message that describes the validation exception.\n\t\t

", "smithy.api#required": {} } }, "Reason": { - "target": "com.amazonaws.devopsguru#ValidationExceptionReason" + "target": "com.amazonaws.devopsguru#ValidationExceptionReason", + "traits": { + "smithy.api#documentation": "

\n\t\t\tThe reason the validation exception was thrown.\n\t\t

" + } + }, + "Fields": { + "target": "com.amazonaws.devopsguru#ValidationExceptionFields" } }, "traits": { + "smithy.api#documentation": "

\n\t\t\tContains information about data passed in to a field during a request that is not valid. \n\t\t

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -2232,18 +3377,32 @@ "com.amazonaws.devopsguru#ValidationExceptionField": { "type": "structure", "members": { - "Message": { - "target": "com.amazonaws.devopsguru#__string", + "Name": { + "target": "com.amazonaws.devopsguru#ErrorNameString", "traits": { + "smithy.api#documentation": "

\n\t\t\tThe name of the field.\n\t\t

", "smithy.api#required": {} } }, - "Name": { - "target": "com.amazonaws.devopsguru#__string", + "Message": { + "target": "com.amazonaws.devopsguru#ErrorMessageString", "traits": { + "smithy.api#documentation": "

\n\t\t\tThe message associated with the validation exception with information to help \n\t\t\tdetermine its cause.\n\t\t

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

\n\t\t\tThe field associated with the validation exception.\n\t\t

" + } + }, + "com.amazonaws.devopsguru#ValidationExceptionFields": { + "type": "list", + "member": { + "target": "com.amazonaws.devopsguru#ValidationExceptionField" + }, + "traits": { + "smithy.api#documentation": "

\n\t\t\tAn array of fields that are associated with the validation exception.\n\t\t

" } }, "com.amazonaws.devopsguru#ValidationExceptionReason": { @@ -2268,276 +3427,6 @@ } ] } - }, - "com.amazonaws.devopsguru#__double": { - "type": "double" - }, - "com.amazonaws.devopsguru#__integer": { - "type": "integer" - }, - "com.amazonaws.devopsguru#__integerMin1Max100": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.devopsguru#__integerMin1Max200": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 200 - } - } - }, - "com.amazonaws.devopsguru#__integerMin1Max500": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 500 - } - } - }, - "com.amazonaws.devopsguru#__listOfCloudFormationHealth": { - "type": "list", - "member": { - "target": "com.amazonaws.devopsguru#CloudFormationHealth" - } - }, - "com.amazonaws.devopsguru#__listOfCloudWatchMetricsDetail": { - "type": "list", - "member": { - "target": "com.amazonaws.devopsguru#CloudWatchMetricsDetail" - } - }, - "com.amazonaws.devopsguru#__listOfCloudWatchMetricsDimension": { - "type": "list", - "member": { - "target": "com.amazonaws.devopsguru#CloudWatchMetricsDimension" - } - }, - "com.amazonaws.devopsguru#__listOfEvent": { - "type": "list", - "member": { - "target": "com.amazonaws.devopsguru#Event" - } - }, - "com.amazonaws.devopsguru#__listOfEventResource": { - "type": "list", - "member": { - "target": "com.amazonaws.devopsguru#EventResource" - } - }, - "com.amazonaws.devopsguru#__listOfInsightSeverity": { - "type": "list", - "member": { - "target": "com.amazonaws.devopsguru#InsightSeverity" - } - }, - "com.amazonaws.devopsguru#__listOfInsightStatus": { - "type": "list", - "member": { - "target": "com.amazonaws.devopsguru#InsightStatus" - } - }, - "com.amazonaws.devopsguru#__listOfNotificationChannel": { - "type": "list", - "member": { - "target": "com.amazonaws.devopsguru#NotificationChannel" - } - }, - "com.amazonaws.devopsguru#__listOfProactiveAnomalySummary": { - "type": "list", - "member": { - "target": "com.amazonaws.devopsguru#ProactiveAnomalySummary" - } - }, - "com.amazonaws.devopsguru#__listOfProactiveInsightSummary": { - "type": "list", - "member": { - "target": "com.amazonaws.devopsguru#ProactiveInsightSummary" - } - }, - "com.amazonaws.devopsguru#__listOfReactiveAnomalySummary": { - "type": "list", - "member": { - "target": "com.amazonaws.devopsguru#ReactiveAnomalySummary" - } - }, - "com.amazonaws.devopsguru#__listOfReactiveInsightSummary": { - "type": "list", - "member": { - "target": "com.amazonaws.devopsguru#ReactiveInsightSummary" - } - }, - "com.amazonaws.devopsguru#__listOfRecommendation": { - "type": "list", - "member": { - "target": "com.amazonaws.devopsguru#Recommendation" - } - }, - "com.amazonaws.devopsguru#__listOfRecommendationRelatedAnomaly": { - "type": "list", - "member": { - "target": "com.amazonaws.devopsguru#RecommendationRelatedAnomaly" - } - }, - "com.amazonaws.devopsguru#__listOfRecommendationRelatedAnomalyResource": { - "type": "list", - "member": { - "target": "com.amazonaws.devopsguru#RecommendationRelatedAnomalyResource" - } - }, - "com.amazonaws.devopsguru#__listOfRecommendationRelatedAnomalySourceDetail": { - "type": "list", - "member": { - "target": "com.amazonaws.devopsguru#RecommendationRelatedAnomalySourceDetail" - } - }, - "com.amazonaws.devopsguru#__listOfRecommendationRelatedCloudWatchMetricsSourceDetail": { - "type": "list", - "member": { - "target": "com.amazonaws.devopsguru#RecommendationRelatedCloudWatchMetricsSourceDetail" - } - }, - "com.amazonaws.devopsguru#__listOfRecommendationRelatedEvent": { - "type": "list", - "member": { - "target": "com.amazonaws.devopsguru#RecommendationRelatedEvent" - } - }, - "com.amazonaws.devopsguru#__listOfRecommendationRelatedEventResource": { - "type": "list", - "member": { - "target": "com.amazonaws.devopsguru#RecommendationRelatedEventResource" - } - }, - "com.amazonaws.devopsguru#__listOfValidationExceptionField": { - "type": "list", - "member": { - "target": "com.amazonaws.devopsguru#ValidationExceptionField" - } - }, - "com.amazonaws.devopsguru#__listOf__stringMin1Max128PatternAZAZAZAZ09": { - "type": "list", - "member": { - "target": "com.amazonaws.devopsguru#__stringMin1Max128PatternAZAZAZAZ09" - } - }, - "com.amazonaws.devopsguru#__long": { - "type": "long" - }, - "com.amazonaws.devopsguru#__string": { - "type": "string" - }, - "com.amazonaws.devopsguru#__stringMin0Max2048Pattern": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 2048 - }, - "smithy.api#pattern": "^.*$" - } - }, - "com.amazonaws.devopsguru#__stringMin0Max50": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 50 - } - } - }, - "com.amazonaws.devopsguru#__stringMin10Max50PatternAZAZ09AmazonawsComAwsEvents": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 10, - "max": 50 - }, - "smithy.api#pattern": "^[a-z]+[a-z0-9]*\\.amazonaws\\.com|aws\\.events$" - } - }, - "com.amazonaws.devopsguru#__stringMin1Max100Pattern": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 100 - }, - "smithy.api#pattern": "^.*$" - } - }, - "com.amazonaws.devopsguru#__stringMin1Max100PatternW": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 100 - }, - "smithy.api#pattern": "^[\\w-]*$" - } - }, - "com.amazonaws.devopsguru#__stringMin1Max128PatternAZAZAZAZ09": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - }, - "smithy.api#pattern": "^[a-zA-Z*]+[a-zA-Z0-9-]*$" - } - }, - "com.amazonaws.devopsguru#__stringMin1Max530PatternSS": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 530 - }, - "smithy.api#pattern": "^[\\s\\S]*$" - } - }, - "com.amazonaws.devopsguru#__stringMin36Max1024PatternArnAwsAZ09SnsAZ09D12": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 36, - "max": 1024 - }, - "smithy.api#pattern": "^arn:aws[a-z0-9-]*:sns:[a-z0-9-]+:\\d{12}:[^:]+$" - } - }, - "com.amazonaws.devopsguru#__stringMin36Max2048PatternArnAwsAZAZ09AZ09D12": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 36, - "max": 2048 - }, - "smithy.api#pattern": "^arn:aws[-a-z]*:[a-z0-9-]*:[a-z0-9-]*:\\d{12}:.*$" - } - }, - "com.amazonaws.devopsguru#__stringMin36Max36PatternAF098AF094AF094AF094AF0912": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 36, - "max": 36 - }, - "smithy.api#pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" - } - }, - "com.amazonaws.devopsguru#__timestampUnix": { - "type": "timestamp", - "traits": { - "smithy.api#timestampFormat": "epoch-seconds" - } } } } diff --git a/codegen/sdk-codegen/aws-models/directconnect.2012-10-25.json b/codegen/sdk-codegen/aws-models/directconnect.2012-10-25.json index 002fb861ecd..787cb95084f 100644 --- a/codegen/sdk-codegen/aws-models/directconnect.2012-10-25.json +++ b/codegen/sdk-codegen/aws-models/directconnect.2012-10-25.json @@ -1027,31 +1027,40 @@ "traits": { "smithy.api#enum": [ { - "value": "ordering" + "value": "ordering", + "name": "ordering" }, { - "value": "requested" + "value": "requested", + "name": "requested" }, { - "value": "pending" + "value": "pending", + "name": "pending" }, { - "value": "available" + "value": "available", + "name": "available" }, { - "value": "down" + "value": "down", + "name": "down" }, { - "value": "deleting" + "value": "deleting", + "name": "deleting" }, { - "value": "deleted" + "value": "deleted", + "name": "deleted" }, { - "value": "rejected" + "value": "rejected", + "name": "rejected" }, { - "value": "unknown" + "value": "unknown", + "name": "unknown" } ] } @@ -2917,13 +2926,16 @@ "traits": { "smithy.api#enum": [ { - "value": "requested" + "value": "requested", + "name": "requested" }, { - "value": "accepted" + "value": "accepted", + "name": "accepted" }, { - "value": "deleted" + "value": "deleted", + "name": "deleted" } ] } @@ -2933,19 +2945,24 @@ "traits": { "smithy.api#enum": [ { - "value": "associating" + "value": "associating", + "name": "associating" }, { - "value": "associated" + "value": "associated", + "name": "associated" }, { - "value": "disassociating" + "value": "disassociating", + "name": "disassociating" }, { - "value": "disassociated" + "value": "disassociated", + "name": "disassociated" }, { - "value": "updating" + "value": "updating", + "name": "updating" } ] } @@ -3011,16 +3028,20 @@ "traits": { "smithy.api#enum": [ { - "value": "attaching" + "value": "attaching", + "name": "attaching" }, { - "value": "attached" + "value": "attached", + "name": "attached" }, { - "value": "detaching" + "value": "detaching", + "name": "detaching" }, { - "value": "detached" + "value": "detached", + "name": "detached" } ] } @@ -3030,10 +3051,12 @@ "traits": { "smithy.api#enum": [ { - "value": "TransitVirtualInterface" + "value": "TransitVirtualInterface", + "name": "TransitVirtualInterface" }, { - "value": "PrivateVirtualInterface" + "value": "PrivateVirtualInterface", + "name": "PrivateVirtualInterface" } ] } @@ -3055,16 +3078,20 @@ "traits": { "smithy.api#enum": [ { - "value": "pending" + "value": "pending", + "name": "pending" }, { - "value": "available" + "value": "available", + "name": "available" }, { - "value": "deleting" + "value": "deleting", + "name": "deleting" }, { - "value": "deleted" + "value": "deleted", + "name": "deleted" } ] } @@ -3290,25 +3317,32 @@ "traits": { "smithy.api#enum": [ { - "value": "requested" + "value": "requested", + "name": "requested" }, { - "value": "pending" + "value": "pending", + "name": "pending" }, { - "value": "available" + "value": "available", + "name": "available" }, { - "value": "down" + "value": "down", + "name": "down" }, { - "value": "deleting" + "value": "deleting", + "name": "deleting" }, { - "value": "deleted" + "value": "deleted", + "name": "deleted" }, { - "value": "unknown" + "value": "unknown", + "name": "unknown" } ] } @@ -3457,25 +3491,32 @@ "traits": { "smithy.api#enum": [ { - "value": "requested" + "value": "requested", + "name": "requested" }, { - "value": "pending" + "value": "pending", + "name": "pending" }, { - "value": "available" + "value": "available", + "name": "available" }, { - "value": "down" + "value": "down", + "name": "down" }, { - "value": "deleting" + "value": "deleting", + "name": "deleting" }, { - "value": "deleted" + "value": "deleted", + "name": "deleted" }, { - "value": "unknown" + "value": "unknown", + "name": "unknown" } ] } @@ -5031,31 +5072,40 @@ "traits": { "smithy.api#enum": [ { - "value": "confirming" + "value": "confirming", + "name": "confirming" }, { - "value": "verifying" + "value": "verifying", + "name": "verifying" }, { - "value": "pending" + "value": "pending", + "name": "pending" }, { - "value": "available" + "value": "available", + "name": "available" }, { - "value": "down" + "value": "down", + "name": "down" }, { - "value": "deleting" + "value": "deleting", + "name": "deleting" }, { - "value": "deleted" + "value": "deleted", + "name": "deleted" }, { - "value": "rejected" + "value": "rejected", + "name": "rejected" }, { - "value": "unknown" + "value": "unknown", + "name": "unknown" } ] } diff --git a/codegen/sdk-codegen/aws-models/dlm.2018-01-12.json b/codegen/sdk-codegen/aws-models/dlm.2018-01-12.json index 8707a78ee74..5238793ce96 100644 --- a/codegen/sdk-codegen/aws-models/dlm.2018-01-12.json +++ b/codegen/sdk-codegen/aws-models/dlm.2018-01-12.json @@ -29,6 +29,50 @@ ] }, "shapes": { + "com.amazonaws.dlm#Action": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.dlm#ActionName", + "traits": { + "smithy.api#documentation": "

A descriptive name for the action.

", + "smithy.api#required": {} + } + }, + "CrossRegionCopy": { + "target": "com.amazonaws.dlm#CrossRegionCopyActionList", + "traits": { + "smithy.api#documentation": "

The rule for copying shared snapshots across Regions.

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

Specifies an action for an event-based policy.

" + } + }, + "com.amazonaws.dlm#ActionList": { + "type": "list", + "member": { + "target": "com.amazonaws.dlm#Action" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.dlm#ActionName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 120 + }, + "smithy.api#pattern": "[0-9A-Za-z _-]+" + } + }, "com.amazonaws.dlm#AvailabilityZone": { "type": "string", "traits": { @@ -51,6 +95,16 @@ } } }, + "com.amazonaws.dlm#AwsAccountId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 12, + "max": 12 + }, + "smithy.api#pattern": "^[0-9]{12}$" + } + }, "com.amazonaws.dlm#CmkArn": { "type": "string", "traits": { @@ -196,6 +250,43 @@ "smithy.api#pattern": "cron\\([^\\n]{11,100}\\)" } }, + "com.amazonaws.dlm#CrossRegionCopyAction": { + "type": "structure", + "members": { + "Target": { + "target": "com.amazonaws.dlm#Target", + "traits": { + "smithy.api#documentation": "

The target Region.

", + "smithy.api#required": {} + } + }, + "EncryptionConfiguration": { + "target": "com.amazonaws.dlm#EncryptionConfiguration", + "traits": { + "smithy.api#documentation": "

The encryption settings for the copied snapshot.

", + "smithy.api#required": {} + } + }, + "RetainRule": { + "target": "com.amazonaws.dlm#CrossRegionCopyRetainRule" + } + }, + "traits": { + "smithy.api#documentation": "

Specifies a rule for copying shared snapshots across Regions.

" + } + }, + "com.amazonaws.dlm#CrossRegionCopyActionList": { + "type": "list", + "member": { + "target": "com.amazonaws.dlm#CrossRegionCopyAction" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 3 + } + } + }, "com.amazonaws.dlm#CrossRegionCopyRetainRule": { "type": "structure", "members": { @@ -358,15 +449,118 @@ "type": "structure", "members": {} }, + "com.amazonaws.dlm#DescriptionRegex": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1000 + }, + "smithy.api#pattern": "[\\p{all}]*" + } + }, "com.amazonaws.dlm#Encrypted": { "type": "boolean" }, + "com.amazonaws.dlm#EncryptionConfiguration": { + "type": "structure", + "members": { + "Encrypted": { + "target": "com.amazonaws.dlm#Encrypted", + "traits": { + "smithy.api#documentation": "

To encrypt a copy of an unencrypted snapshot when encryption by default is not enabled, enable encryption using this parameter. Copies of encrypted snapshots are encrypted, even if this parameter is false or when encryption by default is not enabled.

", + "smithy.api#required": {} + } + }, + "CmkArn": { + "target": "com.amazonaws.dlm#CmkArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS KMS customer master key (CMK) to use for EBS encryption. If this parameter is not specified, your AWS managed CMK for EBS is used.

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

Specifies the encryption settings for shared snapshots that are copied across Regions.

" + } + }, "com.amazonaws.dlm#ErrorCode": { "type": "string" }, "com.amazonaws.dlm#ErrorMessage": { "type": "string" }, + "com.amazonaws.dlm#EventParameters": { + "type": "structure", + "members": { + "EventType": { + "target": "com.amazonaws.dlm#EventTypeValues", + "traits": { + "smithy.api#documentation": "

The type of event. Currently, only snapshot sharing events are supported.

", + "smithy.api#required": {} + } + }, + "SnapshotOwner": { + "target": "com.amazonaws.dlm#SnapshotOwnerList", + "traits": { + "smithy.api#documentation": "

The IDs of the AWS accounts that can trigger policy by sharing snapshots with your account. The policy only runs if one of the specified AWS accounts shares a snapshot with your account.

", + "smithy.api#required": {} + } + }, + "DescriptionRegex": { + "target": "com.amazonaws.dlm#DescriptionRegex", + "traits": { + "smithy.api#documentation": "

The snapshot description that can trigger the policy. The description pattern is specified using a regular expression. The policy runs only if a snapshot with a description that matches the specified pattern is shared with your account.

For example, specifying ^.*Created for policy: policy-1234567890abcdef0.*$ configures the policy to run only if snapshots created by policy policy-1234567890abcdef0 are shared with your account.

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

Specifies an event that triggers an event-based policy.

" + } + }, + "com.amazonaws.dlm#EventSource": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.dlm#EventSourceValues", + "traits": { + "smithy.api#documentation": "

The source of the event. Currently only managed AWS CloudWatch Events rules are supported.

", + "smithy.api#required": {} + } + }, + "Parameters": { + "target": "com.amazonaws.dlm#EventParameters", + "traits": { + "smithy.api#documentation": "

Information about the event.

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

Specifies an event that triggers an event-based policy.

" + } + }, + "com.amazonaws.dlm#EventSourceValues": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "MANAGED_CWE", + "name": "MANAGED_CWE" + } + ] + } + }, + "com.amazonaws.dlm#EventTypeValues": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "shareSnapshot", + "name": "shareSnapshot" + } + ] + } + }, "com.amazonaws.dlm#ExcludeBootVolume": { "type": "boolean" }, @@ -839,7 +1033,7 @@ "NoReboot": { "target": "com.amazonaws.dlm#NoReboot", "traits": { - "smithy.api#documentation": "

Applies to AMI lifecycle policies only. Indicates whether targeted instances are rebooted when the lifecycle policy runs. true indicates that targeted instances are not rebooted when the policy runs. false indicates that target instances are rebooted when the policy runs. The default is true (instance are not rebooted).

" + "smithy.api#documentation": "

Applies to AMI lifecycle policies only. Indicates whether targeted instances are rebooted when the lifecycle policy runs. true indicates that targeted instances are not rebooted when the policy runs. false indicates that target instances are rebooted when the policy runs. The default is true (instances are not rebooted).

" } } }, @@ -873,31 +1067,43 @@ "PolicyType": { "target": "com.amazonaws.dlm#PolicyTypeValues", "traits": { - "smithy.api#documentation": "

The valid target resource types and actions a policy can manage. Specify EBS_SNAPSHOT_MANAGEMENT to create a lifecycle policy that manages the lifecycle of Amazon EBS snapshots. Specify IMAGE_MANAGEMENT to create a lifecycle policy that manages the lifecycle of EBS-backed AMIs. The default is EBS_SNAPSHOT_MANAGEMENT.

" + "smithy.api#documentation": "

The valid target resource types and actions a policy can manage. Specify EBS_SNAPSHOT_MANAGEMENT to create a lifecycle policy that manages the lifecycle of Amazon EBS snapshots. Specify IMAGE_MANAGEMENT to create a lifecycle policy that manages the lifecycle of EBS-backed AMIs. Specify EVENT_BASED_POLICY to create an event-based policy that performs specific actions when a defined event occurs in your AWS account.

The default is EBS_SNAPSHOT_MANAGEMENT.

" } }, "ResourceTypes": { "target": "com.amazonaws.dlm#ResourceTypeValuesList", "traits": { - "smithy.api#documentation": "

The resource type. Use VOLUME to create snapshots of individual volumes or use INSTANCE to create multi-volume snapshots from the volumes for an instance.

" + "smithy.api#documentation": "

The target resource type for snapshot and AMI lifecycle policies. Use VOLUME to create snapshots of individual volumes or use INSTANCE to create multi-volume snapshots from the volumes for an instance.

This parameter is required for snapshot and AMI policies only. If you are creating an event-based policy, omit this parameter.

" } }, "TargetTags": { "target": "com.amazonaws.dlm#TargetTagList", "traits": { - "smithy.api#documentation": "

The single tag that identifies targeted resources for this policy.

" + "smithy.api#documentation": "

The single tag that identifies targeted resources for this policy.

This parameter is required for snapshot and AMI policies only. If you are creating an event-based policy, omit this parameter.

" } }, "Schedules": { "target": "com.amazonaws.dlm#ScheduleList", "traits": { - "smithy.api#documentation": "

The schedules of policy-defined actions. A policy can have up to four schedules - one mandatory schedule and up to three optional schedules.

" + "smithy.api#documentation": "

The schedules of policy-defined actions for snapshot and AMI lifecycle policies. A policy can have up to four schedules—one mandatory schedule and up to three optional schedules.

This parameter is required for snapshot and AMI policies only. If you are creating an event-based policy, omit this parameter.

" } }, "Parameters": { "target": "com.amazonaws.dlm#Parameters", "traits": { - "smithy.api#documentation": "

A set of optional parameters for the policy.

" + "smithy.api#documentation": "

A set of optional parameters for snapshot and AMI lifecycle policies.

This parameter is required for snapshot and AMI policies only. If you are creating an event-based policy, omit this parameter.

" + } + }, + "EventSource": { + "target": "com.amazonaws.dlm#EventSource", + "traits": { + "smithy.api#documentation": "

The event that triggers the event-based policy.

This parameter is required for event-based policies only. If you are creating a snapshot or AMI policy, omit this parameter.

" + } + }, + "Actions": { + "target": "com.amazonaws.dlm#ActionList", + "traits": { + "smithy.api#documentation": "

The actions to be performed when the event-based policy is triggered. You can specify only one action per policy.

This parameter is required for event-based policies only. If you are creating a snapshot or AMI policy, omit this parameter.

" } } }, @@ -932,6 +1138,10 @@ { "value": "IMAGE_MANAGEMENT", "name": "IMAGE_MANAGEMENT" + }, + { + "value": "EVENT_BASED_POLICY", + "name": "EVENT_BASED_POLICY" } ] } @@ -1090,10 +1300,16 @@ "traits": { "smithy.api#documentation": "

The rule for cross-Region snapshot copies.

" } + }, + "ShareRules": { + "target": "com.amazonaws.dlm#ShareRules", + "traits": { + "smithy.api#documentation": "

The rule for sharing snapshots with other AWS accounts.

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

Specifies a backup schedule.

" + "smithy.api#documentation": "

Specifies a backup schedule for a snapshot or AMI lifecycle policy.

" } }, "com.amazonaws.dlm#ScheduleList": { @@ -1115,7 +1331,7 @@ "min": 0, "max": 120 }, - "smithy.api#pattern": "[\\p{all}]*" + "smithy.api#pattern": "[0-9A-Za-z _-]+" } }, "com.amazonaws.dlm#SettablePolicyStateValues": { @@ -1133,6 +1349,68 @@ ] } }, + "com.amazonaws.dlm#ShareRule": { + "type": "structure", + "members": { + "TargetAccounts": { + "target": "com.amazonaws.dlm#ShareTargetAccountList", + "traits": { + "smithy.api#documentation": "

The IDs of the AWS accounts with which to share the snapshots.

", + "smithy.api#required": {} + } + }, + "UnshareInterval": { + "target": "com.amazonaws.dlm#Interval", + "traits": { + "smithy.api#documentation": "

The period after which snapshots that are shared with other AWS accounts are automatically unshared.

" + } + }, + "UnshareIntervalUnit": { + "target": "com.amazonaws.dlm#RetentionIntervalUnitValues", + "traits": { + "smithy.api#documentation": "

The unit of time for the automatic unsharing interval.

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

Specifies a rule for sharing snapshots across AWS accounts.

" + } + }, + "com.amazonaws.dlm#ShareRules": { + "type": "list", + "member": { + "target": "com.amazonaws.dlm#ShareRule" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.dlm#ShareTargetAccountList": { + "type": "list", + "member": { + "target": "com.amazonaws.dlm#AwsAccountId" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.dlm#SnapshotOwnerList": { + "type": "list", + "member": { + "target": "com.amazonaws.dlm#AwsAccountId" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, "com.amazonaws.dlm#StatusMessage": { "type": "string", "traits": { @@ -1308,6 +1586,16 @@ } } }, + "com.amazonaws.dlm#Target": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 16 + }, + "smithy.api#pattern": "^[\\\\w:\\\\-\\\\/\\\\*]+$" + } + }, "com.amazonaws.dlm#TargetRegion": { "type": "string", "traits": { diff --git a/codegen/sdk-codegen/aws-models/docdb.2014-10-31.json b/codegen/sdk-codegen/aws-models/docdb.2014-10-31.json index 86c058b774a..09ea873e612 100644 --- a/codegen/sdk-codegen/aws-models/docdb.2014-10-31.json +++ b/codegen/sdk-codegen/aws-models/docdb.2014-10-31.json @@ -226,10 +226,12 @@ "traits": { "smithy.api#enum": [ { - "value": "immediate" + "value": "immediate", + "name": "immediate" }, { - "value": "pending-reboot" + "value": "pending-reboot", + "name": "pending_reboot" } ] } @@ -5287,22 +5289,28 @@ "traits": { "smithy.api#enum": [ { - "value": "db-instance" + "value": "db-instance", + "name": "db_instance" }, { - "value": "db-parameter-group" + "value": "db-parameter-group", + "name": "db_parameter_group" }, { - "value": "db-security-group" + "value": "db-security-group", + "name": "db_security_group" }, { - "value": "db-snapshot" + "value": "db-snapshot", + "name": "db_snapshot" }, { - "value": "db-cluster" + "value": "db-cluster", + "name": "db_cluster" }, { - "value": "db-cluster-snapshot" + "value": "db-cluster-snapshot", + "name": "db_cluster_snapshot" } ] } diff --git a/codegen/sdk-codegen/aws-models/dynamodb.2012-08-10.json b/codegen/sdk-codegen/aws-models/dynamodb.2012-08-10.json index e62339782ad..c1359efa1e9 100644 --- a/codegen/sdk-codegen/aws-models/dynamodb.2012-08-10.json +++ b/codegen/sdk-codegen/aws-models/dynamodb.2012-08-10.json @@ -63,13 +63,16 @@ "traits": { "smithy.api#enum": [ { - "value": "ADD" + "value": "ADD", + "name": "ADD" }, { - "value": "PUT" + "value": "PUT", + "name": "PUT" }, { - "value": "DELETE" + "value": "DELETE", + "name": "DELETE" } ] } @@ -590,13 +593,16 @@ "traits": { "smithy.api#enum": [ { - "value": "CREATING" + "value": "CREATING", + "name": "CREATING" }, { - "value": "DELETED" + "value": "DELETED", + "name": "DELETED" }, { - "value": "AVAILABLE" + "value": "AVAILABLE", + "name": "AVAILABLE" } ] } @@ -1102,10 +1108,12 @@ "traits": { "smithy.api#enum": [ { - "value": "PROVISIONED" + "value": "PROVISIONED", + "name": "PROVISIONED" }, { - "value": "PAY_PER_REQUEST" + "value": "PAY_PER_REQUEST", + "name": "PAY_PER_REQUEST" } ] } @@ -1235,43 +1243,56 @@ "traits": { "smithy.api#enum": [ { - "value": "EQ" + "value": "EQ", + "name": "EQ" }, { - "value": "NE" + "value": "NE", + "name": "NE" }, { - "value": "IN" + "value": "IN", + "name": "IN" }, { - "value": "LE" + "value": "LE", + "name": "LE" }, { - "value": "LT" + "value": "LT", + "name": "LT" }, { - "value": "GE" + "value": "GE", + "name": "GE" }, { - "value": "GT" + "value": "GT", + "name": "GT" }, { - "value": "BETWEEN" + "value": "BETWEEN", + "name": "BETWEEN" }, { - "value": "NOT_NULL" + "value": "NOT_NULL", + "name": "NOT_NULL" }, { - "value": "NULL" + "value": "NULL", + "name": "NULL" }, { - "value": "CONTAINS" + "value": "CONTAINS", + "name": "CONTAINS" }, { - "value": "NOT_CONTAINS" + "value": "NOT_CONTAINS", + "name": "NOT_CONTAINS" }, { - "value": "BEGINS_WITH" + "value": "BEGINS_WITH", + "name": "BEGINS_WITH" } ] } @@ -1367,10 +1388,12 @@ "traits": { "smithy.api#enum": [ { - "value": "AND" + "value": "AND", + "name": "AND" }, { - "value": "OR" + "value": "OR", + "name": "OR" } ] } @@ -1469,10 +1492,12 @@ "traits": { "smithy.api#enum": [ { - "value": "ENABLED" + "value": "ENABLED", + "name": "ENABLED" }, { - "value": "DISABLED" + "value": "DISABLED", + "name": "DISABLED" } ] } @@ -1494,10 +1519,12 @@ "traits": { "smithy.api#enum": [ { - "value": "ENABLE" + "value": "ENABLE", + "name": "ENABLE" }, { - "value": "DISABLE" + "value": "DISABLE", + "name": "DISABLE" } ] } @@ -1519,19 +1546,24 @@ "traits": { "smithy.api#enum": [ { - "value": "ENABLING" + "value": "ENABLING", + "name": "ENABLING" }, { - "value": "ENABLED" + "value": "ENABLED", + "name": "ENABLED" }, { - "value": "DISABLING" + "value": "DISABLING", + "name": "DISABLING" }, { - "value": "DISABLED" + "value": "DISABLED", + "name": "DISABLED" }, { - "value": "FAILED" + "value": "FAILED", + "name": "FAILED" } ] } @@ -2870,19 +2902,24 @@ "traits": { "smithy.api#enum": [ { - "value": "ENABLING" + "value": "ENABLING", + "name": "ENABLING" }, { - "value": "ACTIVE" + "value": "ACTIVE", + "name": "ACTIVE" }, { - "value": "DISABLING" + "value": "DISABLING", + "name": "DISABLING" }, { - "value": "DISABLED" + "value": "DISABLED", + "name": "DISABLED" }, { - "value": "ENABLE_FAILED" + "value": "ENABLE_FAILED", + "name": "ENABLE_FAILED" } ] } @@ -4237,16 +4274,20 @@ "traits": { "smithy.api#enum": [ { - "value": "CREATING" + "value": "CREATING", + "name": "CREATING" }, { - "value": "ACTIVE" + "value": "ACTIVE", + "name": "ACTIVE" }, { - "value": "DELETING" + "value": "DELETING", + "name": "DELETING" }, { - "value": "UPDATING" + "value": "UPDATING", + "name": "UPDATING" } ] } @@ -4290,16 +4331,20 @@ "traits": { "smithy.api#enum": [ { - "value": "CREATING" + "value": "CREATING", + "name": "CREATING" }, { - "value": "UPDATING" + "value": "UPDATING", + "name": "UPDATING" }, { - "value": "DELETING" + "value": "DELETING", + "name": "DELETING" }, { - "value": "ACTIVE" + "value": "ACTIVE", + "name": "ACTIVE" } ] } @@ -4563,10 +4608,12 @@ "traits": { "smithy.api#enum": [ { - "value": "HASH" + "value": "HASH", + "name": "HASH" }, { - "value": "RANGE" + "value": "RANGE", + "name": "RANGE" } ] } @@ -5420,10 +5467,12 @@ "traits": { "smithy.api#enum": [ { - "value": "ENABLED" + "value": "ENABLED", + "name": "ENABLED" }, { - "value": "DISABLED" + "value": "DISABLED", + "name": "DISABLED" } ] } @@ -5497,13 +5546,16 @@ "traits": { "smithy.api#enum": [ { - "value": "ALL" + "value": "ALL", + "name": "ALL" }, { - "value": "KEYS_ONLY" + "value": "KEYS_ONLY", + "name": "KEYS_ONLY" }, { - "value": "INCLUDE" + "value": "INCLUDE", + "name": "INCLUDE" } ] } @@ -6480,25 +6532,32 @@ "traits": { "smithy.api#enum": [ { - "value": "CREATING" + "value": "CREATING", + "name": "CREATING" }, { - "value": "CREATION_FAILED" + "value": "CREATION_FAILED", + "name": "CREATION_FAILED" }, { - "value": "UPDATING" + "value": "UPDATING", + "name": "UPDATING" }, { - "value": "DELETING" + "value": "DELETING", + "name": "DELETING" }, { - "value": "ACTIVE" + "value": "ACTIVE", + "name": "ACTIVE" }, { - "value": "REGION_DISABLED" + "value": "REGION_DISABLED", + "name": "REGION_DISABLED" }, { - "value": "INACCESSIBLE_ENCRYPTION_CREDENTIALS" + "value": "INACCESSIBLE_ENCRYPTION_CREDENTIALS", + "name": "INACCESSIBLE_ENCRYPTION_CREDENTIALS" } ] } @@ -6879,13 +6938,16 @@ "smithy.api#documentation": "

Determines the level of detail about provisioned throughput consumption that is returned in the response:

\n ", "smithy.api#enum": [ { - "value": "INDEXES" + "value": "INDEXES", + "name": "INDEXES" }, { - "value": "TOTAL" + "value": "TOTAL", + "name": "TOTAL" }, { - "value": "NONE" + "value": "NONE", + "name": "NONE" } ] } @@ -6895,10 +6957,12 @@ "traits": { "smithy.api#enum": [ { - "value": "SIZE" + "value": "SIZE", + "name": "SIZE" }, { - "value": "NONE" + "value": "NONE", + "name": "NONE" } ] } @@ -6908,19 +6972,24 @@ "traits": { "smithy.api#enum": [ { - "value": "NONE" + "value": "NONE", + "name": "NONE" }, { - "value": "ALL_OLD" + "value": "ALL_OLD", + "name": "ALL_OLD" }, { - "value": "UPDATED_OLD" + "value": "UPDATED_OLD", + "name": "UPDATED_OLD" }, { - "value": "ALL_NEW" + "value": "ALL_NEW", + "name": "ALL_NEW" }, { - "value": "UPDATED_NEW" + "value": "UPDATED_NEW", + "name": "UPDATED_NEW" } ] } @@ -6930,10 +6999,12 @@ "traits": { "smithy.api#enum": [ { - "value": "ALL_OLD" + "value": "ALL_OLD", + "name": "ALL_OLD" }, { - "value": "NONE" + "value": "NONE", + "name": "NONE" } ] } @@ -6952,10 +7023,12 @@ "traits": { "smithy.api#enum": [ { - "value": "AES256" + "value": "AES256", + "name": "AES256" }, { - "value": "KMS" + "value": "KMS", + "name": "KMS" } ] } @@ -7038,19 +7111,24 @@ "traits": { "smithy.api#enum": [ { - "value": "ENABLING" + "value": "ENABLING", + "name": "ENABLING" }, { - "value": "ENABLED" + "value": "ENABLED", + "name": "ENABLED" }, { - "value": "DISABLING" + "value": "DISABLING", + "name": "DISABLING" }, { - "value": "DISABLED" + "value": "DISABLED", + "name": "DISABLED" }, { - "value": "UPDATING" + "value": "UPDATING", + "name": "UPDATING" } ] } @@ -7060,10 +7138,12 @@ "traits": { "smithy.api#enum": [ { - "value": "AES256" + "value": "AES256", + "name": "AES256" }, { - "value": "KMS" + "value": "KMS", + "name": "KMS" } ] } @@ -7073,13 +7153,16 @@ "traits": { "smithy.api#enum": [ { - "value": "S" + "value": "S", + "name": "S" }, { - "value": "N" + "value": "N", + "name": "N" }, { - "value": "B" + "value": "B", + "name": "B" } ] } @@ -7296,16 +7379,20 @@ "traits": { "smithy.api#enum": [ { - "value": "ALL_ATTRIBUTES" + "value": "ALL_ATTRIBUTES", + "name": "ALL_ATTRIBUTES" }, { - "value": "ALL_PROJECTED_ATTRIBUTES" + "value": "ALL_PROJECTED_ATTRIBUTES", + "name": "ALL_PROJECTED_ATTRIBUTES" }, { - "value": "SPECIFIC_ATTRIBUTES" + "value": "SPECIFIC_ATTRIBUTES", + "name": "SPECIFIC_ATTRIBUTES" }, { - "value": "COUNT" + "value": "COUNT", + "name": "COUNT" } ] } @@ -7456,16 +7543,20 @@ "traits": { "smithy.api#enum": [ { - "value": "NEW_IMAGE" + "value": "NEW_IMAGE", + "name": "NEW_IMAGE" }, { - "value": "OLD_IMAGE" + "value": "OLD_IMAGE", + "name": "OLD_IMAGE" }, { - "value": "NEW_AND_OLD_IMAGES" + "value": "NEW_AND_OLD_IMAGES", + "name": "NEW_AND_OLD_IMAGES" }, { - "value": "KEYS_ONLY" + "value": "KEYS_ONLY", + "name": "KEYS_ONLY" } ] } @@ -7711,25 +7802,32 @@ "traits": { "smithy.api#enum": [ { - "value": "CREATING" + "value": "CREATING", + "name": "CREATING" }, { - "value": "UPDATING" + "value": "UPDATING", + "name": "UPDATING" }, { - "value": "DELETING" + "value": "DELETING", + "name": "DELETING" }, { - "value": "ACTIVE" + "value": "ACTIVE", + "name": "ACTIVE" }, { - "value": "INACCESSIBLE_ENCRYPTION_CREDENTIALS" + "value": "INACCESSIBLE_ENCRYPTION_CREDENTIALS", + "name": "INACCESSIBLE_ENCRYPTION_CREDENTIALS" }, { - "value": "ARCHIVING" + "value": "ARCHIVING", + "name": "ARCHIVING" }, { - "value": "ARCHIVED" + "value": "ARCHIVED", + "name": "ARCHIVED" } ] } @@ -7899,16 +7997,20 @@ "traits": { "smithy.api#enum": [ { - "value": "ENABLING" + "value": "ENABLING", + "name": "ENABLING" }, { - "value": "DISABLING" + "value": "DISABLING", + "name": "DISABLING" }, { - "value": "ENABLED" + "value": "ENABLED", + "name": "ENABLED" }, { - "value": "DISABLED" + "value": "DISABLED", + "name": "DISABLED" } ] } diff --git a/codegen/sdk-codegen/aws-models/dynamodbstreams.2012-08-10.json b/codegen/sdk-codegen/aws-models/dynamodbstreams.2012-08-10.json index dc151d9fd69..0f480262560 100644 --- a/codegen/sdk-codegen/aws-models/dynamodbstreams.2012-08-10.json +++ b/codegen/sdk-codegen/aws-models/dynamodbstreams.2012-08-10.json @@ -473,10 +473,12 @@ "traits": { "smithy.api#enum": [ { - "value": "HASH" + "value": "HASH", + "name": "HASH" }, { - "value": "RANGE" + "value": "RANGE", + "name": "RANGE" } ] } @@ -597,13 +599,16 @@ "traits": { "smithy.api#enum": [ { - "value": "INSERT" + "value": "INSERT", + "name": "INSERT" }, { - "value": "MODIFY" + "value": "MODIFY", + "name": "MODIFY" }, { - "value": "REMOVE" + "value": "REMOVE", + "name": "REMOVE" } ] } @@ -781,16 +786,20 @@ "traits": { "smithy.api#enum": [ { - "value": "TRIM_HORIZON" + "value": "TRIM_HORIZON", + "name": "TRIM_HORIZON" }, { - "value": "LATEST" + "value": "LATEST", + "name": "LATEST" }, { - "value": "AT_SEQUENCE_NUMBER" + "value": "AT_SEQUENCE_NUMBER", + "name": "AT_SEQUENCE_NUMBER" }, { - "value": "AFTER_SEQUENCE_NUMBER" + "value": "AFTER_SEQUENCE_NUMBER", + "name": "AFTER_SEQUENCE_NUMBER" } ] } @@ -953,16 +962,20 @@ "traits": { "smithy.api#enum": [ { - "value": "ENABLING" + "value": "ENABLING", + "name": "ENABLING" }, { - "value": "ENABLED" + "value": "ENABLED", + "name": "ENABLED" }, { - "value": "DISABLING" + "value": "DISABLING", + "name": "DISABLING" }, { - "value": "DISABLED" + "value": "DISABLED", + "name": "DISABLED" } ] } @@ -972,16 +985,20 @@ "traits": { "smithy.api#enum": [ { - "value": "NEW_IMAGE" + "value": "NEW_IMAGE", + "name": "NEW_IMAGE" }, { - "value": "OLD_IMAGE" + "value": "OLD_IMAGE", + "name": "OLD_IMAGE" }, { - "value": "NEW_AND_OLD_IMAGES" + "value": "NEW_AND_OLD_IMAGES", + "name": "NEW_AND_OLD_IMAGES" }, { - "value": "KEYS_ONLY" + "value": "KEYS_ONLY", + "name": "KEYS_ONLY" } ] } diff --git a/codegen/sdk-codegen/aws-models/ec2.2016-11-15.json b/codegen/sdk-codegen/aws-models/ec2.2016-11-15.json index 6f8c884d6de..0dae25c6fa1 100644 --- a/codegen/sdk-codegen/aws-models/ec2.2016-11-15.json +++ b/codegen/sdk-codegen/aws-models/ec2.2016-11-15.json @@ -360,10 +360,12 @@ "traits": { "smithy.api#enum": [ { - "value": "supported-platforms" + "value": "supported-platforms", + "name": "supported_platforms" }, { - "value": "default-vpc" + "value": "default-vpc", + "name": "default_vpc" } ] } @@ -665,7 +667,8 @@ "traits": { "smithy.api#enum": [ { - "value": "domain-name" + "value": "domain-name", + "name": "domain_name" } ] } @@ -745,10 +748,12 @@ "traits": { "smithy.api#enum": [ { - "value": "default" + "value": "default", + "name": "default" }, { - "value": "host" + "value": "host", + "name": "host" } ] } @@ -805,6 +810,13 @@ "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", "smithy.api#xmlName": "dryRun" } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to assign to the Elastic IP address.

", + "smithy.api#xmlName": "TagSpecification" + } } } }, @@ -997,22 +1009,28 @@ "traits": { "smithy.api#enum": [ { - "value": "available" + "value": "available", + "name": "available" }, { - "value": "under-assessment" + "value": "under-assessment", + "name": "under_assessment" }, { - "value": "permanent-failure" + "value": "permanent-failure", + "name": "permanent_failure" }, { - "value": "released" + "value": "released", + "name": "released" }, { - "value": "released-permanent-failure" + "value": "released-permanent-failure", + "name": "released_permanent_failure" }, { - "value": "pending" + "value": "pending", + "name": "pending" } ] } @@ -1074,10 +1092,12 @@ "traits": { "smithy.api#enum": [ { - "value": "on" + "value": "on", + "name": "on" }, { - "value": "off" + "value": "off", + "name": "off" } ] } @@ -2809,13 +2829,16 @@ "traits": { "smithy.api#enum": [ { - "value": "running" + "value": "running", + "name": "running" }, { - "value": "succeeded" + "value": "succeeded", + "name": "succeeded" }, { - "value": "failed" + "value": "failed", + "name": "failed" } ] } @@ -2825,10 +2848,12 @@ "traits": { "smithy.api#enum": [ { - "value": "enable" + "value": "enable", + "name": "enable" }, { - "value": "disable" + "value": "disable", + "name": "disable" } ] } @@ -2896,13 +2921,16 @@ "traits": { "smithy.api#enum": [ { - "value": "i386" + "value": "i386", + "name": "i386" }, { - "value": "x86_64" + "value": "x86_64", + "name": "x86_64" }, { - "value": "arm64" + "value": "arm64", + "name": "arm64" } ] } @@ -2921,13 +2949,16 @@ "traits": { "smithy.api#enum": [ { - "value": "i386" + "value": "i386", + "name": "i386" }, { - "value": "x86_64" + "value": "x86_64", + "name": "x86_64" }, { - "value": "arm64" + "value": "arm64", + "name": "arm64" } ] } @@ -3713,7 +3744,8 @@ "traits": { "smithy.api#enum": [ { - "value": "vpc" + "value": "vpc", + "name": "vpc" } ] } @@ -3838,19 +3870,24 @@ "traits": { "smithy.api#enum": [ { - "value": "associating" + "value": "associating", + "name": "associating" }, { - "value": "associated" + "value": "associated", + "name": "associated" }, { - "value": "association-failed" + "value": "association-failed", + "name": "association_failed" }, { - "value": "disassociating" + "value": "disassociating", + "name": "disassociating" }, { - "value": "disassociated" + "value": "disassociated", + "name": "disassociated" } ] } @@ -4153,16 +4190,20 @@ "traits": { "smithy.api#enum": [ { - "value": "attaching" + "value": "attaching", + "name": "attaching" }, { - "value": "attached" + "value": "attached", + "name": "attached" }, { - "value": "detaching" + "value": "detaching", + "name": "detaching" }, { - "value": "detached" + "value": "detached", + "name": "detached" } ] } @@ -4507,10 +4548,12 @@ "traits": { "smithy.api#enum": [ { - "value": "enable" + "value": "enable", + "name": "enable" }, { - "value": "disable" + "value": "disable", + "name": "disable" } ] } @@ -4520,10 +4563,12 @@ "traits": { "smithy.api#enum": [ { - "value": "enable" + "value": "enable", + "name": "enable" }, { - "value": "disable" + "value": "disable", + "name": "disable" } ] } @@ -4533,10 +4578,12 @@ "traits": { "smithy.api#enum": [ { - "value": "on" + "value": "on", + "name": "on" }, { - "value": "off" + "value": "off", + "name": "off" } ] } @@ -4682,13 +4729,16 @@ "traits": { "smithy.api#enum": [ { - "value": "opt-in-not-required" + "value": "opt-in-not-required", + "name": "opt_in_not_required" }, { - "value": "opted-in" + "value": "opted-in", + "name": "opted_in" }, { - "value": "not-opted-in" + "value": "not-opted-in", + "name": "not_opted_in" } ] } @@ -4698,16 +4748,20 @@ "traits": { "smithy.api#enum": [ { - "value": "available" + "value": "available", + "name": "available" }, { - "value": "information" + "value": "information", + "name": "information" }, { - "value": "impaired" + "value": "impaired", + "name": "impaired" }, { - "value": "unavailable" + "value": "unavailable", + "name": "unavailable" } ] } @@ -4818,10 +4872,12 @@ "traits": { "smithy.api#enum": [ { - "value": "up" + "value": "up", + "name": "up" }, { - "value": "down" + "value": "down", + "name": "down" } ] } @@ -4916,10 +4972,12 @@ "traits": { "smithy.api#enum": [ { - "value": "legacy-bios" + "value": "legacy-bios", + "name": "legacy_bios" }, { - "value": "uefi" + "value": "uefi", + "name": "uefi" } ] } @@ -4938,10 +4996,12 @@ "traits": { "smithy.api#enum": [ { - "value": "legacy-bios" + "value": "legacy-bios", + "name": "legacy_bios" }, { - "value": "uefi" + "value": "uefi", + "name": "uefi" } ] } @@ -5126,25 +5186,32 @@ "traits": { "smithy.api#enum": [ { - "value": "pending" + "value": "pending", + "name": "pending" }, { - "value": "waiting-for-shutdown" + "value": "waiting-for-shutdown", + "name": "waiting_for_shutdown" }, { - "value": "bundling" + "value": "bundling", + "name": "bundling" }, { - "value": "storing" + "value": "storing", + "name": "storing" }, { - "value": "cancelling" + "value": "cancelling", + "name": "cancelling" }, { - "value": "complete" + "value": "complete", + "name": "complete" }, { - "value": "failed" + "value": "failed", + "name": "failed" } ] } @@ -5209,28 +5276,36 @@ "traits": { "smithy.api#enum": [ { - "value": "advertised" + "value": "advertised", + "name": "advertised" }, { - "value": "deprovisioned" + "value": "deprovisioned", + "name": "deprovisioned" }, { - "value": "failed-deprovision" + "value": "failed-deprovision", + "name": "failed_deprovision" }, { - "value": "failed-provision" + "value": "failed-provision", + "name": "failed_provision" }, { - "value": "pending-deprovision" + "value": "pending-deprovision", + "name": "pending_deprovision" }, { - "value": "pending-provision" + "value": "pending-provision", + "name": "pending_provision" }, { - "value": "provisioned" + "value": "provisioned", + "name": "provisioned" }, { - "value": "provisioned-not-publicly-advertisable" + "value": "provisioned-not-publicly-advertisable", + "name": "provisioned_not_publicly_advertisable" } ] } @@ -5696,19 +5771,24 @@ "traits": { "smithy.api#enum": [ { - "value": "active" + "value": "active", + "name": "active" }, { - "value": "open" + "value": "open", + "name": "open" }, { - "value": "closed" + "value": "closed", + "name": "closed" }, { - "value": "cancelled" + "value": "cancelled", + "name": "cancelled" }, { - "value": "completed" + "value": "completed", + "name": "completed" } ] } @@ -6081,10 +6161,12 @@ "traits": { "smithy.api#enum": [ { - "value": "open" + "value": "open", + "name": "open" }, { - "value": "none" + "value": "none", + "name": "none" } ] } @@ -6147,19 +6229,24 @@ "traits": { "smithy.api#enum": [ { - "value": "active" + "value": "active", + "name": "active" }, { - "value": "expired" + "value": "expired", + "name": "expired" }, { - "value": "cancelled" + "value": "cancelled", + "name": "cancelled" }, { - "value": "pending" + "value": "pending", + "name": "pending" }, { - "value": "failed" + "value": "failed", + "name": "failed" } ] } @@ -6213,10 +6300,12 @@ "traits": { "smithy.api#enum": [ { - "value": "default" + "value": "default", + "name": "default" }, { - "value": "dedicated" + "value": "dedicated", + "name": "dedicated" } ] } @@ -6301,16 +6390,20 @@ "traits": { "smithy.api#enum": [ { - "value": "pending" + "value": "pending", + "name": "pending" }, { - "value": "available" + "value": "available", + "name": "available" }, { - "value": "deleting" + "value": "deleting", + "name": "deleting" }, { - "value": "deleted" + "value": "deleted", + "name": "deleted" } ] } @@ -6550,10 +6643,12 @@ "traits": { "smithy.api#enum": [ { - "value": "pending" + "value": "pending", + "name": "pending" }, { - "value": "active" + "value": "active", + "name": "active" } ] } @@ -6737,13 +6832,16 @@ "traits": { "smithy.api#enum": [ { - "value": "certificate-authentication" + "value": "certificate-authentication", + "name": "certificate_authentication" }, { - "value": "directory-service-authentication" + "value": "directory-service-authentication", + "name": "directory_service_authentication" }, { - "value": "federated-authentication" + "value": "federated-authentication", + "name": "federated_authentication" } ] } @@ -6777,16 +6875,20 @@ "traits": { "smithy.api#enum": [ { - "value": "authorizing" + "value": "authorizing", + "name": "authorizing" }, { - "value": "active" + "value": "active", + "name": "active" }, { - "value": "failed" + "value": "failed", + "name": "failed" }, { - "value": "revoking" + "value": "revoking", + "name": "revoking" } ] } @@ -6949,16 +7051,20 @@ "traits": { "smithy.api#enum": [ { - "value": "active" + "value": "active", + "name": "active" }, { - "value": "failed-to-terminate" + "value": "failed-to-terminate", + "name": "failed_to_terminate" }, { - "value": "terminating" + "value": "terminating", + "name": "terminating" }, { - "value": "terminated" + "value": "terminated", + "name": "terminated" } ] } @@ -7171,10 +7277,12 @@ "traits": { "smithy.api#enum": [ { - "value": "applying" + "value": "applying", + "name": "applying" }, { - "value": "applied" + "value": "applied", + "name": "applied" } ] } @@ -7220,16 +7328,20 @@ "traits": { "smithy.api#enum": [ { - "value": "pending-associate" + "value": "pending-associate", + "name": "pending_associate" }, { - "value": "available" + "value": "available", + "name": "available" }, { - "value": "deleting" + "value": "deleting", + "name": "deleting" }, { - "value": "deleted" + "value": "deleted", + "name": "deleted" } ] } @@ -7336,16 +7448,20 @@ "traits": { "smithy.api#enum": [ { - "value": "creating" + "value": "creating", + "name": "creating" }, { - "value": "active" + "value": "active", + "name": "active" }, { - "value": "failed" + "value": "failed", + "name": "failed" }, { - "value": "deleting" + "value": "deleting", + "name": "deleting" } ] } @@ -7714,7 +7830,8 @@ "traits": { "smithy.api#enum": [ { - "value": "ova" + "value": "ova", + "name": "ova" } ] } @@ -7800,16 +7917,20 @@ "traits": { "smithy.api#enum": [ { - "value": "active" + "value": "active", + "name": "active" }, { - "value": "cancelling" + "value": "cancelling", + "name": "cancelling" }, { - "value": "cancelled" + "value": "cancelled", + "name": "cancelled" }, { - "value": "completed" + "value": "completed", + "name": "completed" } ] } @@ -7946,6 +8067,9 @@ "smithy.api#required": {} } }, + "DestinationOutpostArn": { + "target": "com.amazonaws.ec2#String" + }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -8085,7 +8209,8 @@ "traits": { "smithy.api#enum": [ { - "value": "volume" + "value": "volume", + "name": "volume" } ] } @@ -9333,6 +9458,9 @@ "smithy.api#documentation": "

The tags to apply to the AMI and snapshots on creation. You can tag the AMI, the\n snapshots, or both.

\n \n

If you specify other values for ResourceType, the request fails.

\n

To tag an AMI or snapshot after it has been created, see CreateTags.

", "smithy.api#xmlName": "TagSpecification" } + }, + "OutpostArn": { + "target": "com.amazonaws.ec2#String" } } }, @@ -12176,7 +12304,7 @@ "MultiAttachEnabled": { "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

Indicates whether to enable Amazon EBS Multi-Attach. If you enable Multi-Attach, you can attach the \n \tvolume to up to 16 Instances built on the Nitro System in the same Availability Zone. This parameter is \n \tsupported with io1 volumes only. For more information, \n \tsee \n \t\tAmazon EBS Multi-Attach in the Amazon Elastic Compute Cloud User Guide.

" + "smithy.api#documentation": "

Indicates whether to enable Amazon EBS Multi-Attach. If you enable Multi-Attach, you can attach the \n \tvolume to up to 16 Instances built on the Nitro System in the same Availability Zone. This parameter is \n \tsupported with io1 and io2 volumes only. For more information, \n \tsee \n \t\tAmazon EBS Multi-Attach in the Amazon Elastic Compute Cloud User Guide.

" } }, "Throughput": { @@ -12845,7 +12973,8 @@ "traits": { "smithy.api#enum": [ { - "value": "USD" + "value": "USD", + "name": "USD" } ] } @@ -12974,10 +13103,12 @@ "traits": { "smithy.api#enum": [ { - "value": "Active" + "value": "Active", + "name": "Active" }, { - "value": "Inactive" + "value": "Inactive", + "name": "Inactive" } ] } @@ -13005,10 +13136,12 @@ "traits": { "smithy.api#enum": [ { - "value": "enable" + "value": "enable", + "name": "enable" }, { - "value": "disable" + "value": "disable", + "name": "disable" } ] } @@ -13018,10 +13151,12 @@ "traits": { "smithy.api#enum": [ { - "value": "enable" + "value": "enable", + "name": "enable" }, { - "value": "disable" + "value": "disable", + "name": "disable" } ] } @@ -25844,10 +25979,12 @@ "traits": { "smithy.api#enum": [ { - "value": "ebs" + "value": "ebs", + "name": "ebs" }, { - "value": "instance-store" + "value": "instance-store", + "name": "instance_store" } ] } @@ -26973,13 +27110,16 @@ "traits": { "smithy.api#enum": [ { - "value": "VMDK" + "value": "VMDK", + "name": "VMDK" }, { - "value": "RAW" + "value": "RAW", + "name": "RAW" }, { - "value": "VHD" + "value": "VHD", + "name": "VHD" } ] } @@ -27066,10 +27206,12 @@ "traits": { "smithy.api#enum": [ { - "value": "hdd" + "value": "hdd", + "name": "hdd" }, { - "value": "ssd" + "value": "ssd", + "name": "ssd" } ] } @@ -27151,10 +27293,12 @@ "traits": { "smithy.api#enum": [ { - "value": "enable" + "value": "enable", + "name": "enable" }, { - "value": "disable" + "value": "disable", + "name": "disable" } ] } @@ -27164,10 +27308,12 @@ "traits": { "smithy.api#enum": [ { - "value": "vpc" + "value": "vpc", + "name": "vpc" }, { - "value": "standard" + "value": "standard", + "name": "standard" } ] } @@ -27233,6 +27379,13 @@ "smithy.api#xmlName": "throughput" } }, + "OutpostArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OutpostArn", + "smithy.api#xmlName": "outpostArn" + } + }, "Encrypted": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -27251,10 +27404,12 @@ "traits": { "smithy.api#enum": [ { - "value": "unsupported" + "value": "unsupported", + "name": "unsupported" }, { - "value": "supported" + "value": "supported", + "name": "supported" } ] } @@ -27443,13 +27598,16 @@ "traits": { "smithy.api#enum": [ { - "value": "unsupported" + "value": "unsupported", + "name": "unsupported" }, { - "value": "supported" + "value": "supported", + "name": "supported" }, { - "value": "default" + "value": "default", + "name": "default" } ] } @@ -27842,13 +28000,16 @@ "traits": { "smithy.api#enum": [ { - "value": "unsupported" + "value": "unsupported", + "name": "unsupported" }, { - "value": "supported" + "value": "supported", + "name": "supported" }, { - "value": "required" + "value": "required", + "name": "required" } ] } @@ -28381,10 +28542,12 @@ "traits": { "smithy.api#enum": [ { - "value": "unlimited" + "value": "unlimited", + "name": "unlimited" }, { - "value": "limited" + "value": "limited", + "name": "limited" } ] } @@ -28431,19 +28594,24 @@ "traits": { "smithy.api#enum": [ { - "value": "instance-reboot" + "value": "instance-reboot", + "name": "instance_reboot" }, { - "value": "system-reboot" + "value": "system-reboot", + "name": "system_reboot" }, { - "value": "system-maintenance" + "value": "system-maintenance", + "name": "system_maintenance" }, { - "value": "instance-retirement" + "value": "instance-retirement", + "name": "instance_retirement" }, { - "value": "instance-stop" + "value": "instance-stop", + "name": "instance_stop" } ] } @@ -29003,13 +29171,16 @@ "traits": { "smithy.api#enum": [ { - "value": "citrix" + "value": "citrix", + "name": "citrix" }, { - "value": "vmware" + "value": "vmware", + "name": "vmware" }, { - "value": "microsoft" + "value": "microsoft", + "name": "microsoft" } ] } @@ -29397,16 +29568,20 @@ "traits": { "smithy.api#enum": [ { - "value": "active" + "value": "active", + "name": "active" }, { - "value": "cancelling" + "value": "cancelling", + "name": "cancelling" }, { - "value": "cancelled" + "value": "cancelled", + "name": "cancelled" }, { - "value": "completed" + "value": "completed", + "name": "completed" } ] } @@ -29589,19 +29764,24 @@ "traits": { "smithy.api#enum": [ { - "value": "enabling" + "value": "enabling", + "name": "enabling" }, { - "value": "optimizing" + "value": "optimizing", + "name": "optimizing" }, { - "value": "enabled" + "value": "enabled", + "name": "enabled" }, { - "value": "disabling" + "value": "disabling", + "name": "disabling" }, { - "value": "disabled" + "value": "disabled", + "name": "disabled" } ] } @@ -30496,13 +30676,16 @@ "traits": { "smithy.api#enum": [ { - "value": "VPC" + "value": "VPC", + "name": "VPC" }, { - "value": "Subnet" + "value": "Subnet", + "name": "Subnet" }, { - "value": "NetworkInterface" + "value": "NetworkInterface", + "name": "NetworkInterface" } ] } @@ -30771,16 +30954,20 @@ "traits": { "smithy.api#enum": [ { - "value": "description" + "value": "description", + "name": "description" }, { - "value": "name" + "value": "name", + "name": "name" }, { - "value": "loadPermission" + "value": "loadPermission", + "name": "loadPermission" }, { - "value": "productCodes" + "value": "productCodes", + "name": "productCodes" } ] } @@ -30835,16 +31022,20 @@ "traits": { "smithy.api#enum": [ { - "value": "pending" + "value": "pending", + "name": "pending" }, { - "value": "failed" + "value": "failed", + "name": "failed" }, { - "value": "available" + "value": "available", + "name": "available" }, { - "value": "unavailable" + "value": "unavailable", + "name": "unavailable" } ] } @@ -30884,7 +31075,8 @@ "traits": { "smithy.api#enum": [ { - "value": "ipsec.1" + "value": "ipsec.1", + "name": "ipsec_1" } ] } @@ -32963,10 +33155,12 @@ "traits": { "smithy.api#enum": [ { - "value": "on" + "value": "on", + "name": "on" }, { - "value": "off" + "value": "off", + "name": "off" } ] } @@ -33117,10 +33311,12 @@ "traits": { "smithy.api#enum": [ { - "value": "dedicated" + "value": "dedicated", + "name": "dedicated" }, { - "value": "host" + "value": "host", + "name": "host" } ] } @@ -33145,10 +33341,12 @@ "traits": { "smithy.api#enum": [ { - "value": "ovm" + "value": "ovm", + "name": "ovm" }, { - "value": "xen" + "value": "xen", + "name": "xen" } ] } @@ -33402,10 +33600,12 @@ "traits": { "smithy.api#enum": [ { - "value": "enable" + "value": "enable", + "name": "enable" }, { - "value": "disable" + "value": "disable", + "name": "disable" } ] } @@ -33717,28 +33917,36 @@ "traits": { "smithy.api#enum": [ { - "value": "description" + "value": "description", + "name": "description" }, { - "value": "kernel" + "value": "kernel", + "name": "kernel" }, { - "value": "ramdisk" + "value": "ramdisk", + "name": "ramdisk" }, { - "value": "launchPermission" + "value": "launchPermission", + "name": "launchPermission" }, { - "value": "productCodes" + "value": "productCodes", + "name": "productCodes" }, { - "value": "blockDeviceMapping" + "value": "blockDeviceMapping", + "name": "blockDeviceMapping" }, { - "value": "sriovNetSupport" + "value": "sriovNetSupport", + "name": "sriovNetSupport" }, { - "value": "bootMode" + "value": "bootMode", + "name": "bootMode" } ] } @@ -33822,25 +34030,32 @@ "traits": { "smithy.api#enum": [ { - "value": "pending" + "value": "pending", + "name": "pending" }, { - "value": "available" + "value": "available", + "name": "available" }, { - "value": "invalid" + "value": "invalid", + "name": "invalid" }, { - "value": "deregistered" + "value": "deregistered", + "name": "deregistered" }, { - "value": "transient" + "value": "transient", + "name": "transient" }, { - "value": "failed" + "value": "failed", + "name": "failed" }, { - "value": "error" + "value": "error", + "name": "error" } ] } @@ -33850,13 +34065,16 @@ "traits": { "smithy.api#enum": [ { - "value": "machine" + "value": "machine", + "name": "machine" }, { - "value": "kernel" + "value": "kernel", + "name": "kernel" }, { - "value": "ramdisk" + "value": "ramdisk", + "name": "ramdisk" } ] } @@ -35456,6 +35674,13 @@ "smithy.api#documentation": "

Indicates whether the instance is enabled for AWS Nitro Enclaves.

", "smithy.api#xmlName": "enclaveOptions" } + }, + "BootMode": { + "target": "com.amazonaws.ec2#BootModeValues", + "traits": { + "aws.protocols#ec2QueryName": "BootMode", + "smithy.api#xmlName": "bootMode" + } } }, "traits": { @@ -35603,49 +35828,64 @@ "traits": { "smithy.api#enum": [ { - "value": "instanceType" + "value": "instanceType", + "name": "instanceType" }, { - "value": "kernel" + "value": "kernel", + "name": "kernel" }, { - "value": "ramdisk" + "value": "ramdisk", + "name": "ramdisk" }, { - "value": "userData" + "value": "userData", + "name": "userData" }, { - "value": "disableApiTermination" + "value": "disableApiTermination", + "name": "disableApiTermination" }, { - "value": "instanceInitiatedShutdownBehavior" + "value": "instanceInitiatedShutdownBehavior", + "name": "instanceInitiatedShutdownBehavior" }, { - "value": "rootDeviceName" + "value": "rootDeviceName", + "name": "rootDeviceName" }, { - "value": "blockDeviceMapping" + "value": "blockDeviceMapping", + "name": "blockDeviceMapping" }, { - "value": "productCodes" + "value": "productCodes", + "name": "productCodes" }, { - "value": "sourceDestCheck" + "value": "sourceDestCheck", + "name": "sourceDestCheck" }, { - "value": "groupSet" + "value": "groupSet", + "name": "groupSet" }, { - "value": "ebsOptimized" + "value": "ebsOptimized", + "name": "ebsOptimized" }, { - "value": "sriovNetSupport" + "value": "sriovNetSupport", + "name": "sriovNetSupport" }, { - "value": "enaSupport" + "value": "enaSupport", + "name": "enaSupport" }, { - "value": "enclaveOptions" + "value": "enclaveOptions", + "name": "enclaveOptions" } ] } @@ -35960,13 +36200,16 @@ "traits": { "smithy.api#enum": [ { - "value": "hibernate" + "value": "hibernate", + "name": "hibernate" }, { - "value": "stop" + "value": "stop", + "name": "stop" }, { - "value": "terminate" + "value": "terminate", + "name": "terminate" } ] } @@ -36039,10 +36282,12 @@ "traits": { "smithy.api#enum": [ { - "value": "spot" + "value": "spot", + "name": "spot" }, { - "value": "scheduled" + "value": "scheduled", + "name": "scheduled" } ] } @@ -36081,10 +36326,12 @@ "traits": { "smithy.api#enum": [ { - "value": "open" + "value": "open", + "name": "open" }, { - "value": "targeted" + "value": "targeted", + "name": "targeted" } ] } @@ -36094,10 +36341,12 @@ "traits": { "smithy.api#enum": [ { - "value": "disabled" + "value": "disabled", + "name": "disabled" }, { - "value": "enabled" + "value": "enabled", + "name": "enabled" } ] } @@ -36173,10 +36422,12 @@ "traits": { "smithy.api#enum": [ { - "value": "pending" + "value": "pending", + "name": "pending" }, { - "value": "applied" + "value": "applied", + "name": "applied" } ] } @@ -36724,22 +36975,28 @@ "traits": { "smithy.api#enum": [ { - "value": "pending" + "value": "pending", + "name": "pending" }, { - "value": "running" + "value": "running", + "name": "running" }, { - "value": "shutting-down" + "value": "shutting-down", + "name": "shutting_down" }, { - "value": "terminated" + "value": "terminated", + "name": "terminated" }, { - "value": "stopping" + "value": "stopping", + "name": "stopping" }, { - "value": "stopped" + "value": "stopped", + "name": "stopped" } ] } @@ -37023,1192 +37280,1588 @@ "traits": { "smithy.api#enum": [ { - "value": "t1.micro" + "value": "t1.micro", + "name": "t1_micro" }, { - "value": "t2.nano" + "value": "t2.nano", + "name": "t2_nano" }, { - "value": "t2.micro" + "value": "t2.micro", + "name": "t2_micro" }, { - "value": "t2.small" + "value": "t2.small", + "name": "t2_small" }, { - "value": "t2.medium" + "value": "t2.medium", + "name": "t2_medium" }, { - "value": "t2.large" + "value": "t2.large", + "name": "t2_large" }, { - "value": "t2.xlarge" + "value": "t2.xlarge", + "name": "t2_xlarge" }, { - "value": "t2.2xlarge" + "value": "t2.2xlarge", + "name": "t2_2xlarge" }, { - "value": "t3.nano" + "value": "t3.nano", + "name": "t3_nano" }, { - "value": "t3.micro" + "value": "t3.micro", + "name": "t3_micro" }, { - "value": "t3.small" + "value": "t3.small", + "name": "t3_small" }, { - "value": "t3.medium" + "value": "t3.medium", + "name": "t3_medium" }, { - "value": "t3.large" + "value": "t3.large", + "name": "t3_large" }, { - "value": "t3.xlarge" + "value": "t3.xlarge", + "name": "t3_xlarge" }, { - "value": "t3.2xlarge" + "value": "t3.2xlarge", + "name": "t3_2xlarge" }, { - "value": "t3a.nano" + "value": "t3a.nano", + "name": "t3a_nano" }, { - "value": "t3a.micro" + "value": "t3a.micro", + "name": "t3a_micro" }, { - "value": "t3a.small" + "value": "t3a.small", + "name": "t3a_small" }, { - "value": "t3a.medium" + "value": "t3a.medium", + "name": "t3a_medium" }, { - "value": "t3a.large" + "value": "t3a.large", + "name": "t3a_large" }, { - "value": "t3a.xlarge" + "value": "t3a.xlarge", + "name": "t3a_xlarge" }, { - "value": "t3a.2xlarge" + "value": "t3a.2xlarge", + "name": "t3a_2xlarge" }, { - "value": "t4g.nano" + "value": "t4g.nano", + "name": "t4g_nano" }, { - "value": "t4g.micro" + "value": "t4g.micro", + "name": "t4g_micro" }, { - "value": "t4g.small" + "value": "t4g.small", + "name": "t4g_small" }, { - "value": "t4g.medium" + "value": "t4g.medium", + "name": "t4g_medium" }, { - "value": "t4g.large" + "value": "t4g.large", + "name": "t4g_large" }, { - "value": "t4g.xlarge" + "value": "t4g.xlarge", + "name": "t4g_xlarge" }, { - "value": "t4g.2xlarge" + "value": "t4g.2xlarge", + "name": "t4g_2xlarge" }, { - "value": "m1.small" + "value": "m1.small", + "name": "m1_small" }, { - "value": "m1.medium" + "value": "m1.medium", + "name": "m1_medium" }, { - "value": "m1.large" + "value": "m1.large", + "name": "m1_large" }, { - "value": "m1.xlarge" + "value": "m1.xlarge", + "name": "m1_xlarge" }, { - "value": "m3.medium" + "value": "m3.medium", + "name": "m3_medium" }, { - "value": "m3.large" + "value": "m3.large", + "name": "m3_large" }, { - "value": "m3.xlarge" + "value": "m3.xlarge", + "name": "m3_xlarge" }, { - "value": "m3.2xlarge" + "value": "m3.2xlarge", + "name": "m3_2xlarge" }, { - "value": "m4.large" + "value": "m4.large", + "name": "m4_large" }, { - "value": "m4.xlarge" + "value": "m4.xlarge", + "name": "m4_xlarge" }, { - "value": "m4.2xlarge" + "value": "m4.2xlarge", + "name": "m4_2xlarge" }, { - "value": "m4.4xlarge" + "value": "m4.4xlarge", + "name": "m4_4xlarge" }, { - "value": "m4.10xlarge" + "value": "m4.10xlarge", + "name": "m4_10xlarge" }, { - "value": "m4.16xlarge" + "value": "m4.16xlarge", + "name": "m4_16xlarge" }, { - "value": "m2.xlarge" + "value": "m2.xlarge", + "name": "m2_xlarge" }, { - "value": "m2.2xlarge" + "value": "m2.2xlarge", + "name": "m2_2xlarge" }, { - "value": "m2.4xlarge" + "value": "m2.4xlarge", + "name": "m2_4xlarge" }, { - "value": "cr1.8xlarge" + "value": "cr1.8xlarge", + "name": "cr1_8xlarge" }, { - "value": "r3.large" + "value": "r3.large", + "name": "r3_large" }, { - "value": "r3.xlarge" + "value": "r3.xlarge", + "name": "r3_xlarge" }, { - "value": "r3.2xlarge" + "value": "r3.2xlarge", + "name": "r3_2xlarge" }, { - "value": "r3.4xlarge" + "value": "r3.4xlarge", + "name": "r3_4xlarge" }, { - "value": "r3.8xlarge" + "value": "r3.8xlarge", + "name": "r3_8xlarge" }, { - "value": "r4.large" + "value": "r4.large", + "name": "r4_large" }, { - "value": "r4.xlarge" + "value": "r4.xlarge", + "name": "r4_xlarge" }, { - "value": "r4.2xlarge" + "value": "r4.2xlarge", + "name": "r4_2xlarge" }, { - "value": "r4.4xlarge" + "value": "r4.4xlarge", + "name": "r4_4xlarge" }, { - "value": "r4.8xlarge" + "value": "r4.8xlarge", + "name": "r4_8xlarge" }, { - "value": "r4.16xlarge" + "value": "r4.16xlarge", + "name": "r4_16xlarge" }, { - "value": "r5.large" + "value": "r5.large", + "name": "r5_large" }, { - "value": "r5.xlarge" + "value": "r5.xlarge", + "name": "r5_xlarge" }, { - "value": "r5.2xlarge" + "value": "r5.2xlarge", + "name": "r5_2xlarge" }, { - "value": "r5.4xlarge" + "value": "r5.4xlarge", + "name": "r5_4xlarge" }, { - "value": "r5.8xlarge" + "value": "r5.8xlarge", + "name": "r5_8xlarge" }, { - "value": "r5.12xlarge" + "value": "r5.12xlarge", + "name": "r5_12xlarge" }, { - "value": "r5.16xlarge" + "value": "r5.16xlarge", + "name": "r5_16xlarge" }, { - "value": "r5.24xlarge" + "value": "r5.24xlarge", + "name": "r5_24xlarge" }, { - "value": "r5.metal" + "value": "r5.metal", + "name": "r5_metal" }, { - "value": "r5a.large" + "value": "r5a.large", + "name": "r5a_large" }, { - "value": "r5a.xlarge" + "value": "r5a.xlarge", + "name": "r5a_xlarge" }, { - "value": "r5a.2xlarge" + "value": "r5a.2xlarge", + "name": "r5a_2xlarge" }, { - "value": "r5a.4xlarge" + "value": "r5a.4xlarge", + "name": "r5a_4xlarge" }, { - "value": "r5a.8xlarge" + "value": "r5a.8xlarge", + "name": "r5a_8xlarge" }, { - "value": "r5a.12xlarge" + "value": "r5a.12xlarge", + "name": "r5a_12xlarge" }, { - "value": "r5a.16xlarge" + "value": "r5a.16xlarge", + "name": "r5a_16xlarge" }, { - "value": "r5a.24xlarge" + "value": "r5a.24xlarge", + "name": "r5a_24xlarge" }, { - "value": "r5b.large" + "value": "r5b.large", + "name": "r5b_large" }, { - "value": "r5b.xlarge" + "value": "r5b.xlarge", + "name": "r5b_xlarge" }, { - "value": "r5b.2xlarge" + "value": "r5b.2xlarge", + "name": "r5b_2xlarge" }, { - "value": "r5b.4xlarge" + "value": "r5b.4xlarge", + "name": "r5b_4xlarge" }, { - "value": "r5b.8xlarge" + "value": "r5b.8xlarge", + "name": "r5b_8xlarge" }, { - "value": "r5b.12xlarge" + "value": "r5b.12xlarge", + "name": "r5b_12xlarge" }, { - "value": "r5b.16xlarge" + "value": "r5b.16xlarge", + "name": "r5b_16xlarge" }, { - "value": "r5b.24xlarge" + "value": "r5b.24xlarge", + "name": "r5b_24xlarge" }, { - "value": "r5b.metal" + "value": "r5b.metal", + "name": "r5b_metal" }, { - "value": "r5d.large" + "value": "r5d.large", + "name": "r5d_large" }, { - "value": "r5d.xlarge" + "value": "r5d.xlarge", + "name": "r5d_xlarge" }, { - "value": "r5d.2xlarge" + "value": "r5d.2xlarge", + "name": "r5d_2xlarge" }, { - "value": "r5d.4xlarge" + "value": "r5d.4xlarge", + "name": "r5d_4xlarge" }, { - "value": "r5d.8xlarge" + "value": "r5d.8xlarge", + "name": "r5d_8xlarge" }, { - "value": "r5d.12xlarge" + "value": "r5d.12xlarge", + "name": "r5d_12xlarge" }, { - "value": "r5d.16xlarge" + "value": "r5d.16xlarge", + "name": "r5d_16xlarge" }, { - "value": "r5d.24xlarge" + "value": "r5d.24xlarge", + "name": "r5d_24xlarge" }, { - "value": "r5d.metal" + "value": "r5d.metal", + "name": "r5d_metal" }, { - "value": "r5ad.large" + "value": "r5ad.large", + "name": "r5ad_large" }, { - "value": "r5ad.xlarge" + "value": "r5ad.xlarge", + "name": "r5ad_xlarge" }, { - "value": "r5ad.2xlarge" + "value": "r5ad.2xlarge", + "name": "r5ad_2xlarge" }, { - "value": "r5ad.4xlarge" + "value": "r5ad.4xlarge", + "name": "r5ad_4xlarge" }, { - "value": "r5ad.8xlarge" + "value": "r5ad.8xlarge", + "name": "r5ad_8xlarge" }, { - "value": "r5ad.12xlarge" + "value": "r5ad.12xlarge", + "name": "r5ad_12xlarge" }, { - "value": "r5ad.16xlarge" + "value": "r5ad.16xlarge", + "name": "r5ad_16xlarge" }, { - "value": "r5ad.24xlarge" + "value": "r5ad.24xlarge", + "name": "r5ad_24xlarge" }, { - "value": "r6g.metal" + "value": "r6g.metal", + "name": "r6g_metal" }, { - "value": "r6g.medium" + "value": "r6g.medium", + "name": "r6g_medium" }, { - "value": "r6g.large" + "value": "r6g.large", + "name": "r6g_large" }, { - "value": "r6g.xlarge" + "value": "r6g.xlarge", + "name": "r6g_xlarge" }, { - "value": "r6g.2xlarge" + "value": "r6g.2xlarge", + "name": "r6g_2xlarge" }, { - "value": "r6g.4xlarge" + "value": "r6g.4xlarge", + "name": "r6g_4xlarge" }, { - "value": "r6g.8xlarge" + "value": "r6g.8xlarge", + "name": "r6g_8xlarge" }, { - "value": "r6g.12xlarge" + "value": "r6g.12xlarge", + "name": "r6g_12xlarge" }, { - "value": "r6g.16xlarge" + "value": "r6g.16xlarge", + "name": "r6g_16xlarge" }, { - "value": "r6gd.metal" + "value": "r6gd.metal", + "name": "r6gd_metal" }, { - "value": "r6gd.medium" + "value": "r6gd.medium", + "name": "r6gd_medium" }, { - "value": "r6gd.large" + "value": "r6gd.large", + "name": "r6gd_large" }, { - "value": "r6gd.xlarge" + "value": "r6gd.xlarge", + "name": "r6gd_xlarge" }, { - "value": "r6gd.2xlarge" + "value": "r6gd.2xlarge", + "name": "r6gd_2xlarge" }, { - "value": "r6gd.4xlarge" + "value": "r6gd.4xlarge", + "name": "r6gd_4xlarge" }, { - "value": "r6gd.8xlarge" + "value": "r6gd.8xlarge", + "name": "r6gd_8xlarge" }, { - "value": "r6gd.12xlarge" + "value": "r6gd.12xlarge", + "name": "r6gd_12xlarge" }, { - "value": "r6gd.16xlarge" + "value": "r6gd.16xlarge", + "name": "r6gd_16xlarge" }, { - "value": "x1.16xlarge" + "value": "x1.16xlarge", + "name": "x1_16xlarge" }, { - "value": "x1.32xlarge" + "value": "x1.32xlarge", + "name": "x1_32xlarge" }, { - "value": "x1e.xlarge" + "value": "x1e.xlarge", + "name": "x1e_xlarge" }, { - "value": "x1e.2xlarge" + "value": "x1e.2xlarge", + "name": "x1e_2xlarge" }, { - "value": "x1e.4xlarge" + "value": "x1e.4xlarge", + "name": "x1e_4xlarge" }, { - "value": "x1e.8xlarge" + "value": "x1e.8xlarge", + "name": "x1e_8xlarge" }, { - "value": "x1e.16xlarge" + "value": "x1e.16xlarge", + "name": "x1e_16xlarge" }, { - "value": "x1e.32xlarge" + "value": "x1e.32xlarge", + "name": "x1e_32xlarge" }, { - "value": "i2.xlarge" + "value": "i2.xlarge", + "name": "i2_xlarge" }, { - "value": "i2.2xlarge" + "value": "i2.2xlarge", + "name": "i2_2xlarge" }, { - "value": "i2.4xlarge" + "value": "i2.4xlarge", + "name": "i2_4xlarge" }, { - "value": "i2.8xlarge" + "value": "i2.8xlarge", + "name": "i2_8xlarge" }, { - "value": "i3.large" + "value": "i3.large", + "name": "i3_large" }, { - "value": "i3.xlarge" + "value": "i3.xlarge", + "name": "i3_xlarge" }, { - "value": "i3.2xlarge" + "value": "i3.2xlarge", + "name": "i3_2xlarge" }, { - "value": "i3.4xlarge" + "value": "i3.4xlarge", + "name": "i3_4xlarge" }, { - "value": "i3.8xlarge" + "value": "i3.8xlarge", + "name": "i3_8xlarge" }, { - "value": "i3.16xlarge" + "value": "i3.16xlarge", + "name": "i3_16xlarge" }, { - "value": "i3.metal" + "value": "i3.metal", + "name": "i3_metal" }, { - "value": "i3en.large" + "value": "i3en.large", + "name": "i3en_large" }, { - "value": "i3en.xlarge" + "value": "i3en.xlarge", + "name": "i3en_xlarge" }, { - "value": "i3en.2xlarge" + "value": "i3en.2xlarge", + "name": "i3en_2xlarge" }, { - "value": "i3en.3xlarge" + "value": "i3en.3xlarge", + "name": "i3en_3xlarge" }, { - "value": "i3en.6xlarge" + "value": "i3en.6xlarge", + "name": "i3en_6xlarge" }, { - "value": "i3en.12xlarge" + "value": "i3en.12xlarge", + "name": "i3en_12xlarge" }, { - "value": "i3en.24xlarge" + "value": "i3en.24xlarge", + "name": "i3en_24xlarge" }, { - "value": "i3en.metal" + "value": "i3en.metal", + "name": "i3en_metal" }, { - "value": "hi1.4xlarge" + "value": "hi1.4xlarge", + "name": "hi1_4xlarge" }, { - "value": "hs1.8xlarge" + "value": "hs1.8xlarge", + "name": "hs1_8xlarge" }, { - "value": "c1.medium" + "value": "c1.medium", + "name": "c1_medium" }, { - "value": "c1.xlarge" + "value": "c1.xlarge", + "name": "c1_xlarge" }, { - "value": "c3.large" + "value": "c3.large", + "name": "c3_large" }, { - "value": "c3.xlarge" + "value": "c3.xlarge", + "name": "c3_xlarge" }, { - "value": "c3.2xlarge" + "value": "c3.2xlarge", + "name": "c3_2xlarge" }, { - "value": "c3.4xlarge" + "value": "c3.4xlarge", + "name": "c3_4xlarge" }, { - "value": "c3.8xlarge" + "value": "c3.8xlarge", + "name": "c3_8xlarge" }, { - "value": "c4.large" + "value": "c4.large", + "name": "c4_large" }, { - "value": "c4.xlarge" + "value": "c4.xlarge", + "name": "c4_xlarge" }, { - "value": "c4.2xlarge" + "value": "c4.2xlarge", + "name": "c4_2xlarge" }, { - "value": "c4.4xlarge" + "value": "c4.4xlarge", + "name": "c4_4xlarge" }, { - "value": "c4.8xlarge" + "value": "c4.8xlarge", + "name": "c4_8xlarge" }, { - "value": "c5.large" + "value": "c5.large", + "name": "c5_large" }, { - "value": "c5.xlarge" + "value": "c5.xlarge", + "name": "c5_xlarge" }, { - "value": "c5.2xlarge" + "value": "c5.2xlarge", + "name": "c5_2xlarge" }, { - "value": "c5.4xlarge" + "value": "c5.4xlarge", + "name": "c5_4xlarge" }, { - "value": "c5.9xlarge" + "value": "c5.9xlarge", + "name": "c5_9xlarge" }, { - "value": "c5.12xlarge" + "value": "c5.12xlarge", + "name": "c5_12xlarge" }, { - "value": "c5.18xlarge" + "value": "c5.18xlarge", + "name": "c5_18xlarge" }, { - "value": "c5.24xlarge" + "value": "c5.24xlarge", + "name": "c5_24xlarge" }, { - "value": "c5.metal" + "value": "c5.metal", + "name": "c5_metal" }, { - "value": "c5a.large" + "value": "c5a.large", + "name": "c5a_large" }, { - "value": "c5a.xlarge" + "value": "c5a.xlarge", + "name": "c5a_xlarge" }, { - "value": "c5a.2xlarge" + "value": "c5a.2xlarge", + "name": "c5a_2xlarge" }, { - "value": "c5a.4xlarge" + "value": "c5a.4xlarge", + "name": "c5a_4xlarge" }, { - "value": "c5a.8xlarge" + "value": "c5a.8xlarge", + "name": "c5a_8xlarge" }, { - "value": "c5a.12xlarge" + "value": "c5a.12xlarge", + "name": "c5a_12xlarge" }, { - "value": "c5a.16xlarge" + "value": "c5a.16xlarge", + "name": "c5a_16xlarge" }, { - "value": "c5a.24xlarge" + "value": "c5a.24xlarge", + "name": "c5a_24xlarge" }, { - "value": "c5ad.large" + "value": "c5ad.large", + "name": "c5ad_large" }, { - "value": "c5ad.xlarge" + "value": "c5ad.xlarge", + "name": "c5ad_xlarge" }, { - "value": "c5ad.2xlarge" + "value": "c5ad.2xlarge", + "name": "c5ad_2xlarge" }, { - "value": "c5ad.4xlarge" + "value": "c5ad.4xlarge", + "name": "c5ad_4xlarge" }, { - "value": "c5ad.8xlarge" + "value": "c5ad.8xlarge", + "name": "c5ad_8xlarge" }, { - "value": "c5ad.12xlarge" + "value": "c5ad.12xlarge", + "name": "c5ad_12xlarge" }, { - "value": "c5ad.16xlarge" + "value": "c5ad.16xlarge", + "name": "c5ad_16xlarge" }, { - "value": "c5ad.24xlarge" + "value": "c5ad.24xlarge", + "name": "c5ad_24xlarge" }, { - "value": "c5d.large" + "value": "c5d.large", + "name": "c5d_large" }, { - "value": "c5d.xlarge" + "value": "c5d.xlarge", + "name": "c5d_xlarge" }, { - "value": "c5d.2xlarge" + "value": "c5d.2xlarge", + "name": "c5d_2xlarge" }, { - "value": "c5d.4xlarge" + "value": "c5d.4xlarge", + "name": "c5d_4xlarge" }, { - "value": "c5d.9xlarge" + "value": "c5d.9xlarge", + "name": "c5d_9xlarge" }, { - "value": "c5d.12xlarge" + "value": "c5d.12xlarge", + "name": "c5d_12xlarge" }, { - "value": "c5d.18xlarge" + "value": "c5d.18xlarge", + "name": "c5d_18xlarge" }, { - "value": "c5d.24xlarge" + "value": "c5d.24xlarge", + "name": "c5d_24xlarge" }, { - "value": "c5d.metal" + "value": "c5d.metal", + "name": "c5d_metal" }, { - "value": "c5n.large" + "value": "c5n.large", + "name": "c5n_large" }, { - "value": "c5n.xlarge" + "value": "c5n.xlarge", + "name": "c5n_xlarge" }, { - "value": "c5n.2xlarge" + "value": "c5n.2xlarge", + "name": "c5n_2xlarge" }, { - "value": "c5n.4xlarge" + "value": "c5n.4xlarge", + "name": "c5n_4xlarge" }, { - "value": "c5n.9xlarge" + "value": "c5n.9xlarge", + "name": "c5n_9xlarge" }, { - "value": "c5n.18xlarge" + "value": "c5n.18xlarge", + "name": "c5n_18xlarge" }, { - "value": "c5n.metal" + "value": "c5n.metal", + "name": "c5n_metal" }, { - "value": "c6g.metal" + "value": "c6g.metal", + "name": "c6g_metal" }, { - "value": "c6g.medium" + "value": "c6g.medium", + "name": "c6g_medium" }, { - "value": "c6g.large" + "value": "c6g.large", + "name": "c6g_large" }, { - "value": "c6g.xlarge" + "value": "c6g.xlarge", + "name": "c6g_xlarge" }, { - "value": "c6g.2xlarge" + "value": "c6g.2xlarge", + "name": "c6g_2xlarge" }, { - "value": "c6g.4xlarge" + "value": "c6g.4xlarge", + "name": "c6g_4xlarge" }, { - "value": "c6g.8xlarge" + "value": "c6g.8xlarge", + "name": "c6g_8xlarge" }, { - "value": "c6g.12xlarge" + "value": "c6g.12xlarge", + "name": "c6g_12xlarge" }, { - "value": "c6g.16xlarge" + "value": "c6g.16xlarge", + "name": "c6g_16xlarge" }, { - "value": "c6gd.metal" + "value": "c6gd.metal", + "name": "c6gd_metal" }, { - "value": "c6gd.medium" + "value": "c6gd.medium", + "name": "c6gd_medium" }, { - "value": "c6gd.large" + "value": "c6gd.large", + "name": "c6gd_large" }, { - "value": "c6gd.xlarge" + "value": "c6gd.xlarge", + "name": "c6gd_xlarge" }, { - "value": "c6gd.2xlarge" + "value": "c6gd.2xlarge", + "name": "c6gd_2xlarge" }, { - "value": "c6gd.4xlarge" + "value": "c6gd.4xlarge", + "name": "c6gd_4xlarge" }, { - "value": "c6gd.8xlarge" + "value": "c6gd.8xlarge", + "name": "c6gd_8xlarge" }, { - "value": "c6gd.12xlarge" + "value": "c6gd.12xlarge", + "name": "c6gd_12xlarge" }, { - "value": "c6gd.16xlarge" + "value": "c6gd.16xlarge", + "name": "c6gd_16xlarge" }, { - "value": "c6gn.medium" + "value": "c6gn.medium", + "name": "c6gn_medium" }, { - "value": "c6gn.large" + "value": "c6gn.large", + "name": "c6gn_large" }, { - "value": "c6gn.xlarge" + "value": "c6gn.xlarge", + "name": "c6gn_xlarge" }, { - "value": "c6gn.2xlarge" + "value": "c6gn.2xlarge", + "name": "c6gn_2xlarge" }, { - "value": "c6gn.4xlarge" + "value": "c6gn.4xlarge", + "name": "c6gn_4xlarge" }, { - "value": "c6gn.8xlarge" + "value": "c6gn.8xlarge", + "name": "c6gn_8xlarge" }, { - "value": "c6gn.12xlarge" + "value": "c6gn.12xlarge", + "name": "c6gn_12xlarge" }, { - "value": "c6gn.16xlarge" + "value": "c6gn.16xlarge", + "name": "c6gn_16xlarge" }, { - "value": "c6gn.metal" + "value": "c6gn.metal", + "name": "c6gn_metal" }, { - "value": "cc1.4xlarge" + "value": "cc1.4xlarge", + "name": "cc1_4xlarge" }, { - "value": "cc2.8xlarge" + "value": "cc2.8xlarge", + "name": "cc2_8xlarge" }, { - "value": "g2.2xlarge" + "value": "g2.2xlarge", + "name": "g2_2xlarge" }, { - "value": "g2.8xlarge" + "value": "g2.8xlarge", + "name": "g2_8xlarge" }, { - "value": "g3.4xlarge" + "value": "g3.4xlarge", + "name": "g3_4xlarge" }, { - "value": "g3.8xlarge" + "value": "g3.8xlarge", + "name": "g3_8xlarge" }, { - "value": "g3.16xlarge" + "value": "g3.16xlarge", + "name": "g3_16xlarge" }, { - "value": "g3s.xlarge" + "value": "g3s.xlarge", + "name": "g3s_xlarge" }, { - "value": "g4ad.xlarge" + "value": "g4ad.xlarge", + "name": "g4ad_xlarge" }, { - "value": "g4ad.2xlarge" + "value": "g4ad.2xlarge", + "name": "g4ad_2xlarge" }, { - "value": "g4ad.4xlarge" + "value": "g4ad.4xlarge", + "name": "g4ad_4xlarge" }, { - "value": "g4ad.8xlarge" + "value": "g4ad.8xlarge", + "name": "g4ad_8xlarge" }, { - "value": "g4ad.16xlarge" + "value": "g4ad.16xlarge", + "name": "g4ad_16xlarge" }, { - "value": "g4dn.xlarge" + "value": "g4dn.xlarge", + "name": "g4dn_xlarge" }, { - "value": "g4dn.2xlarge" + "value": "g4dn.2xlarge", + "name": "g4dn_2xlarge" }, { - "value": "g4dn.4xlarge" + "value": "g4dn.4xlarge", + "name": "g4dn_4xlarge" }, { - "value": "g4dn.8xlarge" + "value": "g4dn.8xlarge", + "name": "g4dn_8xlarge" }, { - "value": "g4dn.12xlarge" + "value": "g4dn.12xlarge", + "name": "g4dn_12xlarge" }, { - "value": "g4dn.16xlarge" + "value": "g4dn.16xlarge", + "name": "g4dn_16xlarge" }, { - "value": "g4dn.metal" + "value": "g4dn.metal", + "name": "g4dn_metal" }, { - "value": "cg1.4xlarge" + "value": "cg1.4xlarge", + "name": "cg1_4xlarge" }, { - "value": "p2.xlarge" + "value": "p2.xlarge", + "name": "p2_xlarge" }, { - "value": "p2.8xlarge" + "value": "p2.8xlarge", + "name": "p2_8xlarge" }, { - "value": "p2.16xlarge" + "value": "p2.16xlarge", + "name": "p2_16xlarge" }, { - "value": "p3.2xlarge" + "value": "p3.2xlarge", + "name": "p3_2xlarge" }, { - "value": "p3.8xlarge" + "value": "p3.8xlarge", + "name": "p3_8xlarge" }, { - "value": "p3.16xlarge" + "value": "p3.16xlarge", + "name": "p3_16xlarge" }, { - "value": "p3dn.24xlarge" + "value": "p3dn.24xlarge", + "name": "p3dn_24xlarge" }, { - "value": "p4d.24xlarge" + "value": "p4d.24xlarge", + "name": "p4d_24xlarge" }, { - "value": "d2.xlarge" + "value": "d2.xlarge", + "name": "d2_xlarge" }, { - "value": "d2.2xlarge" + "value": "d2.2xlarge", + "name": "d2_2xlarge" }, { - "value": "d2.4xlarge" + "value": "d2.4xlarge", + "name": "d2_4xlarge" }, { - "value": "d2.8xlarge" + "value": "d2.8xlarge", + "name": "d2_8xlarge" }, { - "value": "d3.xlarge" + "value": "d3.xlarge", + "name": "d3_xlarge" }, { - "value": "d3.2xlarge" + "value": "d3.2xlarge", + "name": "d3_2xlarge" }, { - "value": "d3.4xlarge" + "value": "d3.4xlarge", + "name": "d3_4xlarge" }, { - "value": "d3.8xlarge" + "value": "d3.8xlarge", + "name": "d3_8xlarge" }, { - "value": "d3.metal" + "value": "d3.metal", + "name": "d3_metal" }, { - "value": "d3en.large" + "value": "d3en.large", + "name": "d3en_large" }, { - "value": "d3en.xlarge" + "value": "d3en.xlarge", + "name": "d3en_xlarge" }, { - "value": "d3en.2xlarge" + "value": "d3en.2xlarge", + "name": "d3en_2xlarge" }, { - "value": "d3en.4xlarge" + "value": "d3en.4xlarge", + "name": "d3en_4xlarge" }, { - "value": "d3en.6xlarge" + "value": "d3en.6xlarge", + "name": "d3en_6xlarge" }, { - "value": "d3en.8xlarge" + "value": "d3en.8xlarge", + "name": "d3en_8xlarge" }, { - "value": "d3en.12xlarge" + "value": "d3en.12xlarge", + "name": "d3en_12xlarge" }, { - "value": "d3en.metal" + "value": "d3en.metal", + "name": "d3en_metal" }, { - "value": "f1.2xlarge" + "value": "f1.2xlarge", + "name": "f1_2xlarge" }, { - "value": "f1.4xlarge" + "value": "f1.4xlarge", + "name": "f1_4xlarge" }, { - "value": "f1.16xlarge" + "value": "f1.16xlarge", + "name": "f1_16xlarge" }, { - "value": "m5.large" + "value": "m5.large", + "name": "m5_large" }, { - "value": "m5.xlarge" + "value": "m5.xlarge", + "name": "m5_xlarge" }, { - "value": "m5.2xlarge" + "value": "m5.2xlarge", + "name": "m5_2xlarge" }, { - "value": "m5.4xlarge" + "value": "m5.4xlarge", + "name": "m5_4xlarge" }, { - "value": "m5.8xlarge" + "value": "m5.8xlarge", + "name": "m5_8xlarge" }, { - "value": "m5.12xlarge" + "value": "m5.12xlarge", + "name": "m5_12xlarge" }, { - "value": "m5.16xlarge" + "value": "m5.16xlarge", + "name": "m5_16xlarge" }, { - "value": "m5.24xlarge" + "value": "m5.24xlarge", + "name": "m5_24xlarge" }, { - "value": "m5.metal" + "value": "m5.metal", + "name": "m5_metal" }, { - "value": "m5a.large" + "value": "m5a.large", + "name": "m5a_large" }, { - "value": "m5a.xlarge" + "value": "m5a.xlarge", + "name": "m5a_xlarge" }, { - "value": "m5a.2xlarge" + "value": "m5a.2xlarge", + "name": "m5a_2xlarge" }, { - "value": "m5a.4xlarge" + "value": "m5a.4xlarge", + "name": "m5a_4xlarge" }, { - "value": "m5a.8xlarge" + "value": "m5a.8xlarge", + "name": "m5a_8xlarge" }, { - "value": "m5a.12xlarge" + "value": "m5a.12xlarge", + "name": "m5a_12xlarge" }, { - "value": "m5a.16xlarge" + "value": "m5a.16xlarge", + "name": "m5a_16xlarge" }, { - "value": "m5a.24xlarge" + "value": "m5a.24xlarge", + "name": "m5a_24xlarge" }, { - "value": "m5d.large" + "value": "m5d.large", + "name": "m5d_large" }, { - "value": "m5d.xlarge" + "value": "m5d.xlarge", + "name": "m5d_xlarge" }, { - "value": "m5d.2xlarge" + "value": "m5d.2xlarge", + "name": "m5d_2xlarge" }, { - "value": "m5d.4xlarge" + "value": "m5d.4xlarge", + "name": "m5d_4xlarge" }, { - "value": "m5d.8xlarge" + "value": "m5d.8xlarge", + "name": "m5d_8xlarge" }, { - "value": "m5d.12xlarge" + "value": "m5d.12xlarge", + "name": "m5d_12xlarge" }, { - "value": "m5d.16xlarge" + "value": "m5d.16xlarge", + "name": "m5d_16xlarge" }, { - "value": "m5d.24xlarge" + "value": "m5d.24xlarge", + "name": "m5d_24xlarge" }, { - "value": "m5d.metal" + "value": "m5d.metal", + "name": "m5d_metal" }, { - "value": "m5ad.large" + "value": "m5ad.large", + "name": "m5ad_large" }, { - "value": "m5ad.xlarge" + "value": "m5ad.xlarge", + "name": "m5ad_xlarge" }, { - "value": "m5ad.2xlarge" + "value": "m5ad.2xlarge", + "name": "m5ad_2xlarge" }, { - "value": "m5ad.4xlarge" + "value": "m5ad.4xlarge", + "name": "m5ad_4xlarge" }, { - "value": "m5ad.8xlarge" + "value": "m5ad.8xlarge", + "name": "m5ad_8xlarge" }, { - "value": "m5ad.12xlarge" + "value": "m5ad.12xlarge", + "name": "m5ad_12xlarge" }, { - "value": "m5ad.16xlarge" + "value": "m5ad.16xlarge", + "name": "m5ad_16xlarge" }, { - "value": "m5ad.24xlarge" + "value": "m5ad.24xlarge", + "name": "m5ad_24xlarge" }, { - "value": "m5zn.large" + "value": "m5zn.large", + "name": "m5zn_large" }, { - "value": "m5zn.xlarge" + "value": "m5zn.xlarge", + "name": "m5zn_xlarge" }, { - "value": "m5zn.2xlarge" + "value": "m5zn.2xlarge", + "name": "m5zn_2xlarge" }, { - "value": "m5zn.3xlarge" + "value": "m5zn.3xlarge", + "name": "m5zn_3xlarge" }, { - "value": "m5zn.6xlarge" + "value": "m5zn.6xlarge", + "name": "m5zn_6xlarge" }, { - "value": "m5zn.12xlarge" + "value": "m5zn.12xlarge", + "name": "m5zn_12xlarge" }, { - "value": "m5zn.metal" + "value": "m5zn.metal", + "name": "m5zn_metal" }, { - "value": "h1.2xlarge" + "value": "h1.2xlarge", + "name": "h1_2xlarge" }, { - "value": "h1.4xlarge" + "value": "h1.4xlarge", + "name": "h1_4xlarge" }, { - "value": "h1.8xlarge" + "value": "h1.8xlarge", + "name": "h1_8xlarge" }, { - "value": "h1.16xlarge" + "value": "h1.16xlarge", + "name": "h1_16xlarge" }, { - "value": "hpc5a.48xlarge" + "value": "hpc5a.48xlarge", + "name": "hpc5a_48xlarge" }, { - "value": "z1d.large" + "value": "z1d.large", + "name": "z1d_large" }, { - "value": "z1d.xlarge" + "value": "z1d.xlarge", + "name": "z1d_xlarge" }, { - "value": "z1d.2xlarge" + "value": "z1d.2xlarge", + "name": "z1d_2xlarge" }, { - "value": "z1d.3xlarge" + "value": "z1d.3xlarge", + "name": "z1d_3xlarge" }, { - "value": "z1d.6xlarge" + "value": "z1d.6xlarge", + "name": "z1d_6xlarge" }, { - "value": "z1d.12xlarge" + "value": "z1d.12xlarge", + "name": "z1d_12xlarge" }, { - "value": "z1d.metal" + "value": "z1d.metal", + "name": "z1d_metal" }, { - "value": "u-6tb1.metal" + "value": "u-6tb1.metal", + "name": "u_6tb1_metal" }, { - "value": "u-9tb1.metal" + "value": "u-9tb1.metal", + "name": "u_9tb1_metal" }, { - "value": "u-12tb1.metal" + "value": "u-12tb1.metal", + "name": "u_12tb1_metal" }, { - "value": "u-18tb1.metal" + "value": "u-18tb1.metal", + "name": "u_18tb1_metal" }, { - "value": "u-24tb1.metal" + "value": "u-24tb1.metal", + "name": "u_24tb1_metal" }, { - "value": "a1.medium" + "value": "a1.medium", + "name": "a1_medium" }, { - "value": "a1.large" + "value": "a1.large", + "name": "a1_large" }, { - "value": "a1.xlarge" + "value": "a1.xlarge", + "name": "a1_xlarge" }, { - "value": "a1.2xlarge" + "value": "a1.2xlarge", + "name": "a1_2xlarge" }, { - "value": "a1.4xlarge" + "value": "a1.4xlarge", + "name": "a1_4xlarge" }, { - "value": "a1.metal" + "value": "a1.metal", + "name": "a1_metal" }, { - "value": "m5dn.large" + "value": "m5dn.large", + "name": "m5dn_large" }, { - "value": "m5dn.xlarge" + "value": "m5dn.xlarge", + "name": "m5dn_xlarge" }, { - "value": "m5dn.2xlarge" + "value": "m5dn.2xlarge", + "name": "m5dn_2xlarge" }, { - "value": "m5dn.4xlarge" + "value": "m5dn.4xlarge", + "name": "m5dn_4xlarge" }, { - "value": "m5dn.8xlarge" + "value": "m5dn.8xlarge", + "name": "m5dn_8xlarge" }, { - "value": "m5dn.12xlarge" + "value": "m5dn.12xlarge", + "name": "m5dn_12xlarge" }, { - "value": "m5dn.16xlarge" + "value": "m5dn.16xlarge", + "name": "m5dn_16xlarge" }, { - "value": "m5dn.24xlarge" + "value": "m5dn.24xlarge", + "name": "m5dn_24xlarge" }, { - "value": "m5n.large" + "value": "m5n.large", + "name": "m5n_large" }, { - "value": "m5n.xlarge" + "value": "m5n.xlarge", + "name": "m5n_xlarge" }, { - "value": "m5n.2xlarge" + "value": "m5n.2xlarge", + "name": "m5n_2xlarge" }, { - "value": "m5n.4xlarge" + "value": "m5n.4xlarge", + "name": "m5n_4xlarge" }, { - "value": "m5n.8xlarge" + "value": "m5n.8xlarge", + "name": "m5n_8xlarge" }, { - "value": "m5n.12xlarge" + "value": "m5n.12xlarge", + "name": "m5n_12xlarge" }, { - "value": "m5n.16xlarge" + "value": "m5n.16xlarge", + "name": "m5n_16xlarge" }, { - "value": "m5n.24xlarge" + "value": "m5n.24xlarge", + "name": "m5n_24xlarge" }, { - "value": "r5dn.large" + "value": "r5dn.large", + "name": "r5dn_large" }, { - "value": "r5dn.xlarge" + "value": "r5dn.xlarge", + "name": "r5dn_xlarge" }, { - "value": "r5dn.2xlarge" + "value": "r5dn.2xlarge", + "name": "r5dn_2xlarge" }, { - "value": "r5dn.4xlarge" + "value": "r5dn.4xlarge", + "name": "r5dn_4xlarge" }, { - "value": "r5dn.8xlarge" + "value": "r5dn.8xlarge", + "name": "r5dn_8xlarge" }, { - "value": "r5dn.12xlarge" + "value": "r5dn.12xlarge", + "name": "r5dn_12xlarge" }, { - "value": "r5dn.16xlarge" + "value": "r5dn.16xlarge", + "name": "r5dn_16xlarge" }, { - "value": "r5dn.24xlarge" + "value": "r5dn.24xlarge", + "name": "r5dn_24xlarge" }, { - "value": "r5n.large" + "value": "r5n.large", + "name": "r5n_large" }, { - "value": "r5n.xlarge" + "value": "r5n.xlarge", + "name": "r5n_xlarge" }, { - "value": "r5n.2xlarge" + "value": "r5n.2xlarge", + "name": "r5n_2xlarge" }, { - "value": "r5n.4xlarge" + "value": "r5n.4xlarge", + "name": "r5n_4xlarge" }, { - "value": "r5n.8xlarge" + "value": "r5n.8xlarge", + "name": "r5n_8xlarge" }, { - "value": "r5n.12xlarge" + "value": "r5n.12xlarge", + "name": "r5n_12xlarge" }, { - "value": "r5n.16xlarge" + "value": "r5n.16xlarge", + "name": "r5n_16xlarge" }, { - "value": "r5n.24xlarge" + "value": "r5n.24xlarge", + "name": "r5n_24xlarge" }, { - "value": "inf1.xlarge" + "value": "inf1.xlarge", + "name": "inf1_xlarge" }, { - "value": "inf1.2xlarge" + "value": "inf1.2xlarge", + "name": "inf1_2xlarge" }, { - "value": "inf1.6xlarge" + "value": "inf1.6xlarge", + "name": "inf1_6xlarge" }, { - "value": "inf1.24xlarge" + "value": "inf1.24xlarge", + "name": "inf1_24xlarge" }, { - "value": "m6g.metal" + "value": "m6g.metal", + "name": "m6g_metal" }, { - "value": "m6g.medium" + "value": "m6g.medium", + "name": "m6g_medium" }, { - "value": "m6g.large" + "value": "m6g.large", + "name": "m6g_large" }, { - "value": "m6g.xlarge" + "value": "m6g.xlarge", + "name": "m6g_xlarge" }, { - "value": "m6g.2xlarge" + "value": "m6g.2xlarge", + "name": "m6g_2xlarge" }, { - "value": "m6g.4xlarge" + "value": "m6g.4xlarge", + "name": "m6g_4xlarge" }, { - "value": "m6g.8xlarge" + "value": "m6g.8xlarge", + "name": "m6g_8xlarge" }, { - "value": "m6g.12xlarge" + "value": "m6g.12xlarge", + "name": "m6g_12xlarge" }, { - "value": "m6g.16xlarge" + "value": "m6g.16xlarge", + "name": "m6g_16xlarge" }, { - "value": "m6gd.metal" + "value": "m6gd.metal", + "name": "m6gd_metal" }, { - "value": "m6gd.medium" + "value": "m6gd.medium", + "name": "m6gd_medium" }, { - "value": "m6gd.large" + "value": "m6gd.large", + "name": "m6gd_large" }, { - "value": "m6gd.xlarge" + "value": "m6gd.xlarge", + "name": "m6gd_xlarge" }, { - "value": "m6gd.2xlarge" + "value": "m6gd.2xlarge", + "name": "m6gd_2xlarge" }, { - "value": "m6gd.4xlarge" + "value": "m6gd.4xlarge", + "name": "m6gd_4xlarge" }, { - "value": "m6gd.8xlarge" + "value": "m6gd.8xlarge", + "name": "m6gd_8xlarge" }, { - "value": "m6gd.12xlarge" + "value": "m6gd.12xlarge", + "name": "m6gd_12xlarge" }, { - "value": "m6gd.16xlarge" + "value": "m6gd.16xlarge", + "name": "m6gd_16xlarge" }, { - "value": "mac1.metal" + "value": "mac1.metal", + "name": "mac1_metal" } ] } @@ -38524,10 +39177,12 @@ "traits": { "smithy.api#enum": [ { - "value": "INSTANCE-ATTACH" + "value": "INSTANCE-ATTACH", + "name": "INSTANCE_ATTACH" }, { - "value": "EIP-ASSOCIATE" + "value": "EIP-ASSOCIATE", + "name": "EIP_ASSOCIATE" } ] } @@ -38947,10 +39602,12 @@ "traits": { "smithy.api#enum": [ { - "value": "enable" + "value": "enable", + "name": "enable" }, { - "value": "disable" + "value": "disable", + "name": "disable" } ] } @@ -40004,10 +40661,12 @@ "traits": { "smithy.api#enum": [ { - "value": "disabled" + "value": "disabled", + "name": "disabled" }, { - "value": "enabled" + "value": "enabled", + "name": "enabled" } ] } @@ -40083,10 +40742,12 @@ "traits": { "smithy.api#enum": [ { - "value": "pending" + "value": "pending", + "name": "pending" }, { - "value": "applied" + "value": "applied", + "name": "applied" } ] } @@ -40944,16 +41605,20 @@ "traits": { "smithy.api#enum": [ { - "value": "available" + "value": "available", + "name": "available" }, { - "value": "sold" + "value": "sold", + "name": "sold" }, { - "value": "cancelled" + "value": "cancelled", + "name": "cancelled" }, { - "value": "pending" + "value": "pending", + "name": "pending" } ] } @@ -40963,16 +41628,20 @@ "traits": { "smithy.api#enum": [ { - "value": "active" + "value": "active", + "name": "active" }, { - "value": "pending" + "value": "pending", + "name": "pending" }, { - "value": "cancelled" + "value": "cancelled", + "name": "cancelled" }, { - "value": "closed" + "value": "closed", + "name": "closed" } ] } @@ -41230,19 +41899,24 @@ "traits": { "smithy.api#enum": [ { - "value": "pending" + "value": "pending", + "name": "pending" }, { - "value": "active" + "value": "active", + "name": "active" }, { - "value": "blackhole" + "value": "blackhole", + "name": "blackhole" }, { - "value": "deleting" + "value": "deleting", + "name": "deleting" }, { - "value": "deleted" + "value": "deleted", + "name": "deleted" } ] } @@ -41520,10 +42194,12 @@ "traits": { "smithy.api#enum": [ { - "value": "static" + "value": "static", + "name": "static" }, { - "value": "propagated" + "value": "propagated", + "name": "propagated" } ] } @@ -41718,13 +42394,16 @@ "traits": { "smithy.api#enum": [ { - "value": "region" + "value": "region", + "name": "region" }, { - "value": "availability-zone" + "value": "availability-zone", + "name": "availability_zone" }, { - "value": "availability-zone-id" + "value": "availability-zone-id", + "name": "availability_zone_id" } ] } @@ -41734,10 +42413,12 @@ "traits": { "smithy.api#enum": [ { - "value": "cloud-watch-logs" + "value": "cloud-watch-logs", + "name": "cloud_watch_logs" }, { - "value": "s3" + "value": "s3", + "name": "s3" } ] } @@ -41847,7 +42528,8 @@ "traits": { "smithy.api#enum": [ { - "value": "spot" + "value": "spot", + "name": "spot" } ] } @@ -41905,10 +42587,12 @@ "traits": { "smithy.api#enum": [ { - "value": "static" + "value": "static", + "name": "static" }, { - "value": "igmp" + "value": "igmp", + "name": "igmp" } ] } @@ -42031,10 +42715,12 @@ "traits": { "smithy.api#enum": [ { - "value": "opted-in" + "value": "opted-in", + "name": "opted_in" }, { - "value": "not-opted-in" + "value": "not-opted-in", + "name": "not_opted_in" } ] } @@ -44169,7 +44855,10 @@ } }, "MultiAttachEnabled": { - "target": "com.amazonaws.ec2#Boolean" + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether to enable Amazon EBS Multi-Attach. If you enable Multi-Attach, you can attach the \n\t\tvolume to up to 16 \n\t\t\tNitro-based instances in the same Availability Zone. This parameter is \n\t\tsupported with io1 and io2 volumes only. For more information, see \n\t\t\n\t\t\tAmazon EBS Multi-Attach in the Amazon Elastic Compute Cloud User Guide.

" + } } } }, @@ -45060,16 +45749,20 @@ "traits": { "smithy.api#enum": [ { - "value": "disabled" + "value": "disabled", + "name": "disabled" }, { - "value": "disabling" + "value": "disabling", + "name": "disabling" }, { - "value": "enabled" + "value": "enabled", + "name": "enabled" }, { - "value": "pending" + "value": "pending", + "name": "pending" } ] } @@ -45134,10 +45827,12 @@ "traits": { "smithy.api#enum": [ { - "value": "movingToVpc" + "value": "movingToVpc", + "name": "movingToVpc" }, { - "value": "restoringToClassic" + "value": "restoringToClassic", + "name": "restoringToClassic" } ] } @@ -45180,10 +45875,12 @@ "traits": { "smithy.api#enum": [ { - "value": "enable" + "value": "enable", + "name": "enable" }, { - "value": "disable" + "value": "disable", + "name": "disable" } ] } @@ -46321,16 +47018,20 @@ "traits": { "smithy.api#enum": [ { - "value": "description" + "value": "description", + "name": "description" }, { - "value": "groupSet" + "value": "groupSet", + "name": "groupSet" }, { - "value": "sourceDestCheck" + "value": "sourceDestCheck", + "name": "sourceDestCheck" }, { - "value": "attachment" + "value": "attachment", + "name": "attachment" } ] } @@ -46340,7 +47041,8 @@ "traits": { "smithy.api#enum": [ { - "value": "efa" + "value": "efa", + "name": "efa" } ] } @@ -46494,16 +47196,20 @@ "traits": { "smithy.api#enum": [ { - "value": "pending" + "value": "pending", + "name": "pending" }, { - "value": "granted" + "value": "granted", + "name": "granted" }, { - "value": "revoking" + "value": "revoking", + "name": "revoking" }, { - "value": "revoked" + "value": "revoked", + "name": "revoked" } ] } @@ -46562,19 +47268,24 @@ "traits": { "smithy.api#enum": [ { - "value": "available" + "value": "available", + "name": "available" }, { - "value": "associated" + "value": "associated", + "name": "associated" }, { - "value": "attaching" + "value": "attaching", + "name": "attaching" }, { - "value": "in-use" + "value": "in-use", + "name": "in_use" }, { - "value": "detaching" + "value": "detaching", + "name": "detaching" } ] } @@ -46584,13 +47295,16 @@ "traits": { "smithy.api#enum": [ { - "value": "interface" + "value": "interface", + "name": "interface" }, { - "value": "natGateway" + "value": "natGateway", + "name": "natGateway" }, { - "value": "efa" + "value": "efa", + "name": "efa" } ] } @@ -46674,22 +47388,28 @@ "traits": { "smithy.api#enum": [ { - "value": "Heavy Utilization" + "value": "Heavy Utilization", + "name": "Heavy_Utilization" }, { - "value": "Medium Utilization" + "value": "Medium Utilization", + "name": "Medium_Utilization" }, { - "value": "Light Utilization" + "value": "Light Utilization", + "name": "Light_Utilization" }, { - "value": "No Upfront" + "value": "No Upfront", + "name": "No_Upfront" }, { - "value": "Partial Upfront" + "value": "Partial Upfront", + "name": "Partial_Upfront" }, { - "value": "All Upfront" + "value": "All Upfront", + "name": "All_Upfront" } ] } @@ -46814,10 +47534,12 @@ "traits": { "smithy.api#enum": [ { - "value": "add" + "value": "add", + "name": "add" }, { - "value": "remove" + "value": "remove", + "name": "remove" } ] } @@ -47106,7 +47828,8 @@ "traits": { "smithy.api#enum": [ { - "value": "all" + "value": "all", + "name": "all" } ] } @@ -47572,16 +48295,20 @@ "traits": { "smithy.api#enum": [ { - "value": "pending" + "value": "pending", + "name": "pending" }, { - "value": "available" + "value": "available", + "name": "available" }, { - "value": "deleting" + "value": "deleting", + "name": "deleting" }, { - "value": "deleted" + "value": "deleted", + "name": "deleted" } ] } @@ -47591,13 +48318,16 @@ "traits": { "smithy.api#enum": [ { - "value": "cluster" + "value": "cluster", + "name": "cluster" }, { - "value": "partition" + "value": "partition", + "name": "partition" }, { - "value": "spread" + "value": "spread", + "name": "spread" } ] } @@ -47638,13 +48368,16 @@ "traits": { "smithy.api#enum": [ { - "value": "cluster" + "value": "cluster", + "name": "cluster" }, { - "value": "spread" + "value": "spread", + "name": "spread" }, { - "value": "partition" + "value": "partition", + "name": "partition" } ] } @@ -47654,7 +48387,8 @@ "traits": { "smithy.api#enum": [ { - "value": "Windows" + "value": "Windows", + "name": "Windows" } ] } @@ -47910,40 +48644,52 @@ "traits": { "smithy.api#enum": [ { - "value": "create-in-progress" + "value": "create-in-progress", + "name": "create_in_progress" }, { - "value": "create-complete" + "value": "create-complete", + "name": "create_complete" }, { - "value": "create-failed" + "value": "create-failed", + "name": "create_failed" }, { - "value": "modify-in-progress" + "value": "modify-in-progress", + "name": "modify_in_progress" }, { - "value": "modify-complete" + "value": "modify-complete", + "name": "modify_complete" }, { - "value": "modify-failed" + "value": "modify-failed", + "name": "modify_failed" }, { - "value": "restore-in-progress" + "value": "restore-in-progress", + "name": "restore_in_progress" }, { - "value": "restore-complete" + "value": "restore-complete", + "name": "restore_complete" }, { - "value": "restore-failed" + "value": "restore-failed", + "name": "restore_failed" }, { - "value": "delete-in-progress" + "value": "delete-in-progress", + "name": "delete_in_progress" }, { - "value": "delete-complete" + "value": "delete-complete", + "name": "delete_complete" }, { - "value": "delete-failed" + "value": "delete-failed", + "name": "delete_failed" } ] } @@ -48328,10 +49074,12 @@ "traits": { "smithy.api#enum": [ { - "value": "devpay" + "value": "devpay", + "name": "devpay" }, { - "value": "marketplace" + "value": "marketplace", + "name": "marketplace" } ] } @@ -48372,10 +49120,12 @@ "traits": { "smithy.api#enum": [ { - "value": "tcp" + "value": "tcp", + "name": "tcp" }, { - "value": "udp" + "value": "udp", + "name": "udp" } ] } @@ -48385,7 +49135,8 @@ "traits": { "smithy.api#enum": [ { - "value": "gre" + "value": "gre", + "name": "gre" } ] } @@ -49121,7 +49872,8 @@ "traits": { "smithy.api#enum": [ { - "value": "Hourly" + "value": "Hourly", + "name": "Hourly" } ] } @@ -50318,31 +51070,40 @@ "traits": { "smithy.api#enum": [ { - "value": "instance-stuck-in-state" + "value": "instance-stuck-in-state", + "name": "instance_stuck_in_state" }, { - "value": "unresponsive" + "value": "unresponsive", + "name": "unresponsive" }, { - "value": "not-accepting-credentials" + "value": "not-accepting-credentials", + "name": "not_accepting_credentials" }, { - "value": "password-not-available" + "value": "password-not-available", + "name": "password_not_available" }, { - "value": "performance-network" + "value": "performance-network", + "name": "performance_network" }, { - "value": "performance-instance-store" + "value": "performance-instance-store", + "name": "performance_instance_store" }, { - "value": "performance-ebs-volume" + "value": "performance-ebs-volume", + "name": "performance_ebs_volume" }, { - "value": "performance-other" + "value": "performance-other", + "name": "performance_other" }, { - "value": "other" + "value": "other", + "name": "other" } ] } @@ -50425,10 +51186,12 @@ "traits": { "smithy.api#enum": [ { - "value": "ok" + "value": "ok", + "name": "ok" }, { - "value": "impaired" + "value": "impaired", + "name": "impaired" } ] } @@ -51166,22 +51929,28 @@ "traits": { "smithy.api#enum": [ { - "value": "payment-pending" + "value": "payment-pending", + "name": "payment_pending" }, { - "value": "active" + "value": "active", + "name": "active" }, { - "value": "payment-failed" + "value": "payment-failed", + "name": "payment_failed" }, { - "value": "retired" + "value": "retired", + "name": "retired" }, { - "value": "queued" + "value": "queued", + "name": "queued" }, { - "value": "queued-deleted" + "value": "queued-deleted", + "name": "queued_deleted" } ] } @@ -51912,7 +52681,8 @@ "traits": { "smithy.api#enum": [ { - "value": "loadPermission" + "value": "loadPermission", + "name": "loadPermission" } ] } @@ -51968,7 +52738,8 @@ "traits": { "smithy.api#enum": [ { - "value": "launchPermission" + "value": "launchPermission", + "name": "launchPermission" } ] } @@ -52150,145 +52921,196 @@ "traits": { "smithy.api#enum": [ { - "value": "client-vpn-endpoint" + "value": "client-vpn-endpoint", + "name": "client_vpn_endpoint" }, { - "value": "customer-gateway" + "value": "customer-gateway", + "name": "customer_gateway" }, { - "value": "dedicated-host" + "value": "dedicated-host", + "name": "dedicated_host" }, { - "value": "dhcp-options" + "value": "dhcp-options", + "name": "dhcp_options" }, { - "value": "egress-only-internet-gateway" + "value": "egress-only-internet-gateway", + "name": "egress_only_internet_gateway" }, { - "value": "elastic-ip" + "value": "elastic-ip", + "name": "elastic_ip" }, { - "value": "elastic-gpu" + "value": "elastic-gpu", + "name": "elastic_gpu" }, { - "value": "export-image-task" + "value": "export-image-task", + "name": "export_image_task" }, { - "value": "export-instance-task" + "value": "export-instance-task", + "name": "export_instance_task" }, { - "value": "fleet" + "value": "fleet", + "name": "fleet" }, { - "value": "fpga-image" + "value": "fpga-image", + "name": "fpga_image" }, { - "value": "host-reservation" + "value": "host-reservation", + "name": "host_reservation" }, { - "value": "image" + "value": "image", + "name": "image" }, { - "value": "import-image-task" + "value": "import-image-task", + "name": "import_image_task" }, { - "value": "import-snapshot-task" + "value": "import-snapshot-task", + "name": "import_snapshot_task" }, { - "value": "instance" + "value": "instance", + "name": "instance" }, { - "value": "internet-gateway" + "value": "internet-gateway", + "name": "internet_gateway" }, { - "value": "key-pair" + "value": "key-pair", + "name": "key_pair" }, { - "value": "launch-template" + "value": "launch-template", + "name": "launch_template" }, { - "value": "local-gateway-route-table-vpc-association" + "value": "local-gateway-route-table-vpc-association", + "name": "local_gateway_route_table_vpc_association" }, { - "value": "natgateway" + "value": "natgateway", + "name": "natgateway" }, { - "value": "network-acl" + "value": "network-acl", + "name": "network_acl" }, { - "value": "network-interface" + "value": "network-interface", + "name": "network_interface" }, { - "value": "network-insights-analysis" + "value": "network-insights-analysis", + "name": "network_insights_analysis" }, { - "value": "network-insights-path" + "value": "network-insights-path", + "name": "network_insights_path" }, { - "value": "placement-group" + "value": "placement-group", + "name": "placement_group" }, { - "value": "reserved-instances" + "value": "reserved-instances", + "name": "reserved_instances" }, { - "value": "route-table" + "value": "route-table", + "name": "route_table" }, { - "value": "security-group" + "value": "security-group", + "name": "security_group" }, { - "value": "snapshot" + "value": "security-group-rule", + "name": "security_group_rule" }, { - "value": "spot-fleet-request" + "value": "snapshot", + "name": "snapshot" }, { - "value": "spot-instances-request" + "value": "spot-fleet-request", + "name": "spot_fleet_request" }, { - "value": "subnet" + "value": "spot-instances-request", + "name": "spot_instances_request" }, { - "value": "traffic-mirror-filter" + "value": "subnet", + "name": "subnet" }, { - "value": "traffic-mirror-session" + "value": "traffic-mirror-filter", + "name": "traffic_mirror_filter" }, { - "value": "traffic-mirror-target" + "value": "traffic-mirror-session", + "name": "traffic_mirror_session" }, { - "value": "transit-gateway" + "value": "traffic-mirror-target", + "name": "traffic_mirror_target" }, { - "value": "transit-gateway-attachment" + "value": "transit-gateway", + "name": "transit_gateway" }, { - "value": "transit-gateway-connect-peer" + "value": "transit-gateway-attachment", + "name": "transit_gateway_attachment" }, { - "value": "transit-gateway-multicast-domain" + "value": "transit-gateway-connect-peer", + "name": "transit_gateway_connect_peer" }, { - "value": "transit-gateway-route-table" + "value": "transit-gateway-multicast-domain", + "name": "transit_gateway_multicast_domain" }, { - "value": "volume" + "value": "transit-gateway-route-table", + "name": "transit_gateway_route_table" }, { - "value": "vpc" + "value": "volume", + "name": "volume" }, { - "value": "vpc-peering-connection" + "value": "vpc", + "name": "vpc" }, { - "value": "vpn-connection" + "value": "vpc-peering-connection", + "name": "vpc_peering_connection" }, { - "value": "vpn-gateway" + "value": "vpn-connection", + "name": "vpn_connection" }, { - "value": "vpc-flow-log" + "value": "vpn-gateway", + "name": "vpn_gateway" + }, + { + "value": "vpc-flow-log", + "name": "vpc_flow_log" } ] } @@ -52955,10 +53777,12 @@ "traits": { "smithy.api#enum": [ { - "value": "ebs" + "value": "ebs", + "name": "ebs" }, { - "value": "instance-store" + "value": "instance-store", + "name": "instance_store" } ] } @@ -53117,13 +53941,16 @@ "traits": { "smithy.api#enum": [ { - "value": "CreateRouteTable" + "value": "CreateRouteTable", + "name": "CreateRouteTable" }, { - "value": "CreateRoute" + "value": "CreateRoute", + "name": "CreateRoute" }, { - "value": "EnableVgwRoutePropagation" + "value": "EnableVgwRoutePropagation", + "name": "EnableVgwRoutePropagation" } ] } @@ -53133,10 +53960,12 @@ "traits": { "smithy.api#enum": [ { - "value": "active" + "value": "active", + "name": "active" }, { - "value": "blackhole" + "value": "blackhole", + "name": "blackhole" } ] } @@ -53302,19 +54131,24 @@ "traits": { "smithy.api#enum": [ { - "value": "associating" + "value": "associating", + "name": "associating" }, { - "value": "associated" + "value": "associated", + "name": "associated" }, { - "value": "disassociating" + "value": "disassociating", + "name": "disassociating" }, { - "value": "disassociated" + "value": "disassociated", + "name": "disassociated" }, { - "value": "failed" + "value": "failed", + "name": "failed" } ] } @@ -53345,10 +54179,12 @@ "traits": { "smithy.api#enum": [ { - "value": "allow" + "value": "allow", + "name": "allow" }, { - "value": "deny" + "value": "deny", + "name": "deny" } ] } @@ -54880,10 +55716,12 @@ "traits": { "smithy.api#enum": [ { - "value": "enabled" + "value": "enabled", + "name": "enabled" }, { - "value": "disabled" + "value": "disabled", + "name": "disabled" } ] } @@ -55239,10 +56077,12 @@ "traits": { "smithy.api#enum": [ { - "value": "stop" + "value": "stop", + "name": "stop" }, { - "value": "terminate" + "value": "terminate", + "name": "terminate" } ] } @@ -55414,10 +56254,12 @@ "traits": { "smithy.api#enum": [ { - "value": "productCodes" + "value": "productCodes", + "name": "productCodes" }, { - "value": "createVolumePermission" + "value": "createVolumePermission", + "name": "createVolumePermission" } ] } @@ -55674,13 +56516,16 @@ "traits": { "smithy.api#enum": [ { - "value": "pending" + "value": "pending", + "name": "pending" }, { - "value": "completed" + "value": "completed", + "name": "completed" }, { - "value": "error" + "value": "error", + "name": "error" } ] } @@ -56348,13 +57193,16 @@ "traits": { "smithy.api#enum": [ { - "value": "hibernate" + "value": "hibernate", + "name": "hibernate" }, { - "value": "stop" + "value": "stop", + "name": "stop" }, { - "value": "terminate" + "value": "terminate", + "name": "terminate" } ] } @@ -56545,19 +57393,24 @@ "traits": { "smithy.api#enum": [ { - "value": "open" + "value": "open", + "name": "open" }, { - "value": "active" + "value": "active", + "name": "active" }, { - "value": "closed" + "value": "closed", + "name": "closed" }, { - "value": "cancelled" + "value": "cancelled", + "name": "cancelled" }, { - "value": "failed" + "value": "failed", + "name": "failed" } ] } @@ -56623,10 +57476,12 @@ "traits": { "smithy.api#enum": [ { - "value": "one-time" + "value": "one-time", + "name": "one_time" }, { - "value": "persistent" + "value": "persistent", + "name": "persistent" } ] } @@ -57262,10 +58117,12 @@ "traits": { "smithy.api#enum": [ { - "value": "enable" + "value": "enable", + "name": "enable" }, { - "value": "disable" + "value": "disable", + "name": "disable" } ] } @@ -57294,7 +58151,8 @@ "traits": { "smithy.api#enum": [ { - "value": "reachability" + "value": "reachability", + "name": "reachability" } ] } @@ -57304,16 +58162,20 @@ "traits": { "smithy.api#enum": [ { - "value": "passed" + "value": "passed", + "name": "passed" }, { - "value": "failed" + "value": "failed", + "name": "failed" }, { - "value": "insufficient-data" + "value": "insufficient-data", + "name": "insufficient_data" }, { - "value": "initializing" + "value": "initializing", + "name": "initializing" } ] } @@ -57634,22 +58496,28 @@ "traits": { "smithy.api#enum": [ { - "value": "associating" + "value": "associating", + "name": "associating" }, { - "value": "associated" + "value": "associated", + "name": "associated" }, { - "value": "disassociating" + "value": "disassociating", + "name": "disassociating" }, { - "value": "disassociated" + "value": "disassociated", + "name": "disassociated" }, { - "value": "failing" + "value": "failing", + "name": "failing" }, { - "value": "failed" + "value": "failed", + "name": "failed" } ] } @@ -57721,10 +58589,12 @@ "traits": { "smithy.api#enum": [ { - "value": "pending" + "value": "pending", + "name": "pending" }, { - "value": "available" + "value": "available", + "name": "available" } ] } @@ -57784,19 +58654,24 @@ "traits": { "smithy.api#enum": [ { - "value": "ok" + "value": "ok", + "name": "ok" }, { - "value": "impaired" + "value": "impaired", + "name": "impaired" }, { - "value": "insufficient-data" + "value": "insufficient-data", + "name": "insufficient_data" }, { - "value": "not-applicable" + "value": "not-applicable", + "name": "not_applicable" }, { - "value": "initializing" + "value": "initializing", + "name": "initializing" } ] } @@ -57890,7 +58765,7 @@ "target": "com.amazonaws.ec2#ResourceType", "traits": { "aws.protocols#ec2QueryName": "ResourceType", - "smithy.api#documentation": "

The type of resource to tag. Currently, the resource types that support tagging on\n creation are: capacity-reservation | carrier-gateway |\n client-vpn-endpoint | customer-gateway |\n dedicated-host | dhcp-options | export-image-task\n | export-instance-task | fleet | fpga-image |\n host-reservation | import-image-task |\n import-snapshot-task | instance |\n internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 |\n key-pair | launch-template | placement-group |\n prefix-list | natgateway | network-acl |\n route-table | security-group | spot-fleet-request\n | spot-instances-request | snapshot | subnet |\n traffic-mirror-filter | traffic-mirror-session |\n traffic-mirror-target | transit-gateway |\n \t transit-gateway-attachment | transit-gateway-connect-peer | transit-gateway-multicast-domain | transit-gateway-route-table |\n volume |vpc | vpc-peering-connection |\n vpc-endpoint (for interface and gateway endpoints) |\n vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log |\n vpn-connection | vpn-gateway.

\n

To tag a resource after it has been created, see CreateTags.

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

The type of resource to tag. Currently, the resource types that support tagging on\n creation are: capacity-reservation | carrier-gateway |\n client-vpn-endpoint | customer-gateway |\n \t dedicated-host | dhcp-options | egress-only-internet-gateway | elastic-ip | elastic-gpu |\n \t export-image-task\n | export-instance-task | fleet | fpga-image |\n \t host-reservation | image| import-image-task |\n import-snapshot-task | instance |\n internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 |\n \t key-pair | launch-template | local-gateway-route-table-vpc-association | placement-group |\n \t prefix-list | natgateway | network-acl | network-interface | \n \t reserved-instances |route-table | security-group| snapshot | spot-fleet-request\n | spot-instances-request | snapshot | subnet |\n traffic-mirror-filter | traffic-mirror-session |\n traffic-mirror-target | transit-gateway |\n \t transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table |\n volume |vpc | vpc-peering-connection |\n vpc-endpoint (for interface and gateway endpoints) |\n vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log |\n vpn-connection | vpn-gateway.

\n

To tag a resource after it has been created, see CreateTags.

", "smithy.api#xmlName": "resourceType" } }, @@ -58195,10 +59070,12 @@ "traits": { "smithy.api#enum": [ { - "value": "UP" + "value": "UP", + "name": "UP" }, { - "value": "DOWN" + "value": "DOWN", + "name": "DOWN" } ] } @@ -58208,13 +59085,16 @@ "traits": { "smithy.api#enum": [ { - "value": "default" + "value": "default", + "name": "default" }, { - "value": "dedicated" + "value": "dedicated", + "name": "dedicated" }, { - "value": "host" + "value": "host", + "name": "host" } ] } @@ -58397,10 +59277,12 @@ "traits": { "smithy.api#enum": [ { - "value": "ingress" + "value": "ingress", + "name": "ingress" }, { - "value": "egress" + "value": "egress", + "name": "egress" } ] } @@ -58574,16 +59456,20 @@ "traits": { "smithy.api#enum": [ { - "value": "destination-port-range" + "value": "destination-port-range", + "name": "destination_port_range" }, { - "value": "source-port-range" + "value": "source-port-range", + "name": "source_port_range" }, { - "value": "protocol" + "value": "protocol", + "name": "protocol" }, { - "value": "description" + "value": "description", + "name": "description" } ] } @@ -58620,7 +59506,8 @@ "traits": { "smithy.api#enum": [ { - "value": "amazon-dns" + "value": "amazon-dns", + "name": "amazon_dns" } ] } @@ -58683,10 +59570,12 @@ "traits": { "smithy.api#enum": [ { - "value": "accept" + "value": "accept", + "name": "accept" }, { - "value": "reject" + "value": "reject", + "name": "reject" } ] } @@ -58784,13 +59673,16 @@ "traits": { "smithy.api#enum": [ { - "value": "packet-length" + "value": "packet-length", + "name": "packet_length" }, { - "value": "description" + "value": "description", + "name": "description" }, { - "value": "virtual-network-id" + "value": "virtual-network-id", + "name": "virtual_network_id" } ] } @@ -58912,10 +59804,12 @@ "traits": { "smithy.api#enum": [ { - "value": "network-interface" + "value": "network-interface", + "name": "network_interface" }, { - "value": "network-load-balancer" + "value": "network-load-balancer", + "name": "network_load_balancer" } ] } @@ -58934,13 +59828,16 @@ "traits": { "smithy.api#enum": [ { - "value": "ACCEPT" + "value": "ACCEPT", + "name": "ACCEPT" }, { - "value": "REJECT" + "value": "REJECT", + "name": "REJECT" }, { - "value": "ALL" + "value": "ALL", + "name": "ALL" } ] } @@ -59073,16 +59970,20 @@ "traits": { "smithy.api#enum": [ { - "value": "associating" + "value": "associating", + "name": "associating" }, { - "value": "associated" + "value": "associated", + "name": "associated" }, { - "value": "disassociating" + "value": "disassociating", + "name": "disassociating" }, { - "value": "disassociated" + "value": "disassociated", + "name": "disassociated" } ] } @@ -59312,22 +60213,28 @@ "traits": { "smithy.api#enum": [ { - "value": "vpc" + "value": "vpc", + "name": "vpc" }, { - "value": "vpn" + "value": "vpn", + "name": "vpn" }, { - "value": "direct-connect-gateway" + "value": "direct-connect-gateway", + "name": "direct_connect_gateway" }, { - "value": "connect" + "value": "connect", + "name": "connect" }, { - "value": "peering" + "value": "peering", + "name": "peering" }, { - "value": "tgw-peering" + "value": "tgw-peering", + "name": "tgw_peering" } ] } @@ -59337,43 +60244,56 @@ "traits": { "smithy.api#enum": [ { - "value": "initiating" + "value": "initiating", + "name": "initiating" }, { - "value": "initiatingRequest" + "value": "initiatingRequest", + "name": "initiatingRequest" }, { - "value": "pendingAcceptance" + "value": "pendingAcceptance", + "name": "pendingAcceptance" }, { - "value": "rollingBack" + "value": "rollingBack", + "name": "rollingBack" }, { - "value": "pending" + "value": "pending", + "name": "pending" }, { - "value": "available" + "value": "available", + "name": "available" }, { - "value": "modifying" + "value": "modifying", + "name": "modifying" }, { - "value": "deleting" + "value": "deleting", + "name": "deleting" }, { - "value": "deleted" + "value": "deleted", + "name": "deleted" }, { - "value": "failed" + "value": "failed", + "name": "failed" }, { - "value": "rejected" + "value": "rejected", + "name": "rejected" }, { - "value": "rejecting" + "value": "rejecting", + "name": "rejecting" }, { - "value": "failing" + "value": "failing", + "name": "failing" } ] } @@ -59606,16 +60526,20 @@ "traits": { "smithy.api#enum": [ { - "value": "pending" + "value": "pending", + "name": "pending" }, { - "value": "available" + "value": "available", + "name": "available" }, { - "value": "deleting" + "value": "deleting", + "name": "deleting" }, { - "value": "deleted" + "value": "deleted", + "name": "deleted" } ] } @@ -59669,25 +60593,32 @@ "traits": { "smithy.api#enum": [ { - "value": "pendingAcceptance" + "value": "pendingAcceptance", + "name": "pendingAcceptance" }, { - "value": "associating" + "value": "associating", + "name": "associating" }, { - "value": "associated" + "value": "associated", + "name": "associated" }, { - "value": "disassociating" + "value": "disassociating", + "name": "disassociating" }, { - "value": "disassociated" + "value": "disassociated", + "name": "disassociated" }, { - "value": "rejected" + "value": "rejected", + "name": "rejected" }, { - "value": "failed" + "value": "failed", + "name": "failed" } ] } @@ -59999,16 +60930,20 @@ "traits": { "smithy.api#enum": [ { - "value": "pending" + "value": "pending", + "name": "pending" }, { - "value": "available" + "value": "available", + "name": "available" }, { - "value": "deleting" + "value": "deleting", + "name": "deleting" }, { - "value": "deleted" + "value": "deleted", + "name": "deleted" } ] } @@ -60454,16 +61389,20 @@ "traits": { "smithy.api#enum": [ { - "value": "pending" + "value": "pending", + "name": "pending" }, { - "value": "available" + "value": "available", + "name": "available" }, { - "value": "modifying" + "value": "modifying", + "name": "modifying" }, { - "value": "deleting" + "value": "deleting", + "name": "deleting" } ] } @@ -60521,16 +61460,20 @@ "traits": { "smithy.api#enum": [ { - "value": "enabling" + "value": "enabling", + "name": "enabling" }, { - "value": "enabled" + "value": "enabled", + "name": "enabled" }, { - "value": "disabling" + "value": "disabling", + "name": "disabling" }, { - "value": "disabled" + "value": "disabled", + "name": "disabled" } ] } @@ -60694,19 +61637,24 @@ "traits": { "smithy.api#enum": [ { - "value": "pending" + "value": "pending", + "name": "pending" }, { - "value": "active" + "value": "active", + "name": "active" }, { - "value": "blackhole" + "value": "blackhole", + "name": "blackhole" }, { - "value": "deleting" + "value": "deleting", + "name": "deleting" }, { - "value": "deleted" + "value": "deleted", + "name": "deleted" } ] } @@ -60899,16 +61847,20 @@ "traits": { "smithy.api#enum": [ { - "value": "pending" + "value": "pending", + "name": "pending" }, { - "value": "available" + "value": "available", + "name": "available" }, { - "value": "deleting" + "value": "deleting", + "name": "deleting" }, { - "value": "deleted" + "value": "deleted", + "name": "deleted" } ] } @@ -60918,10 +61870,12 @@ "traits": { "smithy.api#enum": [ { - "value": "static" + "value": "static", + "name": "static" }, { - "value": "propagated" + "value": "propagated", + "name": "propagated" } ] } @@ -60931,19 +61885,24 @@ "traits": { "smithy.api#enum": [ { - "value": "pending" + "value": "pending", + "name": "pending" }, { - "value": "available" + "value": "available", + "name": "available" }, { - "value": "modifying" + "value": "modifying", + "name": "modifying" }, { - "value": "deleting" + "value": "deleting", + "name": "deleting" }, { - "value": "deleted" + "value": "deleted", + "name": "deleted" } ] } @@ -61083,10 +62042,12 @@ "traits": { "smithy.api#enum": [ { - "value": "tcp" + "value": "tcp", + "name": "tcp" }, { - "value": "udp" + "value": "udp", + "name": "udp" } ] } @@ -61096,10 +62057,12 @@ "traits": { "smithy.api#enum": [ { - "value": "ipv4" + "value": "ipv4", + "name": "ipv4" }, { - "value": "ipv6" + "value": "ipv6", + "name": "ipv6" } ] } @@ -61369,16 +62332,20 @@ "traits": { "smithy.api#enum": [ { - "value": "t2" + "value": "t2", + "name": "t2" }, { - "value": "t3" + "value": "t3", + "name": "t3" }, { - "value": "t3a" + "value": "t3a", + "name": "t3a" }, { - "value": "t4g" + "value": "t4g", + "name": "t4g" } ] } @@ -61690,10 +62657,12 @@ "traits": { "smithy.api#enum": [ { - "value": "spot" + "value": "spot", + "name": "spot" }, { - "value": "on-demand" + "value": "on-demand", + "name": "on_demand" } ] } @@ -62059,10 +63028,12 @@ "traits": { "smithy.api#enum": [ { - "value": "hvm" + "value": "hvm", + "name": "hvm" }, { - "value": "paravirtual" + "value": "paravirtual", + "name": "paravirtual" } ] } @@ -62282,19 +63253,24 @@ "traits": { "smithy.api#enum": [ { - "value": "attaching" + "value": "attaching", + "name": "attaching" }, { - "value": "attached" + "value": "attached", + "name": "attached" }, { - "value": "detaching" + "value": "detaching", + "name": "detaching" }, { - "value": "detached" + "value": "detached", + "name": "detached" }, { - "value": "busy" + "value": "busy", + "name": "busy" } ] } @@ -62304,10 +63280,12 @@ "traits": { "smithy.api#enum": [ { - "value": "autoEnableIO" + "value": "autoEnableIO", + "name": "autoEnableIO" }, { - "value": "productCodes" + "value": "productCodes", + "name": "productCodes" } ] } @@ -62413,6 +63391,7 @@ "target": "com.amazonaws.ec2#Boolean", "traits": { "aws.protocols#ec2QueryName": "TargetMultiAttachEnabled", + "smithy.api#documentation": "

The target setting for Amazon EBS Multi-Attach.

", "smithy.api#xmlName": "targetMultiAttachEnabled" } }, @@ -62452,6 +63431,7 @@ "target": "com.amazonaws.ec2#Boolean", "traits": { "aws.protocols#ec2QueryName": "OriginalMultiAttachEnabled", + "smithy.api#documentation": "

The original setting for Amazon EBS Multi-Attach.

", "smithy.api#xmlName": "originalMultiAttachEnabled" } }, @@ -62498,16 +63478,20 @@ "traits": { "smithy.api#enum": [ { - "value": "modifying" + "value": "modifying", + "name": "modifying" }, { - "value": "optimizing" + "value": "optimizing", + "name": "optimizing" }, { - "value": "completed" + "value": "completed", + "name": "completed" }, { - "value": "failed" + "value": "failed", + "name": "failed" } ] } @@ -62517,22 +63501,28 @@ "traits": { "smithy.api#enum": [ { - "value": "creating" + "value": "creating", + "name": "creating" }, { - "value": "available" + "value": "available", + "name": "available" }, { - "value": "in-use" + "value": "in-use", + "name": "in_use" }, { - "value": "deleting" + "value": "deleting", + "name": "deleting" }, { - "value": "deleted" + "value": "deleted", + "name": "deleted" }, { - "value": "error" + "value": "error", + "name": "error" } ] } @@ -62746,13 +63736,16 @@ "traits": { "smithy.api#enum": [ { - "value": "ok" + "value": "ok", + "name": "ok" }, { - "value": "impaired" + "value": "impaired", + "name": "impaired" }, { - "value": "insufficient-data" + "value": "insufficient-data", + "name": "insufficient_data" } ] } @@ -62835,10 +63828,12 @@ "traits": { "smithy.api#enum": [ { - "value": "io-enabled" + "value": "io-enabled", + "name": "io_enabled" }, { - "value": "io-performance" + "value": "io-performance", + "name": "io_performance" } ] } @@ -62848,25 +63843,32 @@ "traits": { "smithy.api#enum": [ { - "value": "standard" + "value": "standard", + "name": "standard" }, { - "value": "io1" + "value": "io1", + "name": "io1" }, { - "value": "io2" + "value": "io2", + "name": "io2" }, { - "value": "gp2" + "value": "gp2", + "name": "gp2" }, { - "value": "sc1" + "value": "sc1", + "name": "sc1" }, { - "value": "st1" + "value": "st1", + "name": "st1" }, { - "value": "gp3" + "value": "gp3", + "name": "gp3" } ] } @@ -62997,10 +63999,12 @@ "traits": { "smithy.api#enum": [ { - "value": "enableDnsSupport" + "value": "enableDnsSupport", + "name": "enableDnsSupport" }, { - "value": "enableDnsHostnames" + "value": "enableDnsHostnames", + "name": "enableDnsHostnames" } ] } @@ -63078,22 +64082,28 @@ "traits": { "smithy.api#enum": [ { - "value": "associating" + "value": "associating", + "name": "associating" }, { - "value": "associated" + "value": "associated", + "name": "associated" }, { - "value": "disassociating" + "value": "disassociating", + "name": "disassociating" }, { - "value": "disassociated" + "value": "disassociated", + "name": "disassociated" }, { - "value": "failing" + "value": "failing", + "name": "failing" }, { - "value": "failed" + "value": "failed", + "name": "failed" } ] } @@ -63671,31 +64681,40 @@ "traits": { "smithy.api#enum": [ { - "value": "initiating-request" + "value": "initiating-request", + "name": "initiating_request" }, { - "value": "pending-acceptance" + "value": "pending-acceptance", + "name": "pending_acceptance" }, { - "value": "active" + "value": "active", + "name": "active" }, { - "value": "deleted" + "value": "deleted", + "name": "deleted" }, { - "value": "rejected" + "value": "rejected", + "name": "rejected" }, { - "value": "failed" + "value": "failed", + "name": "failed" }, { - "value": "expired" + "value": "expired", + "name": "expired" }, { - "value": "provisioning" + "value": "provisioning", + "name": "provisioning" }, { - "value": "deleting" + "value": "deleting", + "name": "deleting" } ] } @@ -63769,10 +64788,12 @@ "traits": { "smithy.api#enum": [ { - "value": "pending" + "value": "pending", + "name": "pending" }, { - "value": "available" + "value": "available", + "name": "available" } ] } @@ -63782,7 +64803,8 @@ "traits": { "smithy.api#enum": [ { - "value": "default" + "value": "default", + "name": "default" } ] } @@ -64047,10 +65069,12 @@ "traits": { "smithy.api#enum": [ { - "value": "enable" + "value": "enable", + "name": "enable" }, { - "value": "disable" + "value": "disable", + "name": "disable" } ] } @@ -64145,7 +65169,8 @@ "traits": { "smithy.api#enum": [ { - "value": "openvpn" + "value": "openvpn", + "name": "openvpn" } ] } @@ -64155,16 +65180,20 @@ "traits": { "smithy.api#enum": [ { - "value": "pending" + "value": "pending", + "name": "pending" }, { - "value": "available" + "value": "available", + "name": "available" }, { - "value": "deleting" + "value": "deleting", + "name": "deleting" }, { - "value": "deleted" + "value": "deleted", + "name": "deleted" } ] } @@ -64215,7 +65244,8 @@ "traits": { "smithy.api#enum": [ { - "value": "Static" + "value": "Static", + "name": "Static" } ] } diff --git a/codegen/sdk-codegen/aws-models/eks.2017-11-01.json b/codegen/sdk-codegen/aws-models/eks.2017-11-01.json index 360375a8c65..abc0024a424 100644 --- a/codegen/sdk-codegen/aws-models/eks.2017-11-01.json +++ b/codegen/sdk-codegen/aws-models/eks.2017-11-01.json @@ -34,13 +34,16 @@ "traits": { "smithy.api#enum": [ { - "value": "AL2_x86_64" + "value": "AL2_x86_64", + "name": "AL2_x86_64" }, { - "value": "AL2_x86_64_GPU" + "value": "AL2_x86_64_GPU", + "name": "AL2_x86_64_GPU" }, { - "value": "AL2_ARM_64" + "value": "AL2_ARM_64", + "name": "AL2_ARM_64" } ] } @@ -319,25 +322,32 @@ "traits": { "smithy.api#enum": [ { - "value": "CREATING" + "value": "CREATING", + "name": "CREATING" }, { - "value": "ACTIVE" + "value": "ACTIVE", + "name": "ACTIVE" }, { - "value": "CREATE_FAILED" + "value": "CREATE_FAILED", + "name": "CREATE_FAILED" }, { - "value": "UPDATING" + "value": "UPDATING", + "name": "UPDATING" }, { - "value": "DELETING" + "value": "DELETING", + "name": "DELETING" }, { - "value": "DELETE_FAILED" + "value": "DELETE_FAILED", + "name": "DELETE_FAILED" }, { - "value": "DEGRADED" + "value": "DEGRADED", + "name": "DEGRADED" } ] } @@ -442,10 +452,12 @@ "traits": { "smithy.api#enum": [ { - "value": "ON_DEMAND" + "value": "ON_DEMAND", + "name": "ON_DEMAND" }, { - "value": "SPOT" + "value": "SPOT", + "name": "SPOT" } ] } @@ -611,19 +623,24 @@ "traits": { "smithy.api#enum": [ { - "value": "CREATING" + "value": "CREATING", + "name": "CREATING" }, { - "value": "ACTIVE" + "value": "ACTIVE", + "name": "ACTIVE" }, { - "value": "DELETING" + "value": "DELETING", + "name": "DELETING" }, { - "value": "FAILED" + "value": "FAILED", + "name": "FAILED" }, { - "value": "UPDATING" + "value": "UPDATING", + "name": "UPDATING" } ] } @@ -2192,19 +2209,24 @@ "traits": { "smithy.api#enum": [ { - "value": "CREATING" + "value": "CREATING", + "name": "CREATING" }, { - "value": "ACTIVE" + "value": "ACTIVE", + "name": "ACTIVE" }, { - "value": "DELETING" + "value": "DELETING", + "name": "DELETING" }, { - "value": "CREATE_FAILED" + "value": "CREATE_FAILED", + "name": "CREATE_FAILED" }, { - "value": "DELETE_FAILED" + "value": "DELETE_FAILED", + "name": "DELETE_FAILED" } ] } @@ -3238,25 +3260,32 @@ "traits": { "smithy.api#enum": [ { - "value": "CREATING" + "value": "CREATING", + "name": "CREATING" }, { - "value": "ACTIVE" + "value": "ACTIVE", + "name": "ACTIVE" }, { - "value": "UPDATING" + "value": "UPDATING", + "name": "UPDATING" }, { - "value": "DELETING" + "value": "DELETING", + "name": "DELETING" }, { - "value": "CREATE_FAILED" + "value": "CREATE_FAILED", + "name": "CREATE_FAILED" }, { - "value": "DELETE_FAILED" + "value": "DELETE_FAILED", + "name": "DELETE_FAILED" }, { - "value": "DEGRADED" + "value": "DEGRADED", + "name": "DEGRADED" } ] } @@ -3327,10 +3356,12 @@ "traits": { "smithy.api#enum": [ { - "value": "OVERWRITE" + "value": "OVERWRITE", + "name": "OVERWRITE" }, { - "value": "NONE" + "value": "NONE", + "name": "NONE" } ] } diff --git a/codegen/sdk-codegen/aws-models/elasticache.2015-02-02.json b/codegen/sdk-codegen/aws-models/elasticache.2015-02-02.json index eb0b4f8d051..907a21099a4 100644 --- a/codegen/sdk-codegen/aws-models/elasticache.2015-02-02.json +++ b/codegen/sdk-codegen/aws-models/elasticache.2015-02-02.json @@ -365,10 +365,12 @@ "traits": { "smithy.api#enum": [ { - "value": "SETTING" + "value": "SETTING", + "name": "SETTING" }, { - "value": "ROTATING" + "value": "ROTATING", + "name": "ROTATING" } ] } @@ -378,13 +380,16 @@ "traits": { "smithy.api#enum": [ { - "value": "SET" + "value": "SET", + "name": "SET" }, { - "value": "ROTATE" + "value": "ROTATE", + "name": "ROTATE" }, { - "value": "DELETE" + "value": "DELETE", + "name": "DELETE" } ] } @@ -1661,10 +1666,12 @@ "traits": { "smithy.api#enum": [ { - "value": "immediate" + "value": "immediate", + "name": "immediate" }, { - "value": "requires-reboot" + "value": "requires-reboot", + "name": "requires_reboot" } ] } @@ -2291,7 +2298,7 @@ } ], "traits": { - "smithy.api#documentation": "

Global Datastore for Redis offers fully managed, fast, \n reliable and secure cross-region replication.\n Using Global Datastore for Redis, you can create cross-region\n read replica clusters for ElastiCache for Redis to enable low-latency reads\n and disaster recovery across regions. For more information,\n see Replication Across Regions Using Global Datastore.

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

Global Datastore for Redis offers fully managed, fast, \n reliable and secure cross-region replication.\n Using Global Datastore for Redis, you can create cross-region\n read replica clusters for ElastiCache for Redis to enable low-latency reads\n and disaster recovery across regions. For more information,\n see Replication Across Regions Using Global Datastore.

\n " } }, "com.amazonaws.elasticache#CreateGlobalReplicationGroupMessage": { @@ -2300,7 +2307,7 @@ "GlobalReplicationGroupIdSuffix": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The suffix name of a Global Datastore. Amazon ElastiCache automatically applies a prefix \n to the Global Datastore ID when it is created. Each AWS Region has its own prefix. For instance, a Global Datastore ID created in the US-West-1 region will begin with \"dsdfu\" along with the suffix name you provide. The suffix, combined with the auto-generated prefix, guarantees uniqueness of the Global Datastore name across multiple regions.

\n

For a full list of AWS Regions and their respective Global Datastore iD prefixes, see Using the AWS CLI with Global Datastores .

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

The suffix name of a Global Datastore. Amazon ElastiCache automatically applies a prefix \n to the Global Datastore ID when it is created. Each AWS Region has its own prefix. For instance, a Global Datastore ID created in the US-West-1 region will begin with \"dsdfu\" along with the suffix name you provide. The suffix, combined with the auto-generated prefix, guarantees uniqueness of the Global Datastore name across multiple regions.

\n

For a full list of AWS Regions and their respective Global Datastore iD prefixes, see Using the AWS CLI with Global Datastores .

", "smithy.api#required": {} } }, @@ -8829,25 +8836,32 @@ "traits": { "smithy.api#enum": [ { - "value": "cache-cluster" + "value": "cache-cluster", + "name": "cache_cluster" }, { - "value": "cache-parameter-group" + "value": "cache-parameter-group", + "name": "cache_parameter_group" }, { - "value": "cache-security-group" + "value": "cache-security-group", + "name": "cache_security_group" }, { - "value": "cache-subnet-group" + "value": "cache-subnet-group", + "name": "cache_subnet_group" }, { - "value": "replication-group" + "value": "replication-group", + "name": "replication_group" }, { - "value": "user" + "value": "user", + "name": "user" }, { - "value": "user-group" + "value": "user-group", + "name": "user_group" } ] } diff --git a/codegen/sdk-codegen/aws-models/elasticbeanstalk.2010-12-01.json b/codegen/sdk-codegen/aws-models/elasticbeanstalk.2010-12-01.json index 699fee0958a..4e9bf0310ae 100644 --- a/codegen/sdk-codegen/aws-models/elasticbeanstalk.2010-12-01.json +++ b/codegen/sdk-codegen/aws-models/elasticbeanstalk.2010-12-01.json @@ -242,13 +242,16 @@ "traits": { "smithy.api#enum": [ { - "value": "Completed" + "value": "Completed", + "name": "Completed" }, { - "value": "Failed" + "value": "Failed", + "name": "Failed" }, { - "value": "Unknown" + "value": "Unknown", + "name": "Unknown" } ] } @@ -258,16 +261,20 @@ "traits": { "smithy.api#enum": [ { - "value": "Scheduled" + "value": "Scheduled", + "name": "Scheduled" }, { - "value": "Pending" + "value": "Pending", + "name": "Pending" }, { - "value": "Running" + "value": "Running", + "name": "Running" }, { - "value": "Unknown" + "value": "Unknown", + "name": "Unknown" } ] } @@ -277,13 +284,16 @@ "traits": { "smithy.api#enum": [ { - "value": "InstanceRefresh" + "value": "InstanceRefresh", + "name": "InstanceRefresh" }, { - "value": "PlatformUpdate" + "value": "PlatformUpdate", + "name": "PlatformUpdate" }, { - "value": "Unknown" + "value": "Unknown", + "name": "Unknown" } ] } @@ -607,19 +617,24 @@ "traits": { "smithy.api#enum": [ { - "value": "Processed" + "value": "Processed", + "name": "Processed" }, { - "value": "Unprocessed" + "value": "Unprocessed", + "name": "Unprocessed" }, { - "value": "Failed" + "value": "Failed", + "name": "Failed" }, { - "value": "Processing" + "value": "Processing", + "name": "Processing" }, { - "value": "Building" + "value": "Building", + "name": "Building" } ] } @@ -1059,13 +1074,16 @@ "traits": { "smithy.api#enum": [ { - "value": "deployed" + "value": "deployed", + "name": "deployed" }, { - "value": "pending" + "value": "pending", + "name": "pending" }, { - "value": "failed" + "value": "failed", + "name": "failed" } ] } @@ -1214,10 +1232,12 @@ "traits": { "smithy.api#enum": [ { - "value": "Scalar" + "value": "Scalar", + "name": "Scalar" }, { - "value": "List" + "value": "List", + "name": "List" } ] } @@ -3179,16 +3199,20 @@ "traits": { "smithy.api#enum": [ { - "value": "Green" + "value": "Green", + "name": "Green" }, { - "value": "Yellow" + "value": "Yellow", + "name": "Yellow" }, { - "value": "Red" + "value": "Red", + "name": "Red" }, { - "value": "Grey" + "value": "Grey", + "name": "Grey" } ] } @@ -3243,31 +3267,40 @@ "traits": { "smithy.api#enum": [ { - "value": "NoData" + "value": "NoData", + "name": "NoData" }, { - "value": "Unknown" + "value": "Unknown", + "name": "Unknown" }, { - "value": "Pending" + "value": "Pending", + "name": "Pending" }, { - "value": "Ok" + "value": "Ok", + "name": "Ok" }, { - "value": "Info" + "value": "Info", + "name": "Info" }, { - "value": "Warning" + "value": "Warning", + "name": "Warning" }, { - "value": "Degraded" + "value": "Degraded", + "name": "Degraded" }, { - "value": "Severe" + "value": "Severe", + "name": "Severe" }, { - "value": "Suspended" + "value": "Suspended", + "name": "Suspended" } ] } @@ -3324,10 +3357,12 @@ "traits": { "smithy.api#enum": [ { - "value": "tail" + "value": "tail", + "name": "tail" }, { - "value": "bundle" + "value": "bundle", + "name": "bundle" } ] } @@ -3462,28 +3497,36 @@ "traits": { "smithy.api#enum": [ { - "value": "Aborting" + "value": "Aborting", + "name": "Aborting" }, { - "value": "Launching" + "value": "Launching", + "name": "Launching" }, { - "value": "Updating" + "value": "Updating", + "name": "Updating" }, { - "value": "LinkingFrom" + "value": "LinkingFrom", + "name": "LinkingFrom" }, { - "value": "LinkingTo" + "value": "LinkingTo", + "name": "LinkingTo" }, { - "value": "Ready" + "value": "Ready", + "name": "Ready" }, { - "value": "Terminating" + "value": "Terminating", + "name": "Terminating" }, { - "value": "Terminated" + "value": "Terminated", + "name": "Terminated" } ] } @@ -3613,22 +3656,28 @@ "traits": { "smithy.api#enum": [ { - "value": "TRACE" + "value": "TRACE", + "name": "TRACE" }, { - "value": "DEBUG" + "value": "DEBUG", + "name": "DEBUG" }, { - "value": "INFO" + "value": "INFO", + "name": "INFO" }, { - "value": "WARN" + "value": "WARN", + "name": "WARN" }, { - "value": "ERROR" + "value": "ERROR", + "name": "ERROR" }, { - "value": "FATAL" + "value": "FATAL", + "name": "FATAL" } ] } @@ -3641,25 +3690,32 @@ "traits": { "smithy.api#enum": [ { - "value": "UpdateCancelled" + "value": "UpdateCancelled", + "name": "UpdateCancelled" }, { - "value": "CancellationFailed" + "value": "CancellationFailed", + "name": "CancellationFailed" }, { - "value": "RollbackFailed" + "value": "RollbackFailed", + "name": "RollbackFailed" }, { - "value": "RollbackSuccessful" + "value": "RollbackSuccessful", + "name": "RollbackSuccessful" }, { - "value": "InternalFailure" + "value": "InternalFailure", + "name": "InternalFailure" }, { - "value": "InvalidEnvironmentState" + "value": "InvalidEnvironmentState", + "name": "InvalidEnvironmentState" }, { - "value": "PermissionsError" + "value": "PermissionsError", + "name": "PermissionsError" } ] } @@ -4919,19 +4975,24 @@ "traits": { "smithy.api#enum": [ { - "value": "Creating" + "value": "Creating", + "name": "Creating" }, { - "value": "Failed" + "value": "Failed", + "name": "Failed" }, { - "value": "Ready" + "value": "Ready", + "name": "Ready" }, { - "value": "Deleting" + "value": "Deleting", + "name": "Deleting" }, { - "value": "Deleted" + "value": "Deleted", + "name": "Deleted" } ] } @@ -5647,10 +5708,12 @@ "traits": { "smithy.api#enum": [ { - "value": "CodeCommit" + "value": "CodeCommit", + "name": "CodeCommit" }, { - "value": "S3" + "value": "S3", + "name": "S3" } ] } @@ -5660,10 +5723,12 @@ "traits": { "smithy.api#enum": [ { - "value": "Git" + "value": "Git", + "name": "Git" }, { - "value": "Zip" + "value": "Zip", + "name": "Zip" } ] } @@ -6470,10 +6535,12 @@ "traits": { "smithy.api#enum": [ { - "value": "error" + "value": "error", + "name": "error" }, { - "value": "warning" + "value": "warning", + "name": "warning" } ] } diff --git a/codegen/sdk-codegen/aws-models/elasticinference.2017-07-25.json b/codegen/sdk-codegen/aws-models/elasticinference.2017-07-25.json index cd5804bbd54..faaa7ba0a79 100644 --- a/codegen/sdk-codegen/aws-models/elasticinference.2017-07-25.json +++ b/codegen/sdk-codegen/aws-models/elasticinference.2017-07-25.json @@ -607,13 +607,16 @@ "traits": { "smithy.api#enum": [ { - "value": "region" + "value": "region", + "name": "region" }, { - "value": "availability-zone" + "value": "availability-zone", + "name": "availability_zone" }, { - "value": "availability-zone-id" + "value": "availability-zone-id", + "name": "availability_zone_id" } ], "smithy.api#length": { diff --git a/codegen/sdk-codegen/aws-models/elasticloadbalancingv2.2015-12-01.json b/codegen/sdk-codegen/aws-models/elasticloadbalancingv2.2015-12-01.json index 70b5a188918..95de4d4fb90 100644 --- a/codegen/sdk-codegen/aws-models/elasticloadbalancingv2.2015-12-01.json +++ b/codegen/sdk-codegen/aws-models/elasticloadbalancingv2.2015-12-01.json @@ -3413,25 +3413,32 @@ "traits": { "smithy.api#enum": [ { - "value": "HTTP" + "value": "HTTP", + "name": "HTTP" }, { - "value": "HTTPS" + "value": "HTTPS", + "name": "HTTPS" }, { - "value": "TCP" + "value": "TCP", + "name": "TCP" }, { - "value": "TLS" + "value": "TLS", + "name": "TLS" }, { - "value": "UDP" + "value": "UDP", + "name": "UDP" }, { - "value": "TCP_UDP" + "value": "TCP_UDP", + "name": "TCP_UDP" }, { - "value": "GENEVE" + "value": "GENEVE", + "name": "GENEVE" } ] } diff --git a/codegen/sdk-codegen/aws-models/elasticsearchservice.2015-01-01.json b/codegen/sdk-codegen/aws-models/elasticsearchservice.2015-01-01.json index 04b6ec89fbf..90e9c0dd7a9 100644 --- a/codegen/sdk-codegen/aws-models/elasticsearchservice.2015-01-01.json +++ b/codegen/sdk-codegen/aws-models/elasticsearchservice.2015-01-01.json @@ -1352,19 +1352,24 @@ "traits": { "smithy.api#enum": [ { - "value": "PENDING_UPDATE" + "value": "PENDING_UPDATE", + "name": "PENDING_UPDATE" }, { - "value": "IN_PROGRESS" + "value": "IN_PROGRESS", + "name": "IN_PROGRESS" }, { - "value": "COMPLETED" + "value": "COMPLETED", + "name": "COMPLETED" }, { - "value": "NOT_ELIGIBLE" + "value": "NOT_ELIGIBLE", + "name": "NOT_ELIGIBLE" }, { - "value": "ELIGIBLE" + "value": "ELIGIBLE", + "name": "ELIGIBLE" } ] } @@ -2392,19 +2397,24 @@ "traits": { "smithy.api#enum": [ { - "value": "ASSOCIATING" + "value": "ASSOCIATING", + "name": "ASSOCIATING" }, { - "value": "ASSOCIATION_FAILED" + "value": "ASSOCIATION_FAILED", + "name": "ASSOCIATION_FAILED" }, { - "value": "ACTIVE" + "value": "ACTIVE", + "name": "ACTIVE" }, { - "value": "DISSOCIATING" + "value": "DISSOCIATING", + "name": "DISSOCIATING" }, { - "value": "DISSOCIATION_FAILED" + "value": "DISSOCIATION_FAILED", + "name": "DISSOCIATION_FAILED" } ] } @@ -2474,178 +2484,236 @@ "traits": { "smithy.api#enum": [ { - "value": "m3.medium.elasticsearch" + "value": "m3.medium.elasticsearch", + "name": "m3_medium_elasticsearch" }, { - "value": "m3.large.elasticsearch" + "value": "m3.large.elasticsearch", + "name": "m3_large_elasticsearch" }, { - "value": "m3.xlarge.elasticsearch" + "value": "m3.xlarge.elasticsearch", + "name": "m3_xlarge_elasticsearch" }, { - "value": "m3.2xlarge.elasticsearch" + "value": "m3.2xlarge.elasticsearch", + "name": "m3_2xlarge_elasticsearch" }, { - "value": "m4.large.elasticsearch" + "value": "m4.large.elasticsearch", + "name": "m4_large_elasticsearch" }, { - "value": "m4.xlarge.elasticsearch" + "value": "m4.xlarge.elasticsearch", + "name": "m4_xlarge_elasticsearch" }, { - "value": "m4.2xlarge.elasticsearch" + "value": "m4.2xlarge.elasticsearch", + "name": "m4_2xlarge_elasticsearch" }, { - "value": "m4.4xlarge.elasticsearch" + "value": "m4.4xlarge.elasticsearch", + "name": "m4_4xlarge_elasticsearch" }, { - "value": "m4.10xlarge.elasticsearch" + "value": "m4.10xlarge.elasticsearch", + "name": "m4_10xlarge_elasticsearch" }, { - "value": "m5.large.elasticsearch" + "value": "m5.large.elasticsearch", + "name": "m5_large_elasticsearch" }, { - "value": "m5.xlarge.elasticsearch" + "value": "m5.xlarge.elasticsearch", + "name": "m5_xlarge_elasticsearch" }, { - "value": "m5.2xlarge.elasticsearch" + "value": "m5.2xlarge.elasticsearch", + "name": "m5_2xlarge_elasticsearch" }, { - "value": "m5.4xlarge.elasticsearch" + "value": "m5.4xlarge.elasticsearch", + "name": "m5_4xlarge_elasticsearch" }, { - "value": "m5.12xlarge.elasticsearch" + "value": "m5.12xlarge.elasticsearch", + "name": "m5_12xlarge_elasticsearch" }, { - "value": "r5.large.elasticsearch" + "value": "r5.large.elasticsearch", + "name": "r5_large_elasticsearch" }, { - "value": "r5.xlarge.elasticsearch" + "value": "r5.xlarge.elasticsearch", + "name": "r5_xlarge_elasticsearch" }, { - "value": "r5.2xlarge.elasticsearch" + "value": "r5.2xlarge.elasticsearch", + "name": "r5_2xlarge_elasticsearch" }, { - "value": "r5.4xlarge.elasticsearch" + "value": "r5.4xlarge.elasticsearch", + "name": "r5_4xlarge_elasticsearch" }, { - "value": "r5.12xlarge.elasticsearch" + "value": "r5.12xlarge.elasticsearch", + "name": "r5_12xlarge_elasticsearch" }, { - "value": "c5.large.elasticsearch" + "value": "c5.large.elasticsearch", + "name": "c5_large_elasticsearch" }, { - "value": "c5.xlarge.elasticsearch" + "value": "c5.xlarge.elasticsearch", + "name": "c5_xlarge_elasticsearch" }, { - "value": "c5.2xlarge.elasticsearch" + "value": "c5.2xlarge.elasticsearch", + "name": "c5_2xlarge_elasticsearch" }, { - "value": "c5.4xlarge.elasticsearch" + "value": "c5.4xlarge.elasticsearch", + "name": "c5_4xlarge_elasticsearch" }, { - "value": "c5.9xlarge.elasticsearch" + "value": "c5.9xlarge.elasticsearch", + "name": "c5_9xlarge_elasticsearch" }, { - "value": "c5.18xlarge.elasticsearch" + "value": "c5.18xlarge.elasticsearch", + "name": "c5_18xlarge_elasticsearch" }, { - "value": "ultrawarm1.medium.elasticsearch" + "value": "ultrawarm1.medium.elasticsearch", + "name": "ultrawarm1_medium_elasticsearch" }, { - "value": "ultrawarm1.large.elasticsearch" + "value": "ultrawarm1.large.elasticsearch", + "name": "ultrawarm1_large_elasticsearch" }, { - "value": "t2.micro.elasticsearch" + "value": "t2.micro.elasticsearch", + "name": "t2_micro_elasticsearch" }, { - "value": "t2.small.elasticsearch" + "value": "t2.small.elasticsearch", + "name": "t2_small_elasticsearch" }, { - "value": "t2.medium.elasticsearch" + "value": "t2.medium.elasticsearch", + "name": "t2_medium_elasticsearch" }, { - "value": "r3.large.elasticsearch" + "value": "r3.large.elasticsearch", + "name": "r3_large_elasticsearch" }, { - "value": "r3.xlarge.elasticsearch" + "value": "r3.xlarge.elasticsearch", + "name": "r3_xlarge_elasticsearch" }, { - "value": "r3.2xlarge.elasticsearch" + "value": "r3.2xlarge.elasticsearch", + "name": "r3_2xlarge_elasticsearch" }, { - "value": "r3.4xlarge.elasticsearch" + "value": "r3.4xlarge.elasticsearch", + "name": "r3_4xlarge_elasticsearch" }, { - "value": "r3.8xlarge.elasticsearch" + "value": "r3.8xlarge.elasticsearch", + "name": "r3_8xlarge_elasticsearch" }, { - "value": "i2.xlarge.elasticsearch" + "value": "i2.xlarge.elasticsearch", + "name": "i2_xlarge_elasticsearch" }, { - "value": "i2.2xlarge.elasticsearch" + "value": "i2.2xlarge.elasticsearch", + "name": "i2_2xlarge_elasticsearch" }, { - "value": "d2.xlarge.elasticsearch" + "value": "d2.xlarge.elasticsearch", + "name": "d2_xlarge_elasticsearch" }, { - "value": "d2.2xlarge.elasticsearch" + "value": "d2.2xlarge.elasticsearch", + "name": "d2_2xlarge_elasticsearch" }, { - "value": "d2.4xlarge.elasticsearch" + "value": "d2.4xlarge.elasticsearch", + "name": "d2_4xlarge_elasticsearch" }, { - "value": "d2.8xlarge.elasticsearch" + "value": "d2.8xlarge.elasticsearch", + "name": "d2_8xlarge_elasticsearch" }, { - "value": "c4.large.elasticsearch" + "value": "c4.large.elasticsearch", + "name": "c4_large_elasticsearch" }, { - "value": "c4.xlarge.elasticsearch" + "value": "c4.xlarge.elasticsearch", + "name": "c4_xlarge_elasticsearch" }, { - "value": "c4.2xlarge.elasticsearch" + "value": "c4.2xlarge.elasticsearch", + "name": "c4_2xlarge_elasticsearch" }, { - "value": "c4.4xlarge.elasticsearch" + "value": "c4.4xlarge.elasticsearch", + "name": "c4_4xlarge_elasticsearch" }, { - "value": "c4.8xlarge.elasticsearch" + "value": "c4.8xlarge.elasticsearch", + "name": "c4_8xlarge_elasticsearch" }, { - "value": "r4.large.elasticsearch" + "value": "r4.large.elasticsearch", + "name": "r4_large_elasticsearch" }, { - "value": "r4.xlarge.elasticsearch" + "value": "r4.xlarge.elasticsearch", + "name": "r4_xlarge_elasticsearch" }, { - "value": "r4.2xlarge.elasticsearch" + "value": "r4.2xlarge.elasticsearch", + "name": "r4_2xlarge_elasticsearch" }, { - "value": "r4.4xlarge.elasticsearch" + "value": "r4.4xlarge.elasticsearch", + "name": "r4_4xlarge_elasticsearch" }, { - "value": "r4.8xlarge.elasticsearch" + "value": "r4.8xlarge.elasticsearch", + "name": "r4_8xlarge_elasticsearch" }, { - "value": "r4.16xlarge.elasticsearch" + "value": "r4.16xlarge.elasticsearch", + "name": "r4_16xlarge_elasticsearch" }, { - "value": "i3.large.elasticsearch" + "value": "i3.large.elasticsearch", + "name": "i3_large_elasticsearch" }, { - "value": "i3.xlarge.elasticsearch" + "value": "i3.xlarge.elasticsearch", + "name": "i3_xlarge_elasticsearch" }, { - "value": "i3.2xlarge.elasticsearch" + "value": "i3.2xlarge.elasticsearch", + "name": "i3_2xlarge_elasticsearch" }, { - "value": "i3.4xlarge.elasticsearch" + "value": "i3.4xlarge.elasticsearch", + "name": "i3_4xlarge_elasticsearch" }, { - "value": "i3.8xlarge.elasticsearch" + "value": "i3.8xlarge.elasticsearch", + "name": "i3_8xlarge_elasticsearch" }, { - "value": "i3.16xlarge.elasticsearch" + "value": "i3.16xlarge.elasticsearch", + "name": "i3_16xlarge_elasticsearch" } ] } @@ -2655,10 +2723,12 @@ "traits": { "smithy.api#enum": [ { - "value": "ultrawarm1.medium.elasticsearch" + "value": "ultrawarm1.medium.elasticsearch", + "name": "ultrawarm1_medium_elasticsearch" }, { - "value": "ultrawarm1.large.elasticsearch" + "value": "ultrawarm1.large.elasticsearch", + "name": "ultrawarm1_large_elasticsearch" } ] } @@ -4215,16 +4285,20 @@ "smithy.api#documentation": "

Type of Log File, it can be one of the following:\n

\n

", "smithy.api#enum": [ { - "value": "INDEX_SLOW_LOGS" + "value": "INDEX_SLOW_LOGS", + "name": "INDEX_SLOW_LOGS" }, { - "value": "SEARCH_SLOW_LOGS" + "value": "SEARCH_SLOW_LOGS", + "name": "SEARCH_SLOW_LOGS" }, { - "value": "ES_APPLICATION_LOGS" + "value": "ES_APPLICATION_LOGS", + "name": "ES_APPLICATION_LOGS" }, { - "value": "AUDIT_LOGS" + "value": "AUDIT_LOGS", + "name": "AUDIT_LOGS" } ] } @@ -4332,13 +4406,16 @@ "smithy.api#documentation": "

The state of a requested change. One of the following:

\n ", "smithy.api#enum": [ { - "value": "RequiresIndexDocuments" + "value": "RequiresIndexDocuments", + "name": "RequiresIndexDocuments" }, { - "value": "Processing" + "value": "Processing", + "name": "Processing" }, { - "value": "Active" + "value": "Active", + "name": "Active" } ] } @@ -4605,28 +4682,36 @@ "traits": { "smithy.api#enum": [ { - "value": "COPYING" + "value": "COPYING", + "name": "COPYING" }, { - "value": "COPY_FAILED" + "value": "COPY_FAILED", + "name": "COPY_FAILED" }, { - "value": "VALIDATING" + "value": "VALIDATING", + "name": "VALIDATING" }, { - "value": "VALIDATION_FAILED" + "value": "VALIDATION_FAILED", + "name": "VALIDATION_FAILED" }, { - "value": "AVAILABLE" + "value": "AVAILABLE", + "name": "AVAILABLE" }, { - "value": "DELETING" + "value": "DELETING", + "name": "DELETING" }, { - "value": "DELETED" + "value": "DELETED", + "name": "DELETED" }, { - "value": "DELETE_FAILED" + "value": "DELETE_FAILED", + "name": "DELETE_FAILED" } ] } @@ -4636,7 +4721,8 @@ "traits": { "smithy.api#enum": [ { - "value": "TXT-DICTIONARY" + "value": "TXT-DICTIONARY", + "name": "TXT_DICTIONARY" } ] } @@ -5084,13 +5170,16 @@ "traits": { "smithy.api#enum": [ { - "value": "ALL_UPFRONT" + "value": "ALL_UPFRONT", + "name": "ALL_UPFRONT" }, { - "value": "PARTIAL_UPFRONT" + "value": "PARTIAL_UPFRONT", + "name": "PARTIAL_UPFRONT" }, { - "value": "NO_UPFRONT" + "value": "NO_UPFRONT", + "name": "NO_UPFRONT" } ] } @@ -5932,16 +6021,20 @@ "traits": { "smithy.api#enum": [ { - "value": "IN_PROGRESS" + "value": "IN_PROGRESS", + "name": "IN_PROGRESS" }, { - "value": "SUCCEEDED" + "value": "SUCCEEDED", + "name": "SUCCEEDED" }, { - "value": "SUCCEEDED_WITH_ISSUES" + "value": "SUCCEEDED_WITH_ISSUES", + "name": "SUCCEEDED_WITH_ISSUES" }, { - "value": "FAILED" + "value": "FAILED", + "name": "FAILED" } ] } @@ -5951,13 +6044,16 @@ "traits": { "smithy.api#enum": [ { - "value": "PRE_UPGRADE_CHECK" + "value": "PRE_UPGRADE_CHECK", + "name": "PRE_UPGRADE_CHECK" }, { - "value": "SNAPSHOT" + "value": "SNAPSHOT", + "name": "SNAPSHOT" }, { - "value": "UPGRADE" + "value": "UPGRADE", + "name": "UPGRADE" } ] } @@ -6126,13 +6222,16 @@ "smithy.api#documentation": "

The type of EBS volume, standard, gp2, or io1. See Configuring EBS-based Storagefor more information.

", "smithy.api#enum": [ { - "value": "standard" + "value": "standard", + "name": "standard" }, { - "value": "gp2" + "value": "gp2", + "name": "gp2" }, { - "value": "io1" + "value": "io1", + "name": "io1" } ] } diff --git a/codegen/sdk-codegen/aws-models/emr.2009-03-31.json b/codegen/sdk-codegen/aws-models/emr.2009-03-31.json index 5ea879f4ecb..161a3d3f731 100644 --- a/codegen/sdk-codegen/aws-models/emr.2009-03-31.json +++ b/codegen/sdk-codegen/aws-models/emr.2009-03-31.json @@ -3726,13 +3726,16 @@ "traits": { "smithy.api#enum": [ { - "value": "MASTER" + "value": "MASTER", + "name": "MASTER" }, { - "value": "CORE" + "value": "CORE", + "name": "CORE" }, { - "value": "TASK" + "value": "TASK", + "name": "TASK" } ] } @@ -6626,10 +6629,12 @@ "traits": { "smithy.api#enum": [ { - "value": "SWITCH_TO_ON_DEMAND" + "value": "SWITCH_TO_ON_DEMAND", + "name": "SWITCH_TO_ON_DEMAND" }, { - "value": "TERMINATE_CLUSTER" + "value": "TERMINATE_CLUSTER", + "name": "TERMINATE_CLUSTER" } ] } @@ -6792,10 +6797,12 @@ "traits": { "smithy.api#enum": [ { - "value": "SEND_INTERRUPT" + "value": "SEND_INTERRUPT", + "name": "SEND_INTERRUPT" }, { - "value": "TERMINATE_PROCESS" + "value": "TERMINATE_PROCESS", + "name": "TERMINATE_PROCESS" } ] } @@ -6867,25 +6874,32 @@ "traits": { "smithy.api#enum": [ { - "value": "PENDING" + "value": "PENDING", + "name": "PENDING" }, { - "value": "RUNNING" + "value": "RUNNING", + "name": "RUNNING" }, { - "value": "CONTINUE" + "value": "CONTINUE", + "name": "CONTINUE" }, { - "value": "COMPLETED" + "value": "COMPLETED", + "name": "COMPLETED" }, { - "value": "CANCELLED" + "value": "CANCELLED", + "name": "CANCELLED" }, { - "value": "FAILED" + "value": "FAILED", + "name": "FAILED" }, { - "value": "INTERRUPTED" + "value": "INTERRUPTED", + "name": "INTERRUPTED" } ] } @@ -6999,7 +7013,8 @@ "traits": { "smithy.api#enum": [ { - "value": "NONE" + "value": "NONE", + "name": "NONE" } ] } diff --git a/codegen/sdk-codegen/aws-models/firehose.2015-08-04.json b/codegen/sdk-codegen/aws-models/firehose.2015-08-04.json index df7d8a47c37..5da2dfc1e2f 100644 --- a/codegen/sdk-codegen/aws-models/firehose.2015-08-04.json +++ b/codegen/sdk-codegen/aws-models/firehose.2015-08-04.json @@ -735,10 +735,12 @@ "traits": { "smithy.api#enum": [ { - "value": "DirectPut" + "value": "DirectPut", + "name": "DirectPut" }, { - "value": "KinesisStreamAsSource" + "value": "KinesisStreamAsSource", + "name": "KinesisStreamAsSource" } ] } @@ -1227,19 +1229,24 @@ "traits": { "smithy.api#enum": [ { - "value": "NoRotation" + "value": "NoRotation", + "name": "NoRotation" }, { - "value": "OneHour" + "value": "OneHour", + "name": "OneHour" }, { - "value": "OneDay" + "value": "OneDay", + "name": "OneDay" }, { - "value": "OneWeek" + "value": "OneWeek", + "name": "OneWeek" }, { - "value": "OneMonth" + "value": "OneMonth", + "name": "OneMonth" } ] } @@ -1273,10 +1280,12 @@ "traits": { "smithy.api#enum": [ { - "value": "FailedDocumentsOnly" + "value": "FailedDocumentsOnly", + "name": "FailedDocumentsOnly" }, { - "value": "AllDocuments" + "value": "AllDocuments", + "name": "AllDocuments" } ] } @@ -1681,10 +1690,12 @@ "traits": { "smithy.api#enum": [ { - "value": "Raw" + "value": "Raw", + "name": "Raw" }, { - "value": "Event" + "value": "Event", + "name": "Event" } ] } @@ -2089,10 +2100,12 @@ "traits": { "smithy.api#enum": [ { - "value": "FailedDataOnly" + "value": "FailedDataOnly", + "name": "FailedDataOnly" }, { - "value": "AllData" + "value": "AllData", + "name": "AllData" } ] } @@ -2454,7 +2467,8 @@ "traits": { "smithy.api#enum": [ { - "value": "NoEncryption" + "value": "NoEncryption", + "name": "NoEncryption" } ] } @@ -2873,7 +2887,8 @@ "traits": { "smithy.api#enum": [ { - "value": "Lambda" + "value": "Lambda", + "name": "Lambda" } ] } @@ -3350,10 +3365,12 @@ "traits": { "smithy.api#enum": [ { - "value": "Disabled" + "value": "Disabled", + "name": "Disabled" }, { - "value": "Enabled" + "value": "Enabled", + "name": "Enabled" } ] } @@ -3403,10 +3420,12 @@ "traits": { "smithy.api#enum": [ { - "value": "Disabled" + "value": "Disabled", + "name": "Disabled" }, { - "value": "Enabled" + "value": "Enabled", + "name": "Enabled" } ] } @@ -3921,10 +3940,12 @@ "traits": { "smithy.api#enum": [ { - "value": "FailedEventsOnly" + "value": "FailedEventsOnly", + "name": "FailedEventsOnly" }, { - "value": "AllEvents" + "value": "AllEvents", + "name": "AllEvents" } ] } diff --git a/codegen/sdk-codegen/aws-models/gamelift.2015-10-01.json b/codegen/sdk-codegen/aws-models/gamelift.2015-10-01.json index c391376776b..90006ed32ba 100644 --- a/codegen/sdk-codegen/aws-models/gamelift.2015-10-01.json +++ b/codegen/sdk-codegen/aws-models/gamelift.2015-10-01.json @@ -93,10 +93,12 @@ "traits": { "smithy.api#enum": [ { - "value": "ACCEPT" + "value": "ACCEPT", + "name": "ACCEPT" }, { - "value": "REJECT" + "value": "REJECT", + "name": "REJECT" } ] } @@ -4175,250 +4177,332 @@ "traits": { "smithy.api#enum": [ { - "value": "t2.micro" + "value": "t2.micro", + "name": "t2_micro" }, { - "value": "t2.small" + "value": "t2.small", + "name": "t2_small" }, { - "value": "t2.medium" + "value": "t2.medium", + "name": "t2_medium" }, { - "value": "t2.large" + "value": "t2.large", + "name": "t2_large" }, { - "value": "c3.large" + "value": "c3.large", + "name": "c3_large" }, { - "value": "c3.xlarge" + "value": "c3.xlarge", + "name": "c3_xlarge" }, { - "value": "c3.2xlarge" + "value": "c3.2xlarge", + "name": "c3_2xlarge" }, { - "value": "c3.4xlarge" + "value": "c3.4xlarge", + "name": "c3_4xlarge" }, { - "value": "c3.8xlarge" + "value": "c3.8xlarge", + "name": "c3_8xlarge" }, { - "value": "c4.large" + "value": "c4.large", + "name": "c4_large" }, { - "value": "c4.xlarge" + "value": "c4.xlarge", + "name": "c4_xlarge" }, { - "value": "c4.2xlarge" + "value": "c4.2xlarge", + "name": "c4_2xlarge" }, { - "value": "c4.4xlarge" + "value": "c4.4xlarge", + "name": "c4_4xlarge" }, { - "value": "c4.8xlarge" + "value": "c4.8xlarge", + "name": "c4_8xlarge" }, { - "value": "c5.large" + "value": "c5.large", + "name": "c5_large" }, { - "value": "c5.xlarge" + "value": "c5.xlarge", + "name": "c5_xlarge" }, { - "value": "c5.2xlarge" + "value": "c5.2xlarge", + "name": "c5_2xlarge" }, { - "value": "c5.4xlarge" + "value": "c5.4xlarge", + "name": "c5_4xlarge" }, { - "value": "c5.9xlarge" + "value": "c5.9xlarge", + "name": "c5_9xlarge" }, { - "value": "c5.12xlarge" + "value": "c5.12xlarge", + "name": "c5_12xlarge" }, { - "value": "c5.18xlarge" + "value": "c5.18xlarge", + "name": "c5_18xlarge" }, { - "value": "c5.24xlarge" + "value": "c5.24xlarge", + "name": "c5_24xlarge" }, { - "value": "c5a.large" + "value": "c5a.large", + "name": "c5a_large" }, { - "value": "c5a.xlarge" + "value": "c5a.xlarge", + "name": "c5a_xlarge" }, { - "value": "c5a.2xlarge" + "value": "c5a.2xlarge", + "name": "c5a_2xlarge" }, { - "value": "c5a.4xlarge" + "value": "c5a.4xlarge", + "name": "c5a_4xlarge" }, { - "value": "c5a.8xlarge" + "value": "c5a.8xlarge", + "name": "c5a_8xlarge" }, { - "value": "c5a.12xlarge" + "value": "c5a.12xlarge", + "name": "c5a_12xlarge" }, { - "value": "c5a.16xlarge" + "value": "c5a.16xlarge", + "name": "c5a_16xlarge" }, { - "value": "c5a.24xlarge" + "value": "c5a.24xlarge", + "name": "c5a_24xlarge" }, { - "value": "r3.large" + "value": "r3.large", + "name": "r3_large" }, { - "value": "r3.xlarge" + "value": "r3.xlarge", + "name": "r3_xlarge" }, { - "value": "r3.2xlarge" + "value": "r3.2xlarge", + "name": "r3_2xlarge" }, { - "value": "r3.4xlarge" + "value": "r3.4xlarge", + "name": "r3_4xlarge" }, { - "value": "r3.8xlarge" + "value": "r3.8xlarge", + "name": "r3_8xlarge" }, { - "value": "r4.large" + "value": "r4.large", + "name": "r4_large" }, { - "value": "r4.xlarge" + "value": "r4.xlarge", + "name": "r4_xlarge" }, { - "value": "r4.2xlarge" + "value": "r4.2xlarge", + "name": "r4_2xlarge" }, { - "value": "r4.4xlarge" + "value": "r4.4xlarge", + "name": "r4_4xlarge" }, { - "value": "r4.8xlarge" + "value": "r4.8xlarge", + "name": "r4_8xlarge" }, { - "value": "r4.16xlarge" + "value": "r4.16xlarge", + "name": "r4_16xlarge" }, { - "value": "r5.large" + "value": "r5.large", + "name": "r5_large" }, { - "value": "r5.xlarge" + "value": "r5.xlarge", + "name": "r5_xlarge" }, { - "value": "r5.2xlarge" + "value": "r5.2xlarge", + "name": "r5_2xlarge" }, { - "value": "r5.4xlarge" + "value": "r5.4xlarge", + "name": "r5_4xlarge" }, { - "value": "r5.8xlarge" + "value": "r5.8xlarge", + "name": "r5_8xlarge" }, { - "value": "r5.12xlarge" + "value": "r5.12xlarge", + "name": "r5_12xlarge" }, { - "value": "r5.16xlarge" + "value": "r5.16xlarge", + "name": "r5_16xlarge" }, { - "value": "r5.24xlarge" + "value": "r5.24xlarge", + "name": "r5_24xlarge" }, { - "value": "r5a.large" + "value": "r5a.large", + "name": "r5a_large" }, { - "value": "r5a.xlarge" + "value": "r5a.xlarge", + "name": "r5a_xlarge" }, { - "value": "r5a.2xlarge" + "value": "r5a.2xlarge", + "name": "r5a_2xlarge" }, { - "value": "r5a.4xlarge" + "value": "r5a.4xlarge", + "name": "r5a_4xlarge" }, { - "value": "r5a.8xlarge" + "value": "r5a.8xlarge", + "name": "r5a_8xlarge" }, { - "value": "r5a.12xlarge" + "value": "r5a.12xlarge", + "name": "r5a_12xlarge" }, { - "value": "r5a.16xlarge" + "value": "r5a.16xlarge", + "name": "r5a_16xlarge" }, { - "value": "r5a.24xlarge" + "value": "r5a.24xlarge", + "name": "r5a_24xlarge" }, { - "value": "m3.medium" + "value": "m3.medium", + "name": "m3_medium" }, { - "value": "m3.large" + "value": "m3.large", + "name": "m3_large" }, { - "value": "m3.xlarge" + "value": "m3.xlarge", + "name": "m3_xlarge" }, { - "value": "m3.2xlarge" + "value": "m3.2xlarge", + "name": "m3_2xlarge" }, { - "value": "m4.large" + "value": "m4.large", + "name": "m4_large" }, { - "value": "m4.xlarge" + "value": "m4.xlarge", + "name": "m4_xlarge" }, { - "value": "m4.2xlarge" + "value": "m4.2xlarge", + "name": "m4_2xlarge" }, { - "value": "m4.4xlarge" + "value": "m4.4xlarge", + "name": "m4_4xlarge" }, { - "value": "m4.10xlarge" + "value": "m4.10xlarge", + "name": "m4_10xlarge" }, { - "value": "m5.large" + "value": "m5.large", + "name": "m5_large" }, { - "value": "m5.xlarge" + "value": "m5.xlarge", + "name": "m5_xlarge" }, { - "value": "m5.2xlarge" + "value": "m5.2xlarge", + "name": "m5_2xlarge" }, { - "value": "m5.4xlarge" + "value": "m5.4xlarge", + "name": "m5_4xlarge" }, { - "value": "m5.8xlarge" + "value": "m5.8xlarge", + "name": "m5_8xlarge" }, { - "value": "m5.12xlarge" + "value": "m5.12xlarge", + "name": "m5_12xlarge" }, { - "value": "m5.16xlarge" + "value": "m5.16xlarge", + "name": "m5_16xlarge" }, { - "value": "m5.24xlarge" + "value": "m5.24xlarge", + "name": "m5_24xlarge" }, { - "value": "m5a.large" + "value": "m5a.large", + "name": "m5a_large" }, { - "value": "m5a.xlarge" + "value": "m5a.xlarge", + "name": "m5a_xlarge" }, { - "value": "m5a.2xlarge" + "value": "m5a.2xlarge", + "name": "m5a_2xlarge" }, { - "value": "m5a.4xlarge" + "value": "m5a.4xlarge", + "name": "m5a_4xlarge" }, { - "value": "m5a.8xlarge" + "value": "m5a.8xlarge", + "name": "m5a_8xlarge" }, { - "value": "m5a.12xlarge" + "value": "m5a.12xlarge", + "name": "m5a_12xlarge" }, { - "value": "m5a.16xlarge" + "value": "m5a.16xlarge", + "name": "m5a_16xlarge" }, { - "value": "m5a.24xlarge" + "value": "m5a.24xlarge", + "name": "m5a_24xlarge" } ] } @@ -5603,124 +5687,164 @@ "traits": { "smithy.api#enum": [ { - "value": "c4.large" + "value": "c4.large", + "name": "c4_large" }, { - "value": "c4.xlarge" + "value": "c4.xlarge", + "name": "c4_xlarge" }, { - "value": "c4.2xlarge" + "value": "c4.2xlarge", + "name": "c4_2xlarge" }, { - "value": "c4.4xlarge" + "value": "c4.4xlarge", + "name": "c4_4xlarge" }, { - "value": "c4.8xlarge" + "value": "c4.8xlarge", + "name": "c4_8xlarge" }, { - "value": "c5.large" + "value": "c5.large", + "name": "c5_large" }, { - "value": "c5.xlarge" + "value": "c5.xlarge", + "name": "c5_xlarge" }, { - "value": "c5.2xlarge" + "value": "c5.2xlarge", + "name": "c5_2xlarge" }, { - "value": "c5.4xlarge" + "value": "c5.4xlarge", + "name": "c5_4xlarge" }, { - "value": "c5.9xlarge" + "value": "c5.9xlarge", + "name": "c5_9xlarge" }, { - "value": "c5.12xlarge" + "value": "c5.12xlarge", + "name": "c5_12xlarge" }, { - "value": "c5.18xlarge" + "value": "c5.18xlarge", + "name": "c5_18xlarge" }, { - "value": "c5.24xlarge" + "value": "c5.24xlarge", + "name": "c5_24xlarge" }, { - "value": "r4.large" + "value": "r4.large", + "name": "r4_large" }, { - "value": "r4.xlarge" + "value": "r4.xlarge", + "name": "r4_xlarge" }, { - "value": "r4.2xlarge" + "value": "r4.2xlarge", + "name": "r4_2xlarge" }, { - "value": "r4.4xlarge" + "value": "r4.4xlarge", + "name": "r4_4xlarge" }, { - "value": "r4.8xlarge" + "value": "r4.8xlarge", + "name": "r4_8xlarge" }, { - "value": "r4.16xlarge" + "value": "r4.16xlarge", + "name": "r4_16xlarge" }, { - "value": "r5.large" + "value": "r5.large", + "name": "r5_large" }, { - "value": "r5.xlarge" + "value": "r5.xlarge", + "name": "r5_xlarge" }, { - "value": "r5.2xlarge" + "value": "r5.2xlarge", + "name": "r5_2xlarge" }, { - "value": "r5.4xlarge" + "value": "r5.4xlarge", + "name": "r5_4xlarge" }, { - "value": "r5.8xlarge" + "value": "r5.8xlarge", + "name": "r5_8xlarge" }, { - "value": "r5.12xlarge" + "value": "r5.12xlarge", + "name": "r5_12xlarge" }, { - "value": "r5.16xlarge" + "value": "r5.16xlarge", + "name": "r5_16xlarge" }, { - "value": "r5.24xlarge" + "value": "r5.24xlarge", + "name": "r5_24xlarge" }, { - "value": "m4.large" + "value": "m4.large", + "name": "m4_large" }, { - "value": "m4.xlarge" + "value": "m4.xlarge", + "name": "m4_xlarge" }, { - "value": "m4.2xlarge" + "value": "m4.2xlarge", + "name": "m4_2xlarge" }, { - "value": "m4.4xlarge" + "value": "m4.4xlarge", + "name": "m4_4xlarge" }, { - "value": "m4.10xlarge" + "value": "m4.10xlarge", + "name": "m4_10xlarge" }, { - "value": "m5.large" + "value": "m5.large", + "name": "m5_large" }, { - "value": "m5.xlarge" + "value": "m5.xlarge", + "name": "m5_xlarge" }, { - "value": "m5.2xlarge" + "value": "m5.2xlarge", + "name": "m5_2xlarge" }, { - "value": "m5.4xlarge" + "value": "m5.4xlarge", + "name": "m5_4xlarge" }, { - "value": "m5.8xlarge" + "value": "m5.8xlarge", + "name": "m5_8xlarge" }, { - "value": "m5.12xlarge" + "value": "m5.12xlarge", + "name": "m5_12xlarge" }, { - "value": "m5.16xlarge" + "value": "m5.16xlarge", + "name": "m5_16xlarge" }, { - "value": "m5.24xlarge" + "value": "m5.24xlarge", + "name": "m5_24xlarge" } ] } @@ -7616,28 +7740,36 @@ "traits": { "smithy.api#enum": [ { - "value": "CANCELLED" + "value": "CANCELLED", + "name": "CANCELLED" }, { - "value": "COMPLETED" + "value": "COMPLETED", + "name": "COMPLETED" }, { - "value": "FAILED" + "value": "FAILED", + "name": "FAILED" }, { - "value": "PLACING" + "value": "PLACING", + "name": "PLACING" }, { - "value": "QUEUED" + "value": "QUEUED", + "name": "QUEUED" }, { - "value": "REQUIRES_ACCEPTANCE" + "value": "REQUIRES_ACCEPTANCE", + "name": "REQUIRES_ACCEPTANCE" }, { - "value": "SEARCHING" + "value": "SEARCHING", + "name": "SEARCHING" }, { - "value": "TIMED_OUT" + "value": "TIMED_OUT", + "name": "TIMED_OUT" } ] } @@ -7852,37 +7984,48 @@ "traits": { "smithy.api#enum": [ { - "value": "ActivatingGameSessions" + "value": "ActivatingGameSessions", + "name": "ActivatingGameSessions" }, { - "value": "ActiveGameSessions" + "value": "ActiveGameSessions", + "name": "ActiveGameSessions" }, { - "value": "ActiveInstances" + "value": "ActiveInstances", + "name": "ActiveInstances" }, { - "value": "AvailableGameSessions" + "value": "AvailableGameSessions", + "name": "AvailableGameSessions" }, { - "value": "AvailablePlayerSessions" + "value": "AvailablePlayerSessions", + "name": "AvailablePlayerSessions" }, { - "value": "CurrentPlayerSessions" + "value": "CurrentPlayerSessions", + "name": "CurrentPlayerSessions" }, { - "value": "IdleInstances" + "value": "IdleInstances", + "name": "IdleInstances" }, { - "value": "PercentAvailableGameSessions" + "value": "PercentAvailableGameSessions", + "name": "PercentAvailableGameSessions" }, { - "value": "PercentIdleInstances" + "value": "PercentIdleInstances", + "name": "PercentIdleInstances" }, { - "value": "QueueDepth" + "value": "QueueDepth", + "name": "QueueDepth" }, { - "value": "WaitTime" + "value": "WaitTime", + "name": "WaitTime" } ] } diff --git a/codegen/sdk-codegen/aws-models/globalaccelerator.2018-08-08.json b/codegen/sdk-codegen/aws-models/globalaccelerator.2018-08-08.json index 1b9cde52254..8eb442c3d92 100644 --- a/codegen/sdk-codegen/aws-models/globalaccelerator.2018-08-08.json +++ b/codegen/sdk-codegen/aws-models/globalaccelerator.2018-08-08.json @@ -148,10 +148,12 @@ "traits": { "smithy.api#enum": [ { - "value": "DEPLOYED" + "value": "DEPLOYED", + "name": "DEPLOYED" }, { - "value": "IN_PROGRESS" + "value": "IN_PROGRESS", + "name": "IN_PROGRESS" } ] } @@ -527,10 +529,12 @@ "traits": { "smithy.api#enum": [ { - "value": "NONE" + "value": "NONE", + "name": "NONE" }, { - "value": "SOURCE_IP" + "value": "SOURCE_IP", + "name": "SOURCE_IP" } ] } @@ -1145,10 +1149,12 @@ "traits": { "smithy.api#enum": [ { - "value": "DEPLOYED" + "value": "DEPLOYED", + "name": "DEPLOYED" }, { - "value": "IN_PROGRESS" + "value": "IN_PROGRESS", + "name": "IN_PROGRESS" } ] } @@ -2612,13 +2618,16 @@ "traits": { "smithy.api#enum": [ { - "value": "INITIAL" + "value": "INITIAL", + "name": "INITIAL" }, { - "value": "HEALTHY" + "value": "HEALTHY", + "name": "HEALTHY" }, { - "value": "UNHEALTHY" + "value": "UNHEALTHY", + "name": "UNHEALTHY" } ] } @@ -2853,7 +2862,12 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the IP address ranges that were specified in calls to ProvisionByoipCidr, including\n\t\t\tthe current state and a history of state changes.

" + "smithy.api#documentation": "

Lists the IP address ranges that were specified in calls to ProvisionByoipCidr, including\n\t\t\tthe current state and a history of state changes.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } } }, "com.amazonaws.globalaccelerator#ListByoipCidrsRequest": { diff --git a/codegen/sdk-codegen/aws-models/glue.2017-03-31.json b/codegen/sdk-codegen/aws-models/glue.2017-03-31.json index 50a987c28ab..d9a9fb055e6 100644 --- a/codegen/sdk-codegen/aws-models/glue.2017-03-31.json +++ b/codegen/sdk-codegen/aws-models/glue.2017-03-31.json @@ -2251,6 +2251,29 @@ "target": "com.amazonaws.glue#ColumnError" } }, + "com.amazonaws.glue#ColumnImportance": { + "type": "structure", + "members": { + "ColumnName": { + "target": "com.amazonaws.glue#NameString" + }, + "Importance": { + "target": "com.amazonaws.glue#GenericBoundedDouble" + } + } + }, + "com.amazonaws.glue#ColumnImportanceList": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#ColumnImportance" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, "com.amazonaws.glue#ColumnList": { "type": "list", "member": { @@ -7317,6 +7340,9 @@ "traits": { "smithy.api#documentation": "

The confusion matrix shows you what your transform is predicting accurately and what types of errors it is making.

\n\t

For more information, see Confusion matrix in Wikipedia.

" } + }, + "ColumnImportances": { + "target": "com.amazonaws.glue#ColumnImportanceList" } }, "traits": { @@ -19489,13 +19515,16 @@ "traits": { "smithy.api#enum": [ { - "value": "Standard" + "value": "Standard", + "name": "Standard" }, { - "value": "G.1X" + "value": "G.1X", + "name": "G_1X" }, { - "value": "G.2X" + "value": "G.2X", + "name": "G_2X" } ] } diff --git a/codegen/sdk-codegen/aws-models/greengrassv2.2020-11-30.json b/codegen/sdk-codegen/aws-models/greengrassv2.2020-11-30.json new file mode 100644 index 00000000000..6cc8a9b0baa --- /dev/null +++ b/codegen/sdk-codegen/aws-models/greengrassv2.2020-11-30.json @@ -0,0 +1,3676 @@ +{ + "smithy": "1.0", + "metadata": { + "suppressions": [ + { + "id": "HttpMethodSemantics", + "namespace": "*" + }, + { + "id": "HttpResponseCodeSemantics", + "namespace": "*" + }, + { + "id": "PaginatedTrait", + "namespace": "*" + }, + { + "id": "HttpHeaderTrait", + "namespace": "*" + }, + { + "id": "HttpUriConflict", + "namespace": "*" + }, + { + "id": "Service", + "namespace": "*" + } + ] + }, + "shapes": { + "com.amazonaws.greengrassv2#AccessDeniedException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.greengrassv2#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

You don't have permission to perform the action.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.greengrassv2#CancelDeployment": { + "type": "operation", + "input": { + "target": "com.amazonaws.greengrassv2#CancelDeploymentRequest" + }, + "output": { + "target": "com.amazonaws.greengrassv2#CancelDeploymentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.greengrassv2#AccessDeniedException" + }, + { + "target": "com.amazonaws.greengrassv2#ConflictException" + }, + { + "target": "com.amazonaws.greengrassv2#InternalServerException" + }, + { + "target": "com.amazonaws.greengrassv2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.greengrassv2#ThrottlingException" + }, + { + "target": "com.amazonaws.greengrassv2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Cancels a deployment. This operation cancels the deployment for devices that haven't yet\n received it. If a device already received the deployment, this operation doesn't change\n anything for that device.

", + "smithy.api#http": { + "method": "POST", + "uri": "/greengrass/v2/deployments/{deploymentId}/cancel", + "code": 200 + } + } + }, + "com.amazonaws.greengrassv2#CancelDeploymentRequest": { + "type": "structure", + "members": { + "deploymentId": { + "target": "com.amazonaws.greengrassv2#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ID of the deployment.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.greengrassv2#CancelDeploymentResponse": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.greengrassv2#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A message that communicates if the cancel was successful.

" + } + } + } + }, + "com.amazonaws.greengrassv2#CloudComponentState": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "REQUESTED", + "name": "REQUESTED" + }, + { + "value": "INITIATED", + "name": "INITIATED" + }, + { + "value": "DEPLOYABLE", + "name": "DEPLOYABLE" + }, + { + "value": "FAILED", + "name": "FAILED" + }, + { + "value": "DEPRECATED", + "name": "DEPRECATED" + } + ] + } + }, + "com.amazonaws.greengrassv2#CloudComponentStatus": { + "type": "structure", + "members": { + "componentState": { + "target": "com.amazonaws.greengrassv2#CloudComponentState", + "traits": { + "smithy.api#documentation": "

The state of the component.

" + } + }, + "message": { + "target": "com.amazonaws.greengrassv2#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A message that communicates details, such as errors, about the status of the component.

" + } + }, + "errors": { + "target": "com.amazonaws.greengrassv2#StringMap", + "traits": { + "smithy.api#documentation": "

A dictionary of errors that communicate why the component is in an error state. For\n example, if AWS IoT Greengrass can't access an artifact for the component, then errors contains\n the artifact's URI as a key, and the error message as the value for that key.

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

Contains the status of a component in the AWS IoT Greengrass service.

" + } + }, + "com.amazonaws.greengrassv2#Component": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.greengrassv2#ComponentARN", + "traits": { + "smithy.api#documentation": "

The ARN of the component version.

" + } + }, + "componentName": { + "target": "com.amazonaws.greengrassv2#ComponentNameString", + "traits": { + "smithy.api#documentation": "

The name of the component.

" + } + }, + "latestVersion": { + "target": "com.amazonaws.greengrassv2#ComponentLatestVersion", + "traits": { + "smithy.api#documentation": "

The latest version of the component and its details.

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

Contains information about a component.

" + } + }, + "com.amazonaws.greengrassv2#ComponentARN": { + "type": "string", + "traits": { + "smithy.api#pattern": "arn:aws(-cn|-us-gov)?:greengrass:[^:]+:(aws|[0-9]+):components:[^:]+" + } + }, + "com.amazonaws.greengrassv2#ComponentCandidate": { + "type": "structure", + "members": { + "componentName": { + "target": "com.amazonaws.greengrassv2#ComponentNameString", + "traits": { + "smithy.api#documentation": "

The name of the component.

" + } + }, + "componentVersion": { + "target": "com.amazonaws.greengrassv2#ComponentVersionString", + "traits": { + "smithy.api#documentation": "

The version of the component.

" + } + }, + "versionRequirements": { + "target": "com.amazonaws.greengrassv2#ComponentVersionRequirementMap", + "traits": { + "smithy.api#documentation": "

The version requirements for the component's dependencies. AWS IoT Greengrass core devices get the\n version requirements from component recipes.

\n

AWS IoT Greengrass V2 uses semantic version constraints. For more information, see Semantic Versioning.

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

Contains information about a component that is a candidate to deploy to a AWS IoT Greengrass core\n device.

" + } + }, + "com.amazonaws.greengrassv2#ComponentCandidateList": { + "type": "list", + "member": { + "target": "com.amazonaws.greengrassv2#ComponentCandidate" + } + }, + "com.amazonaws.greengrassv2#ComponentConfigurationPath": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.greengrassv2#ComponentConfigurationPathList": { + "type": "list", + "member": { + "target": "com.amazonaws.greengrassv2#ComponentConfigurationPath" + } + }, + "com.amazonaws.greengrassv2#ComponentConfigurationString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 65536 + } + } + }, + "com.amazonaws.greengrassv2#ComponentConfigurationUpdate": { + "type": "structure", + "members": { + "merge": { + "target": "com.amazonaws.greengrassv2#ComponentConfigurationString", + "traits": { + "smithy.api#documentation": "

A serialized JSON string that contains the configuration object to merge to target\n devices. The core device merges this configuration with the component's existing\n configuration. If this is the first time a component deploys on a device, the core device\n merges this configuration with the component's default configuration. This means that the core\n device keeps it's existing configuration for keys and values that you don't specify in this\n object. For more information, see Merge configuration updates in the AWS IoT Greengrass V2 Developer\n Guide.

" + } + }, + "reset": { + "target": "com.amazonaws.greengrassv2#ComponentConfigurationPathList", + "traits": { + "smithy.api#documentation": "

The list of configuration nodes to reset to default values on target devices. Use JSON\n pointers to specify each node to reset. JSON pointers start with a forward slash\n (/) and use forward slashes to separate the key for each level in the object.\n For more information, see the JSON pointer\n specification and Reset configuration updates in the AWS IoT Greengrass V2 Developer\n Guide.

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

Contains information about a deployment's update to a component's configuration on\n Greengrass core devices. For more information, see Update component\n configurations in the AWS IoT Greengrass V2 Developer Guide.

" + } + }, + "com.amazonaws.greengrassv2#ComponentDependencyMap": { + "type": "map", + "key": { + "target": "com.amazonaws.greengrassv2#NonEmptyString" + }, + "value": { + "target": "com.amazonaws.greengrassv2#ComponentDependencyRequirement" + } + }, + "com.amazonaws.greengrassv2#ComponentDependencyRequirement": { + "type": "structure", + "members": { + "versionRequirement": { + "target": "com.amazonaws.greengrassv2#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The component version requirement for the component dependency.

\n

AWS IoT Greengrass V2 uses semantic version constraints. For more information, see Semantic Versioning.

" + } + }, + "dependencyType": { + "target": "com.amazonaws.greengrassv2#ComponentDependencyType", + "traits": { + "smithy.api#documentation": "

The type of this dependency. Choose from the following options:

\n \n

Default: HARD\n

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

Contains information about a component dependency for a Lambda function component.

" + } + }, + "com.amazonaws.greengrassv2#ComponentDependencyType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "HARD", + "name": "HARD" + }, + { + "value": "SOFT", + "name": "SOFT" + } + ] + } + }, + "com.amazonaws.greengrassv2#ComponentDeploymentSpecification": { + "type": "structure", + "members": { + "componentVersion": { + "target": "com.amazonaws.greengrassv2#ComponentVersionString", + "traits": { + "smithy.api#documentation": "

The version of the component.

" + } + }, + "configurationUpdate": { + "target": "com.amazonaws.greengrassv2#ComponentConfigurationUpdate", + "traits": { + "smithy.api#documentation": "

The configuration updates to deploy for the component. You can define\n reset updates and merge updates. A reset updates\n the keys that you specify to the default configuration for the component. A merge updates the\n core device's component configuration with the keys and values that you specify. The AWS IoT Greengrass Core\n software applies reset updates before it applies merge updates. For more information, see\n Update component\n configurations in the AWS IoT Greengrass V2 Developer Guide.

" + } + }, + "runWith": { + "target": "com.amazonaws.greengrassv2#ComponentRunWith", + "traits": { + "smithy.api#documentation": "

The system user and group that the AWS IoT Greengrass Core software uses to run component processes on the\n core device. If you omit this parameter, the AWS IoT Greengrass Core software uses the system user and group\n that you configure for the core device. For more information, see Configure the user and group that run components in the AWS IoT Greengrass V2 Developer\n Guide.

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

Contains information about a component to deploy.

" + } + }, + "com.amazonaws.greengrassv2#ComponentDeploymentSpecifications": { + "type": "map", + "key": { + "target": "com.amazonaws.greengrassv2#NonEmptyString" + }, + "value": { + "target": "com.amazonaws.greengrassv2#ComponentDeploymentSpecification" + } + }, + "com.amazonaws.greengrassv2#ComponentLatestVersion": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.greengrassv2#ComponentVersionARN", + "traits": { + "smithy.api#documentation": "

The ARN of the component version.

" + } + }, + "componentVersion": { + "target": "com.amazonaws.greengrassv2#ComponentVersionString", + "traits": { + "smithy.api#documentation": "

The version of the component.

" + } + }, + "creationTimestamp": { + "target": "com.amazonaws.greengrassv2#Timestamp", + "traits": { + "smithy.api#documentation": "

The time at which the component was created, expressed in ISO 8601 format.

" + } + }, + "description": { + "target": "com.amazonaws.greengrassv2#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The description of the component version.

" + } + }, + "publisher": { + "target": "com.amazonaws.greengrassv2#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The publisher of the component version.

" + } + }, + "platforms": { + "target": "com.amazonaws.greengrassv2#ComponentPlatformList", + "traits": { + "smithy.api#documentation": "

The platforms that the component version supports.

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

Contains information about the latest version of a component.

" + } + }, + "com.amazonaws.greengrassv2#ComponentList": { + "type": "list", + "member": { + "target": "com.amazonaws.greengrassv2#Component" + } + }, + "com.amazonaws.greengrassv2#ComponentNameString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "[a-zA-Z0-9-_.]+" + } + }, + "com.amazonaws.greengrassv2#ComponentPlatform": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.greengrassv2#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The friendly name of the platform. This name helps you identify the platform.

\n

If you omit this parameter, AWS IoT Greengrass creates a friendly name from the os and\n architecture of the platform.

" + } + }, + "attributes": { + "target": "com.amazonaws.greengrassv2#PlatformAttributesMap", + "traits": { + "smithy.api#documentation": "

A dictionary of attributes for the platform. The AWS IoT Greengrass Core software defines the\n os and platform by default. You can specify additional platform\n attributes for a core device when you deploy the AWS IoT Greengrass nucleus component. For more information,\n see the AWS IoT Greengrass nucleus\n component in the AWS IoT Greengrass V2 Developer Guide.

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

Contains information about a platform that a component supports.

" + } + }, + "com.amazonaws.greengrassv2#ComponentPlatformList": { + "type": "list", + "member": { + "target": "com.amazonaws.greengrassv2#ComponentPlatform" + } + }, + "com.amazonaws.greengrassv2#ComponentRunWith": { + "type": "structure", + "members": { + "posixUser": { + "target": "com.amazonaws.greengrassv2#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The POSIX system user and (optional) group to use to run this component. Specify the user\n and group separated by a colon (:) in the following format:\n user:group. The group is optional. If you don't specify a group, the AWS IoT Greengrass Core\n software uses the primary user for the group.

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

Contains information system user and group that the AWS IoT Greengrass Core software uses to run component\n processes on the core device. For more information, see Configure the user and group that run components in the AWS IoT Greengrass V2 Developer\n Guide.

" + } + }, + "com.amazonaws.greengrassv2#ComponentVersionARN": { + "type": "string", + "traits": { + "smithy.api#pattern": "arn:aws(-cn|-us-gov)?:greengrass:[^:]+:(aws|[0-9]+):components:[^:]+:versions:[^:]+" + } + }, + "com.amazonaws.greengrassv2#ComponentVersionList": { + "type": "list", + "member": { + "target": "com.amazonaws.greengrassv2#ComponentVersionListItem" + } + }, + "com.amazonaws.greengrassv2#ComponentVersionListItem": { + "type": "structure", + "members": { + "componentName": { + "target": "com.amazonaws.greengrassv2#ComponentNameString", + "traits": { + "smithy.api#documentation": "

The name of the component.

" + } + }, + "componentVersion": { + "target": "com.amazonaws.greengrassv2#ComponentVersionString", + "traits": { + "smithy.api#documentation": "

The version of the component.

" + } + }, + "arn": { + "target": "com.amazonaws.greengrassv2#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the component version.

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

Contains information about a component version in a list.

" + } + }, + "com.amazonaws.greengrassv2#ComponentVersionRequirementMap": { + "type": "map", + "key": { + "target": "com.amazonaws.greengrassv2#NonEmptyString" + }, + "value": { + "target": "com.amazonaws.greengrassv2#NonEmptyString" + } + }, + "com.amazonaws.greengrassv2#ComponentVersionString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "[0-9a-zA-Z-.+]+" + } + }, + "com.amazonaws.greengrassv2#ComponentVisibilityScope": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PRIVATE", + "name": "PRIVATE" + }, + { + "value": "PUBLIC", + "name": "PUBLIC" + } + ] + } + }, + "com.amazonaws.greengrassv2#ConflictException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.greengrassv2#String", + "traits": { + "smithy.api#required": {} + } + }, + "resourceId": { + "target": "com.amazonaws.greengrassv2#String", + "traits": { + "smithy.api#documentation": "

The ID of the resource that conflicts with the request.

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

The type of the resource that conflicts with the request.

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

Your request has conflicting operations. This can occur if you're trying to perform more\n than one operation on the same resource at the same time.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.greengrassv2#CoreDevice": { + "type": "structure", + "members": { + "coreDeviceThingName": { + "target": "com.amazonaws.greengrassv2#CoreDeviceThingName", + "traits": { + "smithy.api#documentation": "

The name of the core device. This is also the name of the AWS IoT thing.

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

The status of the core device. Core devices can have the following statuses:

\n " + } + }, + "lastStatusUpdateTimestamp": { + "target": "com.amazonaws.greengrassv2#Timestamp", + "traits": { + "smithy.api#documentation": "

The time at which the core device's status last updated, expressed in ISO 8601\n format.

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

Contains information about a AWS IoT Greengrass core device, which is an AWS IoT thing that runs the AWS IoT Greengrass\n Core software.

" + } + }, + "com.amazonaws.greengrassv2#CoreDeviceArchitectureString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.greengrassv2#CoreDevicePlatformString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.greengrassv2#CoreDeviceStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "HEALTHY", + "name": "HEALTHY" + }, + { + "value": "UNHEALTHY", + "name": "UNHEALTHY" + } + ] + } + }, + "com.amazonaws.greengrassv2#CoreDeviceThingName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.greengrassv2#CoreDevicesList": { + "type": "list", + "member": { + "target": "com.amazonaws.greengrassv2#CoreDevice" + } + }, + "com.amazonaws.greengrassv2#CreateComponentVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.greengrassv2#CreateComponentVersionRequest" + }, + "output": { + "target": "com.amazonaws.greengrassv2#CreateComponentVersionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.greengrassv2#AccessDeniedException" + }, + { + "target": "com.amazonaws.greengrassv2#ConflictException" + }, + { + "target": "com.amazonaws.greengrassv2#InternalServerException" + }, + { + "target": "com.amazonaws.greengrassv2#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.greengrassv2#ThrottlingException" + }, + { + "target": "com.amazonaws.greengrassv2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a component. Components are software that run on AWS IoT Greengrass core devices. After you\n develop and test a component on your core device, you can use this operation to upload your\n component to AWS IoT Greengrass. Then, you can deploy the component to other core devices.

\n

You can use this operation to do the following:

\n ", + "smithy.api#http": { + "method": "POST", + "uri": "/greengrass/v2/createComponentVersion", + "code": 201 + } + } + }, + "com.amazonaws.greengrassv2#CreateComponentVersionRequest": { + "type": "structure", + "members": { + "inlineRecipe": { + "target": "com.amazonaws.greengrassv2#RecipeBlob", + "traits": { + "smithy.api#documentation": "

The recipe to use to create the component. The recipe defines the component's metadata,\n parameters, dependencies, lifecycle, artifacts, and platform compatibility.

\n

You must specify either inlineRecipe or lambdaFunction.

" + } + }, + "lambdaFunction": { + "target": "com.amazonaws.greengrassv2#LambdaFunctionRecipeSource", + "traits": { + "smithy.api#documentation": "

The parameters to create a component from a Lambda function.

\n

You must specify either inlineRecipe or lambdaFunction.

" + } + }, + "tags": { + "target": "com.amazonaws.greengrassv2#TagMap", + "traits": { + "smithy.api#documentation": "

A list of key-value pairs that contain metadata for the resource. For more\n information, see Tag your\n resources in the AWS IoT Greengrass V2 Developer Guide.

" + } + } + } + }, + "com.amazonaws.greengrassv2#CreateComponentVersionResponse": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.greengrassv2#ComponentVersionARN", + "traits": { + "smithy.api#documentation": "

The ARN of the component version.

" + } + }, + "componentName": { + "target": "com.amazonaws.greengrassv2#ComponentNameString", + "traits": { + "smithy.api#documentation": "

The name of the component.

", + "smithy.api#required": {} + } + }, + "componentVersion": { + "target": "com.amazonaws.greengrassv2#ComponentVersionString", + "traits": { + "smithy.api#documentation": "

The version of the component.

", + "smithy.api#required": {} + } + }, + "creationTimestamp": { + "target": "com.amazonaws.greengrassv2#Timestamp", + "traits": { + "smithy.api#documentation": "

The time at which the component was created, expressed in ISO 8601 format.

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

The status of the component version in AWS IoT Greengrass V2. This status\n is different from the status of the component on a core device.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.greengrassv2#CreateDeployment": { + "type": "operation", + "input": { + "target": "com.amazonaws.greengrassv2#CreateDeploymentRequest" + }, + "output": { + "target": "com.amazonaws.greengrassv2#CreateDeploymentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.greengrassv2#AccessDeniedException" + }, + { + "target": "com.amazonaws.greengrassv2#InternalServerException" + }, + { + "target": "com.amazonaws.greengrassv2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.greengrassv2#ThrottlingException" + }, + { + "target": "com.amazonaws.greengrassv2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a continuous deployment for a target, which is a AWS IoT Greengrass core device or group of core\n devices. When you add a new core device to a group of core devices that has a deployment, AWS IoT Greengrass\n deploys that group's deployment to the new device.

\n

You can define one deployment for each target. When you create a new deployment for a\n target that has an existing deployment, you replace the previous deployment. AWS IoT Greengrass applies the\n new deployment to the target devices.

\n

Every deployment has a revision number that indicates how many deployment revisions you\n define for a target. Use this operation to create a new revision of an existing deployment.\n This operation returns the revision number of the new deployment when you create it.

\n

For more information, see the Create deployments\n in the AWS IoT Greengrass V2 Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/greengrass/v2/deployments", + "code": 201 + } + } + }, + "com.amazonaws.greengrassv2#CreateDeploymentRequest": { + "type": "structure", + "members": { + "targetArn": { + "target": "com.amazonaws.greengrassv2#TargetARN", + "traits": { + "smithy.api#documentation": "

The ARN of the target AWS IoT thing or thing group.

", + "smithy.api#required": {} + } + }, + "deploymentName": { + "target": "com.amazonaws.greengrassv2#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the deployment.

\n

You can create deployments without names. If you create a deployment without a name, the\n AWS IoT Greengrass V2 console shows the deployment name as :,\n where targetType and targetName are the type and name of the\n deployment target.

" + } + }, + "components": { + "target": "com.amazonaws.greengrassv2#ComponentDeploymentSpecifications", + "traits": { + "smithy.api#documentation": "

The components to deploy. This is a dictionary, where each key is the name of a component,\n and each key's value is the version and configuration to deploy for that component.

" + } + }, + "iotJobConfiguration": { + "target": "com.amazonaws.greengrassv2#DeploymentIoTJobConfiguration", + "traits": { + "smithy.api#documentation": "

The job configuration for the deployment configuration. The job configuration specifies\n the rollout, timeout, and stop configurations for the deployment configuration.

" + } + }, + "deploymentPolicies": { + "target": "com.amazonaws.greengrassv2#DeploymentPolicies", + "traits": { + "smithy.api#documentation": "

The deployment policies for the deployment. These policies define how the deployment\n updates components and handles failure.

" + } + }, + "tags": { + "target": "com.amazonaws.greengrassv2#TagMap", + "traits": { + "smithy.api#documentation": "

A list of key-value pairs that contain metadata for the resource. For more\n information, see Tag your\n resources in the AWS IoT Greengrass V2 Developer Guide.

" + } + } + } + }, + "com.amazonaws.greengrassv2#CreateDeploymentResponse": { + "type": "structure", + "members": { + "deploymentId": { + "target": "com.amazonaws.greengrassv2#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ID of the deployment.

" + } + }, + "iotJobId": { + "target": "com.amazonaws.greengrassv2#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ID of the AWS IoT job that applies the deployment to target devices.

" + } + }, + "iotJobArn": { + "target": "com.amazonaws.greengrassv2#IoTJobARN", + "traits": { + "smithy.api#documentation": "

The ARN of the AWS IoT job that applies the deployment to target devices.

" + } + } + } + }, + "com.amazonaws.greengrassv2#DefaultMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.greengrassv2#DeleteComponent": { + "type": "operation", + "input": { + "target": "com.amazonaws.greengrassv2#DeleteComponentRequest" + }, + "errors": [ + { + "target": "com.amazonaws.greengrassv2#AccessDeniedException" + }, + { + "target": "com.amazonaws.greengrassv2#ConflictException" + }, + { + "target": "com.amazonaws.greengrassv2#InternalServerException" + }, + { + "target": "com.amazonaws.greengrassv2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.greengrassv2#ThrottlingException" + }, + { + "target": "com.amazonaws.greengrassv2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a version of a component from AWS IoT Greengrass.

\n \n

This operation deletes the component's recipe and artifacts. As a result, deployments\n that refer to this component version will fail. If you have deployments that use this\n component version, you can remove the component from the deployment or update the deployment\n to use a valid version.

\n ", + "smithy.api#http": { + "method": "DELETE", + "uri": "/greengrass/v2/components/{arn}", + "code": 204 + } + } + }, + "com.amazonaws.greengrassv2#DeleteComponentRequest": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.greengrassv2#ComponentVersionARN", + "traits": { + "smithy.api#documentation": "

The ARN of the component version.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.greengrassv2#DeleteCoreDevice": { + "type": "operation", + "input": { + "target": "com.amazonaws.greengrassv2#DeleteCoreDeviceRequest" + }, + "errors": [ + { + "target": "com.amazonaws.greengrassv2#AccessDeniedException" + }, + { + "target": "com.amazonaws.greengrassv2#ConflictException" + }, + { + "target": "com.amazonaws.greengrassv2#InternalServerException" + }, + { + "target": "com.amazonaws.greengrassv2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.greengrassv2#ThrottlingException" + }, + { + "target": "com.amazonaws.greengrassv2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a AWS IoT Greengrass core device, which is an AWS IoT thing. This operation removes the core\n device from the list of core devices. This operation doesn't delete the AWS IoT thing. For more\n information about how to delete the AWS IoT thing, see DeleteThing in the\n AWS IoT API Reference.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/greengrass/v2/coreDevices/{coreDeviceThingName}", + "code": 204 + } + } + }, + "com.amazonaws.greengrassv2#DeleteCoreDeviceRequest": { + "type": "structure", + "members": { + "coreDeviceThingName": { + "target": "com.amazonaws.greengrassv2#CoreDeviceThingName", + "traits": { + "smithy.api#documentation": "

The name of the core device. This is also the name of the AWS IoT thing.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.greengrassv2#Deployment": { + "type": "structure", + "members": { + "targetArn": { + "target": "com.amazonaws.greengrassv2#TargetARN", + "traits": { + "smithy.api#documentation": "

The ARN of the target AWS IoT thing or thing group.

" + } + }, + "revisionId": { + "target": "com.amazonaws.greengrassv2#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The revision number of the deployment.

" + } + }, + "deploymentId": { + "target": "com.amazonaws.greengrassv2#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ID of the deployment.

" + } + }, + "deploymentName": { + "target": "com.amazonaws.greengrassv2#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the deployment.

\n

You can create deployments without names. If you create a deployment without a name, the\n AWS IoT Greengrass V2 console shows the deployment name as :,\n where targetType and targetName are the type and name of the\n deployment target.

" + } + }, + "creationTimestamp": { + "target": "com.amazonaws.greengrassv2#Timestamp", + "traits": { + "smithy.api#documentation": "

The time at which the deployment was created, expressed in ISO 8601 format.

" + } + }, + "deploymentStatus": { + "target": "com.amazonaws.greengrassv2#DeploymentStatus", + "traits": { + "smithy.api#documentation": "

The status of the deployment.

" + } + }, + "isLatestForTarget": { + "target": "com.amazonaws.greengrassv2#IsLatestForTarget", + "traits": { + "smithy.api#documentation": "

Whether or not the deployment is the latest revision for its target.

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

Contains information about a deployment.

" + } + }, + "com.amazonaws.greengrassv2#DeploymentComponentUpdatePolicy": { + "type": "structure", + "members": { + "timeoutInSeconds": { + "target": "com.amazonaws.greengrassv2#OptionalInteger", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

The amount of time in seconds that each component on a device has to report that it's safe\n to update. If the component waits for longer than this timeout, then the deployment proceeds\n on the device.

\n

Default: 60\n

" + } + }, + "action": { + "target": "com.amazonaws.greengrassv2#DeploymentComponentUpdatePolicyAction", + "traits": { + "smithy.api#documentation": "

Whether or not to notify components and wait for components to become safe to update.\n Choose from the following options:

\n \n

Default: NOTIFY_COMPONENTS\n

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

Contains information about a deployment's policy that defines when components are safe to\n update.

\n

Each component on a device can report whether or not it's ready to update. After a\n component and its dependencies are ready, they can apply the update in the deployment. You can\n configure whether or not the deployment notifies components of an update and waits for a\n response. You specify the amount of time each component has to respond to the update\n notification.

" + } + }, + "com.amazonaws.greengrassv2#DeploymentComponentUpdatePolicyAction": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "NOTIFY_COMPONENTS", + "name": "NOTIFY_COMPONENTS" + }, + { + "value": "SKIP_NOTIFY_COMPONENTS", + "name": "SKIP_NOTIFY_COMPONENTS" + } + ] + } + }, + "com.amazonaws.greengrassv2#DeploymentConfigurationValidationPolicy": { + "type": "structure", + "members": { + "timeoutInSeconds": { + "target": "com.amazonaws.greengrassv2#OptionalInteger", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

The amount of time in seconds that a component can validate its configuration updates. If\n the validation time exceeds this timeout, then the deployment proceeds for the device.

\n

Default: 30\n

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

Contains information about how long a component on a core device can validate its\n configuration updates before it times out. Components can use the SubscribeToValidateConfigurationUpdates IPC operation to receive notifications when\n a deployment specifies a configuration update. Then, components can respond with the SendConfigurationValidityReport IPC operation. For more information, see the Create deployments in the AWS IoT Greengrass V2 Developer Guide.

" + } + }, + "com.amazonaws.greengrassv2#DeploymentFailureHandlingPolicy": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ROLLBACK", + "name": "ROLLBACK" + }, + { + "value": "DO_NOTHING", + "name": "DO_NOTHING" + } + ] + } + }, + "com.amazonaws.greengrassv2#DeploymentHistoryFilter": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ALL", + "name": "ALL" + }, + { + "value": "LATEST_ONLY", + "name": "LATEST_ONLY" + } + ] + } + }, + "com.amazonaws.greengrassv2#DeploymentID": { + "type": "string" + }, + "com.amazonaws.greengrassv2#DeploymentIoTJobConfiguration": { + "type": "structure", + "members": { + "jobExecutionsRolloutConfig": { + "target": "com.amazonaws.greengrassv2#IoTJobExecutionsRolloutConfig", + "traits": { + "smithy.api#documentation": "

The rollout configuration for the job. This configuration defines the rate at which the\n job rolls out to the fleet of target devices.

" + } + }, + "abortConfig": { + "target": "com.amazonaws.greengrassv2#IoTJobAbortConfig", + "traits": { + "smithy.api#documentation": "

The stop configuration for the job. This configuration defines when and how to stop a job\n rollout.

" + } + }, + "timeoutConfig": { + "target": "com.amazonaws.greengrassv2#IoTJobTimeoutConfig", + "traits": { + "smithy.api#documentation": "

The timeout configuration for the job. This configuration defines the amount of time each\n device has to complete the job.

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

Contains information about an AWS IoT job configuration.

" + } + }, + "com.amazonaws.greengrassv2#DeploymentList": { + "type": "list", + "member": { + "target": "com.amazonaws.greengrassv2#Deployment" + } + }, + "com.amazonaws.greengrassv2#DeploymentName": { + "type": "string" + }, + "com.amazonaws.greengrassv2#DeploymentPolicies": { + "type": "structure", + "members": { + "failureHandlingPolicy": { + "target": "com.amazonaws.greengrassv2#DeploymentFailureHandlingPolicy", + "traits": { + "smithy.api#documentation": "

The failure handling policy for the configuration deployment. This policy defines what to\n do if the deployment fails.

\n

Default: ROLLBACK\n

" + } + }, + "componentUpdatePolicy": { + "target": "com.amazonaws.greengrassv2#DeploymentComponentUpdatePolicy", + "traits": { + "smithy.api#documentation": "

The component update policy for the configuration deployment. This policy defines when\n it's safe to deploy the configuration to devices.

" + } + }, + "configurationValidationPolicy": { + "target": "com.amazonaws.greengrassv2#DeploymentConfigurationValidationPolicy", + "traits": { + "smithy.api#documentation": "

The configuration validation policy for the configuration deployment. This policy defines\n how long each component has to validate its configure updates.

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

Contains information about policies that define how a deployment updates components and\n handles failure.

" + } + }, + "com.amazonaws.greengrassv2#DeploymentStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ACTIVE", + "name": "ACTIVE" + }, + { + "value": "COMPLETED", + "name": "COMPLETED" + }, + { + "value": "CANCELED", + "name": "CANCELED" + }, + { + "value": "FAILED", + "name": "FAILED" + }, + { + "value": "INACTIVE", + "name": "INACTIVE" + } + ] + } + }, + "com.amazonaws.greengrassv2#DescribeComponent": { + "type": "operation", + "input": { + "target": "com.amazonaws.greengrassv2#DescribeComponentRequest" + }, + "output": { + "target": "com.amazonaws.greengrassv2#DescribeComponentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.greengrassv2#AccessDeniedException" + }, + { + "target": "com.amazonaws.greengrassv2#InternalServerException" + }, + { + "target": "com.amazonaws.greengrassv2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.greengrassv2#ThrottlingException" + }, + { + "target": "com.amazonaws.greengrassv2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves metadata for a version of a component.

", + "smithy.api#http": { + "method": "GET", + "uri": "/greengrass/v2/components/{arn}/metadata", + "code": 200 + } + } + }, + "com.amazonaws.greengrassv2#DescribeComponentRequest": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.greengrassv2#ComponentVersionARN", + "traits": { + "smithy.api#documentation": "

The ARN of the component version.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.greengrassv2#DescribeComponentResponse": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.greengrassv2#ComponentVersionARN", + "traits": { + "smithy.api#documentation": "

The ARN of the component version.

" + } + }, + "componentName": { + "target": "com.amazonaws.greengrassv2#ComponentNameString", + "traits": { + "smithy.api#documentation": "

The name of the component.

" + } + }, + "componentVersion": { + "target": "com.amazonaws.greengrassv2#ComponentVersionString", + "traits": { + "smithy.api#documentation": "

The version of the component.

" + } + }, + "creationTimestamp": { + "target": "com.amazonaws.greengrassv2#Timestamp", + "traits": { + "smithy.api#documentation": "

The time at which the component was created, expressed in ISO 8601 format.

" + } + }, + "publisher": { + "target": "com.amazonaws.greengrassv2#PublisherString", + "traits": { + "smithy.api#documentation": "

The publisher of the component version.

" + } + }, + "description": { + "target": "com.amazonaws.greengrassv2#DescriptionString", + "traits": { + "smithy.api#documentation": "

The description of the component version.

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

The status of the component version in AWS IoT Greengrass V2. This status\n is different from the status of the component on a core device.

" + } + }, + "platforms": { + "target": "com.amazonaws.greengrassv2#ComponentPlatformList", + "traits": { + "smithy.api#documentation": "

The platforms that the component version supports.

" + } + }, + "tags": { + "target": "com.amazonaws.greengrassv2#TagMap", + "traits": { + "smithy.api#documentation": "

A list of key-value pairs that contain metadata for the resource. For more\n information, see Tag your\n resources in the AWS IoT Greengrass V2 Developer Guide.

" + } + } + } + }, + "com.amazonaws.greengrassv2#Description": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 500 + } + } + }, + "com.amazonaws.greengrassv2#DescriptionString": { + "type": "string" + }, + "com.amazonaws.greengrassv2#EffectiveDeployment": { + "type": "structure", + "members": { + "deploymentId": { + "target": "com.amazonaws.greengrassv2#DeploymentID", + "traits": { + "smithy.api#documentation": "

The ID of the deployment.

", + "smithy.api#required": {} + } + }, + "deploymentName": { + "target": "com.amazonaws.greengrassv2#DeploymentName", + "traits": { + "smithy.api#documentation": "

The name of the deployment.

\n

You can create deployments without names. If you create a deployment without a name, the\n AWS IoT Greengrass V2 console shows the deployment name as :,\n where targetType and targetName are the type and name of the\n deployment target.

", + "smithy.api#required": {} + } + }, + "iotJobId": { + "target": "com.amazonaws.greengrassv2#IoTJobId", + "traits": { + "smithy.api#documentation": "

The ID of the AWS IoT job that applies the deployment to target devices.

" + } + }, + "iotJobArn": { + "target": "com.amazonaws.greengrassv2#IoTJobARN", + "traits": { + "smithy.api#documentation": "

The ARN of the AWS IoT job that applies the deployment to target devices.

" + } + }, + "description": { + "target": "com.amazonaws.greengrassv2#Description", + "traits": { + "smithy.api#documentation": "

The description of the deployment job.

" + } + }, + "targetArn": { + "target": "com.amazonaws.greengrassv2#TargetARN", + "traits": { + "smithy.api#documentation": "

The ARN of the target AWS IoT thing or thing group.

", + "smithy.api#required": {} + } + }, + "coreDeviceExecutionStatus": { + "target": "com.amazonaws.greengrassv2#EffectiveDeploymentExecutionStatus", + "traits": { + "smithy.api#documentation": "

The status of the deployment job on the AWS IoT Greengrass core device.

", + "smithy.api#required": {} + } + }, + "reason": { + "target": "com.amazonaws.greengrassv2#Reason", + "traits": { + "smithy.api#documentation": "

The reason code for the update, if the job was updated.

" + } + }, + "creationTimestamp": { + "target": "com.amazonaws.greengrassv2#Timestamp", + "traits": { + "smithy.api#documentation": "

The time at which the deployment was created, expressed in ISO 8601 format.

", + "smithy.api#required": {} + } + }, + "modifiedTimestamp": { + "target": "com.amazonaws.greengrassv2#Timestamp", + "traits": { + "smithy.api#documentation": "

The time at which the deployment job was last modified, expressed in ISO 8601\n format.

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

Contains information about a deployment job that AWS IoT Greengrass sends to a AWS IoT Greengrass core device.

" + } + }, + "com.amazonaws.greengrassv2#EffectiveDeploymentExecutionStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "IN_PROGRESS", + "name": "IN_PROGRESS" + }, + { + "value": "QUEUED", + "name": "QUEUED" + }, + { + "value": "FAILED", + "name": "FAILED" + }, + { + "value": "COMPLETED", + "name": "COMPLETED" + }, + { + "value": "TIMED_OUT", + "name": "TIMED_OUT" + }, + { + "value": "CANCELED", + "name": "CANCELED" + }, + { + "value": "REJECTED", + "name": "REJECTED" + } + ] + } + }, + "com.amazonaws.greengrassv2#EffectiveDeploymentsList": { + "type": "list", + "member": { + "target": "com.amazonaws.greengrassv2#EffectiveDeployment" + } + }, + "com.amazonaws.greengrassv2#FileSystemPath": { + "type": "string" + }, + "com.amazonaws.greengrassv2#GGCVersion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.greengrassv2#GenericV2ARN": { + "type": "string", + "traits": { + "smithy.api#pattern": "arn:aws(-cn|-us-gov)?:greengrass:[^:]+:(aws|[0-9]+):(components|deployments|coreDevices):.+" + } + }, + "com.amazonaws.greengrassv2#GetComponent": { + "type": "operation", + "input": { + "target": "com.amazonaws.greengrassv2#GetComponentRequest" + }, + "output": { + "target": "com.amazonaws.greengrassv2#GetComponentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.greengrassv2#AccessDeniedException" + }, + { + "target": "com.amazonaws.greengrassv2#InternalServerException" + }, + { + "target": "com.amazonaws.greengrassv2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.greengrassv2#ThrottlingException" + }, + { + "target": "com.amazonaws.greengrassv2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets the recipe for a version of a component. Core devices can call this operation to\n identify the artifacts and requirements to install a component.

", + "smithy.api#http": { + "method": "GET", + "uri": "/greengrass/v2/components/{arn}", + "code": 200 + } + } + }, + "com.amazonaws.greengrassv2#GetComponentRequest": { + "type": "structure", + "members": { + "recipeOutputFormat": { + "target": "com.amazonaws.greengrassv2#RecipeOutputFormat", + "traits": { + "smithy.api#documentation": "

The format of the recipe.

", + "smithy.api#httpQuery": "recipeOutputFormat" + } + }, + "arn": { + "target": "com.amazonaws.greengrassv2#ComponentVersionARN", + "traits": { + "smithy.api#documentation": "

The ARN of the component version.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.greengrassv2#GetComponentResponse": { + "type": "structure", + "members": { + "recipeOutputFormat": { + "target": "com.amazonaws.greengrassv2#RecipeOutputFormat", + "traits": { + "smithy.api#documentation": "

The format of the recipe.

", + "smithy.api#required": {} + } + }, + "recipe": { + "target": "com.amazonaws.greengrassv2#RecipeBlob", + "traits": { + "smithy.api#documentation": "

The recipe of the component version.

", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.greengrassv2#TagMap", + "traits": { + "smithy.api#documentation": "

A list of key-value pairs that contain metadata for the resource. For more\n information, see Tag your\n resources in the AWS IoT Greengrass V2 Developer Guide.

" + } + } + } + }, + "com.amazonaws.greengrassv2#GetComponentVersionArtifact": { + "type": "operation", + "input": { + "target": "com.amazonaws.greengrassv2#GetComponentVersionArtifactRequest" + }, + "output": { + "target": "com.amazonaws.greengrassv2#GetComponentVersionArtifactResponse" + }, + "errors": [ + { + "target": "com.amazonaws.greengrassv2#AccessDeniedException" + }, + { + "target": "com.amazonaws.greengrassv2#InternalServerException" + }, + { + "target": "com.amazonaws.greengrassv2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.greengrassv2#ThrottlingException" + }, + { + "target": "com.amazonaws.greengrassv2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets the pre-signed URL to a component artifact in an S3 bucket. Core devices can call\n this operation to identify the URL that they can use to download an artifact to\n install.

", + "smithy.api#http": { + "method": "GET", + "uri": "/greengrass/v2/components/{arn}/artifacts/{artifactName+}", + "code": 200 + } + } + }, + "com.amazonaws.greengrassv2#GetComponentVersionArtifactRequest": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.greengrassv2#ComponentVersionARN", + "traits": { + "smithy.api#documentation": "

The ARN of the component version.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "artifactName": { + "target": "com.amazonaws.greengrassv2#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the artifact.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.greengrassv2#GetComponentVersionArtifactResponse": { + "type": "structure", + "members": { + "preSignedUrl": { + "target": "com.amazonaws.greengrassv2#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The URL to the artifact.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.greengrassv2#GetCoreDevice": { + "type": "operation", + "input": { + "target": "com.amazonaws.greengrassv2#GetCoreDeviceRequest" + }, + "output": { + "target": "com.amazonaws.greengrassv2#GetCoreDeviceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.greengrassv2#AccessDeniedException" + }, + { + "target": "com.amazonaws.greengrassv2#InternalServerException" + }, + { + "target": "com.amazonaws.greengrassv2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.greengrassv2#ThrottlingException" + }, + { + "target": "com.amazonaws.greengrassv2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves metadata for a AWS IoT Greengrass core device.

", + "smithy.api#http": { + "method": "GET", + "uri": "/greengrass/v2/coreDevices/{coreDeviceThingName}", + "code": 200 + } + } + }, + "com.amazonaws.greengrassv2#GetCoreDeviceRequest": { + "type": "structure", + "members": { + "coreDeviceThingName": { + "target": "com.amazonaws.greengrassv2#CoreDeviceThingName", + "traits": { + "smithy.api#documentation": "

The name of the core device. This is also the name of the AWS IoT thing.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.greengrassv2#GetCoreDeviceResponse": { + "type": "structure", + "members": { + "coreDeviceThingName": { + "target": "com.amazonaws.greengrassv2#CoreDeviceThingName", + "traits": { + "smithy.api#documentation": "

The name of the core device. This is also the name of the AWS IoT thing.

" + } + }, + "coreVersion": { + "target": "com.amazonaws.greengrassv2#GGCVersion", + "traits": { + "smithy.api#documentation": "

The version of the AWS IoT Greengrass Core software that the core device runs. This version is equivalent to\n the version of the AWS IoT Greengrass nucleus component that runs on the core device. For more information,\n see the AWS IoT Greengrass nucleus\n component in the AWS IoT Greengrass V2 Developer Guide.

" + } + }, + "platform": { + "target": "com.amazonaws.greengrassv2#CoreDevicePlatformString", + "traits": { + "smithy.api#documentation": "

The operating system platform that the core device runs.

" + } + }, + "architecture": { + "target": "com.amazonaws.greengrassv2#CoreDeviceArchitectureString", + "traits": { + "smithy.api#documentation": "

The computer architecture of the core device.

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

The status of the core device. The core device status can be:

\n " + } + }, + "lastStatusUpdateTimestamp": { + "target": "com.amazonaws.greengrassv2#Timestamp", + "traits": { + "smithy.api#documentation": "

The time at which the core device's status last updated, expressed in ISO 8601\n format.

" + } + }, + "tags": { + "target": "com.amazonaws.greengrassv2#TagMap", + "traits": { + "smithy.api#documentation": "

A list of key-value pairs that contain metadata for the resource. For more\n information, see Tag your\n resources in the AWS IoT Greengrass V2 Developer Guide.

" + } + } + } + }, + "com.amazonaws.greengrassv2#GetDeployment": { + "type": "operation", + "input": { + "target": "com.amazonaws.greengrassv2#GetDeploymentRequest" + }, + "output": { + "target": "com.amazonaws.greengrassv2#GetDeploymentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.greengrassv2#AccessDeniedException" + }, + { + "target": "com.amazonaws.greengrassv2#InternalServerException" + }, + { + "target": "com.amazonaws.greengrassv2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.greengrassv2#ThrottlingException" + }, + { + "target": "com.amazonaws.greengrassv2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets a deployment. Deployments define the components that run on AWS IoT Greengrass core devices.

", + "smithy.api#http": { + "method": "GET", + "uri": "/greengrass/v2/deployments/{deploymentId}", + "code": 200 + } + } + }, + "com.amazonaws.greengrassv2#GetDeploymentRequest": { + "type": "structure", + "members": { + "deploymentId": { + "target": "com.amazonaws.greengrassv2#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ID of the deployment.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.greengrassv2#GetDeploymentResponse": { + "type": "structure", + "members": { + "targetArn": { + "target": "com.amazonaws.greengrassv2#TargetARN", + "traits": { + "smithy.api#documentation": "

The ARN of the target AWS IoT thing or thing group.

" + } + }, + "revisionId": { + "target": "com.amazonaws.greengrassv2#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The revision number of the deployment.

" + } + }, + "deploymentId": { + "target": "com.amazonaws.greengrassv2#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ID of the deployment.

" + } + }, + "deploymentName": { + "target": "com.amazonaws.greengrassv2#NullableString", + "traits": { + "smithy.api#documentation": "

The name of the deployment.

\n

You can create deployments without names. If you create a deployment without a name, the\n AWS IoT Greengrass V2 console shows the deployment name as :,\n where targetType and targetName are the type and name of the\n deployment target.

" + } + }, + "deploymentStatus": { + "target": "com.amazonaws.greengrassv2#DeploymentStatus", + "traits": { + "smithy.api#documentation": "

The status of the deployment.

" + } + }, + "iotJobId": { + "target": "com.amazonaws.greengrassv2#NullableString", + "traits": { + "smithy.api#documentation": "

The ID of the AWS IoT job that applies the deployment to target devices.

" + } + }, + "iotJobArn": { + "target": "com.amazonaws.greengrassv2#IoTJobARN", + "traits": { + "smithy.api#documentation": "

The ARN of the AWS IoT job that applies the deployment to target devices.

" + } + }, + "components": { + "target": "com.amazonaws.greengrassv2#ComponentDeploymentSpecifications", + "traits": { + "smithy.api#documentation": "

The components to deploy. This is a dictionary, where each key is the name of a component,\n and each key's value is the version and configuration to deploy for that component.

" + } + }, + "deploymentPolicies": { + "target": "com.amazonaws.greengrassv2#DeploymentPolicies", + "traits": { + "smithy.api#documentation": "

The deployment policies for the deployment. These policies define how the deployment\n updates components and handles failure.

" + } + }, + "iotJobConfiguration": { + "target": "com.amazonaws.greengrassv2#DeploymentIoTJobConfiguration", + "traits": { + "smithy.api#documentation": "

The job configuration for the deployment configuration. The job configuration specifies\n the rollout, timeout, and stop configurations for the deployment configuration.

" + } + }, + "creationTimestamp": { + "target": "com.amazonaws.greengrassv2#Timestamp", + "traits": { + "smithy.api#documentation": "

The time at which the deployment was created, expressed in ISO 8601 format.

" + } + }, + "isLatestForTarget": { + "target": "com.amazonaws.greengrassv2#IsLatestForTarget", + "traits": { + "smithy.api#documentation": "

Whether or not the deployment is the latest revision for its target.

" + } + }, + "tags": { + "target": "com.amazonaws.greengrassv2#TagMap", + "traits": { + "smithy.api#documentation": "

A list of key-value pairs that contain metadata for the resource. For more\n information, see Tag your\n resources in the AWS IoT Greengrass V2 Developer Guide.

" + } + } + } + }, + "com.amazonaws.greengrassv2#GreengrassV2": { + "type": "service", + "version": "2020-11-30", + "operations": [ + { + "target": "com.amazonaws.greengrassv2#CancelDeployment" + }, + { + "target": "com.amazonaws.greengrassv2#CreateComponentVersion" + }, + { + "target": "com.amazonaws.greengrassv2#CreateDeployment" + }, + { + "target": "com.amazonaws.greengrassv2#DeleteComponent" + }, + { + "target": "com.amazonaws.greengrassv2#DeleteCoreDevice" + }, + { + "target": "com.amazonaws.greengrassv2#DescribeComponent" + }, + { + "target": "com.amazonaws.greengrassv2#GetComponent" + }, + { + "target": "com.amazonaws.greengrassv2#GetComponentVersionArtifact" + }, + { + "target": "com.amazonaws.greengrassv2#GetCoreDevice" + }, + { + "target": "com.amazonaws.greengrassv2#GetDeployment" + }, + { + "target": "com.amazonaws.greengrassv2#ListComponents" + }, + { + "target": "com.amazonaws.greengrassv2#ListComponentVersions" + }, + { + "target": "com.amazonaws.greengrassv2#ListCoreDevices" + }, + { + "target": "com.amazonaws.greengrassv2#ListDeployments" + }, + { + "target": "com.amazonaws.greengrassv2#ListEffectiveDeployments" + }, + { + "target": "com.amazonaws.greengrassv2#ListInstalledComponents" + }, + { + "target": "com.amazonaws.greengrassv2#ListTagsForResource" + }, + { + "target": "com.amazonaws.greengrassv2#ResolveComponentCandidates" + }, + { + "target": "com.amazonaws.greengrassv2#TagResource" + }, + { + "target": "com.amazonaws.greengrassv2#UntagResource" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "GreengrassV2", + "arnNamespace": "greengrass", + "cloudFormationName": "GreengrassV2", + "cloudTrailEventSource": "greengrassv2.amazonaws.com", + "endpointPrefix": "greengrass" + }, + "aws.auth#sigv4": { + "name": "greengrass" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "

AWS IoT Greengrass brings local compute, messaging, data management, sync, and ML inference capabilities\n to edge devices. This enables devices to collect and analyze data closer to the source of\n information, react autonomously to local events, and communicate securely with each other on\n local networks. Local devices can also communicate securely with AWS IoT Core and export IoT data\n to the AWS Cloud. AWS IoT Greengrass developers can use AWS Lambda functions and components to create and\n deploy applications to fleets of edge devices for local operation.

\n

AWS IoT Greengrass Version 2 provides a new major version of the AWS IoT Greengrass Core software, new APIs, and a new console.\n Use this API reference to learn how to use the AWS IoT Greengrass V2 API operations to manage components,\n manage deployments, and core devices.

\n

For more information, see What is AWS IoT Greengrass? in\n the AWS IoT Greengrass V2 Developer Guide.

", + "smithy.api#title": "AWS IoT Greengrass V2" + } + }, + "com.amazonaws.greengrassv2#InstalledComponent": { + "type": "structure", + "members": { + "componentName": { + "target": "com.amazonaws.greengrassv2#ComponentNameString", + "traits": { + "smithy.api#documentation": "

The name of the component.

" + } + }, + "componentVersion": { + "target": "com.amazonaws.greengrassv2#ComponentVersionString", + "traits": { + "smithy.api#documentation": "

The version of the component.

" + } + }, + "lifecycleState": { + "target": "com.amazonaws.greengrassv2#InstalledComponentLifecycleState", + "traits": { + "smithy.api#documentation": "

The lifecycle state of the component.

" + } + }, + "lifecycleStateDetails": { + "target": "com.amazonaws.greengrassv2#LifecycleStateDetails", + "traits": { + "smithy.api#documentation": "

The details about the lifecycle state of the component.

" + } + }, + "isRoot": { + "target": "com.amazonaws.greengrassv2#IsRoot", + "traits": { + "smithy.api#documentation": "

Whether or not the component is a root component.

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

Contains information about a component on a AWS IoT Greengrass core device.

" + } + }, + "com.amazonaws.greengrassv2#InstalledComponentLifecycleState": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "NEW", + "name": "NEW" + }, + { + "value": "INSTALLED", + "name": "INSTALLED" + }, + { + "value": "STARTING", + "name": "STARTING" + }, + { + "value": "RUNNING", + "name": "RUNNING" + }, + { + "value": "STOPPING", + "name": "STOPPING" + }, + { + "value": "ERRORED", + "name": "ERRORED" + }, + { + "value": "BROKEN", + "name": "BROKEN" + }, + { + "value": "FINISHED", + "name": "FINISHED" + } + ] + } + }, + "com.amazonaws.greengrassv2#InstalledComponentList": { + "type": "list", + "member": { + "target": "com.amazonaws.greengrassv2#InstalledComponent" + } + }, + "com.amazonaws.greengrassv2#InternalServerException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.greengrassv2#String", + "traits": { + "smithy.api#required": {} + } + }, + "retryAfterSeconds": { + "target": "com.amazonaws.greengrassv2#RetryAfterSeconds", + "traits": { + "smithy.api#documentation": "

The amount of time to wait before you retry the request.

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

AWS IoT Greengrass can't process your request right now. Try again later.

", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.greengrassv2#IoTJobARN": { + "type": "string", + "traits": { + "smithy.api#pattern": "arn:aws(-cn|-us-gov)?:iot:[^:]+:[0-9]+:job/.+" + } + }, + "com.amazonaws.greengrassv2#IoTJobAbortAction": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CANCEL", + "name": "CANCEL" + } + ] + } + }, + "com.amazonaws.greengrassv2#IoTJobAbortConfig": { + "type": "structure", + "members": { + "criteriaList": { + "target": "com.amazonaws.greengrassv2#IoTJobAbortCriteriaList", + "traits": { + "smithy.api#documentation": "

The list of criteria that define when and how to cancel the configuration deployment.

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

Contains a list of criteria that define when and how to cancel a configuration\n deployment.

" + } + }, + "com.amazonaws.greengrassv2#IoTJobAbortCriteria": { + "type": "structure", + "members": { + "failureType": { + "target": "com.amazonaws.greengrassv2#IoTJobExecutionFailureType", + "traits": { + "smithy.api#documentation": "

The type of job deployment failure that can cancel a job.

", + "smithy.api#required": {} + } + }, + "action": { + "target": "com.amazonaws.greengrassv2#IoTJobAbortAction", + "traits": { + "smithy.api#documentation": "

The action to perform when the criteria are met.

", + "smithy.api#required": {} + } + }, + "thresholdPercentage": { + "target": "com.amazonaws.greengrassv2#IoTJobAbortThresholdPercentage", + "traits": { + "smithy.api#documentation": "

The minimum percentage of failureType failures that occur before the job can\n cancel.

\n

This parameter supports up to two digits after the decimal (for example, you can specify\n 10.9 or 10.99, but not 10.999).

", + "smithy.api#required": {} + } + }, + "minNumberOfExecutedThings": { + "target": "com.amazonaws.greengrassv2#IoTJobMinimumNumberOfExecutedThings", + "traits": { + "smithy.api#documentation": "

The minimum number of things that receive the configuration before the job can\n cancel.

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

Contains criteria that define when and how to cancel a job.

\n

The deployment stops if the following conditions are true:

\n
    \n
  1. \n

    The number of things that receive the deployment exceeds the\n minNumberOfExecutedThings.

    \n
    2. \n
  2. \n

    The percentage of failures with type failureType exceeds the\n thresholdPercentage.

    \n
    3. \n
" + } + }, + "com.amazonaws.greengrassv2#IoTJobAbortCriteriaList": { + "type": "list", + "member": { + "target": "com.amazonaws.greengrassv2#IoTJobAbortCriteria" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.greengrassv2#IoTJobAbortThresholdPercentage": { + "type": "double", + "traits": { + "smithy.api#range": { + "max": 100 + } + } + }, + "com.amazonaws.greengrassv2#IoTJobExecutionFailureType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "FAILED", + "name": "FAILED" + }, + { + "value": "REJECTED", + "name": "REJECTED" + }, + { + "value": "TIMED_OUT", + "name": "TIMED_OUT" + }, + { + "value": "ALL", + "name": "ALL" + } + ] + } + }, + "com.amazonaws.greengrassv2#IoTJobExecutionsRolloutConfig": { + "type": "structure", + "members": { + "exponentialRate": { + "target": "com.amazonaws.greengrassv2#IoTJobExponentialRolloutRate", + "traits": { + "smithy.api#documentation": "

The exponential rate to increase the job rollout rate.

" + } + }, + "maximumPerMinute": { + "target": "com.amazonaws.greengrassv2#IoTJobMaxExecutionsPerMin", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

The maximum number of devices that receive a pending job notification, per minute.

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

Contains information about the rollout configuration for a job. This configuration defines\n the rate at which the job deploys a configuration to a fleet of target devices.

" + } + }, + "com.amazonaws.greengrassv2#IoTJobExponentialRolloutRate": { + "type": "structure", + "members": { + "baseRatePerMinute": { + "target": "com.amazonaws.greengrassv2#IoTJobRolloutBaseRatePerMinute", + "traits": { + "smithy.api#documentation": "

The minimum number of devices that receive a pending job notification, per minute, when\n the job starts. This parameter defines the initial rollout rate of the job.

", + "smithy.api#required": {} + } + }, + "incrementFactor": { + "target": "com.amazonaws.greengrassv2#IoTJobRolloutIncrementFactor", + "traits": { + "smithy.api#documentation": "

The exponential factor to increase the rollout rate for the job.

\n

This parameter supports up to one digit after the decimal (for example, you can specify\n 1.5, but not 1.55).

", + "smithy.api#required": {} + } + }, + "rateIncreaseCriteria": { + "target": "com.amazonaws.greengrassv2#IoTJobRateIncreaseCriteria", + "traits": { + "smithy.api#documentation": "

The criteria to increase the rollout rate for the job.

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

Contains information about an exponential rollout rate for a configuration deployment\n job.

" + } + }, + "com.amazonaws.greengrassv2#IoTJobId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.greengrassv2#IoTJobInProgressTimeoutInMinutes": { + "type": "long" + }, + "com.amazonaws.greengrassv2#IoTJobMaxExecutionsPerMin": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.greengrassv2#IoTJobMinimumNumberOfExecutedThings": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.greengrassv2#IoTJobNumberOfThings": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.greengrassv2#IoTJobRateIncreaseCriteria": { + "type": "structure", + "members": { + "numberOfNotifiedThings": { + "target": "com.amazonaws.greengrassv2#IoTJobNumberOfThings", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

The number of devices to receive the job notification before the rollout rate\n increases.

" + } + }, + "numberOfSucceededThings": { + "target": "com.amazonaws.greengrassv2#IoTJobNumberOfThings", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

The number of devices to successfully run the configuration job before the rollout rate\n increases.

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

Contains information about criteria to meet before a job increases its rollout rate.\n Specify either numberOfNotifiedThings or\n numberOfSucceededThings.

" + } + }, + "com.amazonaws.greengrassv2#IoTJobRolloutBaseRatePerMinute": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.greengrassv2#IoTJobRolloutIncrementFactor": { + "type": "double", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.greengrassv2#IoTJobTimeoutConfig": { + "type": "structure", + "members": { + "inProgressTimeoutInMinutes": { + "target": "com.amazonaws.greengrassv2#IoTJobInProgressTimeoutInMinutes", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

The amount of time, in minutes, that devices have to complete the job. The timer starts\n when the job status is set to IN_PROGRESS. If the job status doesn't change to a\n terminal state before the time expires, then the job status is set to\n TIMED_OUT.

\n

The timeout interval must be between 1 minute and 7 days (10080 minutes).

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

Contains information about the timeout configuration for a job.

" + } + }, + "com.amazonaws.greengrassv2#IsLatestForTarget": { + "type": "boolean" + }, + "com.amazonaws.greengrassv2#IsRoot": { + "type": "boolean" + }, + "com.amazonaws.greengrassv2#LambdaContainerParams": { + "type": "structure", + "members": { + "memorySizeInKB": { + "target": "com.amazonaws.greengrassv2#OptionalInteger", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

The memory size of the container, expressed in kilobytes.

\n

Default: 16384 (16 MB)

" + } + }, + "mountROSysfs": { + "target": "com.amazonaws.greengrassv2#OptionalBoolean", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

Whether or not the container can read information from the device's /sys\n folder.

\n

Default: false\n

" + } + }, + "volumes": { + "target": "com.amazonaws.greengrassv2#LambdaVolumeList", + "traits": { + "smithy.api#documentation": "

The list of volumes that the container can access.

" + } + }, + "devices": { + "target": "com.amazonaws.greengrassv2#LambdaDeviceList", + "traits": { + "smithy.api#documentation": "

The list of system devices that the container can access.

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

Contains information about a container in which AWS Lambda functions run on AWS IoT Greengrass core\n devices.

" + } + }, + "com.amazonaws.greengrassv2#LambdaDeviceList": { + "type": "list", + "member": { + "target": "com.amazonaws.greengrassv2#LambdaDeviceMount" + } + }, + "com.amazonaws.greengrassv2#LambdaDeviceMount": { + "type": "structure", + "members": { + "path": { + "target": "com.amazonaws.greengrassv2#FileSystemPath", + "traits": { + "smithy.api#documentation": "

The mount path for the device in the file system.

", + "smithy.api#required": {} + } + }, + "permission": { + "target": "com.amazonaws.greengrassv2#LambdaFilesystemPermission", + "traits": { + "smithy.api#documentation": "

The permission to access the device: read/only (ro) or read/write\n (rw).

\n

Default: ro\n

" + } + }, + "addGroupOwner": { + "target": "com.amazonaws.greengrassv2#OptionalBoolean", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

Whether or not to add the component's system user as an owner of the device.

\n

Default: false\n

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

Contains information about a device that Linux processes in a container can access.

" + } + }, + "com.amazonaws.greengrassv2#LambdaEnvironmentVariables": { + "type": "map", + "key": { + "target": "com.amazonaws.greengrassv2#NonEmptyString" + }, + "value": { + "target": "com.amazonaws.greengrassv2#String" + } + }, + "com.amazonaws.greengrassv2#LambdaEventSource": { + "type": "structure", + "members": { + "topic": { + "target": "com.amazonaws.greengrassv2#TopicString", + "traits": { + "smithy.api#documentation": "

The topic to which to subscribe to receive event messages.

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

The type of event source. Choose from the following options:

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

Contains information about an event source for an AWS Lambda function. The event source\n defines the topics on which this Lambda function subscribes to receive messages that run the\n function.

" + } + }, + "com.amazonaws.greengrassv2#LambdaEventSourceList": { + "type": "list", + "member": { + "target": "com.amazonaws.greengrassv2#LambdaEventSource" + } + }, + "com.amazonaws.greengrassv2#LambdaEventSourceType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PUB_SUB", + "name": "PUB_SUB" + }, + { + "value": "IOT_CORE", + "name": "IOT_CORE" + } + ] + } + }, + "com.amazonaws.greengrassv2#LambdaExecArg": { + "type": "string" + }, + "com.amazonaws.greengrassv2#LambdaExecArgsList": { + "type": "list", + "member": { + "target": "com.amazonaws.greengrassv2#LambdaExecArg" + } + }, + "com.amazonaws.greengrassv2#LambdaExecutionParameters": { + "type": "structure", + "members": { + "eventSources": { + "target": "com.amazonaws.greengrassv2#LambdaEventSourceList", + "traits": { + "smithy.api#documentation": "

The list of event sources to which to subscribe to receive work messages. The Lambda\n function runs when it receives a message from an event source. You can subscribe this function\n to local publish/subscribe messages and AWS IoT Core MQTT messages.

" + } + }, + "maxQueueSize": { + "target": "com.amazonaws.greengrassv2#OptionalInteger", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

The maximum size of the message queue for the Lambda function component. The AWS IoT Greengrass core\n stores messages in a FIFO (first-in-first-out) queue until it can run the Lambda function to\n consume each message.

" + } + }, + "maxInstancesCount": { + "target": "com.amazonaws.greengrassv2#OptionalInteger", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

The maximum number of instances that a non-pinned Lambda function can run at the same\n time.

" + } + }, + "maxIdleTimeInSeconds": { + "target": "com.amazonaws.greengrassv2#OptionalInteger", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

The maximum amount of time in seconds that a non-pinned Lambda function can idle before the\n AWS IoT Greengrass Core software stops its process.

" + } + }, + "timeoutInSeconds": { + "target": "com.amazonaws.greengrassv2#OptionalInteger", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

The maximum amount of time in seconds that the Lambda function can process a work\n item.

" + } + }, + "statusTimeoutInSeconds": { + "target": "com.amazonaws.greengrassv2#OptionalInteger", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

The interval in seconds at which a pinned (also known as long-lived) Lambda function\n component sends status updates to the Lambda manager component.

" + } + }, + "pinned": { + "target": "com.amazonaws.greengrassv2#OptionalBoolean", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

Whether or not the Lambda function is pinned, or long-lived.

\n \n

Default: true\n

" + } + }, + "inputPayloadEncodingType": { + "target": "com.amazonaws.greengrassv2#LambdaInputPayloadEncodingType", + "traits": { + "smithy.api#documentation": "

The encoding type that the Lambda function supports.

\n

Default: json\n

" + } + }, + "execArgs": { + "target": "com.amazonaws.greengrassv2#LambdaExecArgsList", + "traits": { + "smithy.api#documentation": "

The list of arguments to pass to the Lambda function when it runs.

" + } + }, + "environmentVariables": { + "target": "com.amazonaws.greengrassv2#LambdaEnvironmentVariables", + "traits": { + "smithy.api#documentation": "

The map of environment variables that are available to the Lambda function when it runs.

" + } + }, + "linuxProcessParams": { + "target": "com.amazonaws.greengrassv2#LambdaLinuxProcessParams", + "traits": { + "smithy.api#documentation": "

The parameters for the Linux process that contains the Lambda function.

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

Contains parameters for a Lambda function that runs on AWS IoT Greengrass.

" + } + }, + "com.amazonaws.greengrassv2#LambdaFilesystemPermission": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ro", + "name": "RO" + }, + { + "value": "rw", + "name": "RW" + } + ] + } + }, + "com.amazonaws.greengrassv2#LambdaFunctionARNWithVersionNumber": { + "type": "string", + "traits": { + "smithy.api#pattern": "arn:aws(-cn|-us-gov)?:lambda:[^:]+:[0-9]+:function:[a-zA-Z0-9-_]+:[0-9]+" + } + }, + "com.amazonaws.greengrassv2#LambdaFunctionRecipeSource": { + "type": "structure", + "members": { + "lambdaArn": { + "target": "com.amazonaws.greengrassv2#LambdaFunctionARNWithVersionNumber", + "traits": { + "smithy.api#documentation": "

The ARN of the Lambda function. The ARN must include the version of the function to\n import. You can't use version aliases like $LATEST.

", + "smithy.api#required": {} + } + }, + "componentName": { + "target": "com.amazonaws.greengrassv2#ComponentNameString", + "traits": { + "smithy.api#documentation": "

The name of the component.

\n

Defaults to the name of the Lambda function.

" + } + }, + "componentVersion": { + "target": "com.amazonaws.greengrassv2#ComponentVersionString", + "traits": { + "smithy.api#documentation": "

The version of the component.

\n

Defaults to the version of the Lambda function as a semantic version. For example, if your\n function version is 3, the component version becomes 3.0.0.

" + } + }, + "componentPlatforms": { + "target": "com.amazonaws.greengrassv2#ComponentPlatformList", + "traits": { + "smithy.api#documentation": "

The platforms that the component version supports.

" + } + }, + "componentDependencies": { + "target": "com.amazonaws.greengrassv2#ComponentDependencyMap", + "traits": { + "smithy.api#documentation": "

The component versions on which this Lambda function component depends.

" + } + }, + "componentLambdaParameters": { + "target": "com.amazonaws.greengrassv2#LambdaExecutionParameters", + "traits": { + "smithy.api#documentation": "

The system and runtime parameters for the Lambda function as it runs on the AWS IoT Greengrass core\n device.

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

Contains information about an AWS Lambda function to import to create a component.

" + } + }, + "com.amazonaws.greengrassv2#LambdaInputPayloadEncodingType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "json", + "name": "JSON" + }, + { + "value": "binary", + "name": "BINARY" + } + ] + } + }, + "com.amazonaws.greengrassv2#LambdaIsolationMode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "GreengrassContainer", + "name": "GREENGRASS_CONTAINER" + }, + { + "value": "NoContainer", + "name": "NO_CONTAINER" + } + ] + } + }, + "com.amazonaws.greengrassv2#LambdaLinuxProcessParams": { + "type": "structure", + "members": { + "isolationMode": { + "target": "com.amazonaws.greengrassv2#LambdaIsolationMode", + "traits": { + "smithy.api#documentation": "

The isolation mode for the process that contains the Lambda function. The process can run\n in an isolated runtime environment inside the AWS IoT Greengrass container, or as a regular process outside\n any container.

\n

Default: GreengrassContainer\n

" + } + }, + "containerParams": { + "target": "com.amazonaws.greengrassv2#LambdaContainerParams", + "traits": { + "smithy.api#documentation": "

The parameters for the container in which the Lambda function runs.

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

Contains parameters for a Linux process that contains an AWS Lambda function.

" + } + }, + "com.amazonaws.greengrassv2#LambdaVolumeList": { + "type": "list", + "member": { + "target": "com.amazonaws.greengrassv2#LambdaVolumeMount" + } + }, + "com.amazonaws.greengrassv2#LambdaVolumeMount": { + "type": "structure", + "members": { + "sourcePath": { + "target": "com.amazonaws.greengrassv2#FileSystemPath", + "traits": { + "smithy.api#documentation": "

The path to the physical volume in the file system.

", + "smithy.api#required": {} + } + }, + "destinationPath": { + "target": "com.amazonaws.greengrassv2#FileSystemPath", + "traits": { + "smithy.api#documentation": "

The path to the logical volume in the file system.

", + "smithy.api#required": {} + } + }, + "permission": { + "target": "com.amazonaws.greengrassv2#LambdaFilesystemPermission", + "traits": { + "smithy.api#documentation": "

The permission to access the volume: read/only (ro) or read/write\n (rw).

\n

Default: ro\n

" + } + }, + "addGroupOwner": { + "target": "com.amazonaws.greengrassv2#OptionalBoolean", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

Whether or not to add the AWS IoT Greengrass user group as an owner of the volume.

\n

Default: false\n

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

Contains information about a volume that Linux processes in a container can access. When\n you define a volume, the AWS IoT Greengrass Core software mounts the source files to the destination inside the\n container.

" + } + }, + "com.amazonaws.greengrassv2#LifecycleStateDetails": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.greengrassv2#ListComponentVersions": { + "type": "operation", + "input": { + "target": "com.amazonaws.greengrassv2#ListComponentVersionsRequest" + }, + "output": { + "target": "com.amazonaws.greengrassv2#ListComponentVersionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.greengrassv2#AccessDeniedException" + }, + { + "target": "com.amazonaws.greengrassv2#InternalServerException" + }, + { + "target": "com.amazonaws.greengrassv2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.greengrassv2#ThrottlingException" + }, + { + "target": "com.amazonaws.greengrassv2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves a paginated list of all versions for a component.

", + "smithy.api#http": { + "method": "GET", + "uri": "/greengrass/v2/components/{arn}/versions", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.greengrassv2#ListComponentVersionsRequest": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.greengrassv2#ComponentARN", + "traits": { + "smithy.api#documentation": "

The ARN of the component version.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.greengrassv2#DefaultMaxResults", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

The maximum number of results to be returned per paginated request.

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

The token to be used for the next set of paginated results.

", + "smithy.api#httpQuery": "nextToken" + } + } + } + }, + "com.amazonaws.greengrassv2#ListComponentVersionsResponse": { + "type": "structure", + "members": { + "componentVersions": { + "target": "com.amazonaws.greengrassv2#ComponentVersionList", + "traits": { + "smithy.api#documentation": "

A list of versions that exist for the component.

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

The token for the next set of results, or null if there are no additional results.

" + } + } + } + }, + "com.amazonaws.greengrassv2#ListComponents": { + "type": "operation", + "input": { + "target": "com.amazonaws.greengrassv2#ListComponentsRequest" + }, + "output": { + "target": "com.amazonaws.greengrassv2#ListComponentsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.greengrassv2#AccessDeniedException" + }, + { + "target": "com.amazonaws.greengrassv2#InternalServerException" + }, + { + "target": "com.amazonaws.greengrassv2#ThrottlingException" + }, + { + "target": "com.amazonaws.greengrassv2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves a paginated list of component summaries. This list includes components that you\n have permission to view.

", + "smithy.api#http": { + "method": "GET", + "uri": "/greengrass/v2/components", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.greengrassv2#ListComponentsRequest": { + "type": "structure", + "members": { + "scope": { + "target": "com.amazonaws.greengrassv2#ComponentVisibilityScope", + "traits": { + "smithy.api#documentation": "

The scope of the components to list.

\n

Default: PRIVATE\n

", + "smithy.api#httpQuery": "scope" + } + }, + "maxResults": { + "target": "com.amazonaws.greengrassv2#DefaultMaxResults", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

The maximum number of results to be returned per paginated request.

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

The token to be used for the next set of paginated results.

", + "smithy.api#httpQuery": "nextToken" + } + } + } + }, + "com.amazonaws.greengrassv2#ListComponentsResponse": { + "type": "structure", + "members": { + "components": { + "target": "com.amazonaws.greengrassv2#ComponentList", + "traits": { + "smithy.api#documentation": "

A list that summarizes each component.

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

The token for the next set of results, or null if there are no additional results.

" + } + } + } + }, + "com.amazonaws.greengrassv2#ListCoreDevices": { + "type": "operation", + "input": { + "target": "com.amazonaws.greengrassv2#ListCoreDevicesRequest" + }, + "output": { + "target": "com.amazonaws.greengrassv2#ListCoreDevicesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.greengrassv2#AccessDeniedException" + }, + { + "target": "com.amazonaws.greengrassv2#InternalServerException" + }, + { + "target": "com.amazonaws.greengrassv2#ThrottlingException" + }, + { + "target": "com.amazonaws.greengrassv2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves a paginated list of AWS IoT Greengrass core devices.

", + "smithy.api#http": { + "method": "GET", + "uri": "/greengrass/v2/coreDevices", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.greengrassv2#ListCoreDevicesRequest": { + "type": "structure", + "members": { + "thingGroupArn": { + "target": "com.amazonaws.greengrassv2#ThingGroupARN", + "traits": { + "smithy.api#documentation": "

The ARN of the AWS IoT thing group by which to filter. If you specify this parameter, the\n list includes only core devices that are members of this thing group.

", + "smithy.api#httpQuery": "thingGroupArn" + } + }, + "status": { + "target": "com.amazonaws.greengrassv2#CoreDeviceStatus", + "traits": { + "smithy.api#documentation": "

The core device status by which to filter. If you specify this parameter, the list\n includes only core devices that have this status. Choose one of the following options:

\n ", + "smithy.api#httpQuery": "status" + } + }, + "maxResults": { + "target": "com.amazonaws.greengrassv2#DefaultMaxResults", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

The maximum number of results to be returned per paginated request.

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

The token to be used for the next set of paginated results.

", + "smithy.api#httpQuery": "nextToken" + } + } + } + }, + "com.amazonaws.greengrassv2#ListCoreDevicesResponse": { + "type": "structure", + "members": { + "coreDevices": { + "target": "com.amazonaws.greengrassv2#CoreDevicesList", + "traits": { + "smithy.api#documentation": "

A list that summarizes each core device.

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

The token for the next set of results, or null if there are no additional results.

" + } + } + } + }, + "com.amazonaws.greengrassv2#ListDeployments": { + "type": "operation", + "input": { + "target": "com.amazonaws.greengrassv2#ListDeploymentsRequest" + }, + "output": { + "target": "com.amazonaws.greengrassv2#ListDeploymentsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.greengrassv2#AccessDeniedException" + }, + { + "target": "com.amazonaws.greengrassv2#InternalServerException" + }, + { + "target": "com.amazonaws.greengrassv2#ThrottlingException" + }, + { + "target": "com.amazonaws.greengrassv2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves a paginated list of deployments.

", + "smithy.api#http": { + "method": "GET", + "uri": "/greengrass/v2/deployments", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.greengrassv2#ListDeploymentsRequest": { + "type": "structure", + "members": { + "targetArn": { + "target": "com.amazonaws.greengrassv2#TargetARN", + "traits": { + "smithy.api#documentation": "

The ARN of the target AWS IoT thing or thing group.

", + "smithy.api#httpQuery": "targetArn" + } + }, + "historyFilter": { + "target": "com.amazonaws.greengrassv2#DeploymentHistoryFilter", + "traits": { + "smithy.api#documentation": "

The filter for the list of deployments. Choose one of the following options:

\n \n

Default: LATEST_ONLY\n

", + "smithy.api#httpQuery": "historyFilter" + } + }, + "maxResults": { + "target": "com.amazonaws.greengrassv2#DefaultMaxResults", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

The maximum number of results to be returned per paginated request.

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

The token to be used for the next set of paginated results.

", + "smithy.api#httpQuery": "nextToken" + } + } + } + }, + "com.amazonaws.greengrassv2#ListDeploymentsResponse": { + "type": "structure", + "members": { + "deployments": { + "target": "com.amazonaws.greengrassv2#DeploymentList", + "traits": { + "smithy.api#documentation": "

A list that summarizes each deployment.

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

The token for the next set of results, or null if there are no additional results.

" + } + } + } + }, + "com.amazonaws.greengrassv2#ListEffectiveDeployments": { + "type": "operation", + "input": { + "target": "com.amazonaws.greengrassv2#ListEffectiveDeploymentsRequest" + }, + "output": { + "target": "com.amazonaws.greengrassv2#ListEffectiveDeploymentsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.greengrassv2#AccessDeniedException" + }, + { + "target": "com.amazonaws.greengrassv2#InternalServerException" + }, + { + "target": "com.amazonaws.greengrassv2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.greengrassv2#ThrottlingException" + }, + { + "target": "com.amazonaws.greengrassv2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves a paginated list of deployment jobs that AWS IoT Greengrass sends to AWS IoT Greengrass core\n devices.

", + "smithy.api#http": { + "method": "GET", + "uri": "/greengrass/v2/coreDevices/{coreDeviceThingName}/effectiveDeployments", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.greengrassv2#ListEffectiveDeploymentsRequest": { + "type": "structure", + "members": { + "coreDeviceThingName": { + "target": "com.amazonaws.greengrassv2#CoreDeviceThingName", + "traits": { + "smithy.api#documentation": "

The name of the core device. This is also the name of the AWS IoT thing.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.greengrassv2#DefaultMaxResults", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

The maximum number of results to be returned per paginated request.

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

The token to be used for the next set of paginated results.

", + "smithy.api#httpQuery": "nextToken" + } + } + } + }, + "com.amazonaws.greengrassv2#ListEffectiveDeploymentsResponse": { + "type": "structure", + "members": { + "effectiveDeployments": { + "target": "com.amazonaws.greengrassv2#EffectiveDeploymentsList", + "traits": { + "smithy.api#documentation": "

A list that summarizes each deployment on the core device.

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

The token for the next set of results, or null if there are no additional results.

" + } + } + } + }, + "com.amazonaws.greengrassv2#ListInstalledComponents": { + "type": "operation", + "input": { + "target": "com.amazonaws.greengrassv2#ListInstalledComponentsRequest" + }, + "output": { + "target": "com.amazonaws.greengrassv2#ListInstalledComponentsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.greengrassv2#AccessDeniedException" + }, + { + "target": "com.amazonaws.greengrassv2#InternalServerException" + }, + { + "target": "com.amazonaws.greengrassv2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.greengrassv2#ThrottlingException" + }, + { + "target": "com.amazonaws.greengrassv2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves a paginated list of the components that a AWS IoT Greengrass core device runs.

", + "smithy.api#http": { + "method": "GET", + "uri": "/greengrass/v2/coreDevices/{coreDeviceThingName}/installedComponents", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.greengrassv2#ListInstalledComponentsRequest": { + "type": "structure", + "members": { + "coreDeviceThingName": { + "target": "com.amazonaws.greengrassv2#CoreDeviceThingName", + "traits": { + "smithy.api#documentation": "

The name of the core device. This is also the name of the AWS IoT thing.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.greengrassv2#DefaultMaxResults", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

The maximum number of results to be returned per paginated request.

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

The token to be used for the next set of paginated results.

", + "smithy.api#httpQuery": "nextToken" + } + } + } + }, + "com.amazonaws.greengrassv2#ListInstalledComponentsResponse": { + "type": "structure", + "members": { + "installedComponents": { + "target": "com.amazonaws.greengrassv2#InstalledComponentList", + "traits": { + "smithy.api#documentation": "

A list that summarizes each component on the core device.

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

The token for the next set of results, or null if there are no additional results.

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

Retrieves the list of tags for an AWS IoT Greengrass resource.

", + "smithy.api#http": { + "method": "GET", + "uri": "/tags/{resourceArn}", + "code": 200 + } + } + }, + "com.amazonaws.greengrassv2#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.greengrassv2#GenericV2ARN", + "traits": { + "smithy.api#documentation": "

The ARN of the resource.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.greengrassv2#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "tags": { + "target": "com.amazonaws.greengrassv2#TagMap", + "traits": { + "smithy.api#documentation": "

A list of key-value pairs that contain metadata for the resource. For more\n information, see Tag your\n resources in the AWS IoT Greengrass V2 Developer Guide.

" + } + } + } + }, + "com.amazonaws.greengrassv2#NextTokenString": { + "type": "string" + }, + "com.amazonaws.greengrassv2#NonEmptyString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.greengrassv2#NullableString": { + "type": "string" + }, + "com.amazonaws.greengrassv2#OptionalBoolean": { + "type": "boolean" + }, + "com.amazonaws.greengrassv2#OptionalInteger": { + "type": "integer" + }, + "com.amazonaws.greengrassv2#PlatformAttributesMap": { + "type": "map", + "key": { + "target": "com.amazonaws.greengrassv2#NonEmptyString" + }, + "value": { + "target": "com.amazonaws.greengrassv2#NonEmptyString" + } + }, + "com.amazonaws.greengrassv2#PublisherString": { + "type": "string" + }, + "com.amazonaws.greengrassv2#Reason": { + "type": "string" + }, + "com.amazonaws.greengrassv2#RecipeBlob": { + "type": "blob" + }, + "com.amazonaws.greengrassv2#RecipeOutputFormat": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "JSON", + "name": "JSON" + }, + { + "value": "YAML", + "name": "YAML" + } + ] + } + }, + "com.amazonaws.greengrassv2#ResolveComponentCandidates": { + "type": "operation", + "input": { + "target": "com.amazonaws.greengrassv2#ResolveComponentCandidatesRequest" + }, + "output": { + "target": "com.amazonaws.greengrassv2#ResolveComponentCandidatesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.greengrassv2#AccessDeniedException" + }, + { + "target": "com.amazonaws.greengrassv2#ConflictException" + }, + { + "target": "com.amazonaws.greengrassv2#InternalServerException" + }, + { + "target": "com.amazonaws.greengrassv2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.greengrassv2#ThrottlingException" + }, + { + "target": "com.amazonaws.greengrassv2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves a list of components that meet the component, version, and platform requirements\n of a deployment. AWS IoT Greengrass core devices call this operation when they receive a deployment to\n identify the components to install.

\n

This operation identifies components that meet all dependency requirements for a\n deployment. If the requirements conflict, then this operation returns an error and the\n deployment fails. For example, this occurs if component A requires version\n >2.0.0 and component B requires version <2.0.0\n of a component dependency.

\n

When you specify the component candidates to resolve, AWS IoT Greengrass compares each component's\n digest from the core device with the component's digest in the AWS Cloud. If the digests don't\n match, then AWS IoT Greengrass specifies to use the version from the AWS Cloud.

\n \n

To use this operation, you must use the data plane API endpoint and authenticate with an\n AWS IoT device certificate. For more information, see AWS IoT Greengrass endpoints and\n quotas.

\n ", + "smithy.api#http": { + "method": "POST", + "uri": "/greengrass/v2/resolveComponentCandidates", + "code": 200 + } + } + }, + "com.amazonaws.greengrassv2#ResolveComponentCandidatesRequest": { + "type": "structure", + "members": { + "platform": { + "target": "com.amazonaws.greengrassv2#ComponentPlatform", + "traits": { + "smithy.api#documentation": "

The platform to use to resolve compatible components.

", + "smithy.api#required": {} + } + }, + "componentCandidates": { + "target": "com.amazonaws.greengrassv2#ComponentCandidateList", + "traits": { + "smithy.api#documentation": "

The list of components to resolve.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.greengrassv2#ResolveComponentCandidatesResponse": { + "type": "structure", + "members": { + "resolvedComponentVersions": { + "target": "com.amazonaws.greengrassv2#ResolvedComponentVersionsList", + "traits": { + "smithy.api#documentation": "

A list of components that meet the requirements that you specify in the request. This list\n includes each component's recipe that you can use to install the component.

" + } + } + } + }, + "com.amazonaws.greengrassv2#ResolvedComponentVersion": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.greengrassv2#ComponentVersionARN", + "traits": { + "smithy.api#documentation": "

The ARN of the component version.

" + } + }, + "componentName": { + "target": "com.amazonaws.greengrassv2#ComponentNameString", + "traits": { + "smithy.api#documentation": "

The name of the component.

" + } + }, + "componentVersion": { + "target": "com.amazonaws.greengrassv2#ComponentVersionString", + "traits": { + "smithy.api#documentation": "

The version of the component.

" + } + }, + "recipe": { + "target": "com.amazonaws.greengrassv2#RecipeBlob", + "traits": { + "smithy.api#documentation": "

The recipe of the component version.

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

Contains information about a component version that is compatible to run on a AWS IoT Greengrass core\n device.

" + } + }, + "com.amazonaws.greengrassv2#ResolvedComponentVersionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.greengrassv2#ResolvedComponentVersion" + } + }, + "com.amazonaws.greengrassv2#ResourceNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.greengrassv2#String", + "traits": { + "smithy.api#required": {} + } + }, + "resourceId": { + "target": "com.amazonaws.greengrassv2#String", + "traits": { + "smithy.api#documentation": "

The ID of the resource that isn't found.

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

The type of the resource that isn't found.

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

The requested resource can't be found.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.greengrassv2#RetryAfterSeconds": { + "type": "integer" + }, + "com.amazonaws.greengrassv2#ServiceQuotaExceededException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.greengrassv2#String", + "traits": { + "smithy.api#required": {} + } + }, + "resourceId": { + "target": "com.amazonaws.greengrassv2#String", + "traits": { + "smithy.api#documentation": "

The ID of the resource that exceeds the service quota.

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

The type of the resource that exceeds the service quota.

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

The code for the quota in Service Quotas.

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

The code for the service in Service Quotas.

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

Your request exceeds a service quota. For example, you might have the maximum number of\n components that you can create.

", + "smithy.api#error": "client", + "smithy.api#httpError": 402 + } + }, + "com.amazonaws.greengrassv2#String": { + "type": "string" + }, + "com.amazonaws.greengrassv2#StringMap": { + "type": "map", + "key": { + "target": "com.amazonaws.greengrassv2#NonEmptyString" + }, + "value": { + "target": "com.amazonaws.greengrassv2#NonEmptyString" + } + }, + "com.amazonaws.greengrassv2#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$" + } + }, + "com.amazonaws.greengrassv2#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.greengrassv2#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.greengrassv2#TagMap": { + "type": "map", + "key": { + "target": "com.amazonaws.greengrassv2#TagKey" + }, + "value": { + "target": "com.amazonaws.greengrassv2#TagValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.greengrassv2#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.greengrassv2#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.greengrassv2#TagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.greengrassv2#InternalServerException" + }, + { + "target": "com.amazonaws.greengrassv2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.greengrassv2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Adds tags to an AWS IoT Greengrass resource. If a tag already exists for the resource, this operation\n updates the tag's value.

", + "smithy.api#http": { + "method": "POST", + "uri": "/tags/{resourceArn}", + "code": 200 + } + } + }, + "com.amazonaws.greengrassv2#TagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.greengrassv2#GenericV2ARN", + "traits": { + "smithy.api#documentation": "

The ARN of the resource to tag.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.greengrassv2#TagMap", + "traits": { + "smithy.api#documentation": "

A list of key-value pairs that contain metadata for the resource. For more\n information, see Tag your\n resources in the AWS IoT Greengrass V2 Developer Guide.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.greengrassv2#TagResourceResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.greengrassv2#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.greengrassv2#TargetARN": { + "type": "string", + "traits": { + "smithy.api#pattern": "arn:aws(-cn|-us-gov)?:iot:[^:]+:[0-9]+:(thing|thinggroup)/.+" + } + }, + "com.amazonaws.greengrassv2#ThingGroupARN": { + "type": "string", + "traits": { + "smithy.api#pattern": "arn:aws(-cn|-us-gov)?:iot:[^:]+:[0-9]+:thinggroup/.+" + } + }, + "com.amazonaws.greengrassv2#ThrottlingException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.greengrassv2#String", + "traits": { + "smithy.api#required": {} + } + }, + "quotaCode": { + "target": "com.amazonaws.greengrassv2#String", + "traits": { + "smithy.api#documentation": "

The code for the quota in Service Quotas.

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

The code for the service in Service Quotas.

" + } + }, + "retryAfterSeconds": { + "target": "com.amazonaws.greengrassv2#RetryAfterSeconds", + "traits": { + "smithy.api#documentation": "

The amount of time to wait before you retry the request.

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

Your request exceeded a request rate quota. For example, you might have exceeded the\n amount of times that you can retrieve device or deployment status per second.

", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, + "com.amazonaws.greengrassv2#Timestamp": { + "type": "timestamp" + }, + "com.amazonaws.greengrassv2#TopicString": { + "type": "string" + }, + "com.amazonaws.greengrassv2#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.greengrassv2#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.greengrassv2#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.greengrassv2#InternalServerException" + }, + { + "target": "com.amazonaws.greengrassv2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.greengrassv2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes a tag from an AWS IoT Greengrass resource.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/tags/{resourceArn}", + "code": 200 + } + } + }, + "com.amazonaws.greengrassv2#UntagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.greengrassv2#GenericV2ARN", + "traits": { + "smithy.api#documentation": "

The ARN of the resource to untag.

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

A list of keys for tags to remove from the resource.

", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.greengrassv2#UntagResourceResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.greengrassv2#ValidationException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.greengrassv2#String", + "traits": { + "smithy.api#required": {} + } + }, + "reason": { + "target": "com.amazonaws.greengrassv2#ValidationExceptionReason", + "traits": { + "smithy.api#documentation": "

The reason for the validation exception.

" + } + }, + "fields": { + "target": "com.amazonaws.greengrassv2#ValidationExceptionFieldList", + "traits": { + "smithy.api#documentation": "

The list of fields that failed to validate.

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

The request isn't valid. This can occur if your request contains malformed JSON or\n unsupported characters.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.greengrassv2#ValidationExceptionField": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.greengrassv2#String", + "traits": { + "smithy.api#documentation": "

The name of the exception field.

", + "smithy.api#required": {} + } + }, + "message": { + "target": "com.amazonaws.greengrassv2#String", + "traits": { + "smithy.api#documentation": "

The message of the exception field.

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

Contains information about a validation exception field.

" + } + }, + "com.amazonaws.greengrassv2#ValidationExceptionFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.greengrassv2#ValidationExceptionField" + } + }, + "com.amazonaws.greengrassv2#ValidationExceptionReason": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "UNKNOWN_OPERATION", + "name": "UNKNOWN_OPERATION" + }, + { + "value": "CANNOT_PARSE", + "name": "CANNOT_PARSE" + }, + { + "value": "FIELD_VALIDATION_FAILED", + "name": "FIELD_VALIDATION_FAILED" + }, + { + "value": "OTHER", + "name": "OTHER" + } + ] + } + } + } +} diff --git a/codegen/sdk-codegen/aws-models/iam.2010-05-08.json b/codegen/sdk-codegen/aws-models/iam.2010-05-08.json index 3be22f19289..3f3dcb96f61 100644 --- a/codegen/sdk-codegen/aws-models/iam.2010-05-08.json +++ b/codegen/sdk-codegen/aws-models/iam.2010-05-08.json @@ -7974,10 +7974,12 @@ "smithy.api#documentation": "

The policy usage type that indicates whether the policy is used as a permissions policy\n or as the permissions boundary for an entity.

\n

For more information about permissions boundaries, see Permissions Boundaries for IAM\n Identities in the IAM User Guide.

", "smithy.api#enum": [ { - "value": "PermissionsPolicy" + "value": "PermissionsPolicy", + "name": "PermissionsPolicy" }, { - "value": "PermissionsBoundary" + "value": "PermissionsBoundary", + "name": "PermissionsBoundary" } ] } @@ -8443,7 +8445,8 @@ "traits": { "smithy.api#enum": [ { - "value": "text/csv" + "value": "text/csv", + "name": "text_csv" } ] } @@ -11043,13 +11046,16 @@ "traits": { "smithy.api#enum": [ { - "value": "Assigned" + "value": "Assigned", + "name": "Assigned" }, { - "value": "Unassigned" + "value": "Unassigned", + "name": "Unassigned" }, { - "value": "Any" + "value": "Any", + "name": "Any" } ] } @@ -11175,10 +11181,12 @@ "traits": { "smithy.api#enum": [ { - "value": "SSH" + "value": "SSH", + "name": "SSH" }, { - "value": "PEM" + "value": "PEM", + "name": "PEM" } ] } @@ -11331,13 +11339,16 @@ "traits": { "smithy.api#enum": [ { - "value": "IN_PROGRESS" + "value": "IN_PROGRESS", + "name": "IN_PROGRESS" }, { - "value": "COMPLETED" + "value": "COMPLETED", + "name": "COMPLETED" }, { - "value": "FAILED" + "value": "FAILED", + "name": "FAILED" } ] } @@ -11815,10 +11826,12 @@ "traits": { "smithy.api#enum": [ { - "value": "Active" + "value": "Active", + "name": "Active" }, { - "value": "Inactive" + "value": "Inactive", + "name": "Inactive" } ] } @@ -11831,82 +11844,108 @@ "traits": { "smithy.api#enum": [ { - "value": "Users" + "value": "Users", + "name": "Users" }, { - "value": "UsersQuota" + "value": "UsersQuota", + "name": "UsersQuota" }, { - "value": "Groups" + "value": "Groups", + "name": "Groups" }, { - "value": "GroupsQuota" + "value": "GroupsQuota", + "name": "GroupsQuota" }, { - "value": "ServerCertificates" + "value": "ServerCertificates", + "name": "ServerCertificates" }, { - "value": "ServerCertificatesQuota" + "value": "ServerCertificatesQuota", + "name": "ServerCertificatesQuota" }, { - "value": "UserPolicySizeQuota" + "value": "UserPolicySizeQuota", + "name": "UserPolicySizeQuota" }, { - "value": "GroupPolicySizeQuota" + "value": "GroupPolicySizeQuota", + "name": "GroupPolicySizeQuota" }, { - "value": "GroupsPerUserQuota" + "value": "GroupsPerUserQuota", + "name": "GroupsPerUserQuota" }, { - "value": "SigningCertificatesPerUserQuota" + "value": "SigningCertificatesPerUserQuota", + "name": "SigningCertificatesPerUserQuota" }, { - "value": "AccessKeysPerUserQuota" + "value": "AccessKeysPerUserQuota", + "name": "AccessKeysPerUserQuota" }, { - "value": "MFADevices" + "value": "MFADevices", + "name": "MFADevices" }, { - "value": "MFADevicesInUse" + "value": "MFADevicesInUse", + "name": "MFADevicesInUse" }, { - "value": "AccountMFAEnabled" + "value": "AccountMFAEnabled", + "name": "AccountMFAEnabled" }, { - "value": "AccountAccessKeysPresent" + "value": "AccountAccessKeysPresent", + "name": "AccountAccessKeysPresent" }, { - "value": "AccountSigningCertificatesPresent" + "value": "AccountSigningCertificatesPresent", + "name": "AccountSigningCertificatesPresent" }, { - "value": "AttachedPoliciesPerGroupQuota" + "value": "AttachedPoliciesPerGroupQuota", + "name": "AttachedPoliciesPerGroupQuota" }, { - "value": "AttachedPoliciesPerRoleQuota" + "value": "AttachedPoliciesPerRoleQuota", + "name": "AttachedPoliciesPerRoleQuota" }, { - "value": "AttachedPoliciesPerUserQuota" + "value": "AttachedPoliciesPerUserQuota", + "name": "AttachedPoliciesPerUserQuota" }, { - "value": "Policies" + "value": "Policies", + "name": "Policies" }, { - "value": "PoliciesQuota" + "value": "PoliciesQuota", + "name": "PoliciesQuota" }, { - "value": "PolicySizeQuota" + "value": "PolicySizeQuota", + "name": "PolicySizeQuota" }, { - "value": "PolicyVersionsInUse" + "value": "PolicyVersionsInUse", + "name": "PolicyVersionsInUse" }, { - "value": "PolicyVersionsInUseQuota" + "value": "PolicyVersionsInUseQuota", + "name": "PolicyVersionsInUseQuota" }, { - "value": "VersionsPerPolicyQuota" + "value": "VersionsPerPolicyQuota", + "name": "VersionsPerPolicyQuota" }, { - "value": "GlobalEndpointTokenVersion" + "value": "GlobalEndpointTokenVersion", + "name": "GlobalEndpointTokenVersion" } ] } diff --git a/codegen/sdk-codegen/aws-models/imagebuilder.2019-12-02.json b/codegen/sdk-codegen/aws-models/imagebuilder.2019-12-02.json index 28019b4468f..baf9920243c 100644 --- a/codegen/sdk-codegen/aws-models/imagebuilder.2019-12-02.json +++ b/codegen/sdk-codegen/aws-models/imagebuilder.2019-12-02.json @@ -151,6 +151,9 @@ "com.amazonaws.imagebuilder#Arn": { "type": "string" }, + "com.amazonaws.imagebuilder#Boolean": { + "type": "boolean" + }, "com.amazonaws.imagebuilder#CallRateLimitExceededException": { "type": "structure", "members": { @@ -585,6 +588,253 @@ "target": "com.amazonaws.imagebuilder#ComponentVersion" } }, + "com.amazonaws.imagebuilder#Container": { + "type": "structure", + "members": { + "region": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Containers and container images are Region-specific. This is the Region context for the container.

" + } + }, + "imageUris": { + "target": "com.amazonaws.imagebuilder#StringList", + "traits": { + "smithy.api#documentation": "

A list of URIs for containers created in the context Region.

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

A container encapsulates the runtime environment for an application.

" + } + }, + "com.amazonaws.imagebuilder#ContainerDistributionConfiguration": { + "type": "structure", + "members": { + "description": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The description of the container distribution configuration.

" + } + }, + "containerTags": { + "target": "com.amazonaws.imagebuilder#StringList", + "traits": { + "smithy.api#documentation": "

Tags that are attached to the container distribution configuration.

" + } + }, + "targetRepository": { + "target": "com.amazonaws.imagebuilder#TargetContainerRepository", + "traits": { + "smithy.api#documentation": "

The destination repository for the container distribution configuration.

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

Container distribution settings for encryption, licensing, and sharing in a specific Region.

" + } + }, + "com.amazonaws.imagebuilder#ContainerList": { + "type": "list", + "member": { + "target": "com.amazonaws.imagebuilder#Container" + } + }, + "com.amazonaws.imagebuilder#ContainerRecipe": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.imagebuilder#ImageBuilderArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the container recipe.

" + } + }, + "containerType": { + "target": "com.amazonaws.imagebuilder#ContainerType", + "traits": { + "smithy.api#documentation": "

Specifies the type of container, such as Docker.

" + } + }, + "name": { + "target": "com.amazonaws.imagebuilder#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the container recipe.

" + } + }, + "description": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The description of the container recipe.

" + } + }, + "platform": { + "target": "com.amazonaws.imagebuilder#Platform", + "traits": { + "smithy.api#documentation": "

The system platform for the container, such as Windows or Linux.

" + } + }, + "owner": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The owner of the container recipe.

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

The semantic version of the container recipe (<major>.<minor>.<patch>).

" + } + }, + "components": { + "target": "com.amazonaws.imagebuilder#ComponentConfigurationList", + "traits": { + "smithy.api#documentation": "

Components for build and test that are included in the container recipe.

" + } + }, + "dockerfileTemplateData": { + "target": "com.amazonaws.imagebuilder#DockerFileTemplate", + "traits": { + "smithy.api#documentation": "

Dockerfiles are text documents that are used to build Docker containers, and ensure that they contain all of the elements required by the application running inside. The template data consists of contextual variables where Image Builder places build information or scripts, based on your container image recipe.

" + } + }, + "kmsKeyId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Identifies which KMS key is used to encrypt the container image for distribution to the target Region.

" + } + }, + "encrypted": { + "target": "com.amazonaws.imagebuilder#NullableBoolean", + "traits": { + "smithy.api#documentation": "

A flag that indicates if the target container is encrypted.

" + } + }, + "parentImage": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The source image for the container recipe.

" + } + }, + "dateCreated": { + "target": "com.amazonaws.imagebuilder#DateTime", + "traits": { + "smithy.api#documentation": "

The date when this container recipe was created.

" + } + }, + "tags": { + "target": "com.amazonaws.imagebuilder#TagMap", + "traits": { + "smithy.api#documentation": "

Tags that are attached to the container recipe.

" + } + }, + "workingDirectory": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The working directory for use during build and test workflows.

" + } + }, + "targetRepository": { + "target": "com.amazonaws.imagebuilder#TargetContainerRepository", + "traits": { + "smithy.api#documentation": "

The destination repository for the container image.

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

A container recipe.

" + } + }, + "com.amazonaws.imagebuilder#ContainerRecipeArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws[^:]*:imagebuilder:[^:]+:(?:\\d{12}|aws):container-recipe/[a-z0-9-_]+/\\d+\\.\\d+\\.\\d+$" + } + }, + "com.amazonaws.imagebuilder#ContainerRecipeSummary": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.imagebuilder#ImageBuilderArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the container recipe.

" + } + }, + "containerType": { + "target": "com.amazonaws.imagebuilder#ContainerType", + "traits": { + "smithy.api#documentation": "

Specifies the type of container, such as \"Docker\".

" + } + }, + "name": { + "target": "com.amazonaws.imagebuilder#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the container recipe.

" + } + }, + "platform": { + "target": "com.amazonaws.imagebuilder#Platform", + "traits": { + "smithy.api#documentation": "

The system platform for the container, such as Windows or Linux.

" + } + }, + "owner": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The owner of the container recipe.

" + } + }, + "parentImage": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The source image for the container recipe.

" + } + }, + "dateCreated": { + "target": "com.amazonaws.imagebuilder#DateTime", + "traits": { + "smithy.api#documentation": "

The date when this container recipe was created.

" + } + }, + "tags": { + "target": "com.amazonaws.imagebuilder#TagMap", + "traits": { + "smithy.api#documentation": "

Tags that are attached to the container recipe.

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

A summary of a container recipe

" + } + }, + "com.amazonaws.imagebuilder#ContainerRecipeSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.imagebuilder#ContainerRecipeSummary" + } + }, + "com.amazonaws.imagebuilder#ContainerRepositoryService": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ECR", + "name": "ECR" + } + ] + } + }, + "com.amazonaws.imagebuilder#ContainerType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "DOCKER", + "name": "DOCKER" + } + ] + } + }, "com.amazonaws.imagebuilder#CreateComponent": { "type": "operation", "input": { @@ -643,77 +893,256 @@ "name": { "target": "com.amazonaws.imagebuilder#ResourceName", "traits": { - "smithy.api#documentation": "

The name of the component.

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

The name of the component.

", + "smithy.api#required": {} + } + }, + "semanticVersion": { + "target": "com.amazonaws.imagebuilder#VersionNumber", + "traits": { + "smithy.api#documentation": "

The semantic version of the component. This version follows the semantic version syntax. For example, major.minor.patch. This could be versioned like software (2.0.1) or like a date (2019.12.01).

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The description of the component. Describes the contents of the component.

" + } + }, + "changeDescription": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The change description of the component. Describes what change has been made in this version, or what makes this version different from other versions of this component.

" + } + }, + "platform": { + "target": "com.amazonaws.imagebuilder#Platform", + "traits": { + "smithy.api#documentation": "

The platform of the component.

", + "smithy.api#required": {} + } + }, + "supportedOsVersions": { + "target": "com.amazonaws.imagebuilder#OsVersionList", + "traits": { + "smithy.api#documentation": "

The operating system (OS) version supported by the component. If the OS information is available, a prefix match is performed against the parent image OS version during image recipe creation.

" + } + }, + "data": { + "target": "com.amazonaws.imagebuilder#InlineComponentData", + "traits": { + "smithy.api#documentation": "

The data of the component. Used to specify the data inline. Either data or uri can be used to specify the data within the component.

" + } + }, + "uri": { + "target": "com.amazonaws.imagebuilder#Uri", + "traits": { + "smithy.api#documentation": "

The uri of the component. Must be an S3 URL and the requester must have permission to access the S3 bucket. If you use S3, you can specify component content up to your service quota. Either data or uri can be used to specify the data within the component.

" + } + }, + "kmsKeyId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ID of the KMS key that should be used to encrypt this component.

" + } + }, + "tags": { + "target": "com.amazonaws.imagebuilder#TagMap", + "traits": { + "smithy.api#documentation": "

The tags of the component.

" + } + }, + "clientToken": { + "target": "com.amazonaws.imagebuilder#ClientToken", + "traits": { + "smithy.api#documentation": "

The idempotency token of the component.

", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.imagebuilder#CreateComponentResponse": { + "type": "structure", + "members": { + "requestId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" + } + }, + "clientToken": { + "target": "com.amazonaws.imagebuilder#ClientToken", + "traits": { + "smithy.api#documentation": "

The idempotency token used to make this request idempotent.

" + } + }, + "componentBuildVersionArn": { + "target": "com.amazonaws.imagebuilder#ComponentBuildVersionArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the component that was created by this request.

" + } + } + } + }, + "com.amazonaws.imagebuilder#CreateContainerRecipe": { + "type": "operation", + "input": { + "target": "com.amazonaws.imagebuilder#CreateContainerRecipeRequest" + }, + "output": { + "target": "com.amazonaws.imagebuilder#CreateContainerRecipeResponse" + }, + "errors": [ + { + "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" + }, + { + "target": "com.amazonaws.imagebuilder#ClientException" + }, + { + "target": "com.amazonaws.imagebuilder#ForbiddenException" + }, + { + "target": "com.amazonaws.imagebuilder#IdempotentParameterMismatchException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidRequestException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidVersionNumberException" + }, + { + "target": "com.amazonaws.imagebuilder#ResourceAlreadyExistsException" + }, + { + "target": "com.amazonaws.imagebuilder#ResourceInUseException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new container recipe. Container recipes define how images are configured, tested, and assessed.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/CreateContainerRecipe", + "code": 200 + } + } + }, + "com.amazonaws.imagebuilder#CreateContainerRecipeRequest": { + "type": "structure", + "members": { + "containerType": { + "target": "com.amazonaws.imagebuilder#ContainerType", + "traits": { + "smithy.api#documentation": "

The type of container to create.

", "smithy.api#required": {} } }, - "semanticVersion": { - "target": "com.amazonaws.imagebuilder#VersionNumber", + "name": { + "target": "com.amazonaws.imagebuilder#ResourceName", "traits": { - "smithy.api#documentation": "

The semantic version of the component. This version follows the semantic version syntax. For example, major.minor.patch. This could be versioned like software (2.0.1) or like a date (2019.12.01).

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

The name of the container recipe.

", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { - "smithy.api#documentation": "

The description of the component. Describes the contents of the component.

" + "smithy.api#documentation": "

The description of the container recipe.

" } }, - "changeDescription": { - "target": "com.amazonaws.imagebuilder#NonEmptyString", + "semanticVersion": { + "target": "com.amazonaws.imagebuilder#VersionNumber", "traits": { - "smithy.api#documentation": "

The change description of the component. Describes what change has been made in this version, or what makes this version different from other versions of this component.

" + "smithy.api#documentation": "

The semantic version of the container recipe (<major>.<minor>.<patch>).

", + "smithy.api#required": {} } }, - "platform": { - "target": "com.amazonaws.imagebuilder#Platform", + "components": { + "target": "com.amazonaws.imagebuilder#ComponentConfigurationList", "traits": { - "smithy.api#documentation": "

The platform of the component.

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

Components for build and test that are included in the container recipe.

", "smithy.api#required": {} } }, - "supportedOsVersions": { - "target": "com.amazonaws.imagebuilder#OsVersionList", + "dockerfileTemplateData": { + "target": "com.amazonaws.imagebuilder#InlineDockerFileTemplate", "traits": { - "smithy.api#documentation": "

The operating system (OS) version supported by the component. If the OS information is available, a prefix match is performed against the parent image OS version during image recipe creation.

" + "smithy.api#documentation": "

The Dockerfile template used to build your image as an inline data blob.

", + "smithy.api#required": {} } }, - "data": { - "target": "com.amazonaws.imagebuilder#InlineComponentData", + "dockerfileTemplateUri": { + "target": "com.amazonaws.imagebuilder#Uri", "traits": { - "smithy.api#documentation": "

The data of the component. Used to specify the data inline. Either data or uri can be used to specify the data within the component.

" + "smithy.api#documentation": "

The S3 URI for the Dockerfile that will be used to build your container image.

" } }, - "uri": { - "target": "com.amazonaws.imagebuilder#Uri", + "platformOverride": { + "target": "com.amazonaws.imagebuilder#Platform", "traits": { - "smithy.api#documentation": "

The uri of the component. Must be an S3 URL and the requester must have permission to access the S3 bucket. If you use S3, you can specify component content up to your service quota. Either data or uri can be used to specify the data within the component.

" + "smithy.api#documentation": "

Specifies the operating system platform when you use a custom source image.

" } }, - "kmsKeyId": { + "imageOsVersionOverride": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { - "smithy.api#documentation": "

The ID of the KMS key that should be used to encrypt this component.

" + "smithy.api#documentation": "

Specifies the operating system version for the source image.

" + } + }, + "parentImage": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The source image for the container recipe.

", + "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.imagebuilder#TagMap", "traits": { - "smithy.api#documentation": "

The tags of the component.

" + "smithy.api#documentation": "

Tags that are attached to the container recipe.

" + } + }, + "workingDirectory": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The working directory for use during build and test workflows.

" + } + }, + "targetRepository": { + "target": "com.amazonaws.imagebuilder#TargetContainerRepository", + "traits": { + "smithy.api#documentation": "

The destination repository for the container image.

", + "smithy.api#required": {} + } + }, + "kmsKeyId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Identifies which KMS key is used to encrypt the container image.

" } }, "clientToken": { "target": "com.amazonaws.imagebuilder#ClientToken", "traits": { - "smithy.api#documentation": "

The idempotency token of the component.

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

The client token used to make this request idempotent.

", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } } } }, - "com.amazonaws.imagebuilder#CreateComponentResponse": { + "com.amazonaws.imagebuilder#CreateContainerRecipeResponse": { "type": "structure", "members": { "requestId": { @@ -725,13 +1154,13 @@ "clientToken": { "target": "com.amazonaws.imagebuilder#ClientToken", "traits": { - "smithy.api#documentation": "

The idempotency token used to make this request idempotent.

" + "smithy.api#documentation": "

The client token used to make this request idempotent.

" } }, - "componentBuildVersionArn": { - "target": "com.amazonaws.imagebuilder#ComponentBuildVersionArn", + "containerRecipeArn": { + "target": "com.amazonaws.imagebuilder#ContainerRecipeArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the component that was created by this request.

" + "smithy.api#documentation": "

Returns the Amazon Resource Name (ARN) of the container recipe that the request created.

" } } } @@ -964,8 +1393,13 @@ "imageRecipeArn": { "target": "com.amazonaws.imagebuilder#ImageRecipeArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image recipe that will be used to configure images created by this image pipeline.

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

The Amazon Resource Name (ARN) of the image recipe that will be used to configure images created by this image pipeline.

" + } + }, + "containerRecipeArn": { + "target": "com.amazonaws.imagebuilder#ContainerRecipeArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the container recipe that is used to configure images created by this container pipeline.

" } }, "infrastructureConfigurationArn": { @@ -1190,8 +1624,13 @@ "imageRecipeArn": { "target": "com.amazonaws.imagebuilder#ImageRecipeArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.

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

The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.

" + } + }, + "containerRecipeArn": { + "target": "com.amazonaws.imagebuilder#ContainerRecipeArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested.

" } }, "distributionConfigurationArn": { @@ -1490,6 +1929,76 @@ } } }, + "com.amazonaws.imagebuilder#DeleteContainerRecipe": { + "type": "operation", + "input": { + "target": "com.amazonaws.imagebuilder#DeleteContainerRecipeRequest" + }, + "output": { + "target": "com.amazonaws.imagebuilder#DeleteContainerRecipeResponse" + }, + "errors": [ + { + "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" + }, + { + "target": "com.amazonaws.imagebuilder#ClientException" + }, + { + "target": "com.amazonaws.imagebuilder#ForbiddenException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidRequestException" + }, + { + "target": "com.amazonaws.imagebuilder#ResourceDependencyException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a container recipe.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/DeleteContainerRecipe", + "code": 200 + } + } + }, + "com.amazonaws.imagebuilder#DeleteContainerRecipeRequest": { + "type": "structure", + "members": { + "containerRecipeArn": { + "target": "com.amazonaws.imagebuilder#ContainerRecipeArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the container recipe to delete.

", + "smithy.api#httpQuery": "containerRecipeArn", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.imagebuilder#DeleteContainerRecipeResponse": { + "type": "structure", + "members": { + "requestId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" + } + }, + "containerRecipeArn": { + "target": "com.amazonaws.imagebuilder#ContainerRecipeArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the container recipe that was deleted.

" + } + } + } + }, "com.amazonaws.imagebuilder#DeleteDistributionConfiguration": { "type": "operation", "input": { @@ -1856,6 +2365,12 @@ "smithy.api#documentation": "

The specific AMI settings (for example, launch permissions, AMI tags).

" } }, + "containerDistributionConfiguration": { + "target": "com.amazonaws.imagebuilder#ContainerDistributionConfiguration", + "traits": { + "smithy.api#documentation": "

Container distribution settings for encryption, licensing, and sharing in a specific Region.

" + } + }, "licenseConfigurationArns": { "target": "com.amazonaws.imagebuilder#LicenseConfigurationArnList", "traits": { @@ -1968,6 +2483,12 @@ "traits": { "smithy.api#documentation": "

The tags associated with the distribution configuration.

" } + }, + "regions": { + "target": "com.amazonaws.imagebuilder#RegionList", + "traits": { + "smithy.api#documentation": "

A list of Regions where the container image is distributed to.

" + } } }, "traits": { @@ -1995,6 +2516,9 @@ } } }, + "com.amazonaws.imagebuilder#DockerFileTemplate": { + "type": "string" + }, "com.amazonaws.imagebuilder#EbsInstanceBlockDeviceSpecification": { "type": "structure", "members": { @@ -2244,67 +2768,201 @@ "smithy.api#documentation": "

Gets a component policy.

", "smithy.api#http": { "method": "GET", - "uri": "/GetComponentPolicy", + "uri": "/GetComponentPolicy", + "code": 200 + } + } + }, + "com.amazonaws.imagebuilder#GetComponentPolicyRequest": { + "type": "structure", + "members": { + "componentArn": { + "target": "com.amazonaws.imagebuilder#ComponentBuildVersionArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the component whose policy you want to retrieve.

", + "smithy.api#httpQuery": "componentArn", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.imagebuilder#GetComponentPolicyResponse": { + "type": "structure", + "members": { + "requestId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" + } + }, + "policy": { + "target": "com.amazonaws.imagebuilder#ResourcePolicyDocument", + "traits": { + "smithy.api#documentation": "

The component policy.

" + } + } + } + }, + "com.amazonaws.imagebuilder#GetComponentRequest": { + "type": "structure", + "members": { + "componentBuildVersionArn": { + "target": "com.amazonaws.imagebuilder#ComponentVersionArnOrBuildVersionArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the component that you want to retrieve. Regex requires \"/\\d+$\" suffix.

", + "smithy.api#httpQuery": "componentBuildVersionArn", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.imagebuilder#GetComponentResponse": { + "type": "structure", + "members": { + "requestId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" + } + }, + "component": { + "target": "com.amazonaws.imagebuilder#Component", + "traits": { + "smithy.api#documentation": "

The component object associated with the specified ARN.

" + } + } + } + }, + "com.amazonaws.imagebuilder#GetContainerRecipe": { + "type": "operation", + "input": { + "target": "com.amazonaws.imagebuilder#GetContainerRecipeRequest" + }, + "output": { + "target": "com.amazonaws.imagebuilder#GetContainerRecipeResponse" + }, + "errors": [ + { + "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" + }, + { + "target": "com.amazonaws.imagebuilder#ClientException" + }, + { + "target": "com.amazonaws.imagebuilder#ForbiddenException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidRequestException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves a container recipe.

", + "smithy.api#http": { + "method": "GET", + "uri": "/GetContainerRecipe", + "code": 200 + } + } + }, + "com.amazonaws.imagebuilder#GetContainerRecipePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.imagebuilder#GetContainerRecipePolicyRequest" + }, + "output": { + "target": "com.amazonaws.imagebuilder#GetContainerRecipePolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" + }, + { + "target": "com.amazonaws.imagebuilder#ForbiddenException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidRequestException" + }, + { + "target": "com.amazonaws.imagebuilder#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the policy for a container recipe.

", + "smithy.api#http": { + "method": "GET", + "uri": "/GetContainerRecipePolicy", "code": 200 } } }, - "com.amazonaws.imagebuilder#GetComponentPolicyRequest": { + "com.amazonaws.imagebuilder#GetContainerRecipePolicyRequest": { "type": "structure", "members": { - "componentArn": { - "target": "com.amazonaws.imagebuilder#ComponentBuildVersionArn", + "containerRecipeArn": { + "target": "com.amazonaws.imagebuilder#ContainerRecipeArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the component whose policy you want to retrieve.

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

The Amazon Resource Name (ARN) of the container recipe for the policy being requested.

", + "smithy.api#httpQuery": "containerRecipeArn", "smithy.api#required": {} } } } }, - "com.amazonaws.imagebuilder#GetComponentPolicyResponse": { + "com.amazonaws.imagebuilder#GetContainerRecipePolicyResponse": { "type": "structure", "members": { "requestId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { - "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" + "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" } }, "policy": { "target": "com.amazonaws.imagebuilder#ResourcePolicyDocument", "traits": { - "smithy.api#documentation": "

The component policy.

" + "smithy.api#documentation": "

The container recipe policy object that is returned.

" } } } }, - "com.amazonaws.imagebuilder#GetComponentRequest": { + "com.amazonaws.imagebuilder#GetContainerRecipeRequest": { "type": "structure", "members": { - "componentBuildVersionArn": { - "target": "com.amazonaws.imagebuilder#ComponentVersionArnOrBuildVersionArn", + "containerRecipeArn": { + "target": "com.amazonaws.imagebuilder#ContainerRecipeArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the component that you want to retrieve. Regex requires \"/\\d+$\" suffix.

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

The Amazon Resource Name (ARN) of the container recipe to retrieve.

", + "smithy.api#httpQuery": "containerRecipeArn", "smithy.api#required": {} } } } }, - "com.amazonaws.imagebuilder#GetComponentResponse": { + "com.amazonaws.imagebuilder#GetContainerRecipeResponse": { "type": "structure", "members": { "requestId": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { - "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" + "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" } }, - "component": { - "target": "com.amazonaws.imagebuilder#Component", + "containerRecipe": { + "target": "com.amazonaws.imagebuilder#ContainerRecipe", "traits": { - "smithy.api#documentation": "

The component object associated with the specified ARN.

" + "smithy.api#documentation": "

The container recipe object that is returned.

" } } } @@ -2806,6 +3464,12 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image.

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

Specifies whether this is an AMI or container image.

" + } + }, "name": { "target": "com.amazonaws.imagebuilder#ResourceName", "traits": { @@ -2848,6 +3512,12 @@ "smithy.api#documentation": "

The image recipe used when creating the image.

" } }, + "containerRecipe": { + "target": "com.amazonaws.imagebuilder#ContainerRecipe", + "traits": { + "smithy.api#documentation": "

The container recipe used to create the container image type.

" + } + }, "sourcePipelineName": { "target": "com.amazonaws.imagebuilder#ResourceName", "traits": { @@ -2910,7 +3580,7 @@ "com.amazonaws.imagebuilder#ImageBuilderArn": { "type": "string", "traits": { - "smithy.api#pattern": "^arn:aws[^:]*:imagebuilder:[^:]+:(?:\\d{12}|aws):(?:image-recipe|infrastructure-configuration|distribution-configuration|component|image|image-pipeline)/[a-z0-9-_]+(?:/(?:(?:x|\\d+)\\.(?:x|\\d+)\\.(?:x|\\d+))(?:/\\d+)?)?$" + "smithy.api#pattern": "^arn:aws[^:]*:imagebuilder:[^:]+:(?:\\d{12}|aws):(?:image-recipe|container-recipe|infrastructure-configuration|distribution-configuration|component|image|image-pipeline)/[a-z0-9-_]+(?:/(?:(?:x|\\d+)\\.(?:x|\\d+)\\.(?:x|\\d+))(?:/\\d+)?)?$" } }, "com.amazonaws.imagebuilder#ImagePipeline": { @@ -2952,6 +3622,12 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image recipe associated with this image pipeline.

" } }, + "containerRecipeArn": { + "target": "com.amazonaws.imagebuilder#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the container recipe that is used for this pipeline.

" + } + }, "infrastructureConfigurationArn": { "target": "com.amazonaws.imagebuilder#Arn", "traits": { @@ -3038,6 +3714,12 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image recipe.

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

Specifies which type of image is created by the recipe - an AMI or a container image.

" + } + }, "name": { "target": "com.amazonaws.imagebuilder#ResourceName", "traits": { @@ -3257,6 +3939,12 @@ "smithy.api#documentation": "

The name of the image.

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

Specifies whether this is an AMI or container image.

" + } + }, "version": { "target": "com.amazonaws.imagebuilder#VersionNumber", "traits": { @@ -3345,6 +4033,21 @@ } } }, + "com.amazonaws.imagebuilder#ImageType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "AMI", + "name": "AMI" + }, + { + "value": "DOCKER", + "name": "DOCKER" + } + ] + } + }, "com.amazonaws.imagebuilder#ImageVersion": { "type": "structure", "members": { @@ -3360,6 +4063,12 @@ "smithy.api#documentation": "

The name of the image semantic version.

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

Specifies whether this is an AMI or container image.

" + } + }, "version": { "target": "com.amazonaws.imagebuilder#VersionNumber", "traits": { @@ -3735,7 +4444,18 @@ "smithy.api#length": { "min": 1, "max": 16000 - } + }, + "smithy.api#pattern": "[^\\x00]+" + } + }, + "com.amazonaws.imagebuilder#InlineDockerFileTemplate": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 16000 + }, + "smithy.api#pattern": "[^\\x00]+" } }, "com.amazonaws.imagebuilder#InstanceBlockDeviceMapping": { @@ -4044,6 +4764,12 @@ "smithy.api#documentation": "

The filters.

" } }, + "byName": { + "target": "com.amazonaws.imagebuilder#Boolean", + "traits": { + "smithy.api#documentation": "

Returns the list of component build versions for the specified semantic version.

" + } + }, "maxResults": { "target": "com.amazonaws.imagebuilder#RestrictedInteger", "traits": { @@ -4082,6 +4808,99 @@ } } }, + "com.amazonaws.imagebuilder#ListContainerRecipes": { + "type": "operation", + "input": { + "target": "com.amazonaws.imagebuilder#ListContainerRecipesRequest" + }, + "output": { + "target": "com.amazonaws.imagebuilder#ListContainerRecipesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" + }, + { + "target": "com.amazonaws.imagebuilder#ClientException" + }, + { + "target": "com.amazonaws.imagebuilder#ForbiddenException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidPaginationTokenException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidRequestException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of container recipes.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ListContainerRecipes", + "code": 200 + } + } + }, + "com.amazonaws.imagebuilder#ListContainerRecipesRequest": { + "type": "structure", + "members": { + "owner": { + "target": "com.amazonaws.imagebuilder#Ownership", + "traits": { + "smithy.api#documentation": "

Returns container recipes belonging to the specified owner, that have been shared with you. You can omit this field to return container recipes belonging to your account.

" + } + }, + "filters": { + "target": "com.amazonaws.imagebuilder#FilterList", + "traits": { + "smithy.api#documentation": "

Request filters that are used to narrow the list of container images that are returned.

" + } + }, + "maxResults": { + "target": "com.amazonaws.imagebuilder#RestrictedInteger", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

The maximum number of results to return in the list.

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

Provides a token for pagination, which determines where to begin the next set of results when the current set reaches the maximum for one request.

" + } + } + } + }, + "com.amazonaws.imagebuilder#ListContainerRecipesResponse": { + "type": "structure", + "members": { + "requestId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" + } + }, + "containerRecipeSummaryList": { + "target": "com.amazonaws.imagebuilder#ContainerRecipeSummaryList", + "traits": { + "smithy.api#documentation": "

The list of container recipes returned for the request.

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

The next token field is used for paginated responses. When this is not empty, there are additional container recipes that the service has not included in this response. Use this token with the next request to retrieve additional list items.

" + } + } + } + }, "com.amazonaws.imagebuilder#ListDistributionConfigurations": { "type": "operation", "input": { @@ -4114,7 +4933,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of distribution configurations.

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

Returns a list of distribution configurations.

", "smithy.api#http": { "method": "POST", "uri": "/ListDistributionConfigurations", @@ -4595,6 +5414,12 @@ "smithy.api#documentation": "

The filters.

" } }, + "byName": { + "target": "com.amazonaws.imagebuilder#Boolean", + "traits": { + "smithy.api#documentation": "

Requests a list of images with a specific recipe name.

" + } + }, "maxResults": { "target": "com.amazonaws.imagebuilder#RestrictedInteger", "traits": { @@ -4607,6 +5432,12 @@ "traits": { "smithy.api#documentation": "

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

" } + }, + "includeDeprecated": { + "target": "com.amazonaws.imagebuilder#NullableBoolean", + "traits": { + "smithy.api#documentation": "

Includes deprecated images in the response list.

" + } } } }, @@ -4826,6 +5657,12 @@ "traits": { "smithy.api#documentation": "

The EC2 AMIs created by this image.

" } + }, + "containers": { + "target": "com.amazonaws.imagebuilder#ContainerList", + "traits": { + "smithy.api#documentation": "

Container images that the pipeline has generated and stored in the output repository.

" + } } }, "traits": { @@ -4984,6 +5821,85 @@ } } }, + "com.amazonaws.imagebuilder#PutContainerRecipePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.imagebuilder#PutContainerRecipePolicyRequest" + }, + "output": { + "target": "com.amazonaws.imagebuilder#PutContainerRecipePolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.imagebuilder#CallRateLimitExceededException" + }, + { + "target": "com.amazonaws.imagebuilder#ClientException" + }, + { + "target": "com.amazonaws.imagebuilder#ForbiddenException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.imagebuilder#InvalidRequestException" + }, + { + "target": "com.amazonaws.imagebuilder#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceException" + }, + { + "target": "com.amazonaws.imagebuilder#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Applies a policy to a container image. We recommend that you call the RAM API CreateResourceShare (https://docs.aws.amazon.com/ram/latest/APIReference/API_CreateResourceShare.html) to share resources. If you call the Image Builder API PutContainerImagePolicy, you must also call the RAM API PromoteResourceShareCreatedFromPolicy (https://docs.aws.amazon.com/ram/latest/APIReference/API_PromoteResourceShareCreatedFromPolicy.html) in order for the resource to be visible to all principals with whom the resource is shared.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/PutContainerRecipePolicy", + "code": 200 + } + } + }, + "com.amazonaws.imagebuilder#PutContainerRecipePolicyRequest": { + "type": "structure", + "members": { + "containerRecipeArn": { + "target": "com.amazonaws.imagebuilder#ContainerRecipeArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the container recipe that this policy should be applied to.

", + "smithy.api#required": {} + } + }, + "policy": { + "target": "com.amazonaws.imagebuilder#ResourcePolicyDocument", + "traits": { + "smithy.api#documentation": "

The policy to apply to the container recipe.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.imagebuilder#PutContainerRecipePolicyResponse": { + "type": "structure", + "members": { + "requestId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The request ID that uniquely identifies this request.

" + } + }, + "containerRecipeArn": { + "target": "com.amazonaws.imagebuilder#ContainerRecipeArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the container recipe that this policy was applied to.

" + } + } + } + }, "com.amazonaws.imagebuilder#PutImagePolicy": { "type": "operation", "input": { @@ -5142,6 +6058,12 @@ } } }, + "com.amazonaws.imagebuilder#RegionList": { + "type": "list", + "member": { + "target": "com.amazonaws.imagebuilder#NonEmptyString" + } + }, "com.amazonaws.imagebuilder#ResourceAlreadyExistsException": { "type": "structure", "members": { @@ -5517,6 +6439,28 @@ } } }, + "com.amazonaws.imagebuilder#TargetContainerRepository": { + "type": "structure", + "members": { + "service": { + "target": "com.amazonaws.imagebuilder#ContainerRepositoryService", + "traits": { + "smithy.api#documentation": "

Specifies the service in which this image was registered.

", + "smithy.api#required": {} + } + }, + "repositoryName": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the container repository where the output container image is stored. This name is prefixed by the repository location.

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

The container repository where the output container image is stored.

" + } + }, "com.amazonaws.imagebuilder#UntagResource": { "type": "operation", "input": { @@ -5734,8 +6678,13 @@ "imageRecipeArn": { "target": "com.amazonaws.imagebuilder#ImageRecipeArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image recipe that will be used to configure images updated by this image pipeline.

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

The Amazon Resource Name (ARN) of the image recipe that will be used to configure images updated by this image pipeline.

" + } + }, + "containerRecipeArn": { + "target": "com.amazonaws.imagebuilder#ContainerRecipeArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the container pipeline to update.

" } }, "infrastructureConfigurationArn": { @@ -5974,6 +6923,9 @@ { "target": "com.amazonaws.imagebuilder#CreateComponent" }, + { + "target": "com.amazonaws.imagebuilder#CreateContainerRecipe" + }, { "target": "com.amazonaws.imagebuilder#CreateDistributionConfiguration" }, @@ -5992,6 +6944,9 @@ { "target": "com.amazonaws.imagebuilder#DeleteComponent" }, + { + "target": "com.amazonaws.imagebuilder#DeleteContainerRecipe" + }, { "target": "com.amazonaws.imagebuilder#DeleteDistributionConfiguration" }, @@ -6013,6 +6968,12 @@ { "target": "com.amazonaws.imagebuilder#GetComponentPolicy" }, + { + "target": "com.amazonaws.imagebuilder#GetContainerRecipe" + }, + { + "target": "com.amazonaws.imagebuilder#GetContainerRecipePolicy" + }, { "target": "com.amazonaws.imagebuilder#GetDistributionConfiguration" }, @@ -6043,6 +7004,9 @@ { "target": "com.amazonaws.imagebuilder#ListComponents" }, + { + "target": "com.amazonaws.imagebuilder#ListContainerRecipes" + }, { "target": "com.amazonaws.imagebuilder#ListDistributionConfigurations" }, @@ -6070,6 +7034,9 @@ { "target": "com.amazonaws.imagebuilder#PutComponentPolicy" }, + { + "target": "com.amazonaws.imagebuilder#PutContainerRecipePolicy" + }, { "target": "com.amazonaws.imagebuilder#PutImagePolicy" }, @@ -6107,7 +7074,7 @@ "name": "imagebuilder" }, "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

EC2 Image Builder is a fully managed AWS service that makes it easier to automate the creation, management, and deployment of customized, secure, and up-to-date “golden” server images that are pre-installed and pre-configured with software and settings to meet specific IT standards.

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

EC2 Image Builder is a fully managed AWS service that makes it easier to automate the creation, management, and deployment of customized, secure, and up-to-date \"golden\" server images that are pre-installed and pre-configured with software and settings to meet specific IT standards.

", "smithy.api#title": "EC2 Image Builder" } } diff --git a/codegen/sdk-codegen/aws-models/iotanalytics.2017-11-27.json b/codegen/sdk-codegen/aws-models/iotanalytics.2017-11-27.json index 56e2a989bd6..8cbc36a864f 100644 --- a/codegen/sdk-codegen/aws-models/iotanalytics.2017-11-27.json +++ b/codegen/sdk-codegen/aws-models/iotanalytics.2017-11-27.json @@ -184,7 +184,7 @@ "attributes": { "target": "com.amazonaws.iotanalytics#AttributeNameMapping", "traits": { - "smithy.api#documentation": "

A list of 1-50 AttributeNameMapping objects that map an existing attribute\n to a new attribute.

\n \n

The existing attributes remain in the message, so if you want to remove the originals, use\n RemoveAttributeActivity.

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

A list of 1-50 AttributeNameMapping objects that map an existing attribute to\n a new attribute.

\n \n

The existing attributes remain in the message, so if you want to remove the originals,\n use RemoveAttributeActivity.

\n ", "smithy.api#required": {} } }, @@ -458,12 +458,12 @@ "lastMessageArrivalTime": { "target": "com.amazonaws.iotanalytics#Timestamp", "traits": { - "smithy.api#documentation": "

The last time when a new message arrived in the channel.

\n

AWS IoT Analytics updates this value at most once per minute for one channel. \n Hence, the lastMessageArrivalTime value is an approximation.

\n

This feature only applies to messages that arrived in the data store after October 23, 2020.

" + "smithy.api#documentation": "

The last time when a new message arrived in the channel.

\n

AWS IoT Analytics updates this value at most once per minute for one channel. \n Hence, the lastMessageArrivalTime value is an approximation.

\n

This feature only applies to messages that arrived in the data store after October 23, 2020.

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

A collection of data from an MQTT topic.\n Channels archive the raw, unprocessed messages before publishing the data to a pipeline.

" + "smithy.api#documentation": "

A collection of data from an MQTT topic. Channels archive the raw, unprocessed messages\n before publishing the data to a pipeline.

" } }, "com.amazonaws.iotanalytics#ChannelActivity": { @@ -497,6 +497,20 @@ "com.amazonaws.iotanalytics#ChannelArn": { "type": "string" }, + "com.amazonaws.iotanalytics#ChannelMessages": { + "type": "structure", + "members": { + "s3Paths": { + "target": "com.amazonaws.iotanalytics#S3PathChannelMessages", + "traits": { + "smithy.api#documentation": "

Specifies one or more keys that identify the Amazon Simple Storage Service (Amazon S3) objects that save your\n channel messages.

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

Specifies one or more sets of channel messages.

" + } + }, "com.amazonaws.iotanalytics#ChannelName": { "type": "string", "traits": { @@ -622,7 +636,7 @@ "lastMessageArrivalTime": { "target": "com.amazonaws.iotanalytics#Timestamp", "traits": { - "smithy.api#documentation": "

The last time when a new message arrived in the channel.

\n

AWS IoT Analytics updates this value at most once per minute for one channel. \n Hence, the lastMessageArrivalTime value is an approximation.

\n

This feature only applies to messages that arrived in the data store after October 23, 2020.

" + "smithy.api#documentation": "

The last time when a new message arrived in the channel.

\n

AWS IoT Analytics updates this value at most once per minute for one channel. \n Hence, the lastMessageArrivalTime value is an approximation.

\n

This feature only applies to messages that arrived in the data store after October 23, 2020.

" } } }, @@ -630,6 +644,54 @@ "smithy.api#documentation": "

A summary of information about a channel.

" } }, + "com.amazonaws.iotanalytics#Column": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.iotanalytics#ColumnName", + "traits": { + "smithy.api#documentation": "

The name of the column.

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

The type of data. For more information about the supported data types, see Common data types\n in the AWS Glue Developer Guide.

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

Contains information about a column that stores your data.

" + } + }, + "com.amazonaws.iotanalytics#ColumnDataType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 131072 + }, + "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*$" + } + }, + "com.amazonaws.iotanalytics#ColumnName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[A-Za-z_]([A-Za-z0-9]*|[A-Za-z0-9][A-Za-z0-9_]*)$" + } + }, + "com.amazonaws.iotanalytics#Columns": { + "type": "list", + "member": { + "target": "com.amazonaws.iotanalytics#Column" + } + }, "com.amazonaws.iotanalytics#ComputeType": { "type": "string", "traits": { @@ -709,7 +771,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a channel. A channel collects data from an MQTT topic and archives the\n raw, unprocessed messages before publishing the data to a pipeline.

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

Creates a channel. A channel collects data from an MQTT topic and archives the raw,\n unprocessed messages before publishing the data to a pipeline.

", "smithy.api#http": { "method": "POST", "uri": "/channels", @@ -833,7 +895,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates the content of a data set by applying a queryAction (a SQL query)\n or a containerAction (executing a containerized application).

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

Creates the content of a data set by applying a queryAction (a SQL query) or\n a containerAction (executing a containerized application).

", "smithy.api#http": { "method": "POST", "uri": "/datasets/{datasetName}/content", @@ -891,7 +953,7 @@ "triggers": { "target": "com.amazonaws.iotanalytics#DatasetTriggers", "traits": { - "smithy.api#documentation": "

A list of triggers. A trigger causes data set contents to be populated at a specified\n time interval or when another data set's contents are created. The list of triggers can be\n empty or contain up to five DataSetTrigger objects.

" + "smithy.api#documentation": "

A list of triggers. A trigger causes data set contents to be populated at a specified time\n interval or when another data set's contents are created. The list of triggers can be empty or\n contain up to five DataSetTrigger objects.

" } }, "contentDeliveryRules": { @@ -903,13 +965,13 @@ "retentionPeriod": { "target": "com.amazonaws.iotanalytics#RetentionPeriod", "traits": { - "smithy.api#documentation": "

Optional. How long, in days, versions of dataset contents are kept for the dataset. If\n not specified or set to null, versions of dataset contents are retained for at\n most 90 days. The number of versions of dataset contents retained is determined by the\n versioningConfiguration parameter. For more information, see Keeping Multiple Versions of AWS IoT Analytics Data Sets in the AWS IoT\n Analytics User Guide.

" + "smithy.api#documentation": "

Optional. How long, in days, versions of dataset contents are kept for the dataset. If not\n specified or set to null, versions of dataset contents are retained for at most\n 90 days. The number of versions of dataset contents retained is determined by the\n versioningConfiguration parameter. For more information, see Keeping Multiple Versions of AWS IoT Analytics Data Sets in the AWS IoT\n Analytics User Guide.

" } }, "versioningConfiguration": { "target": "com.amazonaws.iotanalytics#VersioningConfiguration", "traits": { - "smithy.api#documentation": "

Optional. How many versions of dataset contents are kept. If not specified or set to\n null, only the latest version plus the latest succeeded version (if they are different) are\n kept for the time period specified by the retentionPeriod parameter. For more\n information, see\n Keeping Multiple Versions of AWS IoT Analytics Data Sets in the AWS IoT\n Analytics User Guide.

" + "smithy.api#documentation": "

Optional. How many versions of dataset contents are kept. If not specified or set to null,\n only the latest version plus the latest succeeded version (if they are different) are kept for\n the time period specified by the retentionPeriod parameter. For more information,\n see Keeping Multiple Versions of AWS IoT Analytics Data Sets in the AWS IoT\n Analytics User Guide.

" } }, "tags": { @@ -921,7 +983,7 @@ "lateDataRules": { "target": "com.amazonaws.iotanalytics#LateDataRules", "traits": { - "smithy.api#documentation": "

A list of data rules that send notifications to Amazon CloudWatch, when data arrives late. To\n specify lateDataRules, the dataset must use a DeltaTimer\n filter.

" + "smithy.api#documentation": "

A list of data rules that send notifications to Amazon CloudWatch, when data arrives late. To\n specify lateDataRules, the dataset must use a DeltaTimer\n filter.

" } } } @@ -1013,6 +1075,12 @@ "traits": { "smithy.api#documentation": "

Metadata which can be used to manage the data store.

" } + }, + "fileFormatConfiguration": { + "target": "com.amazonaws.iotanalytics#FileFormatConfiguration", + "traits": { + "smithy.api#documentation": "

Contains the configuration information of file formats. AWS IoT Analytics data stores support JSON \n and Parquet.

\n

The default file format is JSON. You can specify only one format.

\n

You can't change the file format after you create the data store.

" + } } } }, @@ -1068,7 +1136,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a pipeline. A pipeline consumes messages from a channel and allows \n you to process the messages before storing them in a data store. You must specify both a \n channel and a datastore activity and, optionally, as many\n as 23 additional activities in the pipelineActivities array.

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

Creates a pipeline. A pipeline consumes messages from a channel and allows you to process\n the messages before storing them in a data store. You must specify both a channel\n and a datastore activity and, optionally, as many as 23 additional activities in\n the pipelineActivities array.

", "smithy.api#http": { "method": "POST", "uri": "/pipelines", @@ -1089,7 +1157,7 @@ "pipelineActivities": { "target": "com.amazonaws.iotanalytics#PipelineActivities", "traits": { - "smithy.api#documentation": "

A list of PipelineActivity objects. Activities perform transformations on\n your messages, such as removing, renaming or adding message attributes; filtering messages\n based on attribute values; invoking your Lambda functions on messages for advanced processing;\n or performing mathematical transformations to normalize device data.

\n

The list can be 2-25 PipelineActivity objects and must contain both a\n channel and a datastore activity. Each entry in the list must\n contain only one activity. For example:

\n

\n pipelineActivities = [\n {\n \"channel\": { ... }\n },\n {\n \"lambda\": { ... }\n },\n ... \n]\n

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

A list of PipelineActivity objects. Activities perform transformations on\n your messages, such as removing, renaming or adding message attributes; filtering messages\n based on attribute values; invoking your Lambda functions on messages for advanced processing;\n or performing mathematical transformations to normalize device data.

\n

The list can be 2-25 PipelineActivity objects and must contain both a\n channel and a datastore activity. Each entry in the list must\n contain only one activity. For example:

\n

\n pipelineActivities = [ { \"channel\": { ... } }, { \"lambda\": { ... } }, ...\n ]\n

", "smithy.api#required": {} } }, @@ -1137,7 +1205,7 @@ "roleArn": { "target": "com.amazonaws.iotanalytics#RoleArn", "traits": { - "smithy.api#documentation": "

The ARN of the role that grants AWS IoT Analytics permission to interact with your\n Amazon S3 resources.

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

The ARN of the role that grants AWS IoT Analytics permission to interact with your Amazon\n S3 resources.

", "smithy.api#required": {} } } @@ -1164,7 +1232,7 @@ "roleArn": { "target": "com.amazonaws.iotanalytics#RoleArn", "traits": { - "smithy.api#documentation": "

The ARN of the role that grants AWS IoT Analytics permission to interact with your\n Amazon S3 resources.

" + "smithy.api#documentation": "

The ARN of the role that grants AWS IoT Analytics permission to interact with your Amazon\n S3 resources.

" } } }, @@ -1191,7 +1259,7 @@ "roleArn": { "target": "com.amazonaws.iotanalytics#RoleArn", "traits": { - "smithy.api#documentation": "

The ARN of the role that grants AWS IoT Analytics permission to interact with your\n Amazon S3 resources.

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

The ARN of the role that grants AWS IoT Analytics permission to interact with your Amazon\n S3 resources.

", "smithy.api#required": {} } } @@ -1218,7 +1286,7 @@ "roleArn": { "target": "com.amazonaws.iotanalytics#RoleArn", "traits": { - "smithy.api#documentation": "

The ARN of the role that grants AWS IoT Analytics permission to interact with your\n Amazon S3 resources.

" + "smithy.api#documentation": "

The ARN of the role that grants AWS IoT Analytics permission to interact with your Amazon\n S3 resources.

" } } }, @@ -1286,13 +1354,13 @@ "versioningConfiguration": { "target": "com.amazonaws.iotanalytics#VersioningConfiguration", "traits": { - "smithy.api#documentation": "

Optional. How many versions of dataset contents are kept. If not specified or set to\n null, only the latest version plus the latest succeeded version (if they are different) are\n kept for the time period specified by the retentionPeriod parameter. For more\n information, see\n Keeping Multiple Versions of AWS IoT Analytics Data Sets in the AWS IoT\n Analytics User Guide.

" + "smithy.api#documentation": "

Optional. How many versions of dataset contents are kept. If not specified or set to null,\n only the latest version plus the latest succeeded version (if they are different) are kept for\n the time period specified by the retentionPeriod parameter. For more information,\n see Keeping Multiple Versions of AWS IoT Analytics Data Sets in the AWS IoT\n Analytics User Guide.

" } }, "lateDataRules": { "target": "com.amazonaws.iotanalytics#LateDataRules", "traits": { - "smithy.api#documentation": "

A list of data rules that send notifications to Amazon CloudWatch, when data arrives late. To\n specify lateDataRules, the dataset must use a DeltaTimer\n filter.

" + "smithy.api#documentation": "

A list of data rules that send notifications to Amazon CloudWatch, when data arrives late. To\n specify lateDataRules, the dataset must use a DeltaTimer\n filter.

" } } }, @@ -1306,7 +1374,7 @@ "actionName": { "target": "com.amazonaws.iotanalytics#DatasetActionName", "traits": { - "smithy.api#documentation": "

The name of the data set action by which data set contents are automatically created.

" + "smithy.api#documentation": "

The name of the data set action by which data set contents are automatically\n created.

" } }, "queryAction": { @@ -1323,7 +1391,7 @@ } }, "traits": { - "smithy.api#documentation": "

A DatasetAction object that specifies how data set contents are\n automatically created.

" + "smithy.api#documentation": "

A DatasetAction object that specifies how data set contents are automatically\n created.

" } }, "com.amazonaws.iotanalytics#DatasetActionName": { @@ -1555,7 +1623,7 @@ } }, "traits": { - "smithy.api#documentation": "

The dataset whose latest contents are used as input to the notebook or\n application.

" + "smithy.api#documentation": "

The dataset whose latest contents are used as input to the notebook or application.

" } }, "com.amazonaws.iotanalytics#DatasetEntries": { @@ -1649,7 +1717,7 @@ "triggers": { "target": "com.amazonaws.iotanalytics#DatasetTriggers", "traits": { - "smithy.api#documentation": "

A list of triggers. A trigger causes data set content to be populated at a specified time\n interval or when another data set is populated. The list of triggers can be empty or contain up\n to five DataSetTrigger objects

" + "smithy.api#documentation": "

A list of triggers. A trigger causes data set content to be populated at a specified time\n interval or when another data set is populated. The list of triggers can be empty or contain\n up to five DataSetTrigger objects

" } }, "actions": { @@ -1675,7 +1743,7 @@ "dataset": { "target": "com.amazonaws.iotanalytics#TriggeringDataset", "traits": { - "smithy.api#documentation": "

The data set whose content creation triggers the creation of this data set's contents.

" + "smithy.api#documentation": "

The data set whose content creation triggers the creation of this data set's\n contents.

" } } }, @@ -1743,7 +1811,13 @@ "lastMessageArrivalTime": { "target": "com.amazonaws.iotanalytics#Timestamp", "traits": { - "smithy.api#documentation": "

The last time when a new message arrived in the data store.

\n

AWS IoT Analytics updates this value at most once per minute for one data store. \n Hence, the lastMessageArrivalTime value is an approximation.

\n

This feature only applies to messages that arrived in the data store after October 23, 2020.

" + "smithy.api#documentation": "

The last time when a new message arrived in the data store.

\n

AWS IoT Analytics updates this value at most once per minute for one data store. \n Hence, the lastMessageArrivalTime value is an approximation.

\n

This feature only applies to messages that arrived in the data store after October 23, 2020.

" + } + }, + "fileFormatConfiguration": { + "target": "com.amazonaws.iotanalytics#FileFormatConfiguration", + "traits": { + "smithy.api#documentation": "

Contains the configuration information of file formats. AWS IoT Analytics data stores support JSON \n and Parquet.

\n

The default file format is JSON. You can specify only one format.

\n

You can't change the file format after you create the data store.

" } } }, @@ -1825,7 +1899,7 @@ "serviceManagedS3": { "target": "com.amazonaws.iotanalytics#ServiceManagedDatastoreS3Storage", "traits": { - "smithy.api#documentation": "

Use this to store data store data in an S3 bucket managed by AWS IoT Analytics. You\n cannot change the choice of service-managed or customer-managed S3 storage after the data\n store is created.

" + "smithy.api#documentation": "

Use this to store data store data in an S3 bucket managed by AWS IoT Analytics. You cannot\n change the choice of service-managed or customer-managed S3 storage after the data store is\n created.

" } }, "customerManagedS3": { @@ -1901,7 +1975,13 @@ "lastMessageArrivalTime": { "target": "com.amazonaws.iotanalytics#Timestamp", "traits": { - "smithy.api#documentation": "

The last time when a new message arrived in the data store.

\n

AWS IoT Analytics updates this value at most once per minute for one data store. \n Hence, the lastMessageArrivalTime value is an approximation.

\n

This feature only applies to messages that arrived in the data store after October 23, 2020.

" + "smithy.api#documentation": "

The last time when a new message arrived in the data store.

\n

AWS IoT Analytics updates this value at most once per minute for one data store. \n Hence, the lastMessageArrivalTime value is an approximation.

\n

This feature only applies to messages that arrived in the data store after October 23, 2020.

" + } + }, + "fileFormatType": { + "target": "com.amazonaws.iotanalytics#FileFormatType", + "traits": { + "smithy.api#documentation": "

The file format of the data in the data store.

" } } }, @@ -2155,7 +2235,7 @@ } }, "traits": { - "smithy.api#documentation": "

Used to limit data to that which has arrived since the last execution of the action.

" + "smithy.api#documentation": "

Used to limit data to that which has arrived since the last execution of the\n action.

" } }, "com.amazonaws.iotanalytics#DeltaTimeSessionWindowConfiguration": { @@ -2164,13 +2244,13 @@ "timeoutInMinutes": { "target": "com.amazonaws.iotanalytics#SessionTimeoutInMinutes", "traits": { - "smithy.api#documentation": "

A time interval. You can use timeoutInMinutes so that AWS IoT Analytics can batch up late data notifications \n that have been generated since the last execution. AWS IoT Analytics sends one batch of notifications to Amazon CloudWatch Events at one time.

\n

For more information about how to write a timestamp expression, \n see Date and Time Functions and Operators, \n in the Presto 0.172 Documentation.

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

A time interval. You can use timeoutInMinutes so that AWS IoT Analytics can batch up late\n data notifications that have been generated since the last execution. AWS IoT Analytics sends one batch of\n notifications to Amazon CloudWatch Events at one time.

\n

For more information about how to write a timestamp expression, see Date and Time Functions and\n Operators, in the Presto 0.172 Documentation.

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

A structure that contains the configuration information of a delta time session\n window.

\n

\n \n DeltaTime\n specifies a time interval. \n You can use DeltaTime to create dataset contents with data that has arrived in the data store since the last execution. \n For an example of DeltaTime, see \n Creating a SQL dataset with a delta window (CLI) in the AWS IoT Analytics User Guide.

" + "smithy.api#documentation": "

A structure that contains the configuration information of a delta time session\n window.

\n

\n \n DeltaTime\n specifies a time interval. You can use\n DeltaTime to create dataset contents with data that has arrived in the data\n store since the last execution. For an example of DeltaTime, see Creating\n a SQL dataset with a delta window (CLI) in the\n AWS IoT Analytics User Guide.

" } }, "com.amazonaws.iotanalytics#DescribeChannel": { @@ -2221,7 +2301,7 @@ "includeStatistics": { "target": "com.amazonaws.iotanalytics#IncludeStatisticsFlag", "traits": { - "smithy.api#documentation": "

If true, additional statistical information about the channel is included in the response.\n This feature cannot be used with a channel whose S3 storage is customer-managed.

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

If true, additional statistical information about the channel is included in the response.\n This feature cannot be used with a channel whose S3 storage is customer-managed.

", "smithy.api#httpQuery": "includeStatistics" } } @@ -2350,7 +2430,7 @@ "includeStatistics": { "target": "com.amazonaws.iotanalytics#IncludeStatisticsFlag", "traits": { - "smithy.api#documentation": "

If true, additional statistical information about the data store is included in the response.\n This feature cannot be used with a data store whose S3 storage is customer-managed.

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

If true, additional statistical information about the data store is included in the\n response. This feature cannot be used with a data store whose S3 storage is\n customer-managed.

", "smithy.api#httpQuery": "includeStatistics" } } @@ -2542,7 +2622,7 @@ "thingName": { "target": "com.amazonaws.iotanalytics#AttributeName", "traits": { - "smithy.api#documentation": "

The name of the IoT device whose shadow information is added to \n the message.

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

The name of the IoT device whose shadow information is added to the message.

", "smithy.api#required": {} } }, @@ -2599,6 +2679,41 @@ "smithy.api#documentation": "

The estimated size of the resource.

" } }, + "com.amazonaws.iotanalytics#FileFormatConfiguration": { + "type": "structure", + "members": { + "jsonConfiguration": { + "target": "com.amazonaws.iotanalytics#JsonConfiguration", + "traits": { + "smithy.api#documentation": "

Contains the configuration information of the JSON format.

" + } + }, + "parquetConfiguration": { + "target": "com.amazonaws.iotanalytics#ParquetConfiguration", + "traits": { + "smithy.api#documentation": "

Contains the configuration information of the Parquet format.

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

Contains the configuration information of file formats. AWS IoT Analytics data stores support JSON \n and Parquet.

\n

The default file format is JSON. You can specify only one format.

\n

You can't change the file format after you create the data store.

" + } + }, + "com.amazonaws.iotanalytics#FileFormatType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "JSON", + "name": "JSON" + }, + { + "value": "PARQUET", + "name": "PARQUET" + } + ] + } + }, "com.amazonaws.iotanalytics#FilterActivity": { "type": "structure", "members": { @@ -2612,7 +2727,7 @@ "filter": { "target": "com.amazonaws.iotanalytics#FilterExpression", "traits": { - "smithy.api#documentation": "

An expression that looks like a SQL WHERE clause that must return a Boolean value. \n Messages that satisfy the condition are passed to the next activity.

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

An expression that looks like a SQL WHERE clause that must return a Boolean value.\n Messages that satisfy the condition are passed to the next activity.

", "smithy.api#required": {} } }, @@ -2684,7 +2799,7 @@ "versionId": { "target": "com.amazonaws.iotanalytics#DatasetContentVersion", "traits": { - "smithy.api#documentation": "

The version of the data set whose contents are retrieved. You can also use\n the strings \"$LATEST\" or \"$LATEST_SUCCEEDED\" to retrieve the contents of the \n latest or latest successfully completed data set. If not specified, \"$LATEST_SUCCEEDED\" \n is the default.

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

The version of the data set whose contents are retrieved. You can also use the strings\n \"$LATEST\" or \"$LATEST_SUCCEEDED\" to retrieve the contents of the latest or latest successfully\n completed data set. If not specified, \"$LATEST_SUCCEEDED\" is the default.

", "smithy.api#httpQuery": "versionId" } } @@ -2696,7 +2811,7 @@ "entries": { "target": "com.amazonaws.iotanalytics#DatasetEntries", "traits": { - "smithy.api#documentation": "

A list of DatasetEntry objects.

" + "smithy.api#documentation": "

A list of DatasetEntry objects.

" } }, "timestamp": { @@ -2732,7 +2847,7 @@ } }, "traits": { - "smithy.api#documentation": "

Configuration information for coordination with AWS Glue, a fully managed extract,\n transform and load (ETL) service.

" + "smithy.api#documentation": "

Configuration information for coordination with AWS Glue, a fully managed extract,\n transform and load (ETL) service.

" } }, "com.amazonaws.iotanalytics#GlueDatabaseName": { @@ -2825,6 +2940,13 @@ "smithy.api#pattern": "^[a-zA-Z][a-zA-Z0-9_]*$" } }, + "com.amazonaws.iotanalytics#JsonConfiguration": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

Contains the configuration information of the JSON format.

" + } + }, "com.amazonaws.iotanalytics#LambdaActivity": { "type": "structure", "members": { @@ -3001,13 +3123,13 @@ "channelSummaries": { "target": "com.amazonaws.iotanalytics#ChannelSummaries", "traits": { - "smithy.api#documentation": "

A list of ChannelSummary objects.

" + "smithy.api#documentation": "

A list of ChannelSummary objects.

" } }, "nextToken": { "target": "com.amazonaws.iotanalytics#NextToken", "traits": { - "smithy.api#documentation": "

The token to retrieve the next set of results, or null if there are no\n more results.

" + "smithy.api#documentation": "

The token to retrieve the next set of results, or null if there are no more\n results.

" } } } @@ -3079,7 +3201,7 @@ "scheduledOnOrAfter": { "target": "com.amazonaws.iotanalytics#Timestamp", "traits": { - "smithy.api#documentation": "

A filter to limit results to those data set contents whose creation is scheduled on or \n after the given time. See the field triggers.schedule in the CreateDataset \n request. (timestamp)

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

A filter to limit results to those data set contents whose creation is scheduled on or\n after the given time. See the field triggers.schedule in the\n CreateDataset request. (timestamp)

", "smithy.api#httpQuery": "scheduledOnOrAfter" } }, @@ -3104,7 +3226,7 @@ "nextToken": { "target": "com.amazonaws.iotanalytics#NextToken", "traits": { - "smithy.api#documentation": "

The token to retrieve the next set of results, or null if there are no\n more results.

" + "smithy.api#documentation": "

The token to retrieve the next set of results, or null if there are no more\n results.

" } } } @@ -3176,7 +3298,7 @@ "nextToken": { "target": "com.amazonaws.iotanalytics#NextToken", "traits": { - "smithy.api#documentation": "

The token to retrieve the next set of results, or null if there are no\n more results.

" + "smithy.api#documentation": "

The token to retrieve the next set of results, or null if there are no more\n results.

" } } } @@ -3248,7 +3370,7 @@ "nextToken": { "target": "com.amazonaws.iotanalytics#NextToken", "traits": { - "smithy.api#documentation": "

The token to retrieve the next set of results, or null if there are no\n more results.

" + "smithy.api#documentation": "

The token to retrieve the next set of results, or null if there are no more\n results.

" } } } @@ -3320,7 +3442,7 @@ "nextToken": { "target": "com.amazonaws.iotanalytics#NextToken", "traits": { - "smithy.api#documentation": "

The token to retrieve the next set of results, or null if there are no\n more results.

" + "smithy.api#documentation": "

The token to retrieve the next set of results, or null if there are no more\n results.

" } } } @@ -3409,7 +3531,7 @@ "roleArn": { "target": "com.amazonaws.iotanalytics#RoleArn", "traits": { - "smithy.api#documentation": "

The ARN of the role that grants permission to AWS IoT Analytics to\n perform logging.

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

The ARN of the role that grants permission to AWS IoT Analytics to perform logging.

", "smithy.api#required": {} } }, @@ -3452,7 +3574,7 @@ "math": { "target": "com.amazonaws.iotanalytics#MathExpression", "traits": { - "smithy.api#documentation": "

An expression that uses one or more existing attributes and must return an integer value.

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

An expression that uses one or more existing attributes and must return an integer\n value.

", "smithy.api#required": {} } }, @@ -3579,7 +3701,7 @@ "fileName": { "target": "com.amazonaws.iotanalytics#OutputFileName", "traits": { - "smithy.api#documentation": "

The URI of the location where dataset contents are stored, usually the URI of a file in\n an S3 bucket.

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

The URI of the location where dataset contents are stored, usually the URI of a file in an\n S3 bucket.

", "smithy.api#required": {} } } @@ -3588,6 +3710,20 @@ "smithy.api#documentation": "

The value of the variable as a structure that specifies an output file URI.

" } }, + "com.amazonaws.iotanalytics#ParquetConfiguration": { + "type": "structure", + "members": { + "schemaDefinition": { + "target": "com.amazonaws.iotanalytics#SchemaDefinition", + "traits": { + "smithy.api#documentation": "

Information needed to define a schema.

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

Contains the configuration information of the Parquet format.

" + } + }, "com.amazonaws.iotanalytics#Pipeline": { "type": "structure", "members": { @@ -3680,7 +3816,7 @@ "selectAttributes": { "target": "com.amazonaws.iotanalytics#SelectAttributesActivity", "traits": { - "smithy.api#documentation": "

Creates a new message using only the specified attributes from the original message.\n

" + "smithy.api#documentation": "

Creates a new message using only the specified attributes from the original message.\n

" } }, "filter": { @@ -3692,7 +3828,7 @@ "math": { "target": "com.amazonaws.iotanalytics#MathActivity", "traits": { - "smithy.api#documentation": "

Computes an arithmetic expression using the message's attributes and adds\n it to the message.

" + "smithy.api#documentation": "

Computes an arithmetic expression using the message's attributes and adds it to the\n message.

" } }, "deviceRegistryEnrich": { @@ -3812,7 +3948,7 @@ "deltaTime": { "target": "com.amazonaws.iotanalytics#DeltaTime", "traits": { - "smithy.api#documentation": "

Used to limit data to that which has arrived since the last execution of the action.

" + "smithy.api#documentation": "

Used to limit data to that which has arrived since the last execution of the\n action.

" } } }, @@ -3901,7 +4037,7 @@ "id": { "target": "com.amazonaws.iotanalytics#ReprocessingId", "traits": { - "smithy.api#documentation": "

The reprocessingId returned by\n StartPipelineReprocessing.

" + "smithy.api#documentation": "

The reprocessingId returned by StartPipelineReprocessing.

" } }, "status": { @@ -3977,7 +4113,7 @@ } }, "traits": { - "smithy.api#documentation": "

The configuration of the resource used to execute the\n containerAction.

" + "smithy.api#documentation": "

The configuration of the resource used to execute the containerAction.

" } }, "com.amazonaws.iotanalytics#ResourceNotFoundException": { @@ -4005,7 +4141,7 @@ "numberOfDays": { "target": "com.amazonaws.iotanalytics#RetentionPeriodInDays", "traits": { - "smithy.api#documentation": "

The number of days that message data is kept. The unlimited parameter must\n be false.

" + "smithy.api#documentation": "

The number of days that message data is kept. The unlimited parameter must be\n false.

" } } }, @@ -4087,7 +4223,7 @@ "payloads": { "target": "com.amazonaws.iotanalytics#MessagePayloads", "traits": { - "smithy.api#documentation": "

The enriched or transformed sample message payloads as base64-encoded strings. \n (The results of running the pipeline activity on each input sample message payload,\n encoded in base64.)

" + "smithy.api#documentation": "

The enriched or transformed sample message payloads as base64-encoded strings. (The\n results of running the pipeline activity on each input sample message payload, encoded in\n base64.)

" } }, "logResult": { @@ -4111,7 +4247,7 @@ "key": { "target": "com.amazonaws.iotanalytics#BucketKeyExpression", "traits": { - "smithy.api#documentation": "

The key of the dataset contents object in an S3 bucket. Each object has a key that is a\n unique identifier. Each object has exactly one key.

\n

You can create a unique key with the following options:

\n \n

The following example creates a unique key for a CSV file:\n dataset/mydataset/!{iotanalytics:scheduleTime}/!{iotanalytics:versionId}.csv\n

\n \n

If you don't use !{iotanalytics:versionId} to specify the key, you might\n get duplicate keys. For example, you might have two dataset contents with the same\n scheduleTime but different versionIds. \n This means that one dataset content overwrites the other.

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

The key of the dataset contents object in an S3 bucket. Each object has a key that is a\n unique identifier. Each object has exactly one key.

\n

You can create a unique key with the following options:

\n \n

The following example creates a unique key for a CSV file:\n dataset/mydataset/!{iotanalytics:scheduleTime}/!{iotanalytics:versionId}.csv\n

\n \n

If you don't use !{iotanalytics:versionId} to specify the key, you might\n get duplicate keys. For example, you might have two dataset contents with the same\n scheduleTime but different versionIds. This means that one\n dataset content overwrites the other.

\n ", "smithy.api#required": {} } }, @@ -4124,13 +4260,13 @@ "roleArn": { "target": "com.amazonaws.iotanalytics#RoleArn", "traits": { - "smithy.api#documentation": "

The ARN of the role that grants AWS IoT Analytics permission to interact with your\n Amazon S3 and AWS Glue resources.

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

The ARN of the role that grants AWS IoT Analytics permission to interact with your Amazon\n S3 and AWS Glue resources.

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

Configuration information for delivery of dataset contents to Amazon Simple Storage\n Service (Amazon S3).

" + "smithy.api#documentation": "

Configuration information for delivery of dataset contents to Amazon Simple Storage\n Service (Amazon S3).

" } }, "com.amazonaws.iotanalytics#S3KeyPrefix": { @@ -4143,6 +4279,28 @@ "smithy.api#pattern": "^[a-zA-Z0-9!_.*'()/{}:-]*/$" } }, + "com.amazonaws.iotanalytics#S3PathChannelMessage": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^[a-zA-Z0-9/_!'(){}\\*\\s\\.\\-\\=\\:]+$" + } + }, + "com.amazonaws.iotanalytics#S3PathChannelMessages": { + "type": "list", + "member": { + "target": "com.amazonaws.iotanalytics#S3PathChannelMessage" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, "com.amazonaws.iotanalytics#SampleChannelData": { "type": "operation", "input": { @@ -4169,7 +4327,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves a sample of messages from the specified channel ingested during the specified\n timeframe. Up to 10 messages can be retrieved.

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

Retrieves a sample of messages from the specified channel ingested during the specified\n timeframe. Up to 10 messages can be retrieved.

", "smithy.api#http": { "method": "GET", "uri": "/channels/{channelName}/sample", @@ -4217,7 +4375,7 @@ "payloads": { "target": "com.amazonaws.iotanalytics#MessagePayloads", "traits": { - "smithy.api#documentation": "

The list of message samples. Each sample message is returned as a base64-encoded\n string.

" + "smithy.api#documentation": "

The list of message samples. Each sample message is returned as a base64-encoded\n string.

" } } } @@ -4228,7 +4386,7 @@ "expression": { "target": "com.amazonaws.iotanalytics#ScheduleExpression", "traits": { - "smithy.api#documentation": "

The expression that defines when to trigger an update. \n For more information, see Schedule Expressions for\n Rules in the Amazon CloudWatch Events User\n Guide.

" + "smithy.api#documentation": "

The expression that defines when to trigger an update. For more information, see Schedule\n Expressions for Rules in the Amazon CloudWatch Events User\n Guide.

" } } }, @@ -4239,6 +4397,20 @@ "com.amazonaws.iotanalytics#ScheduleExpression": { "type": "string" }, + "com.amazonaws.iotanalytics#SchemaDefinition": { + "type": "structure", + "members": { + "columns": { + "target": "com.amazonaws.iotanalytics#Columns", + "traits": { + "smithy.api#documentation": "

Specifies one or more columns that store your data.

\n

Each schema can have up to 100 columns. Each column can have up to 100 nested types

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

Information needed to define a schema.

" + } + }, "com.amazonaws.iotanalytics#SelectAttributesActivity": { "type": "structure", "members": { @@ -4264,7 +4436,7 @@ } }, "traits": { - "smithy.api#documentation": "

Creates a new message using only the specified attributes\n from the original message.

" + "smithy.api#documentation": "

Creates a new message using only the specified attributes from the original\n message.

" } }, "com.amazonaws.iotanalytics#ServiceManagedChannelS3Storage": { @@ -4285,7 +4457,7 @@ "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "

Use this to store data store data in an S3 bucket managed by AWS IoT Analytics. You\n cannot change the choice of service-managed or customer-managed S3 storage after the data\n store is created.

" + "smithy.api#documentation": "

Use this to store data store data in an S3 bucket managed by AWS IoT Analytics. You cannot\n change the choice of service-managed or customer-managed S3 storage after the data store is\n created.

" } }, "com.amazonaws.iotanalytics#ServiceManagedDatastoreS3StorageSummary": { @@ -4399,13 +4571,19 @@ "startTime": { "target": "com.amazonaws.iotanalytics#StartTime", "traits": { - "smithy.api#documentation": "

The start time (inclusive) of raw message data that is reprocessed.

" + "smithy.api#documentation": "

The start time (inclusive) of raw message data that is reprocessed.

\n

If you specify a value for the startTime parameter, you must not use the\n channelMessages object.

" } }, "endTime": { "target": "com.amazonaws.iotanalytics#EndTime", "traits": { - "smithy.api#documentation": "

The end time (exclusive) of raw message data that is reprocessed.

" + "smithy.api#documentation": "

The end time (exclusive) of raw message data that is reprocessed.

\n

If you specify a value for the endTime parameter, you must not use the\n channelMessages object.

" + } + }, + "channelMessages": { + "target": "com.amazonaws.iotanalytics#ChannelMessages", + "traits": { + "smithy.api#documentation": "

Specifies one or more sets of channel messages that you want to reprocess.

\n

If you use the channelMessages object, you must not specify a value for\n startTime and endTime.

" } } } @@ -4517,7 +4695,7 @@ } ], "traits": { - "smithy.api#documentation": "

Adds to or modifies the tags of the given resource. Tags are metadata that can be used\n to manage a resource.

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

Adds to or modifies the tags of the given resource. Tags are metadata that can be used to\n manage a resource.

", "smithy.api#http": { "method": "POST", "uri": "/tags", @@ -4711,7 +4889,7 @@ "retentionPeriod": { "target": "com.amazonaws.iotanalytics#RetentionPeriod", "traits": { - "smithy.api#documentation": "

How long, in days, message data is kept for the channel. The retention period cannot be updated\n if the channel's S3 storage is customer-managed.

" + "smithy.api#documentation": "

How long, in days, message data is kept for the channel. The retention period cannot be\n updated if the channel's S3 storage is customer-managed.

" } } } @@ -4768,7 +4946,7 @@ "triggers": { "target": "com.amazonaws.iotanalytics#DatasetTriggers", "traits": { - "smithy.api#documentation": "

A list of DatasetTrigger objects. The list can be empty or can contain up\n to five DatasetTrigger objects.

" + "smithy.api#documentation": "

A list of DatasetTrigger objects. The list can be empty or can contain up to\n five DatasetTrigger objects.

" } }, "contentDeliveryRules": { @@ -4786,13 +4964,13 @@ "versioningConfiguration": { "target": "com.amazonaws.iotanalytics#VersioningConfiguration", "traits": { - "smithy.api#documentation": "

Optional. How many versions of dataset contents are kept. If not specified or set to\n null, only the latest version plus the latest succeeded version (if they are different) are\n kept for the time period specified by the retentionPeriod parameter. For more\n information, see \n Keeping Multiple Versions of AWS IoT Analytics Data Sets in the AWS IoT\n Analytics User Guide.

" + "smithy.api#documentation": "

Optional. How many versions of dataset contents are kept. If not specified or set to null,\n only the latest version plus the latest succeeded version (if they are different) are kept for\n the time period specified by the retentionPeriod parameter. For more information,\n see Keeping Multiple Versions of AWS IoT Analytics Data Sets in the AWS IoT\n Analytics User Guide.

" } }, "lateDataRules": { "target": "com.amazonaws.iotanalytics#LateDataRules", "traits": { - "smithy.api#documentation": "

A list of data rules that send notifications to Amazon CloudWatch, when data arrives late. To\n specify lateDataRules, the dataset must use a DeltaTimer\n filter.

" + "smithy.api#documentation": "

A list of data rules that send notifications to Amazon CloudWatch, when data arrives late. To\n specify lateDataRules, the dataset must use a DeltaTimer\n filter.

" } } } @@ -4842,7 +5020,7 @@ "retentionPeriod": { "target": "com.amazonaws.iotanalytics#RetentionPeriod", "traits": { - "smithy.api#documentation": "

How long, in days, message data is kept for the data store. The retention period cannot be updated\n if the data store's S3 storage is customer-managed.

" + "smithy.api#documentation": "

How long, in days, message data is kept for the data store. The retention period cannot be\n updated if the data store's S3 storage is customer-managed.

" } }, "datastoreStorage": { @@ -4850,6 +5028,12 @@ "traits": { "smithy.api#documentation": "

Where data store data is stored. You can choose one of serviceManagedS3 or\n customerManagedS3 storage. If not specified, the default\n isserviceManagedS3. You cannot change this storage option after the data store\n is created.

" } + }, + "fileFormatConfiguration": { + "target": "com.amazonaws.iotanalytics#FileFormatConfiguration", + "traits": { + "smithy.api#documentation": "

Contains the configuration information of file formats. AWS IoT Analytics data stores support JSON \n and Parquet.

\n

The default file format is JSON. You can specify only one format.

\n

You can't change the file format after you create the data store.

" + } } } }, @@ -4879,7 +5063,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the settings of a pipeline. You must specify both a \n channel and a datastore activity and, optionally, as many\n as 23 additional activities in the pipelineActivities array.

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

Updates the settings of a pipeline. You must specify both a channel and a\n datastore activity and, optionally, as many as 23 additional activities in the\n pipelineActivities array.

", "smithy.api#http": { "method": "PUT", "uri": "/pipelines/{pipelineName}", @@ -4901,7 +5085,7 @@ "pipelineActivities": { "target": "com.amazonaws.iotanalytics#PipelineActivities", "traits": { - "smithy.api#documentation": "

A list of PipelineActivity objects. Activities perform transformations on\n your messages, such as removing, renaming or adding message attributes; filtering messages\n based on attribute values; invoking your Lambda functions on messages for advanced processing;\n or performing mathematical transformations to normalize device data.

\n

The list can be 2-25 PipelineActivity objects and must contain both a\n channel and a datastore activity. Each entry in the list must\n contain only one activity. For example:

\n

\n pipelineActivities = [\n {\n \"channel\": { ... }\n },\n {\n \"lambda\": { ... }\n },\n ... \n]\n

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

A list of PipelineActivity objects. Activities perform transformations on\n your messages, such as removing, renaming or adding message attributes; filtering messages\n based on attribute values; invoking your Lambda functions on messages for advanced processing;\n or performing mathematical transformations to normalize device data.

\n

The list can be 2-25 PipelineActivity objects and must contain both a\n channel and a datastore activity. Each entry in the list must\n contain only one activity. For example:

\n

\n pipelineActivities = [ { \"channel\": { ... } }, { \"lambda\": { ... } }, ...\n ]\n

", "smithy.api#required": {} } } @@ -4933,7 +5117,7 @@ "datasetContentVersionValue": { "target": "com.amazonaws.iotanalytics#DatasetContentVersionValue", "traits": { - "smithy.api#documentation": "

The value of the variable as a structure that specifies a dataset content\n version.

" + "smithy.api#documentation": "

The value of the variable as a structure that specifies a dataset content version.

" } }, "outputFileUriValue": { @@ -4944,7 +5128,7 @@ } }, "traits": { - "smithy.api#documentation": "

An instance of a variable to be passed to the containerAction execution.\n Each variable must have a name and a value given by one of stringValue,\n datasetContentVersionValue, or outputFileUriValue.

" + "smithy.api#documentation": "

An instance of a variable to be passed to the containerAction execution. Each\n variable must have a name and a value given by one of stringValue,\n datasetContentVersionValue, or outputFileUriValue.

" } }, "com.amazonaws.iotanalytics#VariableName": { @@ -4980,7 +5164,7 @@ "maxVersions": { "target": "com.amazonaws.iotanalytics#MaxVersions", "traits": { - "smithy.api#documentation": "

How many versions of dataset contents are kept. The unlimited parameter\n must be false.

" + "smithy.api#documentation": "

How many versions of dataset contents are kept. The unlimited parameter must\n be false.

" } } }, diff --git a/codegen/sdk-codegen/aws-models/iotdeviceadvisor.2020-09-18.json b/codegen/sdk-codegen/aws-models/iotdeviceadvisor.2020-09-18.json new file mode 100644 index 00000000000..0308e11eb8d --- /dev/null +++ b/codegen/sdk-codegen/aws-models/iotdeviceadvisor.2020-09-18.json @@ -0,0 +1,1771 @@ +{ + "smithy": "1.0", + "metadata": { + "suppressions": [ + { + "id": "HttpMethodSemantics", + "namespace": "*" + }, + { + "id": "HttpResponseCodeSemantics", + "namespace": "*" + }, + { + "id": "PaginatedTrait", + "namespace": "*" + }, + { + "id": "HttpHeaderTrait", + "namespace": "*" + }, + { + "id": "HttpUriConflict", + "namespace": "*" + }, + { + "id": "Service", + "namespace": "*" + } + ] + }, + "shapes": { + "com.amazonaws.iotdeviceadvisor#AmazonResourceName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + } + } + }, + "com.amazonaws.iotdeviceadvisor#CategoryName": { + "type": "string" + }, + "com.amazonaws.iotdeviceadvisor#ConfigString": { + "type": "string" + }, + "com.amazonaws.iotdeviceadvisor#ConflictException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.iotdeviceadvisor#Message", + "traits": { + "smithy.api#documentation": "

Sends Conflict Exception message.

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

Sends Conflict Exception.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.iotdeviceadvisor#CreateSuiteDefinition": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotdeviceadvisor#CreateSuiteDefinitionRequest" + }, + "output": { + "target": "com.amazonaws.iotdeviceadvisor#CreateSuiteDefinitionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotdeviceadvisor#InternalServerException" + }, + { + "target": "com.amazonaws.iotdeviceadvisor#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a Device Advisor test suite.

", + "smithy.api#http": { + "method": "POST", + "uri": "/suiteDefinitions", + "code": 200 + } + } + }, + "com.amazonaws.iotdeviceadvisor#CreateSuiteDefinitionRequest": { + "type": "structure", + "members": { + "suiteDefinitionConfiguration": { + "target": "com.amazonaws.iotdeviceadvisor#SuiteDefinitionConfiguration", + "traits": { + "smithy.api#documentation": "

Creates a Device Advisor test suite with suite definition configuration.

" + } + }, + "tags": { + "target": "com.amazonaws.iotdeviceadvisor#TagMap", + "traits": { + "smithy.api#documentation": "

The tags to be attached to the suite definition.

" + } + } + } + }, + "com.amazonaws.iotdeviceadvisor#CreateSuiteDefinitionResponse": { + "type": "structure", + "members": { + "suiteDefinitionId": { + "target": "com.amazonaws.iotdeviceadvisor#UUID", + "traits": { + "smithy.api#documentation": "

Creates a Device Advisor test suite with suite UUID.

" + } + }, + "suiteDefinitionArn": { + "target": "com.amazonaws.iotdeviceadvisor#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

Creates a Device Advisor test suite with Amazon Resource name.

" + } + }, + "suiteDefinitionName": { + "target": "com.amazonaws.iotdeviceadvisor#SuiteDefinitionName", + "traits": { + "smithy.api#documentation": "

Creates a Device Advisor test suite with suite definition name.

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

Creates a Device Advisor test suite with TimeStamp of when it was created.

" + } + } + } + }, + "com.amazonaws.iotdeviceadvisor#DeleteSuiteDefinition": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotdeviceadvisor#DeleteSuiteDefinitionRequest" + }, + "output": { + "target": "com.amazonaws.iotdeviceadvisor#DeleteSuiteDefinitionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotdeviceadvisor#InternalServerException" + }, + { + "target": "com.amazonaws.iotdeviceadvisor#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a Device Advisor test suite.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/suiteDefinitions/{suiteDefinitionId}", + "code": 200 + } + } + }, + "com.amazonaws.iotdeviceadvisor#DeleteSuiteDefinitionRequest": { + "type": "structure", + "members": { + "suiteDefinitionId": { + "target": "com.amazonaws.iotdeviceadvisor#UUID", + "traits": { + "smithy.api#documentation": "

Deletes a Device Advisor test suite with defined suite Id.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotdeviceadvisor#DeleteSuiteDefinitionResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.iotdeviceadvisor#DeviceUnderTest": { + "type": "structure", + "members": { + "thingArn": { + "target": "com.amazonaws.iotdeviceadvisor#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

Lists devices thing arn

" + } + }, + "certificateArn": { + "target": "com.amazonaws.iotdeviceadvisor#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

Lists devices certificate arn

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

Lists all the devices under test

" + } + }, + "com.amazonaws.iotdeviceadvisor#DeviceUnderTestList": { + "type": "list", + "member": { + "target": "com.amazonaws.iotdeviceadvisor#DeviceUnderTest" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2 + } + } + }, + "com.amazonaws.iotdeviceadvisor#ErrorReason": { + "type": "string" + }, + "com.amazonaws.iotdeviceadvisor#Failure": { + "type": "string" + }, + "com.amazonaws.iotdeviceadvisor#GetSuiteDefinition": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotdeviceadvisor#GetSuiteDefinitionRequest" + }, + "output": { + "target": "com.amazonaws.iotdeviceadvisor#GetSuiteDefinitionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotdeviceadvisor#InternalServerException" + }, + { + "target": "com.amazonaws.iotdeviceadvisor#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotdeviceadvisor#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets information about a Device Advisor test suite.

", + "smithy.api#http": { + "method": "GET", + "uri": "/suiteDefinitions/{suiteDefinitionId}", + "code": 200 + } + } + }, + "com.amazonaws.iotdeviceadvisor#GetSuiteDefinitionRequest": { + "type": "structure", + "members": { + "suiteDefinitionId": { + "target": "com.amazonaws.iotdeviceadvisor#UUID", + "traits": { + "smithy.api#documentation": "

Requests suite definition Id with GetSuiteDefinition API call.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "suiteDefinitionVersion": { + "target": "com.amazonaws.iotdeviceadvisor#SuiteDefinitionVersion", + "traits": { + "smithy.api#documentation": "

Requests the suite definition version of a test suite.

", + "smithy.api#httpQuery": "suiteDefinitionVersion" + } + } + } + }, + "com.amazonaws.iotdeviceadvisor#GetSuiteDefinitionResponse": { + "type": "structure", + "members": { + "suiteDefinitionId": { + "target": "com.amazonaws.iotdeviceadvisor#UUID", + "traits": { + "smithy.api#documentation": "

Gets suite definition Id with GetSuiteDefinition API call.

" + } + }, + "suiteDefinitionArn": { + "target": "com.amazonaws.iotdeviceadvisor#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

The ARN of the suite definition.

" + } + }, + "suiteDefinitionVersion": { + "target": "com.amazonaws.iotdeviceadvisor#SuiteDefinitionVersion", + "traits": { + "smithy.api#documentation": "

Gets suite definition version with GetSuiteDefinition API call.

" + } + }, + "latestVersion": { + "target": "com.amazonaws.iotdeviceadvisor#SuiteDefinitionVersion", + "traits": { + "smithy.api#documentation": "

Gets latest suite definition version with GetSuiteDefinition API call.

" + } + }, + "suiteDefinitionConfiguration": { + "target": "com.amazonaws.iotdeviceadvisor#SuiteDefinitionConfiguration", + "traits": { + "smithy.api#documentation": "

Gets the suite configuration with GetSuiteDefinition API call.

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

Gets the timestamp of the time suite was created with GetSuiteDefinition API call.

" + } + }, + "lastModifiedAt": { + "target": "com.amazonaws.iotdeviceadvisor#Timestamp", + "traits": { + "smithy.api#documentation": "

Gets the timestamp of the time suite was modified with GetSuiteDefinition API call.

" + } + }, + "tags": { + "target": "com.amazonaws.iotdeviceadvisor#TagMap", + "traits": { + "smithy.api#documentation": "

Tags attached to the suite definition.

" + } + } + } + }, + "com.amazonaws.iotdeviceadvisor#GetSuiteRun": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotdeviceadvisor#GetSuiteRunRequest" + }, + "output": { + "target": "com.amazonaws.iotdeviceadvisor#GetSuiteRunResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotdeviceadvisor#InternalServerException" + }, + { + "target": "com.amazonaws.iotdeviceadvisor#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotdeviceadvisor#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets information about a Device Advisor test suite run.

", + "smithy.api#http": { + "method": "GET", + "uri": "/suiteDefinitions/{suiteDefinitionId}/suiteRuns/{suiteRunId}", + "code": 200 + } + } + }, + "com.amazonaws.iotdeviceadvisor#GetSuiteRunReport": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotdeviceadvisor#GetSuiteRunReportRequest" + }, + "output": { + "target": "com.amazonaws.iotdeviceadvisor#GetSuiteRunReportResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotdeviceadvisor#InternalServerException" + }, + { + "target": "com.amazonaws.iotdeviceadvisor#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotdeviceadvisor#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets a report download link for a successful Device Advisor qualifying test suite run.

", + "smithy.api#http": { + "method": "GET", + "uri": "/suiteDefinitions/{suiteDefinitionId}/suiteRuns/{suiteRunId}/report", + "code": 200 + } + } + }, + "com.amazonaws.iotdeviceadvisor#GetSuiteRunReportRequest": { + "type": "structure", + "members": { + "suiteDefinitionId": { + "target": "com.amazonaws.iotdeviceadvisor#UUID", + "traits": { + "smithy.api#documentation": "

Device Advisor suite definition Id.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "suiteRunId": { + "target": "com.amazonaws.iotdeviceadvisor#UUID", + "traits": { + "smithy.api#documentation": "

Device Advisor suite run Id.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotdeviceadvisor#GetSuiteRunReportResponse": { + "type": "structure", + "members": { + "qualificationReportDownloadUrl": { + "target": "com.amazonaws.iotdeviceadvisor#QualificationReportDownloadUrl", + "traits": { + "smithy.api#documentation": "

Gets the download URL of the qualification report.

" + } + } + } + }, + "com.amazonaws.iotdeviceadvisor#GetSuiteRunRequest": { + "type": "structure", + "members": { + "suiteDefinitionId": { + "target": "com.amazonaws.iotdeviceadvisor#UUID", + "traits": { + "smithy.api#documentation": "

Requests the information about Device Advisor test suite run based on suite definition Id.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "suiteRunId": { + "target": "com.amazonaws.iotdeviceadvisor#UUID", + "traits": { + "smithy.api#documentation": "

Requests the information about Device Advisor test suite run based on suite run Id.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotdeviceadvisor#GetSuiteRunResponse": { + "type": "structure", + "members": { + "suiteDefinitionId": { + "target": "com.amazonaws.iotdeviceadvisor#UUID", + "traits": { + "smithy.api#documentation": "

Gets the information about Device Advisor test suite run based on suite definition Id.

" + } + }, + "suiteDefinitionVersion": { + "target": "com.amazonaws.iotdeviceadvisor#SuiteDefinitionVersion", + "traits": { + "smithy.api#documentation": "

Gets the information about Device Advisor test suite run based on suite definition version.

" + } + }, + "suiteRunId": { + "target": "com.amazonaws.iotdeviceadvisor#UUID", + "traits": { + "smithy.api#documentation": "

Gets the information about Device Advisor test suite run based on suite run Id.

" + } + }, + "suiteRunArn": { + "target": "com.amazonaws.iotdeviceadvisor#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

The ARN of the suite run.

" + } + }, + "suiteRunConfiguration": { + "target": "com.amazonaws.iotdeviceadvisor#SuiteRunConfiguration", + "traits": { + "smithy.api#documentation": "

Gets the information about Device Advisor test suite run based on suite configuration.

" + } + }, + "testResult": { + "target": "com.amazonaws.iotdeviceadvisor#TestResult", + "traits": { + "smithy.api#documentation": "

Gets the information about Device Advisor test suite run based on test case runs.

" + } + }, + "startTime": { + "target": "com.amazonaws.iotdeviceadvisor#Timestamp", + "traits": { + "smithy.api#documentation": "

Gets the information about Device Advisor test suite run based on start time.

" + } + }, + "endTime": { + "target": "com.amazonaws.iotdeviceadvisor#Timestamp", + "traits": { + "smithy.api#documentation": "

Gets the information about Device Advisor test suite run based on end time.

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

Gets the information about Device Advisor test suite run based on its status.

" + } + }, + "errorReason": { + "target": "com.amazonaws.iotdeviceadvisor#ErrorReason", + "traits": { + "smithy.api#documentation": "

Gets the information about Device Advisor test suite run based on error.

" + } + }, + "tags": { + "target": "com.amazonaws.iotdeviceadvisor#TagMap", + "traits": { + "smithy.api#documentation": "

The tags attached to the suite run.

" + } + } + } + }, + "com.amazonaws.iotdeviceadvisor#GroupName": { + "type": "string" + }, + "com.amazonaws.iotdeviceadvisor#GroupResult": { + "type": "structure", + "members": { + "groupId": { + "target": "com.amazonaws.iotdeviceadvisor#UUID", + "traits": { + "smithy.api#documentation": "

Show Group Result Id.

" + } + }, + "groupName": { + "target": "com.amazonaws.iotdeviceadvisor#GroupName", + "traits": { + "smithy.api#documentation": "

Show Group Result Name.

" + } + }, + "tests": { + "target": "com.amazonaws.iotdeviceadvisor#TestCaseRuns", + "traits": { + "smithy.api#documentation": "

Show Group Result.

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

Show Group Result.

" + } + }, + "com.amazonaws.iotdeviceadvisor#GroupResultList": { + "type": "list", + "member": { + "target": "com.amazonaws.iotdeviceadvisor#GroupResult" + }, + "traits": { + "smithy.api#documentation": "

how Group Result list.

" + } + }, + "com.amazonaws.iotdeviceadvisor#IntendedForQualificationBoolean": { + "type": "boolean" + }, + "com.amazonaws.iotdeviceadvisor#InternalServerException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.iotdeviceadvisor#Message", + "traits": { + "smithy.api#documentation": "

Sends Internal Failure Exception message.

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

Sends Internal Failure Exception.

", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.iotdeviceadvisor#IotSenateService": { + "type": "service", + "version": "2020-09-18", + "operations": [ + { + "target": "com.amazonaws.iotdeviceadvisor#CreateSuiteDefinition" + }, + { + "target": "com.amazonaws.iotdeviceadvisor#DeleteSuiteDefinition" + }, + { + "target": "com.amazonaws.iotdeviceadvisor#GetSuiteDefinition" + }, + { + "target": "com.amazonaws.iotdeviceadvisor#GetSuiteRun" + }, + { + "target": "com.amazonaws.iotdeviceadvisor#GetSuiteRunReport" + }, + { + "target": "com.amazonaws.iotdeviceadvisor#ListSuiteDefinitions" + }, + { + "target": "com.amazonaws.iotdeviceadvisor#ListSuiteRuns" + }, + { + "target": "com.amazonaws.iotdeviceadvisor#ListTagsForResource" + }, + { + "target": "com.amazonaws.iotdeviceadvisor#ListTestCases" + }, + { + "target": "com.amazonaws.iotdeviceadvisor#StartSuiteRun" + }, + { + "target": "com.amazonaws.iotdeviceadvisor#TagResource" + }, + { + "target": "com.amazonaws.iotdeviceadvisor#UntagResource" + }, + { + "target": "com.amazonaws.iotdeviceadvisor#UpdateSuiteDefinition" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "IotDeviceAdvisor", + "arnNamespace": "iotdeviceadvisor", + "cloudFormationName": "IotDeviceAdvisor", + "cloudTrailEventSource": "iotdeviceadvisor.amazonaws.com", + "endpointPrefix": "api.iotdeviceadvisor" + }, + "aws.auth#sigv4": { + "name": "iotdeviceadvisor" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "

AWS IoT Core Device Advisor is a cloud-based, fully managed test capability for validating IoT devices during device software development. Device Advisor provides pre-built tests that you can use to validate IoT devices for reliable and secure connectivity with AWS IoT Core before deploying devices to production. By using Device Advisor, you can confirm that your devices can connect to AWS IoT Core, follow security best practices and, if applicable, receive software updates from IoT Device Management. You can also download signed qualification reports to submit to the AWS Partner Network to get your device qualified for the AWS Partner Device Catalog without the need to send your device in and wait for it to be tested.

", + "smithy.api#title": "AWS IoT Core Device Advisor" + } + }, + "com.amazonaws.iotdeviceadvisor#ListSuiteDefinitions": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotdeviceadvisor#ListSuiteDefinitionsRequest" + }, + "output": { + "target": "com.amazonaws.iotdeviceadvisor#ListSuiteDefinitionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotdeviceadvisor#InternalServerException" + }, + { + "target": "com.amazonaws.iotdeviceadvisor#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the Device Advisor test suites you have created.

", + "smithy.api#http": { + "method": "GET", + "uri": "/suiteDefinitions", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.iotdeviceadvisor#ListSuiteDefinitionsRequest": { + "type": "structure", + "members": { + "maxResults": { + "target": "com.amazonaws.iotdeviceadvisor#MaxResults", + "traits": { + "smithy.api#documentation": "

Request the list of all the Device Advisor test suites.

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

Requests the Device Advisor test suites next token.

", + "smithy.api#httpQuery": "nextToken" + } + } + } + }, + "com.amazonaws.iotdeviceadvisor#ListSuiteDefinitionsResponse": { + "type": "structure", + "members": { + "suiteDefinitionInformationList": { + "target": "com.amazonaws.iotdeviceadvisor#SuiteDefinitionInformationList", + "traits": { + "smithy.api#documentation": "

Lists test suite information using List suite definition.

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

Creates a Device Advisor test suite.

" + } + } + } + }, + "com.amazonaws.iotdeviceadvisor#ListSuiteRuns": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotdeviceadvisor#ListSuiteRunsRequest" + }, + "output": { + "target": "com.amazonaws.iotdeviceadvisor#ListSuiteRunsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotdeviceadvisor#InternalServerException" + }, + { + "target": "com.amazonaws.iotdeviceadvisor#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the runs of the specified Device Advisor test suite.\n You can list all runs of the test suite, or the runs of a specific version of the test suite.

", + "smithy.api#http": { + "method": "GET", + "uri": "/suiteRuns", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.iotdeviceadvisor#ListSuiteRunsRequest": { + "type": "structure", + "members": { + "suiteDefinitionId": { + "target": "com.amazonaws.iotdeviceadvisor#UUID", + "traits": { + "smithy.api#documentation": "

Lists the runs of the specified Device Advisor test suite based on suite definition Id.

", + "smithy.api#httpQuery": "suiteDefinitionId" + } + }, + "suiteDefinitionVersion": { + "target": "com.amazonaws.iotdeviceadvisor#SuiteDefinitionVersion", + "traits": { + "smithy.api#documentation": "

Lists the runs of the specified Device Advisor test suite based on suite definition version.

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

MaxResults for list suite run API request.

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

Next pagination token for list suite run request.

", + "smithy.api#httpQuery": "nextToken" + } + } + } + }, + "com.amazonaws.iotdeviceadvisor#ListSuiteRunsResponse": { + "type": "structure", + "members": { + "suiteRunsList": { + "target": "com.amazonaws.iotdeviceadvisor#SuiteRunsList", + "traits": { + "smithy.api#documentation": "

Lists the runs of the specified Device Advisor test suite.

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

Next pagination token for list suite run response.

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

Lists the tags attached to an IoT Device Advisor resource.

", + "smithy.api#http": { + "method": "GET", + "uri": "/tags/{resourceArn}", + "code": 200 + } + } + }, + "com.amazonaws.iotdeviceadvisor#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.iotdeviceadvisor#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

The ARN of the IoT Device Advisor resource.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotdeviceadvisor#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "tags": { + "target": "com.amazonaws.iotdeviceadvisor#TagMap", + "traits": { + "smithy.api#documentation": "

The tags attached to the IoT Device Advisor resource.

" + } + } + } + }, + "com.amazonaws.iotdeviceadvisor#ListTestCases": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotdeviceadvisor#ListTestCasesRequest" + }, + "output": { + "target": "com.amazonaws.iotdeviceadvisor#ListTestCasesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotdeviceadvisor#InternalServerException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all the test cases in the test suite.

", + "smithy.api#http": { + "method": "GET", + "uri": "/testCases", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.iotdeviceadvisor#ListTestCasesRequest": { + "type": "structure", + "members": { + "intendedForQualification": { + "target": "com.amazonaws.iotdeviceadvisor#IntendedForQualificationBoolean", + "traits": { + "smithy.api#documentation": "

Lists all the qualification test cases in the test suite.

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

Requests the test cases max results.

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

Requests the test cases next token.

", + "smithy.api#httpQuery": "nextToken" + } + } + } + }, + "com.amazonaws.iotdeviceadvisor#ListTestCasesResponse": { + "type": "structure", + "members": { + "categories": { + "target": "com.amazonaws.iotdeviceadvisor#TestCategory", + "traits": { + "smithy.api#documentation": "

Gets the category of test case.

" + } + }, + "rootGroupConfiguration": { + "target": "com.amazonaws.iotdeviceadvisor#TestConfiguration", + "traits": { + "smithy.api#documentation": "

Gets the configuration of root test group.

" + } + }, + "groupConfiguration": { + "target": "com.amazonaws.iotdeviceadvisor#TestConfiguration", + "traits": { + "smithy.api#documentation": "

Gets the configuration of test group.

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

Test cases next token response.

" + } + } + } + }, + "com.amazonaws.iotdeviceadvisor#LogUrl": { + "type": "string" + }, + "com.amazonaws.iotdeviceadvisor#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.iotdeviceadvisor#Message": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "com.amazonaws.iotdeviceadvisor#QualificationReportDownloadUrl": { + "type": "string" + }, + "com.amazonaws.iotdeviceadvisor#ResourceNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.iotdeviceadvisor#Message", + "traits": { + "smithy.api#documentation": "

Sends Resource Not Found Exception message.

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

Sends Resource Not Found Exception.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.iotdeviceadvisor#RootGroup": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "com.amazonaws.iotdeviceadvisor#SelectedTestList": { + "type": "list", + "member": { + "target": "com.amazonaws.iotdeviceadvisor#UUID" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.iotdeviceadvisor#StartSuiteRun": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotdeviceadvisor#StartSuiteRunRequest" + }, + "output": { + "target": "com.amazonaws.iotdeviceadvisor#StartSuiteRunResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotdeviceadvisor#ConflictException" + }, + { + "target": "com.amazonaws.iotdeviceadvisor#InternalServerException" + }, + { + "target": "com.amazonaws.iotdeviceadvisor#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Starts a Device Advisor test suite run.

", + "smithy.api#http": { + "method": "POST", + "uri": "/suiteDefinitions/{suiteDefinitionId}/suiteRuns", + "code": 200 + } + } + }, + "com.amazonaws.iotdeviceadvisor#StartSuiteRunRequest": { + "type": "structure", + "members": { + "suiteDefinitionId": { + "target": "com.amazonaws.iotdeviceadvisor#UUID", + "traits": { + "smithy.api#documentation": "

Request to start suite run based on suite definition Id.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "suiteDefinitionVersion": { + "target": "com.amazonaws.iotdeviceadvisor#SuiteDefinitionVersion", + "traits": { + "smithy.api#documentation": "

Request to start suite run based on suite definition version.

" + } + }, + "suiteRunConfiguration": { + "target": "com.amazonaws.iotdeviceadvisor#SuiteRunConfiguration", + "traits": { + "smithy.api#documentation": "

Request to start suite run based on suite configuration.

" + } + }, + "tags": { + "target": "com.amazonaws.iotdeviceadvisor#TagMap", + "traits": { + "smithy.api#documentation": "

The tags to be attached to the suite run.

" + } + } + } + }, + "com.amazonaws.iotdeviceadvisor#StartSuiteRunResponse": { + "type": "structure", + "members": { + "suiteRunId": { + "target": "com.amazonaws.iotdeviceadvisor#UUID", + "traits": { + "smithy.api#documentation": "

Starts a Device Advisor test suite run based on suite Run Id.

" + } + }, + "suiteRunArn": { + "target": "com.amazonaws.iotdeviceadvisor#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

Starts a Device Advisor test suite run based on suite run arn.

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

Starts a Device Advisor test suite run based on suite create time.

" + } + } + } + }, + "com.amazonaws.iotdeviceadvisor#Status": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PASS", + "name": "PASS" + }, + { + "value": "FAIL", + "name": "FAIL" + }, + { + "value": "CANCELED", + "name": "CANCELED" + }, + { + "value": "PENDING", + "name": "PENDING" + }, + { + "value": "RUNNING", + "name": "RUNNING" + }, + { + "value": "PASS_WITH_WARNINGS", + "name": "PASS_WITH_WARNINGS" + }, + { + "value": "ERROR", + "name": "ERROR" + } + ] + } + }, + "com.amazonaws.iotdeviceadvisor#String128": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.iotdeviceadvisor#String256": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.iotdeviceadvisor#SuiteDefinitionConfiguration": { + "type": "structure", + "members": { + "suiteDefinitionName": { + "target": "com.amazonaws.iotdeviceadvisor#SuiteDefinitionName", + "traits": { + "smithy.api#documentation": "

Gets Suite Definition Configuration name.

" + } + }, + "devices": { + "target": "com.amazonaws.iotdeviceadvisor#DeviceUnderTestList", + "traits": { + "smithy.api#documentation": "

Gets the devices configured.

" + } + }, + "intendedForQualification": { + "target": "com.amazonaws.iotdeviceadvisor#IntendedForQualificationBoolean", + "traits": { + "smithy.api#documentation": "

Gets the tests intended for qualification in a suite.

" + } + }, + "rootGroup": { + "target": "com.amazonaws.iotdeviceadvisor#RootGroup", + "traits": { + "smithy.api#documentation": "

Gets test suite root group.

" + } + }, + "devicePermissionRoleArn": { + "target": "com.amazonaws.iotdeviceadvisor#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

Gets device permission arn.

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

Gets Suite Definition Configuration.

" + } + }, + "com.amazonaws.iotdeviceadvisor#SuiteDefinitionInformation": { + "type": "structure", + "members": { + "suiteDefinitionId": { + "target": "com.amazonaws.iotdeviceadvisor#UUID", + "traits": { + "smithy.api#documentation": "

Get suite definition Id.

" + } + }, + "suiteDefinitionName": { + "target": "com.amazonaws.iotdeviceadvisor#SuiteDefinitionName", + "traits": { + "smithy.api#documentation": "

Get test suite name.

" + } + }, + "defaultDevices": { + "target": "com.amazonaws.iotdeviceadvisor#DeviceUnderTestList", + "traits": { + "smithy.api#documentation": "

Specifies the devices under test.

" + } + }, + "intendedForQualification": { + "target": "com.amazonaws.iotdeviceadvisor#IntendedForQualificationBoolean", + "traits": { + "smithy.api#documentation": "

Gets the test suites which will be used for qualification.

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

Gets the information of when the test suite was created.

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

Get suite definition information.

" + } + }, + "com.amazonaws.iotdeviceadvisor#SuiteDefinitionInformationList": { + "type": "list", + "member": { + "target": "com.amazonaws.iotdeviceadvisor#SuiteDefinitionInformation" + } + }, + "com.amazonaws.iotdeviceadvisor#SuiteDefinitionName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.iotdeviceadvisor#SuiteDefinitionVersion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 255 + } + } + }, + "com.amazonaws.iotdeviceadvisor#SuiteRunConfiguration": { + "type": "structure", + "members": { + "primaryDevice": { + "target": "com.amazonaws.iotdeviceadvisor#DeviceUnderTest", + "traits": { + "smithy.api#documentation": "

Gets the primary device for suite run.

" + } + }, + "secondaryDevice": { + "target": "com.amazonaws.iotdeviceadvisor#DeviceUnderTest", + "traits": { + "smithy.api#documentation": "

Gets the secondary device for suite run.

" + } + }, + "selectedTestList": { + "target": "com.amazonaws.iotdeviceadvisor#SelectedTestList", + "traits": { + "smithy.api#documentation": "

Gets test case list.

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

Gets suite run configuration.

" + } + }, + "com.amazonaws.iotdeviceadvisor#SuiteRunInformation": { + "type": "structure", + "members": { + "suiteDefinitionId": { + "target": "com.amazonaws.iotdeviceadvisor#UUID", + "traits": { + "smithy.api#documentation": "

Get suite run information based on suite definition Id.

" + } + }, + "suiteDefinitionVersion": { + "target": "com.amazonaws.iotdeviceadvisor#SuiteDefinitionVersion", + "traits": { + "smithy.api#documentation": "

Get suite run information based on suite definition version.

" + } + }, + "suiteDefinitionName": { + "target": "com.amazonaws.iotdeviceadvisor#SuiteDefinitionName", + "traits": { + "smithy.api#documentation": "

Get suite run information based on suite definition name.

" + } + }, + "suiteRunId": { + "target": "com.amazonaws.iotdeviceadvisor#UUID", + "traits": { + "smithy.api#documentation": "

Get suite run information based on suite run Id.

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

Get suite run information based on time suite was created.

" + } + }, + "startedAt": { + "target": "com.amazonaws.iotdeviceadvisor#Timestamp", + "traits": { + "smithy.api#documentation": "

Get suite run information based on start time of the run.

" + } + }, + "endAt": { + "target": "com.amazonaws.iotdeviceadvisor#Timestamp", + "traits": { + "smithy.api#documentation": "

Get suite run information based on end time of the run.

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

Get suite run information based on test run status.

" + } + }, + "passed": { + "target": "com.amazonaws.iotdeviceadvisor#SuiteRunResultCount", + "traits": { + "smithy.api#documentation": "

Get suite run information based on result of the test suite run.

" + } + }, + "failed": { + "target": "com.amazonaws.iotdeviceadvisor#SuiteRunResultCount", + "traits": { + "smithy.api#documentation": "

Get suite run information based on result of the test suite run.

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

Get suite run information.

" + } + }, + "com.amazonaws.iotdeviceadvisor#SuiteRunResultCount": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 500 + } + } + }, + "com.amazonaws.iotdeviceadvisor#SuiteRunStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PASS", + "name": "PASS" + }, + { + "value": "FAIL", + "name": "FAIL" + }, + { + "value": "CANCELED", + "name": "CANCELED" + }, + { + "value": "PENDING", + "name": "PENDING" + }, + { + "value": "RUNNING", + "name": "RUNNING" + }, + { + "value": "PASS_WITH_WARNINGS", + "name": "PASS_WITH_WARNINGS" + }, + { + "value": "ERROR", + "name": "ERROR" + } + ] + } + }, + "com.amazonaws.iotdeviceadvisor#SuiteRunsList": { + "type": "list", + "member": { + "target": "com.amazonaws.iotdeviceadvisor#SuiteRunInformation" + } + }, + "com.amazonaws.iotdeviceadvisor#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.iotdeviceadvisor#String128" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.iotdeviceadvisor#TagMap": { + "type": "map", + "key": { + "target": "com.amazonaws.iotdeviceadvisor#String128" + }, + "value": { + "target": "com.amazonaws.iotdeviceadvisor#String256" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.iotdeviceadvisor#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotdeviceadvisor#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.iotdeviceadvisor#TagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotdeviceadvisor#InternalServerException" + }, + { + "target": "com.amazonaws.iotdeviceadvisor#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotdeviceadvisor#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Adds to and modifies existing tags of an IoT Device Advisor resource.

", + "smithy.api#http": { + "method": "POST", + "uri": "/tags/{resourceArn}", + "code": 200 + } + } + }, + "com.amazonaws.iotdeviceadvisor#TagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.iotdeviceadvisor#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

The resource ARN of an IoT Device Advisor resource.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.iotdeviceadvisor#TagMap", + "traits": { + "smithy.api#documentation": "

The tags to be attached to the IoT Device Advisor resource.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotdeviceadvisor#TagResourceResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.iotdeviceadvisor#TestCase": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.iotdeviceadvisor#TestCaseName", + "traits": { + "smithy.api#documentation": "

Shows test case name.

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

Shows test case configuration.

" + } + }, + "test": { + "target": "com.amazonaws.iotdeviceadvisor#TestCaseDefinition", + "traits": { + "smithy.api#documentation": "

Specifies a test.

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

Shows tests in a test group.

" + } + }, + "com.amazonaws.iotdeviceadvisor#TestCaseCategory": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.iotdeviceadvisor#CategoryName", + "traits": { + "smithy.api#documentation": "

Lists all the tests name in the specified category.

" + } + }, + "tests": { + "target": "com.amazonaws.iotdeviceadvisor#TestCaseList", + "traits": { + "smithy.api#documentation": "

Lists all the tests in the specified category.

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

Gets the test case category.

" + } + }, + "com.amazonaws.iotdeviceadvisor#TestCaseDefinition": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.iotdeviceadvisor#TestCaseName", + "traits": { + "smithy.api#documentation": "

Provides test case definition Id.

" + } + }, + "testCaseVersion": { + "target": "com.amazonaws.iotdeviceadvisor#TestCaseVersion", + "traits": { + "smithy.api#documentation": "

Provides test case definition version.

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

Provides test case definition.

" + } + }, + "com.amazonaws.iotdeviceadvisor#TestCaseDefinitionName": { + "type": "string" + }, + "com.amazonaws.iotdeviceadvisor#TestCaseList": { + "type": "list", + "member": { + "target": "com.amazonaws.iotdeviceadvisor#TestCase" + } + }, + "com.amazonaws.iotdeviceadvisor#TestCaseName": { + "type": "string" + }, + "com.amazonaws.iotdeviceadvisor#TestCaseRun": { + "type": "structure", + "members": { + "testCaseRunId": { + "target": "com.amazonaws.iotdeviceadvisor#UUID", + "traits": { + "smithy.api#documentation": "

Provides test case run Id.

" + } + }, + "testCaseDefinitionId": { + "target": "com.amazonaws.iotdeviceadvisor#UUID", + "traits": { + "smithy.api#documentation": "

Provides test case run definition Id.

" + } + }, + "testCaseDefinitionName": { + "target": "com.amazonaws.iotdeviceadvisor#TestCaseDefinitionName", + "traits": { + "smithy.api#documentation": "

Provides test case run definition Name.

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

Provides test case run status.

" + } + }, + "startTime": { + "target": "com.amazonaws.iotdeviceadvisor#Timestamp", + "traits": { + "smithy.api#documentation": "

Provides test case run start time.

" + } + }, + "endTime": { + "target": "com.amazonaws.iotdeviceadvisor#Timestamp", + "traits": { + "smithy.api#documentation": "

Provides test case run end time.

" + } + }, + "logUrl": { + "target": "com.amazonaws.iotdeviceadvisor#LogUrl", + "traits": { + "smithy.api#documentation": "

Provides test case run log Url.

" + } + }, + "warnings": { + "target": "com.amazonaws.iotdeviceadvisor#Warnings", + "traits": { + "smithy.api#documentation": "

Provides test case run warnings.

" + } + }, + "failure": { + "target": "com.amazonaws.iotdeviceadvisor#Failure", + "traits": { + "smithy.api#documentation": "

Provides test case run failure result.

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

Provides test case run.

" + } + }, + "com.amazonaws.iotdeviceadvisor#TestCaseRuns": { + "type": "list", + "member": { + "target": "com.amazonaws.iotdeviceadvisor#TestCaseRun" + }, + "traits": { + "smithy.api#documentation": "

Show each group result.

" + } + }, + "com.amazonaws.iotdeviceadvisor#TestCaseVersion": { + "type": "string" + }, + "com.amazonaws.iotdeviceadvisor#TestCategory": { + "type": "list", + "member": { + "target": "com.amazonaws.iotdeviceadvisor#TestCaseCategory" + } + }, + "com.amazonaws.iotdeviceadvisor#TestConfiguration": { + "type": "map", + "key": { + "target": "com.amazonaws.iotdeviceadvisor#ConfigString" + }, + "value": { + "target": "com.amazonaws.iotdeviceadvisor#ConfigString" + } + }, + "com.amazonaws.iotdeviceadvisor#TestResult": { + "type": "structure", + "members": { + "groups": { + "target": "com.amazonaws.iotdeviceadvisor#GroupResultList", + "traits": { + "smithy.api#documentation": "

Show each group of test results.

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

Show each group result.

" + } + }, + "com.amazonaws.iotdeviceadvisor#Timestamp": { + "type": "timestamp" + }, + "com.amazonaws.iotdeviceadvisor#Token": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2000 + } + } + }, + "com.amazonaws.iotdeviceadvisor#UUID": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 36, + "max": 36 + } + } + }, + "com.amazonaws.iotdeviceadvisor#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotdeviceadvisor#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.iotdeviceadvisor#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotdeviceadvisor#InternalServerException" + }, + { + "target": "com.amazonaws.iotdeviceadvisor#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotdeviceadvisor#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes tags from an IoT Device Advisor resource.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/tags/{resourceArn}", + "code": 200 + } + } + }, + "com.amazonaws.iotdeviceadvisor#UntagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.iotdeviceadvisor#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

The resource ARN of an IoT Device Advisor resource.

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

List of tag keys to remove from the IoT Device Advisor resource.

", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotdeviceadvisor#UntagResourceResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.iotdeviceadvisor#UpdateSuiteDefinition": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotdeviceadvisor#UpdateSuiteDefinitionRequest" + }, + "output": { + "target": "com.amazonaws.iotdeviceadvisor#UpdateSuiteDefinitionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotdeviceadvisor#InternalServerException" + }, + { + "target": "com.amazonaws.iotdeviceadvisor#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates a Device Advisor test suite.

", + "smithy.api#http": { + "method": "PATCH", + "uri": "/suiteDefinitions/{suiteDefinitionId}", + "code": 200 + } + } + }, + "com.amazonaws.iotdeviceadvisor#UpdateSuiteDefinitionRequest": { + "type": "structure", + "members": { + "suiteDefinitionId": { + "target": "com.amazonaws.iotdeviceadvisor#UUID", + "traits": { + "smithy.api#documentation": "

Updates a Device Advisor test suite with suite definition id.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "suiteDefinitionConfiguration": { + "target": "com.amazonaws.iotdeviceadvisor#SuiteDefinitionConfiguration", + "traits": { + "smithy.api#documentation": "

Updates a Device Advisor test suite with suite definition configuration.

" + } + } + } + }, + "com.amazonaws.iotdeviceadvisor#UpdateSuiteDefinitionResponse": { + "type": "structure", + "members": { + "suiteDefinitionId": { + "target": "com.amazonaws.iotdeviceadvisor#UUID", + "traits": { + "smithy.api#documentation": "

Updates a Device Advisor test suite with suite UUID.

" + } + }, + "suiteDefinitionArn": { + "target": "com.amazonaws.iotdeviceadvisor#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

Updates a Device Advisor test suite with Amazon Resource name.

" + } + }, + "suiteDefinitionName": { + "target": "com.amazonaws.iotdeviceadvisor#SuiteDefinitionName", + "traits": { + "smithy.api#documentation": "

Updates a Device Advisor test suite with suite definition name.

" + } + }, + "suiteDefinitionVersion": { + "target": "com.amazonaws.iotdeviceadvisor#SuiteDefinitionVersion", + "traits": { + "smithy.api#documentation": "

Updates a Device Advisor test suite with suite definition version.

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

Updates a Device Advisor test suite with TimeStamp of when it was created.

" + } + }, + "lastUpdatedAt": { + "target": "com.amazonaws.iotdeviceadvisor#Timestamp", + "traits": { + "smithy.api#documentation": "

Updates a Device Advisor test suite with TimeStamp of when it was updated.

" + } + } + } + }, + "com.amazonaws.iotdeviceadvisor#ValidationException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.iotdeviceadvisor#Message", + "traits": { + "smithy.api#documentation": "

Sends invalid request exception message.

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

Sends invalid request exception.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.iotdeviceadvisor#Warnings": { + "type": "string" + } + } +} diff --git a/codegen/sdk-codegen/aws-models/iotfleethub.2020-11-03.json b/codegen/sdk-codegen/aws-models/iotfleethub.2020-11-03.json new file mode 100644 index 00000000000..ed94d45deed --- /dev/null +++ b/codegen/sdk-codegen/aws-models/iotfleethub.2020-11-03.json @@ -0,0 +1,925 @@ +{ + "smithy": "1.0", + "metadata": { + "suppressions": [ + { + "id": "HttpMethodSemantics", + "namespace": "*" + }, + { + "id": "HttpResponseCodeSemantics", + "namespace": "*" + }, + { + "id": "PaginatedTrait", + "namespace": "*" + }, + { + "id": "HttpHeaderTrait", + "namespace": "*" + }, + { + "id": "HttpUriConflict", + "namespace": "*" + }, + { + "id": "Service", + "namespace": "*" + } + ] + }, + "shapes": { + "com.amazonaws.iotfleethub#AWSIoTFleetHub": { + "type": "service", + "version": "2020-11-03", + "operations": [ + { + "target": "com.amazonaws.iotfleethub#CreateApplication" + }, + { + "target": "com.amazonaws.iotfleethub#DeleteApplication" + }, + { + "target": "com.amazonaws.iotfleethub#DescribeApplication" + }, + { + "target": "com.amazonaws.iotfleethub#ListApplications" + }, + { + "target": "com.amazonaws.iotfleethub#ListTagsForResource" + }, + { + "target": "com.amazonaws.iotfleethub#TagResource" + }, + { + "target": "com.amazonaws.iotfleethub#UntagResource" + }, + { + "target": "com.amazonaws.iotfleethub#UpdateApplication" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "IoTFleetHub", + "arnNamespace": "iotfleethub", + "cloudFormationName": "IoTFleetHub", + "cloudTrailEventSource": "iotfleethub.amazonaws.com", + "endpointPrefix": "api.fleethub.iot" + }, + "aws.auth#sigv4": { + "name": "iotfleethub" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "

With Fleet Hub for AWS IoT Device Management you can build stand-alone web applications for monitoring the health of your device fleets.

\n \n

Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.

\n ", + "smithy.api#title": "AWS IoT Fleet Hub" + } + }, + "com.amazonaws.iotfleethub#ApplicationState": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CREATING", + "name": "CREATING" + }, + { + "value": "DELETING", + "name": "DELETING" + }, + { + "value": "ACTIVE", + "name": "ACTIVE" + }, + { + "value": "CREATE_FAILED", + "name": "CREATE_FAILED" + }, + { + "value": "DELETE_FAILED", + "name": "DELETE_FAILED" + } + ] + } + }, + "com.amazonaws.iotfleethub#ApplicationSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.iotfleethub#ApplicationSummary" + } + }, + "com.amazonaws.iotfleethub#ApplicationSummary": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.iotfleethub#Id", + "traits": { + "smithy.api#documentation": "

The unique Id of the web application.

", + "smithy.api#required": {} + } + }, + "applicationName": { + "target": "com.amazonaws.iotfleethub#Name", + "traits": { + "smithy.api#documentation": "

The name of the web application.

", + "smithy.api#required": {} + } + }, + "applicationDescription": { + "target": "com.amazonaws.iotfleethub#Description", + "traits": { + "smithy.api#documentation": "

An optional description of the web application.

" + } + }, + "applicationUrl": { + "target": "com.amazonaws.iotfleethub#Url", + "traits": { + "smithy.api#documentation": "

The URL of the web application.

", + "smithy.api#required": {} + } + }, + "applicationCreationDate": { + "target": "com.amazonaws.iotfleethub#Timestamp", + "traits": { + "smithy.api#documentation": "

The date (in Unix epoch time) when the web application was created.

" + } + }, + "applicationLastUpdateDate": { + "target": "com.amazonaws.iotfleethub#Timestamp", + "traits": { + "smithy.api#documentation": "

The date (in Unix epoch time) when the web application was last updated.

" + } + }, + "applicationState": { + "target": "com.amazonaws.iotfleethub#ApplicationState", + "traits": { + "smithy.api#documentation": "

The current state of the web application.

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

A summary of information about a AWS IoT Device Management web application.

\n \n

Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.

\n " + } + }, + "com.amazonaws.iotfleethub#Arn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1600 + }, + "smithy.api#pattern": "^arn:[!-~]+$" + } + }, + "com.amazonaws.iotfleethub#ClientRequestToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-_]+$" + } + }, + "com.amazonaws.iotfleethub#ConflictException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.iotfleethub#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The request conflicts with the current state of the resource.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.iotfleethub#CreateApplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotfleethub#CreateApplicationRequest" + }, + "output": { + "target": "com.amazonaws.iotfleethub#CreateApplicationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotfleethub#InternalFailureException" + }, + { + "target": "com.amazonaws.iotfleethub#InvalidRequestException" + }, + { + "target": "com.amazonaws.iotfleethub#LimitExceededException" + }, + { + "target": "com.amazonaws.iotfleethub#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a Fleet Hub for AWS IoT Device Management web application.

\n \n

Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.

\n ", + "smithy.api#http": { + "method": "POST", + "uri": "/applications", + "code": 201 + } + } + }, + "com.amazonaws.iotfleethub#CreateApplicationRequest": { + "type": "structure", + "members": { + "applicationName": { + "target": "com.amazonaws.iotfleethub#Name", + "traits": { + "smithy.api#documentation": "

The name of the web application.

", + "smithy.api#required": {} + } + }, + "applicationDescription": { + "target": "com.amazonaws.iotfleethub#Description", + "traits": { + "smithy.api#documentation": "

An optional description of the web application.

" + } + }, + "clientToken": { + "target": "com.amazonaws.iotfleethub#ClientRequestToken", + "traits": { + "smithy.api#documentation": "

A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. \n Don't reuse this client token if a new idempotent request is required.

", + "smithy.api#idempotencyToken": {} + } + }, + "roleArn": { + "target": "com.amazonaws.iotfleethub#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the role that the web application assumes when it interacts with AWS IoT Core.

\n \n

The name of the role must be in the form AWSIotFleetHub_random_string\n .

\n ", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.iotfleethub#TagMap", + "traits": { + "smithy.api#documentation": "

A set of key/value pairs that you can use to manage the web application resource.

" + } + } + } + }, + "com.amazonaws.iotfleethub#CreateApplicationResponse": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.iotfleethub#Id", + "traits": { + "smithy.api#documentation": "

The unique Id of the web application.

", + "smithy.api#required": {} + } + }, + "applicationArn": { + "target": "com.amazonaws.iotfleethub#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the web application.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotfleethub#DeleteApplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotfleethub#DeleteApplicationRequest" + }, + "output": { + "target": "com.amazonaws.iotfleethub#DeleteApplicationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotfleethub#InternalFailureException" + }, + { + "target": "com.amazonaws.iotfleethub#InvalidRequestException" + }, + { + "target": "com.amazonaws.iotfleethub#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotfleethub#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a Fleet Hub for AWS IoT Device Management web application.

\n \n

Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.

\n ", + "smithy.api#http": { + "method": "DELETE", + "uri": "/applications/{applicationId}", + "code": 204 + } + } + }, + "com.amazonaws.iotfleethub#DeleteApplicationRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.iotfleethub#Id", + "traits": { + "smithy.api#documentation": "

The unique Id of the web application.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.iotfleethub#ClientRequestToken", + "traits": { + "smithy.api#documentation": "

A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. \n Don't reuse this client token if a new idempotent request is required.

", + "smithy.api#httpQuery": "clientToken", + "smithy.api#idempotencyToken": {} + } + } + } + }, + "com.amazonaws.iotfleethub#DeleteApplicationResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.iotfleethub#DescribeApplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotfleethub#DescribeApplicationRequest" + }, + "output": { + "target": "com.amazonaws.iotfleethub#DescribeApplicationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotfleethub#InternalFailureException" + }, + { + "target": "com.amazonaws.iotfleethub#InvalidRequestException" + }, + { + "target": "com.amazonaws.iotfleethub#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotfleethub#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets information about a Fleet Hub for AWS IoT Device Management web application.

\n \n

Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/applications/{applicationId}", + "code": 200 + } + } + }, + "com.amazonaws.iotfleethub#DescribeApplicationRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.iotfleethub#Id", + "traits": { + "smithy.api#documentation": "

The unique Id of the web application.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotfleethub#DescribeApplicationResponse": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.iotfleethub#Id", + "traits": { + "smithy.api#documentation": "

The unique Id of the web application.

", + "smithy.api#required": {} + } + }, + "applicationArn": { + "target": "com.amazonaws.iotfleethub#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the web application.

", + "smithy.api#required": {} + } + }, + "applicationName": { + "target": "com.amazonaws.iotfleethub#Name", + "traits": { + "smithy.api#documentation": "

The name of the web application.

", + "smithy.api#required": {} + } + }, + "applicationDescription": { + "target": "com.amazonaws.iotfleethub#Description", + "traits": { + "smithy.api#documentation": "

An optional description of the web application.

" + } + }, + "applicationUrl": { + "target": "com.amazonaws.iotfleethub#Url", + "traits": { + "smithy.api#documentation": "

The URL of the web application.

", + "smithy.api#required": {} + } + }, + "applicationState": { + "target": "com.amazonaws.iotfleethub#ApplicationState", + "traits": { + "smithy.api#documentation": "

The current state of the web application.

", + "smithy.api#required": {} + } + }, + "applicationCreationDate": { + "target": "com.amazonaws.iotfleethub#Timestamp", + "traits": { + "smithy.api#documentation": "

The date (in Unix epoch time) when the application was created.

", + "smithy.api#required": {} + } + }, + "applicationLastUpdateDate": { + "target": "com.amazonaws.iotfleethub#Timestamp", + "traits": { + "smithy.api#documentation": "

The date (in Unix epoch time) when the application was last updated.

", + "smithy.api#required": {} + } + }, + "roleArn": { + "target": "com.amazonaws.iotfleethub#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the role that the web application assumes when it interacts with AWS IoT Core.

", + "smithy.api#required": {} + } + }, + "ssoClientId": { + "target": "com.amazonaws.iotfleethub#SsoClientId", + "traits": { + "smithy.api#documentation": "

The Id of the single sign-on client that you use to authenticate and authorize users on the web application.

" + } + }, + "errorMessage": { + "target": "com.amazonaws.iotfleethub#ErrorMessage", + "traits": { + "smithy.api#documentation": "

A message indicating why the DescribeApplication API failed.

" + } + }, + "tags": { + "target": "com.amazonaws.iotfleethub#TagMap", + "traits": { + "smithy.api#documentation": "

A set of key/value pairs that you can use to manage the web application resource.

" + } + } + } + }, + "com.amazonaws.iotfleethub#Description": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^[ -~]*$" + } + }, + "com.amazonaws.iotfleethub#ErrorMessage": { + "type": "string" + }, + "com.amazonaws.iotfleethub#Id": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 36, + "max": 36 + }, + "smithy.api#pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" + } + }, + "com.amazonaws.iotfleethub#InternalFailureException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.iotfleethub#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

An unexpected error has occurred.

", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.iotfleethub#InvalidRequestException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.iotfleethub#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The request is not valid.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.iotfleethub#LimitExceededException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.iotfleethub#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

A limit has been exceeded.

", + "smithy.api#error": "client", + "smithy.api#httpError": 410 + } + }, + "com.amazonaws.iotfleethub#ListApplications": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotfleethub#ListApplicationsRequest" + }, + "output": { + "target": "com.amazonaws.iotfleethub#ListApplicationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotfleethub#InternalFailureException" + }, + { + "target": "com.amazonaws.iotfleethub#InvalidRequestException" + }, + { + "target": "com.amazonaws.iotfleethub#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets a list of Fleet Hub for AWS IoT Device Management web applications for the current account.

\n \n

Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/applications", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken" + } + } + }, + "com.amazonaws.iotfleethub#ListApplicationsRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.iotfleethub#NextToken", + "traits": { + "smithy.api#documentation": "

A token used to get the next set of results.

", + "smithy.api#httpQuery": "nextToken" + } + } + } + }, + "com.amazonaws.iotfleethub#ListApplicationsResponse": { + "type": "structure", + "members": { + "applicationSummaries": { + "target": "com.amazonaws.iotfleethub#ApplicationSummaries", + "traits": { + "smithy.api#documentation": "

An array of objects that provide summaries of information about the web applications in the list.

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

A token used to get the next set of results.

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

Lists the tags for the specified resource.

\n \n

Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/tags/{resourceArn}", + "code": 200 + } + } + }, + "com.amazonaws.iotfleethub#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.iotfleethub#ResourceArn", + "traits": { + "smithy.api#documentation": "

The ARN of the resource.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotfleethub#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "tags": { + "target": "com.amazonaws.iotfleethub#TagMap", + "traits": { + "smithy.api#documentation": "

The list of tags assigned to the resource.

" + } + } + } + }, + "com.amazonaws.iotfleethub#Name": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[ -~]*$" + } + }, + "com.amazonaws.iotfleethub#NextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^[A-Za-z0-9+/=]+$" + } + }, + "com.amazonaws.iotfleethub#ResourceArn": { + "type": "string" + }, + "com.amazonaws.iotfleethub#ResourceNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.iotfleethub#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The specified resource does not exist.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.iotfleethub#SsoClientId": { + "type": "string" + }, + "com.amazonaws.iotfleethub#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + } + }, + "com.amazonaws.iotfleethub#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.iotfleethub#TagKey" + } + }, + "com.amazonaws.iotfleethub#TagMap": { + "type": "map", + "key": { + "target": "com.amazonaws.iotfleethub#TagKey" + }, + "value": { + "target": "com.amazonaws.iotfleethub#TagValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.iotfleethub#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotfleethub#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.iotfleethub#TagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotfleethub#InternalFailureException" + }, + { + "target": "com.amazonaws.iotfleethub#InvalidRequestException" + }, + { + "target": "com.amazonaws.iotfleethub#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Adds to or modifies the tags of the specified resource. Tags are metadata which can be used to manage a resource.

\n \n

Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.

\n ", + "smithy.api#http": { + "method": "POST", + "uri": "/tags/{resourceArn}", + "code": 200 + } + } + }, + "com.amazonaws.iotfleethub#TagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.iotfleethub#ResourceArn", + "traits": { + "smithy.api#documentation": "

The ARN of the resource.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.iotfleethub#TagMap", + "traits": { + "smithy.api#documentation": "

The new or modified tags for the resource.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotfleethub#TagResourceResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.iotfleethub#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.iotfleethub#ThrottlingException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.iotfleethub#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The rate exceeds the limit.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.iotfleethub#Timestamp": { + "type": "long" + }, + "com.amazonaws.iotfleethub#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotfleethub#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.iotfleethub#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotfleethub#InternalFailureException" + }, + { + "target": "com.amazonaws.iotfleethub#InvalidRequestException" + }, + { + "target": "com.amazonaws.iotfleethub#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes the specified tags (metadata) from the resource.

\n \n

Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.

\n ", + "smithy.api#http": { + "method": "DELETE", + "uri": "/tags/{resourceArn}", + "code": 200 + } + } + }, + "com.amazonaws.iotfleethub#UntagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.iotfleethub#ResourceArn", + "traits": { + "smithy.api#documentation": "

The ARN of the resource.

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

A list of the keys of the tags to be removed from the resource.

", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotfleethub#UntagResourceResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.iotfleethub#UpdateApplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotfleethub#UpdateApplicationRequest" + }, + "output": { + "target": "com.amazonaws.iotfleethub#UpdateApplicationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotfleethub#ConflictException" + }, + { + "target": "com.amazonaws.iotfleethub#InternalFailureException" + }, + { + "target": "com.amazonaws.iotfleethub#InvalidRequestException" + }, + { + "target": "com.amazonaws.iotfleethub#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotfleethub#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates information about a Fleet Hub for a AWS IoT Device Management web application.

\n \n

Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.

\n ", + "smithy.api#http": { + "method": "PATCH", + "uri": "/applications/{applicationId}", + "code": 202 + } + } + }, + "com.amazonaws.iotfleethub#UpdateApplicationRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.iotfleethub#Id", + "traits": { + "smithy.api#documentation": "

The unique Id of the web application.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "applicationName": { + "target": "com.amazonaws.iotfleethub#Name", + "traits": { + "smithy.api#documentation": "

The name of the web application.

" + } + }, + "applicationDescription": { + "target": "com.amazonaws.iotfleethub#Description", + "traits": { + "smithy.api#documentation": "

An optional description of the web application.

" + } + }, + "clientToken": { + "target": "com.amazonaws.iotfleethub#ClientRequestToken", + "traits": { + "smithy.api#documentation": "

A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. \n Don't reuse this client token if a new idempotent request is required.

", + "smithy.api#idempotencyToken": {} + } + } + } + }, + "com.amazonaws.iotfleethub#UpdateApplicationResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.iotfleethub#Url": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^https\\://\\S+$" + } + } + } +} diff --git a/codegen/sdk-codegen/aws-models/iotwireless.2020-11-22.json b/codegen/sdk-codegen/aws-models/iotwireless.2020-11-22.json new file mode 100644 index 00000000000..236e1a95e74 --- /dev/null +++ b/codegen/sdk-codegen/aws-models/iotwireless.2020-11-22.json @@ -0,0 +1,5916 @@ +{ + "smithy": "1.0", + "metadata": { + "suppressions": [ + { + "id": "HttpMethodSemantics", + "namespace": "*" + }, + { + "id": "HttpResponseCodeSemantics", + "namespace": "*" + }, + { + "id": "PaginatedTrait", + "namespace": "*" + }, + { + "id": "HttpHeaderTrait", + "namespace": "*" + }, + { + "id": "HttpUriConflict", + "namespace": "*" + }, + { + "id": "Service", + "namespace": "*" + } + ] + }, + "shapes": { + "com.amazonaws.iotwireless#AbpV1_0_x": { + "type": "structure", + "members": { + "DevAddr": { + "target": "com.amazonaws.iotwireless#DevAddr", + "traits": { + "smithy.api#documentation": "

The DevAddr value.

" + } + }, + "SessionKeys": { + "target": "com.amazonaws.iotwireless#SessionKeysAbpV1_0_x", + "traits": { + "smithy.api#documentation": "

Session keys for ABP v1.0.x

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

ABP device object for LoRaWAN specification v1.0.x

" + } + }, + "com.amazonaws.iotwireless#AbpV1_1": { + "type": "structure", + "members": { + "DevAddr": { + "target": "com.amazonaws.iotwireless#DevAddr", + "traits": { + "smithy.api#documentation": "

The DevAddr value.

" + } + }, + "SessionKeys": { + "target": "com.amazonaws.iotwireless#SessionKeysAbpV1_1", + "traits": { + "smithy.api#documentation": "

Session keys for ABP v1.1

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

ABP device object for LoRaWAN specification v1.1

" + } + }, + "com.amazonaws.iotwireless#AccessDeniedException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.iotwireless#Message" + } + }, + "traits": { + "smithy.api#documentation": "

User does not have permission to perform this action.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.iotwireless#AccountLinked": { + "type": "boolean" + }, + "com.amazonaws.iotwireless#AddGwMetadata": { + "type": "boolean" + }, + "com.amazonaws.iotwireless#AmazonId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + } + } + }, + "com.amazonaws.iotwireless#AmazonResourceName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1011 + } + } + }, + "com.amazonaws.iotwireless#AppEui": { + "type": "string", + "traits": { + "smithy.api#pattern": "[a-fA-F0-9]{16}" + } + }, + "com.amazonaws.iotwireless#AppKey": { + "type": "string", + "traits": { + "smithy.api#pattern": "[a-fA-F0-9]{32}" + } + }, + "com.amazonaws.iotwireless#AppSKey": { + "type": "string", + "traits": { + "smithy.api#pattern": "[a-fA-F0-9]{32}" + } + }, + "com.amazonaws.iotwireless#AppServerPrivateKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 4096 + }, + "smithy.api#pattern": "[a-fA-F0-9]{64}", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.iotwireless#AssociateAwsAccountWithPartnerAccount": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotwireless#AssociateAwsAccountWithPartnerAccountRequest" + }, + "output": { + "target": "com.amazonaws.iotwireless#AssociateAwsAccountWithPartnerAccountResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotwireless#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotwireless#ConflictException" + }, + { + "target": "com.amazonaws.iotwireless#InternalServerException" + }, + { + "target": "com.amazonaws.iotwireless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotwireless#ThrottlingException" + }, + { + "target": "com.amazonaws.iotwireless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Associates a partner account with your AWS account.

", + "smithy.api#http": { + "method": "POST", + "uri": "/partner-accounts", + "code": 200 + } + } + }, + "com.amazonaws.iotwireless#AssociateAwsAccountWithPartnerAccountRequest": { + "type": "structure", + "members": { + "Sidewalk": { + "target": "com.amazonaws.iotwireless#SidewalkAccountInfo", + "traits": { + "smithy.api#documentation": "

The Sidewalk account credentials.

", + "smithy.api#required": {} + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.iotwireless#ClientRequestToken", + "traits": { + "smithy.api#documentation": "

Each resource must have a unique client request token. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.

", + "smithy.api#idempotencyToken": {} + } + } + } + }, + "com.amazonaws.iotwireless#AssociateAwsAccountWithPartnerAccountResponse": { + "type": "structure", + "members": { + "Sidewalk": { + "target": "com.amazonaws.iotwireless#SidewalkAccountInfo", + "traits": { + "smithy.api#documentation": "

The Sidewalk account credentials.

" + } + } + } + }, + "com.amazonaws.iotwireless#AssociateWirelessDeviceWithThing": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotwireless#AssociateWirelessDeviceWithThingRequest" + }, + "output": { + "target": "com.amazonaws.iotwireless#AssociateWirelessDeviceWithThingResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotwireless#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotwireless#ConflictException" + }, + { + "target": "com.amazonaws.iotwireless#InternalServerException" + }, + { + "target": "com.amazonaws.iotwireless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotwireless#ThrottlingException" + }, + { + "target": "com.amazonaws.iotwireless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Associates a wireless device with a thing.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/wireless-devices/{Id}/thing", + "code": 204 + } + } + }, + "com.amazonaws.iotwireless#AssociateWirelessDeviceWithThingRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.iotwireless#WirelessDeviceId", + "traits": { + "smithy.api#documentation": "

The ID of the resource to update.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ThingArn": { + "target": "com.amazonaws.iotwireless#ThingArn", + "traits": { + "smithy.api#documentation": "

The ARN of the thing to associate with the wireless device.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotwireless#AssociateWirelessDeviceWithThingResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.iotwireless#AssociateWirelessGatewayWithCertificate": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotwireless#AssociateWirelessGatewayWithCertificateRequest" + }, + "output": { + "target": "com.amazonaws.iotwireless#AssociateWirelessGatewayWithCertificateResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotwireless#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotwireless#ConflictException" + }, + { + "target": "com.amazonaws.iotwireless#InternalServerException" + }, + { + "target": "com.amazonaws.iotwireless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotwireless#ThrottlingException" + }, + { + "target": "com.amazonaws.iotwireless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Associates a wireless gateway with a certificate.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/wireless-gateways/{Id}/certificate", + "code": 200 + } + } + }, + "com.amazonaws.iotwireless#AssociateWirelessGatewayWithCertificateRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.iotwireless#WirelessGatewayId", + "traits": { + "smithy.api#documentation": "

The ID of the resource to update.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "IotCertificateId": { + "target": "com.amazonaws.iotwireless#IotCertificateId", + "traits": { + "smithy.api#documentation": "

The ID of the certificate to associate with the wireless gateway.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotwireless#AssociateWirelessGatewayWithCertificateResponse": { + "type": "structure", + "members": { + "IotCertificateId": { + "target": "com.amazonaws.iotwireless#IotCertificateId", + "traits": { + "smithy.api#documentation": "

The ID of the certificate associated with the wireless gateway.

" + } + } + } + }, + "com.amazonaws.iotwireless#AssociateWirelessGatewayWithThing": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotwireless#AssociateWirelessGatewayWithThingRequest" + }, + "output": { + "target": "com.amazonaws.iotwireless#AssociateWirelessGatewayWithThingResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotwireless#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotwireless#ConflictException" + }, + { + "target": "com.amazonaws.iotwireless#InternalServerException" + }, + { + "target": "com.amazonaws.iotwireless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotwireless#ThrottlingException" + }, + { + "target": "com.amazonaws.iotwireless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Associates a wireless gateway with a thing.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/wireless-gateways/{Id}/thing", + "code": 204 + } + } + }, + "com.amazonaws.iotwireless#AssociateWirelessGatewayWithThingRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.iotwireless#WirelessGatewayId", + "traits": { + "smithy.api#documentation": "

The ID of the resource to update.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ThingArn": { + "target": "com.amazonaws.iotwireless#ThingArn", + "traits": { + "smithy.api#documentation": "

The ARN of the thing to associate with the wireless gateway.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotwireless#AssociateWirelessGatewayWithThingResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.iotwireless#AutoCreateTasks": { + "type": "boolean" + }, + "com.amazonaws.iotwireless#CertificatePEM": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 4096 + }, + "smithy.api#pattern": "[^-A-Za-z0-9+/=]|=[^=]|={3,}${1,4096}" + } + }, + "com.amazonaws.iotwireless#ChannelMask": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + } + } + }, + "com.amazonaws.iotwireless#ClassBTimeout": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 0, + "max": 1000 + } + } + }, + "com.amazonaws.iotwireless#ClassCTimeout": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 0, + "max": 1000 + } + } + }, + "com.amazonaws.iotwireless#ClientRequestToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-_]+$" + } + }, + "com.amazonaws.iotwireless#ConflictException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.iotwireless#Message" + }, + "ResourceId": { + "target": "com.amazonaws.iotwireless#ResourceId" + }, + "ResourceType": { + "target": "com.amazonaws.iotwireless#ResourceType" + } + }, + "traits": { + "smithy.api#documentation": "

Adding, updating, or deleting the resource can cause an inconsistent state.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.iotwireless#Crc": { + "type": "long", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1, + "max": 4294967295 + } + } + }, + "com.amazonaws.iotwireless#CreateDestination": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotwireless#CreateDestinationRequest" + }, + "output": { + "target": "com.amazonaws.iotwireless#CreateDestinationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotwireless#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotwireless#ConflictException" + }, + { + "target": "com.amazonaws.iotwireless#InternalServerException" + }, + { + "target": "com.amazonaws.iotwireless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotwireless#ThrottlingException" + }, + { + "target": "com.amazonaws.iotwireless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new destination that maps a device message to an AWS IoT rule.

", + "smithy.api#http": { + "method": "POST", + "uri": "/destinations", + "code": 201 + } + } + }, + "com.amazonaws.iotwireless#CreateDestinationRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.iotwireless#DestinationName", + "traits": { + "smithy.api#documentation": "

The name of the new resource.

", + "smithy.api#required": {} + } + }, + "ExpressionType": { + "target": "com.amazonaws.iotwireless#ExpressionType", + "traits": { + "smithy.api#documentation": "

The type of value in Expression.

", + "smithy.api#required": {} + } + }, + "Expression": { + "target": "com.amazonaws.iotwireless#Expression", + "traits": { + "smithy.api#documentation": "

The rule name or topic rule to send messages to.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.iotwireless#Description", + "traits": { + "smithy.api#documentation": "

The description of the new resource.

" + } + }, + "RoleArn": { + "target": "com.amazonaws.iotwireless#RoleArn", + "traits": { + "smithy.api#documentation": "

The ARN of the IAM Role that authorizes the destination.

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

The tags to attach to the new destination. Tags are metadata that can be used to manage a resource.

" + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.iotwireless#ClientRequestToken", + "traits": { + "smithy.api#documentation": "

Each resource must have a unique client request token. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.

", + "smithy.api#idempotencyToken": {} + } + } + } + }, + "com.amazonaws.iotwireless#CreateDestinationResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.iotwireless#DestinationArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name of the new resource.

" + } + }, + "Name": { + "target": "com.amazonaws.iotwireless#DestinationName", + "traits": { + "smithy.api#documentation": "

The name of the new resource.

" + } + } + } + }, + "com.amazonaws.iotwireless#CreateDeviceProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotwireless#CreateDeviceProfileRequest" + }, + "output": { + "target": "com.amazonaws.iotwireless#CreateDeviceProfileResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotwireless#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotwireless#ConflictException" + }, + { + "target": "com.amazonaws.iotwireless#InternalServerException" + }, + { + "target": "com.amazonaws.iotwireless#ThrottlingException" + }, + { + "target": "com.amazonaws.iotwireless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new device profile.

", + "smithy.api#http": { + "method": "POST", + "uri": "/device-profiles", + "code": 201 + } + } + }, + "com.amazonaws.iotwireless#CreateDeviceProfileRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.iotwireless#DeviceProfileName", + "traits": { + "smithy.api#documentation": "

The name of the new resource.

" + } + }, + "LoRaWAN": { + "target": "com.amazonaws.iotwireless#LoRaWANDeviceProfile", + "traits": { + "smithy.api#documentation": "

The device profile information to use to create the device profile.

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

The tags to attach to the new device profile Tags are metadata that can be used to manage a resource.

" + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.iotwireless#ClientRequestToken", + "traits": { + "smithy.api#documentation": "

Each resource must have a unique client request token. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.

", + "smithy.api#idempotencyToken": {} + } + } + } + }, + "com.amazonaws.iotwireless#CreateDeviceProfileResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.iotwireless#DeviceProfileArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name of the new resource.

" + } + }, + "Id": { + "target": "com.amazonaws.iotwireless#DeviceProfileId", + "traits": { + "smithy.api#documentation": "

The ID of the new device profile.

" + } + } + } + }, + "com.amazonaws.iotwireless#CreateServiceProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotwireless#CreateServiceProfileRequest" + }, + "output": { + "target": "com.amazonaws.iotwireless#CreateServiceProfileResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotwireless#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotwireless#ConflictException" + }, + { + "target": "com.amazonaws.iotwireless#InternalServerException" + }, + { + "target": "com.amazonaws.iotwireless#ThrottlingException" + }, + { + "target": "com.amazonaws.iotwireless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new service profile.

", + "smithy.api#http": { + "method": "POST", + "uri": "/service-profiles", + "code": 201 + } + } + }, + "com.amazonaws.iotwireless#CreateServiceProfileRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.iotwireless#ServiceProfileName", + "traits": { + "smithy.api#documentation": "

The name of the new resource.

" + } + }, + "LoRaWAN": { + "target": "com.amazonaws.iotwireless#LoRaWANServiceProfile", + "traits": { + "smithy.api#documentation": "

The service profile information to use to create the service profile.

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

The tags to attach to the new service profile. Tags are metadata that can be used to manage a resource.

" + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.iotwireless#ClientRequestToken", + "traits": { + "smithy.api#documentation": "

Each resource must have a unique client request token. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.

", + "smithy.api#idempotencyToken": {} + } + } + } + }, + "com.amazonaws.iotwireless#CreateServiceProfileResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.iotwireless#ServiceProfileArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name of the new resource.

" + } + }, + "Id": { + "target": "com.amazonaws.iotwireless#ServiceProfileId", + "traits": { + "smithy.api#documentation": "

The ID of the new service profile.

" + } + } + } + }, + "com.amazonaws.iotwireless#CreateWirelessDevice": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotwireless#CreateWirelessDeviceRequest" + }, + "output": { + "target": "com.amazonaws.iotwireless#CreateWirelessDeviceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotwireless#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotwireless#ConflictException" + }, + { + "target": "com.amazonaws.iotwireless#InternalServerException" + }, + { + "target": "com.amazonaws.iotwireless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotwireless#ThrottlingException" + }, + { + "target": "com.amazonaws.iotwireless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Provisions a wireless device.

", + "smithy.api#http": { + "method": "POST", + "uri": "/wireless-devices", + "code": 201 + } + } + }, + "com.amazonaws.iotwireless#CreateWirelessDeviceRequest": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.iotwireless#WirelessDeviceType", + "traits": { + "smithy.api#documentation": "

The wireless device type.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.iotwireless#WirelessDeviceName", + "traits": { + "smithy.api#documentation": "

The name of the new resource.

" + } + }, + "Description": { + "target": "com.amazonaws.iotwireless#Description", + "traits": { + "smithy.api#documentation": "

The description of the new resource.

" + } + }, + "DestinationName": { + "target": "com.amazonaws.iotwireless#DestinationName", + "traits": { + "smithy.api#documentation": "

The name of the destination to assign to the new wireless device.

", + "smithy.api#required": {} + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.iotwireless#ClientRequestToken", + "traits": { + "smithy.api#documentation": "

Each resource must have a unique client request token. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.

", + "smithy.api#idempotencyToken": {} + } + }, + "LoRaWAN": { + "target": "com.amazonaws.iotwireless#LoRaWANDevice", + "traits": { + "smithy.api#documentation": "

The device configuration information to use to create the wireless device.

" + } + } + } + }, + "com.amazonaws.iotwireless#CreateWirelessDeviceResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.iotwireless#WirelessDeviceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name of the new resource.

" + } + }, + "Id": { + "target": "com.amazonaws.iotwireless#WirelessDeviceId", + "traits": { + "smithy.api#documentation": "

The ID of the new wireless device.

" + } + } + } + }, + "com.amazonaws.iotwireless#CreateWirelessGateway": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotwireless#CreateWirelessGatewayRequest" + }, + "output": { + "target": "com.amazonaws.iotwireless#CreateWirelessGatewayResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotwireless#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotwireless#ConflictException" + }, + { + "target": "com.amazonaws.iotwireless#InternalServerException" + }, + { + "target": "com.amazonaws.iotwireless#ThrottlingException" + }, + { + "target": "com.amazonaws.iotwireless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Provisions a wireless gateway.

", + "smithy.api#http": { + "method": "POST", + "uri": "/wireless-gateways", + "code": 201 + } + } + }, + "com.amazonaws.iotwireless#CreateWirelessGatewayRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.iotwireless#WirelessGatewayName", + "traits": { + "smithy.api#documentation": "

The name of the new resource.

" + } + }, + "Description": { + "target": "com.amazonaws.iotwireless#Description", + "traits": { + "smithy.api#documentation": "

The description of the new resource.

" + } + }, + "LoRaWAN": { + "target": "com.amazonaws.iotwireless#LoRaWANGateway", + "traits": { + "smithy.api#documentation": "

The gateway configuration information to use to create the wireless gateway.

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

The tags to attach to the new wireless gateway. Tags are metadata that can be used to manage a resource.

" + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.iotwireless#ClientRequestToken", + "traits": { + "smithy.api#documentation": "

Each resource must have a unique client request token. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.

", + "smithy.api#idempotencyToken": {} + } + } + } + }, + "com.amazonaws.iotwireless#CreateWirelessGatewayResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.iotwireless#WirelessGatewayArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name of the new resource.

" + } + }, + "Id": { + "target": "com.amazonaws.iotwireless#WirelessDeviceId", + "traits": { + "smithy.api#documentation": "

The ID of the new wireless gateway.

" + } + } + } + }, + "com.amazonaws.iotwireless#CreateWirelessGatewayTask": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotwireless#CreateWirelessGatewayTaskRequest" + }, + "output": { + "target": "com.amazonaws.iotwireless#CreateWirelessGatewayTaskResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotwireless#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotwireless#ConflictException" + }, + { + "target": "com.amazonaws.iotwireless#InternalServerException" + }, + { + "target": "com.amazonaws.iotwireless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotwireless#ThrottlingException" + }, + { + "target": "com.amazonaws.iotwireless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a task for a wireless gateway.

", + "smithy.api#http": { + "method": "POST", + "uri": "/wireless-gateways/{Id}/tasks", + "code": 201 + } + } + }, + "com.amazonaws.iotwireless#CreateWirelessGatewayTaskDefinition": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotwireless#CreateWirelessGatewayTaskDefinitionRequest" + }, + "output": { + "target": "com.amazonaws.iotwireless#CreateWirelessGatewayTaskDefinitionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotwireless#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotwireless#ConflictException" + }, + { + "target": "com.amazonaws.iotwireless#InternalServerException" + }, + { + "target": "com.amazonaws.iotwireless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotwireless#ThrottlingException" + }, + { + "target": "com.amazonaws.iotwireless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a gateway task definition.

", + "smithy.api#http": { + "method": "POST", + "uri": "/wireless-gateway-task-definitions", + "code": 201 + } + } + }, + "com.amazonaws.iotwireless#CreateWirelessGatewayTaskDefinitionRequest": { + "type": "structure", + "members": { + "AutoCreateTasks": { + "target": "com.amazonaws.iotwireless#AutoCreateTasks", + "traits": { + "smithy.api#documentation": "

Whether to automatically create tasks using this task definition for all gateways with the specified current version. If false, the task must me created by calling CreateWirelessGatewayTask.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.iotwireless#WirelessGatewayTaskName", + "traits": { + "smithy.api#documentation": "

The name of the new resource.

" + } + }, + "Update": { + "target": "com.amazonaws.iotwireless#UpdateWirelessGatewayTaskCreate", + "traits": { + "smithy.api#documentation": "

Information about the gateways to update.

" + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.iotwireless#ClientRequestToken", + "traits": { + "smithy.api#documentation": "

Each resource must have a unique client request token. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.

", + "smithy.api#idempotencyToken": {} + } + } + } + }, + "com.amazonaws.iotwireless#CreateWirelessGatewayTaskDefinitionResponse": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.iotwireless#WirelessGatewayTaskDefinitionId", + "traits": { + "smithy.api#documentation": "

The ID of the new wireless gateway task definition.

" + } + } + } + }, + "com.amazonaws.iotwireless#CreateWirelessGatewayTaskRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.iotwireless#WirelessGatewayId", + "traits": { + "smithy.api#documentation": "

The ID of the resource to update.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "WirelessGatewayTaskDefinitionId": { + "target": "com.amazonaws.iotwireless#WirelessGatewayTaskDefinitionId", + "traits": { + "smithy.api#documentation": "

The ID of the WirelessGatewayTaskDefinition.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotwireless#CreateWirelessGatewayTaskResponse": { + "type": "structure", + "members": { + "WirelessGatewayTaskDefinitionId": { + "target": "com.amazonaws.iotwireless#WirelessGatewayTaskDefinitionId", + "traits": { + "smithy.api#documentation": "

The ID of the WirelessGatewayTaskDefinition.

" + } + }, + "Status": { + "target": "com.amazonaws.iotwireless#WirelessGatewayTaskStatus", + "traits": { + "smithy.api#documentation": "

The status of the request.

" + } + } + } + }, + "com.amazonaws.iotwireless#DeleteDestination": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotwireless#DeleteDestinationRequest" + }, + "output": { + "target": "com.amazonaws.iotwireless#DeleteDestinationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotwireless#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotwireless#ConflictException" + }, + { + "target": "com.amazonaws.iotwireless#InternalServerException" + }, + { + "target": "com.amazonaws.iotwireless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotwireless#ThrottlingException" + }, + { + "target": "com.amazonaws.iotwireless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a destination.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/destinations/{Name}", + "code": 204 + } + } + }, + "com.amazonaws.iotwireless#DeleteDestinationRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.iotwireless#DestinationName", + "traits": { + "smithy.api#documentation": "

The name of the resource to delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotwireless#DeleteDestinationResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.iotwireless#DeleteDeviceProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotwireless#DeleteDeviceProfileRequest" + }, + "output": { + "target": "com.amazonaws.iotwireless#DeleteDeviceProfileResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotwireless#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotwireless#ConflictException" + }, + { + "target": "com.amazonaws.iotwireless#InternalServerException" + }, + { + "target": "com.amazonaws.iotwireless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotwireless#ThrottlingException" + }, + { + "target": "com.amazonaws.iotwireless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a device profile.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/device-profiles/{Id}", + "code": 204 + } + } + }, + "com.amazonaws.iotwireless#DeleteDeviceProfileRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.iotwireless#DeviceProfileId", + "traits": { + "smithy.api#documentation": "

The ID of the resource to delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotwireless#DeleteDeviceProfileResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.iotwireless#DeleteServiceProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotwireless#DeleteServiceProfileRequest" + }, + "output": { + "target": "com.amazonaws.iotwireless#DeleteServiceProfileResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotwireless#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotwireless#ConflictException" + }, + { + "target": "com.amazonaws.iotwireless#InternalServerException" + }, + { + "target": "com.amazonaws.iotwireless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotwireless#ThrottlingException" + }, + { + "target": "com.amazonaws.iotwireless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a service profile.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/service-profiles/{Id}", + "code": 204 + } + } + }, + "com.amazonaws.iotwireless#DeleteServiceProfileRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.iotwireless#ServiceProfileId", + "traits": { + "smithy.api#documentation": "

The ID of the resource to delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotwireless#DeleteServiceProfileResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.iotwireless#DeleteWirelessDevice": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotwireless#DeleteWirelessDeviceRequest" + }, + "output": { + "target": "com.amazonaws.iotwireless#DeleteWirelessDeviceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotwireless#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotwireless#InternalServerException" + }, + { + "target": "com.amazonaws.iotwireless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotwireless#ThrottlingException" + }, + { + "target": "com.amazonaws.iotwireless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a wireless device.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/wireless-devices/{Id}", + "code": 204 + } + } + }, + "com.amazonaws.iotwireless#DeleteWirelessDeviceRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.iotwireless#WirelessDeviceId", + "traits": { + "smithy.api#documentation": "

The ID of the resource to delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotwireless#DeleteWirelessDeviceResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.iotwireless#DeleteWirelessGateway": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotwireless#DeleteWirelessGatewayRequest" + }, + "output": { + "target": "com.amazonaws.iotwireless#DeleteWirelessGatewayResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotwireless#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotwireless#InternalServerException" + }, + { + "target": "com.amazonaws.iotwireless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotwireless#ThrottlingException" + }, + { + "target": "com.amazonaws.iotwireless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a wireless gateway.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/wireless-gateways/{Id}", + "code": 204 + } + } + }, + "com.amazonaws.iotwireless#DeleteWirelessGatewayRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.iotwireless#WirelessGatewayId", + "traits": { + "smithy.api#documentation": "

The ID of the resource to delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotwireless#DeleteWirelessGatewayResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.iotwireless#DeleteWirelessGatewayTask": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotwireless#DeleteWirelessGatewayTaskRequest" + }, + "output": { + "target": "com.amazonaws.iotwireless#DeleteWirelessGatewayTaskResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotwireless#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotwireless#InternalServerException" + }, + { + "target": "com.amazonaws.iotwireless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotwireless#ThrottlingException" + }, + { + "target": "com.amazonaws.iotwireless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a wireless gateway task.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/wireless-gateways/{Id}/tasks", + "code": 204 + } + } + }, + "com.amazonaws.iotwireless#DeleteWirelessGatewayTaskDefinition": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotwireless#DeleteWirelessGatewayTaskDefinitionRequest" + }, + "output": { + "target": "com.amazonaws.iotwireless#DeleteWirelessGatewayTaskDefinitionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotwireless#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotwireless#InternalServerException" + }, + { + "target": "com.amazonaws.iotwireless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotwireless#ThrottlingException" + }, + { + "target": "com.amazonaws.iotwireless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a wireless gateway task definition. Deleting this task definition does not affect tasks that are currently in progress.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/wireless-gateway-task-definitions/{Id}", + "code": 204 + } + } + }, + "com.amazonaws.iotwireless#DeleteWirelessGatewayTaskDefinitionRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.iotwireless#WirelessGatewayTaskDefinitionId", + "traits": { + "smithy.api#documentation": "

The ID of the resource to delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotwireless#DeleteWirelessGatewayTaskDefinitionResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.iotwireless#DeleteWirelessGatewayTaskRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.iotwireless#WirelessGatewayId", + "traits": { + "smithy.api#documentation": "

The ID of the resource to delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotwireless#DeleteWirelessGatewayTaskResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.iotwireless#Description": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + } + } + }, + "com.amazonaws.iotwireless#DestinationArn": { + "type": "string" + }, + "com.amazonaws.iotwireless#DestinationList": { + "type": "list", + "member": { + "target": "com.amazonaws.iotwireless#Destinations" + } + }, + "com.amazonaws.iotwireless#DestinationName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 128 + }, + "smithy.api#pattern": "[a-zA-Z0-9-_]+" + } + }, + "com.amazonaws.iotwireless#Destinations": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.iotwireless#DestinationArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name of the resource.

" + } + }, + "Name": { + "target": "com.amazonaws.iotwireless#DestinationName", + "traits": { + "smithy.api#documentation": "

The name of the resource.

" + } + }, + "ExpressionType": { + "target": "com.amazonaws.iotwireless#ExpressionType", + "traits": { + "smithy.api#documentation": "

The type of value in Expression.

" + } + }, + "Expression": { + "target": "com.amazonaws.iotwireless#Expression", + "traits": { + "smithy.api#documentation": "

The rule name or topic rule to send messages to.

" + } + }, + "Description": { + "target": "com.amazonaws.iotwireless#Description", + "traits": { + "smithy.api#documentation": "

The description of the resource.

" + } + }, + "RoleArn": { + "target": "com.amazonaws.iotwireless#RoleArn", + "traits": { + "smithy.api#documentation": "

The ARN of the IAM Role that authorizes the destination.

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

Describes a destination.

" + } + }, + "com.amazonaws.iotwireless#DevAddr": { + "type": "string", + "traits": { + "smithy.api#pattern": "[a-fA-F0-9]{8}" + } + }, + "com.amazonaws.iotwireless#DevEui": { + "type": "string", + "traits": { + "smithy.api#pattern": "[a-fA-F0-9]{16}" + } + }, + "com.amazonaws.iotwireless#DevStatusReqFreq": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 0, + "max": 2147483647 + } + } + }, + "com.amazonaws.iotwireless#DeviceProfile": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.iotwireless#DeviceProfileArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name of the resource.

" + } + }, + "Name": { + "target": "com.amazonaws.iotwireless#DeviceProfileName", + "traits": { + "smithy.api#documentation": "

The name of the resource.

" + } + }, + "Id": { + "target": "com.amazonaws.iotwireless#DeviceProfileId", + "traits": { + "smithy.api#documentation": "

The ID of the device profile.

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

Describes a device profile.

" + } + }, + "com.amazonaws.iotwireless#DeviceProfileArn": { + "type": "string" + }, + "com.amazonaws.iotwireless#DeviceProfileId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.iotwireless#DeviceProfileList": { + "type": "list", + "member": { + "target": "com.amazonaws.iotwireless#DeviceProfile" + } + }, + "com.amazonaws.iotwireless#DeviceProfileName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.iotwireless#DisassociateAwsAccountFromPartnerAccount": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotwireless#DisassociateAwsAccountFromPartnerAccountRequest" + }, + "output": { + "target": "com.amazonaws.iotwireless#DisassociateAwsAccountFromPartnerAccountResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotwireless#InternalServerException" + }, + { + "target": "com.amazonaws.iotwireless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotwireless#ThrottlingException" + }, + { + "target": "com.amazonaws.iotwireless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Disassociates your AWS account from a partner account. If PartnerAccountId and PartnerType are null, disassociates your AWS account from all partner accounts.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/partner-accounts/{PartnerAccountId}", + "code": 204 + } + } + }, + "com.amazonaws.iotwireless#DisassociateAwsAccountFromPartnerAccountRequest": { + "type": "structure", + "members": { + "PartnerAccountId": { + "target": "com.amazonaws.iotwireless#PartnerAccountId", + "traits": { + "smithy.api#documentation": "

The partner account ID to disassociate from the AWS account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "PartnerType": { + "target": "com.amazonaws.iotwireless#PartnerType", + "traits": { + "smithy.api#documentation": "

The partner type.

", + "smithy.api#httpQuery": "partnerType", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotwireless#DisassociateAwsAccountFromPartnerAccountResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.iotwireless#DisassociateWirelessDeviceFromThing": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotwireless#DisassociateWirelessDeviceFromThingRequest" + }, + "output": { + "target": "com.amazonaws.iotwireless#DisassociateWirelessDeviceFromThingResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotwireless#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotwireless#ConflictException" + }, + { + "target": "com.amazonaws.iotwireless#InternalServerException" + }, + { + "target": "com.amazonaws.iotwireless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotwireless#ThrottlingException" + }, + { + "target": "com.amazonaws.iotwireless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Disassociates a wireless device from its currently associated thing.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/wireless-devices/{Id}/thing", + "code": 204 + } + } + }, + "com.amazonaws.iotwireless#DisassociateWirelessDeviceFromThingRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.iotwireless#WirelessDeviceId", + "traits": { + "smithy.api#documentation": "

The ID of the resource to update.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotwireless#DisassociateWirelessDeviceFromThingResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.iotwireless#DisassociateWirelessGatewayFromCertificate": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotwireless#DisassociateWirelessGatewayFromCertificateRequest" + }, + "output": { + "target": "com.amazonaws.iotwireless#DisassociateWirelessGatewayFromCertificateResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotwireless#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotwireless#InternalServerException" + }, + { + "target": "com.amazonaws.iotwireless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotwireless#ThrottlingException" + }, + { + "target": "com.amazonaws.iotwireless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Disassociates a wireless gateway from its currently associated certificate.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/wireless-gateways/{Id}/certificate", + "code": 204 + } + } + }, + "com.amazonaws.iotwireless#DisassociateWirelessGatewayFromCertificateRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.iotwireless#WirelessGatewayId", + "traits": { + "smithy.api#documentation": "

The ID of the resource to update.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotwireless#DisassociateWirelessGatewayFromCertificateResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.iotwireless#DisassociateWirelessGatewayFromThing": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotwireless#DisassociateWirelessGatewayFromThingRequest" + }, + "output": { + "target": "com.amazonaws.iotwireless#DisassociateWirelessGatewayFromThingResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotwireless#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotwireless#ConflictException" + }, + { + "target": "com.amazonaws.iotwireless#InternalServerException" + }, + { + "target": "com.amazonaws.iotwireless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotwireless#ThrottlingException" + }, + { + "target": "com.amazonaws.iotwireless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Disassociates a wireless gateway from its currently associated thing.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/wireless-gateways/{Id}/thing", + "code": 204 + } + } + }, + "com.amazonaws.iotwireless#DisassociateWirelessGatewayFromThingRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.iotwireless#WirelessGatewayId", + "traits": { + "smithy.api#documentation": "

The ID of the resource to update.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotwireless#DisassociateWirelessGatewayFromThingResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.iotwireless#DlBucketSize": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 0, + "max": 2147483647 + } + } + }, + "com.amazonaws.iotwireless#DlRate": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 0, + "max": 2147483647 + } + } + }, + "com.amazonaws.iotwireless#DlRatePolicy": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.iotwireless#Double": { + "type": "double", + "traits": { + "smithy.api#box": {} + } + }, + "com.amazonaws.iotwireless#DrMax": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 15 + } + } + }, + "com.amazonaws.iotwireless#DrMin": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 15 + } + } + }, + "com.amazonaws.iotwireless#EndPoint": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.iotwireless#Expression": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + } + } + }, + "com.amazonaws.iotwireless#ExpressionType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "RuleName", + "name": "RuleName" + } + ] + } + }, + "com.amazonaws.iotwireless#FNwkSIntKey": { + "type": "string", + "traits": { + "smithy.api#pattern": "[a-fA-F0-9]{32}" + } + }, + "com.amazonaws.iotwireless#FPort": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1, + "max": 223 + } + } + }, + "com.amazonaws.iotwireless#FactoryPresetFreqsList": { + "type": "list", + "member": { + "target": "com.amazonaws.iotwireless#PresetFreq" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 20 + } + } + }, + "com.amazonaws.iotwireless#Fingerprint": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 64, + "max": 64 + }, + "smithy.api#pattern": "[a-fA-F0-9]{64}", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.iotwireless#GatewayEui": { + "type": "string", + "traits": { + "smithy.api#pattern": "^(([0-9A-Fa-f]{2}-){7}|([0-9A-Fa-f]{2}:){7}|([0-9A-Fa-f]{2}\\s){7}|([0-9A-Fa-f]{2}){7})([0-9A-Fa-f]{2})$" + } + }, + "com.amazonaws.iotwireless#GetDestination": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotwireless#GetDestinationRequest" + }, + "output": { + "target": "com.amazonaws.iotwireless#GetDestinationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotwireless#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotwireless#InternalServerException" + }, + { + "target": "com.amazonaws.iotwireless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotwireless#ThrottlingException" + }, + { + "target": "com.amazonaws.iotwireless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets information about a destination.

", + "smithy.api#http": { + "method": "GET", + "uri": "/destinations/{Name}", + "code": 200 + } + } + }, + "com.amazonaws.iotwireless#GetDestinationRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.iotwireless#DestinationName", + "traits": { + "smithy.api#documentation": "

The name of the resource to get.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotwireless#GetDestinationResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.iotwireless#DestinationArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name of the resource.

" + } + }, + "Name": { + "target": "com.amazonaws.iotwireless#DestinationName", + "traits": { + "smithy.api#documentation": "

The name of the resource.

" + } + }, + "Expression": { + "target": "com.amazonaws.iotwireless#Expression", + "traits": { + "smithy.api#documentation": "

The rule name or topic rule to send messages to.

" + } + }, + "ExpressionType": { + "target": "com.amazonaws.iotwireless#ExpressionType", + "traits": { + "smithy.api#documentation": "

The type of value in Expression.

" + } + }, + "Description": { + "target": "com.amazonaws.iotwireless#Description", + "traits": { + "smithy.api#documentation": "

The description of the resource.

" + } + }, + "RoleArn": { + "target": "com.amazonaws.iotwireless#RoleArn", + "traits": { + "smithy.api#documentation": "

The ARN of the IAM Role that authorizes the destination.

" + } + } + } + }, + "com.amazonaws.iotwireless#GetDeviceProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotwireless#GetDeviceProfileRequest" + }, + "output": { + "target": "com.amazonaws.iotwireless#GetDeviceProfileResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotwireless#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotwireless#InternalServerException" + }, + { + "target": "com.amazonaws.iotwireless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotwireless#ThrottlingException" + }, + { + "target": "com.amazonaws.iotwireless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets information about a device profile.

", + "smithy.api#http": { + "method": "GET", + "uri": "/device-profiles/{Id}", + "code": 200 + } + } + }, + "com.amazonaws.iotwireless#GetDeviceProfileRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.iotwireless#DeviceProfileId", + "traits": { + "smithy.api#documentation": "

The ID of the resource to get.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotwireless#GetDeviceProfileResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.iotwireless#DeviceProfileArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name of the resource.

" + } + }, + "Name": { + "target": "com.amazonaws.iotwireless#DeviceProfileName", + "traits": { + "smithy.api#documentation": "

The name of the resource.

" + } + }, + "Id": { + "target": "com.amazonaws.iotwireless#DeviceProfileId", + "traits": { + "smithy.api#documentation": "

The ID of the device profile.

" + } + }, + "LoRaWAN": { + "target": "com.amazonaws.iotwireless#LoRaWANDeviceProfile", + "traits": { + "smithy.api#documentation": "

Information about the device profile.

" + } + } + } + }, + "com.amazonaws.iotwireless#GetPartnerAccount": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotwireless#GetPartnerAccountRequest" + }, + "output": { + "target": "com.amazonaws.iotwireless#GetPartnerAccountResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotwireless#InternalServerException" + }, + { + "target": "com.amazonaws.iotwireless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotwireless#ThrottlingException" + }, + { + "target": "com.amazonaws.iotwireless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets information about a partner account. If PartnerAccountId and PartnerType are null, returns all partner accounts.

", + "smithy.api#http": { + "method": "GET", + "uri": "/partner-accounts/{PartnerAccountId}", + "code": 200 + } + } + }, + "com.amazonaws.iotwireless#GetPartnerAccountRequest": { + "type": "structure", + "members": { + "PartnerAccountId": { + "target": "com.amazonaws.iotwireless#PartnerAccountId", + "traits": { + "smithy.api#documentation": "

The partner account ID to disassociate from the AWS account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "PartnerType": { + "target": "com.amazonaws.iotwireless#PartnerType", + "traits": { + "smithy.api#documentation": "

The partner type.

", + "smithy.api#httpQuery": "partnerType", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotwireless#GetPartnerAccountResponse": { + "type": "structure", + "members": { + "Sidewalk": { + "target": "com.amazonaws.iotwireless#SidewalkAccountInfoWithFingerprint", + "traits": { + "smithy.api#documentation": "

The Sidewalk account credentials.

" + } + }, + "AccountLinked": { + "target": "com.amazonaws.iotwireless#AccountLinked", + "traits": { + "smithy.api#documentation": "

Whether the partner account is linked to the AWS account.

" + } + } + } + }, + "com.amazonaws.iotwireless#GetServiceEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotwireless#GetServiceEndpointRequest" + }, + "output": { + "target": "com.amazonaws.iotwireless#GetServiceEndpointResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotwireless#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotwireless#InternalServerException" + }, + { + "target": "com.amazonaws.iotwireless#ThrottlingException" + }, + { + "target": "com.amazonaws.iotwireless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets the account-specific endpoint for Configuration and Update Server (CUPS) protocol or LoRaWAN Network Server (LNS) connections.

", + "smithy.api#http": { + "method": "GET", + "uri": "/service-endpoint", + "code": 200 + } + } + }, + "com.amazonaws.iotwireless#GetServiceEndpointRequest": { + "type": "structure", + "members": { + "ServiceType": { + "target": "com.amazonaws.iotwireless#WirelessGatewayServiceType", + "traits": { + "smithy.api#documentation": "

The service type for which to get endpoint information about. Can be CUPS for the Configuration and Update Server endpoint, or LNS for the LoRaWAN Network Server endpoint.

", + "smithy.api#httpQuery": "serviceType" + } + } + } + }, + "com.amazonaws.iotwireless#GetServiceEndpointResponse": { + "type": "structure", + "members": { + "ServiceType": { + "target": "com.amazonaws.iotwireless#WirelessGatewayServiceType", + "traits": { + "smithy.api#documentation": "

The endpoint's service type.

" + } + }, + "ServiceEndpoint": { + "target": "com.amazonaws.iotwireless#EndPoint", + "traits": { + "smithy.api#documentation": "

The service endpoint value.

" + } + }, + "ServerTrust": { + "target": "com.amazonaws.iotwireless#CertificatePEM", + "traits": { + "smithy.api#documentation": "

The Root CA of the server trust certificate.

" + } + } + } + }, + "com.amazonaws.iotwireless#GetServiceProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotwireless#GetServiceProfileRequest" + }, + "output": { + "target": "com.amazonaws.iotwireless#GetServiceProfileResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotwireless#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotwireless#InternalServerException" + }, + { + "target": "com.amazonaws.iotwireless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotwireless#ThrottlingException" + }, + { + "target": "com.amazonaws.iotwireless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets information about a service profile.

", + "smithy.api#http": { + "method": "GET", + "uri": "/service-profiles/{Id}", + "code": 200 + } + } + }, + "com.amazonaws.iotwireless#GetServiceProfileRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.iotwireless#ServiceProfileId", + "traits": { + "smithy.api#documentation": "

The ID of the resource to get.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotwireless#GetServiceProfileResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.iotwireless#ServiceProfileArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name of the resource.

" + } + }, + "Name": { + "target": "com.amazonaws.iotwireless#ServiceProfileName", + "traits": { + "smithy.api#documentation": "

The name of the resource.

" + } + }, + "Id": { + "target": "com.amazonaws.iotwireless#ServiceProfileId", + "traits": { + "smithy.api#documentation": "

The ID of the service profile.

" + } + }, + "LoRaWAN": { + "target": "com.amazonaws.iotwireless#LoRaWANGetServiceProfileInfo", + "traits": { + "smithy.api#documentation": "

Information about the service profile.

" + } + } + } + }, + "com.amazonaws.iotwireless#GetWirelessDevice": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotwireless#GetWirelessDeviceRequest" + }, + "output": { + "target": "com.amazonaws.iotwireless#GetWirelessDeviceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotwireless#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotwireless#InternalServerException" + }, + { + "target": "com.amazonaws.iotwireless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotwireless#ThrottlingException" + }, + { + "target": "com.amazonaws.iotwireless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets information about a wireless device.

", + "smithy.api#http": { + "method": "GET", + "uri": "/wireless-devices/{Identifier}", + "code": 200 + } + } + }, + "com.amazonaws.iotwireless#GetWirelessDeviceRequest": { + "type": "structure", + "members": { + "Identifier": { + "target": "com.amazonaws.iotwireless#Identifier", + "traits": { + "smithy.api#documentation": "

The identifier of the wireless device to get.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "IdentifierType": { + "target": "com.amazonaws.iotwireless#WirelessDeviceIdType", + "traits": { + "smithy.api#documentation": "

The type of identifier used in identifier.

", + "smithy.api#httpQuery": "identifierType", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotwireless#GetWirelessDeviceResponse": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.iotwireless#WirelessDeviceType", + "traits": { + "smithy.api#documentation": "

The wireless device type.

" + } + }, + "Name": { + "target": "com.amazonaws.iotwireless#WirelessDeviceName", + "traits": { + "smithy.api#documentation": "

The name of the resource.

" + } + }, + "Description": { + "target": "com.amazonaws.iotwireless#Description", + "traits": { + "smithy.api#documentation": "

The description of the resource.

" + } + }, + "DestinationName": { + "target": "com.amazonaws.iotwireless#DestinationName", + "traits": { + "smithy.api#documentation": "

The name of the destination to which the device is assigned.

" + } + }, + "Id": { + "target": "com.amazonaws.iotwireless#WirelessDeviceId", + "traits": { + "smithy.api#documentation": "

The ID of the wireless device.

" + } + }, + "Arn": { + "target": "com.amazonaws.iotwireless#WirelessDeviceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name of the resource.

" + } + }, + "ThingName": { + "target": "com.amazonaws.iotwireless#ThingName", + "traits": { + "smithy.api#documentation": "

The name of the thing associated with the wireless device. The value is empty if a thing isn't associated with the device.

" + } + }, + "ThingArn": { + "target": "com.amazonaws.iotwireless#ThingArn", + "traits": { + "smithy.api#documentation": "

The ARN of the thing associated with the wireless device.

" + } + }, + "LoRaWAN": { + "target": "com.amazonaws.iotwireless#LoRaWANDevice", + "traits": { + "smithy.api#documentation": "

Information about the wireless device.

" + } + } + } + }, + "com.amazonaws.iotwireless#GetWirelessDeviceStatistics": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotwireless#GetWirelessDeviceStatisticsRequest" + }, + "output": { + "target": "com.amazonaws.iotwireless#GetWirelessDeviceStatisticsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotwireless#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotwireless#InternalServerException" + }, + { + "target": "com.amazonaws.iotwireless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotwireless#ThrottlingException" + }, + { + "target": "com.amazonaws.iotwireless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets operating information about a wireless device.

", + "smithy.api#http": { + "method": "GET", + "uri": "/wireless-devices/{WirelessDeviceId}/statistics", + "code": 200 + } + } + }, + "com.amazonaws.iotwireless#GetWirelessDeviceStatisticsRequest": { + "type": "structure", + "members": { + "WirelessDeviceId": { + "target": "com.amazonaws.iotwireless#WirelessDeviceId", + "traits": { + "smithy.api#documentation": "

The ID of the wireless device for which to get the data.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotwireless#GetWirelessDeviceStatisticsResponse": { + "type": "structure", + "members": { + "WirelessDeviceId": { + "target": "com.amazonaws.iotwireless#WirelessDeviceId", + "traits": { + "smithy.api#documentation": "

The ID of the wireless device.

" + } + }, + "LastUplinkReceivedAt": { + "target": "com.amazonaws.iotwireless#ISODateTimeString", + "traits": { + "smithy.api#documentation": "

The date and time when the most recent uplink was received.

" + } + }, + "LoRaWAN": { + "target": "com.amazonaws.iotwireless#LoRaWANDeviceMetadata", + "traits": { + "smithy.api#documentation": "

Information about the wireless device's operations.

" + } + } + } + }, + "com.amazonaws.iotwireless#GetWirelessGateway": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotwireless#GetWirelessGatewayRequest" + }, + "output": { + "target": "com.amazonaws.iotwireless#GetWirelessGatewayResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotwireless#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotwireless#InternalServerException" + }, + { + "target": "com.amazonaws.iotwireless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotwireless#ThrottlingException" + }, + { + "target": "com.amazonaws.iotwireless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets information about a wireless gateway.

", + "smithy.api#http": { + "method": "GET", + "uri": "/wireless-gateways/{Identifier}", + "code": 200 + } + } + }, + "com.amazonaws.iotwireless#GetWirelessGatewayCertificate": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotwireless#GetWirelessGatewayCertificateRequest" + }, + "output": { + "target": "com.amazonaws.iotwireless#GetWirelessGatewayCertificateResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotwireless#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotwireless#InternalServerException" + }, + { + "target": "com.amazonaws.iotwireless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotwireless#ThrottlingException" + }, + { + "target": "com.amazonaws.iotwireless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets the ID of the certificate that is currently associated with a wireless gateway.

", + "smithy.api#http": { + "method": "GET", + "uri": "/wireless-gateways/{Id}/certificate", + "code": 200 + } + } + }, + "com.amazonaws.iotwireless#GetWirelessGatewayCertificateRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.iotwireless#WirelessGatewayId", + "traits": { + "smithy.api#documentation": "

The ID of the resource to get.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotwireless#GetWirelessGatewayCertificateResponse": { + "type": "structure", + "members": { + "IotCertificateId": { + "target": "com.amazonaws.iotwireless#IotCertificateId", + "traits": { + "smithy.api#documentation": "

The ID of the certificate associated with the wireless gateway.

" + } + } + } + }, + "com.amazonaws.iotwireless#GetWirelessGatewayFirmwareInformation": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotwireless#GetWirelessGatewayFirmwareInformationRequest" + }, + "output": { + "target": "com.amazonaws.iotwireless#GetWirelessGatewayFirmwareInformationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotwireless#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotwireless#InternalServerException" + }, + { + "target": "com.amazonaws.iotwireless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotwireless#ThrottlingException" + }, + { + "target": "com.amazonaws.iotwireless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets the firmware version and other information about a wireless gateway.

", + "smithy.api#http": { + "method": "GET", + "uri": "/wireless-gateways/{Id}/firmware-information", + "code": 200 + } + } + }, + "com.amazonaws.iotwireless#GetWirelessGatewayFirmwareInformationRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.iotwireless#WirelessGatewayId", + "traits": { + "smithy.api#documentation": "

The ID of the resource to get.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotwireless#GetWirelessGatewayFirmwareInformationResponse": { + "type": "structure", + "members": { + "LoRaWAN": { + "target": "com.amazonaws.iotwireless#LoRaWANGatewayCurrentVersion", + "traits": { + "smithy.api#documentation": "

Information about the wireless gateway's firmware.

" + } + } + } + }, + "com.amazonaws.iotwireless#GetWirelessGatewayRequest": { + "type": "structure", + "members": { + "Identifier": { + "target": "com.amazonaws.iotwireless#Identifier", + "traits": { + "smithy.api#documentation": "

The identifier of the wireless gateway to get.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "IdentifierType": { + "target": "com.amazonaws.iotwireless#WirelessGatewayIdType", + "traits": { + "smithy.api#documentation": "

The type of identifier used in identifier.

", + "smithy.api#httpQuery": "identifierType", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotwireless#GetWirelessGatewayResponse": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.iotwireless#WirelessGatewayName", + "traits": { + "smithy.api#documentation": "

The name of the resource.

" + } + }, + "Id": { + "target": "com.amazonaws.iotwireless#WirelessGatewayId", + "traits": { + "smithy.api#documentation": "

The ID of the wireless gateway.

" + } + }, + "Description": { + "target": "com.amazonaws.iotwireless#Description", + "traits": { + "smithy.api#documentation": "

The description of the resource.

" + } + }, + "LoRaWAN": { + "target": "com.amazonaws.iotwireless#LoRaWANGateway", + "traits": { + "smithy.api#documentation": "

Information about the wireless gateway.

" + } + }, + "Arn": { + "target": "com.amazonaws.iotwireless#WirelessGatewayArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name of the resource.

" + } + }, + "ThingName": { + "target": "com.amazonaws.iotwireless#ThingName", + "traits": { + "smithy.api#documentation": "

The name of the thing associated with the wireless gateway. The value is empty if a thing isn't associated with the gateway.

" + } + }, + "ThingArn": { + "target": "com.amazonaws.iotwireless#ThingArn", + "traits": { + "smithy.api#documentation": "

The ARN of the thing associated with the wireless gateway.

" + } + } + } + }, + "com.amazonaws.iotwireless#GetWirelessGatewayStatistics": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotwireless#GetWirelessGatewayStatisticsRequest" + }, + "output": { + "target": "com.amazonaws.iotwireless#GetWirelessGatewayStatisticsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotwireless#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotwireless#InternalServerException" + }, + { + "target": "com.amazonaws.iotwireless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotwireless#ThrottlingException" + }, + { + "target": "com.amazonaws.iotwireless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets operating information about a wireless gateway.

", + "smithy.api#http": { + "method": "GET", + "uri": "/wireless-gateways/{WirelessGatewayId}/statistics", + "code": 200 + } + } + }, + "com.amazonaws.iotwireless#GetWirelessGatewayStatisticsRequest": { + "type": "structure", + "members": { + "WirelessGatewayId": { + "target": "com.amazonaws.iotwireless#WirelessGatewayId", + "traits": { + "smithy.api#documentation": "

The ID of the wireless gateway for which to get the data.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotwireless#GetWirelessGatewayStatisticsResponse": { + "type": "structure", + "members": { + "WirelessGatewayId": { + "target": "com.amazonaws.iotwireless#WirelessGatewayId", + "traits": { + "smithy.api#documentation": "

The ID of the wireless gateway.

" + } + }, + "LastUplinkReceivedAt": { + "target": "com.amazonaws.iotwireless#ISODateTimeString", + "traits": { + "smithy.api#documentation": "

The date and time when the most recent uplink was received.

" + } + } + } + }, + "com.amazonaws.iotwireless#GetWirelessGatewayTask": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotwireless#GetWirelessGatewayTaskRequest" + }, + "output": { + "target": "com.amazonaws.iotwireless#GetWirelessGatewayTaskResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotwireless#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotwireless#InternalServerException" + }, + { + "target": "com.amazonaws.iotwireless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotwireless#ThrottlingException" + }, + { + "target": "com.amazonaws.iotwireless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets information about a wireless gateway task.

", + "smithy.api#http": { + "method": "GET", + "uri": "/wireless-gateways/{Id}/tasks", + "code": 200 + } + } + }, + "com.amazonaws.iotwireless#GetWirelessGatewayTaskDefinition": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotwireless#GetWirelessGatewayTaskDefinitionRequest" + }, + "output": { + "target": "com.amazonaws.iotwireless#GetWirelessGatewayTaskDefinitionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotwireless#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotwireless#InternalServerException" + }, + { + "target": "com.amazonaws.iotwireless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotwireless#ThrottlingException" + }, + { + "target": "com.amazonaws.iotwireless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets information about a wireless gateway task definition.

", + "smithy.api#http": { + "method": "GET", + "uri": "/wireless-gateway-task-definitions/{Id}", + "code": 200 + } + } + }, + "com.amazonaws.iotwireless#GetWirelessGatewayTaskDefinitionRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.iotwireless#WirelessGatewayTaskDefinitionId", + "traits": { + "smithy.api#documentation": "

The ID of the resource to get.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotwireless#GetWirelessGatewayTaskDefinitionResponse": { + "type": "structure", + "members": { + "AutoCreateTasks": { + "target": "com.amazonaws.iotwireless#AutoCreateTasks", + "traits": { + "smithy.api#documentation": "

Whether to automatically create tasks using this task definition for all gateways with the specified current version. If false, the task must me created by calling CreateWirelessGatewayTask.

" + } + }, + "Name": { + "target": "com.amazonaws.iotwireless#WirelessGatewayTaskName", + "traits": { + "smithy.api#documentation": "

The name of the resource.

" + } + }, + "Update": { + "target": "com.amazonaws.iotwireless#UpdateWirelessGatewayTaskCreate", + "traits": { + "smithy.api#documentation": "

Information about the gateways to update.

" + } + } + } + }, + "com.amazonaws.iotwireless#GetWirelessGatewayTaskRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.iotwireless#WirelessGatewayId", + "traits": { + "smithy.api#documentation": "

The ID of the resource to get.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotwireless#GetWirelessGatewayTaskResponse": { + "type": "structure", + "members": { + "WirelessGatewayId": { + "target": "com.amazonaws.iotwireless#WirelessGatewayId", + "traits": { + "smithy.api#documentation": "

The ID of the wireless gateway.

" + } + }, + "WirelessGatewayTaskDefinitionId": { + "target": "com.amazonaws.iotwireless#WirelessGatewayTaskDefinitionId", + "traits": { + "smithy.api#documentation": "

The ID of the WirelessGatewayTask.

" + } + }, + "LastUplinkReceivedAt": { + "target": "com.amazonaws.iotwireless#ISODateTimeString", + "traits": { + "smithy.api#documentation": "

The date and time when the most recent uplink was received.

" + } + }, + "TaskCreatedAt": { + "target": "com.amazonaws.iotwireless#ISODateTimeString", + "traits": { + "smithy.api#documentation": "

The date and time when the task was created.

" + } + }, + "Status": { + "target": "com.amazonaws.iotwireless#WirelessGatewayTaskStatus", + "traits": { + "smithy.api#documentation": "

The status of the request.

" + } + } + } + }, + "com.amazonaws.iotwireless#HrAllowed": { + "type": "boolean" + }, + "com.amazonaws.iotwireless#ISODateTimeString": { + "type": "string", + "traits": { + "smithy.api#pattern": "^([\\+-]?\\d{4}(?!\\d{2}\\b))((-?)((0[1-9]|1[0-2])(\\3([12]\\d|0[1-9]|3[01]))?|W([0-4]\\d|5[0-2])(-?[1-7])?|(00[1-9]|0[1-9]\\d|[12]\\d{2}|3([0-5]\\d|6[1-6])))([T\\s]((([01]\\d|2[0-3])((:?)[0-5]\\d)?|24\\:?00)([\\.,]\\d+(?!:))?)?(\\17[0-5]\\d([\\.,]\\d+)?)?([zZ]|([\\+-])([01]\\d|2[0-3]):?([0-5]\\d)?)?)?)?$" + } + }, + "com.amazonaws.iotwireless#Identifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.iotwireless#Integer": { + "type": "integer", + "traits": { + "smithy.api#box": {} + } + }, + "com.amazonaws.iotwireless#InternalServerException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.iotwireless#Message" + } + }, + "traits": { + "smithy.api#documentation": "

An unexpected error occurred while processing a request.

", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.iotwireless#IotCertificateId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 4096 + } + } + }, + "com.amazonaws.iotwireless#JoinEui": { + "type": "string", + "traits": { + "smithy.api#pattern": "[a-fA-F0-9]{16}" + } + }, + "com.amazonaws.iotwireless#ListDestinations": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotwireless#ListDestinationsRequest" + }, + "output": { + "target": "com.amazonaws.iotwireless#ListDestinationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotwireless#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotwireless#InternalServerException" + }, + { + "target": "com.amazonaws.iotwireless#ThrottlingException" + }, + { + "target": "com.amazonaws.iotwireless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the destinations registered to your AWS account.

", + "smithy.api#http": { + "method": "GET", + "uri": "/destinations", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.iotwireless#ListDestinationsRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.iotwireless#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return in this operation.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.iotwireless#NextToken", + "traits": { + "smithy.api#documentation": "

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

", + "smithy.api#httpQuery": "nextToken" + } + } + } + }, + "com.amazonaws.iotwireless#ListDestinationsResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.iotwireless#NextToken", + "traits": { + "smithy.api#documentation": "

The token to use to get the next set of results, or null if there are no additional results.

" + } + }, + "DestinationList": { + "target": "com.amazonaws.iotwireless#DestinationList", + "traits": { + "smithy.api#documentation": "

The list of destinations.

" + } + } + } + }, + "com.amazonaws.iotwireless#ListDeviceProfiles": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotwireless#ListDeviceProfilesRequest" + }, + "output": { + "target": "com.amazonaws.iotwireless#ListDeviceProfilesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotwireless#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotwireless#InternalServerException" + }, + { + "target": "com.amazonaws.iotwireless#ThrottlingException" + }, + { + "target": "com.amazonaws.iotwireless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the device profiles registered to your AWS account.

", + "smithy.api#http": { + "method": "GET", + "uri": "/device-profiles", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.iotwireless#ListDeviceProfilesRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.iotwireless#NextToken", + "traits": { + "smithy.api#documentation": "

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

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

The maximum number of results to return in this operation.

", + "smithy.api#httpQuery": "maxResults" + } + } + } + }, + "com.amazonaws.iotwireless#ListDeviceProfilesResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.iotwireless#NextToken", + "traits": { + "smithy.api#documentation": "

The token to use to get the next set of results, or null if there are no additional results.

" + } + }, + "DeviceProfileList": { + "target": "com.amazonaws.iotwireless#DeviceProfileList", + "traits": { + "smithy.api#documentation": "

The list of device profiles.

" + } + } + } + }, + "com.amazonaws.iotwireless#ListPartnerAccounts": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotwireless#ListPartnerAccountsRequest" + }, + "output": { + "target": "com.amazonaws.iotwireless#ListPartnerAccountsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotwireless#InternalServerException" + }, + { + "target": "com.amazonaws.iotwireless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotwireless#ThrottlingException" + }, + { + "target": "com.amazonaws.iotwireless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the partner accounts associated with your AWS account.

", + "smithy.api#http": { + "method": "GET", + "uri": "/partner-accounts", + "code": 200 + } + } + }, + "com.amazonaws.iotwireless#ListPartnerAccountsRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.iotwireless#NextToken", + "traits": { + "smithy.api#documentation": "

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

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

The maximum number of results to return in this operation.

", + "smithy.api#httpQuery": "maxResults" + } + } + } + }, + "com.amazonaws.iotwireless#ListPartnerAccountsResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.iotwireless#NextToken", + "traits": { + "smithy.api#documentation": "

The token to use to get the next set of results, or null if there are no additional results.

" + } + }, + "Sidewalk": { + "target": "com.amazonaws.iotwireless#SidewalkAccountList", + "traits": { + "smithy.api#documentation": "

The Sidewalk account credentials.

" + } + } + } + }, + "com.amazonaws.iotwireless#ListServiceProfiles": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotwireless#ListServiceProfilesRequest" + }, + "output": { + "target": "com.amazonaws.iotwireless#ListServiceProfilesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotwireless#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotwireless#InternalServerException" + }, + { + "target": "com.amazonaws.iotwireless#ThrottlingException" + }, + { + "target": "com.amazonaws.iotwireless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the service profiles registered to your AWS account.

", + "smithy.api#http": { + "method": "GET", + "uri": "/service-profiles", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.iotwireless#ListServiceProfilesRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.iotwireless#NextToken", + "traits": { + "smithy.api#documentation": "

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

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

The maximum number of results to return in this operation.

", + "smithy.api#httpQuery": "maxResults" + } + } + } + }, + "com.amazonaws.iotwireless#ListServiceProfilesResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.iotwireless#NextToken", + "traits": { + "smithy.api#documentation": "

The token to use to get the next set of results, or null if there are no additional results.

" + } + }, + "ServiceProfileList": { + "target": "com.amazonaws.iotwireless#ServiceProfileList", + "traits": { + "smithy.api#documentation": "

The list of service profiles.

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

Lists the tags (metadata) you have assigned to the resource.

", + "smithy.api#http": { + "method": "GET", + "uri": "/tags", + "code": 200 + } + } + }, + "com.amazonaws.iotwireless#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.iotwireless#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

The ARN of the resource for which to list tags.

", + "smithy.api#httpQuery": "resourceArn", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotwireless#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "Tags": { + "target": "com.amazonaws.iotwireless#TagList", + "traits": { + "smithy.api#documentation": "

The tags attached to the specified resource. Tags are metadata that can be used to manage a resource

" + } + } + } + }, + "com.amazonaws.iotwireless#ListWirelessDevices": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotwireless#ListWirelessDevicesRequest" + }, + "output": { + "target": "com.amazonaws.iotwireless#ListWirelessDevicesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotwireless#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotwireless#InternalServerException" + }, + { + "target": "com.amazonaws.iotwireless#ThrottlingException" + }, + { + "target": "com.amazonaws.iotwireless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the wireless devices registered to your AWS account.

", + "smithy.api#http": { + "method": "GET", + "uri": "/wireless-devices", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.iotwireless#ListWirelessDevicesRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.iotwireless#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return in this operation.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.iotwireless#NextToken", + "traits": { + "smithy.api#documentation": "

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "DestinationName": { + "target": "com.amazonaws.iotwireless#DestinationName", + "traits": { + "smithy.api#documentation": "

A filter to list only the wireless devices that use this destination.

", + "smithy.api#httpQuery": "destinationName" + } + }, + "DeviceProfileId": { + "target": "com.amazonaws.iotwireless#DeviceProfileId", + "traits": { + "smithy.api#documentation": "

A filter to list only the wireless devices that use this device profile.

", + "smithy.api#httpQuery": "deviceProfileId" + } + }, + "ServiceProfileId": { + "target": "com.amazonaws.iotwireless#ServiceProfileId", + "traits": { + "smithy.api#documentation": "

A filter to list only the wireless devices that use this service profile.

", + "smithy.api#httpQuery": "serviceProfileId" + } + }, + "WirelessDeviceType": { + "target": "com.amazonaws.iotwireless#WirelessDeviceType", + "traits": { + "smithy.api#documentation": "

A filter to list only the wireless devices that use this wireless device type.

", + "smithy.api#httpQuery": "wirelessDeviceType" + } + } + } + }, + "com.amazonaws.iotwireless#ListWirelessDevicesResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.iotwireless#NextToken", + "traits": { + "smithy.api#documentation": "

The token to use to get the next set of results, or null if there are no additional results.

" + } + }, + "WirelessDeviceList": { + "target": "com.amazonaws.iotwireless#WirelessDeviceStatisticsList", + "traits": { + "smithy.api#documentation": "

The ID of the wireless device.

" + } + } + } + }, + "com.amazonaws.iotwireless#ListWirelessGatewayTaskDefinitions": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotwireless#ListWirelessGatewayTaskDefinitionsRequest" + }, + "output": { + "target": "com.amazonaws.iotwireless#ListWirelessGatewayTaskDefinitionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotwireless#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotwireless#InternalServerException" + }, + { + "target": "com.amazonaws.iotwireless#ThrottlingException" + }, + { + "target": "com.amazonaws.iotwireless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

List the wireless gateway tasks definitions registered to your AWS account.

", + "smithy.api#http": { + "method": "GET", + "uri": "/wireless-gateway-task-definitions", + "code": 200 + } + } + }, + "com.amazonaws.iotwireless#ListWirelessGatewayTaskDefinitionsRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.iotwireless#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return in this operation.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.iotwireless#NextToken", + "traits": { + "smithy.api#documentation": "

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "TaskDefinitionType": { + "target": "com.amazonaws.iotwireless#WirelessGatewayTaskDefinitionType", + "traits": { + "smithy.api#documentation": "

A filter to list only the wireless gateway task definitions that use this task definition type.

", + "smithy.api#httpQuery": "taskDefinitionType" + } + } + } + }, + "com.amazonaws.iotwireless#ListWirelessGatewayTaskDefinitionsResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.iotwireless#NextToken", + "traits": { + "smithy.api#documentation": "

The token to use to get the next set of results, or null if there are no additional results.

" + } + }, + "TaskDefinitions": { + "target": "com.amazonaws.iotwireless#WirelessGatewayTaskDefinitionList", + "traits": { + "smithy.api#documentation": "

The list of task definitions.

" + } + } + } + }, + "com.amazonaws.iotwireless#ListWirelessGateways": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotwireless#ListWirelessGatewaysRequest" + }, + "output": { + "target": "com.amazonaws.iotwireless#ListWirelessGatewaysResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotwireless#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotwireless#InternalServerException" + }, + { + "target": "com.amazonaws.iotwireless#ThrottlingException" + }, + { + "target": "com.amazonaws.iotwireless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the wireless gateways registered to your AWS account.

", + "smithy.api#http": { + "method": "GET", + "uri": "/wireless-gateways", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.iotwireless#ListWirelessGatewaysRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.iotwireless#NextToken", + "traits": { + "smithy.api#documentation": "

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

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

The maximum number of results to return in this operation.

", + "smithy.api#httpQuery": "maxResults" + } + } + } + }, + "com.amazonaws.iotwireless#ListWirelessGatewaysResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.iotwireless#NextToken", + "traits": { + "smithy.api#documentation": "

The token to use to get the next set of results, or null if there are no additional results.

" + } + }, + "WirelessGatewayList": { + "target": "com.amazonaws.iotwireless#WirelessGatewayStatisticsList", + "traits": { + "smithy.api#documentation": "

The ID of the wireless gateway.

" + } + } + } + }, + "com.amazonaws.iotwireless#LoRaWANDevice": { + "type": "structure", + "members": { + "DevEui": { + "target": "com.amazonaws.iotwireless#DevEui", + "traits": { + "smithy.api#documentation": "

The DevEUI value.

" + } + }, + "DeviceProfileId": { + "target": "com.amazonaws.iotwireless#DeviceProfileId", + "traits": { + "smithy.api#documentation": "

The ID of the device profile for the new wireless device.

" + } + }, + "ServiceProfileId": { + "target": "com.amazonaws.iotwireless#ServiceProfileId", + "traits": { + "smithy.api#documentation": "

The ID of the service profile.

" + } + }, + "OtaaV1_1": { + "target": "com.amazonaws.iotwireless#OtaaV1_1", + "traits": { + "smithy.api#documentation": "

OTAA device object for v1.1 for create APIs

" + } + }, + "OtaaV1_0_x": { + "target": "com.amazonaws.iotwireless#OtaaV1_0_x", + "traits": { + "smithy.api#documentation": "

OTAA device object for create APIs for v1.0.x

" + } + }, + "AbpV1_1": { + "target": "com.amazonaws.iotwireless#AbpV1_1", + "traits": { + "smithy.api#documentation": "

ABP device object for create APIs for v1.1

" + } + }, + "AbpV1_0_x": { + "target": "com.amazonaws.iotwireless#AbpV1_0_x", + "traits": { + "smithy.api#documentation": "

LoRaWAN object for create APIs

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

LoRaWAN object for create functions.

" + } + }, + "com.amazonaws.iotwireless#LoRaWANDeviceMetadata": { + "type": "structure", + "members": { + "DevEui": { + "target": "com.amazonaws.iotwireless#DevEui", + "traits": { + "smithy.api#documentation": "

The DevEUI value.

" + } + }, + "FPort": { + "target": "com.amazonaws.iotwireless#Integer", + "traits": { + "smithy.api#documentation": "

The FPort value.

" + } + }, + "DataRate": { + "target": "com.amazonaws.iotwireless#Integer", + "traits": { + "smithy.api#documentation": "

The DataRate value.

" + } + }, + "Frequency": { + "target": "com.amazonaws.iotwireless#Integer", + "traits": { + "smithy.api#documentation": "

The device's channel frequency in Hz.

" + } + }, + "Timestamp": { + "target": "com.amazonaws.iotwireless#ISODateTimeString", + "traits": { + "smithy.api#documentation": "

The date and time of the metadata.

" + } + }, + "Gateways": { + "target": "com.amazonaws.iotwireless#LoRaWANGatewayMetadataList", + "traits": { + "smithy.api#documentation": "

Information about the gateways accessed by the device.

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

LoRaWAN device metatdata.

" + } + }, + "com.amazonaws.iotwireless#LoRaWANDeviceProfile": { + "type": "structure", + "members": { + "SupportsClassB": { + "target": "com.amazonaws.iotwireless#SupportsClassB", + "traits": { + "smithy.api#documentation": "

The SupportsClassB value.

" + } + }, + "ClassBTimeout": { + "target": "com.amazonaws.iotwireless#ClassBTimeout", + "traits": { + "smithy.api#documentation": "

The ClassBTimeout value.

" + } + }, + "PingSlotPeriod": { + "target": "com.amazonaws.iotwireless#PingSlotPeriod", + "traits": { + "smithy.api#documentation": "

The PingSlotPeriod value.

" + } + }, + "PingSlotDr": { + "target": "com.amazonaws.iotwireless#PingSlotDr", + "traits": { + "smithy.api#documentation": "

The PingSlotDR value.

" + } + }, + "PingSlotFreq": { + "target": "com.amazonaws.iotwireless#PingSlotFreq", + "traits": { + "smithy.api#documentation": "

The PingSlotFreq value.

" + } + }, + "SupportsClassC": { + "target": "com.amazonaws.iotwireless#SupportsClassC", + "traits": { + "smithy.api#documentation": "

The SupportsClassC value.

" + } + }, + "ClassCTimeout": { + "target": "com.amazonaws.iotwireless#ClassCTimeout", + "traits": { + "smithy.api#documentation": "

The ClassCTimeout value.

" + } + }, + "MacVersion": { + "target": "com.amazonaws.iotwireless#MacVersion", + "traits": { + "smithy.api#documentation": "

The MAC version (such as OTAA 1.1 or OTAA 1.0.3) to use with this device profile.

" + } + }, + "RegParamsRevision": { + "target": "com.amazonaws.iotwireless#RegParamsRevision", + "traits": { + "smithy.api#documentation": "

The version of regional parameters.

" + } + }, + "RxDelay1": { + "target": "com.amazonaws.iotwireless#RxDelay1", + "traits": { + "smithy.api#documentation": "

The RXDelay1 value.

" + } + }, + "RxDrOffset1": { + "target": "com.amazonaws.iotwireless#RxDrOffset1", + "traits": { + "smithy.api#documentation": "

The RXDROffset1 value.

" + } + }, + "RxDataRate2": { + "target": "com.amazonaws.iotwireless#RxDataRate2", + "traits": { + "smithy.api#documentation": "

The RXDataRate2 value.

" + } + }, + "RxFreq2": { + "target": "com.amazonaws.iotwireless#RxFreq2", + "traits": { + "smithy.api#documentation": "

The RXFreq2 value.

" + } + }, + "FactoryPresetFreqsList": { + "target": "com.amazonaws.iotwireless#FactoryPresetFreqsList", + "traits": { + "smithy.api#documentation": "

The list of values that make up the FactoryPresetFreqs value.

" + } + }, + "MaxEirp": { + "target": "com.amazonaws.iotwireless#MaxEirp", + "traits": { + "smithy.api#documentation": "

The MaxEIRP value.

" + } + }, + "MaxDutyCycle": { + "target": "com.amazonaws.iotwireless#MaxDutyCycle", + "traits": { + "smithy.api#documentation": "

The MaxDutyCycle value.

" + } + }, + "RfRegion": { + "target": "com.amazonaws.iotwireless#RfRegion", + "traits": { + "smithy.api#documentation": "

The frequency band (RFRegion) value.

" + } + }, + "SupportsJoin": { + "target": "com.amazonaws.iotwireless#SupportsJoin", + "traits": { + "smithy.api#documentation": "

The SupportsJoin value.

" + } + }, + "Supports32BitFCnt": { + "target": "com.amazonaws.iotwireless#Supports32BitFCnt", + "traits": { + "smithy.api#documentation": "

The Supports32BitFCnt value.

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

LoRaWANDeviceProfile object.

" + } + }, + "com.amazonaws.iotwireless#LoRaWANGateway": { + "type": "structure", + "members": { + "GatewayEui": { + "target": "com.amazonaws.iotwireless#GatewayEui", + "traits": { + "smithy.api#documentation": "

The gateway's EUI value.

" + } + }, + "RfRegion": { + "target": "com.amazonaws.iotwireless#RfRegion", + "traits": { + "smithy.api#documentation": "

The frequency band (RFRegion) value.

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

LoRaWANGateway object.

" + } + }, + "com.amazonaws.iotwireless#LoRaWANGatewayCurrentVersion": { + "type": "structure", + "members": { + "CurrentVersion": { + "target": "com.amazonaws.iotwireless#LoRaWANGatewayVersion", + "traits": { + "smithy.api#documentation": "

The version of the gateways that should receive the update.

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

LoRaWANGatewayCurrentVersion object.

" + } + }, + "com.amazonaws.iotwireless#LoRaWANGatewayMetadata": { + "type": "structure", + "members": { + "GatewayEui": { + "target": "com.amazonaws.iotwireless#GatewayEui", + "traits": { + "smithy.api#documentation": "

The gateway's EUI value.

" + } + }, + "Snr": { + "target": "com.amazonaws.iotwireless#Double", + "traits": { + "smithy.api#documentation": "

The SNR value.

" + } + }, + "Rssi": { + "target": "com.amazonaws.iotwireless#Double", + "traits": { + "smithy.api#documentation": "

The RSSI value.

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

LoRaWAN gateway metatdata.

" + } + }, + "com.amazonaws.iotwireless#LoRaWANGatewayMetadataList": { + "type": "list", + "member": { + "target": "com.amazonaws.iotwireless#LoRaWANGatewayMetadata" + } + }, + "com.amazonaws.iotwireless#LoRaWANGatewayVersion": { + "type": "structure", + "members": { + "PackageVersion": { + "target": "com.amazonaws.iotwireless#PackageVersion", + "traits": { + "smithy.api#documentation": "

The version of the wireless gateway firmware.

" + } + }, + "Model": { + "target": "com.amazonaws.iotwireless#Model", + "traits": { + "smithy.api#documentation": "

The model number of the wireless gateway.

" + } + }, + "Station": { + "target": "com.amazonaws.iotwireless#Station", + "traits": { + "smithy.api#documentation": "

The basic station version of the wireless gateway.

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

LoRaWANGatewayVersion object.

" + } + }, + "com.amazonaws.iotwireless#LoRaWANGetServiceProfileInfo": { + "type": "structure", + "members": { + "UlRate": { + "target": "com.amazonaws.iotwireless#UlRate", + "traits": { + "smithy.api#documentation": "

The ULRate value.

" + } + }, + "UlBucketSize": { + "target": "com.amazonaws.iotwireless#UlBucketSize", + "traits": { + "smithy.api#documentation": "

The ULBucketSize value.

" + } + }, + "UlRatePolicy": { + "target": "com.amazonaws.iotwireless#UlRatePolicy", + "traits": { + "smithy.api#documentation": "

The ULRatePolicy value.

" + } + }, + "DlRate": { + "target": "com.amazonaws.iotwireless#DlRate", + "traits": { + "smithy.api#documentation": "

The DLRate value.

" + } + }, + "DlBucketSize": { + "target": "com.amazonaws.iotwireless#DlBucketSize", + "traits": { + "smithy.api#documentation": "

The DLBucketSize value.

" + } + }, + "DlRatePolicy": { + "target": "com.amazonaws.iotwireless#DlRatePolicy", + "traits": { + "smithy.api#documentation": "

The DLRatePolicy value.

" + } + }, + "AddGwMetadata": { + "target": "com.amazonaws.iotwireless#AddGwMetadata", + "traits": { + "smithy.api#documentation": "

The AddGWMetaData value.

" + } + }, + "DevStatusReqFreq": { + "target": "com.amazonaws.iotwireless#DevStatusReqFreq", + "traits": { + "smithy.api#documentation": "

The DevStatusReqFreq value.

" + } + }, + "ReportDevStatusBattery": { + "target": "com.amazonaws.iotwireless#ReportDevStatusBattery", + "traits": { + "smithy.api#documentation": "

The ReportDevStatusBattery value.

" + } + }, + "ReportDevStatusMargin": { + "target": "com.amazonaws.iotwireless#ReportDevStatusMargin", + "traits": { + "smithy.api#documentation": "

The ReportDevStatusMargin value.

" + } + }, + "DrMin": { + "target": "com.amazonaws.iotwireless#DrMin", + "traits": { + "smithy.api#documentation": "

The DRMin value.

" + } + }, + "DrMax": { + "target": "com.amazonaws.iotwireless#DrMax", + "traits": { + "smithy.api#documentation": "

The DRMax value.

" + } + }, + "ChannelMask": { + "target": "com.amazonaws.iotwireless#ChannelMask", + "traits": { + "smithy.api#documentation": "

The ChannelMask value.

" + } + }, + "PrAllowed": { + "target": "com.amazonaws.iotwireless#PrAllowed", + "traits": { + "smithy.api#documentation": "

The PRAllowed value that describes whether passive roaming is allowed.

" + } + }, + "HrAllowed": { + "target": "com.amazonaws.iotwireless#HrAllowed", + "traits": { + "smithy.api#documentation": "

The HRAllowed value that describes whether handover roaming is allowed.

" + } + }, + "RaAllowed": { + "target": "com.amazonaws.iotwireless#RaAllowed", + "traits": { + "smithy.api#documentation": "

The RAAllowed value that describes whether roaming activation is allowed.

" + } + }, + "NwkGeoLoc": { + "target": "com.amazonaws.iotwireless#NwkGeoLoc", + "traits": { + "smithy.api#documentation": "

The NwkGeoLoc value.

" + } + }, + "TargetPer": { + "target": "com.amazonaws.iotwireless#TargetPer", + "traits": { + "smithy.api#documentation": "

The TargetPER value.

" + } + }, + "MinGwDiversity": { + "target": "com.amazonaws.iotwireless#MinGwDiversity", + "traits": { + "smithy.api#documentation": "

The MinGwDiversity value.

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

LoRaWANGetServiceProfileInfo object.

" + } + }, + "com.amazonaws.iotwireless#LoRaWANListDevice": { + "type": "structure", + "members": { + "DevEui": { + "target": "com.amazonaws.iotwireless#DevEui", + "traits": { + "smithy.api#documentation": "

The DevEUI value.

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

LoRaWAN object for list functions.

" + } + }, + "com.amazonaws.iotwireless#LoRaWANSendDataToDevice": { + "type": "structure", + "members": { + "FPort": { + "target": "com.amazonaws.iotwireless#FPort", + "traits": { + "smithy.api#documentation": "

The Fport value.

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

LoRaWAN router info.

" + } + }, + "com.amazonaws.iotwireless#LoRaWANServiceProfile": { + "type": "structure", + "members": { + "AddGwMetadata": { + "target": "com.amazonaws.iotwireless#AddGwMetadata", + "traits": { + "smithy.api#documentation": "

The AddGWMetaData value.

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

LoRaWANServiceProfile object.

" + } + }, + "com.amazonaws.iotwireless#LoRaWANUpdateDevice": { + "type": "structure", + "members": { + "DeviceProfileId": { + "target": "com.amazonaws.iotwireless#DeviceProfileId", + "traits": { + "smithy.api#documentation": "

The ID of the device profile for the wireless device.

" + } + }, + "ServiceProfileId": { + "target": "com.amazonaws.iotwireless#ServiceProfileId", + "traits": { + "smithy.api#documentation": "

The ID of the service profile.

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

LoRaWAN object for update functions.

" + } + }, + "com.amazonaws.iotwireless#LoRaWANUpdateGatewayTaskCreate": { + "type": "structure", + "members": { + "UpdateSignature": { + "target": "com.amazonaws.iotwireless#UpdateSignature", + "traits": { + "smithy.api#documentation": "

The signature used to verify the update firmware.

" + } + }, + "SigKeyCrc": { + "target": "com.amazonaws.iotwireless#Crc", + "traits": { + "smithy.api#documentation": "

The CRC of the signature private key to check.

" + } + }, + "CurrentVersion": { + "target": "com.amazonaws.iotwireless#LoRaWANGatewayVersion", + "traits": { + "smithy.api#documentation": "

The version of the gateways that should receive the update.

" + } + }, + "UpdateVersion": { + "target": "com.amazonaws.iotwireless#LoRaWANGatewayVersion", + "traits": { + "smithy.api#documentation": "

The firmware version to update the gateway to.

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

LoRaWANUpdateGatewayTaskCreate object.

" + } + }, + "com.amazonaws.iotwireless#LoRaWANUpdateGatewayTaskEntry": { + "type": "structure", + "members": { + "CurrentVersion": { + "target": "com.amazonaws.iotwireless#LoRaWANGatewayVersion", + "traits": { + "smithy.api#documentation": "

The version of the gateways that should receive the update.

" + } + }, + "UpdateVersion": { + "target": "com.amazonaws.iotwireless#LoRaWANGatewayVersion", + "traits": { + "smithy.api#documentation": "

The firmware version to update the gateway to.

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

LoRaWANUpdateGatewayTaskEntry object.

" + } + }, + "com.amazonaws.iotwireless#MacVersion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 64 + } + } + }, + "com.amazonaws.iotwireless#MaxDutyCycle": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.iotwireless#MaxEirp": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 0, + "max": 15 + } + } + }, + "com.amazonaws.iotwireless#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 250 + } + } + }, + "com.amazonaws.iotwireless#Message": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + } + } + }, + "com.amazonaws.iotwireless#MessageId": { + "type": "string" + }, + "com.amazonaws.iotwireless#MinGwDiversity": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.iotwireless#Model": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 4096 + } + } + }, + "com.amazonaws.iotwireless#NextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 4096 + } + } + }, + "com.amazonaws.iotwireless#NwkGeoLoc": { + "type": "boolean" + }, + "com.amazonaws.iotwireless#NwkKey": { + "type": "string", + "traits": { + "smithy.api#pattern": "[a-fA-F0-9]{32}" + } + }, + "com.amazonaws.iotwireless#NwkSEncKey": { + "type": "string", + "traits": { + "smithy.api#pattern": "[a-fA-F0-9]{32}" + } + }, + "com.amazonaws.iotwireless#NwkSKey": { + "type": "string", + "traits": { + "smithy.api#pattern": "[a-fA-F0-9]{32}" + } + }, + "com.amazonaws.iotwireless#OtaaV1_0_x": { + "type": "structure", + "members": { + "AppKey": { + "target": "com.amazonaws.iotwireless#AppKey", + "traits": { + "smithy.api#documentation": "

The AppKey value.

" + } + }, + "AppEui": { + "target": "com.amazonaws.iotwireless#AppEui", + "traits": { + "smithy.api#documentation": "

The AppEUI value.

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

OTAA device object for v1.0.x

" + } + }, + "com.amazonaws.iotwireless#OtaaV1_1": { + "type": "structure", + "members": { + "AppKey": { + "target": "com.amazonaws.iotwireless#AppKey", + "traits": { + "smithy.api#documentation": "

The AppKey value.

" + } + }, + "NwkKey": { + "target": "com.amazonaws.iotwireless#NwkKey", + "traits": { + "smithy.api#documentation": "

The NwkKey value.

" + } + }, + "JoinEui": { + "target": "com.amazonaws.iotwireless#JoinEui", + "traits": { + "smithy.api#documentation": "

The JoinEUI value.

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

OTAA device object for v1.1

" + } + }, + "com.amazonaws.iotwireless#PackageVersion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 32 + } + } + }, + "com.amazonaws.iotwireless#PartnerAccountId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.iotwireless#PartnerType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Sidewalk", + "name": "Sidewalk" + } + ] + } + }, + "com.amazonaws.iotwireless#PayloadData": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + }, + "smithy.api#pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$" + } + }, + "com.amazonaws.iotwireless#PingSlotDr": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 0, + "max": 15 + } + } + }, + "com.amazonaws.iotwireless#PingSlotFreq": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1000000, + "max": 16700000 + } + } + }, + "com.amazonaws.iotwireless#PingSlotPeriod": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 128, + "max": 4096 + } + } + }, + "com.amazonaws.iotwireless#PrAllowed": { + "type": "boolean" + }, + "com.amazonaws.iotwireless#PresetFreq": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1000000, + "max": 16700000 + } + } + }, + "com.amazonaws.iotwireless#RaAllowed": { + "type": "boolean" + }, + "com.amazonaws.iotwireless#RegParamsRevision": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 64 + } + } + }, + "com.amazonaws.iotwireless#ReportDevStatusBattery": { + "type": "boolean" + }, + "com.amazonaws.iotwireless#ReportDevStatusMargin": { + "type": "boolean" + }, + "com.amazonaws.iotwireless#ResourceId": { + "type": "string" + }, + "com.amazonaws.iotwireless#ResourceNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.iotwireless#Message" + }, + "ResourceId": { + "target": "com.amazonaws.iotwireless#ResourceId" + }, + "ResourceType": { + "target": "com.amazonaws.iotwireless#ResourceType" + } + }, + "traits": { + "smithy.api#documentation": "

Resource does not exist.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.iotwireless#ResourceType": { + "type": "string" + }, + "com.amazonaws.iotwireless#Result": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + } + } + }, + "com.amazonaws.iotwireless#RfRegion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 64 + } + } + }, + "com.amazonaws.iotwireless#RoleArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + } + } + }, + "com.amazonaws.iotwireless#RxDataRate2": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 0, + "max": 15 + } + } + }, + "com.amazonaws.iotwireless#RxDelay1": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 0, + "max": 15 + } + } + }, + "com.amazonaws.iotwireless#RxDrOffset1": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 0, + "max": 7 + } + } + }, + "com.amazonaws.iotwireless#RxFreq2": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1000000, + "max": 16700000 + } + } + }, + "com.amazonaws.iotwireless#SNwkSIntKey": { + "type": "string", + "traits": { + "smithy.api#pattern": "[a-fA-F0-9]{32}" + } + }, + "com.amazonaws.iotwireless#SendDataToWirelessDevice": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotwireless#SendDataToWirelessDeviceRequest" + }, + "output": { + "target": "com.amazonaws.iotwireless#SendDataToWirelessDeviceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotwireless#InternalServerException" + }, + { + "target": "com.amazonaws.iotwireless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotwireless#ThrottlingException" + }, + { + "target": "com.amazonaws.iotwireless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Sends a decrypted application data frame to a device.

", + "smithy.api#http": { + "method": "POST", + "uri": "/wireless-devices/{Id}/data", + "code": 202 + } + } + }, + "com.amazonaws.iotwireless#SendDataToWirelessDeviceRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.iotwireless#WirelessDeviceId", + "traits": { + "smithy.api#documentation": "

The ID of the wireless device to receive the data.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TransmitMode": { + "target": "com.amazonaws.iotwireless#TransmitMode", + "traits": { + "smithy.api#documentation": "

The transmit mode to use to send data to the wireless device. Can be: 0 for UM (unacknowledge mode), 1 for AM (acknowledge mode), or 2 for (TM) transparent mode.

", + "smithy.api#required": {} + } + }, + "PayloadData": { + "target": "com.amazonaws.iotwireless#PayloadData", + "traits": { + "smithy.api#documentation": "

The message payload to send.

", + "smithy.api#required": {} + } + }, + "WirelessMetadata": { + "target": "com.amazonaws.iotwireless#WirelessMetadata", + "traits": { + "smithy.api#documentation": "

Metadata about the message request.

" + } + } + } + }, + "com.amazonaws.iotwireless#SendDataToWirelessDeviceResponse": { + "type": "structure", + "members": { + "MessageId": { + "target": "com.amazonaws.iotwireless#MessageId", + "traits": { + "smithy.api#documentation": "

The ID of the message sent to the wireless device.

" + } + } + } + }, + "com.amazonaws.iotwireless#Seq": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.iotwireless#ServiceProfile": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.iotwireless#ServiceProfileArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name of the resource.

" + } + }, + "Name": { + "target": "com.amazonaws.iotwireless#ServiceProfileName", + "traits": { + "smithy.api#documentation": "

The name of the resource.

" + } + }, + "Id": { + "target": "com.amazonaws.iotwireless#ServiceProfileId", + "traits": { + "smithy.api#documentation": "

The ID of the service profile.

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

Information about a service profile.

" + } + }, + "com.amazonaws.iotwireless#ServiceProfileArn": { + "type": "string" + }, + "com.amazonaws.iotwireless#ServiceProfileId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.iotwireless#ServiceProfileList": { + "type": "list", + "member": { + "target": "com.amazonaws.iotwireless#ServiceProfile" + } + }, + "com.amazonaws.iotwireless#ServiceProfileName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.iotwireless#SessionKeysAbpV1_0_x": { + "type": "structure", + "members": { + "NwkSKey": { + "target": "com.amazonaws.iotwireless#NwkSKey", + "traits": { + "smithy.api#documentation": "

The NwkSKey value.

" + } + }, + "AppSKey": { + "target": "com.amazonaws.iotwireless#AppSKey", + "traits": { + "smithy.api#documentation": "

The AppSKey value.

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

Session keys for ABP v1.1

" + } + }, + "com.amazonaws.iotwireless#SessionKeysAbpV1_1": { + "type": "structure", + "members": { + "FNwkSIntKey": { + "target": "com.amazonaws.iotwireless#FNwkSIntKey", + "traits": { + "smithy.api#documentation": "

The FNwkSIntKey value.

" + } + }, + "SNwkSIntKey": { + "target": "com.amazonaws.iotwireless#SNwkSIntKey", + "traits": { + "smithy.api#documentation": "

The SNwkSIntKey value.

" + } + }, + "NwkSEncKey": { + "target": "com.amazonaws.iotwireless#NwkSEncKey", + "traits": { + "smithy.api#documentation": "

The NwkSEncKey value.

" + } + }, + "AppSKey": { + "target": "com.amazonaws.iotwireless#AppSKey", + "traits": { + "smithy.api#documentation": "

The AppSKey value.

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

Session keys for ABP v1.1

" + } + }, + "com.amazonaws.iotwireless#SidewalkAccountInfo": { + "type": "structure", + "members": { + "AmazonId": { + "target": "com.amazonaws.iotwireless#AmazonId", + "traits": { + "smithy.api#documentation": "

The Sidewalk Amazon ID.

" + } + }, + "AppServerPrivateKey": { + "target": "com.amazonaws.iotwireless#AppServerPrivateKey", + "traits": { + "smithy.api#documentation": "

The Sidewalk application server private key.

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

Information about a Sidewalk account.

" + } + }, + "com.amazonaws.iotwireless#SidewalkAccountInfoWithFingerprint": { + "type": "structure", + "members": { + "AmazonId": { + "target": "com.amazonaws.iotwireless#AmazonId", + "traits": { + "smithy.api#documentation": "

The Sidewalk Amazon ID.

" + } + }, + "Fingerprint": { + "target": "com.amazonaws.iotwireless#Fingerprint", + "traits": { + "smithy.api#documentation": "

Fingerprint for Sidewalk application server private key.

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

Information about a Sidewalk account.

" + } + }, + "com.amazonaws.iotwireless#SidewalkAccountList": { + "type": "list", + "member": { + "target": "com.amazonaws.iotwireless#SidewalkAccountInfoWithFingerprint" + } + }, + "com.amazonaws.iotwireless#SidewalkListDevice": { + "type": "structure", + "members": { + "AmazonId": { + "target": "com.amazonaws.iotwireless#AmazonId", + "traits": { + "smithy.api#documentation": "

The Sidewalk Amazon ID.

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

Sidewalk object used by list functions.

" + } + }, + "com.amazonaws.iotwireless#SidewalkSendDataToDevice": { + "type": "structure", + "members": { + "Seq": { + "target": "com.amazonaws.iotwireless#Seq", + "traits": { + "smithy.api#documentation": "

The sequence number.

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

Information about a Sidewalk router.

" + } + }, + "com.amazonaws.iotwireless#SidewalkUpdateAccount": { + "type": "structure", + "members": { + "AppServerPrivateKey": { + "target": "com.amazonaws.iotwireless#AppServerPrivateKey", + "traits": { + "smithy.api#documentation": "

The new Sidewalk application server private key.

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

Sidewalk update.

" + } + }, + "com.amazonaws.iotwireless#Station": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 4096 + } + } + }, + "com.amazonaws.iotwireless#Supports32BitFCnt": { + "type": "boolean" + }, + "com.amazonaws.iotwireless#SupportsClassB": { + "type": "boolean" + }, + "com.amazonaws.iotwireless#SupportsClassC": { + "type": "boolean" + }, + "com.amazonaws.iotwireless#SupportsJoin": { + "type": "boolean", + "traits": { + "smithy.api#box": {} + } + }, + "com.amazonaws.iotwireless#Tag": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.iotwireless#TagKey", + "traits": { + "smithy.api#documentation": "

The tag's key value.

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

The tag's value.

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

A simple label consisting of a customer-defined key-value pair

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

Adds a tag to a resource.

", + "smithy.api#http": { + "method": "POST", + "uri": "/tags", + "code": 204 + } + } + }, + "com.amazonaws.iotwireless#TagResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.iotwireless#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

The ARN of the resource to add tags to.

", + "smithy.api#httpQuery": "resourceArn", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.iotwireless#TagList", + "traits": { + "smithy.api#documentation": "

Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotwireless#TagResourceResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.iotwireless#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.iotwireless#TargetPer": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.iotwireless#TestWirelessDevice": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotwireless#TestWirelessDeviceRequest" + }, + "output": { + "target": "com.amazonaws.iotwireless#TestWirelessDeviceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotwireless#InternalServerException" + }, + { + "target": "com.amazonaws.iotwireless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotwireless#ThrottlingException" + }, + { + "target": "com.amazonaws.iotwireless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Simulates a provisioned device by sending an uplink data payload of Hello.

", + "smithy.api#http": { + "method": "POST", + "uri": "/wireless-devices/{Id}/test", + "code": 200 + } + } + }, + "com.amazonaws.iotwireless#TestWirelessDeviceRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.iotwireless#WirelessDeviceId", + "traits": { + "smithy.api#documentation": "

The ID of the wireless device to test.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotwireless#TestWirelessDeviceResponse": { + "type": "structure", + "members": { + "Result": { + "target": "com.amazonaws.iotwireless#Result", + "traits": { + "smithy.api#documentation": "

The result returned by the test.

" + } + } + } + }, + "com.amazonaws.iotwireless#ThingArn": { + "type": "string" + }, + "com.amazonaws.iotwireless#ThingName": { + "type": "string" + }, + "com.amazonaws.iotwireless#ThrottlingException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.iotwireless#Message" + } + }, + "traits": { + "smithy.api#documentation": "

The request was denied because it exceeded the allowed API request rate.

", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, + "com.amazonaws.iotwireless#TooManyTagsException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.iotwireless#Message" + }, + "ResourceName": { + "target": "com.amazonaws.iotwireless#AmazonResourceName" + } + }, + "traits": { + "smithy.api#documentation": "

The request was denied because the resource can't have any more tags.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.iotwireless#TransmitMode": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.iotwireless#UlBucketSize": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 0, + "max": 2147483647 + } + } + }, + "com.amazonaws.iotwireless#UlRate": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 0, + "max": 2147483647 + } + } + }, + "com.amazonaws.iotwireless#UlRatePolicy": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.iotwireless#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotwireless#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.iotwireless#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotwireless#ConflictException" + }, + { + "target": "com.amazonaws.iotwireless#InternalServerException" + }, + { + "target": "com.amazonaws.iotwireless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotwireless#ThrottlingException" + }, + { + "target": "com.amazonaws.iotwireless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes one or more tags from a resource.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/tags", + "code": 204 + } + } + }, + "com.amazonaws.iotwireless#UntagResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.iotwireless#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

The ARN of the resource to remove tags from.

", + "smithy.api#httpQuery": "resourceArn", + "smithy.api#required": {} + } + }, + "TagKeys": { + "target": "com.amazonaws.iotwireless#TagKeyList", + "traits": { + "smithy.api#documentation": "

A list of the keys of the tags to remove from the resource.

", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotwireless#UntagResourceResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.iotwireless#UpdateDataSource": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 4096 + } + } + }, + "com.amazonaws.iotwireless#UpdateDestination": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotwireless#UpdateDestinationRequest" + }, + "output": { + "target": "com.amazonaws.iotwireless#UpdateDestinationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotwireless#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotwireless#InternalServerException" + }, + { + "target": "com.amazonaws.iotwireless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotwireless#ThrottlingException" + }, + { + "target": "com.amazonaws.iotwireless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates properties of a destination.

", + "smithy.api#http": { + "method": "PATCH", + "uri": "/destinations/{Name}", + "code": 204 + } + } + }, + "com.amazonaws.iotwireless#UpdateDestinationRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.iotwireless#DestinationName", + "traits": { + "smithy.api#documentation": "

The new name of the resource.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ExpressionType": { + "target": "com.amazonaws.iotwireless#ExpressionType", + "traits": { + "smithy.api#documentation": "

The type of value in Expression.

" + } + }, + "Expression": { + "target": "com.amazonaws.iotwireless#Expression", + "traits": { + "smithy.api#documentation": "

The new rule name or topic rule to send messages to.

" + } + }, + "Description": { + "target": "com.amazonaws.iotwireless#Description", + "traits": { + "smithy.api#documentation": "

A new description of the resource.

" + } + }, + "RoleArn": { + "target": "com.amazonaws.iotwireless#RoleArn", + "traits": { + "smithy.api#documentation": "

The ARN of the IAM Role that authorizes the destination.

" + } + } + } + }, + "com.amazonaws.iotwireless#UpdateDestinationResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.iotwireless#UpdatePartnerAccount": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotwireless#UpdatePartnerAccountRequest" + }, + "output": { + "target": "com.amazonaws.iotwireless#UpdatePartnerAccountResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotwireless#InternalServerException" + }, + { + "target": "com.amazonaws.iotwireless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotwireless#ThrottlingException" + }, + { + "target": "com.amazonaws.iotwireless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates properties of a partner account.

", + "smithy.api#http": { + "method": "PATCH", + "uri": "/partner-accounts/{PartnerAccountId}", + "code": 204 + } + } + }, + "com.amazonaws.iotwireless#UpdatePartnerAccountRequest": { + "type": "structure", + "members": { + "Sidewalk": { + "target": "com.amazonaws.iotwireless#SidewalkUpdateAccount", + "traits": { + "smithy.api#documentation": "

The Sidewalk account credentials.

", + "smithy.api#required": {} + } + }, + "PartnerAccountId": { + "target": "com.amazonaws.iotwireless#PartnerAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the partner account to update.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "PartnerType": { + "target": "com.amazonaws.iotwireless#PartnerType", + "traits": { + "smithy.api#documentation": "

The partner type.

", + "smithy.api#httpQuery": "partnerType", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotwireless#UpdatePartnerAccountResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.iotwireless#UpdateSignature": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 4096 + } + } + }, + "com.amazonaws.iotwireless#UpdateWirelessDevice": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotwireless#UpdateWirelessDeviceRequest" + }, + "output": { + "target": "com.amazonaws.iotwireless#UpdateWirelessDeviceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotwireless#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotwireless#InternalServerException" + }, + { + "target": "com.amazonaws.iotwireless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotwireless#ThrottlingException" + }, + { + "target": "com.amazonaws.iotwireless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates properties of a wireless device.

", + "smithy.api#http": { + "method": "PATCH", + "uri": "/wireless-devices/{Id}", + "code": 204 + } + } + }, + "com.amazonaws.iotwireless#UpdateWirelessDeviceRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.iotwireless#WirelessDeviceId", + "traits": { + "smithy.api#documentation": "

The ID of the resource to update.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DestinationName": { + "target": "com.amazonaws.iotwireless#DestinationName", + "traits": { + "smithy.api#documentation": "

The name of the new destination for the device.

" + } + }, + "Name": { + "target": "com.amazonaws.iotwireless#WirelessDeviceName", + "traits": { + "smithy.api#documentation": "

The new name of the resource.

" + } + }, + "Description": { + "target": "com.amazonaws.iotwireless#Description", + "traits": { + "smithy.api#documentation": "

A new description of the resource.

" + } + }, + "LoRaWAN": { + "target": "com.amazonaws.iotwireless#LoRaWANUpdateDevice", + "traits": { + "smithy.api#documentation": "

The updated wireless device's configuration.

" + } + } + } + }, + "com.amazonaws.iotwireless#UpdateWirelessDeviceResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.iotwireless#UpdateWirelessGateway": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotwireless#UpdateWirelessGatewayRequest" + }, + "output": { + "target": "com.amazonaws.iotwireless#UpdateWirelessGatewayResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotwireless#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotwireless#InternalServerException" + }, + { + "target": "com.amazonaws.iotwireless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotwireless#ThrottlingException" + }, + { + "target": "com.amazonaws.iotwireless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates properties of a wireless gateway.

", + "smithy.api#http": { + "method": "PATCH", + "uri": "/wireless-gateways/{Id}", + "code": 204 + } + } + }, + "com.amazonaws.iotwireless#UpdateWirelessGatewayRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.iotwireless#WirelessGatewayId", + "traits": { + "smithy.api#documentation": "

The ID of the resource to update.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.iotwireless#WirelessGatewayName", + "traits": { + "smithy.api#documentation": "

The new name of the resource.

" + } + }, + "Description": { + "target": "com.amazonaws.iotwireless#Description", + "traits": { + "smithy.api#documentation": "

A new description of the resource.

" + } + } + } + }, + "com.amazonaws.iotwireless#UpdateWirelessGatewayResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.iotwireless#UpdateWirelessGatewayTaskCreate": { + "type": "structure", + "members": { + "UpdateDataSource": { + "target": "com.amazonaws.iotwireless#UpdateDataSource", + "traits": { + "smithy.api#documentation": "

The link to the S3 bucket.

" + } + }, + "UpdateDataRole": { + "target": "com.amazonaws.iotwireless#UpdateDataSource", + "traits": { + "smithy.api#documentation": "

The IAM role used to read data from the S3 bucket.

" + } + }, + "LoRaWAN": { + "target": "com.amazonaws.iotwireless#LoRaWANUpdateGatewayTaskCreate", + "traits": { + "smithy.api#documentation": "

The properties that relate to the LoRaWAN wireless gateway.

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

UpdateWirelessGatewayTaskCreate object.

" + } + }, + "com.amazonaws.iotwireless#UpdateWirelessGatewayTaskEntry": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.iotwireless#WirelessGatewayTaskDefinitionId", + "traits": { + "smithy.api#documentation": "

The ID of the new wireless gateway task entry.

" + } + }, + "LoRaWAN": { + "target": "com.amazonaws.iotwireless#LoRaWANUpdateGatewayTaskEntry", + "traits": { + "smithy.api#documentation": "

The properties that relate to the LoRaWAN wireless gateway.

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

UpdateWirelessGatewayTaskEntry object.

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

The input did not meet the specified constraints.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.iotwireless#WirelessDeviceArn": { + "type": "string" + }, + "com.amazonaws.iotwireless#WirelessDeviceId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.iotwireless#WirelessDeviceIdType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "WirelessDeviceId", + "name": "WirelessDeviceId" + }, + { + "value": "DevEui", + "name": "DevEui" + }, + { + "value": "ThingName", + "name": "ThingName" + } + ] + } + }, + "com.amazonaws.iotwireless#WirelessDeviceName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.iotwireless#WirelessDeviceStatistics": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.iotwireless#WirelessDeviceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name of the resource.

" + } + }, + "Id": { + "target": "com.amazonaws.iotwireless#WirelessDeviceId", + "traits": { + "smithy.api#documentation": "

The ID of the wireless device reporting the data.

" + } + }, + "Type": { + "target": "com.amazonaws.iotwireless#WirelessDeviceType", + "traits": { + "smithy.api#documentation": "

The wireless device type.

" + } + }, + "Name": { + "target": "com.amazonaws.iotwireless#WirelessDeviceName", + "traits": { + "smithy.api#documentation": "

The name of the resource.

" + } + }, + "DestinationName": { + "target": "com.amazonaws.iotwireless#DestinationName", + "traits": { + "smithy.api#documentation": "

The name of the destination to which the device is assigned.

" + } + }, + "LastUplinkReceivedAt": { + "target": "com.amazonaws.iotwireless#ISODateTimeString", + "traits": { + "smithy.api#documentation": "

The date and time when the most recent uplink was received.

" + } + }, + "LoRaWAN": { + "target": "com.amazonaws.iotwireless#LoRaWANListDevice", + "traits": { + "smithy.api#documentation": "

LoRaWAN device info.

" + } + }, + "Sidewalk": { + "target": "com.amazonaws.iotwireless#SidewalkListDevice", + "traits": { + "smithy.api#documentation": "

The Sidewalk account credentials.

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

Information about a wireless device's operation.

" + } + }, + "com.amazonaws.iotwireless#WirelessDeviceStatisticsList": { + "type": "list", + "member": { + "target": "com.amazonaws.iotwireless#WirelessDeviceStatistics" + } + }, + "com.amazonaws.iotwireless#WirelessDeviceType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Sidewalk", + "name": "Sidewalk" + }, + { + "value": "LoRaWAN", + "name": "LoRaWAN" + } + ] + } + }, + "com.amazonaws.iotwireless#WirelessGatewayArn": { + "type": "string" + }, + "com.amazonaws.iotwireless#WirelessGatewayId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.iotwireless#WirelessGatewayIdType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "GatewayEui", + "name": "GatewayEui" + }, + { + "value": "WirelessGatewayId", + "name": "WirelessGatewayId" + }, + { + "value": "ThingName", + "name": "ThingName" + } + ] + } + }, + "com.amazonaws.iotwireless#WirelessGatewayName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.iotwireless#WirelessGatewayServiceType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CUPS", + "name": "CUPS" + }, + { + "value": "LNS", + "name": "LNS" + } + ] + } + }, + "com.amazonaws.iotwireless#WirelessGatewayStatistics": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.iotwireless#WirelessGatewayArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name of the resource.

" + } + }, + "Id": { + "target": "com.amazonaws.iotwireless#WirelessGatewayId", + "traits": { + "smithy.api#documentation": "

The ID of the wireless gateway reporting the data.

" + } + }, + "Name": { + "target": "com.amazonaws.iotwireless#WirelessGatewayName", + "traits": { + "smithy.api#documentation": "

The name of the resource.

" + } + }, + "Description": { + "target": "com.amazonaws.iotwireless#Description", + "traits": { + "smithy.api#documentation": "

The description of the resource.

" + } + }, + "LoRaWAN": { + "target": "com.amazonaws.iotwireless#LoRaWANGateway", + "traits": { + "smithy.api#documentation": "

LoRaWAN gateway info.

" + } + }, + "LastUplinkReceivedAt": { + "target": "com.amazonaws.iotwireless#ISODateTimeString", + "traits": { + "smithy.api#documentation": "

The date and time when the most recent uplink was received.

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

Information about a wireless gateway's operation.

" + } + }, + "com.amazonaws.iotwireless#WirelessGatewayStatisticsList": { + "type": "list", + "member": { + "target": "com.amazonaws.iotwireless#WirelessGatewayStatistics" + } + }, + "com.amazonaws.iotwireless#WirelessGatewayTaskDefinitionId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 36 + }, + "smithy.api#pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}" + } + }, + "com.amazonaws.iotwireless#WirelessGatewayTaskDefinitionList": { + "type": "list", + "member": { + "target": "com.amazonaws.iotwireless#UpdateWirelessGatewayTaskEntry" + } + }, + "com.amazonaws.iotwireless#WirelessGatewayTaskDefinitionType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "UPDATE", + "name": "UPDATE" + } + ] + } + }, + "com.amazonaws.iotwireless#WirelessGatewayTaskName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "com.amazonaws.iotwireless#WirelessGatewayTaskStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PENDING", + "name": "PENDING" + }, + { + "value": "IN_PROGRESS", + "name": "IN_PROGRESS" + }, + { + "value": "FIRST_RETRY", + "name": "FIRST_RETRY" + }, + { + "value": "SECOND_RETRY", + "name": "SECOND_RETRY" + }, + { + "value": "COMPLETED", + "name": "COMPLETED" + }, + { + "value": "FAILED", + "name": "FAILED" + } + ] + } + }, + "com.amazonaws.iotwireless#WirelessMetadata": { + "type": "structure", + "members": { + "LoRaWAN": { + "target": "com.amazonaws.iotwireless#LoRaWANSendDataToDevice", + "traits": { + "smithy.api#documentation": "

LoRaWAN device info.

" + } + }, + "Sidewalk": { + "target": "com.amazonaws.iotwireless#SidewalkSendDataToDevice", + "traits": { + "smithy.api#documentation": "

The Sidewalk account credentials.

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

WirelessMetadata object.

" + } + }, + "com.amazonaws.iotwireless#iotwireless": { + "type": "service", + "version": "2020-11-22", + "operations": [ + { + "target": "com.amazonaws.iotwireless#AssociateAwsAccountWithPartnerAccount" + }, + { + "target": "com.amazonaws.iotwireless#AssociateWirelessDeviceWithThing" + }, + { + "target": "com.amazonaws.iotwireless#AssociateWirelessGatewayWithCertificate" + }, + { + "target": "com.amazonaws.iotwireless#AssociateWirelessGatewayWithThing" + }, + { + "target": "com.amazonaws.iotwireless#CreateDestination" + }, + { + "target": "com.amazonaws.iotwireless#CreateDeviceProfile" + }, + { + "target": "com.amazonaws.iotwireless#CreateServiceProfile" + }, + { + "target": "com.amazonaws.iotwireless#CreateWirelessDevice" + }, + { + "target": "com.amazonaws.iotwireless#CreateWirelessGateway" + }, + { + "target": "com.amazonaws.iotwireless#CreateWirelessGatewayTask" + }, + { + "target": "com.amazonaws.iotwireless#CreateWirelessGatewayTaskDefinition" + }, + { + "target": "com.amazonaws.iotwireless#DeleteDestination" + }, + { + "target": "com.amazonaws.iotwireless#DeleteDeviceProfile" + }, + { + "target": "com.amazonaws.iotwireless#DeleteServiceProfile" + }, + { + "target": "com.amazonaws.iotwireless#DeleteWirelessDevice" + }, + { + "target": "com.amazonaws.iotwireless#DeleteWirelessGateway" + }, + { + "target": "com.amazonaws.iotwireless#DeleteWirelessGatewayTask" + }, + { + "target": "com.amazonaws.iotwireless#DeleteWirelessGatewayTaskDefinition" + }, + { + "target": "com.amazonaws.iotwireless#DisassociateAwsAccountFromPartnerAccount" + }, + { + "target": "com.amazonaws.iotwireless#DisassociateWirelessDeviceFromThing" + }, + { + "target": "com.amazonaws.iotwireless#DisassociateWirelessGatewayFromCertificate" + }, + { + "target": "com.amazonaws.iotwireless#DisassociateWirelessGatewayFromThing" + }, + { + "target": "com.amazonaws.iotwireless#GetDestination" + }, + { + "target": "com.amazonaws.iotwireless#GetDeviceProfile" + }, + { + "target": "com.amazonaws.iotwireless#GetPartnerAccount" + }, + { + "target": "com.amazonaws.iotwireless#GetServiceEndpoint" + }, + { + "target": "com.amazonaws.iotwireless#GetServiceProfile" + }, + { + "target": "com.amazonaws.iotwireless#GetWirelessDevice" + }, + { + "target": "com.amazonaws.iotwireless#GetWirelessDeviceStatistics" + }, + { + "target": "com.amazonaws.iotwireless#GetWirelessGateway" + }, + { + "target": "com.amazonaws.iotwireless#GetWirelessGatewayCertificate" + }, + { + "target": "com.amazonaws.iotwireless#GetWirelessGatewayFirmwareInformation" + }, + { + "target": "com.amazonaws.iotwireless#GetWirelessGatewayStatistics" + }, + { + "target": "com.amazonaws.iotwireless#GetWirelessGatewayTask" + }, + { + "target": "com.amazonaws.iotwireless#GetWirelessGatewayTaskDefinition" + }, + { + "target": "com.amazonaws.iotwireless#ListDestinations" + }, + { + "target": "com.amazonaws.iotwireless#ListDeviceProfiles" + }, + { + "target": "com.amazonaws.iotwireless#ListPartnerAccounts" + }, + { + "target": "com.amazonaws.iotwireless#ListServiceProfiles" + }, + { + "target": "com.amazonaws.iotwireless#ListTagsForResource" + }, + { + "target": "com.amazonaws.iotwireless#ListWirelessDevices" + }, + { + "target": "com.amazonaws.iotwireless#ListWirelessGateways" + }, + { + "target": "com.amazonaws.iotwireless#ListWirelessGatewayTaskDefinitions" + }, + { + "target": "com.amazonaws.iotwireless#SendDataToWirelessDevice" + }, + { + "target": "com.amazonaws.iotwireless#TagResource" + }, + { + "target": "com.amazonaws.iotwireless#TestWirelessDevice" + }, + { + "target": "com.amazonaws.iotwireless#UntagResource" + }, + { + "target": "com.amazonaws.iotwireless#UpdateDestination" + }, + { + "target": "com.amazonaws.iotwireless#UpdatePartnerAccount" + }, + { + "target": "com.amazonaws.iotwireless#UpdateWirelessDevice" + }, + { + "target": "com.amazonaws.iotwireless#UpdateWirelessGateway" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "IoT Wireless", + "arnNamespace": "iotwireless", + "cloudFormationName": "IoTWireless", + "cloudTrailEventSource": "iotwireless.amazonaws.com", + "endpointPrefix": "api.iotwireless" + }, + "aws.auth#sigv4": { + "name": "iotwireless" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "

AWS IoT Wireless API documentation

", + "smithy.api#title": "AWS IoT Wireless" + } + } + } +} diff --git a/codegen/sdk-codegen/aws-models/kms.2014-11-01.json b/codegen/sdk-codegen/aws-models/kms.2014-11-01.json index 864b537aee7..4e3f90af5cb 100644 --- a/codegen/sdk-codegen/aws-models/kms.2014-11-01.json +++ b/codegen/sdk-codegen/aws-models/kms.2014-11-01.json @@ -75,7 +75,19 @@ "TargetKeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

String that contains the key identifier referred to by the alias.

" + "smithy.api#documentation": "

String that contains the key identifier of the CMK associated with the alias.

" + } + }, + "CreationDate": { + "target": "com.amazonaws.kms#DateType", + "traits": { + "smithy.api#documentation": "

Date and time that the alias was most recently created in the account and Region. Formatted as Unix time.

" + } + }, + "LastUpdatedDate": { + "target": "com.amazonaws.kms#DateType", + "traits": { + "smithy.api#documentation": "

Date and time that the alias was most recently associated with a CMK in the account and Region. Formatted as Unix time.

" } } }, @@ -144,7 +156,7 @@ } ], "traits": { - "smithy.api#documentation": "

Cancels the deletion of a customer master key (CMK). When this operation succeeds, the key\n state of the CMK is Disabled. To enable the CMK, use EnableKey.\n You cannot perform this operation on a CMK in a different AWS account.

\n

For more information about scheduling and canceling deletion of a CMK, see Deleting Customer Master\n Keys in the AWS Key Management Service Developer Guide.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see How Key State Affects Use\nof a Customer Master Key in the AWS Key Management Service Developer Guide.

" + "smithy.api#documentation": "

Cancels the deletion of a customer master key (CMK). When this operation succeeds, the key\n state of the CMK is Disabled. To enable the CMK, use EnableKey.

\n

For more information about scheduling and canceling deletion of a CMK, see Deleting Customer Master\n Keys in the AWS Key Management Service Developer Guide.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see How Key State Affects Use\nof a Customer Master Key in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.

\n

\n Required permissions: kms:CancelKeyDeletion (key policy)

\n

\n Related operations: ScheduleKeyDeletion\n

" } }, "com.amazonaws.kms#CancelKeyDeletionRequest": { @@ -279,7 +291,7 @@ } ], "traits": { - "smithy.api#documentation": "

Connects or reconnects a custom key store to its associated AWS CloudHSM cluster.

\n

The custom key store must be connected before you can create customer master keys (CMKs)\n in the key store or use the CMKs it contains. You can disconnect and reconnect a custom key\n store at any time.

\n

To connect a custom key store, its associated AWS CloudHSM cluster must have at least one active\n HSM. To get the number of active HSMs in a cluster, use the DescribeClusters operation. To add HSMs\n to the cluster, use the CreateHsm operation. Also, the \n kmsuser crypto\n user (CU) must not be logged into the cluster. This prevents AWS KMS from using this\n account to log in.

\n

The connection process can take an extended amount of time to complete; up to 20 minutes.\n This operation starts the connection process, but it does not wait for it to complete. When it\n succeeds, this operation quickly returns an HTTP 200 response and a JSON object with no\n properties. However, this response does not indicate that the custom key store is connected.\n To get the connection state of the custom key store, use the DescribeCustomKeyStores operation.

\n

During the connection process, AWS KMS finds the AWS CloudHSM cluster that is associated with the\n custom key store, creates the connection infrastructure, connects to the cluster, logs into\n the AWS CloudHSM client as the kmsuser CU, and rotates its password.

\n

The ConnectCustomKeyStore operation might fail for various reasons. To find\n the reason, use the DescribeCustomKeyStores operation and see the\n ConnectionErrorCode in the response. For help interpreting the\n ConnectionErrorCode, see CustomKeyStoresListEntry.

\n

To fix the failure, use the DisconnectCustomKeyStore operation to\n disconnect the custom key store, correct the error, use the UpdateCustomKeyStore operation if necessary, and then use\n ConnectCustomKeyStore again.

\n

If you are having trouble connecting or disconnecting a custom key store, see Troubleshooting a Custom Key\n Store in the AWS Key Management Service Developer Guide.

" + "smithy.api#documentation": "

Connects or reconnects a custom key store to its associated AWS CloudHSM cluster.

\n

The custom key store must be connected before you can create customer master keys (CMKs)\n in the key store or use the CMKs it contains. You can disconnect and reconnect a custom key\n store at any time.

\n

To connect a custom key store, its associated AWS CloudHSM cluster must have at least one active\n HSM. To get the number of active HSMs in a cluster, use the DescribeClusters operation. To add HSMs\n to the cluster, use the CreateHsm operation. Also, the \n kmsuser crypto\n user (CU) must not be logged into the cluster. This prevents AWS KMS from using this\n account to log in.

\n

The connection process can take an extended amount of time to complete; up to 20 minutes.\n This operation starts the connection process, but it does not wait for it to complete. When it\n succeeds, this operation quickly returns an HTTP 200 response and a JSON object with no\n properties. However, this response does not indicate that the custom key store is connected.\n To get the connection state of the custom key store, use the DescribeCustomKeyStores operation.

\n

During the connection process, AWS KMS finds the AWS CloudHSM cluster that is associated with the\n custom key store, creates the connection infrastructure, connects to the cluster, logs into\n the AWS CloudHSM client as the kmsuser CU, and rotates its password.

\n

The ConnectCustomKeyStore operation might fail for various reasons. To find\n the reason, use the DescribeCustomKeyStores operation and see the\n ConnectionErrorCode in the response. For help interpreting the\n ConnectionErrorCode, see CustomKeyStoresListEntry.

\n

To fix the failure, use the DisconnectCustomKeyStore operation to\n disconnect the custom key store, correct the error, use the UpdateCustomKeyStore operation if necessary, and then use\n ConnectCustomKeyStore again.

\n

If you are having trouble connecting or disconnecting a custom key store, see Troubleshooting a Custom Key\n Store in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a custom key store in a different AWS account.

\n \n

\n Required permissions: kms:ConnectCustomKeyStore (IAM policy)

\n

\n Related operations\n

\n " } }, "com.amazonaws.kms#ConnectCustomKeyStoreRequest": { @@ -397,7 +409,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a display name for a customer managed customer master key (CMK). You can use an\n alias to identify a CMK in cryptographic operations, such as Encrypt and GenerateDataKey. You can change the CMK associated with the alias at any\n time.

\n

Aliases are easier to remember than key IDs. They can also help to simplify your\n applications. For example, if you use an alias in your code, you can change the CMK your code\n uses by associating a given alias with a different CMK.

\n

To run the same code in multiple AWS regions, use an alias in your code, such as\n alias/ApplicationKey. Then, in each AWS Region, create an\n alias/ApplicationKey alias that is associated with a CMK in that Region. When\n you run your code, it uses the alias/ApplicationKey CMK for that AWS Region\n without any Region-specific code.

\n

This operation does not return a response. To get the alias that you created, use the\n ListAliases operation.

\n \n

To use aliases successfully, be aware of the following information.

\n \n\n

Because an alias is not a property of a CMK, you can delete and change the aliases of a\n CMK without affecting the CMK. Also, aliases do not appear in the response from the DescribeKey operation. To get the aliases and alias ARNs of CMKs in each AWS\n account and Region, use the ListAliases operation.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see How Key State Affects Use\nof a Customer Master Key in the AWS Key Management Service Developer Guide.

" + "smithy.api#documentation": "

Creates a friendly name for a customer master key (CMK). You can use an alias to identify\n a CMK in the AWS KMS console, in the DescribeKey operation and in\n cryptographic operations, such as Encrypt and GenerateDataKey.

\n

You can also change the CMK that's associated with the alias (UpdateAlias) or delete the alias (DeleteAlias) at any time. These operations don't\n affect the underlying CMK.

\n

You can associate the alias with any customer managed CMK in the same AWS Region. Each\n alias is associated with only on CMK at a time, but a CMK can have multiple aliases. A valid\n CMK is required. You can't create an alias without a CMK.

\n

The alias must be unique in the account and Region, but you can have aliases with the same\n name in different Regions. For detailed information about aliases, see Using aliases in the\n AWS Key Management Service Developer Guide.

\n

This operation does not return a response. To get the alias that you created, use the\n ListAliases operation.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see How Key State Affects Use\nof a Customer Master Key in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on an alias in a different AWS account.

\n \n

\n Required permissions\n

\n \n

For details, see Controlling access to aliases in the AWS Key Management Service Developer Guide.

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#CreateAliasRequest": { @@ -406,14 +418,14 @@ "AliasName": { "target": "com.amazonaws.kms#AliasNameType", "traits": { - "smithy.api#documentation": "

Specifies the alias name. This value must begin with alias/ followed by a\n name, such as alias/ExampleAlias. The alias name cannot begin with\n alias/aws/. The alias/aws/ prefix is reserved for AWS managed\n CMKs.

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

Specifies the alias name. This value must begin with alias/ followed by a\n name, such as alias/ExampleAlias.

\n

The AliasName value must be string of 1-256 characters. It can contain only alphanumeric characters,\n forward slashes (/), underscores (_), and dashes (-). The alias name cannot begin with alias/aws/. The alias/aws/ prefix is reserved\n for AWS managed CMKs.

", "smithy.api#required": {} } }, "TargetKeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

Identifies the CMK to which the alias refers. Specify the key ID or the Amazon Resource\n Name (ARN) of the CMK. You cannot specify another alias. For help finding the key ID and ARN,\n see Finding the Key ID and\n ARN in the AWS Key Management Service Developer Guide.

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

Associates the alias with the specified customer managed CMK. The CMK must be\n in the same AWS Region.

\n

A valid CMK ID is required. If you supply a null or empty string value, this operation\n returns an error.

\n

For help finding the key ID and ARN, see Finding the Key ID and\n ARN in the AWS Key Management Service Developer Guide.

\n \n

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

", "smithy.api#required": {} } } @@ -451,7 +463,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a custom key store that is associated with an AWS CloudHSM cluster that you own and\n manage.

\n

This operation is part of the Custom Key Store feature feature in AWS KMS, which\ncombines the convenience and extensive integration of AWS KMS with the isolation and control of a\nsingle-tenant key store.

\n

Before you create the custom key store, you must assemble\n the required elements, including an AWS CloudHSM cluster that fulfills the requirements for a custom\n key store. For details about the required elements, see Assemble the Prerequisites\n in the AWS Key Management Service Developer Guide.

\n

When the operation completes successfully, it returns the ID of the new custom key store.\n Before you can use your new custom key store, you need to use the ConnectCustomKeyStore operation to connect the new key store to its AWS CloudHSM\n cluster. Even if you are not going to use your custom key store immediately, you might want to\n connect it to verify that all settings are correct and then disconnect it until you are ready\n to use it.

\n

For help with failures, see Troubleshooting a Custom Key Store in the\n AWS Key Management Service Developer Guide.

" + "smithy.api#documentation": "

Creates a custom key store that is associated with an AWS CloudHSM cluster that you own and\n manage.

\n

This operation is part of the Custom Key Store feature feature in AWS KMS, which\ncombines the convenience and extensive integration of AWS KMS with the isolation and control of a\nsingle-tenant key store.

\n

Before you create the custom key store, you must assemble\n the required elements, including an AWS CloudHSM cluster that fulfills the requirements for a custom\n key store. For details about the required elements, see Assemble the Prerequisites\n in the AWS Key Management Service Developer Guide.

\n

When the operation completes successfully, it returns the ID of the new custom key store.\n Before you can use your new custom key store, you need to use the ConnectCustomKeyStore operation to connect the new key store to its AWS CloudHSM\n cluster. Even if you are not going to use your custom key store immediately, you might want to\n connect it to verify that all settings are correct and then disconnect it until you are ready\n to use it.

\n

For help with failures, see Troubleshooting a Custom Key Store in the\n AWS Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a custom key store in a different AWS account.

\n

\n Required permissions: kms:CreateCustomKeyStore (IAM policy).

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#CreateCustomKeyStoreRequest": { @@ -533,7 +545,7 @@ } ], "traits": { - "smithy.api#documentation": "

Adds a grant to a customer master key (CMK). The grant allows the grantee principal to use\n the CMK when the conditions specified in the grant are met. When setting permissions, grants\n are an alternative to key policies.

\n

To create a grant that allows a cryptographic operation only when the request includes a particular\n encryption\n context, use the Constraints parameter. For details, see GrantConstraints.

\n

You can create grants on symmetric and asymmetric CMKs. However, if the grant allows an\n operation that the CMK does not support, CreateGrant fails with a\n ValidationException.

\n\n \n

For information about symmetric and asymmetric CMKs, see Using Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.

\n

To perform this operation on a CMK in a different AWS account, specify the key\n ARN in the value of the KeyId parameter. For more information about grants, see Grants in the\n \n AWS Key Management Service Developer Guide\n .

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see How Key State Affects Use\nof a Customer Master Key in the AWS Key Management Service Developer Guide.

" + "smithy.api#documentation": "

Adds a grant to a customer master key (CMK). The grant allows the grantee principal to use\n the CMK when the conditions specified in the grant are met. When setting permissions, grants\n are an alternative to key policies.

\n

To create a grant that allows a cryptographic operation only when the request includes a particular\n encryption\n context, use the Constraints parameter. For details, see GrantConstraints.

\n

You can create grants on symmetric and asymmetric CMKs. However, if the grant allows an\n operation that the CMK does not support, CreateGrant fails with a\n ValidationException.

\n\n \n

For information about symmetric and asymmetric CMKs, see Using Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide. For more information about grants, see Grants in the\n \n AWS Key Management Service Developer Guide\n .

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see How Key State Affects Use\nof a Customer Master Key in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: Yes. To perform this operation on a CMK in a different AWS account, specify the key\n ARN in the value of the KeyId parameter.

\n

\n Required permissions: kms:CreateGrant (key policy)

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#CreateGrantRequest": { @@ -569,7 +581,7 @@ "Constraints": { "target": "com.amazonaws.kms#GrantConstraints", "traits": { - "smithy.api#documentation": "

Allows a cryptographic operation only when the encryption context matches or includes the encryption\n context specified in this structure. For more information about encryption context, see Encryption\n Context in the \n AWS Key Management Service Developer Guide\n .

" + "smithy.api#documentation": "

Allows a cryptographic operation only when the encryption context matches or includes the encryption\n context specified in this structure. For more information about encryption context, see Encryption\n Context in the \n AWS Key Management Service Developer Guide\n .

\n

Grant constraints are not applied to operations that do not support an encryption context,\n such as cryptographic operations with asymmetric CMKs and management operations, such as\n DescribeKey or RetireGrant.

" } }, "GrantTokens": { @@ -581,7 +593,7 @@ "Name": { "target": "com.amazonaws.kms#GrantNameType", "traits": { - "smithy.api#documentation": "

A friendly name for identifying the grant. Use this value to prevent the unintended\n creation of duplicate grants when retrying this request.

\n

When this value is absent, all CreateGrant requests result in a new grant\n with a unique GrantId even if all the supplied parameters are identical. This can\n result in unintended duplicates when you retry the CreateGrant request.

\n

When this value is present, you can retry a CreateGrant request with\n identical parameters; if the grant already exists, the original GrantId is\n returned without creating a new grant. Note that the returned grant token is unique with every\n CreateGrant request, even when a duplicate GrantId is returned.\n All grant tokens obtained in this way can be used interchangeably.

" + "smithy.api#documentation": "

A friendly name for the grant. Use this value to prevent the unintended\n creation of duplicate grants when retrying this request.

\n

When this value is absent, all CreateGrant requests result in a new grant\n with a unique GrantId even if all the supplied parameters are identical. This can\n result in unintended duplicates when you retry the CreateGrant request.

\n

When this value is present, you can retry a CreateGrant request with\n identical parameters; if the grant already exists, the original GrantId is\n returned without creating a new grant. Note that the returned grant token is unique with every\n CreateGrant request, even when a duplicate GrantId is returned.\n All grant tokens for the same grant ID can be used interchangeably.

" } } } @@ -644,7 +656,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a unique customer managed customer master key (CMK) in your AWS\n account and Region. You cannot use this operation to create a CMK in a different AWS\n account.

\n\n

You can use the CreateKey operation to create symmetric or asymmetric\n CMKs.

\n \n

For information about symmetric and asymmetric CMKs, see Using Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.

\n\n\n

To create different types of CMKs, use the following guidance:

\n\n
\n
Asymmetric CMKs
\n
\n

To create an asymmetric CMK, use the CustomerMasterKeySpec parameter to\n specify the type of key material in the CMK. Then, use the KeyUsage\n parameter to determine whether the CMK will be used to encrypt and decrypt or sign and\n verify. You can't change these properties after the CMK is created.

\n

\n
\n
Symmetric CMKs
\n
\n

When creating a symmetric CMK, you don't need to specify the\n CustomerMasterKeySpec or KeyUsage parameters. The default\n value for CustomerMasterKeySpec, SYMMETRIC_DEFAULT, and the\n default value for KeyUsage, ENCRYPT_DECRYPT, are the only\n valid values for symmetric CMKs.

\n

\n
\n
Imported Key Material
\n
\n

To import your own key material, begin by creating a symmetric CMK with no key\n material. To do this, use the Origin parameter of CreateKey\n with a value of EXTERNAL. Next, use GetParametersForImport operation to get a public key and import token, and use the public key to encrypt\n your key material. Then, use ImportKeyMaterial with your import token\n to import the key material. For step-by-step instructions, see Importing Key Material in the \n AWS Key Management Service Developer Guide\n . You\n cannot import the key material into an asymmetric CMK.

\n

\n
\n
Custom Key Stores
\n
\n

To create a symmetric CMK in a custom key store, use the\n CustomKeyStoreId parameter to specify the custom key store. You must also\n use the Origin parameter with a value of AWS_CLOUDHSM. The\n AWS CloudHSM cluster that is associated with the custom key store must have at least two active\n HSMs in different Availability Zones in the AWS Region.

\n

You cannot create an asymmetric CMK in a custom key store. For information about\n custom key stores in AWS KMS see Using Custom Key Stores in\n the \n AWS Key Management Service Developer Guide\n .

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

Creates a unique customer managed customer master key (CMK) in your AWS\n account and Region.

\n\n

You can use the CreateKey operation to create symmetric or asymmetric\n CMKs.

\n \n

For information about symmetric and asymmetric CMKs, see Using Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.

\n\n\n

To create different types of CMKs, use the following guidance:

\n\n
\n
Asymmetric CMKs
\n
\n

To create an asymmetric CMK, use the CustomerMasterKeySpec parameter to\n specify the type of key material in the CMK. Then, use the KeyUsage\n parameter to determine whether the CMK will be used to encrypt and decrypt or sign and\n verify. You can't change these properties after the CMK is created.

\n

\n
\n
Symmetric CMKs
\n
\n

When creating a symmetric CMK, you don't need to specify the\n CustomerMasterKeySpec or KeyUsage parameters. The default\n value for CustomerMasterKeySpec, SYMMETRIC_DEFAULT, and the\n default value for KeyUsage, ENCRYPT_DECRYPT, are the only\n valid values for symmetric CMKs.

\n

\n
\n
Imported Key Material
\n
\n

To import your own key material, begin by creating a symmetric CMK with no key\n material. To do this, use the Origin parameter of CreateKey\n with a value of EXTERNAL. Next, use GetParametersForImport operation to get a public key and import token, and use the public key to encrypt\n your key material. Then, use ImportKeyMaterial with your import token\n to import the key material. For step-by-step instructions, see Importing Key Material in the \n AWS Key Management Service Developer Guide\n . You\n cannot import the key material into an asymmetric CMK.

\n

\n
\n
Custom Key Stores
\n
\n

To create a symmetric CMK in a custom key store, use the\n CustomKeyStoreId parameter to specify the custom key store. You must also\n use the Origin parameter with a value of AWS_CLOUDHSM. The\n AWS CloudHSM cluster that is associated with the custom key store must have at least two active\n HSMs in different Availability Zones in the AWS Region.

\n

You cannot create an asymmetric CMK in a custom key store. For information about\n custom key stores in AWS KMS see Using Custom Key Stores in\n the \n AWS Key Management Service Developer Guide\n .

\n
\n
\n

\n Cross-account use: No. You cannot use this operation to\n create a CMK in a different AWS account.

\n\n

\n Required permissions: kms:CreateKey (IAM policy). To use the\n Tags parameter, kms:TagResource (IAM policy). For examples and information about related\n permissions, see Allow a user to create\n CMKs in the AWS Key Management Service Developer Guide.

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#CreateKeyRequest": { @@ -653,7 +665,7 @@ "Policy": { "target": "com.amazonaws.kms#PolicyType", "traits": { - "smithy.api#documentation": "

The key policy to attach to the CMK.

\n

If you provide a key policy, it must meet the following criteria:

\n \n

If you do not provide a key policy, AWS KMS attaches a default key policy to the CMK. For\n more information, see Default Key Policy in the\n AWS Key Management Service Developer Guide.

\n

The key policy size quota is 32 kilobytes (32768 bytes).

" + "smithy.api#documentation": "

The key policy to attach to the CMK.

\n

If you provide a key policy, it must meet the following criteria:

\n \n

If you do not provide a key policy, AWS KMS attaches a default key policy to the CMK. For\n more information, see Default Key Policy in the\n AWS Key Management Service Developer Guide.

\n

The key policy size quota is 32 kilobytes (32768 bytes).

\n

For help writing and formatting a JSON policy document, see the IAM JSON Policy Reference in the \n IAM User Guide\n .

" } }, "Description": { @@ -695,7 +707,7 @@ "Tags": { "target": "com.amazonaws.kms#TagList", "traits": { - "smithy.api#documentation": "

One or more tags. Each tag consists of a tag key and a tag value. Both the tag key and the\n tag value are required, but the tag value can be an empty (null) string.

\n

When you add tags to an AWS resource, AWS generates a cost allocation\n report with usage and costs aggregated by tags. For information about adding, changing, deleting and listing tags for CMKs,\n see Tagging Keys.

\n

Use this parameter to tag the CMK when it is created. To add tags to an\n existing CMK, use the TagResource operation.

" + "smithy.api#documentation": "

One or more tags. Each tag consists of a tag key and a tag value. Both the tag key and the\n tag value are required, but the tag value can be an empty (null) string.

\n

When you add tags to an AWS resource, AWS generates a cost allocation\n report with usage and costs aggregated by tags. For information about adding, changing, deleting and listing tags for CMKs,\n see Tagging Keys.

\n

Use this parameter to tag the CMK when it is created. To add tags to an\n existing CMK, use the TagResource operation.

\n

To use this parameter, you must have kms:TagResource permission in an IAM policy.

" } } } @@ -970,7 +982,7 @@ } ], "traits": { - "smithy.api#documentation": "

Decrypts ciphertext that was encrypted by a AWS KMS customer master key (CMK) using any of\n the following operations:

\n \n

You can use this operation to decrypt ciphertext that was encrypted under a symmetric or\n asymmetric CMK. When the CMK is asymmetric, you must specify the CMK and the encryption\n algorithm that was used to encrypt the ciphertext. For information about symmetric and asymmetric CMKs, see Using Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.

\n

The Decrypt operation also decrypts ciphertext that was encrypted outside of AWS KMS by the\n public key in an AWS KMS asymmetric CMK. However, it cannot decrypt ciphertext produced by other\n libraries, such as the AWS Encryption\n SDK or Amazon S3 client-side encryption. These libraries return a ciphertext format that\n is incompatible with AWS KMS.

\n

If the ciphertext was encrypted under a symmetric CMK, you do not need to specify the CMK\n or the encryption algorithm. AWS KMS can get this information from metadata that it adds to the\n symmetric ciphertext blob. However, if you prefer, you can specify the KeyId to\n ensure that a particular CMK is used to decrypt the ciphertext. If you specify a different CMK\n than the one used to encrypt the ciphertext, the Decrypt operation fails.

\n

Whenever possible, use key policies to give users permission to call the Decrypt operation\n on a particular CMK, instead of using IAM policies. Otherwise, you might create an IAM user\n policy that gives the user Decrypt permission on all CMKs. This user could decrypt ciphertext\n that was encrypted by CMKs in other accounts if the key policy for the cross-account CMK\n permits it. If you must use an IAM policy for Decrypt permissions, limit the user\n to particular CMKs or particular trusted accounts.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see How Key State Affects Use\nof a Customer Master Key in the AWS Key Management Service Developer Guide.

" + "smithy.api#documentation": "

Decrypts ciphertext that was encrypted by a AWS KMS customer master key (CMK) using any of\n the following operations:

\n \n

You can use this operation to decrypt ciphertext that was encrypted under a symmetric or\n asymmetric CMK. When the CMK is asymmetric, you must specify the CMK and the encryption\n algorithm that was used to encrypt the ciphertext. For information about symmetric and asymmetric CMKs, see Using Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.

\n

The Decrypt operation also decrypts ciphertext that was encrypted outside of AWS KMS by the\n public key in an AWS KMS asymmetric CMK. However, it cannot decrypt ciphertext produced by other\n libraries, such as the AWS Encryption\n SDK or Amazon S3 client-side encryption. These libraries return a ciphertext format that\n is incompatible with AWS KMS.

\n

If the ciphertext was encrypted under a symmetric CMK, the KeyId parameter is\n optional. AWS KMS can get this information from metadata that it adds to the symmetric\n ciphertext blob. This feature adds durability to your implementation by ensuring that\n authorized users can decrypt ciphertext decades after it was encrypted, even if they've lost\n track of the CMK ID. However, specifying the CMK is always recommended as a best practice.\n When you use the KeyId parameter to specify a CMK, AWS KMS only uses the CMK you\n specify. If the ciphertext was encrypted under a different CMK, the Decrypt\n operation fails. This practice ensures that you use the CMK that you intend.

\n

Whenever possible, use key policies to give users permission to call the\n Decrypt operation on a particular CMK, instead of using IAM policies.\n Otherwise, you might create an IAM user policy that gives the user Decrypt\n permission on all CMKs. This user could decrypt ciphertext that was encrypted by CMKs in other\n accounts if the key policy for the cross-account CMK permits it. If you must use an IAM policy\n for Decrypt permissions, limit the user to particular CMKs or particular trusted\n accounts. For details, see Best practices for IAM policies in the AWS Key Management Service Developer Guide.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see How Key State Affects Use\nof a Customer Master Key in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: Yes. You can decrypt a ciphertext\n using a CMK in a different AWS account.

\n \n

\n Required permissions: kms:Decrypt (key policy)

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#DecryptRequest": { @@ -998,7 +1010,7 @@ "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

Specifies the customer master key (CMK) that AWS KMS will use to decrypt the ciphertext.\n Enter a key ID of the CMK that was used to encrypt the ciphertext.

\n

If you specify a KeyId value, the Decrypt operation succeeds\n only if the specified CMK was used to encrypt the ciphertext.

\n

This parameter is required only when the ciphertext was encrypted under an asymmetric CMK.\n Otherwise, AWS KMS uses the metadata that it adds to the ciphertext blob to determine which\n CMK was used to encrypt the ciphertext. However, you can use this parameter to ensure that a\n particular CMK (of any kind) is used to decrypt the ciphertext.

\n

To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\".

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

" + "smithy.api#documentation": "

Specifies the customer master key (CMK) that AWS KMS uses to decrypt the ciphertext. Enter a\n key ID of the CMK that was used to encrypt the ciphertext.

\n

This parameter is required only when the ciphertext was encrypted under an asymmetric CMK.\n If you used a symmetric CMK, AWS KMS can get the CMK from metadata that it adds to the\n symmetric ciphertext blob. However, it is always recommended as a best practice. This practice\n ensures that you use the CMK that you intend.

\n \n

To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

" } }, "EncryptionAlgorithm": { @@ -1052,7 +1064,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes the specified alias. You cannot perform this operation on an alias in a different AWS account.

\n

Because an alias is not a property of a CMK, you can delete and change the aliases of a\n CMK without affecting the CMK. Also, aliases do not appear in the response from the DescribeKey operation. To get the aliases of all CMKs, use the ListAliases operation.

\n

Each CMK can have multiple aliases. To change the alias of a CMK, use DeleteAlias to delete the current alias and CreateAlias to\n create a new alias. To associate an existing alias with a different customer master key (CMK),\n call UpdateAlias.

" + "smithy.api#documentation": "

Deletes the specified alias.

\n

Because an alias is not a property of a CMK, you can delete and change the aliases of a\n CMK without affecting the CMK. Also, aliases do not appear in the response from the DescribeKey operation. To get the aliases of all CMKs, use the ListAliases operation.

\n

Each CMK can have multiple aliases. To change the alias of a CMK, use DeleteAlias to delete the current alias and CreateAlias to\n create a new alias. To associate an existing alias with a different customer master key (CMK),\n call UpdateAlias.

\n

\n Cross-account use: No. You cannot perform this operation on an alias in a different AWS account.

\n

\n Required permissions\n

\n \n

For details, see Controlling access to aliases in the AWS Key Management Service Developer Guide.

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#DeleteAliasRequest": { @@ -1090,7 +1102,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a custom key store. This operation does not delete the AWS CloudHSM cluster that is\n associated with the custom key store, or affect any users or keys in the cluster.

\n

The custom key store that you delete cannot contain any AWS KMS customer master keys (CMKs). Before\n deleting the key store, verify that you will never need to use any of the CMKs in the key\n store for any cryptographic operations. Then, use ScheduleKeyDeletion to\n delete the AWS KMS customer master keys (CMKs) from the key store. When the scheduled waiting\n period expires, the ScheduleKeyDeletion operation deletes the CMKs. Then it makes\n a best effort to delete the key material from the associated cluster. However, you might need\n to manually delete the orphaned key\n material from the cluster and its backups.

\n

After all CMKs are deleted from AWS KMS, use DisconnectCustomKeyStore to\n disconnect the key store from AWS KMS. Then, you can delete the custom key store.

\n

Instead of deleting the custom key store, consider using DisconnectCustomKeyStore to disconnect it from AWS KMS. While the key store is\n disconnected, you cannot create or use the CMKs in the key store. But, you do not need to\n delete CMKs and you can reconnect a disconnected custom key store at any time.

\n

If the operation succeeds, it returns a JSON object with no\nproperties.

\n

This operation is part of the Custom Key Store feature feature in AWS KMS, which\ncombines the convenience and extensive integration of AWS KMS with the isolation and control of a\nsingle-tenant key store.

" + "smithy.api#documentation": "

Deletes a custom key store. This operation does not delete the AWS CloudHSM cluster that is\n associated with the custom key store, or affect any users or keys in the cluster.

\n

The custom key store that you delete cannot contain any AWS KMS customer master keys (CMKs). Before\n deleting the key store, verify that you will never need to use any of the CMKs in the key\n store for any cryptographic operations. Then, use ScheduleKeyDeletion to\n delete the AWS KMS customer master keys (CMKs) from the key store. When the scheduled waiting\n period expires, the ScheduleKeyDeletion operation deletes the CMKs. Then it makes\n a best effort to delete the key material from the associated cluster. However, you might need\n to manually delete the orphaned key\n material from the cluster and its backups.

\n

After all CMKs are deleted from AWS KMS, use DisconnectCustomKeyStore to\n disconnect the key store from AWS KMS. Then, you can delete the custom key store.

\n

Instead of deleting the custom key store, consider using DisconnectCustomKeyStore to disconnect it from AWS KMS. While the key store is\n disconnected, you cannot create or use the CMKs in the key store. But, you do not need to\n delete CMKs and you can reconnect a disconnected custom key store at any time.

\n

If the operation succeeds, it returns a JSON object with no\nproperties.

\n

This operation is part of the Custom Key Store feature feature in AWS KMS, which\ncombines the convenience and extensive integration of AWS KMS with the isolation and control of a\nsingle-tenant key store.

\n\n

\n Cross-account use: No. You cannot perform this operation on a custom key store in a different AWS account.

\n \n

\n Required permissions: kms:DeleteCustomKeyStore (IAM policy)

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#DeleteCustomKeyStoreRequest": { @@ -1135,7 +1147,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes key material that you previously imported. This operation makes the specified\n customer master key (CMK) unusable. For more information about importing key material into\n AWS KMS, see Importing Key\n Material in the AWS Key Management Service Developer Guide. You cannot perform this operation on a CMK in a different AWS account.

\n

When the specified CMK is in the PendingDeletion state, this operation does\n not change the CMK's state. Otherwise, it changes the CMK's state to\n PendingImport.

\n

After you delete key material, you can use ImportKeyMaterial to reimport\n the same key material into the CMK.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see How Key State Affects Use\nof a Customer Master Key in the AWS Key Management Service Developer Guide.

" + "smithy.api#documentation": "

Deletes key material that you previously imported. This operation makes the specified\n customer master key (CMK) unusable. For more information about importing key material into\n AWS KMS, see Importing Key\n Material in the AWS Key Management Service Developer Guide.

\n

When the specified CMK is in the PendingDeletion state, this operation does\n not change the CMK's state. Otherwise, it changes the CMK's state to\n PendingImport.

\n

After you delete key material, you can use ImportKeyMaterial to reimport\n the same key material into the CMK.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see How Key State Affects Use\nof a Customer Master Key in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.

\n \n

\n Required permissions: kms:DeleteImportedKeyMaterial (key policy)

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#DeleteImportedKeyMaterialRequest": { @@ -1180,7 +1192,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets information about custom key stores in the account and region.

\n

This operation is part of the Custom Key Store feature feature in AWS KMS, which\ncombines the convenience and extensive integration of AWS KMS with the isolation and control of a\nsingle-tenant key store.

\n

By default, this operation returns information about all custom key\n stores in the account and region. To get only information about a particular custom key store,\n use either the CustomKeyStoreName or CustomKeyStoreId parameter (but\n not both).

\n

To determine whether the custom key store is connected to its AWS CloudHSM cluster, use the\n ConnectionState element in the response. If an attempt to connect the custom\n key store failed, the ConnectionState value is FAILED and the\n ConnectionErrorCode element in the response indicates the cause of the failure.\n For help interpreting the ConnectionErrorCode, see CustomKeyStoresListEntry.

\n

Custom key stores have a DISCONNECTED connection state if the key store has\n never been connected or you use the DisconnectCustomKeyStore operation to\n disconnect it. If your custom key store state is CONNECTED but you are having\n trouble using it, make sure that its associated AWS CloudHSM cluster is active and contains the\n minimum number of HSMs required for the operation, if any.

\n

For help repairing your custom key store, see the Troubleshooting Custom Key Stores topic in the\n AWS Key Management Service Developer Guide.

" + "smithy.api#documentation": "

Gets information about custom key stores in the account and region.

\n

This operation is part of the Custom Key Store feature feature in AWS KMS, which\ncombines the convenience and extensive integration of AWS KMS with the isolation and control of a\nsingle-tenant key store.

\n

By default, this operation returns information about all custom key\n stores in the account and region. To get only information about a particular custom key store,\n use either the CustomKeyStoreName or CustomKeyStoreId parameter (but\n not both).

\n

To determine whether the custom key store is connected to its AWS CloudHSM cluster, use the\n ConnectionState element in the response. If an attempt to connect the custom\n key store failed, the ConnectionState value is FAILED and the\n ConnectionErrorCode element in the response indicates the cause of the failure.\n For help interpreting the ConnectionErrorCode, see CustomKeyStoresListEntry.

\n

Custom key stores have a DISCONNECTED connection state if the key store has\n never been connected or you use the DisconnectCustomKeyStore operation to\n disconnect it. If your custom key store state is CONNECTED but you are having\n trouble using it, make sure that its associated AWS CloudHSM cluster is active and contains the\n minimum number of HSMs required for the operation, if any.

\n

For help repairing your custom key store, see the Troubleshooting Custom Key Stores topic in the\n AWS Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a custom key store in a different AWS account.

\n

\n Required permissions: kms:DescribeCustomKeyStores (IAM policy)

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#DescribeCustomKeyStoresRequest": { @@ -1258,7 +1270,7 @@ } ], "traits": { - "smithy.api#documentation": "

Provides detailed information about a customer master key (CMK). You can run\n DescribeKey on a customer managed CMK or an AWS managed\n CMK.

\n

This detailed information includes the key ARN, creation date (and deletion date, if\n applicable), the key state, and the origin and expiration date (if any) of the key material.\n For CMKs in custom key stores, it includes information about the custom key store, such as the\n key store ID and the AWS CloudHSM cluster ID. It includes fields, like KeySpec, that\n help you distinguish symmetric from asymmetric CMKs. It also provides information that is\n particularly important to asymmetric CMKs, such as the key usage (encryption or signing) and\n the encryption algorithms or signing algorithms that the CMK supports.

\n

\n DescribeKey does not return the following information:

\n \n

If you call the DescribeKey operation on a predefined AWS\n alias, that is, an AWS alias with no key ID, AWS KMS creates an AWS managed CMK.\n Then, it associates the alias with the new CMK, and returns the KeyId and\n Arn of the new CMK in the response.

\n

To perform this operation on a CMK in a different AWS account, specify\n the key ARN or alias ARN in the value of the KeyId parameter.

" + "smithy.api#documentation": "

Provides detailed information about a customer master key (CMK). You can run\n DescribeKey on a customer managed CMK or an AWS managed\n CMK.

\n

This detailed information includes the key ARN, creation date (and deletion date, if\n applicable), the key state, and the origin and expiration date (if any) of the key material.\n For CMKs in custom key stores, it includes information about the custom key store, such as the\n key store ID and the AWS CloudHSM cluster ID. It includes fields, like KeySpec, that\n help you distinguish symmetric from asymmetric CMKs. It also provides information that is\n particularly important to asymmetric CMKs, such as the key usage (encryption or signing) and\n the encryption algorithms or signing algorithms that the CMK supports.

\n

\n DescribeKey does not return the following information:

\n \n

If you call the DescribeKey operation on a predefined AWS\n alias, that is, an AWS alias with no key ID, AWS KMS creates an AWS managed CMK.\n Then, it associates the alias with the new CMK, and returns the KeyId and\n Arn of the new CMK in the response.

\n

\n Cross-account use: Yes. To perform this operation with a CMK in a different AWS account, specify\n the key ARN or alias ARN in the value of the KeyId parameter.

\n \n

\n Required permissions: kms:DescribeKey (key policy)

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#DescribeKeyRequest": { @@ -1322,7 +1334,7 @@ } ], "traits": { - "smithy.api#documentation": "

Sets the state of a customer master key (CMK) to disabled, thereby preventing its use for\n cryptographic operations. You cannot perform this operation on a CMK in a different AWS account.

\n

For more information about how key state affects the use of a CMK, see How Key State Affects the Use of a\n Customer Master Key in the \n AWS Key Management Service Developer Guide\n .

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see How Key State Affects Use\nof a Customer Master Key in the AWS Key Management Service Developer Guide.

" + "smithy.api#documentation": "

Sets the state of a customer master key (CMK) to disabled. This change temporarily\n prevents use of the CMK for cryptographic operations.

\n

For more information about how key state affects the use of a CMK, see How Key State Affects the Use of a\n Customer Master Key in the \n AWS Key Management Service Developer Guide\n .

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see How Key State Affects Use\nof a Customer Master Key in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.

\n \n

\n Required permissions: kms:DisableKey (key policy)

\n

\n Related operations: EnableKey\n

" } }, "com.amazonaws.kms#DisableKeyRequest": { @@ -1366,7 +1378,7 @@ } ], "traits": { - "smithy.api#documentation": "

Disables automatic\n rotation of the key material for the specified symmetric customer master key\n (CMK).

\n

You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store. You cannot perform this operation on a CMK in a different AWS account.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see How Key State Affects Use\nof a Customer Master Key in the AWS Key Management Service Developer Guide.

" + "smithy.api#documentation": "

Disables automatic\n rotation of the key material for the specified symmetric customer master key\n (CMK).

\n

You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see How Key State Affects Use\nof a Customer Master Key in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.

\n \n

\n Required permissions: kms:DisableKeyRotation (key policy)

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#DisableKeyRotationRequest": { @@ -1375,7 +1387,7 @@ "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

Identifies a symmetric customer master key (CMK). You cannot enable automatic rotation of\n asymmetric CMKs, CMKs with imported key material, or CMKs in a\n custom key store.

\n

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

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

Identifies a symmetric customer master key (CMK). You cannot enable or disable automatic\n rotation of asymmetric CMKs, CMKs\n with imported key\n material, or CMKs in a custom key store.

\n

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

", "smithy.api#required": {} } } @@ -1414,7 +1426,7 @@ } ], "traits": { - "smithy.api#documentation": "

Disconnects the custom key store from its associated AWS CloudHSM cluster. While a custom key\n store is disconnected, you can manage the custom key store and its customer master keys\n (CMKs), but you cannot create or use CMKs in the custom key store. You can reconnect the\n custom key store at any time.

\n \n

While a custom key store is disconnected, all attempts to create customer master keys\n (CMKs) in the custom key store or to use existing CMKs in cryptographic operations will\n fail. This action can prevent users from storing and accessing sensitive data.

\n \n

\n

To find the connection state of a custom key store, use the DescribeCustomKeyStores operation. To reconnect a custom key store, use the\n ConnectCustomKeyStore operation.

\n

If the operation succeeds, it returns a JSON object with no\nproperties.

\n

This operation is part of the Custom Key Store feature feature in AWS KMS, which\ncombines the convenience and extensive integration of AWS KMS with the isolation and control of a\nsingle-tenant key store.

" + "smithy.api#documentation": "

Disconnects the custom key store from its associated AWS CloudHSM cluster. While a custom key\n store is disconnected, you can manage the custom key store and its customer master keys\n (CMKs), but you cannot create or use CMKs in the custom key store. You can reconnect the\n custom key store at any time.

\n \n

While a custom key store is disconnected, all attempts to create customer master keys\n (CMKs) in the custom key store or to use existing CMKs in cryptographic operations will\n fail. This action can prevent users from storing and accessing sensitive data.

\n \n

\n

To find the connection state of a custom key store, use the DescribeCustomKeyStores operation. To reconnect a custom key store, use the\n ConnectCustomKeyStore operation.

\n

If the operation succeeds, it returns a JSON object with no\nproperties.

\n

This operation is part of the Custom Key Store feature feature in AWS KMS, which\ncombines the convenience and extensive integration of AWS KMS with the isolation and control of a\nsingle-tenant key store.

\n\n

\n Cross-account use: No. You cannot perform this operation on a custom key store in a different AWS account.

\n \n

\n Required permissions: kms:DisconnectCustomKeyStore (IAM policy)

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#DisconnectCustomKeyStoreRequest": { @@ -1459,7 +1471,7 @@ } ], "traits": { - "smithy.api#documentation": "

Sets the key state of a customer master key (CMK) to enabled. This allows you to use the\n CMK for cryptographic operations. You cannot perform this operation on a CMK in a different AWS account.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see How Key State Affects Use\nof a Customer Master Key in the AWS Key Management Service Developer Guide.

" + "smithy.api#documentation": "

Sets the key state of a customer master key (CMK) to enabled. This allows you to use the\n CMK for cryptographic operations.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see How Key State Affects Use\nof a Customer Master Key in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.

\n \n

\n Required permissions: kms:EnableKey (key policy)

\n

\n Related operations: DisableKey\n

" } }, "com.amazonaws.kms#EnableKeyRequest": { @@ -1503,7 +1515,7 @@ } ], "traits": { - "smithy.api#documentation": "

Enables automatic rotation\n of the key material for the specified symmetric customer master key (CMK).\n You cannot perform this operation on a CMK in a different AWS account.

\n

You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see How Key State Affects Use\nof a Customer Master Key in the AWS Key Management Service Developer Guide.

" + "smithy.api#documentation": "

Enables automatic rotation\n of the key material for the specified symmetric customer master key (CMK).

\n

You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see How Key State Affects Use\nof a Customer Master Key in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.

\n \n

\n Required permissions: kms:EnableKeyRotation (key policy)

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#EnableKeyRotationRequest": { @@ -1553,7 +1565,7 @@ } ], "traits": { - "smithy.api#documentation": "

Encrypts plaintext into ciphertext by using a customer master key (CMK). The\n Encrypt operation has two primary use cases:

\n \n\n

You don't need to use the Encrypt operation to encrypt a data key. The GenerateDataKey and GenerateDataKeyPair operations return a\n plaintext data key and an encrypted copy of that data key.

\n\n

When you encrypt data, you must specify a symmetric or asymmetric CMK to use in the\n encryption operation. The CMK must have a KeyUsage value of\n ENCRYPT_DECRYPT. To find the KeyUsage of a CMK, use the DescribeKey operation.

\n\n

If you use a symmetric CMK, you can use an encryption context to add additional security\n to your encryption operation. If you specify an EncryptionContext when encrypting\n data, you must specify the same encryption context (a case-sensitive exact match) when\n decrypting the data. Otherwise, the request to decrypt fails with an\n InvalidCiphertextException. For more information, see Encryption\n Context in the AWS Key Management Service Developer Guide.

\n

If you specify an asymmetric CMK, you must also specify the encryption algorithm. The\n algorithm must be compatible with the CMK type.

\n \n

When you use an asymmetric CMK to encrypt or reencrypt data, be sure to record the CMK and encryption algorithm that you choose. You will be required to provide the same CMK and encryption algorithm when you decrypt the data. If the CMK and algorithm do not match the values used to encrypt the data, the decrypt operation fails.

\n

You are not required to supply the CMK ID and encryption algorithm when you decrypt with symmetric CMKs because AWS KMS stores this information in the ciphertext blob. AWS KMS cannot store metadata in ciphertext generated with asymmetric keys. The standard format for asymmetric key ciphertext does not include configurable fields.

\n \n\n\n

The maximum size of the data that you can encrypt varies with the type of CMK and the\n encryption algorithm that you choose.

\n \n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see How Key State Affects Use\nof a Customer Master Key in the AWS Key Management Service Developer Guide.

\n

To perform this operation on a CMK in a different AWS account, specify\n the key ARN or alias ARN in the value of the KeyId parameter.

" + "smithy.api#documentation": "

Encrypts plaintext into ciphertext by using a customer master key (CMK). The\n Encrypt operation has two primary use cases:

\n \n\n

You don't need to use the Encrypt operation to encrypt a data key. The GenerateDataKey and GenerateDataKeyPair operations return a\n plaintext data key and an encrypted copy of that data key.

\n\n

When you encrypt data, you must specify a symmetric or asymmetric CMK to use in the\n encryption operation. The CMK must have a KeyUsage value of\n ENCRYPT_DECRYPT. To find the KeyUsage of a CMK, use the DescribeKey operation.

\n\n

If you use a symmetric CMK, you can use an encryption context to add additional security\n to your encryption operation. If you specify an EncryptionContext when encrypting\n data, you must specify the same encryption context (a case-sensitive exact match) when\n decrypting the data. Otherwise, the request to decrypt fails with an\n InvalidCiphertextException. For more information, see Encryption\n Context in the AWS Key Management Service Developer Guide.

\n

If you specify an asymmetric CMK, you must also specify the encryption algorithm. The\n algorithm must be compatible with the CMK type.

\n \n

When you use an asymmetric CMK to encrypt or reencrypt data, be sure to record the CMK and encryption algorithm that you choose. You will be required to provide the same CMK and encryption algorithm when you decrypt the data. If the CMK and algorithm do not match the values used to encrypt the data, the decrypt operation fails.

\n

You are not required to supply the CMK ID and encryption algorithm when you decrypt with symmetric CMKs because AWS KMS stores this information in the ciphertext blob. AWS KMS cannot store metadata in ciphertext generated with asymmetric keys. The standard format for asymmetric key ciphertext does not include configurable fields.

\n \n\n\n

The maximum size of the data that you can encrypt varies with the type of CMK and the\n encryption algorithm that you choose.

\n \n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see How Key State Affects Use\nof a Customer Master Key in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: Yes. To perform this operation with a CMK in a different AWS account, specify\n the key ARN or alias ARN in the value of the KeyId parameter.

\n \n

\n Required permissions: kms:Encrypt (key policy)

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#EncryptRequest": { @@ -1722,7 +1734,7 @@ } ], "traits": { - "smithy.api#documentation": "

Generates a unique symmetric data key for client-side encryption. This operation returns a\n plaintext copy of the data key and a copy that is encrypted under a customer master key (CMK)\n that you specify. You can use the plaintext key to encrypt your data outside of AWS KMS and\n store the encrypted data key with the encrypted data.

\n\n

\n GenerateDataKey returns a unique data key for each request. The bytes in the\n plaintext key are not related to the caller or the CMK.

\n\n

To generate a data key, specify the symmetric CMK that will be used to encrypt the data\n key. You cannot use an asymmetric CMK to generate data keys. To get the type of your CMK, use\n the DescribeKey operation. You must also specify the length of the data key.\n Use either the KeySpec or NumberOfBytes parameters (but not both).\n For 128-bit and 256-bit data keys, use the KeySpec parameter.

\n\n

To get only an encrypted copy of the data key, use GenerateDataKeyWithoutPlaintext. To generate an asymmetric data key pair, use\n the GenerateDataKeyPair or GenerateDataKeyPairWithoutPlaintext operation. To get a cryptographically secure\n random byte string, use GenerateRandom.

\n\n

You can use the optional encryption context to add additional security to the encryption\n operation. If you specify an EncryptionContext, you must specify the same\n encryption context (a case-sensitive exact match) when decrypting the encrypted data key.\n Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more information, see Encryption Context in the\n AWS Key Management Service Developer Guide.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see How Key State Affects Use\nof a Customer Master Key in the AWS Key Management Service Developer Guide.

\n

\n How to use your data key\n

\n

We recommend that you use the following pattern to encrypt data locally in your application.\n You can write your own code or use a client-side encryption library, such as the AWS Encryption SDK, the Amazon DynamoDB Encryption Client, or\n Amazon S3\n client-side encryption to do these tasks for you.

\n

To encrypt data outside of AWS KMS:

\n
    \n
  1. \n

    Use the GenerateDataKey operation to get a data key.

    \n
    2. \n
  2. \n

    Use the plaintext data key (in the Plaintext field of the response) to\n encrypt your data outside of AWS KMS. Then erase the plaintext data key from memory.

    \n
    3. \n
  3. \n

    Store the encrypted data key (in the CiphertextBlob field of the\n response) with the encrypted data.

    \n
    4. \n
\n

To decrypt data outside of AWS KMS:

\n
    \n
  1. \n

    Use the Decrypt operation to decrypt the encrypted data key. The\n operation returns a plaintext copy of the data key.

    \n
    2. \n
  2. \n

    Use the plaintext data key to decrypt data outside of AWS KMS, then erase the plaintext\n data key from memory.

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

Generates a unique symmetric data key for client-side encryption. This operation returns a\n plaintext copy of the data key and a copy that is encrypted under a customer master key (CMK)\n that you specify. You can use the plaintext key to encrypt your data outside of AWS KMS and\n store the encrypted data key with the encrypted data.

\n\n

\n GenerateDataKey returns a unique data key for each request. The bytes in the\n plaintext key are not related to the caller or the CMK.

\n\n

To generate a data key, specify the symmetric CMK that will be used to encrypt the data\n key. You cannot use an asymmetric CMK to generate data keys. To get the type of your CMK, use\n the DescribeKey operation. You must also specify the length of the data key.\n Use either the KeySpec or NumberOfBytes parameters (but not both).\n For 128-bit and 256-bit data keys, use the KeySpec parameter.

\n\n

To get only an encrypted copy of the data key, use GenerateDataKeyWithoutPlaintext. To generate an asymmetric data key pair, use\n the GenerateDataKeyPair or GenerateDataKeyPairWithoutPlaintext operation. To get a cryptographically secure\n random byte string, use GenerateRandom.

\n\n

You can use the optional encryption context to add additional security to the encryption\n operation. If you specify an EncryptionContext, you must specify the same\n encryption context (a case-sensitive exact match) when decrypting the encrypted data key.\n Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more information, see Encryption Context in the\n AWS Key Management Service Developer Guide.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see How Key State Affects Use\nof a Customer Master Key in the AWS Key Management Service Developer Guide.

\n

\n How to use your data key\n

\n

We recommend that you use the following pattern to encrypt data locally in your application.\n You can write your own code or use a client-side encryption library, such as the AWS Encryption SDK, the Amazon DynamoDB Encryption Client, or\n Amazon S3\n client-side encryption to do these tasks for you.

\n

To encrypt data outside of AWS KMS:

\n
    \n
  1. \n

    Use the GenerateDataKey operation to get a data key.

    \n
    2. \n
  2. \n

    Use the plaintext data key (in the Plaintext field of the response) to\n encrypt your data outside of AWS KMS. Then erase the plaintext data key from memory.

    \n
    3. \n
  3. \n

    Store the encrypted data key (in the CiphertextBlob field of the\n response) with the encrypted data.

    \n
    4. \n
\n

To decrypt data outside of AWS KMS:

\n
    \n
  1. \n

    Use the Decrypt operation to decrypt the encrypted data key. The\n operation returns a plaintext copy of the data key.

    \n
    2. \n
  2. \n

    Use the plaintext data key to decrypt data outside of AWS KMS, then erase the plaintext\n data key from memory.

    \n
    3. \n
\n

\n Cross-account use: Yes. To perform this operation with a CMK in a different AWS account, specify\n the key ARN or alias ARN in the value of the KeyId parameter.

\n \n

\n Required permissions: kms:GenerateDataKey (key policy)

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#GenerateDataKeyPair": { @@ -1763,7 +1775,7 @@ } ], "traits": { - "smithy.api#documentation": "

Generates a unique asymmetric data key pair. The GenerateDataKeyPair\n operation returns a plaintext public key, a plaintext private key, and a copy of the private\n key that is encrypted under the symmetric CMK you specify. You can use the data key pair to\n perform asymmetric cryptography outside of AWS KMS.

\n\n

\n GenerateDataKeyPair returns a unique data key pair for each request. The\n bytes in the keys are not related to the caller or the CMK that is used to encrypt the private\n key.

\n\n

You can use the public key that GenerateDataKeyPair returns to encrypt data\n or verify a signature outside of AWS KMS. Then, store the encrypted private key with the data.\n When you are ready to decrypt data or sign a message, you can use the Decrypt operation to decrypt the encrypted private key.

\n\n

To generate a data key pair, you must specify a symmetric customer master key (CMK) to\n encrypt the private key in a data key pair. You cannot use an asymmetric CMK or a CMK in a\n custom key store. To get the type and origin of your CMK, use the DescribeKey operation.

\n\n

If you are using the data key pair to encrypt data, or for any operation where you don't\n immediately need a private key, consider using the GenerateDataKeyPairWithoutPlaintext operation.\n GenerateDataKeyPairWithoutPlaintext returns a plaintext public key and an\n encrypted private key, but omits the plaintext private key that you need only to decrypt\n ciphertext or sign a message. Later, when you need to decrypt the data or sign a message, use\n the Decrypt operation to decrypt the encrypted private key in the data key\n pair.

\n\n

You can use the optional encryption context to add additional security to the encryption\n operation. If you specify an EncryptionContext, you must specify the same\n encryption context (a case-sensitive exact match) when decrypting the encrypted data key.\n Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more information, see Encryption Context in the\n AWS Key Management Service Developer Guide.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see How Key State Affects Use\nof a Customer Master Key in the AWS Key Management Service Developer Guide.

" + "smithy.api#documentation": "

Generates a unique asymmetric data key pair. The GenerateDataKeyPair\n operation returns a plaintext public key, a plaintext private key, and a copy of the private\n key that is encrypted under the symmetric CMK you specify. You can use the data key pair to\n perform asymmetric cryptography outside of AWS KMS.

\n\n

\n GenerateDataKeyPair returns a unique data key pair for each request. The\n bytes in the keys are not related to the caller or the CMK that is used to encrypt the private\n key.

\n\n

You can use the public key that GenerateDataKeyPair returns to encrypt data\n or verify a signature outside of AWS KMS. Then, store the encrypted private key with the data.\n When you are ready to decrypt data or sign a message, you can use the Decrypt operation to decrypt the encrypted private key.

\n\n

To generate a data key pair, you must specify a symmetric customer master key (CMK) to\n encrypt the private key in a data key pair. You cannot use an asymmetric CMK or a CMK in a\n custom key store. To get the type and origin of your CMK, use the DescribeKey operation.

\n\n

If you are using the data key pair to encrypt data, or for any operation where you don't\n immediately need a private key, consider using the GenerateDataKeyPairWithoutPlaintext operation.\n GenerateDataKeyPairWithoutPlaintext returns a plaintext public key and an\n encrypted private key, but omits the plaintext private key that you need only to decrypt\n ciphertext or sign a message. Later, when you need to decrypt the data or sign a message, use\n the Decrypt operation to decrypt the encrypted private key in the data key\n pair.

\n\n

You can use the optional encryption context to add additional security to the encryption\n operation. If you specify an EncryptionContext, you must specify the same\n encryption context (a case-sensitive exact match) when decrypting the encrypted data key.\n Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more information, see Encryption Context in the\n AWS Key Management Service Developer Guide.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see How Key State Affects Use\nof a Customer Master Key in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: Yes. To perform this operation with a CMK in a different AWS account, specify\n the key ARN or alias ARN in the value of the KeyId parameter.

\n \n

\n Required permissions: kms:GenerateDataKeyPair (key policy)

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#GenerateDataKeyPairRequest": { @@ -1870,7 +1882,7 @@ } ], "traits": { - "smithy.api#documentation": "

Generates a unique asymmetric data key pair. The\n GenerateDataKeyPairWithoutPlaintext operation returns a plaintext public key\n and a copy of the private key that is encrypted under the symmetric CMK you specify. Unlike\n GenerateDataKeyPair, this operation does not return a plaintext private\n key.

\n

To generate a data key pair, you must specify a symmetric customer master key (CMK) to\n encrypt the private key in the data key pair. You cannot use an asymmetric CMK or a CMK in a\n custom key store. To get the type and origin of your CMK, use the KeySpec field\n in the DescribeKey response.

\n

You can use the public key that GenerateDataKeyPairWithoutPlaintext returns\n to encrypt data or verify a signature outside of AWS KMS. Then, store the encrypted private key\n with the data. When you are ready to decrypt data or sign a message, you can use the Decrypt operation to decrypt the encrypted private key.

\n

\n GenerateDataKeyPairWithoutPlaintext returns a unique data key pair for each\n request. The bytes in the key are not related to the caller or CMK that is used to encrypt the\n private key.

\n\n

You can use the optional encryption context to add additional security to the encryption\n operation. If you specify an EncryptionContext, you must specify the same\n encryption context (a case-sensitive exact match) when decrypting the encrypted data key.\n Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more information, see Encryption Context in the\n AWS Key Management Service Developer Guide.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see How Key State Affects Use\nof a Customer Master Key in the AWS Key Management Service Developer Guide.

" + "smithy.api#documentation": "

Generates a unique asymmetric data key pair. The\n GenerateDataKeyPairWithoutPlaintext operation returns a plaintext public key\n and a copy of the private key that is encrypted under the symmetric CMK you specify. Unlike\n GenerateDataKeyPair, this operation does not return a plaintext private\n key.

\n

To generate a data key pair, you must specify a symmetric customer master key (CMK) to\n encrypt the private key in the data key pair. You cannot use an asymmetric CMK or a CMK in a\n custom key store. To get the type and origin of your CMK, use the KeySpec field\n in the DescribeKey response.

\n

You can use the public key that GenerateDataKeyPairWithoutPlaintext returns\n to encrypt data or verify a signature outside of AWS KMS. Then, store the encrypted private key\n with the data. When you are ready to decrypt data or sign a message, you can use the Decrypt operation to decrypt the encrypted private key.

\n

\n GenerateDataKeyPairWithoutPlaintext returns a unique data key pair for each\n request. The bytes in the key are not related to the caller or CMK that is used to encrypt the\n private key.

\n\n

You can use the optional encryption context to add additional security to the encryption\n operation. If you specify an EncryptionContext, you must specify the same\n encryption context (a case-sensitive exact match) when decrypting the encrypted data key.\n Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more information, see Encryption Context in the\n AWS Key Management Service Developer Guide.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see How Key State Affects Use\nof a Customer Master Key in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: Yes. To perform this operation with a CMK in a different AWS account, specify\n the key ARN or alias ARN in the value of the KeyId parameter.

\n \n

\n Required permissions: kms:GenerateDataKeyPairWithoutPlaintext (key policy)

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#GenerateDataKeyPairWithoutPlaintextRequest": { @@ -1885,7 +1897,7 @@ "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

Specifies the CMK that encrypts the private key in the data key pair. You must specify a\n symmetric CMK. You cannot use an asymmetric CMK or a CMK in a custom key store. To get the\n type and origin of your CMK, use the DescribeKey operation.

\n

To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\".

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

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

Specifies the CMK that encrypts the private key in the data key pair. You must specify a\n symmetric CMK. You cannot use an asymmetric CMK or a CMK in a custom key store. To get the\n type and origin of your CMK, use the DescribeKey operation.

\n

To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

", "smithy.api#required": {} } }, @@ -2027,7 +2039,7 @@ } ], "traits": { - "smithy.api#documentation": "

Generates a unique symmetric data key. This operation returns a data key that is encrypted\n under a customer master key (CMK) that you specify. To request an asymmetric data key pair,\n use the GenerateDataKeyPair or GenerateDataKeyPairWithoutPlaintext operations.

\n

\n GenerateDataKeyWithoutPlaintext is identical to the GenerateDataKey operation except that returns only the encrypted copy of the\n data key. This operation is useful for systems that need to encrypt data at some point, but\n not immediately. When you need to encrypt the data, you call the Decrypt\n operation on the encrypted copy of the key.

\n

It's also useful in distributed systems with different levels of trust. For example, you\n might store encrypted data in containers. One component of your system creates new containers\n and stores an encrypted data key with each container. Then, a different component puts the\n data into the containers. That component first decrypts the data key, uses the plaintext data\n key to encrypt data, puts the encrypted data into the container, and then destroys the\n plaintext data key. In this system, the component that creates the containers never sees the\n plaintext data key.

\n

\n GenerateDataKeyWithoutPlaintext returns a unique data key for each request.\n The bytes in the keys are not related to the caller or CMK that is used to encrypt the private\n key.

\n\n

To generate a data key, you must specify the symmetric customer master key (CMK) that is\n used to encrypt the data key. You cannot use an asymmetric CMK to generate a data key. To get the type\n of your CMK, use the DescribeKey operation.

\n\n

If the operation succeeds, you will find the encrypted copy of the data key in the\n CiphertextBlob field.

\n\n

You can use the optional encryption context to add additional security to the encryption\n operation. If you specify an EncryptionContext, you must specify the same\n encryption context (a case-sensitive exact match) when decrypting the encrypted data key.\n Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more information, see Encryption Context in the\n AWS Key Management Service Developer Guide.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see How Key State Affects Use\nof a Customer Master Key in the AWS Key Management Service Developer Guide.

" + "smithy.api#documentation": "

Generates a unique symmetric data key. This operation returns a data key that is encrypted\n under a customer master key (CMK) that you specify. To request an asymmetric data key pair,\n use the GenerateDataKeyPair or GenerateDataKeyPairWithoutPlaintext operations.

\n

\n GenerateDataKeyWithoutPlaintext is identical to the GenerateDataKey operation except that returns only the encrypted copy of the\n data key. This operation is useful for systems that need to encrypt data at some point, but\n not immediately. When you need to encrypt the data, you call the Decrypt\n operation on the encrypted copy of the key.

\n

It's also useful in distributed systems with different levels of trust. For example, you\n might store encrypted data in containers. One component of your system creates new containers\n and stores an encrypted data key with each container. Then, a different component puts the\n data into the containers. That component first decrypts the data key, uses the plaintext data\n key to encrypt data, puts the encrypted data into the container, and then destroys the\n plaintext data key. In this system, the component that creates the containers never sees the\n plaintext data key.

\n

\n GenerateDataKeyWithoutPlaintext returns a unique data key for each request.\n The bytes in the keys are not related to the caller or CMK that is used to encrypt the private\n key.

\n\n

To generate a data key, you must specify the symmetric customer master key (CMK) that is\n used to encrypt the data key. You cannot use an asymmetric CMK to generate a data key. To get the type\n of your CMK, use the DescribeKey operation.

\n\n

If the operation succeeds, you will find the encrypted copy of the data key in the\n CiphertextBlob field.

\n\n

You can use the optional encryption context to add additional security to the encryption\n operation. If you specify an EncryptionContext, you must specify the same\n encryption context (a case-sensitive exact match) when decrypting the encrypted data key.\n Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more information, see Encryption Context in the\n AWS Key Management Service Developer Guide.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see How Key State Affects Use\nof a Customer Master Key in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: Yes. To perform this operation with a CMK in a different AWS account, specify\n the key ARN or alias ARN in the value of the KeyId parameter.

\n \n

\n Required permissions: kms:GenerateDataKeyWithoutPlaintext (key policy)

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#GenerateDataKeyWithoutPlaintextRequest": { @@ -2106,7 +2118,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a random byte string that is cryptographically secure.

\n

By default, the random byte string is generated in AWS KMS. To generate the byte string in\n the AWS CloudHSM cluster that is associated with a custom key store, specify the custom key store\n ID.

\n

For more information about entropy and random number generation, see the AWS Key Management Service\n Cryptographic Details whitepaper.

" + "smithy.api#documentation": "

Returns a random byte string that is cryptographically secure.

\n

By default, the random byte string is generated in AWS KMS. To generate the byte string in\n the AWS CloudHSM cluster that is associated with a custom key store, specify the custom key store\n ID.

\n

For more information about entropy and random number generation, see the AWS Key Management Service\n Cryptographic Details whitepaper.

\n \n

\n Required permissions: kms:GenerateRandom (IAM policy)

" } }, "com.amazonaws.kms#GenerateRandomRequest": { @@ -2163,7 +2175,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets a key policy attached to the specified customer master key (CMK).\n You cannot perform this operation on a CMK in a different AWS account.

" + "smithy.api#documentation": "

Gets a key policy attached to the specified customer master key (CMK).

\n

\n Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.

\n \n

\n Required permissions: kms:GetKeyPolicy (key policy)

\n

\n Related operations: PutKeyPolicy\n

" } }, "com.amazonaws.kms#GetKeyPolicyRequest": { @@ -2225,7 +2237,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets a Boolean value that indicates whether automatic rotation of the key material is\n enabled for the specified customer master key (CMK).

\n

You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store. The key rotation status for these CMKs is always false.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see How Key State Affects Use\nof a Customer Master Key in the AWS Key Management Service Developer Guide.

\n \n

To perform this operation on a CMK in a different AWS account, specify the key\n ARN in the value of the KeyId parameter.

" + "smithy.api#documentation": "

Gets a Boolean value that indicates whether automatic rotation of the key material is\n enabled for the specified customer master key (CMK).

\n

You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store. The key rotation status for these CMKs is always false.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see How Key State Affects Use\nof a Customer Master Key in the AWS Key Management Service Developer Guide.

\n \n

\n Cross-account use: Yes. To perform this operation on a CMK in a different AWS account, specify the key\n ARN in the value of the KeyId parameter.

\n \n

\n Required permissions: kms:GetKeyRotationStatus (key policy)

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#GetKeyRotationStatusRequest": { @@ -2280,7 +2292,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns the items you need to import key material into a symmetric, customer managed\n customer master key (CMK). For more information about importing key material into AWS KMS, see\n Importing Key\n Material in the AWS Key Management Service Developer Guide.

\n

This operation returns a public key and an import token. Use the public key to encrypt the\n symmetric key material. Store the import token to send with a subsequent ImportKeyMaterial request.

\n

You must specify the key ID of the symmetric CMK into which you will import key material.\n This CMK's Origin must be EXTERNAL. You must also specify the\n wrapping algorithm and type of wrapping key (public key) that you will use to encrypt the key\n material. You cannot perform this operation on an asymmetric CMK or on any CMK in a different AWS account.

\n

To import key material, you must use the public key and import token from the same\n response. These items are valid for 24 hours. The expiration date and time appear in the\n GetParametersForImport response. You cannot use an expired token in an ImportKeyMaterial request. If your key and token expire, send another\n GetParametersForImport request.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see How Key State Affects Use\nof a Customer Master Key in the AWS Key Management Service Developer Guide.

" + "smithy.api#documentation": "

Returns the items you need to import key material into a symmetric, customer managed\n customer master key (CMK). For more information about importing key material into AWS KMS, see\n Importing Key\n Material in the AWS Key Management Service Developer Guide.

\n

This operation returns a public key and an import token. Use the public key to encrypt the\n symmetric key material. Store the import token to send with a subsequent ImportKeyMaterial request.

\n

You must specify the key ID of the symmetric CMK into which you will import key material.\n This CMK's Origin must be EXTERNAL. You must also specify the\n wrapping algorithm and type of wrapping key (public key) that you will use to encrypt the key\n material. You cannot perform this operation on an asymmetric CMK or on any CMK in a different AWS account.

\n

To import key material, you must use the public key and import token from the same\n response. These items are valid for 24 hours. The expiration date and time appear in the\n GetParametersForImport response. You cannot use an expired token in an ImportKeyMaterial request. If your key and token expire, send another\n GetParametersForImport request.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see How Key State Affects Use\nof a Customer Master Key in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.

\n \n

\n Required permissions: kms:GetParametersForImport (key policy)

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#GetParametersForImportRequest": { @@ -2379,7 +2391,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns the public key of an asymmetric CMK. Unlike the private key of a asymmetric CMK,\n which never leaves AWS KMS unencrypted, callers with kms:GetPublicKey permission\n can download the public key of an asymmetric CMK. You can share the public key to allow others\n to encrypt messages and verify signatures outside of AWS KMS. For information about symmetric and asymmetric CMKs, see Using Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.

\n

You do not need to download the public key. Instead, you can use the public key within\n AWS KMS by calling the Encrypt, ReEncrypt, or Verify operations with the identifier of an asymmetric CMK. When you use the\n public key within AWS KMS, you benefit from the authentication, authorization, and logging that\n are part of every AWS KMS operation. You also reduce of risk of encrypting data that cannot be\n decrypted. These features are not effective outside of AWS KMS. For details, see Special Considerations\n for Downloading Public Keys.

\n

To help you use the public key safely outside of AWS KMS, GetPublicKey returns\n important information about the public key in the response, including:

\n \n \n

Although AWS KMS cannot enforce these restrictions on external operations, it is crucial\n that you use this information to prevent the public key from being used improperly. For\n example, you can prevent a public signing key from being used encrypt data, or prevent a\n public key from being used with an encryption algorithm that is not supported by AWS KMS. You\n can also avoid errors, such as using the wrong signing algorithm in a verification\n operation.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see How Key State Affects Use\nof a Customer Master Key in the AWS Key Management Service Developer Guide.

" + "smithy.api#documentation": "

Returns the public key of an asymmetric CMK. Unlike the private key of a asymmetric CMK,\n which never leaves AWS KMS unencrypted, callers with kms:GetPublicKey permission\n can download the public key of an asymmetric CMK. You can share the public key to allow others\n to encrypt messages and verify signatures outside of AWS KMS. For information about symmetric and asymmetric CMKs, see Using Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.

\n

You do not need to download the public key. Instead, you can use the public key within\n AWS KMS by calling the Encrypt, ReEncrypt, or Verify operations with the identifier of an asymmetric CMK. When you use the\n public key within AWS KMS, you benefit from the authentication, authorization, and logging that\n are part of every AWS KMS operation. You also reduce of risk of encrypting data that cannot be\n decrypted. These features are not effective outside of AWS KMS. For details, see Special Considerations\n for Downloading Public Keys.

\n

To help you use the public key safely outside of AWS KMS, GetPublicKey returns\n important information about the public key in the response, including:

\n \n

Although AWS KMS cannot enforce these restrictions on external operations, it is crucial\n that you use this information to prevent the public key from being used improperly. For\n example, you can prevent a public signing key from being used encrypt data, or prevent a\n public key from being used with an encryption algorithm that is not supported by AWS KMS. You\n can also avoid errors, such as using the wrong signing algorithm in a verification\n operation.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see How Key State Affects Use\nof a Customer Master Key in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: Yes. To perform this operation with a CMK in a different AWS account, specify\n the key ARN or alias ARN in the value of the KeyId parameter.

\n \n

\n Required permissions: kms:GetPublicKey (key policy)

\n

\n Related operations: CreateKey\n

" } }, "com.amazonaws.kms#GetPublicKeyRequest": { @@ -2458,7 +2470,7 @@ } }, "traits": { - "smithy.api#documentation": "

Use this structure to allow cryptographic operations in the grant only when the operation request\n includes the specified encryption context.

\n

AWS KMS applies the grant constraints only to cryptographic operations that support an\n encryption context, that is, all cryptographic operations with a symmetric CMK. Grant\n constraints are not applied to operations that do not support an encryption context, such as\n cryptographic operations with asymmetric CMKs and management operations, such as DescribeKey or ScheduleKeyDeletion.

\n \n

In a cryptographic operation, the encryption context in the decryption operation must be\n an exact, case-sensitive match for the keys and values in the encryption context of the\n encryption operation. Only the order of the pairs can vary.

\n

However, in a grant constraint, the key in each key-value pair is not case sensitive,\n but the value is case sensitive.

\n

To avoid confusion, do not use multiple encryption context pairs that differ only by\n case. To require a fully case-sensitive encryption context, use the\n kms:EncryptionContext: and kms:EncryptionContextKeys conditions\n in an IAM or key policy. For details, see kms:EncryptionContext: in the \n AWS Key Management Service Developer Guide\n .

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

Use this structure to allow cryptographic operations in the grant only when the operation request\n includes the specified encryption context.

\n

AWS KMS applies the grant constraints only to cryptographic operations that support an\n encryption context, that is, all cryptographic operations with a symmetric CMK. Grant\n constraints are not applied to operations that do not support an encryption context, such as\n cryptographic operations with asymmetric CMKs and management operations, such as DescribeKey or RetireGrant.

\n \n

In a cryptographic operation, the encryption context in the decryption operation must be\n an exact, case-sensitive match for the keys and values in the encryption context of the\n encryption operation. Only the order of the pairs can vary.

\n

However, in a grant constraint, the key in each key-value pair is not case sensitive,\n but the value is case sensitive.

\n

To avoid confusion, do not use multiple encryption context pairs that differ only by\n case. To require a fully case-sensitive encryption context, use the\n kms:EncryptionContext: and kms:EncryptionContextKeys conditions\n in an IAM or key policy. For details, see kms:EncryptionContext: in the \n AWS Key Management Service Developer Guide\n .

\n " } }, "com.amazonaws.kms#GrantIdType": { @@ -2679,7 +2691,7 @@ } ], "traits": { - "smithy.api#documentation": "

Imports key material into an existing symmetric AWS KMS customer master key (CMK) that was\n created without key material. After you successfully import key material into a CMK, you can\n reimport the same key material into that CMK, but you cannot import different key\n material.

\n

You cannot perform this operation on an asymmetric CMK or on any CMK in a different AWS account. For more information about creating CMKs with no key material and\n then importing key material, see Importing Key Material in the\n AWS Key Management Service Developer Guide.

\n

Before using this operation, call GetParametersForImport. Its response\n includes a public key and an import token. Use the public key to encrypt the key material.\n Then, submit the import token from the same GetParametersForImport\n response.

\n

When calling this operation, you must specify the following values:

\n \n

When this operation is successful, the key state of the CMK changes from\n PendingImport to Enabled, and you can use the CMK.

\n

If this operation fails, use the exception to help determine the problem. If the error is\n related to the key material, the import token, or wrapping key, use GetParametersForImport to get a new public key and import token for the CMK and\n repeat the import procedure. For help, see How To Import Key\n Material in the AWS Key Management Service Developer Guide.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see How Key State Affects Use\nof a Customer Master Key in the AWS Key Management Service Developer Guide.

" + "smithy.api#documentation": "

Imports key material into an existing symmetric AWS KMS customer master key (CMK) that was\n created without key material. After you successfully import key material into a CMK, you can\n reimport the same key material into that CMK, but you cannot import different key\n material.

\n

You cannot perform this operation on an asymmetric CMK or on any CMK in a different AWS account. For more information about creating CMKs with no key material and\n then importing key material, see Importing Key Material in the\n AWS Key Management Service Developer Guide.

\n

Before using this operation, call GetParametersForImport. Its response\n includes a public key and an import token. Use the public key to encrypt the key material.\n Then, submit the import token from the same GetParametersForImport\n response.

\n

When calling this operation, you must specify the following values:

\n \n

When this operation is successful, the key state of the CMK changes from\n PendingImport to Enabled, and you can use the CMK.

\n

If this operation fails, use the exception to help determine the problem. If the error is\n related to the key material, the import token, or wrapping key, use GetParametersForImport to get a new public key and import token for the CMK and\n repeat the import procedure. For help, see How To Import Key\n Material in the AWS Key Management Service Developer Guide.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see How Key State Affects Use\nof a Customer Master Key in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.

\n \n

\n Required permissions: kms:ImportKeyMaterial (key policy)

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#ImportKeyMaterialRequest": { @@ -3187,7 +3199,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets a list of aliases in the caller's AWS account and region. You cannot list aliases in\n other accounts. For more information about aliases, see CreateAlias.

\n

By default, the ListAliases command returns all aliases in the account and region. To get\n only the aliases that point to a particular customer master key (CMK), use the\n KeyId parameter.

\n

The ListAliases response can include aliases that you created and associated\n with your customer managed CMKs, and aliases that AWS created and associated with AWS managed\n CMKs in your account. You can recognize AWS aliases because their names have the format\n aws/, such as aws/dynamodb.

\n

The response might also include aliases that have no TargetKeyId field. These\n are predefined aliases that AWS has created but has not yet associated with a CMK. Aliases\n that AWS creates in your account, including predefined aliases, do not count against your\n AWS KMS aliases\n quota.

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

Gets a list of aliases in the caller's AWS account and region. For more information about\n aliases, see CreateAlias.

\n

By default, the ListAliases operation returns all aliases in the account and\n region. To get only the aliases associated with a particular customer master key (CMK), use\n the KeyId parameter.

\n

The ListAliases response can include aliases that you created and associated\n with your customer managed CMKs, and aliases that AWS created and associated with AWS managed\n CMKs in your account. You can recognize AWS aliases because their names have the format\n aws/, such as aws/dynamodb.

\n

The response might also include aliases that have no TargetKeyId field. These\n are predefined aliases that AWS has created but has not yet associated with a CMK. Aliases\n that AWS creates in your account, including predefined aliases, do not count against your\n AWS KMS aliases\n quota.

\n

\n Cross-account use: No. ListAliases does not\n return aliases in other AWS accounts.

\n \n \n

\n Required permissions: kms:ListAliases (IAM policy)

\n

For details, see Controlling access to aliases in the AWS Key Management Service Developer Guide.

\n

\n Related operations:\n

\n ", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "NextMarker", @@ -3202,7 +3214,7 @@ "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

Lists only aliases that refer to the specified CMK. The value of this parameter can be the\n ID or Amazon Resource Name (ARN) of a CMK in the caller's account and region. You cannot use\n an alias name or alias ARN in this value.

\n

This parameter is optional. If you omit it, ListAliases returns all aliases\n in the account and region.

" + "smithy.api#documentation": "

Lists only aliases that are associated with the specified CMK. Enter a CMK in your AWS\n account.

\n

This parameter is optional. If you omit it, ListAliases returns all aliases\n in the account and Region.

\n \n

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

" } }, "Limit": { @@ -3271,7 +3283,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets a list of all grants for the specified customer master key (CMK).

\n

To perform this operation on a CMK in a different AWS account, specify the key\n ARN in the value of the KeyId parameter.

\n \n

The GranteePrincipal field in the ListGrants response usually contains the\n user or role designated as the grantee principal in the grant. However, when the grantee\n principal in the grant is an AWS service, the GranteePrincipal field contains\n the service\n principal, which might represent several different grantee principals.

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

Gets a list of all grants for the specified customer master key (CMK).

\n \n

The GranteePrincipal field in the ListGrants response usually contains the\n user or role designated as the grantee principal in the grant. However, when the grantee\n principal in the grant is an AWS service, the GranteePrincipal field contains\n the service\n principal, which might represent several different grantee principals.

\n \n

\n Cross-account use: Yes. To perform this operation on a CMK in a different AWS account, specify the key\n ARN in the value of the KeyId parameter.

\n \n

\n Required permissions: kms:ListGrants (key policy)

\n

\n Related operations:\n

\n ", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "NextMarker", @@ -3353,7 +3365,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets the names of the key policies that are attached to a customer master key (CMK). This\n operation is designed to get policy names that you can use in a GetKeyPolicy\n operation. However, the only valid policy name is default.\n You cannot perform this operation on a CMK in a different AWS account.

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

Gets the names of the key policies that are attached to a customer master key (CMK). This\n operation is designed to get policy names that you can use in a GetKeyPolicy\n operation. However, the only valid policy name is default.

\n

\n Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.

\n \n

\n Required permissions: kms:ListKeyPolicies (key policy)

\n

\n Related operations:\n

\n ", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "NextMarker", @@ -3429,7 +3441,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets a list of all customer master keys (CMKs) in the caller's AWS account and\n Region.

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

Gets a list of all customer master keys (CMKs) in the caller's AWS account and\n Region.

\n

\n Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.

\n \n

\n Required permissions: kms:ListKeys (IAM policy)

\n

\n Related operations:\n

\n ", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "NextMarker", @@ -3501,7 +3513,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of all tags for the specified customer master key (CMK).

\n

You cannot perform this operation on a CMK in a different AWS account.

" + "smithy.api#documentation": "

Returns all tags on the specified customer master key (CMK).

\n

For general information about tags, including the format and syntax, see Tagging AWS resources in\n the Amazon Web Services General Reference. For information about using\n tags in AWS KMS, see Tagging\n keys.

\n

\n Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.

\n \n

\n Required permissions: kms:ListResourceTags (key policy)

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#ListResourceTagsRequest": { @@ -3577,7 +3589,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of all grants for which the grant's RetiringPrincipal matches\n the one specified.

\n

A typical use is to list all grants that you are able to retire. To retire a grant, use\n RetireGrant.

" + "smithy.api#documentation": "

Returns all grants in which the specified principal is the RetiringPrincipal\n in the grant.

\n

You can specify any principal in your AWS account. The grants that are returned include\n grants for CMKs in your AWS account and other AWS accounts.

\n

You might use this operation to determine which grants you may retire. To retire a grant,\n use the RetireGrant operation.

\n

\n Cross-account use: You must specify a principal in your\n AWS account. However, this operation can return grants in any AWS account. You do not need\n kms:ListRetirableGrants permission (or any other additional permission) in any\n AWS account other than your own.

\n \n

\n Required permissions: kms:ListRetirableGrants (IAM policy) in your AWS\n account.

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#ListRetirableGrantsRequest": { @@ -3598,7 +3610,7 @@ "RetiringPrincipal": { "target": "com.amazonaws.kms#PrincipalIdType", "traits": { - "smithy.api#documentation": "

The retiring principal for which to list grants.

\n

To specify the retiring principal, use the Amazon Resource Name (ARN) of an AWS\n principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and\n assumed role users. For examples of the ARN syntax for specifying a principal, see AWS\n Identity and Access Management (IAM) in the Example ARNs section of the\n Amazon Web Services General Reference.

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

The retiring principal for which to list grants. Enter a principal in your AWS\n account.

\n

To specify the retiring principal, use the Amazon Resource Name (ARN) of an AWS\n principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and\n assumed role users. For examples of the ARN syntax for specifying a principal, see AWS\n Identity and Access Management (IAM) in the Example ARNs section of the\n Amazon Web Services General Reference.

", "smithy.api#required": {} } } @@ -3781,7 +3793,7 @@ } ], "traits": { - "smithy.api#documentation": "

Attaches a key policy to the specified customer master key (CMK).\n You cannot perform this operation on a CMK in a different AWS account.

\n

For more information about key policies, see Key Policies in the AWS Key Management Service Developer Guide.

" + "smithy.api#documentation": "

Attaches a key policy to the specified customer master key (CMK).

\n

For more information about key policies, see Key Policies in the AWS Key Management Service Developer Guide.\n For help writing and formatting a JSON policy document, see the IAM JSON Policy Reference in the \n IAM User Guide\n . For examples of adding a key policy in multiple programming languages,\n see Setting a key policy in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.

\n \n

\n Required permissions: kms:PutKeyPolicy (key policy)

\n

\n Related operations: GetKeyPolicy\n

" } }, "com.amazonaws.kms#PutKeyPolicyRequest": { @@ -3857,7 +3869,7 @@ } ], "traits": { - "smithy.api#documentation": "

Decrypts ciphertext and then reencrypts it entirely within AWS KMS. You can use this\n operation to change the customer master key (CMK) under which data is encrypted, such as when\n you manually rotate a\n CMK or change the CMK that protects a ciphertext. You can also use it to reencrypt ciphertext\n under the same CMK, such as to change the encryption context of a ciphertext.

\n

The ReEncrypt operation can decrypt ciphertext that was encrypted by using an\n AWS KMS CMK in an AWS KMS operation, such as Encrypt or GenerateDataKey. It can also decrypt ciphertext that was encrypted by using the\n public key of an asymmetric CMK outside of AWS KMS. However, it cannot decrypt ciphertext\n produced by other libraries, such as the AWS Encryption SDK or Amazon S3 client-side encryption.\n These libraries return a ciphertext format that is incompatible with AWS KMS.

\n

When you use the ReEncrypt operation, you need to provide information for the\n decrypt operation and the subsequent encrypt operation.

\n \n\n\n

Unlike other AWS KMS API operations, ReEncrypt callers must have two\n permissions:

\n \n

To permit reencryption from or to a CMK, include the \"kms:ReEncrypt*\"\n permission in your key policy. This permission is\n automatically included in the key policy when you use the console to create a CMK. But you\n must include it manually when you create a CMK programmatically or when you use the PutKeyPolicy operation to set a key policy.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see How Key State Affects Use\nof a Customer Master Key in the AWS Key Management Service Developer Guide.

" + "smithy.api#documentation": "

Decrypts ciphertext and then reencrypts it entirely within AWS KMS. You can use this\n operation to change the customer master key (CMK) under which data is encrypted, such as when\n you manually rotate a\n CMK or change the CMK that protects a ciphertext. You can also use it to reencrypt ciphertext\n under the same CMK, such as to change the encryption context of a ciphertext.

\n

The ReEncrypt operation can decrypt ciphertext that was encrypted by using an\n AWS KMS CMK in an AWS KMS operation, such as Encrypt or GenerateDataKey. It can also decrypt ciphertext that was encrypted by using the\n public key of an asymmetric CMK outside of AWS KMS. However, it cannot decrypt ciphertext\n produced by other libraries, such as the AWS Encryption SDK or Amazon S3 client-side encryption.\n These libraries return a ciphertext format that is incompatible with AWS KMS.

\n

When you use the ReEncrypt operation, you need to provide information for the\n decrypt operation and the subsequent encrypt operation.

\n \n \n \n \n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see How Key State Affects Use\nof a Customer Master Key in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: Yes. The source CMK and destination\n CMK can be in different AWS accounts. Either or both CMKs can be in a different account than\n the caller.

\n\n

\n Required permissions:

\n \n

To permit reencryption from or to a CMK, include the \"kms:ReEncrypt*\"\n permission in your key policy. This permission is\n automatically included in the key policy when you use the console to create a CMK. But you\n must include it manually when you create a CMK programmatically or when you use the PutKeyPolicy operation to set a key policy.

\n \n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#ReEncryptRequest": { @@ -3879,7 +3891,7 @@ "SourceKeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

A unique identifier for the CMK that is used to decrypt the ciphertext before it\n reencrypts it using the destination CMK.

\n

This parameter is required only when the ciphertext was encrypted under an asymmetric CMK.\n Otherwise, AWS KMS uses the metadata that it adds to the ciphertext blob to determine which\n CMK was used to encrypt the ciphertext. However, you can use this parameter to ensure that a\n particular CMK (of any kind) is used to decrypt the ciphertext before it is\n reencrypted.

\n

If you specify a KeyId value, the decrypt part of the ReEncrypt\n operation succeeds only if the specified CMK was used to encrypt the ciphertext.

\n \n

To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\".

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

" + "smithy.api#documentation": "

Specifies the customer master key (CMK) that\n AWS KMS will use to decrypt the ciphertext before it is re-encrypted. Enter a key ID of the CMK\n that was used to encrypt the ciphertext.

\n

This parameter is required only when the ciphertext was encrypted under an asymmetric CMK.\n If you used a symmetric CMK, AWS KMS can get the CMK from metadata that it adds to the\n symmetric ciphertext blob. However, it is always recommended as a best practice. This practice\n ensures that you use the CMK that you intend.

\n \n

To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

" } }, "DestinationKeyId": { @@ -3979,7 +3991,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retires a grant. To clean up, you can retire a grant when you're done using it. You should\n revoke a grant when you intend to actively deny operations that depend on it. The following\n are permitted to call this API:

\n \n

You must identify the grant to retire by its grant token or by a combination of the grant\n ID and the Amazon Resource Name (ARN) of the customer master key (CMK). A grant token is a\n unique variable-length base64-encoded string. A grant ID is a 64 character unique identifier\n of a grant. The CreateGrant operation returns both.

" + "smithy.api#documentation": "

Retires a grant. To clean up, you can retire a grant when you're done using it. You should\n revoke a grant when you intend to actively deny operations that depend on it. The following\n are permitted to call this API:

\n \n

You must identify the grant to retire by its grant token or by a combination of the grant\n ID and the Amazon Resource Name (ARN) of the customer master key (CMK). A grant token is a\n unique variable-length base64-encoded string. A grant ID is a 64 character unique identifier\n of a grant. The CreateGrant operation returns both.

\n \n

\n Cross-account use: Yes. You can retire a grant on a CMK\n in a different AWS account.

\n

\n Required permissions:: Permission to retire a grant is\n specified in the grant. You cannot control access to this operation in a policy. For more\n information, see Using\n grants in the AWS Key Management Service Developer Guide.

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#RetireGrantRequest": { @@ -4031,7 +4043,7 @@ } ], "traits": { - "smithy.api#documentation": "

Revokes the specified grant for the specified customer master key (CMK). You can revoke a\n grant to actively deny operations that depend on it.

\n

To perform this operation on a CMK in a different AWS account, specify the key\n ARN in the value of the KeyId parameter.

" + "smithy.api#documentation": "

Revokes the specified grant for the specified customer master key (CMK). You can revoke a\n grant to actively deny operations that depend on it.

\n

\n Cross-account use: Yes. To perform this operation on a CMK in a different AWS account, specify the key\n ARN in the value of the KeyId parameter.

\n \n

\n Required permissions: kms:RevokeGrant (key policy)

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#RevokeGrantRequest": { @@ -4079,7 +4091,7 @@ } ], "traits": { - "smithy.api#documentation": "

Schedules the deletion of a customer master key (CMK). You may provide a waiting period,\n specified in days, before deletion occurs. If you do not provide a waiting period, the default\n period of 30 days is used. When this operation is successful, the key state of the CMK changes\n to PendingDeletion. Before the waiting period ends, you can use CancelKeyDeletion to cancel the deletion of the CMK. After the waiting period\n ends, AWS KMS deletes the CMK and all AWS KMS data associated with it, including all aliases that\n refer to it.

\n \n

Deleting a CMK is a destructive and potentially dangerous operation. When a CMK is\n deleted, all data that was encrypted under the CMK is unrecoverable. To prevent the use of a\n CMK without deleting it, use DisableKey.

\n \n

If you schedule deletion of a CMK from a custom key store, when the waiting period\n expires, ScheduleKeyDeletion deletes the CMK from AWS KMS. Then AWS KMS makes a best\n effort to delete the key material from the associated AWS CloudHSM cluster. However, you might need\n to manually delete the orphaned key\n material from the cluster and its backups.

\n

You cannot perform this operation on a CMK in a different AWS account.

\n

For more information about scheduling a CMK for deletion, see Deleting Customer Master Keys in the\n AWS Key Management Service Developer Guide.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see How Key State Affects Use\nof a Customer Master Key in the AWS Key Management Service Developer Guide.

" + "smithy.api#documentation": "

Schedules the deletion of a customer master key (CMK). You may provide a waiting period,\n specified in days, before deletion occurs. If you do not provide a waiting period, the default\n period of 30 days is used. When this operation is successful, the key state of the CMK changes\n to PendingDeletion. Before the waiting period ends, you can use CancelKeyDeletion to cancel the deletion of the CMK. After the waiting period\n ends, AWS KMS deletes the CMK and all AWS KMS data associated with it, including all aliases that\n refer to it.

\n \n

Deleting a CMK is a destructive and potentially dangerous operation. When a CMK is\n deleted, all data that was encrypted under the CMK is unrecoverable. To prevent the use of a\n CMK without deleting it, use DisableKey.

\n \n

If you schedule deletion of a CMK from a custom key store, when the waiting period\n expires, ScheduleKeyDeletion deletes the CMK from AWS KMS. Then AWS KMS makes a best\n effort to delete the key material from the associated AWS CloudHSM cluster. However, you might need\n to manually delete the orphaned key\n material from the cluster and its backups.

\n

For more information about scheduling a CMK for deletion, see Deleting Customer Master Keys in the\n AWS Key Management Service Developer Guide.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see How Key State Affects Use\nof a Customer Master Key in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.

\n \n \n

\n Required permissions: kms:ScheduleKeyDeletion (key policy)

\n

\n Related operations\n

\n " } }, "com.amazonaws.kms#ScheduleKeyDeletionRequest": { @@ -4152,7 +4164,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a digital\n signature for a message or message digest by using the private key in an asymmetric\n CMK. To verify the signature, use the Verify operation, or use the public\n key in the same asymmetric CMK outside of AWS KMS. For information about symmetric and asymmetric CMKs, see Using Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.

\n

Digital signatures are generated and verified by using asymmetric key pair, such as an RSA\n or ECC pair that is represented by an asymmetric customer master key (CMK). The key owner (or\n an authorized user) uses their private key to sign a message. Anyone with the public key can\n verify that the message was signed with that particular private key and that the message\n hasn't changed since it was signed.

\n

To use the Sign operation, provide the following information:

\n \n \n

When signing a message, be sure to record the CMK and the signing algorithm. This\n information is required to verify the signature.

\n \n

To verify the signature that this operation generates, use the Verify\n operation. Or use the GetPublicKey operation to download the public key and\n then use the public key to verify the signature outside of AWS KMS.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see How Key State Affects Use\nof a Customer Master Key in the AWS Key Management Service Developer Guide.

" + "smithy.api#documentation": "

Creates a digital\n signature for a message or message digest by using the private key in an asymmetric\n CMK. To verify the signature, use the Verify operation, or use the public\n key in the same asymmetric CMK outside of AWS KMS. For information about symmetric and asymmetric CMKs, see Using Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.

\n

Digital signatures are generated and verified by using asymmetric key pair, such as an RSA\n or ECC pair that is represented by an asymmetric customer master key (CMK). The key owner (or\n an authorized user) uses their private key to sign a message. Anyone with the public key can\n verify that the message was signed with that particular private key and that the message\n hasn't changed since it was signed.

\n

To use the Sign operation, provide the following information:

\n \n \n

When signing a message, be sure to record the CMK and the signing algorithm. This\n information is required to verify the signature.

\n \n

To verify the signature that this operation generates, use the Verify\n operation. Or use the GetPublicKey operation to download the public key and\n then use the public key to verify the signature outside of AWS KMS.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see How Key State Affects Use\nof a Customer Master Key in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: Yes. To perform this operation with a CMK in a different AWS account, specify\n the key ARN or alias ARN in the value of the KeyId parameter.

\n \n

\n Required permissions: kms:Sign (key policy)

\n

\n Related operations: Verify\n

" } }, "com.amazonaws.kms#SignRequest": { @@ -4347,7 +4359,7 @@ } ], "traits": { - "smithy.api#documentation": "

Adds or edits tags for a customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account.

\n

Each tag consists of a tag key and a tag value. Tag keys and tag values are both required,\n but tag values can be empty (null) strings.

\n

You can only use a tag key once for each CMK. If you use the tag key again, AWS KMS replaces\n the current tag value with the specified value.

\n

For information about the rules that apply to tag keys and tag values, see User-Defined Tag Restrictions in the AWS Billing and Cost Management User\n Guide.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see How Key State Affects Use\nof a Customer Master Key in the AWS Key Management Service Developer Guide.

" + "smithy.api#documentation": "

Adds or edits tags on a customer managed CMK.

\n

Each tag consists of a tag key and a tag value, both of which are case-sensitive strings.\n The tag value can be an empty (null) string.

\n

To add a tag, specify a new tag key and a tag value. To edit a tag, specify an existing\n tag key and a new tag value.

\n

You can use this operation to tag a customer managed CMK, but you cannot\n tag an AWS\n managed CMK, an AWS owned CMK, or an alias.

\n

For general information about tags, including the format and syntax, see Tagging AWS resources in\n the Amazon Web Services General Reference. For information about using\n tags in AWS KMS, see Tagging\n keys.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see How Key State Affects Use\nof a Customer Master Key in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.

\n \n

\n Required permissions: kms:TagResource (key policy)

\n

\n Related operations\n

\n " } }, "com.amazonaws.kms#TagResourceRequest": { @@ -4356,14 +4368,14 @@ "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

A unique identifier for the CMK you are tagging.

\n

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

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

Identifies a customer managed CMK in the account and Region.

\n

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.kms#TagList", "traits": { - "smithy.api#documentation": "

One or more tags. Each tag consists of a tag key and a tag value.

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

One or more tags.

\n

Each tag consists of a tag key and a tag value. The tag value can be an empty (null)\n string.

\n

You cannot have more than one tag on a CMK with the same tag key. If you specify an\n existing tag key with a different tag value, AWS KMS replaces the current tag value with the\n specified one.

", "smithy.api#required": {} } } @@ -4585,7 +4597,7 @@ } ], "traits": { - "smithy.api#documentation": "

Removes the specified tags from the specified customer master key (CMK).\n You cannot perform this operation on a CMK in a different AWS account.

\n

To remove a tag, specify the tag key. To change the tag value of an existing tag key, use\n TagResource.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see How Key State Affects Use\nof a Customer Master Key in the AWS Key Management Service Developer Guide.

" + "smithy.api#documentation": "

Deletes tags from a customer managed CMK. To delete a tag,\n specify the tag key and the CMK.

\n

When it succeeds, the UntagResource operation doesn't return any output.\n Also, if the specified tag key isn't found on the CMK, it doesn't throw an exception or return\n a response. To confirm that the operation worked, use the ListResourceTags operation.

\n \n

For general information about tags, including the format and syntax, see Tagging AWS resources in\n the Amazon Web Services General Reference. For information about using\n tags in AWS KMS, see Tagging\n keys.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see How Key State Affects Use\nof a Customer Master Key in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.

\n \n

\n Required permissions: kms:UntagResource (key policy)

\n

\n Related operations\n

\n " } }, "com.amazonaws.kms#UntagResourceRequest": { @@ -4594,7 +4606,7 @@ "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

A unique identifier for the CMK from which you are removing tags.

\n \n

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

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

Identifies the CMK from which you are removing tags.

\n \n

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

", "smithy.api#required": {} } }, @@ -4630,7 +4642,7 @@ } ], "traits": { - "smithy.api#documentation": "

Associates an existing AWS KMS alias with a different customer master key (CMK). Each alias\n is associated with only one CMK at a time, although a CMK can have multiple aliases. The alias\n and the CMK must be in the same AWS account and region. You cannot perform this operation on an alias in a different AWS account.

\n

The current and new CMK must be the same type (both symmetric or both asymmetric), and\n they must have the same key usage (ENCRYPT_DECRYPT or SIGN_VERIFY).\n This restriction prevents errors in code that uses aliases. If you must assign an alias to a\n different type of CMK, use DeleteAlias to delete the old alias and CreateAlias to create a new alias.

\n

You cannot use UpdateAlias to change an alias name. To change an alias name,\n use DeleteAlias to delete the old alias and CreateAlias to\n create a new alias.

\n

Because an alias is not a property of a CMK, you can create, update, and delete the\n aliases of a CMK without affecting the CMK. Also, aliases do not appear in the response from\n the DescribeKey operation. To get the aliases of all CMKs in the account,\n use the ListAliases operation.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see How Key State Affects Use\nof a Customer Master Key in the AWS Key Management Service Developer Guide.

" + "smithy.api#documentation": "

Associates an existing AWS KMS alias with a different customer master key (CMK). Each alias\n is associated with only one CMK at a time, although a CMK can have multiple aliases. The alias\n and the CMK must be in the same AWS account and region.

\n

The current and new CMK must be the same type (both symmetric or both asymmetric), and\n they must have the same key usage (ENCRYPT_DECRYPT or SIGN_VERIFY).\n This restriction prevents errors in code that uses aliases. If you must assign an alias to a\n different type of CMK, use DeleteAlias to delete the old alias and CreateAlias to create a new alias.

\n

You cannot use UpdateAlias to change an alias name. To change an alias name,\n use DeleteAlias to delete the old alias and CreateAlias to\n create a new alias.

\n

Because an alias is not a property of a CMK, you can create, update, and delete the\n aliases of a CMK without affecting the CMK. Also, aliases do not appear in the response from\n the DescribeKey operation. To get the aliases of all CMKs in the account,\n use the ListAliases operation.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see How Key State Affects Use\nof a Customer Master Key in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.

\n

\n Required permissions\n

\n \n

For details, see Controlling access to aliases in the AWS Key Management Service Developer Guide.

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#UpdateAliasRequest": { @@ -4646,7 +4658,7 @@ "TargetKeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

Identifies the CMK to associate with the alias. When the update operation completes, the\n alias will point to this CMK.

\n

The CMK must be in the same AWS account and Region as the alias. Also, the new target CMK\n must be the same type as the current target CMK (both symmetric or both asymmetric) and they\n must have the same key usage.

\n

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

\n

To verify that the alias\n is mapped to the correct CMK, use ListAliases.

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

Identifies the customer managed CMK to associate with the alias. You don't have permission\n to associate an alias with an AWS managed CMK.

\n

The CMK must be in the same AWS account and Region as the alias. Also, the new target CMK\n must be the same type as the current target CMK (both symmetric or both asymmetric) and they\n must have the same key usage.

\n

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

\n

To verify that the alias\n is mapped to the correct CMK, use ListAliases.

", "smithy.api#required": {} } } @@ -4687,7 +4699,7 @@ } ], "traits": { - "smithy.api#documentation": "

Changes the properties of a custom key store. Use the CustomKeyStoreId\n parameter to identify the custom key store you want to edit. Use the remaining parameters to\n change the properties of the custom key store.

\n

You can only update a custom key store that is disconnected. To disconnect the custom key\n store, use DisconnectCustomKeyStore. To reconnect the custom key store after\n the update completes, use ConnectCustomKeyStore. To find the connection\n state of a custom key store, use the DescribeCustomKeyStores\n operation.

\n

Use the parameters of UpdateCustomKeyStore to edit your keystore\n settings.

\n \n

If the operation succeeds, it returns a JSON object with no\nproperties.

\n

This operation is part of the Custom Key Store feature feature in AWS KMS, which\ncombines the convenience and extensive integration of AWS KMS with the isolation and control of a\nsingle-tenant key store.

" + "smithy.api#documentation": "

Changes the properties of a custom key store. Use the CustomKeyStoreId\n parameter to identify the custom key store you want to edit. Use the remaining parameters to\n change the properties of the custom key store.

\n

You can only update a custom key store that is disconnected. To disconnect the custom key\n store, use DisconnectCustomKeyStore. To reconnect the custom key store after\n the update completes, use ConnectCustomKeyStore. To find the connection\n state of a custom key store, use the DescribeCustomKeyStores\n operation.

\n

Use the parameters of UpdateCustomKeyStore to edit your keystore\n settings.

\n \n

If the operation succeeds, it returns a JSON object with no\nproperties.

\n

This operation is part of the Custom Key Store feature feature in AWS KMS, which\ncombines the convenience and extensive integration of AWS KMS with the isolation and control of a\nsingle-tenant key store.

\n\n

\n Cross-account use: No. You cannot perform this operation on a custom key store in a different AWS account.

\n

\n Required permissions: kms:UpdateCustomKeyStore (IAM policy)

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#UpdateCustomKeyStoreRequest": { @@ -4747,7 +4759,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the description of a customer master key (CMK). To see the description of a CMK,\n use DescribeKey.

\n

You cannot perform this operation on a CMK in a different AWS account.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see How Key State Affects Use\nof a Customer Master Key in the AWS Key Management Service Developer Guide.

" + "smithy.api#documentation": "

Updates the description of a customer master key (CMK). To see the description of a CMK,\n use DescribeKey.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see How Key State Affects Use\nof a Customer Master Key in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.

\n \n

\n Required permissions: kms:UpdateKeyDescription (key policy)

\n

\n Related operations\n

\n " } }, "com.amazonaws.kms#UpdateKeyDescriptionRequest": { @@ -4807,7 +4819,7 @@ } ], "traits": { - "smithy.api#documentation": "

Verifies a digital signature that was generated by the Sign operation.

\n

\n

Verification confirms that an authorized user signed the message with the specified CMK\n and signing algorithm, and the message hasn't changed since it was signed. If the signature is\n verified, the value of the SignatureValid field in the response is\n True. If the signature verification fails, the Verify operation\n fails with an KMSInvalidSignatureException exception.

\n

A digital signature is generated by using the private key in an asymmetric CMK. The\n signature is verified by using the public key in the same asymmetric CMK.\n For information about symmetric and asymmetric CMKs, see Using Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.

\n

To verify a digital signature, you can use the Verify operation. Specify the\n same asymmetric CMK, message, and signing algorithm that were used to produce the\n signature.

\n

You can also verify the digital signature by using the public key of the CMK outside of\n AWS KMS. Use the GetPublicKey operation to download the public key in the\n asymmetric CMK and then use the public key to verify the signature outside of AWS KMS. The\n advantage of using the Verify operation is that it is performed within AWS KMS. As\n a result, it's easy to call, the operation is performed within the FIPS boundary, it is logged\n in AWS CloudTrail, and you can use key policy and IAM policy to determine who is authorized to use\n the CMK to verify signatures.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see How Key State Affects Use\nof a Customer Master Key in the AWS Key Management Service Developer Guide.

" + "smithy.api#documentation": "

Verifies a digital signature that was generated by the Sign operation.

\n

\n

Verification confirms that an authorized user signed the message with the specified CMK\n and signing algorithm, and the message hasn't changed since it was signed. If the signature is\n verified, the value of the SignatureValid field in the response is\n True. If the signature verification fails, the Verify operation\n fails with an KMSInvalidSignatureException exception.

\n

A digital signature is generated by using the private key in an asymmetric CMK. The\n signature is verified by using the public key in the same asymmetric CMK.\n For information about symmetric and asymmetric CMKs, see Using Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.

\n

To verify a digital signature, you can use the Verify operation. Specify the\n same asymmetric CMK, message, and signing algorithm that were used to produce the\n signature.

\n

You can also verify the digital signature by using the public key of the CMK outside of\n AWS KMS. Use the GetPublicKey operation to download the public key in the\n asymmetric CMK and then use the public key to verify the signature outside of AWS KMS. The\n advantage of using the Verify operation is that it is performed within AWS KMS. As\n a result, it's easy to call, the operation is performed within the FIPS boundary, it is logged\n in AWS CloudTrail, and you can use key policy and IAM policy to determine who is authorized to use\n the CMK to verify signatures.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see How Key State Affects Use\nof a Customer Master Key in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: Yes. To perform this operation with a CMK in a different AWS account, specify\n the key ARN or alias ARN in the value of the KeyId parameter.

\n \n

\n Required permissions: kms:Verify (key policy)

\n

\n Related operations: Sign\n

" } }, "com.amazonaws.kms#VerifyRequest": { diff --git a/codegen/sdk-codegen/aws-models/lambda.2015-03-31.json b/codegen/sdk-codegen/aws-models/lambda.2015-03-31.json index dd41e08e5b0..a31194dd2af 100644 --- a/codegen/sdk-codegen/aws-models/lambda.2015-03-31.json +++ b/codegen/sdk-codegen/aws-models/lambda.2015-03-31.json @@ -995,7 +995,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a mapping between an event source and an AWS Lambda function. Lambda reads items from the event source\n and triggers the function.

\n

For details about each event source type, see the following topics.

\n \n

The following error handling options are only available for stream sources (DynamoDB and Kinesis):

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

Creates a mapping between an event source and an AWS Lambda function. Lambda reads items from the event source\n and triggers the function.

\n

For details about each event source type, see the following topics.

\n \n

The following error handling options are only available for stream sources (DynamoDB and Kinesis):

\n ", "smithy.api#http": { "method": "POST", "uri": "/2015-03-31/event-source-mappings", @@ -1009,8 +1009,7 @@ "EventSourceArn": { "target": "com.amazonaws.lambda#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the event source.

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

The Amazon Resource Name (ARN) of the event source.

\n " } }, "FunctionName": { @@ -1029,13 +1028,13 @@ "BatchSize": { "target": "com.amazonaws.lambda#BatchSize", "traits": { - "smithy.api#documentation": "

The maximum number of items to retrieve in a single batch.

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

The maximum number of items to retrieve in a single batch.

\n " } }, "MaximumBatchingWindowInSeconds": { "target": "com.amazonaws.lambda#MaximumBatchingWindowInSeconds", "traits": { - "smithy.api#documentation": "

(Streams) The maximum amount of time to gather records before invoking the function, in seconds.

" + "smithy.api#documentation": "

(Streams and SQS standard queues) The maximum amount of time to gather records before invoking the function, in seconds.

" } }, "ParallelizationFactor": { @@ -1080,10 +1079,16 @@ "smithy.api#documentation": "

(Streams) Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records will be retried until the record expires.

" } }, + "TumblingWindowInSeconds": { + "target": "com.amazonaws.lambda#TumblingWindowInSeconds", + "traits": { + "smithy.api#documentation": "

(Streams) The duration of a processing window in seconds. The range is between 1 second up to 15 minutes.

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

\n (MSK) The name of the Kafka topic.\n

" + "smithy.api#documentation": "

The name of the Kafka topic.

" } }, "Queues": { @@ -1095,7 +1100,19 @@ "SourceAccessConfigurations": { "target": "com.amazonaws.lambda#SourceAccessConfigurations", "traits": { - "smithy.api#documentation": "

\n (MQ) The Secrets Manager secret that stores your broker credentials. To store your secret, use the following format:\n \t {\n \"username\": \"your username\",\n \"password\": \"your password\"\n }\n

\n\n

To reference the secret, use the following format:\n [\n {\n \"Type\": \"BASIC_AUTH\",\n \"URI\": \"secretARN\"\n }\n ] \n

\n

The value of Type is always BASIC_AUTH. To encrypt the secret, you can use customer or service managed keys. When using a customer managed KMS key, the Lambda execution role requires kms:Decrypt permissions.

" + "smithy.api#documentation": "

An array of the authentication protocol, or the VPC components to secure your event source.

" + } + }, + "SelfManagedEventSource": { + "target": "com.amazonaws.lambda#SelfManagedEventSource", + "traits": { + "smithy.api#documentation": "

The Self-Managed Apache Kafka cluster to send records.

" + } + }, + "FunctionResponseTypes": { + "target": "com.amazonaws.lambda#FunctionResponseTypeList", + "traits": { + "smithy.api#documentation": "

(Streams) A list of current response type enums applied to the event source mapping.

" } } } @@ -1414,7 +1431,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes an event source\n mapping. You can get the identifier of a mapping from the output of ListEventSourceMappings.

\n

When you delete an event source mapping, it enters a Deleting state and might not be completely\n deleted for several seconds.

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

Deletes an event source\n mapping. You can get the identifier of a mapping from the output of ListEventSourceMappings.

\n

When you delete an event source mapping, it enters a Deleting state and might not be completely deleted for several seconds.

", "smithy.api#http": { "method": "DELETE", "uri": "/2015-03-31/event-source-mappings/{UUID}", @@ -1896,6 +1913,54 @@ "smithy.api#box": {} } }, + "com.amazonaws.lambda#EndPointType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "KAFKA_BOOTSTRAP_SERVERS", + "name": "KAFKA_BOOTSTRAP_SERVERS" + } + ] + } + }, + "com.amazonaws.lambda#Endpoint": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 300 + }, + "smithy.api#pattern": "^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9]):[0-9]{1,5}" + } + }, + "com.amazonaws.lambda#EndpointLists": { + "type": "list", + "member": { + "target": "com.amazonaws.lambda#Endpoint" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.lambda#Endpoints": { + "type": "map", + "key": { + "target": "com.amazonaws.lambda#EndPointType" + }, + "value": { + "target": "com.amazonaws.lambda#EndpointLists" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2 + } + } + }, "com.amazonaws.lambda#Environment": { "type": "structure", "members": { @@ -2005,7 +2070,7 @@ "MaximumBatchingWindowInSeconds": { "target": "com.amazonaws.lambda#MaximumBatchingWindowInSeconds", "traits": { - "smithy.api#documentation": "

(Streams) The maximum amount of time to gather records before invoking the function, in seconds. The default value is zero.

" + "smithy.api#documentation": "

(Streams and SQS standard queues) The maximum amount of time to gather records before invoking the function, in seconds. The default value is zero.

" } }, "ParallelizationFactor": { @@ -2059,7 +2124,7 @@ "Topics": { "target": "com.amazonaws.lambda#Topics", "traits": { - "smithy.api#documentation": "

\n (MSK) The name of the Kafka topic to consume.\n

" + "smithy.api#documentation": "

The name of the Kafka topic.

" } }, "Queues": { @@ -2071,7 +2136,13 @@ "SourceAccessConfigurations": { "target": "com.amazonaws.lambda#SourceAccessConfigurations", "traits": { - "smithy.api#documentation": "

\n (MQ) The Secrets Manager secret that stores your broker credentials. To store your secret, use the following format:\n \t {\n \"username\": \"your username\",\n \"password\": \"your password\"\n }\n

\n\n

To reference the secret, use the following format:\n [\n {\n \"Type\": \"BASIC_AUTH\",\n \"URI\": \"secretARN\"\n }\n ] \n

\n

The value of Type is always BASIC_AUTH. To encrypt the secret, you can use customer or service managed keys. When using a customer managed KMS key, the Lambda execution role requires kms:Decrypt permissions.

" + "smithy.api#documentation": "

An array of the authentication protocol, or the VPC components to secure your event source.

" + } + }, + "SelfManagedEventSource": { + "target": "com.amazonaws.lambda#SelfManagedEventSource", + "traits": { + "smithy.api#documentation": "

The Self-Managed Apache Kafka cluster for your event source.

" } }, "MaximumRecordAgeInSeconds": { @@ -2091,10 +2162,22 @@ "traits": { "smithy.api#documentation": "

(Streams) Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires.

" } + }, + "TumblingWindowInSeconds": { + "target": "com.amazonaws.lambda#TumblingWindowInSeconds", + "traits": { + "smithy.api#documentation": "

(Streams) The duration of a processing window in seconds. The range is between 1 second up to 15 minutes.

" + } + }, + "FunctionResponseTypes": { + "target": "com.amazonaws.lambda#FunctionResponseTypeList", + "traits": { + "smithy.api#documentation": "

(Streams) A list of current response type enums applied to the event source mapping.

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

A mapping between an AWS resource and an AWS Lambda function. See CreateEventSourceMapping\n for details.

" + "smithy.api#documentation": "

A mapping between an AWS resource and an AWS Lambda function. See CreateEventSourceMapping for details.

" } }, "com.amazonaws.lambda#EventSourceMappingsList": { @@ -2509,6 +2592,29 @@ "smithy.api#pattern": "(arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]{2}(-gov)?-[a-z]+-\\d{1}:)?(\\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\\$LATEST|[a-zA-Z0-9-_]+))?" } }, + "com.amazonaws.lambda#FunctionResponseType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ReportBatchItemFailures", + "name": "ReportBatchItemFailures" + } + ] + } + }, + "com.amazonaws.lambda#FunctionResponseTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.lambda#FunctionResponseType" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, "com.amazonaws.lambda#FunctionVersion": { "type": "string", "traits": { @@ -2694,7 +2800,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns details about an event source mapping. You can get the identifier of a mapping from the output of\n ListEventSourceMappings.

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

Returns details about an event source mapping. You can get the identifier of a mapping from the output of ListEventSourceMappings.

", "smithy.api#http": { "method": "GET", "uri": "/2015-03-31/event-source-mappings/{UUID}", @@ -3526,7 +3632,7 @@ } }, "traits": { - "smithy.api#documentation": "

Configuration values that override the container image Dockerfile. See \n Override Container settings.

" + "smithy.api#documentation": "

Configuration values that override the container image Dockerfile settings. See \n Container settings.

" } }, "com.amazonaws.lambda#ImageConfigError": { @@ -6524,6 +6630,20 @@ } } }, + "com.amazonaws.lambda#SelfManagedEventSource": { + "type": "structure", + "members": { + "Endpoints": { + "target": "com.amazonaws.lambda#Endpoints", + "traits": { + "smithy.api#documentation": "

The list of bootstrap servers for your Kafka brokers in the following format: \"KAFKA_BOOTSTRAP_SERVERS\": [\"abc.xyz.com:xxxx\",\"abc2.xyz.com:xxxx\"].

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

The Self-Managed Apache Kafka cluster for your event source.

" + } + }, "com.amazonaws.lambda#SensitiveString": { "type": "string", "traits": { @@ -6564,18 +6684,18 @@ "Type": { "target": "com.amazonaws.lambda#SourceAccessType", "traits": { - "smithy.api#documentation": "

To reference the secret, use the following format:\n [\n {\n \"Type\": \"BASIC_AUTH\",\n \"URI\": \"secretARN\"\n }\n ] \n

\n

The value of Type is always BASIC_AUTH. To encrypt the secret, you can use customer or service managed keys. When using a customer managed KMS key, the Lambda execution role requires kms:Decrypt permissions.

" + "smithy.api#documentation": "

The type of authentication protocol or the VPC components for your event source. For example: \"Type\":\"SASL_SCRAM_512_AUTH\".

\n " } }, "URI": { - "target": "com.amazonaws.lambda#Arn", + "target": "com.amazonaws.lambda#URI", "traits": { - "smithy.api#documentation": "

To reference the secret, use the following format:\n [\n {\n \"Type\": \"BASIC_AUTH\",\n \"URI\": \"secretARN\"\n }\n ] \n

\n

The value of Type is always BASIC_AUTH. To encrypt the secret, you can use customer or service managed keys. When using a customer managed KMS key, the Lambda execution role requires kms:Decrypt permissions.

" + "smithy.api#documentation": "

The value for your chosen configuration in Type. For example: \"URI\": \"arn:aws:secretsmanager:us-east-1:01234567890:secret:MyBrokerSecretName\".

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

\n (MQ) The Secrets Manager secret that stores your broker credentials. To store your secret, use the following format:\n \t {\n \"username\": \"your username\",\n \"password\": \"your password\"\n }\n

" + "smithy.api#documentation": "

You can specify the authentication protocol, or the VPC components to secure access to your event source.

" } }, "com.amazonaws.lambda#SourceAccessConfigurations": { @@ -6586,7 +6706,7 @@ "traits": { "smithy.api#length": { "min": 1, - "max": 1 + "max": 22 } } }, @@ -6597,6 +6717,22 @@ { "value": "BASIC_AUTH", "name": "BASIC_AUTH" + }, + { + "value": "VPC_SUBNET", + "name": "VPC_SUBNET" + }, + { + "value": "VPC_SECURITY_GROUP", + "name": "VPC_SECURITY_GROUP" + }, + { + "value": "SASL_SCRAM_512_AUTH", + "name": "SASL_SCRAM_512_AUTH" + }, + { + "value": "SASL_SCRAM_256_AUTH", + "name": "SASL_SCRAM_256_AUTH" } ] } @@ -6950,6 +7086,26 @@ ] } }, + "com.amazonaws.lambda#TumblingWindowInSeconds": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 0, + "max": 900 + } + } + }, + "com.amazonaws.lambda#URI": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + }, + "smithy.api#pattern": "[a-zA-Z0-9-\\/*:_+=.@-]*" + } + }, "com.amazonaws.lambda#UnreservedConcurrentExecutions": { "type": "integer", "traits": { @@ -7209,7 +7365,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates an event source mapping. You can change the function that AWS Lambda invokes, or pause invocation and\n resume later from the same location.

\n

The following error handling options are only available for stream sources (DynamoDB and Kinesis):

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

Updates an event source mapping. You can change the function that AWS Lambda invokes, or pause invocation and resume later from the same location.

\n

The following error handling options are only available for stream sources (DynamoDB and Kinesis):

\n ", "smithy.api#http": { "method": "PUT", "uri": "/2015-03-31/event-source-mappings/{UUID}", @@ -7243,13 +7399,13 @@ "BatchSize": { "target": "com.amazonaws.lambda#BatchSize", "traits": { - "smithy.api#documentation": "

The maximum number of items to retrieve in a single batch.

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

The maximum number of items to retrieve in a single batch.

\n " } }, "MaximumBatchingWindowInSeconds": { "target": "com.amazonaws.lambda#MaximumBatchingWindowInSeconds", "traits": { - "smithy.api#documentation": "

(Streams) The maximum amount of time to gather records before invoking the function, in seconds.

" + "smithy.api#documentation": "

(Streams and SQS standard queues) The maximum amount of time to gather records before invoking the function, in seconds.

" } }, "DestinationConfig": { @@ -7285,7 +7441,19 @@ "SourceAccessConfigurations": { "target": "com.amazonaws.lambda#SourceAccessConfigurations", "traits": { - "smithy.api#documentation": "

\n (MQ) The Secrets Manager secret that stores your broker credentials. To store your secret, use the following format:\n \t {\n \"username\": \"your username\",\n \"password\": \"your password\"\n }\n

\n\n

To reference the secret, use the following format:\n [\n {\n \"Type\": \"BASIC_AUTH\",\n \"URI\": \"secretARN\"\n }\n ] \n

\n

The value of Type is always BASIC_AUTH. To encrypt the secret, you can use customer or service managed keys. When using a customer managed KMS key, the Lambda execution role requires kms:Decrypt permissions.

" + "smithy.api#documentation": "

An array of the authentication protocol, or the VPC components to secure your event source.

" + } + }, + "TumblingWindowInSeconds": { + "target": "com.amazonaws.lambda#TumblingWindowInSeconds", + "traits": { + "smithy.api#documentation": "

(Streams) The duration of a processing window in seconds. The range is between 1 second up to 15 minutes.

" + } + }, + "FunctionResponseTypes": { + "target": "com.amazonaws.lambda#FunctionResponseTypeList", + "traits": { + "smithy.api#documentation": "

(Streams) A list of current response type enums applied to the event source mapping.

" } } } diff --git a/codegen/sdk-codegen/aws-models/managedblockchain.2018-09-24.json b/codegen/sdk-codegen/aws-models/managedblockchain.2018-09-24.json index 012af576d89..17a5e91a0de 100644 --- a/codegen/sdk-codegen/aws-models/managedblockchain.2018-09-24.json +++ b/codegen/sdk-codegen/aws-models/managedblockchain.2018-09-24.json @@ -31,7 +31,11 @@ "shapes": { "com.amazonaws.managedblockchain#AccessDeniedException": { "type": "structure", - "members": {}, + "members": { + "Message": { + "target": "com.amazonaws.managedblockchain#String" + } + }, "traits": { "smithy.api#documentation": "

You do not have sufficient access to perform this action.

", "smithy.api#error": "client", @@ -61,7 +65,7 @@ } }, "traits": { - "smithy.api#documentation": "

A policy type that defines the voting rules for the network. The rules decide if a proposal is approved. Approval may be based on criteria such as the percentage of YES votes and the duration of the proposal. The policy applies to all proposals and is specified when the network is created.

" + "smithy.api#documentation": "

A policy type that defines the voting rules for the network. The rules decide if a proposal is approved. Approval may be based on criteria such as the percentage of YES votes and the duration of the proposal. The policy applies to all proposals and is specified when the network is created.

\n

Applies only to Hyperledger Fabric.

" } }, "com.amazonaws.managedblockchain#AvailabilityZoneString": { @@ -111,7 +115,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a member within a Managed Blockchain network.

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

Creates a member within a Managed Blockchain network.

\n

Applies only to Hyperledger Fabric.

", "smithy.api#http": { "method": "POST", "uri": "/networks/{NetworkId}/members", @@ -194,7 +198,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new blockchain network using Amazon Managed Blockchain.

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

Creates a new blockchain network using Amazon Managed Blockchain.

\n

Applies only to Hyperledger Fabric.

", "smithy.api#http": { "method": "POST", "uri": "/networks", @@ -314,10 +318,10 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a peer node in a member.

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

Creates a node on the specified blockchain network.

\n

Applies to Hyperledger Fabric and Ethereum.

", "smithy.api#http": { "method": "POST", - "uri": "/networks/{NetworkId}/members/{MemberId}/nodes", + "uri": "/networks/{NetworkId}/nodes", "code": 200 } } @@ -336,7 +340,7 @@ "NetworkId": { "target": "com.amazonaws.managedblockchain#ResourceIdString", "traits": { - "smithy.api#documentation": "

The unique identifier of the network in which this node runs.

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

The unique identifier of the network for the node.

\n

Ethereum public networks have the following NetworkIds:

\n ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -344,9 +348,7 @@ "MemberId": { "target": "com.amazonaws.managedblockchain#ResourceIdString", "traits": { - "smithy.api#documentation": "

The unique identifier of the member that owns this node.

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

The unique identifier of the member that owns this node.

\n

Applies only to Hyperledger Fabric.

" } }, "NodeConfiguration": { @@ -398,7 +400,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a proposal for a change to the network that other members of the network can vote on, for example, a proposal to add a new member to the network. Any member can create a proposal.

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

Creates a proposal for a change to the network that other members of the network can vote on, for example, a proposal to add a new member to the network. Any member can create a proposal.

\n

Applies only to Hyperledger Fabric.

", "smithy.api#http": { "method": "POST", "uri": "/networks/{NetworkId}/proposals", @@ -487,7 +489,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a member. Deleting a member removes the member and all associated resources from the network. DeleteMember can only be called for a specified MemberId if the principal performing the action is associated with the AWS account that owns the member. In all other cases, the DeleteMember action is carried out as the result of an approved proposal to remove a member. If MemberId is the last member in a network specified by the last AWS account, the network is deleted also.

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

Deletes a member. Deleting a member removes the member and all associated resources from the network. DeleteMember can only be called for a specified MemberId if the principal performing the action is associated with the AWS account that owns the member. In all other cases, the DeleteMember action is carried out as the result of an approved proposal to remove a member. If MemberId is the last member in a network specified by the last AWS account, the network is deleted also.

\n

Applies only to Hyperledger Fabric.

", "smithy.api#http": { "method": "DELETE", "uri": "/networks/{NetworkId}/members/{MemberId}", @@ -549,10 +551,10 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a peer node from a member that your AWS account owns. All data on the node is lost and cannot be recovered.

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

Deletes a node that your AWS account owns. All data on the node is lost and cannot be recovered.

\n

Applies to Hyperledger Fabric and Ethereum.

", "smithy.api#http": { "method": "DELETE", - "uri": "/networks/{NetworkId}/members/{MemberId}/nodes/{NodeId}", + "uri": "/networks/{NetworkId}/nodes/{NodeId}", "code": 200 } } @@ -563,7 +565,7 @@ "NetworkId": { "target": "com.amazonaws.managedblockchain#ResourceIdString", "traits": { - "smithy.api#documentation": "

The unique identifier of the network that the node belongs to.

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

The unique identifier of the network that the node is on.

\n

Ethereum public networks have the following NetworkIds:

\n ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -571,9 +573,8 @@ "MemberId": { "target": "com.amazonaws.managedblockchain#ResourceIdString", "traits": { - "smithy.api#documentation": "

The unique identifier of the member that owns this node.

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

The unique identifier of the member that owns this node.

\n

Applies only to Hyperledger Fabric and is required for Hyperledger Fabric.

", + "smithy.api#httpQuery": "memberId" } }, "NodeId": { @@ -627,6 +628,10 @@ { "value": "HYPERLEDGER_FABRIC", "name": "HYPERLEDGER_FABRIC" + }, + { + "value": "ETHEREUM", + "name": "ETHEREUM" } ] } @@ -666,7 +671,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns detailed information about a member.

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

Returns detailed information about a member.

\n

Applies only to Hyperledger Fabric.

", "smithy.api#http": { "method": "GET", "uri": "/networks/{NetworkId}/members/{MemberId}", @@ -732,7 +737,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns detailed information about a network.

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

Returns detailed information about a network.

\n

Applies to Hyperledger Fabric and Ethereum.

", "smithy.api#http": { "method": "GET", "uri": "/networks/{NetworkId}", @@ -790,10 +795,10 @@ } ], "traits": { - "smithy.api#documentation": "

Returns detailed information about a peer node.

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

Returns detailed information about a node.

\n

Applies to Hyperledger Fabric and Ethereum.

", "smithy.api#http": { "method": "GET", - "uri": "/networks/{NetworkId}/members/{MemberId}/nodes/{NodeId}", + "uri": "/networks/{NetworkId}/nodes/{NodeId}", "code": 200 } } @@ -804,7 +809,7 @@ "NetworkId": { "target": "com.amazonaws.managedblockchain#ResourceIdString", "traits": { - "smithy.api#documentation": "

The unique identifier of the network to which the node belongs.

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

The unique identifier of the network that the node is on.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -812,9 +817,8 @@ "MemberId": { "target": "com.amazonaws.managedblockchain#ResourceIdString", "traits": { - "smithy.api#documentation": "

The unique identifier of the member that owns the node.

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

The unique identifier of the member that owns the node.

\n

Applies only to Hyperledger Fabric and is required for Hyperledger Fabric.

", + "smithy.api#httpQuery": "memberId" } }, "NodeId": { @@ -864,7 +868,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns detailed information about a proposal.

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

Returns detailed information about a proposal.

\n

Applies only to Hyperledger Fabric.

", "smithy.api#http": { "method": "GET", "uri": "/networks/{NetworkId}/proposals/{ProposalId}", @@ -974,7 +978,7 @@ } }, "traits": { - "smithy.api#documentation": "

An invitation to an AWS account to create a member and join the network.

" + "smithy.api#documentation": "

An invitation to an AWS account to create a member and join the network.

\n

Applies only to Hyperledger Fabric.

" } }, "com.amazonaws.managedblockchain#InvitationList": { @@ -1022,7 +1026,7 @@ } }, "traits": { - "smithy.api#documentation": "

An action to invite a specific AWS account to create a member and join the network. The InviteAction is carried out when a Proposal is APPROVED.

" + "smithy.api#documentation": "

An action to invite a specific AWS account to create a member and join the network. The InviteAction is carried out when a Proposal is APPROVED.

\n

Applies only to Hyperledger Fabric.

" } }, "com.amazonaws.managedblockchain#InviteActionList": { @@ -1066,7 +1070,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a listing of all invitations for the current AWS account.

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

Returns a list of all invitations for the current AWS account.

\n

Applies only to Hyperledger Fabric.

", "smithy.api#http": { "method": "GET", "uri": "/invitations", @@ -1138,7 +1142,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a listing of the members in a network and properties of their configurations.

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

Returns a list of the members in a network and properties of their configurations.

\n

Applies only to Hyperledger Fabric.

", "smithy.api#http": { "method": "GET", "uri": "/networks/{NetworkId}/members", @@ -1239,7 +1243,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns information about the networks in which the current AWS account has members.

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

Returns information about the networks in which the current AWS account participates.

\n

Applies to Hyperledger Fabric and Ethereum.

", "smithy.api#http": { "method": "GET", "uri": "/networks", @@ -1272,7 +1276,7 @@ "Status": { "target": "com.amazonaws.managedblockchain#NetworkStatus", "traits": { - "smithy.api#documentation": "

An optional status specifier. If provided, only networks currently in this status are listed.

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

An optional status specifier. If provided, only networks currently in this status are listed.

\n

Applies only to Hyperledger Fabric.

", "smithy.api#httpQuery": "status" } }, @@ -1332,10 +1336,10 @@ } ], "traits": { - "smithy.api#documentation": "

Returns information about the nodes within a network.

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

Returns information about the nodes within a network.

\n

Applies to Hyperledger Fabric and Ethereum.

", "smithy.api#http": { "method": "GET", - "uri": "/networks/{NetworkId}/members/{MemberId}/nodes", + "uri": "/networks/{NetworkId}/nodes", "code": 200 }, "smithy.api#paginated": { @@ -1359,9 +1363,8 @@ "MemberId": { "target": "com.amazonaws.managedblockchain#ResourceIdString", "traits": { - "smithy.api#documentation": "

The unique identifier of the member who owns the nodes to list.

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

The unique identifier of the member who owns the nodes to list.

\n

Applies only to Hyperledger Fabric and is required for Hyperledger Fabric.

", + "smithy.api#httpQuery": "memberId" } }, "Status": { @@ -1427,7 +1430,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns the listing of votes for a specified proposal, including the value of each vote and the unique identifier of the member that cast the vote.

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

Returns the list of votes for a specified proposal, including the value of each vote and the unique identifier of the member that cast the vote.

\n

Applies only to Hyperledger Fabric.

", "smithy.api#http": { "method": "GET", "uri": "/networks/{NetworkId}/proposals/{ProposalId}/votes", @@ -1481,7 +1484,7 @@ "ProposalVotes": { "target": "com.amazonaws.managedblockchain#ProposalVoteList", "traits": { - "smithy.api#documentation": "

\n The listing of votes.\n

" + "smithy.api#documentation": "

\n The list of votes.\n

" } }, "NextToken": { @@ -1518,7 +1521,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a listing of proposals for the network.

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

Returns a list of proposals for the network.

\n

Applies only to Hyperledger Fabric.

", "smithy.api#http": { "method": "GET", "uri": "/networks/{NetworkId}/proposals", @@ -1656,7 +1659,7 @@ } }, "traits": { - "smithy.api#documentation": "

Member configuration properties.

" + "smithy.api#documentation": "

Member configuration properties.

\n

Applies only to Hyperledger Fabric.

" } }, "com.amazonaws.managedblockchain#MemberConfiguration": { @@ -1690,7 +1693,7 @@ } }, "traits": { - "smithy.api#documentation": "

Configuration properties of the member.

" + "smithy.api#documentation": "

Configuration properties of the member.

\n

Applies only to Hyperledger Fabric.

" } }, "com.amazonaws.managedblockchain#MemberFabricAttributes": { @@ -1726,7 +1729,7 @@ "AdminPassword": { "target": "com.amazonaws.managedblockchain#PasswordString", "traits": { - "smithy.api#documentation": "

The password for the member's initial administrative user. The AdminPassword must be at least eight characters long and no more than 32 characters. It must contain at least one uppercase letter, one lowercase letter, and one digit. It cannot have a single quote(‘), double quote(“), forward slash(/), backward slash(\\), @, or a space.

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

The password for the member's initial administrative user. The AdminPassword must be at least eight characters long and no more than 32 characters. It must contain at least one uppercase letter, one lowercase letter, and one digit. It cannot have a single quotation mark (‘), a double quotation marks (“), a forward slash(/), a backward slash(\\), @, or a space.

", "smithy.api#required": {} } } @@ -1873,7 +1876,7 @@ } }, "traits": { - "smithy.api#documentation": "

A summary of configuration properties for a member.

" + "smithy.api#documentation": "

A summary of configuration properties for a member.

\n

Applies only to Hyperledger Fabric.

" } }, "com.amazonaws.managedblockchain#MemberSummaryList": { @@ -1960,6 +1963,20 @@ "smithy.api#documentation": "

Network configuration properties.

" } }, + "com.amazonaws.managedblockchain#NetworkEthereumAttributes": { + "type": "structure", + "members": { + "ChainId": { + "target": "com.amazonaws.managedblockchain#String", + "traits": { + "smithy.api#documentation": "

The Ethereum CHAIN_ID associated with the Ethereum network. Chain IDs are as follows:

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

Attributes of Ethereum for a network.

" + } + }, "com.amazonaws.managedblockchain#NetworkFabricAttributes": { "type": "structure", "members": { @@ -2003,6 +2020,12 @@ "traits": { "smithy.api#documentation": "

Attributes of Hyperledger Fabric for a Managed Blockchain network that uses Hyperledger Fabric.

" } + }, + "Ethereum": { + "target": "com.amazonaws.managedblockchain#NetworkEthereumAttributes", + "traits": { + "smithy.api#documentation": "

Attributes of an Ethereum network for Managed Blockchain resources participating in an Ethereum network.

" + } } }, "traits": { @@ -2040,7 +2063,7 @@ "min": 1, "max": 64 }, - "smithy.api#pattern": "^(?!-)^[^0-9](?!.*--)[A-Za-z0-9-]+[^- ]$" + "smithy.api#pattern": "^(?!-|[0-9])(?!.*-$)(?!.*?--)[a-zA-Z0-9-]+$" } }, "com.amazonaws.managedblockchain#NetworkStatus": { @@ -2132,13 +2155,13 @@ "NetworkId": { "target": "com.amazonaws.managedblockchain#ResourceIdString", "traits": { - "smithy.api#documentation": "

The unique identifier of the network that the node is in.

" + "smithy.api#documentation": "

The unique identifier of the network that the node is on.

" } }, "MemberId": { "target": "com.amazonaws.managedblockchain#ResourceIdString", "traits": { - "smithy.api#documentation": "

The unique identifier of the member to which the node belongs.

" + "smithy.api#documentation": "

The unique identifier of the member to which the node belongs.

\n

Applies only to Hyperledger Fabric.

" } }, "Id": { @@ -2168,13 +2191,13 @@ "LogPublishingConfiguration": { "target": "com.amazonaws.managedblockchain#NodeLogPublishingConfiguration", "traits": { - "smithy.api#documentation": "

Configuration properties for logging events associated with a peer node owned by a member in a Managed Blockchain network.

" + "smithy.api#documentation": "

Configuration properties for logging events associated with a peer node on a Hyperledger Fabric network on Managed Blockchain.

" } }, "StateDB": { "target": "com.amazonaws.managedblockchain#StateDBType", "traits": { - "smithy.api#documentation": "

The state database that the node uses. Values are LevelDB or CouchDB.

" + "smithy.api#documentation": "

The state database that the node uses. Values are LevelDB or CouchDB.

\n

Applies only to Hyperledger Fabric.

" } }, "Status": { @@ -2191,7 +2214,7 @@ } }, "traits": { - "smithy.api#documentation": "

Configuration properties of a peer node.

" + "smithy.api#documentation": "

Configuration properties of a node.

" } }, "com.amazonaws.managedblockchain#NodeConfiguration": { @@ -2207,25 +2230,44 @@ "AvailabilityZone": { "target": "com.amazonaws.managedblockchain#AvailabilityZoneString", "traits": { - "smithy.api#documentation": "

The Availability Zone in which the node exists.

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

The Availability Zone in which the node exists.

" } }, "LogPublishingConfiguration": { "target": "com.amazonaws.managedblockchain#NodeLogPublishingConfiguration", "traits": { - "smithy.api#documentation": "

Configuration properties for logging events associated with a peer node owned by a member in a Managed Blockchain network. \n

" + "smithy.api#documentation": "

Configuration properties for logging events associated with a peer node on a Hyperledger Fabric network on Managed Blockchain. \n

" } }, "StateDB": { "target": "com.amazonaws.managedblockchain#StateDBType", "traits": { - "smithy.api#documentation": "

The state database that the node uses. Values are LevelDB or CouchDB. When using an Amazon Managed Blockchain network with Hyperledger Fabric version 1.4 or later, the default is CouchDB.

" + "smithy.api#documentation": "

The state database that the node uses. Values are LevelDB or CouchDB. When using an Amazon Managed Blockchain network with Hyperledger Fabric version 1.4 or later, the default is CouchDB.

\n

Applies only to Hyperledger Fabric.

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

Configuration properties of a peer node.

" + "smithy.api#documentation": "

Configuration properties of a node.

" + } + }, + "com.amazonaws.managedblockchain#NodeEthereumAttributes": { + "type": "structure", + "members": { + "HttpEndpoint": { + "target": "com.amazonaws.managedblockchain#String", + "traits": { + "smithy.api#documentation": "

The endpoint on which the Ethereum node listens to run Ethereum JSON-RPC methods over HTTP connections from a client. Use this endpoint in client code for smart contracts when using an HTTP connection. Connections to this endpoint are authenticated using Signature Version 4.

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

The endpoint on which the Ethereum node listens to run Ethereum JSON-RPC methods over WebSockets connections from a client. Use this endpoint in client code for smart contracts when using a WebSockets connection. Connections to this endpoint are authenticated using Signature Version 4.

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

Attributes of an Ethereum node.

" } }, "com.amazonaws.managedblockchain#NodeFabricAttributes": { @@ -2245,7 +2287,7 @@ } }, "traits": { - "smithy.api#documentation": "

Attributes of Hyperledger Fabric for a peer node on a Managed Blockchain network that uses Hyperledger Fabric.

" + "smithy.api#documentation": "

Attributes of Hyperledger Fabric for a peer node on a Hyperledger Fabric network on Managed Blockchain.

" } }, "com.amazonaws.managedblockchain#NodeFabricLogPublishingConfiguration": { @@ -2276,10 +2318,16 @@ "traits": { "smithy.api#documentation": "

Attributes of Hyperledger Fabric for a peer node on a Managed Blockchain network that uses Hyperledger Fabric.

" } + }, + "Ethereum": { + "target": "com.amazonaws.managedblockchain#NodeEthereumAttributes", + "traits": { + "smithy.api#documentation": "

Attributes of Ethereum for a node on a Managed Blockchain network that uses Ethereum.

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

Attributes relevant to a peer node on a Managed Blockchain network for the blockchain framework that the network uses.

" + "smithy.api#documentation": "

Attributes relevant to a node on a Managed Blockchain network for the blockchain framework that the network uses.

" } }, "com.amazonaws.managedblockchain#NodeListMaxResults": { @@ -2303,7 +2351,7 @@ } }, "traits": { - "smithy.api#documentation": "

Configuration properties for logging events associated with a peer node owned by a member in a Managed Blockchain network.

" + "smithy.api#documentation": "

Configuration properties for logging events associated with a peer node on a Hyperledger Fabric network on Managed Blockchain.

" } }, "com.amazonaws.managedblockchain#NodeStatus": { @@ -2318,6 +2366,10 @@ "value": "AVAILABLE", "name": "AVAILABLE" }, + { + "value": "UNHEALTHY", + "name": "UNHEALTHY" + }, { "value": "CREATE_FAILED", "name": "CREATE_FAILED" @@ -2376,7 +2428,7 @@ } }, "traits": { - "smithy.api#documentation": "

A summary of configuration properties for a peer node.

" + "smithy.api#documentation": "

A summary of configuration properties for a node.

" } }, "com.amazonaws.managedblockchain#NodeSummaryList": { @@ -2485,7 +2537,7 @@ } }, "traits": { - "smithy.api#documentation": "

Properties of a proposal on a Managed Blockchain network.

" + "smithy.api#documentation": "

Properties of a proposal on a Managed Blockchain network.

\n

Applies only to Hyperledger Fabric.

" } }, "com.amazonaws.managedblockchain#ProposalActions": { @@ -2505,7 +2557,7 @@ } }, "traits": { - "smithy.api#documentation": "

\n The actions to carry out if a proposal is APPROVED.\n

" + "smithy.api#documentation": "

\n The actions to carry out if a proposal is APPROVED.\n

\n

Applies only to Hyperledger Fabric.

" } }, "com.amazonaws.managedblockchain#ProposalDurationInt": { @@ -2602,7 +2654,7 @@ } }, "traits": { - "smithy.api#documentation": "

Properties of a proposal.

" + "smithy.api#documentation": "

Properties of a proposal.

\n

Applies only to Hyperledger Fabric.

" } }, "com.amazonaws.managedblockchain#ProposalSummaryList": { @@ -2646,7 +2698,7 @@ } ], "traits": { - "smithy.api#documentation": "

Rejects an invitation to join a network. This action can be called by a principal in an AWS account that has received an invitation to create a member and join a network.

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

Rejects an invitation to join a network. This action can be called by a principal in an AWS account that has received an invitation to create a member and join a network.

\n

Applies only to Hyperledger Fabric.

", "smithy.api#http": { "method": "DELETE", "uri": "/invitations/{InvitationId}", @@ -2683,7 +2735,7 @@ } }, "traits": { - "smithy.api#documentation": "

An action to remove a member from a Managed Blockchain network as the result of a removal proposal that is APPROVED. The member and all associated resources are deleted from the network.

" + "smithy.api#documentation": "

An action to remove a member from a Managed Blockchain network as the result of a removal proposal that is APPROVED. The member and all associated resources are deleted from the network.

\n

Applies only to Hyperledger Fabric.

" } }, "com.amazonaws.managedblockchain#RemoveActionList": { @@ -2848,7 +2900,7 @@ "name": "managedblockchain" }, "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

\n

Amazon Managed Blockchain is a fully managed service for creating and managing blockchain networks using open source frameworks. Blockchain allows you to build applications where multiple parties can securely and transparently run transactions and share data without the need for a trusted, central authority. Currently, Managed Blockchain supports the Hyperledger Fabric open source framework.

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

\n

Amazon Managed Blockchain is a fully managed service for creating and managing blockchain networks using open-source frameworks. Blockchain allows you to build applications where multiple parties can securely and transparently run transactions and share data without the need for a trusted, central authority.

\n

Managed Blockchain supports the Hyperledger Fabric and Ethereum open-source frameworks. Because of fundamental differences between the frameworks, some API actions or data types may only apply in the context of one framework and not the other. For example, actions related to Hyperledger Fabric network members such as CreateMember and DeleteMember do not apply to Ethereum.

\n

The description for each action indicates the framework or frameworks to which it applies. Data types and properties that apply only in the context of a particular framework are similarly indicated.

", "smithy.api#title": "Amazon Managed Blockchain" } }, @@ -2918,7 +2970,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates a member configuration with new parameters.

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

Updates a member configuration with new parameters.

\n

Applies only to Hyperledger Fabric.

", "smithy.api#http": { "method": "PATCH", "uri": "/networks/{NetworkId}/members/{MemberId}", @@ -2932,7 +2984,7 @@ "NetworkId": { "target": "com.amazonaws.managedblockchain#ResourceIdString", "traits": { - "smithy.api#documentation": "

The unique ID of the Managed Blockchain network to which the member belongs.

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

The unique identifier of the Managed Blockchain network to which the member belongs.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2940,7 +2992,7 @@ "MemberId": { "target": "com.amazonaws.managedblockchain#ResourceIdString", "traits": { - "smithy.api#documentation": "

The unique ID of the member.

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

The unique identifier of the member.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2983,10 +3035,10 @@ } ], "traits": { - "smithy.api#documentation": "

Updates a node configuration with new parameters.

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

Updates a node configuration with new parameters.

\n

Applies only to Hyperledger Fabric.

", "smithy.api#http": { "method": "PATCH", - "uri": "/networks/{NetworkId}/members/{MemberId}/nodes/{NodeId}", + "uri": "/networks/{NetworkId}/nodes/{NodeId}", "code": 200 } } @@ -2997,7 +3049,7 @@ "NetworkId": { "target": "com.amazonaws.managedblockchain#ResourceIdString", "traits": { - "smithy.api#documentation": "

The unique ID of the Managed Blockchain network to which the node belongs.

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

The unique identifier of the network that the node is on.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3005,15 +3057,13 @@ "MemberId": { "target": "com.amazonaws.managedblockchain#ResourceIdString", "traits": { - "smithy.api#documentation": "

The unique ID of the member that owns the node.

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

The unique identifier of the member that owns the node.

\n

Applies only to Hyperledger Fabric.

" } }, "NodeId": { "target": "com.amazonaws.managedblockchain#ResourceIdString", "traits": { - "smithy.api#documentation": "

The unique ID of the node.

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

The unique identifier of the node.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3075,7 +3125,7 @@ } ], "traits": { - "smithy.api#documentation": "

Casts a vote for a specified ProposalId on behalf of a member. The member to vote as, specified by VoterMemberId, must be in the same AWS account as the principal that calls the action.

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

Casts a vote for a specified ProposalId on behalf of a member. The member to vote as, specified by VoterMemberId, must be in the same AWS account as the principal that calls the action.

\n

Applies only to Hyperledger Fabric.

", "smithy.api#http": { "method": "POST", "uri": "/networks/{NetworkId}/proposals/{ProposalId}/votes", @@ -3145,7 +3195,7 @@ } }, "traits": { - "smithy.api#documentation": "

\n Properties of an individual vote that a member cast for a proposal.\n

" + "smithy.api#documentation": "

\n Properties of an individual vote that a member cast for a proposal.\n

\n

Applies only to Hyperledger Fabric.

" } }, "com.amazonaws.managedblockchain#VoteValue": { @@ -3174,7 +3224,7 @@ } }, "traits": { - "smithy.api#documentation": "

\n The voting rules for the network to decide if a proposal is accepted\n

" + "smithy.api#documentation": "

\n The voting rules for the network to decide if a proposal is accepted\n

\n

Applies only to Hyperledger Fabric.

" } } } diff --git a/codegen/sdk-codegen/aws-models/marketplacecommerceanalytics.2015-07-01.json b/codegen/sdk-codegen/aws-models/marketplacecommerceanalytics.2015-07-01.json index aa3be0e3a8e..a69f51aaf6c 100644 --- a/codegen/sdk-codegen/aws-models/marketplacecommerceanalytics.2015-07-01.json +++ b/codegen/sdk-codegen/aws-models/marketplacecommerceanalytics.2015-07-01.json @@ -431,10 +431,12 @@ "traits": { "smithy.api#enum": [ { - "value": "customer_support_contacts_data" + "value": "customer_support_contacts_data", + "name": "customer_support_contacts_data" }, { - "value": "test_customer_support_contacts_data" + "value": "test_customer_support_contacts_data", + "name": "test_customer_support_contacts_data" } ], "smithy.api#length": { diff --git a/codegen/sdk-codegen/aws-models/neptune.2014-10-31.json b/codegen/sdk-codegen/aws-models/neptune.2014-10-31.json index 1032fd0193b..0ea4ebff49f 100644 --- a/codegen/sdk-codegen/aws-models/neptune.2014-10-31.json +++ b/codegen/sdk-codegen/aws-models/neptune.2014-10-31.json @@ -381,10 +381,12 @@ "traits": { "smithy.api#enum": [ { - "value": "immediate" + "value": "immediate", + "name": "immediate" }, { - "value": "pending-reboot" + "value": "pending-reboot", + "name": "pending_reboot" } ] } @@ -8200,22 +8202,28 @@ "traits": { "smithy.api#enum": [ { - "value": "db-instance" + "value": "db-instance", + "name": "db_instance" }, { - "value": "db-parameter-group" + "value": "db-parameter-group", + "name": "db_parameter_group" }, { - "value": "db-security-group" + "value": "db-security-group", + "name": "db_security_group" }, { - "value": "db-snapshot" + "value": "db-snapshot", + "name": "db_snapshot" }, { - "value": "db-cluster" + "value": "db-cluster", + "name": "db_cluster" }, { - "value": "db-cluster-snapshot" + "value": "db-cluster-snapshot", + "name": "db_cluster_snapshot" } ] } diff --git a/codegen/sdk-codegen/aws-models/opsworks.2013-02-18.json b/codegen/sdk-codegen/aws-models/opsworks.2013-02-18.json index a55f13794c9..0ebcaf39410 100644 --- a/codegen/sdk-codegen/aws-models/opsworks.2013-02-18.json +++ b/codegen/sdk-codegen/aws-models/opsworks.2013-02-18.json @@ -161,16 +161,20 @@ "traits": { "smithy.api#enum": [ { - "value": "DocumentRoot" + "value": "DocumentRoot", + "name": "DocumentRoot" }, { - "value": "RailsEnv" + "value": "RailsEnv", + "name": "RailsEnv" }, { - "value": "AutoBundleOnDeploy" + "value": "AutoBundleOnDeploy", + "name": "AutoBundleOnDeploy" }, { - "value": "AwsFlowRubySettings" + "value": "AwsFlowRubySettings", + "name": "AwsFlowRubySettings" } ] } @@ -180,25 +184,32 @@ "traits": { "smithy.api#enum": [ { - "value": "aws-flow-ruby" + "value": "aws-flow-ruby", + "name": "aws_flow_ruby" }, { - "value": "java" + "value": "java", + "name": "java" }, { - "value": "rails" + "value": "rails", + "name": "rails" }, { - "value": "php" + "value": "php", + "name": "php" }, { - "value": "nodejs" + "value": "nodejs", + "name": "nodejs" }, { - "value": "static" + "value": "static", + "name": "static" }, { - "value": "other" + "value": "other", + "name": "other" } ] } @@ -214,10 +225,12 @@ "traits": { "smithy.api#enum": [ { - "value": "x86_64" + "value": "x86_64", + "name": "x86_64" }, { - "value": "i386" + "value": "i386", + "name": "i386" } ] } @@ -419,10 +432,12 @@ "traits": { "smithy.api#enum": [ { - "value": "load" + "value": "load", + "name": "load" }, { - "value": "timer" + "value": "timer", + "name": "timer" } ] } @@ -690,280 +705,372 @@ "smithy.api#documentation": "

Specifies the encoding of the log file so that the file can be read correctly. The default is utf_8. Encodings supported by Python codecs.decode() can be used here.

", "smithy.api#enum": [ { - "value": "ascii" + "value": "ascii", + "name": "ascii" }, { - "value": "big5" + "value": "big5", + "name": "big5" }, { - "value": "big5hkscs" + "value": "big5hkscs", + "name": "big5hkscs" }, { - "value": "cp037" + "value": "cp037", + "name": "cp037" }, { - "value": "cp424" + "value": "cp424", + "name": "cp424" }, { - "value": "cp437" + "value": "cp437", + "name": "cp437" }, { - "value": "cp500" + "value": "cp500", + "name": "cp500" }, { - "value": "cp720" + "value": "cp720", + "name": "cp720" }, { - "value": "cp737" + "value": "cp737", + "name": "cp737" }, { - "value": "cp775" + "value": "cp775", + "name": "cp775" }, { - "value": "cp850" + "value": "cp850", + "name": "cp850" }, { - "value": "cp852" + "value": "cp852", + "name": "cp852" }, { - "value": "cp855" + "value": "cp855", + "name": "cp855" }, { - "value": "cp856" + "value": "cp856", + "name": "cp856" }, { - "value": "cp857" + "value": "cp857", + "name": "cp857" }, { - "value": "cp858" + "value": "cp858", + "name": "cp858" }, { - "value": "cp860" + "value": "cp860", + "name": "cp860" }, { - "value": "cp861" + "value": "cp861", + "name": "cp861" }, { - "value": "cp862" + "value": "cp862", + "name": "cp862" }, { - "value": "cp863" + "value": "cp863", + "name": "cp863" }, { - "value": "cp864" + "value": "cp864", + "name": "cp864" }, { - "value": "cp865" + "value": "cp865", + "name": "cp865" }, { - "value": "cp866" + "value": "cp866", + "name": "cp866" }, { - "value": "cp869" + "value": "cp869", + "name": "cp869" }, { - "value": "cp874" + "value": "cp874", + "name": "cp874" }, { - "value": "cp875" + "value": "cp875", + "name": "cp875" }, { - "value": "cp932" + "value": "cp932", + "name": "cp932" }, { - "value": "cp949" + "value": "cp949", + "name": "cp949" }, { - "value": "cp950" + "value": "cp950", + "name": "cp950" }, { - "value": "cp1006" + "value": "cp1006", + "name": "cp1006" }, { - "value": "cp1026" + "value": "cp1026", + "name": "cp1026" }, { - "value": "cp1140" + "value": "cp1140", + "name": "cp1140" }, { - "value": "cp1250" + "value": "cp1250", + "name": "cp1250" }, { - "value": "cp1251" + "value": "cp1251", + "name": "cp1251" }, { - "value": "cp1252" + "value": "cp1252", + "name": "cp1252" }, { - "value": "cp1253" + "value": "cp1253", + "name": "cp1253" }, { - "value": "cp1254" + "value": "cp1254", + "name": "cp1254" }, { - "value": "cp1255" + "value": "cp1255", + "name": "cp1255" }, { - "value": "cp1256" + "value": "cp1256", + "name": "cp1256" }, { - "value": "cp1257" + "value": "cp1257", + "name": "cp1257" }, { - "value": "cp1258" + "value": "cp1258", + "name": "cp1258" }, { - "value": "euc_jp" + "value": "euc_jp", + "name": "euc_jp" }, { - "value": "euc_jis_2004" + "value": "euc_jis_2004", + "name": "euc_jis_2004" }, { - "value": "euc_jisx0213" + "value": "euc_jisx0213", + "name": "euc_jisx0213" }, { - "value": "euc_kr" + "value": "euc_kr", + "name": "euc_kr" }, { - "value": "gb2312" + "value": "gb2312", + "name": "gb2312" }, { - "value": "gbk" + "value": "gbk", + "name": "gbk" }, { - "value": "gb18030" + "value": "gb18030", + "name": "gb18030" }, { - "value": "hz" + "value": "hz", + "name": "hz" }, { - "value": "iso2022_jp" + "value": "iso2022_jp", + "name": "iso2022_jp" }, { - "value": "iso2022_jp_1" + "value": "iso2022_jp_1", + "name": "iso2022_jp_1" }, { - "value": "iso2022_jp_2" + "value": "iso2022_jp_2", + "name": "iso2022_jp_2" }, { - "value": "iso2022_jp_2004" + "value": "iso2022_jp_2004", + "name": "iso2022_jp_2004" }, { - "value": "iso2022_jp_3" + "value": "iso2022_jp_3", + "name": "iso2022_jp_3" }, { - "value": "iso2022_jp_ext" + "value": "iso2022_jp_ext", + "name": "iso2022_jp_ext" }, { - "value": "iso2022_kr" + "value": "iso2022_kr", + "name": "iso2022_kr" }, { - "value": "latin_1" + "value": "latin_1", + "name": "latin_1" }, { - "value": "iso8859_2" + "value": "iso8859_2", + "name": "iso8859_2" }, { - "value": "iso8859_3" + "value": "iso8859_3", + "name": "iso8859_3" }, { - "value": "iso8859_4" + "value": "iso8859_4", + "name": "iso8859_4" }, { - "value": "iso8859_5" + "value": "iso8859_5", + "name": "iso8859_5" }, { - "value": "iso8859_6" + "value": "iso8859_6", + "name": "iso8859_6" }, { - "value": "iso8859_7" + "value": "iso8859_7", + "name": "iso8859_7" }, { - "value": "iso8859_8" + "value": "iso8859_8", + "name": "iso8859_8" }, { - "value": "iso8859_9" + "value": "iso8859_9", + "name": "iso8859_9" }, { - "value": "iso8859_10" + "value": "iso8859_10", + "name": "iso8859_10" }, { - "value": "iso8859_13" + "value": "iso8859_13", + "name": "iso8859_13" }, { - "value": "iso8859_14" + "value": "iso8859_14", + "name": "iso8859_14" }, { - "value": "iso8859_15" + "value": "iso8859_15", + "name": "iso8859_15" }, { - "value": "iso8859_16" + "value": "iso8859_16", + "name": "iso8859_16" }, { - "value": "johab" + "value": "johab", + "name": "johab" }, { - "value": "koi8_r" + "value": "koi8_r", + "name": "koi8_r" }, { - "value": "koi8_u" + "value": "koi8_u", + "name": "koi8_u" }, { - "value": "mac_cyrillic" + "value": "mac_cyrillic", + "name": "mac_cyrillic" }, { - "value": "mac_greek" + "value": "mac_greek", + "name": "mac_greek" }, { - "value": "mac_iceland" + "value": "mac_iceland", + "name": "mac_iceland" }, { - "value": "mac_latin2" + "value": "mac_latin2", + "name": "mac_latin2" }, { - "value": "mac_roman" + "value": "mac_roman", + "name": "mac_roman" }, { - "value": "mac_turkish" + "value": "mac_turkish", + "name": "mac_turkish" }, { - "value": "ptcp154" + "value": "ptcp154", + "name": "ptcp154" }, { - "value": "shift_jis" + "value": "shift_jis", + "name": "shift_jis" }, { - "value": "shift_jis_2004" + "value": "shift_jis_2004", + "name": "shift_jis_2004" }, { - "value": "shift_jisx0213" + "value": "shift_jisx0213", + "name": "shift_jisx0213" }, { - "value": "utf_32" + "value": "utf_32", + "name": "utf_32" }, { - "value": "utf_32_be" + "value": "utf_32_be", + "name": "utf_32_be" }, { - "value": "utf_32_le" + "value": "utf_32_le", + "name": "utf_32_le" }, { - "value": "utf_16" + "value": "utf_16", + "name": "utf_16" }, { - "value": "utf_16_be" + "value": "utf_16_be", + "name": "utf_16_be" }, { - "value": "utf_16_le" + "value": "utf_16_le", + "name": "utf_16_le" }, { - "value": "utf_7" + "value": "utf_7", + "name": "utf_7" }, { - "value": "utf_8" + "value": "utf_8", + "name": "utf_8" }, { - "value": "utf_8_sig" + "value": "utf_8_sig", + "name": "utf_8_sig" } ] } @@ -974,10 +1081,12 @@ "smithy.api#documentation": "

Specifies where to start to read data (start_of_file or end_of_file). The default is start_of_file. It's only used if there is no state persisted for that log stream.

", "smithy.api#enum": [ { - "value": "start_of_file" + "value": "start_of_file", + "name": "start_of_file" }, { - "value": "end_of_file" + "value": "end_of_file", + "name": "end_of_file" } ] } @@ -1071,10 +1180,12 @@ "smithy.api#documentation": "

The preferred time zone for logs streamed to CloudWatch Logs. Valid values are LOCAL and UTC, for Coordinated Universal Time.

", "smithy.api#enum": [ { - "value": "LOCAL" + "value": "LOCAL", + "name": "LOCAL" }, { - "value": "UTC" + "value": "UTC", + "name": "UTC" } ] } @@ -2182,40 +2293,52 @@ "traits": { "smithy.api#enum": [ { - "value": "install_dependencies" + "value": "install_dependencies", + "name": "install_dependencies" }, { - "value": "update_dependencies" + "value": "update_dependencies", + "name": "update_dependencies" }, { - "value": "update_custom_cookbooks" + "value": "update_custom_cookbooks", + "name": "update_custom_cookbooks" }, { - "value": "execute_recipes" + "value": "execute_recipes", + "name": "execute_recipes" }, { - "value": "configure" + "value": "configure", + "name": "configure" }, { - "value": "setup" + "value": "setup", + "name": "setup" }, { - "value": "deploy" + "value": "deploy", + "name": "deploy" }, { - "value": "rollback" + "value": "rollback", + "name": "rollback" }, { - "value": "start" + "value": "start", + "name": "start" }, { - "value": "stop" + "value": "stop", + "name": "stop" }, { - "value": "restart" + "value": "restart", + "name": "restart" }, { - "value": "undeploy" + "value": "undeploy", + "name": "undeploy" } ] } @@ -4884,79 +5007,104 @@ "traits": { "smithy.api#enum": [ { - "value": "EcsClusterArn" + "value": "EcsClusterArn", + "name": "EcsClusterArn" }, { - "value": "EnableHaproxyStats" + "value": "EnableHaproxyStats", + "name": "EnableHaproxyStats" }, { - "value": "HaproxyStatsUrl" + "value": "HaproxyStatsUrl", + "name": "HaproxyStatsUrl" }, { - "value": "HaproxyStatsUser" + "value": "HaproxyStatsUser", + "name": "HaproxyStatsUser" }, { - "value": "HaproxyStatsPassword" + "value": "HaproxyStatsPassword", + "name": "HaproxyStatsPassword" }, { - "value": "HaproxyHealthCheckUrl" + "value": "HaproxyHealthCheckUrl", + "name": "HaproxyHealthCheckUrl" }, { - "value": "HaproxyHealthCheckMethod" + "value": "HaproxyHealthCheckMethod", + "name": "HaproxyHealthCheckMethod" }, { - "value": "MysqlRootPassword" + "value": "MysqlRootPassword", + "name": "MysqlRootPassword" }, { - "value": "MysqlRootPasswordUbiquitous" + "value": "MysqlRootPasswordUbiquitous", + "name": "MysqlRootPasswordUbiquitous" }, { - "value": "GangliaUrl" + "value": "GangliaUrl", + "name": "GangliaUrl" }, { - "value": "GangliaUser" + "value": "GangliaUser", + "name": "GangliaUser" }, { - "value": "GangliaPassword" + "value": "GangliaPassword", + "name": "GangliaPassword" }, { - "value": "MemcachedMemory" + "value": "MemcachedMemory", + "name": "MemcachedMemory" }, { - "value": "NodejsVersion" + "value": "NodejsVersion", + "name": "NodejsVersion" }, { - "value": "RubyVersion" + "value": "RubyVersion", + "name": "RubyVersion" }, { - "value": "RubygemsVersion" + "value": "RubygemsVersion", + "name": "RubygemsVersion" }, { - "value": "ManageBundler" + "value": "ManageBundler", + "name": "ManageBundler" }, { - "value": "BundlerVersion" + "value": "BundlerVersion", + "name": "BundlerVersion" }, { - "value": "RailsStack" + "value": "RailsStack", + "name": "RailsStack" }, { - "value": "PassengerVersion" + "value": "PassengerVersion", + "name": "PassengerVersion" }, { - "value": "Jvm" + "value": "Jvm", + "name": "Jvm" }, { - "value": "JvmVersion" + "value": "JvmVersion", + "name": "JvmVersion" }, { - "value": "JvmOptions" + "value": "JvmOptions", + "name": "JvmOptions" }, { - "value": "JavaAppServer" + "value": "JavaAppServer", + "name": "JavaAppServer" }, { - "value": "JavaAppServerVersion" + "value": "JavaAppServerVersion", + "name": "JavaAppServerVersion" } ] } @@ -4966,40 +5114,52 @@ "traits": { "smithy.api#enum": [ { - "value": "aws-flow-ruby" + "value": "aws-flow-ruby", + "name": "aws_flow_ruby" }, { - "value": "ecs-cluster" + "value": "ecs-cluster", + "name": "ecs_cluster" }, { - "value": "java-app" + "value": "java-app", + "name": "java_app" }, { - "value": "lb" + "value": "lb", + "name": "lb" }, { - "value": "web" + "value": "web", + "name": "web" }, { - "value": "php-app" + "value": "php-app", + "name": "php_app" }, { - "value": "rails-app" + "value": "rails-app", + "name": "rails_app" }, { - "value": "nodejs-app" + "value": "nodejs-app", + "name": "nodejs_app" }, { - "value": "memcached" + "value": "memcached", + "name": "memcached" }, { - "value": "db-master" + "value": "db-master", + "name": "db_master" }, { - "value": "monitoring-master" + "value": "monitoring-master", + "name": "monitoring_master" }, { - "value": "custom" + "value": "custom", + "name": "custom" } ] } @@ -6089,10 +6249,12 @@ "traits": { "smithy.api#enum": [ { - "value": "ebs" + "value": "ebs", + "name": "ebs" }, { - "value": "instance-store" + "value": "instance-store", + "name": "instance_store" } ] } @@ -6384,16 +6546,20 @@ "traits": { "smithy.api#enum": [ { - "value": "git" + "value": "git", + "name": "git" }, { - "value": "svn" + "value": "svn", + "name": "svn" }, { - "value": "archive" + "value": "archive", + "name": "archive" }, { - "value": "s3" + "value": "s3", + "name": "s3" } ] } @@ -6580,7 +6746,8 @@ "traits": { "smithy.api#enum": [ { - "value": "Color" + "value": "Color", + "name": "Color" } ] } @@ -7701,10 +7868,12 @@ "traits": { "smithy.api#enum": [ { - "value": "paravirtual" + "value": "paravirtual", + "name": "paravirtual" }, { - "value": "hvm" + "value": "hvm", + "name": "hvm" } ] } @@ -7865,13 +8034,16 @@ "traits": { "smithy.api#enum": [ { - "value": "gp2" + "value": "gp2", + "name": "gp2" }, { - "value": "io1" + "value": "io1", + "name": "io1" }, { - "value": "standard" + "value": "standard", + "name": "standard" } ] } diff --git a/codegen/sdk-codegen/aws-models/outposts.2019-12-03.json b/codegen/sdk-codegen/aws-models/outposts.2019-12-03.json index ddca2f37ff9..898e731f8a4 100644 --- a/codegen/sdk-codegen/aws-models/outposts.2019-12-03.json +++ b/codegen/sdk-codegen/aws-models/outposts.2019-12-03.json @@ -52,6 +52,16 @@ } } }, + "com.amazonaws.outposts#Arn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1011 + }, + "smithy.api#pattern": "^(arn:aws([a-z-]+)?:outposts:[a-z\\d-]+:\\d{12}:([a-z\\d-]+)/)[a-z]{2,8}-[a-f0-9]{17}$" + } + }, "com.amazonaws.outposts#AvailabilityZone": { "type": "string", "traits": { @@ -542,6 +552,58 @@ } } }, + "com.amazonaws.outposts#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.outposts#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.outposts#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.outposts#InternalServerException" + }, + { + "target": "com.amazonaws.outposts#NotFoundException" + }, + { + "target": "com.amazonaws.outposts#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the tags for the specified resource.

", + "smithy.api#http": { + "method": "GET", + "uri": "/tags/{ResourceArn}", + "code": 200 + } + } + }, + "com.amazonaws.outposts#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.outposts#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

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

The resource tags.

" + } + } + } + }, "com.amazonaws.outposts#MaxResults1000": { "type": "integer", "traits": { @@ -621,7 +683,7 @@ "com.amazonaws.outposts#OutpostDescription": { "type": "string", "traits": { - "smithy.api#documentation": "

The Outpost description.

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

The description of the Outpost.

", "smithy.api#length": { "min": 1, "max": 1000 @@ -675,6 +737,15 @@ }, { "target": "com.amazonaws.outposts#ListSites" + }, + { + "target": "com.amazonaws.outposts#ListTagsForResource" + }, + { + "target": "com.amazonaws.outposts#TagResource" + }, + { + "target": "com.amazonaws.outposts#UntagResource" } ], "traits": { @@ -689,7 +760,7 @@ "name": "outposts" }, "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

AWS Outposts is a fully-managed service that extends AWS infrastructure, \n APIs, and tools to customer premises. By providing local access to AWS-managed \n infrastructure, AWS Outposts enables customers to build and run applications \n on premises using the same programming interfaces as in AWS Regions, while \n using local compute and storage resources for lower latency and local data \n processing needs.

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

AWS Outposts is a fully managed service that extends AWS infrastructure, APIs, and tools\n to customer premises. By providing local access to AWS managed infrastructure, AWS Outposts\n enables customers to build and run applications on premises using the same programming\n interfaces as in AWS Regions, while using local compute and storage resources for lower\n latency and local data processing needs.

", "smithy.api#title": "AWS Outposts" } }, @@ -786,6 +857,18 @@ "smithy.api#pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$" } }, + "com.amazonaws.outposts#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.outposts#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, "com.amazonaws.outposts#TagMap": { "type": "map", "key": { @@ -801,6 +884,58 @@ } } }, + "com.amazonaws.outposts#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.outposts#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.outposts#TagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.outposts#InternalServerException" + }, + { + "target": "com.amazonaws.outposts#NotFoundException" + }, + { + "target": "com.amazonaws.outposts#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Adds tags to the specified resource.

", + "smithy.api#http": { + "method": "POST", + "uri": "/tags/{ResourceArn}", + "code": 200 + } + } + }, + "com.amazonaws.outposts#TagResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.outposts#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

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

The tags to add to the resource.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.outposts#TagResourceResponse": { + "type": "structure", + "members": {} + }, "com.amazonaws.outposts#TagValue": { "type": "string", "traits": { @@ -822,6 +957,59 @@ "smithy.api#pattern": ".*\\S.*" } }, + "com.amazonaws.outposts#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.outposts#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.outposts#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.outposts#InternalServerException" + }, + { + "target": "com.amazonaws.outposts#NotFoundException" + }, + { + "target": "com.amazonaws.outposts#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes tags from the specified resource.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/tags/{ResourceArn}", + "code": 200 + } + } + }, + "com.amazonaws.outposts#UntagResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.outposts#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

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

The tag keys.

", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.outposts#UntagResourceResponse": { + "type": "structure", + "members": {} + }, "com.amazonaws.outposts#ValidationException": { "type": "structure", "members": { diff --git a/codegen/sdk-codegen/aws-models/personalizeruntime.2018-05-22.json b/codegen/sdk-codegen/aws-models/personalizeruntime.2018-05-22.json index 97b42cb5b96..a6aad5c9f27 100644 --- a/codegen/sdk-codegen/aws-models/personalizeruntime.2018-05-22.json +++ b/codegen/sdk-codegen/aws-models/personalizeruntime.2018-05-22.json @@ -111,7 +111,7 @@ "min": 0, "max": 50 }, - "smithy.api#pattern": "[A-Za-z0-9]+" + "smithy.api#pattern": "[A-Za-z0-9_]+" } }, "com.amazonaws.personalizeruntime#FilterAttributeValue": { diff --git a/codegen/sdk-codegen/aws-models/polly.2016-06-10.json b/codegen/sdk-codegen/aws-models/polly.2016-06-10.json index 37f6126c9df..547e145e75c 100644 --- a/codegen/sdk-codegen/aws-models/polly.2016-06-10.json +++ b/codegen/sdk-codegen/aws-models/polly.2016-06-10.json @@ -203,10 +203,12 @@ "traits": { "smithy.api#enum": [ { - "value": "Female" + "value": "Female", + "name": "Female" }, { - "value": "Male" + "value": "Male", + "name": "Male" } ] } @@ -430,91 +432,120 @@ "traits": { "smithy.api#enum": [ { - "value": "arb" + "value": "arb", + "name": "arb" }, { - "value": "cmn-CN" + "value": "cmn-CN", + "name": "cmn_CN" }, { - "value": "cy-GB" + "value": "cy-GB", + "name": "cy_GB" }, { - "value": "da-DK" + "value": "da-DK", + "name": "da_DK" }, { - "value": "de-DE" + "value": "de-DE", + "name": "de_DE" }, { - "value": "en-AU" + "value": "en-AU", + "name": "en_AU" }, { - "value": "en-GB" + "value": "en-GB", + "name": "en_GB" }, { - "value": "en-GB-WLS" + "value": "en-GB-WLS", + "name": "en_GB_WLS" }, { - "value": "en-IN" + "value": "en-IN", + "name": "en_IN" }, { - "value": "en-US" + "value": "en-US", + "name": "en_US" }, { - "value": "es-ES" + "value": "es-ES", + "name": "es_ES" }, { - "value": "es-MX" + "value": "es-MX", + "name": "es_MX" }, { - "value": "es-US" + "value": "es-US", + "name": "es_US" }, { - "value": "fr-CA" + "value": "fr-CA", + "name": "fr_CA" }, { - "value": "fr-FR" + "value": "fr-FR", + "name": "fr_FR" }, { - "value": "is-IS" + "value": "is-IS", + "name": "is_IS" }, { - "value": "it-IT" + "value": "it-IT", + "name": "it_IT" }, { - "value": "ja-JP" + "value": "ja-JP", + "name": "ja_JP" }, { - "value": "hi-IN" + "value": "hi-IN", + "name": "hi_IN" }, { - "value": "ko-KR" + "value": "ko-KR", + "name": "ko_KR" }, { - "value": "nb-NO" + "value": "nb-NO", + "name": "nb_NO" }, { - "value": "nl-NL" + "value": "nl-NL", + "name": "nl_NL" }, { - "value": "pl-PL" + "value": "pl-PL", + "name": "pl_PL" }, { - "value": "pt-BR" + "value": "pt-BR", + "name": "pt_BR" }, { - "value": "pt-PT" + "value": "pt-PT", + "name": "pt_PT" }, { - "value": "ro-RO" + "value": "ro-RO", + "name": "ro_RO" }, { - "value": "ru-RU" + "value": "ru-RU", + "name": "ru_RU" }, { - "value": "sv-SE" + "value": "sv-SE", + "name": "sv_SE" }, { - "value": "tr-TR" + "value": "tr-TR", + "name": "tr_TR" } ] } @@ -1646,190 +1677,252 @@ "traits": { "smithy.api#enum": [ { - "value": "Aditi" + "value": "Aditi", + "name": "Aditi" }, { - "value": "Amy" + "value": "Amy", + "name": "Amy" }, { - "value": "Astrid" + "value": "Astrid", + "name": "Astrid" }, { - "value": "Bianca" + "value": "Bianca", + "name": "Bianca" }, { - "value": "Brian" + "value": "Brian", + "name": "Brian" }, { - "value": "Camila" + "value": "Camila", + "name": "Camila" }, { - "value": "Carla" + "value": "Carla", + "name": "Carla" }, { - "value": "Carmen" + "value": "Carmen", + "name": "Carmen" }, { - "value": "Celine" + "value": "Celine", + "name": "Celine" }, { - "value": "Chantal" + "value": "Chantal", + "name": "Chantal" }, { - "value": "Conchita" + "value": "Conchita", + "name": "Conchita" }, { - "value": "Cristiano" + "value": "Cristiano", + "name": "Cristiano" }, { - "value": "Dora" + "value": "Dora", + "name": "Dora" }, { - "value": "Emma" + "value": "Emma", + "name": "Emma" }, { - "value": "Enrique" + "value": "Enrique", + "name": "Enrique" }, { - "value": "Ewa" + "value": "Ewa", + "name": "Ewa" }, { - "value": "Filiz" + "value": "Filiz", + "name": "Filiz" }, { - "value": "Geraint" + "value": "Geraint", + "name": "Geraint" }, { - "value": "Giorgio" + "value": "Giorgio", + "name": "Giorgio" }, { - "value": "Gwyneth" + "value": "Gwyneth", + "name": "Gwyneth" }, { - "value": "Hans" + "value": "Hans", + "name": "Hans" }, { - "value": "Ines" + "value": "Ines", + "name": "Ines" }, { - "value": "Ivy" + "value": "Ivy", + "name": "Ivy" }, { - "value": "Jacek" + "value": "Jacek", + "name": "Jacek" }, { - "value": "Jan" + "value": "Jan", + "name": "Jan" }, { - "value": "Joanna" + "value": "Joanna", + "name": "Joanna" }, { - "value": "Joey" + "value": "Joey", + "name": "Joey" }, { - "value": "Justin" + "value": "Justin", + "name": "Justin" }, { - "value": "Karl" + "value": "Karl", + "name": "Karl" }, { - "value": "Kendra" + "value": "Kendra", + "name": "Kendra" }, { - "value": "Kevin" + "value": "Kevin", + "name": "Kevin" }, { - "value": "Kimberly" + "value": "Kimberly", + "name": "Kimberly" }, { - "value": "Lea" + "value": "Lea", + "name": "Lea" }, { - "value": "Liv" + "value": "Liv", + "name": "Liv" }, { - "value": "Lotte" + "value": "Lotte", + "name": "Lotte" }, { - "value": "Lucia" + "value": "Lucia", + "name": "Lucia" }, { - "value": "Lupe" + "value": "Lupe", + "name": "Lupe" }, { - "value": "Mads" + "value": "Mads", + "name": "Mads" }, { - "value": "Maja" + "value": "Maja", + "name": "Maja" }, { - "value": "Marlene" + "value": "Marlene", + "name": "Marlene" }, { - "value": "Mathieu" + "value": "Mathieu", + "name": "Mathieu" }, { - "value": "Matthew" + "value": "Matthew", + "name": "Matthew" }, { - "value": "Maxim" + "value": "Maxim", + "name": "Maxim" }, { - "value": "Mia" + "value": "Mia", + "name": "Mia" }, { - "value": "Miguel" + "value": "Miguel", + "name": "Miguel" }, { - "value": "Mizuki" + "value": "Mizuki", + "name": "Mizuki" }, { - "value": "Naja" + "value": "Naja", + "name": "Naja" }, { - "value": "Nicole" + "value": "Nicole", + "name": "Nicole" }, { - "value": "Olivia" + "value": "Olivia", + "name": "Olivia" }, { - "value": "Penelope" + "value": "Penelope", + "name": "Penelope" }, { - "value": "Raveena" + "value": "Raveena", + "name": "Raveena" }, { - "value": "Ricardo" + "value": "Ricardo", + "name": "Ricardo" }, { - "value": "Ruben" + "value": "Ruben", + "name": "Ruben" }, { - "value": "Russell" + "value": "Russell", + "name": "Russell" }, { - "value": "Salli" + "value": "Salli", + "name": "Salli" }, { - "value": "Seoyeon" + "value": "Seoyeon", + "name": "Seoyeon" }, { - "value": "Takumi" + "value": "Takumi", + "name": "Takumi" }, { - "value": "Tatyana" + "value": "Tatyana", + "name": "Tatyana" }, { - "value": "Vicki" + "value": "Vicki", + "name": "Vicki" }, { - "value": "Vitoria" + "value": "Vitoria", + "name": "Vitoria" }, { - "value": "Zeina" + "value": "Zeina", + "name": "Zeina" }, { - "value": "Zhiyu" + "value": "Zhiyu", + "name": "Zhiyu" } ] } diff --git a/codegen/sdk-codegen/aws-models/qldbsession.2019-07-11.json b/codegen/sdk-codegen/aws-models/qldbsession.2019-07-11.json index a900aab0625..d721aaad961 100644 --- a/codegen/sdk-codegen/aws-models/qldbsession.2019-07-11.json +++ b/codegen/sdk-codegen/aws-models/qldbsession.2019-07-11.json @@ -38,7 +38,14 @@ }, "com.amazonaws.qldbsession#AbortTransactionResult": { "type": "structure", - "members": {}, + "members": { + "TimingInformation": { + "target": "com.amazonaws.qldbsession#TimingInformation", + "traits": { + "smithy.api#documentation": "

Contains server-side performance information for the command.

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

Contains the details of the aborted transaction.

" } @@ -74,7 +81,7 @@ "CommitDigest": { "target": "com.amazonaws.qldbsession#CommitDigest", "traits": { - "smithy.api#documentation": "

Specifies the commit digest for the transaction to commit. For every active transaction,\n the commit digest must be passed. QLDB validates CommitDigest and rejects\n the commit with an error if the digest computed on the client does not match the digest\n computed by QLDB.

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

Specifies the commit digest for the transaction to commit. For every active transaction,\n the commit digest must be passed. QLDB validates CommitDigest and rejects\n the commit with an error if the digest computed on the client does not match the digest\n computed by QLDB.

\n

The purpose of the CommitDigest parameter is to ensure that QLDB commits\n a transaction if and only if the server has processed the exact set of statements sent by\n the client, in the same order that client sent them, and with no duplicates.

", "smithy.api#required": {} } } @@ -97,6 +104,18 @@ "traits": { "smithy.api#documentation": "

The commit digest of the committed transaction.

" } + }, + "TimingInformation": { + "target": "com.amazonaws.qldbsession#TimingInformation", + "traits": { + "smithy.api#documentation": "

Contains server-side performance information for the command.

" + } + }, + "ConsumedIOs": { + "target": "com.amazonaws.qldbsession#IOUsage", + "traits": { + "smithy.api#documentation": "

Contains metrics about the number of I/O requests that were consumed.

" + } } }, "traits": { @@ -112,7 +131,14 @@ }, "com.amazonaws.qldbsession#EndSessionResult": { "type": "structure", - "members": {}, + "members": { + "TimingInformation": { + "target": "com.amazonaws.qldbsession#TimingInformation", + "traits": { + "smithy.api#documentation": "

Contains server-side performance information for the command.

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

Contains the details of the ended session.

" } @@ -159,6 +185,18 @@ "traits": { "smithy.api#documentation": "

Contains the details of the first fetched page.

" } + }, + "TimingInformation": { + "target": "com.amazonaws.qldbsession#TimingInformation", + "traits": { + "smithy.api#documentation": "

Contains server-side performance information for the command.

" + } + }, + "ConsumedIOs": { + "target": "com.amazonaws.qldbsession#IOUsage", + "traits": { + "smithy.api#documentation": "

Contains metrics about the number of I/O requests that were consumed.

" + } } }, "traits": { @@ -195,12 +233,44 @@ "traits": { "smithy.api#documentation": "

Contains details of the fetched page.

" } + }, + "TimingInformation": { + "target": "com.amazonaws.qldbsession#TimingInformation", + "traits": { + "smithy.api#documentation": "

Contains server-side performance information for the command.

" + } + }, + "ConsumedIOs": { + "target": "com.amazonaws.qldbsession#IOUsage", + "traits": { + "smithy.api#documentation": "

Contains metrics about the number of I/O requests that were consumed.

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

Contains the page that was fetched.

" } }, + "com.amazonaws.qldbsession#IOUsage": { + "type": "structure", + "members": { + "ReadIOs": { + "target": "com.amazonaws.qldbsession#ReadIOs", + "traits": { + "smithy.api#documentation": "

The number of read I/O requests that the command performed.

" + } + }, + "WriteIOs": { + "target": "com.amazonaws.qldbsession#WriteIOs", + "traits": { + "smithy.api#documentation": "

The number of write I/O requests that the command performed.

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

Contains I/O usage metrics for a command that was invoked.

" + } + }, "com.amazonaws.qldbsession#InvalidSessionException": { "type": "structure", "members": { @@ -298,6 +368,9 @@ "smithy.api#pattern": "^[A-Za-z-0-9+/=]+$" } }, + "com.amazonaws.qldbsession#ProcessingTimeMilliseconds": { + "type": "long" + }, "com.amazonaws.qldbsession#QLDBSession": { "type": "service", "version": "2019-07-11", @@ -318,7 +391,7 @@ "name": "qldb" }, "aws.protocols#awsJson1_0": {}, - "smithy.api#documentation": "

The transactional data APIs for Amazon QLDB

\n \n

Instead of interacting directly with this API, we recommend that you use the\n Amazon QLDB Driver or the QLDB Shell to execute data transactions on a ledger.

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

The transactional data APIs for Amazon QLDB

\n \n

Instead of interacting directly with this API, we recommend using the QLDB driver\n or the QLDB shell to execute data transactions on a ledger.

\n \n ", "smithy.api#title": "Amazon QLDB Session" } }, @@ -334,6 +407,9 @@ "smithy.api#error": "client" } }, + "com.amazonaws.qldbsession#ReadIOs": { + "type": "long" + }, "com.amazonaws.qldbsession#SendCommand": { "type": "operation", "input": { @@ -360,7 +436,7 @@ } ], "traits": { - "smithy.api#documentation": "

Sends a command to an Amazon QLDB ledger.

\n \n

Instead of interacting directly with this API, we recommend that you use the\n Amazon QLDB Driver or the QLDB Shell to execute data transactions on a ledger.

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

Sends a command to an Amazon QLDB ledger.

\n \n

Instead of interacting directly with this API, we recommend using the QLDB driver\n or the QLDB shell to execute data transactions on a ledger.

\n \n " } }, "com.amazonaws.qldbsession#SendCommandRequest": { @@ -496,6 +572,12 @@ "traits": { "smithy.api#documentation": "

Session token of the started session. This SessionToken is required for\n every subsequent command that is issued during the current session.

" } + }, + "TimingInformation": { + "target": "com.amazonaws.qldbsession#TimingInformation", + "traits": { + "smithy.api#documentation": "

Contains server-side performance information for the command.

" + } } }, "traits": { @@ -517,6 +599,12 @@ "traits": { "smithy.api#documentation": "

The transaction ID of the started transaction.

" } + }, + "TimingInformation": { + "target": "com.amazonaws.qldbsession#TimingInformation", + "traits": { + "smithy.api#documentation": "

Contains server-side performance information for the command.

" + } } }, "traits": { @@ -538,6 +626,20 @@ "target": "com.amazonaws.qldbsession#ValueHolder" } }, + "com.amazonaws.qldbsession#TimingInformation": { + "type": "structure", + "members": { + "ProcessingTimeMilliseconds": { + "target": "com.amazonaws.qldbsession#ProcessingTimeMilliseconds", + "traits": { + "smithy.api#documentation": "

The amount of time that was taken for the command to finish processing, measured in\n milliseconds.

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

Contains server-side performance information for a command. Amazon QLDB captures timing\n information between the times when it receives the request and when it sends the\n corresponding response.

" + } + }, "com.amazonaws.qldbsession#TransactionId": { "type": "string", "traits": { @@ -565,7 +667,7 @@ } }, "traits": { - "smithy.api#documentation": "

A structure that can contain an Amazon Ion value in multiple encoding formats.

" + "smithy.api#documentation": "

A structure that can contain a value in multiple encoding formats.

" } }, "com.amazonaws.qldbsession#ValueHolders": { @@ -573,6 +675,9 @@ "member": { "target": "com.amazonaws.qldbsession#ValueHolder" } + }, + "com.amazonaws.qldbsession#WriteIOs": { + "type": "long" } } } diff --git a/codegen/sdk-codegen/aws-models/quicksight.2018-04-01.json b/codegen/sdk-codegen/aws-models/quicksight.2018-04-01.json index b7361fbdc90..f71b63f6117 100644 --- a/codegen/sdk-codegen/aws-models/quicksight.2018-04-01.json +++ b/codegen/sdk-codegen/aws-models/quicksight.2018-04-01.json @@ -2250,7 +2250,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates and starts a new SPICE ingestion on a dataset

\n\t\t \n\t\t

Any ingestions operating on tagged datasets inherit the same tags automatically for use in\n\t\t\taccess control. For an example, see How do I create an IAM policy to control access to Amazon EC2 resources using\n\t\t\t\ttags? in the AWS Knowledge Center. Tags are visible on the tagged dataset, but not on the ingestion resource.

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

Creates and starts a new SPICE ingestion on a dataset

\n\t\t \n\t\t

Any ingestions operating on tagged datasets inherit the same tags automatically for use in\n\t\t\taccess control. For an example, see How do I create an IAM policy to control access to Amazon EC2 resources using\n\t\t\t\ttags? in the AWS Knowledge Center. Tags are visible on the tagged dataset, but not on the ingestion resource.

", "smithy.api#http": { "method": "PUT", "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}/ingestions/{IngestionId}", @@ -3559,7 +3559,7 @@ "ImportMode": { "target": "com.amazonaws.quicksight#DataSetImportMode", "traits": { - "smithy.api#documentation": "

Indicates whether you want to import the data into SPICE.

" + "smithy.api#documentation": "

A value that indicates whether you want to import the data into SPICE.

" } }, "ConsumedSpiceCapacityInBytes": { @@ -3748,7 +3748,7 @@ "ImportMode": { "target": "com.amazonaws.quicksight#DataSetImportMode", "traits": { - "smithy.api#documentation": "

Indicates whether you want to import the data into SPICE.

" + "smithy.api#documentation": "

A value that indicates whether you want to import the data into SPICE.

" } }, "RowLevelPermissionDataSet": { @@ -3760,7 +3760,7 @@ "ColumnLevelPermissionRulesApplied": { "target": "com.amazonaws.quicksight#Boolean", "traits": { - "smithy.api#documentation": "

Indicates if the dataset has column level permission\n configured.

" + "smithy.api#documentation": "

A value that indicates if the dataset has column level permission configured.

" } } }, @@ -7883,7 +7883,7 @@ } ], "traits": { - "smithy.api#documentation": "

Generates a session URL and authorization code that you can use to embed an Amazon\n QuickSight read-only dashboard in your web server code. Before you use this command,\n make sure that you have configured the dashboards and permissions.

\n

Currently, you can use GetDashboardEmbedURL only from the server, not\n from the user's browser. The following rules apply to the combination of URL and\n authorization code:

\n \n

For more information, see Embedding Amazon QuickSight in the Amazon QuickSight User\n Guide\n .

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

Generates a session URL and authorization code that you can use to embed an Amazon\n QuickSight read-only dashboard in your web server code. Before you use this command,\n make sure that you have configured the dashboards and permissions.

\n

Currently, you can use GetDashboardEmbedURL only from the server, not\n from the user's browser. The following rules apply to the combination of URL and\n authorization code:

\n \n

For more information, see Embedded Analytics in the Amazon QuickSight User\n Guide.

", "smithy.api#http": { "method": "GET", "uri": "/accounts/{AwsAccountId}/dashboards/{DashboardId}/embed-url", @@ -7905,7 +7905,7 @@ "DashboardId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { - "smithy.api#documentation": "

The ID for the dashboard, also added to the IAM policy.

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

The ID for the dashboard, also added to the AWS Identity and Access Management (IAM)\n policy.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -7942,7 +7942,7 @@ "StatePersistenceEnabled": { "target": "com.amazonaws.quicksight#Boolean", "traits": { - "smithy.api#documentation": "

Adds persistence of state for the user session in an embedded dashboard. Persistence applies to\n the sheet and the parameter settings. These are control settings that the dashboard subscriber\n (QuickSight reader) chooses while viewing the dashboard. If this is set to TRUE, the\n settings are the same when the the subscriber reopens the same dashboard URL. The state is stored\n in QuickSight, not in a browser cookie. If this is set to FALSE, the state of the user session is\n not persisted. The default is FALSE.

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

Adds persistence of state for the user session in an embedded dashboard. Persistence\n applies to the sheet and the parameter settings. These are control settings that the\n dashboard subscriber (QuickSight reader) chooses while viewing the dashboard. If this is\n set to TRUE, the settings are the same when the subscriber reopens the same\n dashboard URL. The state is stored in QuickSight, not in a browser cookie. If this is\n set to FALSE, the state of the user session is not persisted. The default is\n FALSE.

", "smithy.api#httpQuery": "state-persistence-enabled" } }, @@ -7963,13 +7963,10 @@ "AdditionalDashboardIds": { "target": "com.amazonaws.quicksight#AdditionalDashboardIdList", "traits": { - "smithy.api#documentation": "

A list of one or more dashboard ids that you want to add to a session that \n includes anonymous authorizations. IdentityType must be set to ANONYMOUS \n for this to work, because other identity types authenticate as QuickSight users. \n For example, if you set \"--dashboard-id dash_id1 --dashboard-id dash_id2 \n dash_id3 identity-type ANONYMOUS\", the session can access all \n three dashboards.\n

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

A list of one or more dashboard IDs that you want to add to a session that includes\n anonymous users. The IdentityType parameter must be set to\n ANONYMOUS for this to work, because other identity types authenticate\n as QuickSight or IAM users. For example, if you set \"--dashboard-id dash_id1\n --dashboard-id dash_id2 dash_id3 identity-type ANONYMOUS\", the session\n can access all three dashboards.

", "smithy.api#httpQuery": "additional-dashboard-ids" } } - }, - "traits": { - "smithy.api#documentation": "

Parameter input for the GetDashboardEmbedUrl operation.

" } }, "com.amazonaws.quicksight#GetDashboardEmbedUrlResponse": { @@ -8073,7 +8070,7 @@ "UserArn": { "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "

The Amazon QuickSight user's Amazon Resource Name (ARN), for use with QUICKSIGHT identity type.\n\t\t\tYou can use this for any type of Amazon QuickSight users in your account (readers, authors, or\n\t\t\tadmins). They need to be authenticated as one of the following:

\n\t\t
    \n
  1. \n\t\t\t\t

    Active Directory (AD) users or group members

    \n\t\t\t
    2. \n
  2. \n\t\t\t\t

    Invited nonfederated users

    \n\t\t\t
    3. \n
  3. \n\t\t\t\t

    IAM users and IAM role-based sessions authenticated through Federated Single Sign-On using\n SAML, OpenID Connect, or IAM federation

    \n\t\t\t
    4. \n
\n

Omit this parameter for users in the third group – IAM users and IAM\n role-based sessions.

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

The Amazon QuickSight user's Amazon Resource Name (ARN), for use with QUICKSIGHT identity type.\n\t\t\tYou can use this for any type of Amazon QuickSight users in your account (readers, authors, or\n\t\t\tadmins). They need to be authenticated as one of the following:

\n\t\t
    \n
  1. \n\t\t\t\t

    Active Directory (AD) users or group members

    \n\t\t\t
    2. \n
  2. \n\t\t\t\t

    Invited nonfederated users

    \n\t\t\t
    3. \n
  3. \n\t\t\t\t

    AWS Identity and Access Management (IAM) users and IAM role-based sessions authenticated\n through Federated Single Sign-On using SAML, OpenID Connect, or IAM\n federation

    \n\t\t\t
    4. \n
\n

Omit this parameter for users in the third group, IAM users and IAM role-based\n sessions.

", "smithy.api#httpQuery": "user-arn" } } @@ -8946,7 +8943,7 @@ "target": "com.amazonaws.quicksight#Boolean", "traits": { "smithy.api#box": {}, - "smithy.api#documentation": "

Indicates that a row in a table is uniquely identified by the columns in a \n join key. This is used by QuickSight to optimize query performance.

" + "smithy.api#documentation": "

A value that indicates that a row in a table is uniquely identified by the columns in\n a join key. This is used by QuickSight to optimize query performance.

" } } }, @@ -12230,7 +12227,7 @@ "SessionName": { "target": "com.amazonaws.quicksight#RoleSessionName", "traits": { - "smithy.api#documentation": "

You need to use this parameter only when you register one or more users using an assumed\n\t\t\tIAM role. You don't need to provide the session name for other scenarios, for example when\n\t\t\tyou are registering an IAM user or an Amazon QuickSight user. You can register multiple\n\t\t\tusers using the same IAM role if each user has a different session name. For more\n\t\t\tinformation on assuming IAM roles, see \n assume-role\n in the AWS CLI Reference.\n

" + "smithy.api#documentation": "

You need to use this parameter only when you register one or more users using an assumed\n\t\t\tIAM role. You don't need to provide the session name for other scenarios, for example when\n\t\t\tyou are registering an IAM user or an Amazon QuickSight user. You can register multiple\n\t\t\tusers using the same IAM role if each user has a different session name. For more\n\t\t\tinformation on assuming IAM roles, see \n assume-role\n in the AWS CLI Reference.\n

" } }, "AwsAccountId": { @@ -12303,6 +12300,12 @@ "smithy.api#required": {} } }, + "Catalog": { + "target": "com.amazonaws.quicksight#RelationalTableCatalog", + "traits": { + "smithy.api#documentation": "

The catalog associated with a table.

" + } + }, "Schema": { "target": "com.amazonaws.quicksight#RelationalTableSchema", "traits": { @@ -12328,6 +12331,15 @@ "smithy.api#documentation": "

A physical table type for relational data sources.

" } }, + "com.amazonaws.quicksight#RelationalTableCatalog": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, "com.amazonaws.quicksight#RelationalTableName": { "type": "string", "traits": { @@ -14432,7 +14444,7 @@ } }, "traits": { - "smithy.api#documentation": "

This error indicates that you are calling an embedding operation in Amazon QuickSight\n\t\t\twithout the required pricing plan on your AWS account. Before you can use anonymous \n\t\t\tembedding, a QuickSight administrator needs to add capacity pricing to QuickSight. You \n\t\t can do this on the Manage QuickSight page.

\n

After capacity pricing is added, you can enable anonymous embedding by using the \n \n GetDashboardEmbedUrl\n API operation with the \n --identity-type ANONYMOUS option.

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

This error indicates that you are calling an embedding operation in Amazon QuickSight\n\t\t\twithout the required pricing plan on your AWS account. Before you can use embedding \n\t\t\tfor anonymous users, a QuickSight administrator needs to add capacity pricing to QuickSight. You \n\t\t can do this on the Manage QuickSight page.

\n

After capacity pricing is added, you can use the \n GetDashboardEmbedUrl API operation with the \n --identity-type ANONYMOUS option.

", "smithy.api#error": "client", "smithy.api#httpError": 403 } diff --git a/codegen/sdk-codegen/aws-models/ram.2018-01-04.json b/codegen/sdk-codegen/aws-models/ram.2018-01-04.json index 301988caab6..c1869e56b77 100644 --- a/codegen/sdk-codegen/aws-models/ram.2018-01-04.json +++ b/codegen/sdk-codegen/aws-models/ram.2018-01-04.json @@ -2477,19 +2477,24 @@ "traits": { "smithy.api#enum": [ { - "value": "ASSOCIATING" + "value": "ASSOCIATING", + "name": "ASSOCIATING" }, { - "value": "ASSOCIATED" + "value": "ASSOCIATED", + "name": "ASSOCIATED" }, { - "value": "FAILED" + "value": "FAILED", + "name": "FAILED" }, { - "value": "DISASSOCIATING" + "value": "DISASSOCIATING", + "name": "DISASSOCIATING" }, { - "value": "DISASSOCIATED" + "value": "DISASSOCIATED", + "name": "DISASSOCIATED" } ] } @@ -2499,10 +2504,12 @@ "traits": { "smithy.api#enum": [ { - "value": "PRINCIPAL" + "value": "PRINCIPAL", + "name": "PRINCIPAL" }, { - "value": "RESOURCE" + "value": "RESOURCE", + "name": "RESOURCE" } ] } @@ -2512,13 +2519,16 @@ "traits": { "smithy.api#enum": [ { - "value": "CREATED_FROM_POLICY" + "value": "CREATED_FROM_POLICY", + "name": "CREATED_FROM_POLICY" }, { - "value": "PROMOTING_TO_STANDARD" + "value": "PROMOTING_TO_STANDARD", + "name": "PROMOTING_TO_STANDARD" }, { - "value": "STANDARD" + "value": "STANDARD", + "name": "STANDARD" } ] } @@ -2669,16 +2679,20 @@ "traits": { "smithy.api#enum": [ { - "value": "PENDING" + "value": "PENDING", + "name": "PENDING" }, { - "value": "ACCEPTED" + "value": "ACCEPTED", + "name": "ACCEPTED" }, { - "value": "REJECTED" + "value": "REJECTED", + "name": "REJECTED" }, { - "value": "EXPIRED" + "value": "EXPIRED", + "name": "EXPIRED" } ] } @@ -2834,19 +2848,24 @@ "traits": { "smithy.api#enum": [ { - "value": "PENDING" + "value": "PENDING", + "name": "PENDING" }, { - "value": "ACTIVE" + "value": "ACTIVE", + "name": "ACTIVE" }, { - "value": "FAILED" + "value": "FAILED", + "name": "FAILED" }, { - "value": "DELETING" + "value": "DELETING", + "name": "DELETING" }, { - "value": "DELETED" + "value": "DELETED", + "name": "DELETED" } ] } @@ -2856,19 +2875,24 @@ "traits": { "smithy.api#enum": [ { - "value": "AVAILABLE" + "value": "AVAILABLE", + "name": "AVAILABLE" }, { - "value": "ZONAL_RESOURCE_INACCESSIBLE" + "value": "ZONAL_RESOURCE_INACCESSIBLE", + "name": "ZONAL_RESOURCE_INACCESSIBLE" }, { - "value": "LIMIT_EXCEEDED" + "value": "LIMIT_EXCEEDED", + "name": "LIMIT_EXCEEDED" }, { - "value": "UNAVAILABLE" + "value": "UNAVAILABLE", + "name": "UNAVAILABLE" }, { - "value": "PENDING" + "value": "PENDING", + "name": "PENDING" } ] } diff --git a/codegen/sdk-codegen/aws-models/rds.2014-10-31.json b/codegen/sdk-codegen/aws-models/rds.2014-10-31.json index 764ee751686..a4adedaf79d 100644 --- a/codegen/sdk-codegen/aws-models/rds.2014-10-31.json +++ b/codegen/sdk-codegen/aws-models/rds.2014-10-31.json @@ -83,10 +83,12 @@ "traits": { "smithy.api#enum": [ { - "value": "sync" + "value": "sync", + "name": "sync" }, { - "value": "async" + "value": "async", + "name": "async" } ] } @@ -96,16 +98,20 @@ "traits": { "smithy.api#enum": [ { - "value": "stopped" + "value": "stopped", + "name": "stopped" }, { - "value": "starting" + "value": "starting", + "name": "starting" }, { - "value": "started" + "value": "started", + "name": "started" }, { - "value": "stopping" + "value": "stopping", + "name": "stopping" } ] } @@ -730,10 +736,12 @@ "traits": { "smithy.api#enum": [ { - "value": "immediate" + "value": "immediate", + "name": "immediate" }, { - "value": "pending-reboot" + "value": "pending-reboot", + "name": "pending_reboot" } ] } @@ -1245,6 +1253,41 @@ "smithy.api#documentation": "

The configuration setting for the log types to be enabled for export to CloudWatch\n Logs for a specific DB instance or DB cluster.

\n

The EnableLogTypes and DisableLogTypes arrays determine which logs will be exported\n (or not exported) to CloudWatch Logs. The values within these arrays depend on the DB\n engine being used.

\n

For more information about exporting CloudWatch Logs for Amazon RDS DB instances, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

\n

For more information about exporting CloudWatch Logs for Amazon Aurora DB clusters, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

" } }, + "com.amazonaws.rds#ClusterPendingModifiedValues": { + "type": "structure", + "members": { + "PendingCloudwatchLogsExports": { + "target": "com.amazonaws.rds#PendingCloudwatchLogsExports" + }, + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DBClusterIdentifier for the DB cluster.

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

The master credentials for the DB cluster.

" + } + }, + "IAMDatabaseAuthenticationEnabled": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Whether mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled.

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

The database engine version.

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

This data type is used as a response element in the ModifyDBCluster operation and \n contains changes that will be applied during the next maintenance window.

" + } + }, "com.amazonaws.rds#ConnectionPoolConfiguration": { "type": "structure", "members": { @@ -1600,7 +1643,7 @@ "OptionGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of an option group to associate with the copy of the snapshot.

\n \n

Specify this option if you are copying a snapshot from one AWS Region to another,\n and your DB instance uses a nondefault option group. \n If your source DB instance uses Transparent Data Encryption for Oracle or Microsoft SQL Server, \n you must specify this option when copying across AWS Regions. \n For more information, see \n Option Group Considerations in the Amazon RDS User Guide.\n

" + "smithy.api#documentation": "

The name of an option group to associate with the copy of the snapshot.

\n \n

Specify this option if you are copying a snapshot from one AWS Region to another,\n and your DB instance uses a nondefault option group. \n If your source DB instance uses Transparent Data Encryption for Oracle or Microsoft SQL Server, \n you must specify this option when copying across AWS Regions. \n For more information, see \n Option group considerations in the Amazon RDS User Guide.\n

" } }, "TargetCustomAvailabilityZone": { @@ -1705,7 +1748,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a custom Availability Zone (AZ).

\n

A custom AZ is an on-premises AZ that is integrated with a VMware vSphere cluster.

\n

For more information about RDS on VMware, see the \n \n RDS on VMware User Guide.\n \n

" + "smithy.api#documentation": "

Creates a custom Availability Zone (AZ).

\n

A custom AZ is an on-premises AZ that is integrated with a VMware vSphere cluster.

\n

For more information about RDS on VMware, see the \n \n RDS on VMware User Guide.\n

" } }, "com.amazonaws.rds#CreateCustomAvailabilityZoneMessage": { @@ -2314,7 +2357,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, the default \"postgres\" database is created in the DB instance.

\n

Constraints:

\n \n

\n Oracle\n

\n

The Oracle System ID (SID) of the created DB instance.\n If you specify null, the default value ORCL is used.\n You can't specify the string NULL, or any other reserved word, for DBName. \n

\n

Default: ORCL\n

\n

Constraints:

\n \n

\n SQL Server\n

\n

Not applicable. Must be null.

\n

\n Amazon Aurora\n

\n

The name of the database to create when the primary instance of the DB cluster is created.\n If this parameter isn't specified, no database is created in the DB instance.

\n

Constraints:

\n " + "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, no database is created in the DB instance.

\n

Constraints:

\n \n

\n Oracle\n

\n

The Oracle System ID (SID) of the created DB instance.\n If you specify null, the default value ORCL is used.\n You can't specify the string NULL, or any other reserved word, for DBName. \n

\n

Default: ORCL\n

\n

Constraints:

\n \n

\n SQL Server\n

\n

Not applicable. Must be null.

\n

\n Amazon Aurora\n

\n

The name of the database to create when the primary instance of the DB cluster is created.\n If this parameter isn't specified, no database is created in the DB instance.

\n

Constraints:

\n " } }, "DBInstanceIdentifier": { @@ -2371,7 +2414,7 @@ "AvailabilityZone": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n The Availability Zone (AZ) where the database will be created. For information on\n AWS Regions and Availability Zones, see \n Regions\n and Availability Zones.\n

\n

Default: A random, system-chosen Availability Zone in the endpoint's AWS Region.

\n

\n Example: us-east-1d\n

\n

\n Constraint: The AvailabilityZone parameter can't be specified if the DB instance is a Multi-AZ deployment. \n The specified Availability Zone must be in the same AWS Region as the current endpoint.\n

\n \n

If you're creating a DB instance in an RDS on VMware environment,\n specify the identifier of the custom Availability Zone to create the DB instance\n in.

\n

For more information about RDS on VMware, see the \n \n RDS on VMware User Guide.\n \n

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

\n The Availability Zone (AZ) where the database will be created. For information on\n AWS Regions and Availability Zones, see \n Regions\n and Availability Zones.\n

\n

Default: A random, system-chosen Availability Zone in the endpoint's AWS Region.

\n

\n Example: us-east-1d\n

\n

\n Constraint: The AvailabilityZone parameter can't be specified if the DB instance is a Multi-AZ deployment. \n The specified Availability Zone must be in the same AWS Region as the current endpoint.\n

\n \n

If you're creating a DB instance in an RDS on VMware environment,\n specify the identifier of the custom Availability Zone to create the DB instance\n in.

\n

For more information about RDS on VMware, see the \n \n RDS on VMware User Guide.\n

\n " } }, "DBSubnetGroupName": { @@ -2595,6 +2638,12 @@ "traits": { "smithy.api#documentation": "

The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.

" } + }, + "EnableCustomerOwnedIp": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS\n on Outposts DB instance.

\n

A CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the DB instance from outside of its virtual\n private cloud (VPC) on your local network.

\n

For more information about RDS on Outposts, see Working with Amazon RDS on AWS Outposts \n in the Amazon RDS User Guide.

\n

For more information about CoIPs, see Customer-owned IP addresses \n in the AWS Outposts User Guide.

" + } } }, "traits": { @@ -2785,7 +2834,7 @@ "KmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The AWS KMS key identifier for an encrypted read replica.

\n

The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS CMK.

\n

If you create an encrypted read replica in the same AWS Region as the source DB\n instance, then you do not have to specify a value for this parameter. The read replica\n is encrypted with the same AWS KMS CMK as the source DB instance.

\n

If you create an encrypted read replica in a different AWS Region, then you must\n specify a AWS KMS key identifier for the destination AWS Region. AWS KMS CMKs are specific to\n the AWS Region that they are created in, and you can't use CMKs from one\n AWS Region in another AWS Region.

\n

You can't create an encrypted read replica from an unencrypted DB instance.

" + "smithy.api#documentation": "

The AWS KMS key identifier for an encrypted read replica.

\n

The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS CMK.

\n

If you create an encrypted read replica in the same AWS Region as the source DB\n instance, then do not specify a value for this parameter. A read replica in the same Region\n is always encrypted with the same AWS KMS CMK as the source DB instance.

\n

If you create an encrypted read replica in a different AWS Region, then you must\n specify a AWS KMS key identifier for the destination AWS Region. AWS KMS CMKs are specific to\n the AWS Region that they are created in, and you can't use CMKs from one\n AWS Region in another AWS Region.

\n

You can't create an encrypted read replica from an unencrypted DB instance.

" } }, "PreSignedUrl": { @@ -3513,7 +3562,7 @@ } }, "traits": { - "smithy.api#documentation": "

A custom Availability Zone (AZ) is an on-premises AZ that is integrated with a VMware vSphere cluster.

\n

For more information about RDS on VMware, see the \n \n RDS on VMware User Guide.\n \n

" + "smithy.api#documentation": "

A custom Availability Zone (AZ) is an on-premises AZ that is integrated with a VMware vSphere cluster.

\n

For more information about RDS on VMware, see the \n \n RDS on VMware User Guide.\n

" } }, "com.amazonaws.rds#CustomAvailabilityZoneAlreadyExistsFault": { @@ -3907,6 +3956,12 @@ "traits": { "smithy.api#documentation": "

Specifies whether you have requested to enable write forwarding for a secondary cluster\n in an Aurora global database. Because write forwarding takes time to enable, check the\n value of GlobalWriteForwardingStatus to confirm that the request has completed\n before using the write forwarding feature for this cluster.

" } + }, + "PendingModifiedValues": { + "target": "com.amazonaws.rds#ClusterPendingModifiedValues", + "traits": { + "smithy.api#documentation": "

Specifies that changes to the DB cluster are pending. This element is only included when changes are pending. \n Specific changes are identified by subelements.

" + } } }, "traits": { @@ -5238,6 +5293,12 @@ "traits": { "smithy.api#documentation": "

The list of replicated automated backups associated with the DB instance.

" } + }, + "CustomerOwnedIpEnabled": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance.

\n

A CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the DB instance from outside of its virtual\n private cloud (VPC) on your local network.

\n

For more information about RDS on Outposts, see Working with Amazon RDS on AWS Outposts \n in the Amazon RDS User Guide.

\n

For more information about CoIPs, see Customer-owned IP addresses \n in the AWS Outposts User Guide.

" + } } }, "traits": { @@ -6790,7 +6851,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a custom Availability Zone (AZ).

\n

A custom AZ is an on-premises AZ that is integrated with a VMware vSphere cluster.

\n

For more information about RDS on VMware, see the \n \n RDS on VMware User Guide.\n \n

" + "smithy.api#documentation": "

Deletes a custom Availability Zone (AZ).

\n

A custom AZ is an on-premises AZ that is integrated with a VMware vSphere cluster.

\n

For more information about RDS on VMware, see the \n \n RDS on VMware User Guide.\n

" } }, "com.amazonaws.rds#DeleteCustomAvailabilityZoneMessage": { @@ -7585,7 +7646,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns information about custom Availability Zones (AZs).

\n

A custom AZ is an on-premises AZ that is integrated with a VMware vSphere cluster.

\n

For more information about RDS on VMware, see the \n \n RDS on VMware User Guide.\n \n

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

Returns information about custom Availability Zones (AZs).

\n

A custom AZ is an on-premises AZ that is integrated with a VMware vSphere cluster.

\n

For more information about RDS on VMware, see the \n \n RDS on VMware User Guide.\n

", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -8295,7 +8356,7 @@ "Filters": { "target": "com.amazonaws.rds#FilterList", "traits": { - "smithy.api#documentation": "

A filter that specifies which resources to return based on status.

\n\t\t

Supported filters are the following:

\n\t\t \n\t\t

Returns all resources by default. The status for each resource is specified in the response.

" + "smithy.api#documentation": "

A filter that specifies which resources to return based on status.

\n\t\t

Supported filters are the following:

\n\t\t \n\t\t

Returns all resources by default. The status for each resource is specified in the response.

" } }, "MaxRecords": { @@ -10116,7 +10177,7 @@ "target": "com.amazonaws.rds#SourceRegionMessage" }, "traits": { - "smithy.api#documentation": "

Returns a list of the source AWS Regions where the current AWS Region can create a\n read replica or copy a DB snapshot from. This API action supports pagination.

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

Returns a list of the source AWS Regions where the current AWS Region can create a read replica, \n copy a DB snapshot from, or replicate automated backups from. This API action supports pagination.

", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -11056,7 +11117,7 @@ } }, "traits": { - "smithy.api#documentation": "

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

The GlobalClusterIdentifier already exists. Choose a new global database identifier (unique name) to create a new global database cluster.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -11119,7 +11180,7 @@ } }, "traits": { - "smithy.api#documentation": "

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

The GlobalClusterIdentifier doesn't refer to an existing global database cluster.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } @@ -11132,7 +11193,7 @@ } }, "traits": { - "smithy.api#documentation": "

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

The number of global database clusters for this account is already at the maximum allowed.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -11709,7 +11770,7 @@ } }, "traits": { - "smithy.api#documentation": "

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

The global cluster is in an invalid state and can't perform the requested operation.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -12470,7 +12531,7 @@ "DBSubnetGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The new DB subnet group for the DB instance.\n You can use this parameter to move your DB instance to a different VPC.\n \n If your DB instance isn't in a VPC, you can also use this parameter to move your DB instance into a VPC.\n For more information, see \n Updating the VPC for a DB Instance \n in the Amazon RDS User Guide. \n

\n

Changing the subnet group causes an outage during the change. \n The change is applied during the next maintenance window,\n unless you enable ApplyImmediately.\n

\n

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

\n

Example: mySubnetGroup\n

" + "smithy.api#documentation": "

The new DB subnet group for the DB instance.\n You can use this parameter to move your DB instance to a different VPC.\n \n If your DB instance isn't in a VPC, you can also use this parameter to move your DB instance into a VPC.\n For more information, see \n Working with a DB instance in a VPC \n in the Amazon RDS User Guide. \n

\n

Changing the subnet group causes an outage during the change. \n The change is applied during the next maintenance window,\n unless you enable ApplyImmediately.\n

\n

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

\n

Example: mySubnetGroup\n

" } }, "DBSecurityGroups": { @@ -12706,6 +12767,12 @@ "traits": { "smithy.api#documentation": "

A value that sets the open mode of a replica database to either mounted or read-only.

\n \n

Currently, this parameter is only supported for Oracle DB instances.

\n \n

Mounted DB replicas are included in Oracle Enterprise Edition. The main use case for \n mounted replicas is cross-Region disaster recovery. The primary database doesn't use \n Active Data Guard to transmit information to the mounted replica. Because it doesn't \n accept user connections, a mounted replica can't serve a read-only workload. \n For more information, see Working with Oracle Read Replicas for Amazon RDS \n in the Amazon RDS User Guide.

" } + }, + "EnableCustomerOwnedIp": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.

\n

A CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the DB instance from outside of its virtual\n private cloud (VPC) on your local network.

\n

For more information about RDS on Outposts, see Working with Amazon RDS on AWS Outposts \n in the Amazon RDS User Guide.

\n

For more information about CoIPs, see Customer-owned IP addresses \n in the AWS Outposts User Guide.

" + } } }, "traits": { @@ -13016,7 +13083,7 @@ "OptionGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The option group to identify with the upgraded DB snapshot.\n

\n \n

You can specify this parameter when you upgrade an Oracle DB snapshot.\n The same option group considerations apply when upgrading a DB snapshot as when upgrading a DB instance.\n For more information, see \n Option Group Considerations in the Amazon RDS User Guide.\n

" + "smithy.api#documentation": "

The option group to identify with the upgraded DB snapshot.\n

\n \n

You can specify this parameter when you upgrade an Oracle DB snapshot.\n The same option group considerations apply when upgrading a DB snapshot as when upgrading a DB instance.\n For more information, see \n Option group considerations in the Amazon RDS User Guide.\n

" } } } @@ -14298,43 +14365,43 @@ "DBInstanceClass": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n Contains the new DBInstanceClass for the DB instance\n that will be applied or is currently being applied.\n

" + "smithy.api#documentation": "

The name of the compute and memory capacity class for the DB instance.

" } }, "AllocatedStorage": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

\n Contains the new AllocatedStorage size for the DB instance\n that will be applied or is currently being applied.\n

" + "smithy.api#documentation": "

The allocated storage size for the DB instance specified in gibibytes .

" } }, "MasterUserPassword": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Contains the pending or currently-in-progress change of the master credentials for the DB instance.

" + "smithy.api#documentation": "

The master credentials for the DB instance.

" } }, "Port": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

Specifies the pending port for the DB instance.

" + "smithy.api#documentation": "

The port for the DB instance.

" } }, "BackupRetentionPeriod": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

Specifies the pending number of days for which automated backups are retained.

" + "smithy.api#documentation": "

The number of days for which automated backups are retained.

" } }, "MultiAZ": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

Indicates that the Single-AZ DB instance is to change to a Multi-AZ deployment.

" + "smithy.api#documentation": "

Indicates that the Single-AZ DB instance will change to a Multi-AZ deployment.

" } }, "EngineVersion": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Indicates the database engine version.

" + "smithy.api#documentation": "

The database engine version.

" } }, "LicenseModel": { @@ -14346,31 +14413,31 @@ "Iops": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

Specifies the new Provisioned IOPS value for the DB instance that will be applied or is currently being applied.

" + "smithy.api#documentation": "

The Provisioned IOPS value for the DB instance.

" } }, "DBInstanceIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n Contains the new DBInstanceIdentifier for the DB instance\n that will be applied or is currently being applied.\n

" + "smithy.api#documentation": "

The database identifier for the DB instance.

" } }, "StorageType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Specifies the storage type to be associated with the DB instance.

" + "smithy.api#documentation": "

The storage type of the DB instance.

" } }, "CACertificateIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Specifies the identifier of the CA certificate for the DB instance.

" + "smithy.api#documentation": "

The identifier of the CA certificate for the DB instance.

" } }, "DBSubnetGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The new DB subnet group for the DB instance.\n

" + "smithy.api#documentation": "

The DB subnet group for the DB instance.

" } }, "PendingCloudwatchLogsExports": { @@ -14381,10 +14448,16 @@ "traits": { "smithy.api#documentation": "

The number of CPU cores and the number of threads per core for the DB instance class\n of the DB instance.

" } + }, + "IAMDatabaseAuthenticationEnabled": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Whether mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled.

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

\n This data type is used as a response element in the ModifyDBInstance action.\n

" + "smithy.api#documentation": "

\n This data type is used as a response element in the ModifyDBInstance action and \n contains changes that will be applied during the next maintenance window.\n

" } }, "com.amazonaws.rds#PointInTimeRestoreNotEnabledFault": { @@ -16406,6 +16479,12 @@ "traits": { "smithy.api#documentation": "

A value that indicates whether the DB instance has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection is disabled. For more information, see \n \n Deleting a DB Instance.\n

" } + }, + "EnableCustomerOwnedIp": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.

\n

A CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the DB instance from outside of its virtual\n private cloud (VPC) on your local network.

\n

For more information about RDS on Outposts, see Working with Amazon RDS on AWS Outposts \n in the Amazon RDS User Guide.

\n

For more information about CoIPs, see Customer-owned IP addresses \n in the AWS Outposts User Guide.

" + } } }, "traits": { @@ -17047,6 +17126,12 @@ "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example, \n arn:aws:rds:useast-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.

" } + }, + "EnableCustomerOwnedIp": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.

\n

A CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the DB instance from outside of its virtual\n private cloud (VPC) on your local network.

\n

For more information about RDS on Outposts, see Working with Amazon RDS on AWS Outposts \n in the Amazon RDS User Guide.

\n

For more information about CoIPs, see Customer-owned IP addresses \n in the AWS Outposts User Guide.

" + } } }, "traits": { @@ -17380,22 +17465,28 @@ "traits": { "smithy.api#enum": [ { - "value": "db-instance" + "value": "db-instance", + "name": "db_instance" }, { - "value": "db-parameter-group" + "value": "db-parameter-group", + "name": "db_parameter_group" }, { - "value": "db-security-group" + "value": "db-security-group", + "name": "db_security_group" }, { - "value": "db-snapshot" + "value": "db-snapshot", + "name": "db_snapshot" }, { - "value": "db-cluster" + "value": "db-cluster", + "name": "db_cluster" }, { - "value": "db-cluster-snapshot" + "value": "db-cluster-snapshot", + "name": "db_cluster_snapshot" } ] } @@ -18578,7 +18669,7 @@ } }, "traits": { - "smithy.api#documentation": "

Information about the virtual private network (VPN) between the VMware vSphere cluster and the AWS website.

\n

For more information about RDS on VMware, see the \n \n RDS on VMware User Guide.\n \n

" + "smithy.api#documentation": "

Information about the virtual private network (VPN) between the VMware vSphere cluster and the AWS website.

\n

For more information about RDS on VMware, see the \n \n RDS on VMware User Guide.\n

" } }, "com.amazonaws.rds#WriteForwardingStatus": { diff --git a/codegen/sdk-codegen/aws-models/redshift.2012-12-01.json b/codegen/sdk-codegen/aws-models/redshift.2012-12-01.json index d391d283f7f..c45a7851e3e 100644 --- a/codegen/sdk-codegen/aws-models/redshift.2012-12-01.json +++ b/codegen/sdk-codegen/aws-models/redshift.2012-12-01.json @@ -8255,10 +8255,12 @@ "traits": { "smithy.api#enum": [ { - "value": "static" + "value": "static", + "name": "static" }, { - "value": "dynamic" + "value": "dynamic", + "name": "dynamic" } ] } @@ -9054,10 +9056,12 @@ "traits": { "smithy.api#enum": [ { - "value": "Regular" + "value": "Regular", + "name": "Regular" }, { - "value": "Upgradable" + "value": "Upgradable", + "name": "Upgradable" } ] } @@ -10142,13 +10146,16 @@ "traits": { "smithy.api#enum": [ { - "value": "MODIFYING" + "value": "MODIFYING", + "name": "MODIFYING" }, { - "value": "ACTIVE" + "value": "ACTIVE", + "name": "ACTIVE" }, { - "value": "FAILED" + "value": "FAILED", + "name": "FAILED" } ] } @@ -11040,19 +11047,24 @@ "traits": { "smithy.api#enum": [ { - "value": "cluster" + "value": "cluster", + "name": "cluster" }, { - "value": "cluster-parameter-group" + "value": "cluster-parameter-group", + "name": "cluster_parameter_group" }, { - "value": "cluster-security-group" + "value": "cluster-security-group", + "name": "cluster_security_group" }, { - "value": "cluster-snapshot" + "value": "cluster-snapshot", + "name": "cluster_snapshot" }, { - "value": "scheduled-action" + "value": "scheduled-action", + "name": "scheduled_action" } ] } @@ -11412,19 +11424,24 @@ "traits": { "smithy.api#enum": [ { - "value": "PENDING" + "value": "PENDING", + "name": "PENDING" }, { - "value": "IN_PROGRESS" + "value": "IN_PROGRESS", + "name": "IN_PROGRESS" }, { - "value": "SUCCEEDED" + "value": "SUCCEEDED", + "name": "SUCCEEDED" }, { - "value": "FAILED" + "value": "FAILED", + "name": "FAILED" }, { - "value": "CANCELED" + "value": "CANCELED", + "name": "CANCELED" } ] } diff --git a/codegen/sdk-codegen/aws-models/rekognition.2016-06-27.json b/codegen/sdk-codegen/aws-models/rekognition.2016-06-27.json index 7909a1c3172..d72f90635cb 100644 --- a/codegen/sdk-codegen/aws-models/rekognition.2016-06-27.json +++ b/codegen/sdk-codegen/aws-models/rekognition.2016-06-27.json @@ -2272,31 +2272,40 @@ "traits": { "smithy.api#enum": [ { - "value": "HAPPY" + "value": "HAPPY", + "name": "HAPPY" }, { - "value": "SAD" + "value": "SAD", + "name": "SAD" }, { - "value": "ANGRY" + "value": "ANGRY", + "name": "ANGRY" }, { - "value": "CONFUSED" + "value": "CONFUSED", + "name": "CONFUSED" }, { - "value": "DISGUSTED" + "value": "DISGUSTED", + "name": "DISGUSTED" }, { - "value": "SURPRISED" + "value": "SURPRISED", + "name": "SURPRISED" }, { - "value": "CALM" + "value": "CALM", + "name": "CALM" }, { - "value": "UNKNOWN" + "value": "UNKNOWN", + "name": "UNKNOWN" }, { - "value": "FEAR" + "value": "FEAR", + "name": "FEAR" } ] } diff --git a/codegen/sdk-codegen/aws-models/route53.2013-04-01.json b/codegen/sdk-codegen/aws-models/route53.2013-04-01.json index e44f91d87a7..442adf20ebc 100644 --- a/codegen/sdk-codegen/aws-models/route53.2013-04-01.json +++ b/codegen/sdk-codegen/aws-models/route53.2013-04-01.json @@ -36,6 +36,9 @@ "type": "service", "version": "2013-04-01", "operations": [ + { + "target": "com.amazonaws.route53#ActivateKeySigningKey" + }, { "target": "com.amazonaws.route53#AssociateVPCWithHostedZone" }, @@ -51,6 +54,9 @@ { "target": "com.amazonaws.route53#CreateHostedZone" }, + { + "target": "com.amazonaws.route53#CreateKeySigningKey" + }, { "target": "com.amazonaws.route53#CreateQueryLoggingConfig" }, @@ -69,12 +75,18 @@ { "target": "com.amazonaws.route53#CreateVPCAssociationAuthorization" }, + { + "target": "com.amazonaws.route53#DeactivateKeySigningKey" + }, { "target": "com.amazonaws.route53#DeleteHealthCheck" }, { "target": "com.amazonaws.route53#DeleteHostedZone" }, + { + "target": "com.amazonaws.route53#DeleteKeySigningKey" + }, { "target": "com.amazonaws.route53#DeleteQueryLoggingConfig" }, @@ -90,9 +102,15 @@ { "target": "com.amazonaws.route53#DeleteVPCAssociationAuthorization" }, + { + "target": "com.amazonaws.route53#DisableHostedZoneDNSSEC" + }, { "target": "com.amazonaws.route53#DisassociateVPCFromHostedZone" }, + { + "target": "com.amazonaws.route53#EnableHostedZoneDNSSEC" + }, { "target": "com.amazonaws.route53#GetAccountLimit" }, @@ -102,6 +120,9 @@ { "target": "com.amazonaws.route53#GetCheckerIpRanges" }, + { + "target": "com.amazonaws.route53#GetDNSSEC" + }, { "target": "com.amazonaws.route53#GetGeoLocation" }, @@ -254,23 +275,94 @@ "traits": { "smithy.api#enum": [ { - "value": "MAX_HEALTH_CHECKS_BY_OWNER" + "value": "MAX_HEALTH_CHECKS_BY_OWNER", + "name": "MAX_HEALTH_CHECKS_BY_OWNER" }, { - "value": "MAX_HOSTED_ZONES_BY_OWNER" + "value": "MAX_HOSTED_ZONES_BY_OWNER", + "name": "MAX_HOSTED_ZONES_BY_OWNER" }, { - "value": "MAX_TRAFFIC_POLICY_INSTANCES_BY_OWNER" + "value": "MAX_TRAFFIC_POLICY_INSTANCES_BY_OWNER", + "name": "MAX_TRAFFIC_POLICY_INSTANCES_BY_OWNER" }, { - "value": "MAX_REUSABLE_DELEGATION_SETS_BY_OWNER" + "value": "MAX_REUSABLE_DELEGATION_SETS_BY_OWNER", + "name": "MAX_REUSABLE_DELEGATION_SETS_BY_OWNER" }, { - "value": "MAX_TRAFFIC_POLICIES_BY_OWNER" + "value": "MAX_TRAFFIC_POLICIES_BY_OWNER", + "name": "MAX_TRAFFIC_POLICIES_BY_OWNER" } ] } }, + "com.amazonaws.route53#ActivateKeySigningKey": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#ActivateKeySigningKeyRequest" + }, + "output": { + "target": "com.amazonaws.route53#ActivateKeySigningKeyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#ConcurrentModification" + }, + { + "target": "com.amazonaws.route53#InvalidKeySigningKeyStatus" + }, + { + "target": "com.amazonaws.route53#InvalidKMSArn" + }, + { + "target": "com.amazonaws.route53#InvalidSigningStatus" + }, + { + "target": "com.amazonaws.route53#NoSuchKeySigningKey" + } + ], + "traits": { + "smithy.api#documentation": "

Activates a key signing key (KSK) so that it can be used for signing by DNSSEC. This operation changes the \n\t\t\tKSK status to ACTIVE.

", + "smithy.api#http": { + "method": "POST", + "uri": "/2013-04-01/keysigningkey/{HostedZoneId}/{Name}/activate", + "code": 200 + } + } + }, + "com.amazonaws.route53#ActivateKeySigningKeyRequest": { + "type": "structure", + "members": { + "HostedZoneId": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

A unique string used to identify a hosted zone.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.route53#SigningKeyName", + "traits": { + "smithy.api#documentation": "

An alphanumeric string used to identify a key signing key (KSK).

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.route53#ActivateKeySigningKeyResponse": { + "type": "structure", + "members": { + "ChangeInfo": { + "target": "com.amazonaws.route53#ChangeInfo", + "traits": { + "smithy.api#required": {} + } + } + } + }, "com.amazonaws.route53#AlarmIdentifier": { "type": "structure", "members": { @@ -451,13 +543,16 @@ "traits": { "smithy.api#enum": [ { - "value": "CREATE" + "value": "CREATE", + "name": "CREATE" }, { - "value": "DELETE" + "value": "DELETE", + "name": "DELETE" }, { - "value": "UPSERT" + "value": "UPSERT", + "name": "UPSERT" } ] } @@ -595,10 +690,12 @@ "traits": { "smithy.api#enum": [ { - "value": "PENDING" + "value": "PENDING", + "name": "PENDING" }, { - "value": "INSYNC" + "value": "INSYNC", + "name": "INSYNC" } ] } @@ -786,85 +883,112 @@ "traits": { "smithy.api#enum": [ { - "value": "us-east-1" + "value": "us-east-1", + "name": "us_east_1" }, { - "value": "us-east-2" + "value": "us-east-2", + "name": "us_east_2" }, { - "value": "us-west-1" + "value": "us-west-1", + "name": "us_west_1" }, { - "value": "us-west-2" + "value": "us-west-2", + "name": "us_west_2" }, { - "value": "ca-central-1" + "value": "ca-central-1", + "name": "ca_central_1" }, { - "value": "eu-central-1" + "value": "eu-central-1", + "name": "eu_central_1" }, { - "value": "eu-west-1" + "value": "eu-west-1", + "name": "eu_west_1" }, { - "value": "eu-west-2" + "value": "eu-west-2", + "name": "eu_west_2" }, { - "value": "eu-west-3" + "value": "eu-west-3", + "name": "eu_west_3" }, { - "value": "ap-east-1" + "value": "ap-east-1", + "name": "ap_east_1" }, { - "value": "me-south-1" + "value": "me-south-1", + "name": "me_south_1" }, { - "value": "ap-south-1" + "value": "ap-south-1", + "name": "ap_south_1" }, { - "value": "ap-southeast-1" + "value": "ap-southeast-1", + "name": "ap_southeast_1" }, { - "value": "ap-southeast-2" + "value": "ap-southeast-2", + "name": "ap_southeast_2" }, { - "value": "ap-northeast-1" + "value": "ap-northeast-1", + "name": "ap_northeast_1" }, { - "value": "ap-northeast-2" + "value": "ap-northeast-2", + "name": "ap_northeast_2" }, { - "value": "ap-northeast-3" + "value": "ap-northeast-3", + "name": "ap_northeast_3" }, { - "value": "eu-north-1" + "value": "eu-north-1", + "name": "eu_north_1" }, { - "value": "sa-east-1" + "value": "sa-east-1", + "name": "sa_east_1" }, { - "value": "cn-northwest-1" + "value": "cn-northwest-1", + "name": "cn_northwest_1" }, { - "value": "cn-north-1" + "value": "cn-north-1", + "name": "cn_north_1" }, { - "value": "af-south-1" + "value": "af-south-1", + "name": "af_south_1" }, { - "value": "eu-south-1" + "value": "eu-south-1", + "name": "eu_south_1" }, { - "value": "us-gov-west-1" + "value": "us-gov-west-1", + "name": "us_gov_west_1" }, { - "value": "us-gov-east-1" + "value": "us-gov-east-1", + "name": "us_gov_east_1" }, { - "value": "us-iso-east-1" + "value": "us-iso-east-1", + "name": "us_iso_east_1" }, { - "value": "us-isob-east-1" + "value": "us-isob-east-1", + "name": "us_isob_east_1" } ], "smithy.api#length": { @@ -878,16 +1002,20 @@ "traits": { "smithy.api#enum": [ { - "value": "GreaterThanOrEqualToThreshold" + "value": "GreaterThanOrEqualToThreshold", + "name": "GreaterThanOrEqualToThreshold" }, { - "value": "GreaterThanThreshold" + "value": "GreaterThanThreshold", + "name": "GreaterThanThreshold" }, { - "value": "LessThanThreshold" + "value": "LessThanThreshold", + "name": "LessThanThreshold" }, { - "value": "LessThanOrEqualToThreshold" + "value": "LessThanOrEqualToThreshold", + "name": "LessThanOrEqualToThreshold" } ] } @@ -898,7 +1026,7 @@ "message": { "target": "com.amazonaws.route53#ErrorMessage", "traits": { - "smithy.api#documentation": "

Descriptive message for the error response.

" + "smithy.api#documentation": "

" } } }, @@ -926,7 +1054,7 @@ "message": { "target": "com.amazonaws.route53#ErrorMessage", "traits": { - "smithy.api#documentation": "

Descriptive message for the error response.

" + "smithy.api#documentation": "

" } } }, @@ -1138,6 +1266,121 @@ "smithy.api#documentation": "

A complex type containing the response information for the hosted zone.

" } }, + "com.amazonaws.route53#CreateKeySigningKey": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#CreateKeySigningKeyRequest" + }, + "output": { + "target": "com.amazonaws.route53#CreateKeySigningKeyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#ConcurrentModification" + }, + { + "target": "com.amazonaws.route53#InvalidArgument" + }, + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#InvalidKeySigningKeyName" + }, + { + "target": "com.amazonaws.route53#InvalidKeySigningKeyStatus" + }, + { + "target": "com.amazonaws.route53#InvalidKMSArn" + }, + { + "target": "com.amazonaws.route53#InvalidSigningStatus" + }, + { + "target": "com.amazonaws.route53#KeySigningKeyAlreadyExists" + }, + { + "target": "com.amazonaws.route53#NoSuchHostedZone" + }, + { + "target": "com.amazonaws.route53#TooManyKeySigningKeys" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new key signing key (KSK) associated with a hosted zone. You can only have two KSKs per hosted zone.

", + "smithy.api#http": { + "method": "POST", + "uri": "/2013-04-01/keysigningkey", + "code": 201 + } + } + }, + "com.amazonaws.route53#CreateKeySigningKeyRequest": { + "type": "structure", + "members": { + "CallerReference": { + "target": "com.amazonaws.route53#Nonce", + "traits": { + "smithy.api#documentation": "

A unique string that identifies the request.

", + "smithy.api#required": {} + } + }, + "HostedZoneId": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

The unique string (ID) used to identify a hosted zone.

", + "smithy.api#required": {} + } + }, + "KeyManagementServiceArn": { + "target": "com.amazonaws.route53#SigningKeyString", + "traits": { + "smithy.api#documentation": "

The Amazon resource name (ARN) for a customer managed key (CMK) in AWS Key Management Service (KMS).\n\t\t\tThe KeyManagementServiceArn must be unique for each key signing key (KSK) in a single hosted zone. \n\t\t\tTo see an example of KeyManagementServiceArn that grants the correct permissions for DNSSEC, \n\t\t\tscroll down to Example.

\n\t\t

You must configure the CMK as follows:

\n\t\t
\n
Status
\n
\n

Enabled

\n
\n
Key spec
\n
\n

ECC_NIST_P256

\n
\n
Key usage
\n
\n

Sign and verify

\n
\n
Key policy
\n
\n

The key policy must give permission for the following actions:

\n\t\t\t\t\t
    \n
  • \n

    DescribeKey

    \n
    • \n
  • \n

    GetPublicKey

    \n
    • \n
  • \n

    Sign

    \n
    • \n
\n\t\t\t\t\t

The key policy must also include the Amazon Route 53 service in the principal for your account. \n\t\t\t\t\t\tSpecify the following:

\n\t\t\t\t\t
    \n
  • \n

    \n \"Service\": \"api-service.dnssec.route53.aws.internal\"\n

    \n
    • \n
\n\t\t\t\t
\n
\n\t\t

For more information about working with CMK in KMS, see \n\t\t\tAWS Key Management Service concepts.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.route53#SigningKeyName", + "traits": { + "smithy.api#documentation": "

An alphanumeric string used to identify a key signing key (KSK). Name must be unique for each key signing key in the same \n\t\t\thosted zone.

", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.route53#SigningKeyStatus", + "traits": { + "smithy.api#documentation": "

A string specifying the initial status of the key signing key (KSK). You can set the value to ACTIVE or INACTIVE.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.route53#CreateKeySigningKeyResponse": { + "type": "structure", + "members": { + "ChangeInfo": { + "target": "com.amazonaws.route53#ChangeInfo", + "traits": { + "smithy.api#required": {} + } + }, + "KeySigningKey": { + "target": "com.amazonaws.route53#KeySigningKey", + "traits": { + "smithy.api#documentation": "

The key signing key (KSK) that the request creates.

", + "smithy.api#required": {} + } + }, + "Location": { + "target": "com.amazonaws.route53#ResourceURI", + "traits": { + "smithy.api#documentation": "

The unique URL representing the new key signing key (KSK).

", + "smithy.api#httpHeader": "Location", + "smithy.api#required": {} + } + } + } + }, "com.amazonaws.route53#CreateQueryLoggingConfig": { "type": "operation", "input": { @@ -1651,6 +1894,108 @@ "com.amazonaws.route53#DNSRCode": { "type": "string" }, + "com.amazonaws.route53#DNSSECNotFound": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The hosted zone doesn't have any DNSSEC resources.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.route53#DNSSECStatus": { + "type": "structure", + "members": { + "ServeSignature": { + "target": "com.amazonaws.route53#ServeSignature", + "traits": { + "smithy.api#documentation": "

Indicates your hosted zone signging status: SIGNING, NOT_SIGNING, or INTERNAL_FAILURE.\n\t\t\tIf the status is INTERNAL_FAILURE, see StatusMessage for information about steps that you can take to\n\t\t\tcorrect the problem.

\n\t\t

A status INTERNAL_FAILURE means there was an error during a request. Before you can continue to work with DNSSEC\n\t\t\tsigning, including working with key signing keys (KSKs), you must correct the problem by enabling or disabling DNSSEC \n\t\t\tsigning for the hosted zone.

" + } + }, + "StatusMessage": { + "target": "com.amazonaws.route53#SigningKeyStatusMessage", + "traits": { + "smithy.api#documentation": "

The status message provided for the following DNSSEC signing status: INTERNAL_FAILURE. The status message \n\t\t\tincludes information about what the problem might be and steps that you can take to correct the issue.

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

A string repesenting the status of DNSSEC signing.

" + } + }, + "com.amazonaws.route53#DeactivateKeySigningKey": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#DeactivateKeySigningKeyRequest" + }, + "output": { + "target": "com.amazonaws.route53#DeactivateKeySigningKeyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#ConcurrentModification" + }, + { + "target": "com.amazonaws.route53#InvalidKeySigningKeyStatus" + }, + { + "target": "com.amazonaws.route53#InvalidSigningStatus" + }, + { + "target": "com.amazonaws.route53#KeySigningKeyInParentDSRecord" + }, + { + "target": "com.amazonaws.route53#KeySigningKeyInUse" + }, + { + "target": "com.amazonaws.route53#NoSuchKeySigningKey" + } + ], + "traits": { + "smithy.api#documentation": "

Deactivates a key signing key (KSK) so that it will not be used for signing by DNSSEC. This operation changes the \n\t\t\tKSK status to INACTIVE.

", + "smithy.api#http": { + "method": "POST", + "uri": "/2013-04-01/keysigningkey/{HostedZoneId}/{Name}/deactivate", + "code": 200 + } + } + }, + "com.amazonaws.route53#DeactivateKeySigningKeyRequest": { + "type": "structure", + "members": { + "HostedZoneId": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

A unique string used to identify a hosted zone.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.route53#SigningKeyName", + "traits": { + "smithy.api#documentation": "

An alphanumeric string used to identify a key signing key (KSK).

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.route53#DeactivateKeySigningKeyResponse": { + "type": "structure", + "members": { + "ChangeInfo": { + "target": "com.amazonaws.route53#ChangeInfo", + "traits": { + "smithy.api#required": {} + } + } + } + }, "com.amazonaws.route53#DelegationSet": { "type": "structure", "members": { @@ -1684,7 +2029,7 @@ "message": { "target": "com.amazonaws.route53#ErrorMessage", "traits": { - "smithy.api#documentation": "

Descriptive message for the error response.

" + "smithy.api#documentation": "

" } } }, @@ -1699,7 +2044,7 @@ "message": { "target": "com.amazonaws.route53#ErrorMessage", "traits": { - "smithy.api#documentation": "

Descriptive message for the error response.

" + "smithy.api#documentation": "

" } } }, @@ -1714,7 +2059,7 @@ "message": { "target": "com.amazonaws.route53#ErrorMessage", "traits": { - "smithy.api#documentation": "

Descriptive message for the error response.

" + "smithy.api#documentation": "

" } } }, @@ -1743,7 +2088,7 @@ "message": { "target": "com.amazonaws.route53#ErrorMessage", "traits": { - "smithy.api#documentation": "

Descriptive message for the error response.

" + "smithy.api#documentation": "

" } } }, @@ -1758,7 +2103,7 @@ "message": { "target": "com.amazonaws.route53#ErrorMessage", "traits": { - "smithy.api#documentation": "

Descriptive message for the error response.

" + "smithy.api#documentation": "

" } } }, @@ -1892,6 +2237,72 @@ "smithy.api#documentation": "

A complex type that contains the response to a DeleteHostedZone request.

" } }, + "com.amazonaws.route53#DeleteKeySigningKey": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#DeleteKeySigningKeyRequest" + }, + "output": { + "target": "com.amazonaws.route53#DeleteKeySigningKeyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#ConcurrentModification" + }, + { + "target": "com.amazonaws.route53#InvalidKeySigningKeyStatus" + }, + { + "target": "com.amazonaws.route53#InvalidKMSArn" + }, + { + "target": "com.amazonaws.route53#InvalidSigningStatus" + }, + { + "target": "com.amazonaws.route53#NoSuchKeySigningKey" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a key signing key (KSK). Before you can delete a KSK, you must deactivate it. The KSK must be\n\t\tdeactived before you can delete it regardless of whether the hosted zone is enabled for DNSSEC signing.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/2013-04-01/keysigningkey/{HostedZoneId}/{Name}", + "code": 200 + } + } + }, + "com.amazonaws.route53#DeleteKeySigningKeyRequest": { + "type": "structure", + "members": { + "HostedZoneId": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

A unique string used to identify a hosted zone.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.route53#SigningKeyName", + "traits": { + "smithy.api#documentation": "

An alphanumeric string used to identify a key signing key (KSK).

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.route53#DeleteKeySigningKeyResponse": { + "type": "structure", + "members": { + "ChangeInfo": { + "target": "com.amazonaws.route53#ChangeInfo", + "traits": { + "smithy.api#required": {} + } + } + } + }, "com.amazonaws.route53#DeleteQueryLoggingConfig": { "type": "operation", "input": { @@ -2214,6 +2625,70 @@ } } }, + "com.amazonaws.route53#DisableHostedZoneDNSSEC": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#DisableHostedZoneDNSSECRequest" + }, + "output": { + "target": "com.amazonaws.route53#DisableHostedZoneDNSSECResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#ConcurrentModification" + }, + { + "target": "com.amazonaws.route53#DNSSECNotFound" + }, + { + "target": "com.amazonaws.route53#InvalidArgument" + }, + { + "target": "com.amazonaws.route53#InvalidKeySigningKeyStatus" + }, + { + "target": "com.amazonaws.route53#InvalidKMSArn" + }, + { + "target": "com.amazonaws.route53#KeySigningKeyInParentDSRecord" + }, + { + "target": "com.amazonaws.route53#NoSuchHostedZone" + } + ], + "traits": { + "smithy.api#documentation": "

Disables DNSSEC signing in a specific hosted zone. This action does not deactivate any key signing keys (KSKs)\n\t\tthat are active in the hosted zone.

", + "smithy.api#http": { + "method": "POST", + "uri": "/2013-04-01/hostedzone/{HostedZoneId}/disable-dnssec", + "code": 200 + } + } + }, + "com.amazonaws.route53#DisableHostedZoneDNSSECRequest": { + "type": "structure", + "members": { + "HostedZoneId": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

A unique string used to identify a hosted zone.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.route53#DisableHostedZoneDNSSECResponse": { + "type": "structure", + "members": { + "ChangeInfo": { + "target": "com.amazonaws.route53#ChangeInfo", + "traits": { + "smithy.api#required": {} + } + } + } + }, "com.amazonaws.route53#Disabled": { "type": "boolean", "traits": { @@ -2301,6 +2776,73 @@ "smithy.api#documentation": "

A complex type that contains the response information for the disassociate request.

" } }, + "com.amazonaws.route53#EnableHostedZoneDNSSEC": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#EnableHostedZoneDNSSECRequest" + }, + "output": { + "target": "com.amazonaws.route53#EnableHostedZoneDNSSECResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#ConcurrentModification" + }, + { + "target": "com.amazonaws.route53#DNSSECNotFound" + }, + { + "target": "com.amazonaws.route53#HostedZonePartiallyDelegated" + }, + { + "target": "com.amazonaws.route53#InvalidArgument" + }, + { + "target": "com.amazonaws.route53#InvalidKeySigningKeyStatus" + }, + { + "target": "com.amazonaws.route53#InvalidKMSArn" + }, + { + "target": "com.amazonaws.route53#KeySigningKeyWithActiveStatusNotFound" + }, + { + "target": "com.amazonaws.route53#NoSuchHostedZone" + } + ], + "traits": { + "smithy.api#documentation": "

Enables DNSSEC signing in a specific hosted zone.

", + "smithy.api#http": { + "method": "POST", + "uri": "/2013-04-01/hostedzone/{HostedZoneId}/enable-dnssec", + "code": 200 + } + } + }, + "com.amazonaws.route53#EnableHostedZoneDNSSECRequest": { + "type": "structure", + "members": { + "HostedZoneId": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

A unique string used to identify a hosted zone.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.route53#EnableHostedZoneDNSSECResponse": { + "type": "structure", + "members": { + "ChangeInfo": { + "target": "com.amazonaws.route53#ChangeInfo", + "traits": { + "smithy.api#required": {} + } + } + } + }, "com.amazonaws.route53#EnableSNI": { "type": "boolean", "traits": { @@ -2596,43 +3138,100 @@ "smithy.api#documentation": "

A complex type that contains the ChangeInfo element.

" } }, - "com.amazonaws.route53#GetCheckerIpRanges": { + "com.amazonaws.route53#GetCheckerIpRanges": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#GetCheckerIpRangesRequest" + }, + "output": { + "target": "com.amazonaws.route53#GetCheckerIpRangesResponse" + }, + "traits": { + "smithy.api#documentation": "\n\t\t\t

\n GetCheckerIpRanges still works, but we recommend that you download \n\t\t\tip-ranges.json, which includes IP address ranges for all AWS services. For more information, see \n\t\t\tIP Address Ranges of Amazon Route 53 Servers \n\t\t\tin the Amazon Route 53 Developer Guide.

\n\t\t ", + "smithy.api#http": { + "method": "GET", + "uri": "/2013-04-01/checkeripranges", + "code": 200 + } + } + }, + "com.amazonaws.route53#GetCheckerIpRangesRequest": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

Empty request.

" + } + }, + "com.amazonaws.route53#GetCheckerIpRangesResponse": { + "type": "structure", + "members": { + "CheckerIpRanges": { + "target": "com.amazonaws.route53#CheckerIpRanges", + "traits": { + "smithy.api#documentation": "

A complex type that contains sorted list of IP ranges in CIDR format for Amazon Route 53 health\n\t\t\tcheckers.

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

A complex type that contains the CheckerIpRanges element.

" + } + }, + "com.amazonaws.route53#GetDNSSEC": { "type": "operation", "input": { - "target": "com.amazonaws.route53#GetCheckerIpRangesRequest" + "target": "com.amazonaws.route53#GetDNSSECRequest" }, "output": { - "target": "com.amazonaws.route53#GetCheckerIpRangesResponse" + "target": "com.amazonaws.route53#GetDNSSECResponse" }, + "errors": [ + { + "target": "com.amazonaws.route53#InvalidArgument" + }, + { + "target": "com.amazonaws.route53#NoSuchHostedZone" + } + ], "traits": { - "smithy.api#documentation": "\n\t\t\t

\n GetCheckerIpRanges still works, but we recommend that you download \n\t\t\tip-ranges.json, which includes IP address ranges for all AWS services. For more information, see \n\t\t\tIP Address Ranges of Amazon Route 53 Servers \n\t\t\tin the Amazon Route 53 Developer Guide.

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

Returns information about DNSSEC for a specific hosted zone, including the key signing keys (KSKs)\n\t\t\tand zone signing keys (ZSKs) in the hosted zone.

", "smithy.api#http": { "method": "GET", - "uri": "/2013-04-01/checkeripranges", + "uri": "/2013-04-01/hostedzone/{HostedZoneId}/dnssec", "code": 200 } } }, - "com.amazonaws.route53#GetCheckerIpRangesRequest": { + "com.amazonaws.route53#GetDNSSECRequest": { "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "

Empty request.

" + "members": { + "HostedZoneId": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

A unique string used to identify a hosted zone.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } } }, - "com.amazonaws.route53#GetCheckerIpRangesResponse": { + "com.amazonaws.route53#GetDNSSECResponse": { "type": "structure", "members": { - "CheckerIpRanges": { - "target": "com.amazonaws.route53#CheckerIpRanges", + "Status": { + "target": "com.amazonaws.route53#DNSSECStatus", "traits": { - "smithy.api#documentation": "

A complex type that contains sorted list of IP ranges in CIDR format for Amazon Route 53 health\n\t\t\tcheckers.

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

A string repesenting the status of DNSSEC.

", + "smithy.api#required": {} + } + }, + "KeySigningKeys": { + "target": "com.amazonaws.route53#KeySigningKeys", + "traits": { + "smithy.api#documentation": "

The key signing keys (KSKs) in your account.

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

A complex type that contains the CheckerIpRanges element.

" } }, "com.amazonaws.route53#GetGeoLocation": { @@ -3493,7 +4092,7 @@ "message": { "target": "com.amazonaws.route53#ErrorMessage", "traits": { - "smithy.api#documentation": "

Descriptive message for the error response.

" + "smithy.api#documentation": "

" } } }, @@ -3635,7 +4234,7 @@ "message": { "target": "com.amazonaws.route53#ErrorMessage", "traits": { - "smithy.api#documentation": "

Descriptive message for the error response.

" + "smithy.api#documentation": "

" } } }, @@ -3695,28 +4294,36 @@ "traits": { "smithy.api#enum": [ { - "value": "us-east-1" + "value": "us-east-1", + "name": "us_east_1" }, { - "value": "us-west-1" + "value": "us-west-1", + "name": "us_west_1" }, { - "value": "us-west-2" + "value": "us-west-2", + "name": "us_west_2" }, { - "value": "eu-west-1" + "value": "eu-west-1", + "name": "eu_west_1" }, { - "value": "ap-southeast-1" + "value": "ap-southeast-1", + "name": "ap_southeast_1" }, { - "value": "ap-southeast-2" + "value": "ap-southeast-2", + "name": "ap_southeast_2" }, { - "value": "ap-northeast-1" + "value": "ap-northeast-1", + "name": "ap_northeast_1" }, { - "value": "sa-east-1" + "value": "sa-east-1", + "name": "sa_east_1" } ], "smithy.api#length": { @@ -3869,7 +4476,7 @@ "message": { "target": "com.amazonaws.route53#ErrorMessage", "traits": { - "smithy.api#documentation": "

Descriptive message for the error response.

" + "smithy.api#documentation": "

" } } }, @@ -3932,10 +4539,12 @@ "traits": { "smithy.api#enum": [ { - "value": "MAX_RRSETS_BY_ZONE" + "value": "MAX_RRSETS_BY_ZONE", + "name": "MAX_RRSETS_BY_ZONE" }, { - "value": "MAX_VPCS_ASSOCIATED_BY_ZONE" + "value": "MAX_VPCS_ASSOCIATED_BY_ZONE", + "name": "MAX_VPCS_ASSOCIATED_BY_ZONE" } ] } @@ -3946,7 +4555,7 @@ "message": { "target": "com.amazonaws.route53#ErrorMessage", "traits": { - "smithy.api#documentation": "

Descriptive message for the error response.

" + "smithy.api#documentation": "

" } } }, @@ -3962,7 +4571,7 @@ "message": { "target": "com.amazonaws.route53#ErrorMessage", "traits": { - "smithy.api#documentation": "

Descriptive message for the error response.

" + "smithy.api#documentation": "

" } } }, @@ -3977,7 +4586,7 @@ "message": { "target": "com.amazonaws.route53#ErrorMessage", "traits": { - "smithy.api#documentation": "

Descriptive message for the error response.

" + "smithy.api#documentation": "

" } } }, @@ -4015,6 +4624,18 @@ } } }, + "com.amazonaws.route53#HostedZonePartiallyDelegated": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The hosted zone nameservers don't match the parent nameservers. The hosted zone and parent must have the same nameservers.

", + "smithy.api#error": "client" + } + }, "com.amazonaws.route53#HostedZoneRRSetCount": { "type": "long", "traits": { @@ -4112,13 +4733,16 @@ "traits": { "smithy.api#enum": [ { - "value": "Healthy" + "value": "Healthy", + "name": "Healthy" }, { - "value": "Unhealthy" + "value": "Unhealthy", + "name": "Unhealthy" }, { - "value": "LastKnownStatus" + "value": "LastKnownStatus", + "name": "LastKnownStatus" } ] } @@ -4129,12 +4753,12 @@ "message": { "target": "com.amazonaws.route53#ErrorMessage", "traits": { - "smithy.api#documentation": "

Descriptive message for the error response.

" + "smithy.api#documentation": "

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

Parameter name is invalid.

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

Parameter name is not valid.

", "smithy.api#error": "client" } }, @@ -4144,7 +4768,7 @@ "messages": { "target": "com.amazonaws.route53#ErrorMessages", "traits": { - "smithy.api#documentation": "

Descriptive message for the error response.

" + "smithy.api#documentation": "

" } }, "message": { @@ -4162,7 +4786,7 @@ "message": { "target": "com.amazonaws.route53#ErrorMessage", "traits": { - "smithy.api#documentation": "

Descriptive message for the error response.

" + "smithy.api#documentation": "

" } } }, @@ -4178,7 +4802,7 @@ "message": { "target": "com.amazonaws.route53#ErrorMessage", "traits": { - "smithy.api#documentation": "

Descriptive message for the error response.

" + "smithy.api#documentation": "

" } } }, @@ -4188,6 +4812,44 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.route53#InvalidKMSArn": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The KeyManagementServiceArn that you specified isn't valid to use with DNSSEC signing.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.route53#InvalidKeySigningKeyName": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The key signing key (KSK) name that you specified isn't a valid name.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.route53#InvalidKeySigningKeyStatus": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The key signing key (KSK) status isn't valid or another KSK has the status INTERNAL_FAILURE.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, "com.amazonaws.route53#InvalidPaginationToken": { "type": "structure", "members": { @@ -4201,18 +4863,30 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.route53#InvalidSigningStatus": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

Your hosted zone status isn't valid for this operation. In the hosted zone, change the status to enable DNSSEC \n\t\t\tor disable DNSSEC.

", + "smithy.api#error": "client" + } + }, "com.amazonaws.route53#InvalidTrafficPolicyDocument": { "type": "structure", "members": { "message": { "target": "com.amazonaws.route53#ErrorMessage", "traits": { - "smithy.api#documentation": "

Descriptive message for the error response.

" + "smithy.api#documentation": "

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

The format of the traffic policy document that you specified in the Document element is invalid.

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

The format of the traffic policy document that you specified in the Document element is not valid.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -4223,7 +4897,7 @@ "message": { "target": "com.amazonaws.route53#ErrorMessage", "traits": { - "smithy.api#documentation": "

Descriptive message for the error response.

" + "smithy.api#documentation": "

" } } }, @@ -4242,13 +4916,173 @@ "com.amazonaws.route53#IsPrivateZone": { "type": "boolean" }, + "com.amazonaws.route53#KeySigningKey": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.route53#SigningKeyName", + "traits": { + "smithy.api#documentation": "

An alphanumeric string used to identify a key signing key (KSK). Name must be unique for each key signing key in the same \n\t\t\thosted zone.

" + } + }, + "KmsArn": { + "target": "com.amazonaws.route53#SigningKeyString", + "traits": { + "smithy.api#documentation": "

The Amazon resource name (ARN) used to identify the customer managed key (CMK) in AWS Key Management Service (KMS).\n\t\t\tThe KmsArn must be unique for each key signing key (KSK) in a single hosted zone.

\n\t\t

You must configure the CMK as follows:

\n\t\t
\n
Status
\n
\n

Enabled

\n
\n
Key spec
\n
\n

ECC_NIST_P256

\n
\n
Key usage
\n
\n

Sign and verify

\n
\n
Key policy
\n
\n

The key policy must give permission for the following actions:

\n\t\t\t\t
    \n
  • \n

    DescribeKey

    \n
    • \n
  • \n

    GetPublicKey

    \n
    • \n
  • \n

    Sign

    \n
    • \n
\n\t\t\t\t\t

The key policy must also include the Amazon Route 53 service in the principal for your account. \n\t\t\t\t\t\tSpecify the following:

\n\t\t\t\t\t
    \n
  • \n

    \n \"Service\": \"api-service.dnssec.route53.aws.internal\"\n

    \n
    • \n
\n\t\t\t\t
\n
\n\t\t

For more information about working with the customer managed key (CMK) in KMS, see \n\t\t\tAWS Key Management Service concepts.

" + } + }, + "Flag": { + "target": "com.amazonaws.route53#SigningKeyInteger", + "traits": { + "smithy.api#documentation": "

An integer that specifies how the key is used. For key signing key (KSK), this value is always 257.

" + } + }, + "SigningAlgorithmMnemonic": { + "target": "com.amazonaws.route53#SigningKeyString", + "traits": { + "smithy.api#documentation": "

A string used to represent the signing algorithm. This value must follow the guidelines provided by\n\t\t\tRFC-8624 Section 3.1.\n\t\t

" + } + }, + "SigningAlgorithmType": { + "target": "com.amazonaws.route53#SigningKeyInteger", + "traits": { + "smithy.api#documentation": "

An integer used to represent the signing algorithm. This value must follow the guidelines provided by\n\t\t\tRFC-8624 Section 3.1.\n\t\t

" + } + }, + "DigestAlgorithmMnemonic": { + "target": "com.amazonaws.route53#SigningKeyString", + "traits": { + "smithy.api#documentation": "

A string used to represent the delegation signer digest algorithm. This value must follow the guidelines provided by\n\t\t\tRFC-8624 Section 3.3.\n\t\t

" + } + }, + "DigestAlgorithmType": { + "target": "com.amazonaws.route53#SigningKeyInteger", + "traits": { + "smithy.api#documentation": "

An integer used to represent the delegation signer digest algorithm. This value must follow the guidelines provided by\n\t\t\tRFC-8624 Section 3.3.

" + } + }, + "KeyTag": { + "target": "com.amazonaws.route53#SigningKeyTag", + "traits": { + "smithy.api#documentation": "

An integer used to identify the DNSSEC record for the domain name. The process used to calculate the value is described in\n\t\t\tRFC-4034 Appendix B.

" + } + }, + "DigestValue": { + "target": "com.amazonaws.route53#SigningKeyString", + "traits": { + "smithy.api#documentation": "

A cryptographic digest of a DNSKEY resource record (RR). DNSKEY records are used to publish the public key that resolvers \n\t\t\tcan use to verify DNSSEC signatures that are used to secure certain kinds of information provided by the DNS system.

" + } + }, + "PublicKey": { + "target": "com.amazonaws.route53#SigningKeyString", + "traits": { + "smithy.api#documentation": "

The public key, represented as a Base64 encoding, as required by \n\t\t\tRFC-4034 Page 5.

" + } + }, + "DSRecord": { + "target": "com.amazonaws.route53#SigningKeyString", + "traits": { + "smithy.api#documentation": "

A string that represents a delegation signer (DS) record.

" + } + }, + "DNSKEYRecord": { + "target": "com.amazonaws.route53#SigningKeyString", + "traits": { + "smithy.api#documentation": "

A string that represents a DNSKEY record.

" + } + }, + "Status": { + "target": "com.amazonaws.route53#SigningKeyStatus", + "traits": { + "smithy.api#documentation": "

A string that represents the current key signing key (KSK) status.

\n\t\t

Status can have one of the following values:

\n\t\t
\n
ACTIVE
\n
\n

The KSK is being used for signing.

\n
\n
INACTIVE
\n
\n

The KSK is not being used for signing.

\n
\n
ACTION_NEEDED
\n
\n

There is an error in the KSK that requires you to take action to resolve.

\n
\n
INTERNAL_FAILURE
\n
\n

There was an error during a request. Before you can continue to work with DNSSEC\n\t\t\t\t\tsigning, including actions that involve this KSK, you must correct the problem. For example,\n\t\t\t\t\tyou may need to activate or deactivate the KSK.

\n
\n
" + } + }, + "StatusMessage": { + "target": "com.amazonaws.route53#SigningKeyStatusMessage", + "traits": { + "smithy.api#documentation": "

The status message provided for the following key signing key (KSK) statuses: ACTION_NEEDED or \n\t\t\tINTERNAL_FAILURE. The status message includes information about what the problem might be and steps \n\t\t\tthat you can take to correct the issue.

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

The date when the key signing key (KSK) was created.

" + } + }, + "LastModifiedDate": { + "target": "com.amazonaws.route53#TimeStamp", + "traits": { + "smithy.api#documentation": "

The last time that the key signing key (KSK) was changed.

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

A key signing key (KSK) is a complex type that represents a public/private key pair. The private key is used to generate\n\t\ta digital signature for the zone signing key (ZSK). The public key is stored in the DNS and is used to authenticate the ZSK. \n\t\tA KSK is always associated with a hosted zone; it cannot exist by itself.

" + } + }, + "com.amazonaws.route53#KeySigningKeyAlreadyExists": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

You've already created a key signing key (KSK) with this name or with the same customer managed key (CMK) ARN.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.route53#KeySigningKeyInParentDSRecord": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The key signing key (KSK) is specified in a parent DS record.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.route53#KeySigningKeyInUse": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The key signing key (KSK) that you specified can't be deactivated because it's the only KSK for a\n\t\tcurrently-enabled DNSSEC. Disable DNSSEC signing, or add or enable another KSK.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.route53#KeySigningKeyWithActiveStatusNotFound": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

A key signing key (KSK) with ACTIVE status wasn't found.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.route53#KeySigningKeys": { + "type": "list", + "member": { + "target": "com.amazonaws.route53#KeySigningKey" + } + }, "com.amazonaws.route53#LastVPCAssociation": { "type": "structure", "members": { "message": { "target": "com.amazonaws.route53#ErrorMessage", "traits": { - "smithy.api#documentation": "

Descriptive message for the error response.

" + "smithy.api#documentation": "

" } } }, @@ -4272,7 +5106,7 @@ "message": { "target": "com.amazonaws.route53#ErrorMessage", "traits": { - "smithy.api#documentation": "

Descriptive message for the error response.

" + "smithy.api#documentation": "

" } } }, @@ -5895,7 +6729,7 @@ "message": { "target": "com.amazonaws.route53#ErrorMessage", "traits": { - "smithy.api#documentation": "

Descriptive message for the error response.

" + "smithy.api#documentation": "

" } } }, @@ -5910,7 +6744,7 @@ "message": { "target": "com.amazonaws.route53#ErrorMessage", "traits": { - "smithy.api#documentation": "

Descriptive message for the error response.

" + "smithy.api#documentation": "

" } } }, @@ -5926,7 +6760,7 @@ "message": { "target": "com.amazonaws.route53#ErrorMessage", "traits": { - "smithy.api#documentation": "

Descriptive message for the error response.

" + "smithy.api#documentation": "

" } } }, @@ -5942,7 +6776,7 @@ "message": { "target": "com.amazonaws.route53#ErrorMessage", "traits": { - "smithy.api#documentation": "

Descriptive message for the error response.

" + "smithy.api#documentation": "

" } } }, @@ -5952,6 +6786,19 @@ "smithy.api#httpError": 404 } }, + "com.amazonaws.route53#NoSuchKeySigningKey": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The specified key signing key (KSK) doesn't exist.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, "com.amazonaws.route53#NoSuchQueryLoggingConfig": { "type": "structure", "members": { @@ -5971,7 +6818,7 @@ "message": { "target": "com.amazonaws.route53#ErrorMessage", "traits": { - "smithy.api#documentation": "

Descriptive message for the error response.

" + "smithy.api#documentation": "

" } } }, @@ -5987,7 +6834,7 @@ "message": { "target": "com.amazonaws.route53#ErrorMessage", "traits": { - "smithy.api#documentation": "

Descriptive message for the error response.

" + "smithy.api#documentation": "

" } } }, @@ -6012,7 +6859,7 @@ "message": { "target": "com.amazonaws.route53#ErrorMessage", "traits": { - "smithy.api#documentation": "

Descriptive message for the error response.

" + "smithy.api#documentation": "

" } } }, @@ -6081,7 +6928,7 @@ "message": { "target": "com.amazonaws.route53#ErrorMessage", "traits": { - "smithy.api#documentation": "

Descriptive message for the error response.

" + "smithy.api#documentation": "

" } } }, @@ -6165,40 +7012,56 @@ "traits": { "smithy.api#enum": [ { - "value": "SOA" + "value": "SOA", + "name": "SOA" }, { - "value": "A" + "value": "A", + "name": "A" }, { - "value": "TXT" + "value": "TXT", + "name": "TXT" }, { - "value": "NS" + "value": "NS", + "name": "NS" }, { - "value": "CNAME" + "value": "CNAME", + "name": "CNAME" }, { - "value": "MX" + "value": "MX", + "name": "MX" }, { - "value": "NAPTR" + "value": "NAPTR", + "name": "NAPTR" }, { - "value": "PTR" + "value": "PTR", + "name": "PTR" }, { - "value": "SRV" + "value": "SRV", + "name": "SRV" }, { - "value": "SPF" + "value": "SPF", + "name": "SPF" }, { - "value": "AAAA" + "value": "AAAA", + "name": "AAAA" }, { - "value": "CAA" + "value": "CAA", + "name": "CAA" + }, + { + "value": "DS", + "name": "DS" } ] } @@ -6237,16 +7100,20 @@ "traits": { "smithy.api#enum": [ { - "value": "FullyQualifiedDomainName" + "value": "FullyQualifiedDomainName", + "name": "FullyQualifiedDomainName" }, { - "value": "Regions" + "value": "Regions", + "name": "Regions" }, { - "value": "ResourcePath" + "value": "ResourcePath", + "name": "ResourcePath" }, { - "value": "ChildHealthChecks" + "value": "ChildHealthChecks", + "name": "ChildHealthChecks" } ], "smithy.api#length": { @@ -6405,10 +7272,12 @@ "traits": { "smithy.api#enum": [ { - "value": "PRIMARY" + "value": "PRIMARY", + "name": "PRIMARY" }, { - "value": "SECONDARY" + "value": "SECONDARY", + "name": "SECONDARY" } ] } @@ -6433,73 +7302,96 @@ "traits": { "smithy.api#enum": [ { - "value": "us-east-1" + "value": "us-east-1", + "name": "us_east_1" }, { - "value": "us-east-2" + "value": "us-east-2", + "name": "us_east_2" }, { - "value": "us-west-1" + "value": "us-west-1", + "name": "us_west_1" }, { - "value": "us-west-2" + "value": "us-west-2", + "name": "us_west_2" }, { - "value": "ca-central-1" + "value": "ca-central-1", + "name": "ca_central_1" }, { - "value": "eu-west-1" + "value": "eu-west-1", + "name": "eu_west_1" }, { - "value": "eu-west-2" + "value": "eu-west-2", + "name": "eu_west_2" }, { - "value": "eu-west-3" + "value": "eu-west-3", + "name": "eu_west_3" }, { - "value": "eu-central-1" + "value": "eu-central-1", + "name": "eu_central_1" }, { - "value": "ap-southeast-1" + "value": "ap-southeast-1", + "name": "ap_southeast_1" }, { - "value": "ap-southeast-2" + "value": "ap-southeast-2", + "name": "ap_southeast_2" }, { - "value": "ap-northeast-1" + "value": "ap-northeast-1", + "name": "ap_northeast_1" }, { - "value": "ap-northeast-2" + "value": "ap-northeast-2", + "name": "ap_northeast_2" }, { - "value": "ap-northeast-3" + "value": "ap-northeast-3", + "name": "ap_northeast_3" }, { - "value": "eu-north-1" + "value": "eu-north-1", + "name": "eu_north_1" }, { - "value": "sa-east-1" + "value": "sa-east-1", + "name": "sa_east_1" }, { - "value": "cn-north-1" + "value": "cn-north-1", + "name": "cn_north_1" }, { - "value": "cn-northwest-1" + "value": "cn-northwest-1", + "name": "cn_northwest_1" }, { - "value": "ap-east-1" + "value": "ap-east-1", + "name": "ap_east_1" }, { - "value": "me-south-1" + "value": "me-south-1", + "name": "me_south_1" }, { - "value": "ap-south-1" + "value": "ap-south-1", + "name": "ap_south_1" }, { - "value": "af-south-1" + "value": "af-south-1", + "name": "af_south_1" }, { - "value": "eu-south-1" + "value": "eu-south-1", + "name": "eu_south_1" } ], "smithy.api#length": { @@ -6612,7 +7504,8 @@ "traits": { "smithy.api#enum": [ { - "value": "MAX_ZONES_BY_REUSABLE_DELEGATION_SET" + "value": "MAX_ZONES_BY_REUSABLE_DELEGATION_SET", + "name": "MAX_ZONES_BY_REUSABLE_DELEGATION_SET" } ] } @@ -6626,6 +7519,15 @@ } } }, + "com.amazonaws.route53#ServeSignature": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, "com.amazonaws.route53#ServicePrincipal": { "type": "string", "traits": { @@ -6635,24 +7537,71 @@ } } }, + "com.amazonaws.route53#SigningKeyInteger": { + "type": "integer" + }, + "com.amazonaws.route53#SigningKeyName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 128 + } + } + }, + "com.amazonaws.route53#SigningKeyStatus": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 5, + "max": 150 + } + } + }, + "com.amazonaws.route53#SigningKeyStatusMessage": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + } + } + }, + "com.amazonaws.route53#SigningKeyString": { + "type": "string" + }, + "com.amazonaws.route53#SigningKeyTag": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 65536 + } + } + }, "com.amazonaws.route53#Statistic": { "type": "string", "traits": { "smithy.api#enum": [ { - "value": "Average" + "value": "Average", + "name": "Average" }, { - "value": "Sum" + "value": "Sum", + "name": "Sum" }, { - "value": "SampleCount" + "value": "SampleCount", + "name": "SampleCount" }, { - "value": "Maximum" + "value": "Maximum", + "name": "Maximum" }, { - "value": "Minimum" + "value": "Minimum", + "name": "Minimum" } ] } @@ -6787,10 +7736,12 @@ "traits": { "smithy.api#enum": [ { - "value": "healthcheck" + "value": "healthcheck", + "name": "healthcheck" }, { - "value": "hostedzone" + "value": "hostedzone", + "name": "hostedzone" } ] } @@ -6972,7 +7923,7 @@ "message": { "target": "com.amazonaws.route53#ErrorMessage", "traits": { - "smithy.api#documentation": "

Descriptive message for the error response.

" + "smithy.api#documentation": "

" } } }, @@ -6982,13 +7933,25 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.route53#TooManyKeySigningKeys": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

You've reached the limit for the number of key signing keys (KSKs). Remove at least one KSK, and then try again.

", + "smithy.api#error": "client" + } + }, "com.amazonaws.route53#TooManyTrafficPolicies": { "type": "structure", "members": { "message": { "target": "com.amazonaws.route53#ErrorMessage", "traits": { - "smithy.api#documentation": "

Descriptive message for the error response.

" + "smithy.api#documentation": "

" } } }, @@ -7004,7 +7967,7 @@ "message": { "target": "com.amazonaws.route53#ErrorMessage", "traits": { - "smithy.api#documentation": "

Descriptive message for the error response.

" + "smithy.api#documentation": "

" } } }, @@ -7020,7 +7983,7 @@ "message": { "target": "com.amazonaws.route53#ErrorMessage", "traits": { - "smithy.api#documentation": "

Descriptive message for the error response.

" + "smithy.api#documentation": "

" } } }, @@ -7036,7 +7999,7 @@ "message": { "target": "com.amazonaws.route53#ErrorMessage", "traits": { - "smithy.api#documentation": "

Descriptive message for the error response.

" + "smithy.api#documentation": "

" } } }, @@ -7110,7 +8073,7 @@ "message": { "target": "com.amazonaws.route53#ErrorMessage", "traits": { - "smithy.api#documentation": "

Descriptive message for the error response.

" + "smithy.api#documentation": "

" } } }, @@ -7153,7 +8116,7 @@ "message": { "target": "com.amazonaws.route53#ErrorMessage", "traits": { - "smithy.api#documentation": "

Descriptive message for the error response.

" + "smithy.api#documentation": "

" } } }, @@ -7240,7 +8203,7 @@ "message": { "target": "com.amazonaws.route53#ErrorMessage", "traits": { - "smithy.api#documentation": "

Descriptive message for the error response.

" + "smithy.api#documentation": "

" } } }, @@ -7768,7 +8731,7 @@ "message": { "target": "com.amazonaws.route53#ErrorMessage", "traits": { - "smithy.api#documentation": "

Descriptive message for the error response.

" + "smithy.api#documentation": "

" } } }, @@ -7784,7 +8747,7 @@ "message": { "target": "com.amazonaws.route53#ErrorMessage", "traits": { - "smithy.api#documentation": "

Descriptive message for the error response.

" + "smithy.api#documentation": "

The specified VPC or hosted zone weren't found.

" } } }, @@ -7809,82 +8772,108 @@ "traits": { "smithy.api#enum": [ { - "value": "us-east-1" + "value": "us-east-1", + "name": "us_east_1" }, { - "value": "us-east-2" + "value": "us-east-2", + "name": "us_east_2" }, { - "value": "us-west-1" + "value": "us-west-1", + "name": "us_west_1" }, { - "value": "us-west-2" + "value": "us-west-2", + "name": "us_west_2" }, { - "value": "eu-west-1" + "value": "eu-west-1", + "name": "eu_west_1" }, { - "value": "eu-west-2" + "value": "eu-west-2", + "name": "eu_west_2" }, { - "value": "eu-west-3" + "value": "eu-west-3", + "name": "eu_west_3" }, { - "value": "eu-central-1" + "value": "eu-central-1", + "name": "eu_central_1" }, { - "value": "ap-east-1" + "value": "ap-east-1", + "name": "ap_east_1" }, { - "value": "me-south-1" + "value": "me-south-1", + "name": "me_south_1" }, { - "value": "us-gov-west-1" + "value": "us-gov-west-1", + "name": "us_gov_west_1" }, { - "value": "us-gov-east-1" + "value": "us-gov-east-1", + "name": "us_gov_east_1" }, { - "value": "us-iso-east-1" + "value": "us-iso-east-1", + "name": "us_iso_east_1" }, { - "value": "us-isob-east-1" + "value": "us-isob-east-1", + "name": "us_isob_east_1" }, { - "value": "ap-southeast-1" + "value": "ap-southeast-1", + "name": "ap_southeast_1" }, { - "value": "ap-southeast-2" + "value": "ap-southeast-2", + "name": "ap_southeast_2" }, { - "value": "ap-south-1" + "value": "ap-south-1", + "name": "ap_south_1" }, { - "value": "ap-northeast-1" + "value": "ap-northeast-1", + "name": "ap_northeast_1" }, { - "value": "ap-northeast-2" + "value": "ap-northeast-2", + "name": "ap_northeast_2" }, { - "value": "ap-northeast-3" + "value": "ap-northeast-3", + "name": "ap_northeast_3" }, { - "value": "eu-north-1" + "value": "eu-north-1", + "name": "eu_north_1" }, { - "value": "sa-east-1" + "value": "sa-east-1", + "name": "sa_east_1" }, { - "value": "ca-central-1" + "value": "ca-central-1", + "name": "ca_central_1" }, { - "value": "cn-north-1" + "value": "cn-north-1", + "name": "cn_north_1" }, { - "value": "af-south-1" + "value": "af-south-1", + "name": "af_south_1" }, { - "value": "eu-south-1" + "value": "eu-south-1", + "name": "eu_south_1" } ], "smithy.api#length": { diff --git a/codegen/sdk-codegen/aws-models/route53domains.2014-05-15.json b/codegen/sdk-codegen/aws-models/route53domains.2014-05-15.json index eb24abd1a96..b788a17ce37 100644 --- a/codegen/sdk-codegen/aws-models/route53domains.2014-05-15.json +++ b/codegen/sdk-codegen/aws-models/route53domains.2014-05-15.json @@ -439,19 +439,24 @@ "traits": { "smithy.api#enum": [ { - "value": "PERSON" + "value": "PERSON", + "name": "PERSON" }, { - "value": "COMPANY" + "value": "COMPANY", + "name": "COMPANY" }, { - "value": "ASSOCIATION" + "value": "ASSOCIATION", + "name": "ASSOCIATION" }, { - "value": "PUBLIC_BODY" + "value": "PUBLIC_BODY", + "name": "PUBLIC_BODY" }, { - "value": "RESELLER" + "value": "RESELLER", + "name": "RESELLER" } ] } @@ -461,691 +466,920 @@ "traits": { "smithy.api#enum": [ { - "value": "AD" + "value": "AD", + "name": "AD" }, { - "value": "AE" + "value": "AE", + "name": "AE" }, { - "value": "AF" + "value": "AF", + "name": "AF" }, { - "value": "AG" + "value": "AG", + "name": "AG" }, { - "value": "AI" + "value": "AI", + "name": "AI" }, { - "value": "AL" + "value": "AL", + "name": "AL" }, { - "value": "AM" + "value": "AM", + "name": "AM" }, { - "value": "AN" + "value": "AN", + "name": "AN" }, { - "value": "AO" + "value": "AO", + "name": "AO" }, { - "value": "AQ" + "value": "AQ", + "name": "AQ" }, { - "value": "AR" + "value": "AR", + "name": "AR" }, { - "value": "AS" + "value": "AS", + "name": "AS" }, { - "value": "AT" + "value": "AT", + "name": "AT" }, { - "value": "AU" + "value": "AU", + "name": "AU" }, { - "value": "AW" + "value": "AW", + "name": "AW" }, { - "value": "AZ" + "value": "AZ", + "name": "AZ" }, { - "value": "BA" + "value": "BA", + "name": "BA" }, { - "value": "BB" + "value": "BB", + "name": "BB" }, { - "value": "BD" + "value": "BD", + "name": "BD" }, { - "value": "BE" + "value": "BE", + "name": "BE" }, { - "value": "BF" + "value": "BF", + "name": "BF" }, { - "value": "BG" + "value": "BG", + "name": "BG" }, { - "value": "BH" + "value": "BH", + "name": "BH" }, { - "value": "BI" + "value": "BI", + "name": "BI" }, { - "value": "BJ" + "value": "BJ", + "name": "BJ" }, { - "value": "BL" + "value": "BL", + "name": "BL" }, { - "value": "BM" + "value": "BM", + "name": "BM" }, { - "value": "BN" + "value": "BN", + "name": "BN" }, { - "value": "BO" + "value": "BO", + "name": "BO" }, { - "value": "BR" + "value": "BR", + "name": "BR" }, { - "value": "BS" + "value": "BS", + "name": "BS" }, { - "value": "BT" + "value": "BT", + "name": "BT" }, { - "value": "BW" + "value": "BW", + "name": "BW" }, { - "value": "BY" + "value": "BY", + "name": "BY" }, { - "value": "BZ" + "value": "BZ", + "name": "BZ" }, { - "value": "CA" + "value": "CA", + "name": "CA" }, { - "value": "CC" + "value": "CC", + "name": "CC" }, { - "value": "CD" + "value": "CD", + "name": "CD" }, { - "value": "CF" + "value": "CF", + "name": "CF" }, { - "value": "CG" + "value": "CG", + "name": "CG" }, { - "value": "CH" + "value": "CH", + "name": "CH" }, { - "value": "CI" + "value": "CI", + "name": "CI" }, { - "value": "CK" + "value": "CK", + "name": "CK" }, { - "value": "CL" + "value": "CL", + "name": "CL" }, { - "value": "CM" + "value": "CM", + "name": "CM" }, { - "value": "CN" + "value": "CN", + "name": "CN" }, { - "value": "CO" + "value": "CO", + "name": "CO" }, { - "value": "CR" + "value": "CR", + "name": "CR" }, { - "value": "CU" + "value": "CU", + "name": "CU" }, { - "value": "CV" + "value": "CV", + "name": "CV" }, { - "value": "CX" + "value": "CX", + "name": "CX" }, { - "value": "CY" + "value": "CY", + "name": "CY" }, { - "value": "CZ" + "value": "CZ", + "name": "CZ" }, { - "value": "DE" + "value": "DE", + "name": "DE" }, { - "value": "DJ" + "value": "DJ", + "name": "DJ" }, { - "value": "DK" + "value": "DK", + "name": "DK" }, { - "value": "DM" + "value": "DM", + "name": "DM" }, { - "value": "DO" + "value": "DO", + "name": "DO" }, { - "value": "DZ" + "value": "DZ", + "name": "DZ" }, { - "value": "EC" + "value": "EC", + "name": "EC" }, { - "value": "EE" + "value": "EE", + "name": "EE" }, { - "value": "EG" + "value": "EG", + "name": "EG" }, { - "value": "ER" + "value": "ER", + "name": "ER" }, { - "value": "ES" + "value": "ES", + "name": "ES" }, { - "value": "ET" + "value": "ET", + "name": "ET" }, { - "value": "FI" + "value": "FI", + "name": "FI" }, { - "value": "FJ" + "value": "FJ", + "name": "FJ" }, { - "value": "FK" + "value": "FK", + "name": "FK" }, { - "value": "FM" + "value": "FM", + "name": "FM" }, { - "value": "FO" + "value": "FO", + "name": "FO" }, { - "value": "FR" + "value": "FR", + "name": "FR" }, { - "value": "GA" + "value": "GA", + "name": "GA" }, { - "value": "GB" + "value": "GB", + "name": "GB" }, { - "value": "GD" + "value": "GD", + "name": "GD" }, { - "value": "GE" + "value": "GE", + "name": "GE" }, { - "value": "GH" + "value": "GH", + "name": "GH" }, { - "value": "GI" + "value": "GI", + "name": "GI" }, { - "value": "GL" + "value": "GL", + "name": "GL" }, { - "value": "GM" + "value": "GM", + "name": "GM" }, { - "value": "GN" + "value": "GN", + "name": "GN" }, { - "value": "GQ" + "value": "GQ", + "name": "GQ" }, { - "value": "GR" + "value": "GR", + "name": "GR" }, { - "value": "GT" + "value": "GT", + "name": "GT" }, { - "value": "GU" + "value": "GU", + "name": "GU" }, { - "value": "GW" + "value": "GW", + "name": "GW" }, { - "value": "GY" + "value": "GY", + "name": "GY" }, { - "value": "HK" + "value": "HK", + "name": "HK" }, { - "value": "HN" + "value": "HN", + "name": "HN" }, { - "value": "HR" + "value": "HR", + "name": "HR" }, { - "value": "HT" + "value": "HT", + "name": "HT" }, { - "value": "HU" + "value": "HU", + "name": "HU" }, { - "value": "ID" + "value": "ID", + "name": "ID" }, { - "value": "IE" + "value": "IE", + "name": "IE" }, { - "value": "IL" + "value": "IL", + "name": "IL" }, { - "value": "IM" + "value": "IM", + "name": "IM" }, { - "value": "IN" + "value": "IN", + "name": "IN" }, { - "value": "IQ" + "value": "IQ", + "name": "IQ" }, { - "value": "IR" + "value": "IR", + "name": "IR" }, { - "value": "IS" + "value": "IS", + "name": "IS" }, { - "value": "IT" + "value": "IT", + "name": "IT" }, { - "value": "JM" + "value": "JM", + "name": "JM" }, { - "value": "JO" + "value": "JO", + "name": "JO" }, { - "value": "JP" + "value": "JP", + "name": "JP" }, { - "value": "KE" + "value": "KE", + "name": "KE" }, { - "value": "KG" + "value": "KG", + "name": "KG" }, { - "value": "KH" + "value": "KH", + "name": "KH" }, { - "value": "KI" + "value": "KI", + "name": "KI" }, { - "value": "KM" + "value": "KM", + "name": "KM" }, { - "value": "KN" + "value": "KN", + "name": "KN" }, { - "value": "KP" + "value": "KP", + "name": "KP" }, { - "value": "KR" + "value": "KR", + "name": "KR" }, { - "value": "KW" + "value": "KW", + "name": "KW" }, { - "value": "KY" + "value": "KY", + "name": "KY" }, { - "value": "KZ" + "value": "KZ", + "name": "KZ" }, { - "value": "LA" + "value": "LA", + "name": "LA" }, { - "value": "LB" + "value": "LB", + "name": "LB" }, { - "value": "LC" + "value": "LC", + "name": "LC" }, { - "value": "LI" + "value": "LI", + "name": "LI" }, { - "value": "LK" + "value": "LK", + "name": "LK" }, { - "value": "LR" + "value": "LR", + "name": "LR" }, { - "value": "LS" + "value": "LS", + "name": "LS" }, { - "value": "LT" + "value": "LT", + "name": "LT" }, { - "value": "LU" + "value": "LU", + "name": "LU" }, { - "value": "LV" + "value": "LV", + "name": "LV" }, { - "value": "LY" + "value": "LY", + "name": "LY" }, { - "value": "MA" + "value": "MA", + "name": "MA" }, { - "value": "MC" + "value": "MC", + "name": "MC" }, { - "value": "MD" + "value": "MD", + "name": "MD" }, { - "value": "ME" + "value": "ME", + "name": "ME" }, { - "value": "MF" + "value": "MF", + "name": "MF" }, { - "value": "MG" + "value": "MG", + "name": "MG" }, { - "value": "MH" + "value": "MH", + "name": "MH" }, { - "value": "MK" + "value": "MK", + "name": "MK" }, { - "value": "ML" + "value": "ML", + "name": "ML" }, { - "value": "MM" + "value": "MM", + "name": "MM" }, { - "value": "MN" + "value": "MN", + "name": "MN" }, { - "value": "MO" + "value": "MO", + "name": "MO" }, { - "value": "MP" + "value": "MP", + "name": "MP" }, { - "value": "MR" + "value": "MR", + "name": "MR" }, { - "value": "MS" + "value": "MS", + "name": "MS" }, { - "value": "MT" + "value": "MT", + "name": "MT" }, { - "value": "MU" + "value": "MU", + "name": "MU" }, { - "value": "MV" + "value": "MV", + "name": "MV" }, { - "value": "MW" + "value": "MW", + "name": "MW" }, { - "value": "MX" + "value": "MX", + "name": "MX" }, { - "value": "MY" + "value": "MY", + "name": "MY" }, { - "value": "MZ" + "value": "MZ", + "name": "MZ" }, { - "value": "NA" + "value": "NA", + "name": "NA" }, { - "value": "NC" + "value": "NC", + "name": "NC" }, { - "value": "NE" + "value": "NE", + "name": "NE" }, { - "value": "NG" + "value": "NG", + "name": "NG" }, { - "value": "NI" + "value": "NI", + "name": "NI" }, { - "value": "NL" + "value": "NL", + "name": "NL" }, { - "value": "NO" + "value": "NO", + "name": "NO" }, { - "value": "NP" + "value": "NP", + "name": "NP" }, { - "value": "NR" + "value": "NR", + "name": "NR" }, { - "value": "NU" + "value": "NU", + "name": "NU" }, { - "value": "NZ" + "value": "NZ", + "name": "NZ" }, { - "value": "OM" + "value": "OM", + "name": "OM" }, { - "value": "PA" + "value": "PA", + "name": "PA" }, { - "value": "PE" + "value": "PE", + "name": "PE" }, { - "value": "PF" + "value": "PF", + "name": "PF" }, { - "value": "PG" + "value": "PG", + "name": "PG" }, { - "value": "PH" + "value": "PH", + "name": "PH" }, { - "value": "PK" + "value": "PK", + "name": "PK" }, { - "value": "PL" + "value": "PL", + "name": "PL" }, { - "value": "PM" + "value": "PM", + "name": "PM" }, { - "value": "PN" + "value": "PN", + "name": "PN" }, { - "value": "PR" + "value": "PR", + "name": "PR" }, { - "value": "PT" + "value": "PT", + "name": "PT" }, { - "value": "PW" + "value": "PW", + "name": "PW" }, { - "value": "PY" + "value": "PY", + "name": "PY" }, { - "value": "QA" + "value": "QA", + "name": "QA" }, { - "value": "RO" + "value": "RO", + "name": "RO" }, { - "value": "RS" + "value": "RS", + "name": "RS" }, { - "value": "RU" + "value": "RU", + "name": "RU" }, { - "value": "RW" + "value": "RW", + "name": "RW" }, { - "value": "SA" + "value": "SA", + "name": "SA" }, { - "value": "SB" + "value": "SB", + "name": "SB" }, { - "value": "SC" + "value": "SC", + "name": "SC" }, { - "value": "SD" + "value": "SD", + "name": "SD" }, { - "value": "SE" + "value": "SE", + "name": "SE" }, { - "value": "SG" + "value": "SG", + "name": "SG" }, { - "value": "SH" + "value": "SH", + "name": "SH" }, { - "value": "SI" + "value": "SI", + "name": "SI" }, { - "value": "SK" + "value": "SK", + "name": "SK" }, { - "value": "SL" + "value": "SL", + "name": "SL" }, { - "value": "SM" + "value": "SM", + "name": "SM" }, { - "value": "SN" + "value": "SN", + "name": "SN" }, { - "value": "SO" + "value": "SO", + "name": "SO" }, { - "value": "SR" + "value": "SR", + "name": "SR" }, { - "value": "ST" + "value": "ST", + "name": "ST" }, { - "value": "SV" + "value": "SV", + "name": "SV" }, { - "value": "SY" + "value": "SY", + "name": "SY" }, { - "value": "SZ" + "value": "SZ", + "name": "SZ" }, { - "value": "TC" + "value": "TC", + "name": "TC" }, { - "value": "TD" + "value": "TD", + "name": "TD" }, { - "value": "TG" + "value": "TG", + "name": "TG" }, { - "value": "TH" + "value": "TH", + "name": "TH" }, { - "value": "TJ" + "value": "TJ", + "name": "TJ" }, { - "value": "TK" + "value": "TK", + "name": "TK" }, { - "value": "TL" + "value": "TL", + "name": "TL" }, { - "value": "TM" + "value": "TM", + "name": "TM" }, { - "value": "TN" + "value": "TN", + "name": "TN" }, { - "value": "TO" + "value": "TO", + "name": "TO" }, { - "value": "TR" + "value": "TR", + "name": "TR" }, { - "value": "TT" + "value": "TT", + "name": "TT" }, { - "value": "TV" + "value": "TV", + "name": "TV" }, { - "value": "TW" + "value": "TW", + "name": "TW" }, { - "value": "TZ" + "value": "TZ", + "name": "TZ" }, { - "value": "UA" + "value": "UA", + "name": "UA" }, { - "value": "UG" + "value": "UG", + "name": "UG" }, { - "value": "US" + "value": "US", + "name": "US" }, { - "value": "UY" + "value": "UY", + "name": "UY" }, { - "value": "UZ" + "value": "UZ", + "name": "UZ" }, { - "value": "VA" + "value": "VA", + "name": "VA" }, { - "value": "VC" + "value": "VC", + "name": "VC" }, { - "value": "VE" + "value": "VE", + "name": "VE" }, { - "value": "VG" + "value": "VG", + "name": "VG" }, { - "value": "VI" + "value": "VI", + "name": "VI" }, { - "value": "VN" + "value": "VN", + "name": "VN" }, { - "value": "VU" + "value": "VU", + "name": "VU" }, { - "value": "WF" + "value": "WF", + "name": "WF" }, { - "value": "WS" + "value": "WS", + "name": "WS" }, { - "value": "YE" + "value": "YE", + "name": "YE" }, { - "value": "YT" + "value": "YT", + "name": "YT" }, { - "value": "ZA" + "value": "ZA", + "name": "ZA" }, { - "value": "ZM" + "value": "ZM", + "name": "ZM" }, { - "value": "ZW" + "value": "ZW", + "name": "ZW" } ] } @@ -1315,28 +1549,36 @@ "traits": { "smithy.api#enum": [ { - "value": "AVAILABLE" + "value": "AVAILABLE", + "name": "AVAILABLE" }, { - "value": "AVAILABLE_RESERVED" + "value": "AVAILABLE_RESERVED", + "name": "AVAILABLE_RESERVED" }, { - "value": "AVAILABLE_PREORDER" + "value": "AVAILABLE_PREORDER", + "name": "AVAILABLE_PREORDER" }, { - "value": "UNAVAILABLE" + "value": "UNAVAILABLE", + "name": "UNAVAILABLE" }, { - "value": "UNAVAILABLE_PREMIUM" + "value": "UNAVAILABLE_PREMIUM", + "name": "UNAVAILABLE_PREMIUM" }, { - "value": "UNAVAILABLE_RESTRICTED" + "value": "UNAVAILABLE_RESTRICTED", + "name": "UNAVAILABLE_RESTRICTED" }, { - "value": "RESERVED" + "value": "RESERVED", + "name": "RESERVED" }, { - "value": "DONT_KNOW" + "value": "DONT_KNOW", + "name": "DONT_KNOW" } ] } @@ -2408,19 +2650,24 @@ "traits": { "smithy.api#enum": [ { - "value": "SUBMITTED" + "value": "SUBMITTED", + "name": "SUBMITTED" }, { - "value": "IN_PROGRESS" + "value": "IN_PROGRESS", + "name": "IN_PROGRESS" }, { - "value": "ERROR" + "value": "ERROR", + "name": "ERROR" }, { - "value": "SUCCESSFUL" + "value": "SUCCESSFUL", + "name": "SUCCESSFUL" }, { - "value": "FAILED" + "value": "FAILED", + "name": "FAILED" } ] } diff --git a/codegen/sdk-codegen/aws-models/s3.2006-03-01.json b/codegen/sdk-codegen/aws-models/s3.2006-03-01.json index ba09a05fafb..2e9c951a678 100644 --- a/codegen/sdk-codegen/aws-models/s3.2006-03-01.json +++ b/codegen/sdk-codegen/aws-models/s3.2006-03-01.json @@ -1,12687 +1,12845 @@ { - "smithy": "1.0", - "metadata": { - "suppressions": [ - { - "id": "HttpMethodSemantics", - "namespace": "*" - }, - { - "id": "HttpResponseCodeSemantics", - "namespace": "*" - }, - { - "id": "PaginatedTrait", - "namespace": "*" - }, - { - "id": "HttpHeaderTrait", - "namespace": "*" - }, - { - "id": "HttpUriConflict", - "namespace": "*" - }, - { - "id": "Service", - "namespace": "*" - } - ] - }, - "shapes": { - "com.amazonaws.s3#AbortDate": { - "type": "timestamp" - }, - "com.amazonaws.s3#AbortIncompleteMultipartUpload": { - "type": "structure", - "members": { - "DaysAfterInitiation": { - "target": "com.amazonaws.s3#DaysAfterInitiation", - "traits": { - "smithy.api#documentation": "

Specifies the number of days after which Amazon S3 aborts an incomplete multipart\n upload.

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

Specifies the days since the initiation of an incomplete multipart upload that Amazon S3 will\n wait before permanently removing all parts of the upload. For more information, see \n Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy in the\n Amazon Simple Storage Service Developer Guide.

" - } - }, - "com.amazonaws.s3#AbortMultipartUpload": { - "type": "operation", - "input": { - "target": "com.amazonaws.s3#AbortMultipartUploadRequest" - }, - "output": { - "target": "com.amazonaws.s3#AbortMultipartUploadOutput" - }, - "errors": [ - { - "target": "com.amazonaws.s3#NoSuchUpload" - } - ], - "traits": { - "smithy.api#documentation": "

This operation aborts a multipart upload. After a multipart upload is aborted, no\n additional parts can be uploaded using that upload ID. The storage consumed by any\n previously uploaded parts will be freed. However, if any part uploads are currently in\n progress, those part uploads might or might not succeed. As a result, it might be necessary\n to abort a given multipart upload multiple times in order to completely free all storage\n consumed by all parts.

\n

To verify that all parts have been removed, so you don't get charged for the part\n storage, you should call the ListParts operation and ensure that\n the parts list is empty.

\n

For information about permissions required to use the multipart upload API, see Multipart Upload API and\n Permissions.

\n

The following operations are related to AbortMultipartUpload:

\n ", - "smithy.api#http": { - "method": "DELETE", - "uri": "/{Bucket}/{Key+}?x-id=AbortMultipartUpload", - "code": 204 - } - } - }, - "com.amazonaws.s3#AbortMultipartUploadOutput": { - "type": "structure", - "members": { - "RequestCharged": { - "target": "com.amazonaws.s3#RequestCharged", - "traits": { - "smithy.api#httpHeader": "x-amz-request-charged" - } - } - } - }, - "com.amazonaws.s3#AbortMultipartUploadRequest": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

The bucket name to which the upload was taking place.

\n

When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.

\n

When using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Key": { - "target": "com.amazonaws.s3#ObjectKey", - "traits": { - "smithy.api#documentation": "

Key of the object for which the multipart upload was initiated.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "UploadId": { - "target": "com.amazonaws.s3#MultipartUploadId", - "traits": { - "smithy.api#documentation": "

Upload ID that identifies the multipart upload.

", - "smithy.api#httpQuery": "uploadId", - "smithy.api#required": {} - } - }, - "RequestPayer": { - "target": "com.amazonaws.s3#RequestPayer", - "traits": { - "smithy.api#httpHeader": "x-amz-request-payer" - } - }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", - "smithy.api#httpHeader": "x-amz-expected-bucket-owner" - } - } - } - }, - "com.amazonaws.s3#AbortRuleId": { - "type": "string" - }, - "com.amazonaws.s3#AccelerateConfiguration": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.s3#BucketAccelerateStatus", - "traits": { - "smithy.api#documentation": "

Specifies the transfer acceleration status of the bucket.

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

Configures the transfer acceleration state for an Amazon S3 bucket. For more information, see\n Amazon S3\n Transfer Acceleration in the Amazon Simple Storage Service Developer\n Guide.

" - } - }, - "com.amazonaws.s3#AcceptRanges": { - "type": "string" - }, - "com.amazonaws.s3#AccessControlPolicy": { - "type": "structure", - "members": { - "Grants": { - "target": "com.amazonaws.s3#Grants", - "traits": { - "smithy.api#documentation": "

A list of grants.

", - "smithy.api#xmlName": "AccessControlList" - } - }, - "Owner": { - "target": "com.amazonaws.s3#Owner", - "traits": { - "smithy.api#documentation": "

Container for the bucket owner's display name and ID.

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

Contains the elements that set the ACL permissions for an object per grantee.

" - } - }, - "com.amazonaws.s3#AccessControlTranslation": { - "type": "structure", - "members": { - "Owner": { - "target": "com.amazonaws.s3#OwnerOverride", - "traits": { - "smithy.api#documentation": "

Specifies the replica ownership. For default and valid values, see PUT bucket\n replication in the Amazon Simple Storage Service API Reference.

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

A container for information about access control for replicas.

" - } - }, - "com.amazonaws.s3#AccountId": { - "type": "string" - }, - "com.amazonaws.s3#AllowQuotedRecordDelimiter": { - "type": "boolean" - }, - "com.amazonaws.s3#AllowedHeader": { - "type": "string" - }, - "com.amazonaws.s3#AllowedHeaders": { - "type": "list", - "member": { - "target": "com.amazonaws.s3#AllowedHeader" - } - }, - "com.amazonaws.s3#AllowedMethod": { - "type": "string" - }, - "com.amazonaws.s3#AllowedMethods": { - "type": "list", - "member": { - "target": "com.amazonaws.s3#AllowedMethod" - } - }, - "com.amazonaws.s3#AllowedOrigin": { - "type": "string" - }, - "com.amazonaws.s3#AllowedOrigins": { - "type": "list", - "member": { - "target": "com.amazonaws.s3#AllowedOrigin" - } + "smithy": "1.0", + "metadata": { + "suppressions": [ + { + "id": "HttpMethodSemantics", + "namespace": "*" + }, + { + "id": "HttpResponseCodeSemantics", + "namespace": "*" + }, + { + "id": "PaginatedTrait", + "namespace": "*" + }, + { + "id": "HttpHeaderTrait", + "namespace": "*" + }, + { + "id": "HttpUriConflict", + "namespace": "*" + }, + { + "id": "Service", + "namespace": "*" + } + ] }, - "com.amazonaws.s3#AmazonS3": { - "type": "service", - "version": "2006-03-01", - "operations": [ - { - "target": "com.amazonaws.s3#AbortMultipartUpload" - }, - { - "target": "com.amazonaws.s3#CompleteMultipartUpload" - }, - { - "target": "com.amazonaws.s3#CopyObject" - }, - { - "target": "com.amazonaws.s3#CreateBucket" - }, - { - "target": "com.amazonaws.s3#CreateMultipartUpload" - }, - { - "target": "com.amazonaws.s3#DeleteBucket" - }, - { - "target": "com.amazonaws.s3#DeleteBucketAnalyticsConfiguration" - }, - { - "target": "com.amazonaws.s3#DeleteBucketCors" - }, - { - "target": "com.amazonaws.s3#DeleteBucketEncryption" - }, - { - "target": "com.amazonaws.s3#DeleteBucketIntelligentTieringConfiguration" - }, - { - "target": "com.amazonaws.s3#DeleteBucketInventoryConfiguration" - }, - { - "target": "com.amazonaws.s3#DeleteBucketLifecycle" - }, - { - "target": "com.amazonaws.s3#DeleteBucketMetricsConfiguration" - }, - { - "target": "com.amazonaws.s3#DeleteBucketOwnershipControls" - }, - { - "target": "com.amazonaws.s3#DeleteBucketPolicy" - }, - { - "target": "com.amazonaws.s3#DeleteBucketReplication" - }, - { - "target": "com.amazonaws.s3#DeleteBucketTagging" - }, - { - "target": "com.amazonaws.s3#DeleteBucketWebsite" - }, - { - "target": "com.amazonaws.s3#DeleteObject" - }, - { - "target": "com.amazonaws.s3#DeleteObjects" - }, - { - "target": "com.amazonaws.s3#DeleteObjectTagging" - }, - { - "target": "com.amazonaws.s3#DeletePublicAccessBlock" - }, - { - "target": "com.amazonaws.s3#GetBucketAccelerateConfiguration" - }, - { - "target": "com.amazonaws.s3#GetBucketAcl" - }, - { - "target": "com.amazonaws.s3#GetBucketAnalyticsConfiguration" - }, - { - "target": "com.amazonaws.s3#GetBucketCors" - }, - { - "target": "com.amazonaws.s3#GetBucketEncryption" - }, - { - "target": "com.amazonaws.s3#GetBucketIntelligentTieringConfiguration" - }, - { - "target": "com.amazonaws.s3#GetBucketInventoryConfiguration" - }, - { - "target": "com.amazonaws.s3#GetBucketLifecycleConfiguration" - }, - { - "target": "com.amazonaws.s3#GetBucketLocation" - }, - { - "target": "com.amazonaws.s3#GetBucketLogging" - }, - { - "target": "com.amazonaws.s3#GetBucketMetricsConfiguration" - }, - { - "target": "com.amazonaws.s3#GetBucketNotificationConfiguration" + "shapes": { + "com.amazonaws.s3#AbortDate": { + "type": "timestamp" + }, + "com.amazonaws.s3#AbortIncompleteMultipartUpload": { + "type": "structure", + "members": { + "DaysAfterInitiation": { + "target": "com.amazonaws.s3#DaysAfterInitiation", + "traits": { + "smithy.api#documentation": "

Specifies the number of days after which Amazon S3 aborts an incomplete multipart\n upload.

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

Specifies the days since the initiation of an incomplete multipart upload that Amazon S3 will\n wait before permanently removing all parts of the upload. For more information, see \n Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy in the\n Amazon Simple Storage Service Developer Guide.

" + } + }, + "com.amazonaws.s3#AbortMultipartUpload": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#AbortMultipartUploadRequest" + }, + "output": { + "target": "com.amazonaws.s3#AbortMultipartUploadOutput" + }, + "errors": [ + { + "target": "com.amazonaws.s3#NoSuchUpload" + } + ], + "traits": { + "smithy.api#documentation": "

This operation aborts a multipart upload. After a multipart upload is aborted, no\n additional parts can be uploaded using that upload ID. The storage consumed by any\n previously uploaded parts will be freed. However, if any part uploads are currently in\n progress, those part uploads might or might not succeed. As a result, it might be necessary\n to abort a given multipart upload multiple times in order to completely free all storage\n consumed by all parts.

\n

To verify that all parts have been removed, so you don't get charged for the part\n storage, you should call the ListParts operation and ensure that\n the parts list is empty.

\n

For information about permissions required to use the multipart upload API, see Multipart Upload API and\n Permissions.

\n

The following operations are related to AbortMultipartUpload:

\n ", + "smithy.api#http": { + "method": "DELETE", + "uri": "/{Bucket}/{Key+}?x-id=AbortMultipartUpload", + "code": 204 + } + } + }, + "com.amazonaws.s3#AbortMultipartUploadOutput": { + "type": "structure", + "members": { + "RequestCharged": { + "target": "com.amazonaws.s3#RequestCharged", + "traits": { + "smithy.api#httpHeader": "x-amz-request-charged" + } + } + } + }, + "com.amazonaws.s3#AbortMultipartUploadRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The bucket name to which the upload was taking place.

\n

When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.

\n

When using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Key": { + "target": "com.amazonaws.s3#ObjectKey", + "traits": { + "smithy.api#documentation": "

Key of the object for which the multipart upload was initiated.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "UploadId": { + "target": "com.amazonaws.s3#MultipartUploadId", + "traits": { + "smithy.api#documentation": "

Upload ID that identifies the multipart upload.

", + "smithy.api#httpQuery": "uploadId", + "smithy.api#required": {} + } + }, + "RequestPayer": { + "target": "com.amazonaws.s3#RequestPayer", + "traits": { + "smithy.api#httpHeader": "x-amz-request-payer" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + } + }, + "com.amazonaws.s3#AbortRuleId": { + "type": "string" + }, + "com.amazonaws.s3#AccelerateConfiguration": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.s3#BucketAccelerateStatus", + "traits": { + "smithy.api#documentation": "

Specifies the transfer acceleration status of the bucket.

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

Configures the transfer acceleration state for an Amazon S3 bucket. For more information, see\n Amazon S3\n Transfer Acceleration in the Amazon Simple Storage Service Developer\n Guide.

" + } + }, + "com.amazonaws.s3#AcceptRanges": { + "type": "string" + }, + "com.amazonaws.s3#AccessControlPolicy": { + "type": "structure", + "members": { + "Grants": { + "target": "com.amazonaws.s3#Grants", + "traits": { + "smithy.api#documentation": "

A list of grants.

", + "smithy.api#xmlName": "AccessControlList" + } + }, + "Owner": { + "target": "com.amazonaws.s3#Owner", + "traits": { + "smithy.api#documentation": "

Container for the bucket owner's display name and ID.

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

Contains the elements that set the ACL permissions for an object per grantee.

" + } + }, + "com.amazonaws.s3#AccessControlTranslation": { + "type": "structure", + "members": { + "Owner": { + "target": "com.amazonaws.s3#OwnerOverride", + "traits": { + "smithy.api#documentation": "

Specifies the replica ownership. For default and valid values, see PUT bucket\n replication in the Amazon Simple Storage Service API Reference.

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

A container for information about access control for replicas.

" + } + }, + "com.amazonaws.s3#AccountId": { + "type": "string" + }, + "com.amazonaws.s3#AllowQuotedRecordDelimiter": { + "type": "boolean" + }, + "com.amazonaws.s3#AllowedHeader": { + "type": "string" + }, + "com.amazonaws.s3#AllowedHeaders": { + "type": "list", + "member": { + "target": "com.amazonaws.s3#AllowedHeader" + } + }, + "com.amazonaws.s3#AllowedMethod": { + "type": "string" + }, + "com.amazonaws.s3#AllowedMethods": { + "type": "list", + "member": { + "target": "com.amazonaws.s3#AllowedMethod" + } + }, + "com.amazonaws.s3#AllowedOrigin": { + "type": "string" + }, + "com.amazonaws.s3#AllowedOrigins": { + "type": "list", + "member": { + "target": "com.amazonaws.s3#AllowedOrigin" + } + }, + "com.amazonaws.s3#AmazonS3": { + "type": "service", + "version": "2006-03-01", + "operations": [ + { + "target": "com.amazonaws.s3#AbortMultipartUpload" + }, + { + "target": "com.amazonaws.s3#CompleteMultipartUpload" + }, + { + "target": "com.amazonaws.s3#CopyObject" + }, + { + "target": "com.amazonaws.s3#CreateBucket" + }, + { + "target": "com.amazonaws.s3#CreateMultipartUpload" + }, + { + "target": "com.amazonaws.s3#DeleteBucket" + }, + { + "target": "com.amazonaws.s3#DeleteBucketAnalyticsConfiguration" + }, + { + "target": "com.amazonaws.s3#DeleteBucketCors" + }, + { + "target": "com.amazonaws.s3#DeleteBucketEncryption" + }, + { + "target": "com.amazonaws.s3#DeleteBucketIntelligentTieringConfiguration" + }, + { + "target": "com.amazonaws.s3#DeleteBucketInventoryConfiguration" + }, + { + "target": "com.amazonaws.s3#DeleteBucketLifecycle" + }, + { + "target": "com.amazonaws.s3#DeleteBucketMetricsConfiguration" + }, + { + "target": "com.amazonaws.s3#DeleteBucketOwnershipControls" + }, + { + "target": "com.amazonaws.s3#DeleteBucketPolicy" + }, + { + "target": "com.amazonaws.s3#DeleteBucketReplication" + }, + { + "target": "com.amazonaws.s3#DeleteBucketTagging" + }, + { + "target": "com.amazonaws.s3#DeleteBucketWebsite" + }, + { + "target": "com.amazonaws.s3#DeleteObject" + }, + { + "target": "com.amazonaws.s3#DeleteObjects" + }, + { + "target": "com.amazonaws.s3#DeleteObjectTagging" + }, + { + "target": "com.amazonaws.s3#DeletePublicAccessBlock" + }, + { + "target": "com.amazonaws.s3#GetBucketAccelerateConfiguration" + }, + { + "target": "com.amazonaws.s3#GetBucketAcl" + }, + { + "target": "com.amazonaws.s3#GetBucketAnalyticsConfiguration" + }, + { + "target": "com.amazonaws.s3#GetBucketCors" + }, + { + "target": "com.amazonaws.s3#GetBucketEncryption" + }, + { + "target": "com.amazonaws.s3#GetBucketIntelligentTieringConfiguration" + }, + { + "target": "com.amazonaws.s3#GetBucketInventoryConfiguration" + }, + { + "target": "com.amazonaws.s3#GetBucketLifecycleConfiguration" + }, + { + "target": "com.amazonaws.s3#GetBucketLocation" + }, + { + "target": "com.amazonaws.s3#GetBucketLogging" + }, + { + "target": "com.amazonaws.s3#GetBucketMetricsConfiguration" + }, + { + "target": "com.amazonaws.s3#GetBucketNotificationConfiguration" + }, + { + "target": "com.amazonaws.s3#GetBucketOwnershipControls" + }, + { + "target": "com.amazonaws.s3#GetBucketPolicy" + }, + { + "target": "com.amazonaws.s3#GetBucketPolicyStatus" + }, + { + "target": "com.amazonaws.s3#GetBucketReplication" + }, + { + "target": "com.amazonaws.s3#GetBucketRequestPayment" + }, + { + "target": "com.amazonaws.s3#GetBucketTagging" + }, + { + "target": "com.amazonaws.s3#GetBucketVersioning" + }, + { + "target": "com.amazonaws.s3#GetBucketWebsite" + }, + { + "target": "com.amazonaws.s3#GetObject" + }, + { + "target": "com.amazonaws.s3#GetObjectAcl" + }, + { + "target": "com.amazonaws.s3#GetObjectLegalHold" + }, + { + "target": "com.amazonaws.s3#GetObjectLockConfiguration" + }, + { + "target": "com.amazonaws.s3#GetObjectRetention" + }, + { + "target": "com.amazonaws.s3#GetObjectTagging" + }, + { + "target": "com.amazonaws.s3#GetObjectTorrent" + }, + { + "target": "com.amazonaws.s3#GetPublicAccessBlock" + }, + { + "target": "com.amazonaws.s3#HeadBucket" + }, + { + "target": "com.amazonaws.s3#HeadObject" + }, + { + "target": "com.amazonaws.s3#ListBucketAnalyticsConfigurations" + }, + { + "target": "com.amazonaws.s3#ListBucketIntelligentTieringConfigurations" + }, + { + "target": "com.amazonaws.s3#ListBucketInventoryConfigurations" + }, + { + "target": "com.amazonaws.s3#ListBucketMetricsConfigurations" + }, + { + "target": "com.amazonaws.s3#ListBuckets" + }, + { + "target": "com.amazonaws.s3#ListMultipartUploads" + }, + { + "target": "com.amazonaws.s3#ListObjects" + }, + { + "target": "com.amazonaws.s3#ListObjectsV2" + }, + { + "target": "com.amazonaws.s3#ListObjectVersions" + }, + { + "target": "com.amazonaws.s3#ListParts" + }, + { + "target": "com.amazonaws.s3#PutBucketAccelerateConfiguration" + }, + { + "target": "com.amazonaws.s3#PutBucketAcl" + }, + { + "target": "com.amazonaws.s3#PutBucketAnalyticsConfiguration" + }, + { + "target": "com.amazonaws.s3#PutBucketCors" + }, + { + "target": "com.amazonaws.s3#PutBucketEncryption" + }, + { + "target": "com.amazonaws.s3#PutBucketIntelligentTieringConfiguration" + }, + { + "target": "com.amazonaws.s3#PutBucketInventoryConfiguration" + }, + { + "target": "com.amazonaws.s3#PutBucketLifecycleConfiguration" + }, + { + "target": "com.amazonaws.s3#PutBucketLogging" + }, + { + "target": "com.amazonaws.s3#PutBucketMetricsConfiguration" + }, + { + "target": "com.amazonaws.s3#PutBucketNotificationConfiguration" + }, + { + "target": "com.amazonaws.s3#PutBucketOwnershipControls" + }, + { + "target": "com.amazonaws.s3#PutBucketPolicy" + }, + { + "target": "com.amazonaws.s3#PutBucketReplication" + }, + { + "target": "com.amazonaws.s3#PutBucketRequestPayment" + }, + { + "target": "com.amazonaws.s3#PutBucketTagging" + }, + { + "target": "com.amazonaws.s3#PutBucketVersioning" + }, + { + "target": "com.amazonaws.s3#PutBucketWebsite" + }, + { + "target": "com.amazonaws.s3#PutObject" + }, + { + "target": "com.amazonaws.s3#PutObjectAcl" + }, + { + "target": "com.amazonaws.s3#PutObjectLegalHold" + }, + { + "target": "com.amazonaws.s3#PutObjectLockConfiguration" + }, + { + "target": "com.amazonaws.s3#PutObjectRetention" + }, + { + "target": "com.amazonaws.s3#PutObjectTagging" + }, + { + "target": "com.amazonaws.s3#PutPublicAccessBlock" + }, + { + "target": "com.amazonaws.s3#RestoreObject" + }, + { + "target": "com.amazonaws.s3#SelectObjectContent" + }, + { + "target": "com.amazonaws.s3#UploadPart" + }, + { + "target": "com.amazonaws.s3#UploadPartCopy" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "S3", + "arnNamespace": "s3", + "cloudFormationName": "S3", + "cloudTrailEventSource": "s3.amazonaws.com", + "endpointPrefix": "s3" + }, + "aws.auth#sigv4": { + "name": "s3" + }, + "aws.protocols#restXml": { + "noErrorWrapping": true + }, + "smithy.api#documentation": "

", + "smithy.api#title": "Amazon Simple Storage Service", + "smithy.api#xmlNamespace": { + "uri": "http://s3.amazonaws.com/doc/2006-03-01/" + } + } + }, + "com.amazonaws.s3#AnalyticsAndOperator": { + "type": "structure", + "members": { + "Prefix": { + "target": "com.amazonaws.s3#Prefix", + "traits": { + "smithy.api#documentation": "

The prefix to use when evaluating an AND predicate: The prefix that an object must have\n to be included in the metrics results.

" + } + }, + "Tags": { + "target": "com.amazonaws.s3#TagSet", + "traits": { + "smithy.api#documentation": "

The list of tags to use when evaluating an AND predicate.

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

A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter.\n The operator must have at least two predicates in any combination, and an object must match\n all of the predicates for the filter to apply.

" + } + }, + "com.amazonaws.s3#AnalyticsConfiguration": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.s3#AnalyticsId", + "traits": { + "smithy.api#documentation": "

The ID that identifies the analytics configuration.

", + "smithy.api#required": {} + } + }, + "Filter": { + "target": "com.amazonaws.s3#AnalyticsFilter", + "traits": { + "smithy.api#documentation": "

The filter used to describe a set of objects for analyses. A filter must have exactly\n one prefix, one tag, or one conjunction (AnalyticsAndOperator). If no filter is provided,\n all objects will be considered in any analysis.

" + } + }, + "StorageClassAnalysis": { + "target": "com.amazonaws.s3#StorageClassAnalysis", + "traits": { + "smithy.api#documentation": "

Contains data related to access patterns to be collected and made available to analyze\n the tradeoffs between different storage classes.

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

Specifies the configuration and any analyses for the analytics filter of an Amazon S3\n bucket.

" + } + }, + "com.amazonaws.s3#AnalyticsConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.s3#AnalyticsConfiguration" + } + }, + "com.amazonaws.s3#AnalyticsExportDestination": { + "type": "structure", + "members": { + "S3BucketDestination": { + "target": "com.amazonaws.s3#AnalyticsS3BucketDestination", + "traits": { + "smithy.api#documentation": "

A destination signifying output to an S3 bucket.

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

Where to publish the analytics results.

" + } + }, + "com.amazonaws.s3#AnalyticsFilter": { + "type": "union", + "members": { + "Prefix": { + "target": "com.amazonaws.s3#Prefix", + "traits": { + "smithy.api#documentation": "

The prefix to use when evaluating an analytics filter.

" + } + }, + "Tag": { + "target": "com.amazonaws.s3#Tag", + "traits": { + "smithy.api#documentation": "

The tag to use when evaluating an analytics filter.

" + } + }, + "And": { + "target": "com.amazonaws.s3#AnalyticsAndOperator", + "traits": { + "smithy.api#documentation": "

A conjunction (logical AND) of predicates, which is used in evaluating an analytics\n filter. The operator must have at least two predicates.

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

The filter used to describe a set of objects for analyses. A filter must have exactly\n one prefix, one tag, or one conjunction (AnalyticsAndOperator). If no filter is provided,\n all objects will be considered in any analysis.

" + } + }, + "com.amazonaws.s3#AnalyticsId": { + "type": "string" + }, + "com.amazonaws.s3#AnalyticsS3BucketDestination": { + "type": "structure", + "members": { + "Format": { + "target": "com.amazonaws.s3#AnalyticsS3ExportFileFormat", + "traits": { + "smithy.api#documentation": "

Specifies the file format used when exporting data to Amazon S3.

", + "smithy.api#required": {} + } + }, + "BucketAccountId": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID that owns the destination S3 bucket. If no account ID is provided, the\n owner is not validated before exporting data.

\n \n

Although this value is optional, we strongly recommend that you set it to help\n prevent problems if the destination bucket ownership changes.

\n " + } + }, + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the bucket to which data is exported.

", + "smithy.api#required": {} + } + }, + "Prefix": { + "target": "com.amazonaws.s3#Prefix", + "traits": { + "smithy.api#documentation": "

The prefix to use when exporting data. The prefix is prepended to all results.

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

Contains information about where to publish the analytics results.

" + } + }, + "com.amazonaws.s3#AnalyticsS3ExportFileFormat": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CSV", + "name": "CSV" + } + ] + } + }, + "com.amazonaws.s3#ArchiveStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ARCHIVE_ACCESS", + "name": "ARCHIVE_ACCESS" + }, + { + "value": "DEEP_ARCHIVE_ACCESS", + "name": "DEEP_ARCHIVE_ACCESS" + } + ] + } + }, + "com.amazonaws.s3#Body": { + "type": "blob" + }, + "com.amazonaws.s3#Bucket": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket.

" + } + }, + "CreationDate": { + "target": "com.amazonaws.s3#CreationDate", + "traits": { + "smithy.api#documentation": "

Date the bucket was created. This date can change when making changes to your bucket, such as editing its bucket policy.

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

In terms of implementation, a Bucket is a resource. An Amazon S3 bucket name is globally\n unique, and the namespace is shared by all AWS accounts.

" + } + }, + "com.amazonaws.s3#BucketAccelerateStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Enabled", + "name": "Enabled" + }, + { + "value": "Suspended", + "name": "Suspended" + } + ] + } + }, + "com.amazonaws.s3#BucketAlreadyExists": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

The requested bucket name is not available. The bucket namespace is shared by all users\n of the system. Select a different name and try again.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.s3#BucketAlreadyOwnedByYou": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

The bucket you tried to create already exists, and you own it. Amazon S3 returns this error\n in all AWS Regions except in the North Virginia Region. For legacy compatibility, if you\n re-create an existing bucket that you already own in the North Virginia Region, Amazon S3\n returns 200 OK and resets the bucket access control lists (ACLs).

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.s3#BucketCannedACL": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "private", + "name": "private" + }, + { + "value": "public-read", + "name": "public_read" + }, + { + "value": "public-read-write", + "name": "public_read_write" + }, + { + "value": "authenticated-read", + "name": "authenticated_read" + } + ] + } + }, + "com.amazonaws.s3#BucketKeyEnabled": { + "type": "boolean" + }, + "com.amazonaws.s3#BucketLifecycleConfiguration": { + "type": "structure", + "members": { + "Rules": { + "target": "com.amazonaws.s3#LifecycleRules", + "traits": { + "smithy.api#documentation": "

A lifecycle rule for individual objects in an Amazon S3 bucket.

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

Specifies the lifecycle configuration for objects in an Amazon S3 bucket. For more\n information, see Object Lifecycle Management\n in the Amazon Simple Storage Service Developer Guide.

" + } + }, + "com.amazonaws.s3#BucketLocationConstraint": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "af-south-1", + "name": "af_south_1" + }, + { + "value": "ap-east-1", + "name": "ap_east_1" + }, + { + "value": "ap-northeast-1", + "name": "ap_northeast_1" + }, + { + "value": "ap-northeast-2", + "name": "ap_northeast_2" + }, + { + "value": "ap-northeast-3", + "name": "ap_northeast_3" + }, + { + "value": "ap-south-1", + "name": "ap_south_1" + }, + { + "value": "ap-southeast-1", + "name": "ap_southeast_1" + }, + { + "value": "ap-southeast-2", + "name": "ap_southeast_2" + }, + { + "value": "ca-central-1", + "name": "ca_central_1" + }, + { + "value": "cn-north-1", + "name": "cn_north_1" + }, + { + "value": "cn-northwest-1", + "name": "cn_northwest_1" + }, + { + "value": "EU", + "name": "EU" + }, + { + "value": "eu-central-1", + "name": "eu_central_1" + }, + { + "value": "eu-north-1", + "name": "eu_north_1" + }, + { + "value": "eu-south-1", + "name": "eu_south_1" + }, + { + "value": "eu-west-1", + "name": "eu_west_1" + }, + { + "value": "eu-west-2", + "name": "eu_west_2" + }, + { + "value": "eu-west-3", + "name": "eu_west_3" + }, + { + "value": "me-south-1", + "name": "me_south_1" + }, + { + "value": "sa-east-1", + "name": "sa_east_1" + }, + { + "value": "us-east-2", + "name": "us_east_2" + }, + { + "value": "us-gov-east-1", + "name": "us_gov_east_1" + }, + { + "value": "us-gov-west-1", + "name": "us_gov_west_1" + }, + { + "value": "us-west-1", + "name": "us_west_1" + }, + { + "value": "us-west-2", + "name": "us_west_2" + } + ] + } + }, + "com.amazonaws.s3#BucketLoggingStatus": { + "type": "structure", + "members": { + "LoggingEnabled": { + "target": "com.amazonaws.s3#LoggingEnabled" + } + }, + "traits": { + "smithy.api#documentation": "

Container for logging status information.

" + } + }, + "com.amazonaws.s3#BucketLogsPermission": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "FULL_CONTROL", + "name": "FULL_CONTROL" + }, + { + "value": "READ", + "name": "READ" + }, + { + "value": "WRITE", + "name": "WRITE" + } + ] + } + }, + "com.amazonaws.s3#BucketName": { + "type": "string" + }, + "com.amazonaws.s3#BucketVersioningStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Enabled", + "name": "Enabled" + }, + { + "value": "Suspended", + "name": "Suspended" + } + ] + } + }, + "com.amazonaws.s3#Buckets": { + "type": "list", + "member": { + "target": "com.amazonaws.s3#Bucket", + "traits": { + "smithy.api#xmlName": "Bucket" + } + } + }, + "com.amazonaws.s3#BypassGovernanceRetention": { + "type": "boolean" + }, + "com.amazonaws.s3#BytesProcessed": { + "type": "long" + }, + "com.amazonaws.s3#BytesReturned": { + "type": "long" + }, + "com.amazonaws.s3#BytesScanned": { + "type": "long" + }, + "com.amazonaws.s3#CORSConfiguration": { + "type": "structure", + "members": { + "CORSRules": { + "target": "com.amazonaws.s3#CORSRules", + "traits": { + "smithy.api#documentation": "

A set of origins and methods (cross-origin access that you want to allow). You can add\n up to 100 rules to the configuration.

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

Describes the cross-origin access configuration for objects in an Amazon S3 bucket. For more\n information, see Enabling\n Cross-Origin Resource Sharing in the Amazon Simple Storage Service Developer\n Guide.

" + } + }, + "com.amazonaws.s3#CORSRule": { + "type": "structure", + "members": { + "AllowedHeaders": { + "target": "com.amazonaws.s3#AllowedHeaders", + "traits": { + "smithy.api#documentation": "

Headers that are specified in the Access-Control-Request-Headers header.\n These headers are allowed in a preflight OPTIONS request. In response to any preflight\n OPTIONS request, Amazon S3 returns any requested headers that are allowed.

", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "AllowedHeader" + } + }, + "AllowedMethods": { + "target": "com.amazonaws.s3#AllowedMethods", + "traits": { + "smithy.api#documentation": "

An HTTP method that you allow the origin to execute. Valid values are GET,\n PUT, HEAD, POST, and DELETE.

", + "smithy.api#required": {}, + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "AllowedMethod" + } + }, + "AllowedOrigins": { + "target": "com.amazonaws.s3#AllowedOrigins", + "traits": { + "smithy.api#documentation": "

One or more origins you want customers to be able to access the bucket from.

", + "smithy.api#required": {}, + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "AllowedOrigin" + } + }, + "ExposeHeaders": { + "target": "com.amazonaws.s3#ExposeHeaders", + "traits": { + "smithy.api#documentation": "

One or more headers in the response that you want customers to be able to access from\n their applications (for example, from a JavaScript XMLHttpRequest\n object).

", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "ExposeHeader" + } + }, + "MaxAgeSeconds": { + "target": "com.amazonaws.s3#MaxAgeSeconds", + "traits": { + "smithy.api#documentation": "

The time in seconds that your browser is to cache the preflight response for the\n specified resource.

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

Specifies a cross-origin access rule for an Amazon S3 bucket.

" + } + }, + "com.amazonaws.s3#CORSRules": { + "type": "list", + "member": { + "target": "com.amazonaws.s3#CORSRule" + } + }, + "com.amazonaws.s3#CSVInput": { + "type": "structure", + "members": { + "FileHeaderInfo": { + "target": "com.amazonaws.s3#FileHeaderInfo", + "traits": { + "smithy.api#documentation": "

Describes the first line of input. Valid values are:

\n " + } + }, + "Comments": { + "target": "com.amazonaws.s3#Comments", + "traits": { + "smithy.api#documentation": "

A single character used to indicate that a row should be ignored when the character is\n present at the start of that row. You can specify any character to indicate a comment\n line.

" + } + }, + "QuoteEscapeCharacter": { + "target": "com.amazonaws.s3#QuoteEscapeCharacter", + "traits": { + "smithy.api#documentation": "

A single character used for escaping the quotation mark character inside an already\n escaped value. For example, the value \"\"\" a , b \"\"\" is parsed as \" a , b \".

" + } + }, + "RecordDelimiter": { + "target": "com.amazonaws.s3#RecordDelimiter", + "traits": { + "smithy.api#documentation": "

A single character used to separate individual records in the input. Instead of the\n default value, you can specify an arbitrary delimiter.

" + } + }, + "FieldDelimiter": { + "target": "com.amazonaws.s3#FieldDelimiter", + "traits": { + "smithy.api#documentation": "

A single character used to separate individual fields in a record. You can specify an\n arbitrary delimiter.

" + } + }, + "QuoteCharacter": { + "target": "com.amazonaws.s3#QuoteCharacter", + "traits": { + "smithy.api#documentation": "

A single character used for escaping when the field delimiter is part of the value. For\n example, if the value is a, b, Amazon S3 wraps this field value in quotation marks,\n as follows: \" a , b \".

\n

Type: String

\n

Default: \"\n

\n

Ancestors: CSV\n

" + } + }, + "AllowQuotedRecordDelimiter": { + "target": "com.amazonaws.s3#AllowQuotedRecordDelimiter", + "traits": { + "smithy.api#documentation": "

Specifies that CSV field values may contain quoted record delimiters and such records\n should be allowed. Default value is FALSE. Setting this value to TRUE may lower\n performance.

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

Describes how an uncompressed comma-separated values (CSV)-formatted input object is\n formatted.

" + } + }, + "com.amazonaws.s3#CSVOutput": { + "type": "structure", + "members": { + "QuoteFields": { + "target": "com.amazonaws.s3#QuoteFields", + "traits": { + "smithy.api#documentation": "

Indicates whether to use quotation marks around output fields.

\n " + } + }, + "QuoteEscapeCharacter": { + "target": "com.amazonaws.s3#QuoteEscapeCharacter", + "traits": { + "smithy.api#documentation": "

The single character used for escaping the quote character inside an already escaped\n value.

" + } + }, + "RecordDelimiter": { + "target": "com.amazonaws.s3#RecordDelimiter", + "traits": { + "smithy.api#documentation": "

A single character used to separate individual records in the output. Instead of the\n default value, you can specify an arbitrary delimiter.

" + } + }, + "FieldDelimiter": { + "target": "com.amazonaws.s3#FieldDelimiter", + "traits": { + "smithy.api#documentation": "

The value used to separate individual fields in a record. You can specify an arbitrary\n delimiter.

" + } + }, + "QuoteCharacter": { + "target": "com.amazonaws.s3#QuoteCharacter", + "traits": { + "smithy.api#documentation": "

A single character used for escaping when the field delimiter is part of the value. For\n example, if the value is a, b, Amazon S3 wraps this field value in quotation marks,\n as follows: \" a , b \".

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

Describes how uncompressed comma-separated values (CSV)-formatted results are\n formatted.

" + } + }, + "com.amazonaws.s3#CacheControl": { + "type": "string" + }, + "com.amazonaws.s3#Code": { + "type": "string" + }, + "com.amazonaws.s3#Comments": { + "type": "string" + }, + "com.amazonaws.s3#CommonPrefix": { + "type": "structure", + "members": { + "Prefix": { + "target": "com.amazonaws.s3#Prefix", + "traits": { + "smithy.api#documentation": "

Container for the specified common prefix.

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

Container for all (if there are any) keys between Prefix and the next occurrence of the\n string specified by a delimiter. CommonPrefixes lists keys that act like subdirectories in\n the directory specified by Prefix. For example, if the prefix is notes/ and the delimiter\n is a slash (/) as in notes/summer/july, the common prefix is notes/summer/.

" + } + }, + "com.amazonaws.s3#CommonPrefixList": { + "type": "list", + "member": { + "target": "com.amazonaws.s3#CommonPrefix" + } + }, + "com.amazonaws.s3#CompleteMultipartUpload": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#CompleteMultipartUploadRequest" + }, + "output": { + "target": "com.amazonaws.s3#CompleteMultipartUploadOutput" + }, + "traits": { + "smithy.api#documentation": "

Completes a multipart upload by assembling previously uploaded parts.

\n

You first initiate the multipart upload and then upload all parts using the UploadPart\n operation. After successfully uploading all relevant parts of an upload, you call this\n operation to complete the upload. Upon receiving this request, Amazon S3 concatenates all\n the parts in ascending order by part number to create a new object. In the Complete\n Multipart Upload request, you must provide the parts list. You must ensure that the parts\n list is complete. This operation concatenates the parts that you provide in the list. For\n each part in the list, you must provide the part number and the ETag value,\n returned after that part was uploaded.

\n

Processing of a Complete Multipart Upload request could take several minutes to\n complete. After Amazon S3 begins processing the request, it sends an HTTP response header that\n specifies a 200 OK response. While processing is in progress, Amazon S3 periodically sends white\n space characters to keep the connection from timing out. Because a request could fail after\n the initial 200 OK response has been sent, it is important that you check the response body\n to determine whether the request succeeded.

\n

Note that if CompleteMultipartUpload fails, applications should be prepared\n to retry the failed requests. For more information, see Amazon S3 Error Best Practices.

\n

For more information about multipart uploads, see Uploading Objects Using Multipart\n Upload.

\n

For information about permissions required to use the multipart upload API, see Multipart Upload API and\n Permissions.

\n\n\n

\n CompleteMultipartUpload has the following special errors:

\n \n\n

The following operations are related to CompleteMultipartUpload:

\n ", + "smithy.api#http": { + "method": "POST", + "uri": "/{Bucket}/{Key+}", + "code": 200 + } + } + }, + "com.amazonaws.s3#CompleteMultipartUploadOutput": { + "type": "structure", + "members": { + "Location": { + "target": "com.amazonaws.s3#Location", + "traits": { + "smithy.api#documentation": "

The URI that identifies the newly created object.

" + } + }, + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket that contains the newly created object.

\n

When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.

\n

When using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.

" + } + }, + "Key": { + "target": "com.amazonaws.s3#ObjectKey", + "traits": { + "smithy.api#documentation": "

The object key of the newly created object.

" + } + }, + "Expiration": { + "target": "com.amazonaws.s3#Expiration", + "traits": { + "smithy.api#documentation": "

If the object expiration is configured, this will contain the expiration date\n (expiry-date) and rule ID (rule-id). The value of rule-id is URL encoded.

", + "smithy.api#httpHeader": "x-amz-expiration" + } + }, + "ETag": { + "target": "com.amazonaws.s3#ETag", + "traits": { + "smithy.api#documentation": "

Entity tag that identifies the newly created object's data. Objects with different\n object data will have different entity tags. The entity tag is an opaque string. The entity\n tag may or may not be an MD5 digest of the object data. If the entity tag is not an MD5\n digest of the object data, it will contain one or more nonhexadecimal characters and/or\n will consist of less than 32 or more than 32 hexadecimal digits.

" + } + }, + "ServerSideEncryption": { + "target": "com.amazonaws.s3#ServerSideEncryption", + "traits": { + "smithy.api#documentation": "

If you specified server-side encryption either with an Amazon S3-managed encryption key or an\n AWS KMS customer master key (CMK) in your initiate multipart upload request, the response\n includes this header. It confirms the encryption algorithm that Amazon S3 used to encrypt the\n object.

", + "smithy.api#httpHeader": "x-amz-server-side-encryption" + } + }, + "VersionId": { + "target": "com.amazonaws.s3#ObjectVersionId", + "traits": { + "smithy.api#documentation": "

Version ID of the newly created object, in case the bucket has versioning turned\n on.

", + "smithy.api#httpHeader": "x-amz-version-id" + } + }, + "SSEKMSKeyId": { + "target": "com.amazonaws.s3#SSEKMSKeyId", + "traits": { + "smithy.api#documentation": "

If present, specifies the ID of the AWS Key Management Service (AWS KMS) symmetric\n customer managed customer master key (CMK) that was used for the object.

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" + } + }, + "BucketKeyEnabled": { + "target": "com.amazonaws.s3#BucketKeyEnabled", + "traits": { + "smithy.api#documentation": "

Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with AWS KMS (SSE-KMS).

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-bucket-key-enabled" + } + }, + "RequestCharged": { + "target": "com.amazonaws.s3#RequestCharged", + "traits": { + "smithy.api#httpHeader": "x-amz-request-charged" + } + } + } + }, + "com.amazonaws.s3#CompleteMultipartUploadRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

Name of the bucket to which the multipart upload was initiated.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Key": { + "target": "com.amazonaws.s3#ObjectKey", + "traits": { + "smithy.api#documentation": "

Object key for which the multipart upload was initiated.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "MultipartUpload": { + "target": "com.amazonaws.s3#CompletedMultipartUpload", + "traits": { + "smithy.api#documentation": "

The container for the multipart upload request information.

", + "smithy.api#httpPayload": {}, + "smithy.api#xmlName": "CompleteMultipartUpload" + } + }, + "UploadId": { + "target": "com.amazonaws.s3#MultipartUploadId", + "traits": { + "smithy.api#documentation": "

ID for the initiated multipart upload.

", + "smithy.api#httpQuery": "uploadId", + "smithy.api#required": {} + } + }, + "RequestPayer": { + "target": "com.amazonaws.s3#RequestPayer", + "traits": { + "smithy.api#httpHeader": "x-amz-request-payer" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + } + }, + "com.amazonaws.s3#CompletedMultipartUpload": { + "type": "structure", + "members": { + "Parts": { + "target": "com.amazonaws.s3#CompletedPartList", + "traits": { + "smithy.api#documentation": "

Array of CompletedPart data types.

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

The container for the completed multipart upload details.

" + } + }, + "com.amazonaws.s3#CompletedPart": { + "type": "structure", + "members": { + "ETag": { + "target": "com.amazonaws.s3#ETag", + "traits": { + "smithy.api#documentation": "

Entity tag returned when the part was uploaded.

" + } + }, + "PartNumber": { + "target": "com.amazonaws.s3#PartNumber", + "traits": { + "smithy.api#documentation": "

Part number that identifies the part. This is a positive integer between 1 and\n 10,000.

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

Details of the parts that were uploaded.

" + } + }, + "com.amazonaws.s3#CompletedPartList": { + "type": "list", + "member": { + "target": "com.amazonaws.s3#CompletedPart" + } + }, + "com.amazonaws.s3#CompressionType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "NONE", + "name": "NONE" + }, + { + "value": "GZIP", + "name": "GZIP" + }, + { + "value": "BZIP2", + "name": "BZIP2" + } + ] + } + }, + "com.amazonaws.s3#Condition": { + "type": "structure", + "members": { + "HttpErrorCodeReturnedEquals": { + "target": "com.amazonaws.s3#HttpErrorCodeReturnedEquals", + "traits": { + "smithy.api#documentation": "

The HTTP error code when the redirect is applied. In the event of an error, if the error\n code equals this value, then the specified redirect is applied. Required when parent\n element Condition is specified and sibling KeyPrefixEquals is not\n specified. If both are specified, then both must be true for the redirect to be\n applied.

" + } + }, + "KeyPrefixEquals": { + "target": "com.amazonaws.s3#KeyPrefixEquals", + "traits": { + "smithy.api#documentation": "

The object key name prefix when the redirect is applied. For example, to redirect\n requests for ExamplePage.html, the key prefix will be\n ExamplePage.html. To redirect request for all pages with the prefix\n docs/, the key prefix will be /docs, which identifies all\n objects in the docs/ folder. Required when the parent element\n Condition is specified and sibling HttpErrorCodeReturnedEquals\n is not specified. If both conditions are specified, both must be true for the redirect to\n be applied.

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

A container for describing a condition that must be met for the specified redirect to\n apply. For example, 1. If request is for pages in the /docs folder, redirect\n to the /documents folder. 2. If request results in HTTP error 4xx, redirect\n request to another host where you might process the error.

" + } + }, + "com.amazonaws.s3#ConfirmRemoveSelfBucketAccess": { + "type": "boolean" + }, + "com.amazonaws.s3#ContentDisposition": { + "type": "string" + }, + "com.amazonaws.s3#ContentEncoding": { + "type": "string" + }, + "com.amazonaws.s3#ContentLanguage": { + "type": "string" + }, + "com.amazonaws.s3#ContentLength": { + "type": "long" + }, + "com.amazonaws.s3#ContentMD5": { + "type": "string" + }, + "com.amazonaws.s3#ContentRange": { + "type": "string" + }, + "com.amazonaws.s3#ContentType": { + "type": "string" + }, + "com.amazonaws.s3#ContinuationEvent": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.s3#CopyObject": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#CopyObjectRequest" + }, + "output": { + "target": "com.amazonaws.s3#CopyObjectOutput" + }, + "errors": [ + { + "target": "com.amazonaws.s3#ObjectNotInActiveTierError" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a copy of an object that is already stored in Amazon S3.

\n \n

You can store individual objects of up to 5 TB in Amazon S3. You create a copy of your\n object up to 5 GB in size in a single atomic operation using this API. However, to copy\n an object greater than 5 GB, you must use the multipart upload Upload Part - Copy API.\n For more information, see Copy Object Using the REST Multipart Upload API.

\n \n

All copy requests must be authenticated. Additionally, you must have\n read access to the source object and write\n access to the destination bucket. For more information, see REST Authentication. Both the Region\n that you want to copy the object from and the Region that you want to copy the object to\n must be enabled for your account.

\n

A copy request might return an error when Amazon S3 receives the copy request or while Amazon S3\n is copying the files. If the error occurs before the copy operation starts, you receive a\n standard Amazon S3 error. If the error occurs during the copy operation, the error response is\n embedded in the 200 OK response. This means that a 200 OK\n response can contain either a success or an error. Design your application to parse the\n contents of the response and handle it appropriately.

\n

If the copy is successful, you receive a response with information about the copied\n object.

\n \n

If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not,\n it would not contain the content-length, and you would need to read the entire\n body.

\n \n

The copy request charge is based on the storage class and Region that you specify for\n the destination object. For pricing information, see Amazon S3 pricing.

\n \n

Amazon S3 transfer acceleration does not support cross-Region copies. If you request a\n cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad\n Request error. For more information, see Transfer Acceleration.

\n \n

\n Metadata\n

\n

When copying an object, you can preserve all metadata (default) or specify new metadata.\n However, the ACL is not preserved and is set to private for the user making the request. To\n override the default ACL setting, specify a new ACL when generating a copy request. For\n more information, see Using ACLs.

\n

To specify whether you want the object metadata copied from the source object or\n replaced with metadata provided in the request, you can optionally add the\n x-amz-metadata-directive header. When you grant permissions, you can use\n the s3:x-amz-metadata-directive condition key to enforce certain metadata\n behavior when objects are uploaded. For more information, see Specifying Conditions in a\n Policy in the Amazon S3 Developer Guide. For a complete list of\n Amazon S3-specific condition keys, see Actions, Resources, and Condition Keys for\n Amazon S3.

\n

\n \n x-amz-copy-source-if Headers\n

\n

To only copy an object under certain conditions, such as whether the Etag\n matches or whether the object was modified before or after a specified date, use the\n following request parameters:

\n \n

If both the x-amz-copy-source-if-match and\n x-amz-copy-source-if-unmodified-since headers are present in the request\n and evaluate as follows, Amazon S3 returns 200 OK and copies the data:

\n \n\n

If both the x-amz-copy-source-if-none-match and\n x-amz-copy-source-if-modified-since headers are present in the request and\n evaluate as follows, Amazon S3 returns the 412 Precondition Failed response\n code:

\n \n\n \n

All headers with the x-amz- prefix, including\n x-amz-copy-source, must be signed.

\n \n

\n Server-side encryption\n

\n

When you perform a CopyObject operation, you can optionally use the appropriate encryption-related headers to encrypt the object using server-side encryption with AWS managed encryption keys (SSE-S3 or SSE-KMS) or a customer-provided encryption key. With server-side encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts the data when you access it. For more information about server-side encryption, see Using\n Server-Side Encryption.

\n

If a target object uses SSE-KMS, you can enable an S3 Bucket Key for the object. For more\n information, see Amazon S3 Bucket Keys in the Amazon Simple Storage Service Developer Guide.

\n

\n Access Control List (ACL)-Specific Request\n Headers\n

\n

When copying an object, you can optionally use headers to grant ACL-based permissions.\n By default, all objects are private. Only the owner has full access control. When adding a\n new object, you can grant permissions to individual AWS accounts or to predefined groups\n defined by Amazon S3. These permissions are then added to the ACL on the object. For more\n information, see Access Control List (ACL) Overview and Managing ACLs Using the REST\n API.

\n\n

\n Storage Class Options\n

\n

You can use the CopyObject operation to change the storage class of an\n object that is already stored in Amazon S3 using the StorageClass parameter. For\n more information, see Storage\n Classes in the Amazon S3 Service Developer Guide.

\n

\n Versioning\n

\n

By default, x-amz-copy-source identifies the current version of an object\n to copy. If the current version is a delete marker, Amazon S3 behaves as if the object was\n deleted. To copy a different version, use the versionId subresource.

\n

If you enable versioning on the target bucket, Amazon S3 generates a unique version ID for\n the object being copied. This version ID is different from the version ID of the source\n object. Amazon S3 returns the version ID of the copied object in the\n x-amz-version-id response header in the response.

\n

If you do not enable versioning or suspend it on the target bucket, the version ID that\n Amazon S3 generates is always null.

\n

If the source object's storage class is GLACIER, you must restore a copy of this object\n before you can use it as a source object for the copy operation. For more information, see\n RestoreObject.

\n

The following operations are related to CopyObject:

\n \n

For more information, see Copying\n Objects.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/{Bucket}/{Key+}?x-id=CopyObject", + "code": 200 + } + } + }, + "com.amazonaws.s3#CopyObjectOutput": { + "type": "structure", + "members": { + "CopyObjectResult": { + "target": "com.amazonaws.s3#CopyObjectResult", + "traits": { + "smithy.api#documentation": "

Container for all response elements.

", + "smithy.api#httpPayload": {} + } + }, + "Expiration": { + "target": "com.amazonaws.s3#Expiration", + "traits": { + "smithy.api#documentation": "

If the object expiration is configured, the response includes this header.

", + "smithy.api#httpHeader": "x-amz-expiration" + } + }, + "CopySourceVersionId": { + "target": "com.amazonaws.s3#CopySourceVersionId", + "traits": { + "smithy.api#documentation": "

Version of the copied object in the destination bucket.

", + "smithy.api#httpHeader": "x-amz-copy-source-version-id" + } + }, + "VersionId": { + "target": "com.amazonaws.s3#ObjectVersionId", + "traits": { + "smithy.api#documentation": "

Version ID of the newly created copy.

", + "smithy.api#httpHeader": "x-amz-version-id" + } + }, + "ServerSideEncryption": { + "target": "com.amazonaws.s3#ServerSideEncryption", + "traits": { + "smithy.api#documentation": "

The server-side encryption algorithm used when storing this object in Amazon S3 (for example,\n AES256, aws:kms).

", + "smithy.api#httpHeader": "x-amz-server-side-encryption" + } + }, + "SSECustomerAlgorithm": { + "target": "com.amazonaws.s3#SSECustomerAlgorithm", + "traits": { + "smithy.api#documentation": "

If server-side encryption with a customer-provided encryption key was requested, the\n response will include this header confirming the encryption algorithm used.

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-algorithm" + } + }, + "SSECustomerKeyMD5": { + "target": "com.amazonaws.s3#SSECustomerKeyMD5", + "traits": { + "smithy.api#documentation": "

If server-side encryption with a customer-provided encryption key was requested, the\n response will include this header to provide round-trip message integrity verification of\n the customer-provided encryption key.

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key-MD5" + } + }, + "SSEKMSKeyId": { + "target": "com.amazonaws.s3#SSEKMSKeyId", + "traits": { + "smithy.api#documentation": "

If present, specifies the ID of the AWS Key Management Service (AWS KMS) symmetric\n customer managed customer master key (CMK) that was used for the object.

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" + } + }, + "SSEKMSEncryptionContext": { + "target": "com.amazonaws.s3#SSEKMSEncryptionContext", + "traits": { + "smithy.api#documentation": "

If present, specifies the AWS KMS Encryption Context to use for object encryption. The\n value of this header is a base64-encoded UTF-8 string holding JSON with the encryption\n context key-value pairs.

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-context" + } + }, + "BucketKeyEnabled": { + "target": "com.amazonaws.s3#BucketKeyEnabled", + "traits": { + "smithy.api#documentation": "

Indicates whether the copied object uses an S3 Bucket Key for server-side encryption with AWS KMS (SSE-KMS).

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-bucket-key-enabled" + } + }, + "RequestCharged": { + "target": "com.amazonaws.s3#RequestCharged", + "traits": { + "smithy.api#httpHeader": "x-amz-request-charged" + } + } + } + }, + "com.amazonaws.s3#CopyObjectRequest": { + "type": "structure", + "members": { + "ACL": { + "target": "com.amazonaws.s3#ObjectCannedACL", + "traits": { + "smithy.api#documentation": "

The canned ACL to apply to the object.

\n

This action is not supported by Amazon S3 on Outposts.

", + "smithy.api#httpHeader": "x-amz-acl" + } + }, + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the destination bucket.

\n

When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.

\n

When using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "CacheControl": { + "target": "com.amazonaws.s3#CacheControl", + "traits": { + "smithy.api#documentation": "

Specifies caching behavior along the request/reply chain.

", + "smithy.api#httpHeader": "Cache-Control" + } + }, + "ContentDisposition": { + "target": "com.amazonaws.s3#ContentDisposition", + "traits": { + "smithy.api#documentation": "

Specifies presentational information for the object.

", + "smithy.api#httpHeader": "Content-Disposition" + } + }, + "ContentEncoding": { + "target": "com.amazonaws.s3#ContentEncoding", + "traits": { + "smithy.api#documentation": "

Specifies what content encodings have been applied to the object and thus what decoding\n mechanisms must be applied to obtain the media-type referenced by the Content-Type header\n field.

", + "smithy.api#httpHeader": "Content-Encoding" + } + }, + "ContentLanguage": { + "target": "com.amazonaws.s3#ContentLanguage", + "traits": { + "smithy.api#documentation": "

The language the content is in.

", + "smithy.api#httpHeader": "Content-Language" + } + }, + "ContentType": { + "target": "com.amazonaws.s3#ContentType", + "traits": { + "smithy.api#documentation": "

A standard MIME type describing the format of the object data.

", + "smithy.api#httpHeader": "Content-Type" + } + }, + "CopySource": { + "target": "com.amazonaws.s3#CopySource", + "traits": { + "smithy.api#documentation": "

Specifies the source object for the copy operation. You specify the value in one of two\n formats, depending on whether you want to access the source object through an access\n point:

\n \n

To copy a specific version of an object, append ?versionId=\n to the value (for example,\n awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893).\n If you don't specify a version ID, Amazon S3 copies the latest version of the source\n object.

", + "smithy.api#httpHeader": "x-amz-copy-source", + "smithy.api#required": {} + } + }, + "CopySourceIfMatch": { + "target": "com.amazonaws.s3#CopySourceIfMatch", + "traits": { + "smithy.api#documentation": "

Copies the object if its entity tag (ETag) matches the specified tag.

", + "smithy.api#httpHeader": "x-amz-copy-source-if-match" + } + }, + "CopySourceIfModifiedSince": { + "target": "com.amazonaws.s3#CopySourceIfModifiedSince", + "traits": { + "smithy.api#documentation": "

Copies the object if it has been modified since the specified time.

", + "smithy.api#httpHeader": "x-amz-copy-source-if-modified-since" + } + }, + "CopySourceIfNoneMatch": { + "target": "com.amazonaws.s3#CopySourceIfNoneMatch", + "traits": { + "smithy.api#documentation": "

Copies the object if its entity tag (ETag) is different than the specified ETag.

", + "smithy.api#httpHeader": "x-amz-copy-source-if-none-match" + } + }, + "CopySourceIfUnmodifiedSince": { + "target": "com.amazonaws.s3#CopySourceIfUnmodifiedSince", + "traits": { + "smithy.api#documentation": "

Copies the object if it hasn't been modified since the specified time.

", + "smithy.api#httpHeader": "x-amz-copy-source-if-unmodified-since" + } + }, + "Expires": { + "target": "com.amazonaws.s3#Expires", + "traits": { + "smithy.api#documentation": "

The date and time at which the object is no longer cacheable.

", + "smithy.api#httpHeader": "Expires" + } + }, + "GrantFullControl": { + "target": "com.amazonaws.s3#GrantFullControl", + "traits": { + "smithy.api#documentation": "

Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the\n object.

\n

This action is not supported by Amazon S3 on Outposts.

", + "smithy.api#httpHeader": "x-amz-grant-full-control" + } + }, + "GrantRead": { + "target": "com.amazonaws.s3#GrantRead", + "traits": { + "smithy.api#documentation": "

Allows grantee to read the object data and its\n metadata.

\n

This action is not supported by Amazon S3 on Outposts.

", + "smithy.api#httpHeader": "x-amz-grant-read" + } + }, + "GrantReadACP": { + "target": "com.amazonaws.s3#GrantReadACP", + "traits": { + "smithy.api#documentation": "

Allows grantee to read the object ACL.

\n

This action is not supported by Amazon S3 on Outposts.

", + "smithy.api#httpHeader": "x-amz-grant-read-acp" + } + }, + "GrantWriteACP": { + "target": "com.amazonaws.s3#GrantWriteACP", + "traits": { + "smithy.api#documentation": "

Allows grantee to write the ACL for the applicable\n object.

\n

This action is not supported by Amazon S3 on Outposts.

", + "smithy.api#httpHeader": "x-amz-grant-write-acp" + } + }, + "Key": { + "target": "com.amazonaws.s3#ObjectKey", + "traits": { + "smithy.api#documentation": "

The key of the destination object.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Metadata": { + "target": "com.amazonaws.s3#Metadata", + "traits": { + "smithy.api#documentation": "

A map of metadata to store with the object in S3.

", + "smithy.api#httpPrefixHeaders": "x-amz-meta-" + } + }, + "MetadataDirective": { + "target": "com.amazonaws.s3#MetadataDirective", + "traits": { + "smithy.api#documentation": "

Specifies whether the metadata is copied from the source object or replaced with\n metadata provided in the request.

", + "smithy.api#httpHeader": "x-amz-metadata-directive" + } + }, + "TaggingDirective": { + "target": "com.amazonaws.s3#TaggingDirective", + "traits": { + "smithy.api#documentation": "

Specifies whether the object tag-set are copied from the source object or replaced with\n tag-set provided in the request.

", + "smithy.api#httpHeader": "x-amz-tagging-directive" + } + }, + "ServerSideEncryption": { + "target": "com.amazonaws.s3#ServerSideEncryption", + "traits": { + "smithy.api#documentation": "

The server-side encryption algorithm used when storing this object in Amazon S3 (for example,\n AES256, aws:kms).

", + "smithy.api#httpHeader": "x-amz-server-side-encryption" + } + }, + "StorageClass": { + "target": "com.amazonaws.s3#StorageClass", + "traits": { + "smithy.api#documentation": "

By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The\n STANDARD storage class provides high durability and high availability. Depending on\n performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses\n the OUTPOSTS Storage Class. For more information, see Storage Classes in the Amazon S3\n Service Developer Guide.

", + "smithy.api#httpHeader": "x-amz-storage-class" + } + }, + "WebsiteRedirectLocation": { + "target": "com.amazonaws.s3#WebsiteRedirectLocation", + "traits": { + "smithy.api#documentation": "

If the bucket is configured as a website, redirects requests for this object to another\n object in the same bucket or to an external URL. Amazon S3 stores the value of this header in\n the object metadata.

", + "smithy.api#httpHeader": "x-amz-website-redirect-location" + } + }, + "SSECustomerAlgorithm": { + "target": "com.amazonaws.s3#SSECustomerAlgorithm", + "traits": { + "smithy.api#documentation": "

Specifies the algorithm to use to when encrypting the object (for example,\n AES256).

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-algorithm" + } + }, + "SSECustomerKey": { + "target": "com.amazonaws.s3#SSECustomerKey", + "traits": { + "smithy.api#documentation": "

Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This\n value is used to store the object and then it is discarded; Amazon S3 does not store the\n encryption key. The key must be appropriate for use with the algorithm specified in the\n x-amz-server-side-encryption-customer-algorithm header.

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key" + } + }, + "SSECustomerKeyMD5": { + "target": "com.amazonaws.s3#SSECustomerKeyMD5", + "traits": { + "smithy.api#documentation": "

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses\n this header for a message integrity check to ensure that the encryption key was transmitted\n without error.

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key-MD5" + } + }, + "SSEKMSKeyId": { + "target": "com.amazonaws.s3#SSEKMSKeyId", + "traits": { + "smithy.api#documentation": "

Specifies the AWS KMS key ID to use for object encryption. All GET and PUT requests for\n an object protected by AWS KMS will fail if not made via SSL or using SigV4. For\n information about configuring using any of the officially supported AWS SDKs and AWS CLI,\n see Specifying the\n Signature Version in Request Authentication in the Amazon S3 Developer\n Guide.

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" + } + }, + "SSEKMSEncryptionContext": { + "target": "com.amazonaws.s3#SSEKMSEncryptionContext", + "traits": { + "smithy.api#documentation": "

Specifies the AWS KMS Encryption Context to use for object encryption. The value of this\n header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value\n pairs.

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-context" + } + }, + "BucketKeyEnabled": { + "target": "com.amazonaws.s3#BucketKeyEnabled", + "traits": { + "smithy.api#documentation": "

Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using AWS KMS (SSE-KMS). Setting this header to true causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS.

\n

Specifying this header with a COPY operation doesn’t affect bucket-level settings for S3 Bucket Key.

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-bucket-key-enabled" + } + }, + "CopySourceSSECustomerAlgorithm": { + "target": "com.amazonaws.s3#CopySourceSSECustomerAlgorithm", + "traits": { + "smithy.api#documentation": "

Specifies the algorithm to use when decrypting the source object (for example,\n AES256).

", + "smithy.api#httpHeader": "x-amz-copy-source-server-side-encryption-customer-algorithm" + } + }, + "CopySourceSSECustomerKey": { + "target": "com.amazonaws.s3#CopySourceSSECustomerKey", + "traits": { + "smithy.api#documentation": "

Specifies the customer-provided encryption key for Amazon S3 to use to decrypt the source\n object. The encryption key provided in this header must be one that was used when the\n source object was created.

", + "smithy.api#httpHeader": "x-amz-copy-source-server-side-encryption-customer-key" + } + }, + "CopySourceSSECustomerKeyMD5": { + "target": "com.amazonaws.s3#CopySourceSSECustomerKeyMD5", + "traits": { + "smithy.api#documentation": "

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses\n this header for a message integrity check to ensure that the encryption key was transmitted\n without error.

", + "smithy.api#httpHeader": "x-amz-copy-source-server-side-encryption-customer-key-MD5" + } + }, + "RequestPayer": { + "target": "com.amazonaws.s3#RequestPayer", + "traits": { + "smithy.api#httpHeader": "x-amz-request-payer" + } + }, + "Tagging": { + "target": "com.amazonaws.s3#TaggingHeader", + "traits": { + "smithy.api#documentation": "

The tag-set for the object destination object this value must be used in conjunction\n with the TaggingDirective. The tag-set must be encoded as URL Query\n parameters.

", + "smithy.api#httpHeader": "x-amz-tagging" + } + }, + "ObjectLockMode": { + "target": "com.amazonaws.s3#ObjectLockMode", + "traits": { + "smithy.api#documentation": "

The Object Lock mode that you want to apply to the copied object.

", + "smithy.api#httpHeader": "x-amz-object-lock-mode" + } + }, + "ObjectLockRetainUntilDate": { + "target": "com.amazonaws.s3#ObjectLockRetainUntilDate", + "traits": { + "smithy.api#documentation": "

The date and time when you want the copied object's Object Lock to expire.

", + "smithy.api#httpHeader": "x-amz-object-lock-retain-until-date" + } + }, + "ObjectLockLegalHoldStatus": { + "target": "com.amazonaws.s3#ObjectLockLegalHoldStatus", + "traits": { + "smithy.api#documentation": "

Specifies whether you want to apply a Legal Hold to the copied object.

", + "smithy.api#httpHeader": "x-amz-object-lock-legal-hold" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account id of the expected destination bucket owner. If the destination bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + }, + "ExpectedSourceBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account id of the expected source bucket owner. If the source bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", + "smithy.api#httpHeader": "x-amz-source-expected-bucket-owner" + } + } + } + }, + "com.amazonaws.s3#CopyObjectResult": { + "type": "structure", + "members": { + "ETag": { + "target": "com.amazonaws.s3#ETag", + "traits": { + "smithy.api#documentation": "

Returns the ETag of the new object. The ETag reflects only changes to the contents of an\n object, not its metadata. The source and destination ETag is identical for a successfully\n copied object.

" + } + }, + "LastModified": { + "target": "com.amazonaws.s3#LastModified", + "traits": { + "smithy.api#documentation": "

Returns the date that the object was last modified.

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

Container for all response elements.

" + } + }, + "com.amazonaws.s3#CopyPartResult": { + "type": "structure", + "members": { + "ETag": { + "target": "com.amazonaws.s3#ETag", + "traits": { + "smithy.api#documentation": "

Entity tag of the object.

" + } + }, + "LastModified": { + "target": "com.amazonaws.s3#LastModified", + "traits": { + "smithy.api#documentation": "

Date and time at which the object was uploaded.

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

Container for all response elements.

" + } + }, + "com.amazonaws.s3#CopySource": { + "type": "string", + "traits": { + "smithy.api#pattern": "\\/.+\\/.+" + } + }, + "com.amazonaws.s3#CopySourceIfMatch": { + "type": "string" + }, + "com.amazonaws.s3#CopySourceIfModifiedSince": { + "type": "timestamp" + }, + "com.amazonaws.s3#CopySourceIfNoneMatch": { + "type": "string" + }, + "com.amazonaws.s3#CopySourceIfUnmodifiedSince": { + "type": "timestamp" + }, + "com.amazonaws.s3#CopySourceRange": { + "type": "string" + }, + "com.amazonaws.s3#CopySourceSSECustomerAlgorithm": { + "type": "string" + }, + "com.amazonaws.s3#CopySourceSSECustomerKey": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.s3#CopySourceSSECustomerKeyMD5": { + "type": "string" + }, + "com.amazonaws.s3#CopySourceVersionId": { + "type": "string" + }, + "com.amazonaws.s3#CreateBucket": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#CreateBucketRequest" + }, + "output": { + "target": "com.amazonaws.s3#CreateBucketOutput" + }, + "errors": [ + { + "target": "com.amazonaws.s3#BucketAlreadyExists" + }, + { + "target": "com.amazonaws.s3#BucketAlreadyOwnedByYou" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new S3 bucket. To create a bucket, you must register with Amazon S3 and have a\n valid AWS Access Key ID to authenticate requests. Anonymous requests are never allowed to\n create buckets. By creating the bucket, you become the bucket owner.

\n

Not every string is an acceptable bucket name. For information about bucket naming\n restrictions, see Working with Amazon S3\n buckets.

\n

If you want to create an Amazon S3 on Outposts bucket, see Create Bucket.

\n

By default, the bucket is created in the US East (N. Virginia) Region. You can\n optionally specify a Region in the request body. You might choose a Region to optimize\n latency, minimize costs, or address regulatory requirements. For example, if you reside in\n Europe, you will probably find it advantageous to create buckets in the Europe (Ireland)\n Region. For more information, see Accessing a\n bucket.

\n \n

If you send your create bucket request to the s3.amazonaws.com endpoint,\n the request goes to the us-east-1 Region. Accordingly, the signature calculations in\n Signature Version 4 must use us-east-1 as the Region, even if the location constraint in\n the request specifies another Region where the bucket is to be created. If you create a\n bucket in a Region other than US East (N. Virginia), your application must be able to\n handle 307 redirect. For more information, see Virtual hosting of buckets.

\n \n

When creating a bucket using this operation, you can optionally specify the accounts or\n groups that should be granted specific permissions on the bucket. There are two ways to\n grant the appropriate permissions using the request headers.

\n \n \n

You can use either a canned ACL or specify access permissions explicitly. You cannot\n do both.

\n \n\n\n

The following operations are related to CreateBucket:

\n ", + "smithy.api#http": { + "method": "PUT", + "uri": "/{Bucket}", + "code": 200 + } + } + }, + "com.amazonaws.s3#CreateBucketConfiguration": { + "type": "structure", + "members": { + "LocationConstraint": { + "target": "com.amazonaws.s3#BucketLocationConstraint", + "traits": { + "smithy.api#documentation": "

Specifies the Region where the bucket will be created. If you don't specify a Region,\n the bucket is created in the US East (N. Virginia) Region (us-east-1).

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

The configuration information for the bucket.

" + } + }, + "com.amazonaws.s3#CreateBucketOutput": { + "type": "structure", + "members": { + "Location": { + "target": "com.amazonaws.s3#Location", + "traits": { + "smithy.api#documentation": "

Specifies the Region where the bucket will be created. If you are creating a bucket on\n the US East (N. Virginia) Region (us-east-1), you do not need to specify the\n location.

", + "smithy.api#httpHeader": "Location" + } + } + } + }, + "com.amazonaws.s3#CreateBucketRequest": { + "type": "structure", + "members": { + "ACL": { + "target": "com.amazonaws.s3#BucketCannedACL", + "traits": { + "smithy.api#documentation": "

The canned ACL to apply to the bucket.

", + "smithy.api#httpHeader": "x-amz-acl" + } + }, + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket to create.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "CreateBucketConfiguration": { + "target": "com.amazonaws.s3#CreateBucketConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration information for the bucket.

", + "smithy.api#httpPayload": {} + } + }, + "GrantFullControl": { + "target": "com.amazonaws.s3#GrantFullControl", + "traits": { + "smithy.api#documentation": "

Allows grantee the read, write, read ACP, and write ACP permissions on the\n bucket.

", + "smithy.api#httpHeader": "x-amz-grant-full-control" + } + }, + "GrantRead": { + "target": "com.amazonaws.s3#GrantRead", + "traits": { + "smithy.api#documentation": "

Allows grantee to list the objects in the bucket.

", + "smithy.api#httpHeader": "x-amz-grant-read" + } + }, + "GrantReadACP": { + "target": "com.amazonaws.s3#GrantReadACP", + "traits": { + "smithy.api#documentation": "

Allows grantee to read the bucket ACL.

", + "smithy.api#httpHeader": "x-amz-grant-read-acp" + } + }, + "GrantWrite": { + "target": "com.amazonaws.s3#GrantWrite", + "traits": { + "smithy.api#documentation": "

Allows grantee to create, overwrite, and delete any object in the bucket.

", + "smithy.api#httpHeader": "x-amz-grant-write" + } + }, + "GrantWriteACP": { + "target": "com.amazonaws.s3#GrantWriteACP", + "traits": { + "smithy.api#documentation": "

Allows grantee to write the ACL for the applicable bucket.

", + "smithy.api#httpHeader": "x-amz-grant-write-acp" + } + }, + "ObjectLockEnabledForBucket": { + "target": "com.amazonaws.s3#ObjectLockEnabledForBucket", + "traits": { + "smithy.api#documentation": "

Specifies whether you want S3 Object Lock to be enabled for the new bucket.

", + "smithy.api#httpHeader": "x-amz-bucket-object-lock-enabled" + } + } + } + }, + "com.amazonaws.s3#CreateMultipartUpload": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#CreateMultipartUploadRequest" + }, + "output": { + "target": "com.amazonaws.s3#CreateMultipartUploadOutput" + }, + "traits": { + "smithy.api#documentation": "

This operation initiates a multipart upload and returns an upload ID. This upload ID is\n used to associate all of the parts in the specific multipart upload. You specify this\n upload ID in each of your subsequent upload part requests (see UploadPart). You also include this\n upload ID in the final request to either complete or abort the multipart upload\n request.

\n\n

For more information about multipart uploads, see Multipart Upload Overview.

\n\n

If you have configured a lifecycle rule to abort incomplete multipart uploads, the\n upload must complete within the number of days specified in the bucket lifecycle\n configuration. Otherwise, the incomplete multipart upload becomes eligible for an abort\n operation and Amazon S3 aborts the multipart upload. For more information, see Aborting\n Incomplete Multipart Uploads Using a Bucket Lifecycle Policy.

\n\n

For information about the permissions required to use the multipart upload API, see\n Multipart Upload API and\n Permissions.

\n\n

For request signing, multipart upload is just a series of regular requests. You initiate\n a multipart upload, send one or more requests to upload parts, and then complete the\n multipart upload process. You sign each request individually. There is nothing special\n about signing multipart upload requests. For more information about signing, see Authenticating\n Requests (AWS Signature Version 4).

\n\n \n

After you initiate a multipart upload and upload one or more parts, to stop being\n charged for storing the uploaded parts, you must either complete or abort the multipart\n upload. Amazon S3 frees up the space used to store the parts and stop charging you for\n storing them only after you either complete or abort a multipart upload.

\n \n\n

You can optionally request server-side encryption. For server-side encryption, Amazon S3\n encrypts your data as it writes it to disks in its data centers and decrypts it when you\n access it. You can provide your own encryption key, or use AWS Key Management Service (AWS\n KMS) customer master keys (CMKs) or Amazon S3-managed encryption keys. If you choose to provide\n your own encryption key, the request headers you provide in UploadPart and UploadPartCopy requests must match the headers you used in the request to\n initiate the upload by using CreateMultipartUpload.

\n

To perform a multipart upload with encryption using an AWS KMS CMK, the requester must\n have permission to the kms:Encrypt, kms:Decrypt,\n kms:ReEncrypt*, kms:GenerateDataKey*, and\n kms:DescribeKey actions on the key. These permissions are required because\n Amazon S3 must decrypt and read data from the encrypted file parts before it completes the\n multipart upload.

\n\n

If your AWS Identity and Access Management (IAM) user or role is in the same AWS account\n as the AWS KMS CMK, then you must have these permissions on the key policy. If your IAM\n user or role belongs to a different account than the key, then you must have the\n permissions on both the key policy and your IAM user or role.

\n\n\n

For more information, see Protecting\n Data Using Server-Side Encryption.

\n\n
\n
Access Permissions
\n
\n

When copying an object, you can optionally specify the accounts or groups that\n should be granted specific permissions on the new object. There are two ways to\n grant the permissions using the request headers:

\n
    \n
  • \n

    Specify a canned ACL with the x-amz-acl request header. For\n more information, see Canned ACL.

    \n
    • \n
  • \n

    Specify access permissions explicitly with the\n x-amz-grant-read, x-amz-grant-read-acp,\n x-amz-grant-write-acp, and\n x-amz-grant-full-control headers. These parameters map to\n the set of permissions that Amazon S3 supports in an ACL. For more information,\n see Access Control List (ACL)\n Overview.

    \n
    • \n
\n

You can use either a canned ACL or specify access permissions explicitly. You\n cannot do both.

\n
\n
Server-Side- Encryption-Specific Request Headers
\n
\n

You can optionally tell Amazon S3 to encrypt data at rest using server-side\n encryption. Server-side encryption is for data encryption at rest. Amazon S3 encrypts\n your data as it writes it to disks in its data centers and decrypts it when you\n access it. The option you use depends on whether you want to use AWS managed\n encryption keys or provide your own encryption key.

\n
    \n
  • \n

    Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored\n in AWS Key Management Service (AWS KMS) – If you want AWS to manage the keys\n used to encrypt data, specify the following headers in the request.

    \n
      \n
    • \n

      x-amz-server-side-encryption

      \n
      • \n
    • \n

      x-amz-server-side-encryption-aws-kms-key-id

      \n
      • \n
    • \n

      x-amz-server-side-encryption-context

      \n
      • \n
    \n \n

    If you specify x-amz-server-side-encryption:aws:kms, but\n don't provide x-amz-server-side-encryption-aws-kms-key-id,\n Amazon S3 uses the AWS managed CMK in AWS KMS to protect the data.

    \n     \n \n

    All GET and PUT requests for an object protected by AWS KMS fail if\n you don't make them with SSL or by using SigV4.

    \n     \n

    For more information about server-side encryption with CMKs stored in AWS\n KMS (SSE-KMS), see Protecting Data Using Server-Side Encryption with CMKs stored in AWS\n KMS.

    \n
    • \n
  • \n

    Use customer-provided encryption keys – If you want to manage your own\n encryption keys, provide all the following headers in the request.

    \n
      \n
    • \n

      x-amz-server-side-encryption-customer-algorithm

      \n
      • \n
    • \n

      x-amz-server-side-encryption-customer-key

      \n
      • \n
    • \n

      x-amz-server-side-encryption-customer-key-MD5

      \n
      • \n
    \n

    For more information about server-side encryption with CMKs stored in AWS\n KMS (SSE-KMS), see Protecting Data Using Server-Side Encryption with CMKs stored in AWS\n KMS.

    \n
    • \n
\n
\n
Access-Control-List (ACL)-Specific Request Headers
\n
\n

You also can use the following access control–related headers with this\n operation. By default, all objects are private. Only the owner has full access\n control. When adding a new object, you can grant permissions to individual AWS\n accounts or to predefined groups defined by Amazon S3. These permissions are then added\n to the access control list (ACL) on the object. For more information, see Using ACLs. With this\n operation, you can grant access permissions using one of the following two\n methods:

\n
    \n
  • \n

    Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of\n predefined ACLs, known as canned ACLs. Each canned ACL\n has a predefined set of grantees and permissions. For more information, see\n Canned\n ACL.

    \n
    • \n
  • \n

    Specify access permissions explicitly — To explicitly grant access\n permissions to specific AWS accounts or groups, use the following headers.\n Each header maps to specific permissions that Amazon S3 supports in an ACL. For\n more information, see Access\n Control List (ACL) Overview. In the header, you specify a list of\n grantees who get the specific permission. To grant permissions explicitly,\n use:

    \n
      \n
    • \n

      x-amz-grant-read

      \n
      • \n
    • \n

      x-amz-grant-write

      \n
      • \n
    • \n

      x-amz-grant-read-acp

      \n
      • \n
    • \n

      x-amz-grant-write-acp

      \n
      • \n
    • \n

      x-amz-grant-full-control

      \n
      • \n
    \n

    You specify each grantee as a type=value pair, where the type is one of\n the following:

    \n
      \n
    • \n

      \n id – if the value specified is the canonical user ID\n of an AWS account

      \n
      • \n
    • \n

      \n uri – if you are granting permissions to a predefined\n group

      \n
      • \n
    • \n

      \n emailAddress – if the value specified is the email\n address of an AWS account

      \n \n

      Using email addresses to specify a grantee is only supported in the following AWS Regions:

      \n
        \n
      • \n

        US East (N. Virginia)

        \n
        • \n
      • \n

        US West (N. California)

        \n
        • \n
      • \n

        US West (Oregon)

        \n
        • \n
      • \n

        Asia Pacific (Singapore)

        \n
        • \n
      • \n

        Asia Pacific (Sydney)

        \n
        • \n
      • \n

        Asia Pacific (Tokyo)

        \n
        • \n
      • \n

        Europe (Ireland)

        \n
        • \n
      • \n

        South America (São Paulo)

        \n
        • \n
      \n

      For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the AWS General Reference.

      \n       \n
      • \n
    \n

    For example, the following x-amz-grant-read header grants the AWS accounts identified by account IDs permissions to read object data and its metadata:

    \n

    \n x-amz-grant-read: id=\"11112222333\", id=\"444455556666\" \n

    \n
    • \n
\n\n
\n
\n\n

The following operations are related to CreateMultipartUpload:

\n ", + "smithy.api#http": { + "method": "POST", + "uri": "/{Bucket}/{Key+}?uploads", + "code": 200 + } + } + }, + "com.amazonaws.s3#CreateMultipartUploadOutput": { + "type": "structure", + "members": { + "AbortDate": { + "target": "com.amazonaws.s3#AbortDate", + "traits": { + "smithy.api#documentation": "

If the bucket has a lifecycle rule configured with an action to abort incomplete\n multipart uploads and the prefix in the lifecycle rule matches the object name in the\n request, the response includes this header. The header indicates when the initiated\n multipart upload becomes eligible for an abort operation. For more information, see \n Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy.

\n\n

The response also includes the x-amz-abort-rule-id header that provides the\n ID of the lifecycle configuration rule that defines this action.

", + "smithy.api#httpHeader": "x-amz-abort-date" + } + }, + "AbortRuleId": { + "target": "com.amazonaws.s3#AbortRuleId", + "traits": { + "smithy.api#documentation": "

This header is returned along with the x-amz-abort-date header. It\n identifies the applicable lifecycle configuration rule that defines the action to abort\n incomplete multipart uploads.

", + "smithy.api#httpHeader": "x-amz-abort-rule-id" + } + }, + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket to which the multipart upload was initiated.

\n

When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.

\n

When using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.

", + "smithy.api#xmlName": "Bucket" + } + }, + "Key": { + "target": "com.amazonaws.s3#ObjectKey", + "traits": { + "smithy.api#documentation": "

Object key for which the multipart upload was initiated.

" + } + }, + "UploadId": { + "target": "com.amazonaws.s3#MultipartUploadId", + "traits": { + "smithy.api#documentation": "

ID for the initiated multipart upload.

" + } + }, + "ServerSideEncryption": { + "target": "com.amazonaws.s3#ServerSideEncryption", + "traits": { + "smithy.api#documentation": "

The server-side encryption algorithm used when storing this object in Amazon S3 (for example,\n AES256, aws:kms).

", + "smithy.api#httpHeader": "x-amz-server-side-encryption" + } + }, + "SSECustomerAlgorithm": { + "target": "com.amazonaws.s3#SSECustomerAlgorithm", + "traits": { + "smithy.api#documentation": "

If server-side encryption with a customer-provided encryption key was requested, the\n response will include this header confirming the encryption algorithm used.

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-algorithm" + } + }, + "SSECustomerKeyMD5": { + "target": "com.amazonaws.s3#SSECustomerKeyMD5", + "traits": { + "smithy.api#documentation": "

If server-side encryption with a customer-provided encryption key was requested, the\n response will include this header to provide round-trip message integrity verification of\n the customer-provided encryption key.

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key-MD5" + } + }, + "SSEKMSKeyId": { + "target": "com.amazonaws.s3#SSEKMSKeyId", + "traits": { + "smithy.api#documentation": "

If present, specifies the ID of the AWS Key Management Service (AWS KMS) symmetric\n customer managed customer master key (CMK) that was used for the object.

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" + } + }, + "SSEKMSEncryptionContext": { + "target": "com.amazonaws.s3#SSEKMSEncryptionContext", + "traits": { + "smithy.api#documentation": "

If present, specifies the AWS KMS Encryption Context to use for object encryption. The\n value of this header is a base64-encoded UTF-8 string holding JSON with the encryption\n context key-value pairs.

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-context" + } + }, + "BucketKeyEnabled": { + "target": "com.amazonaws.s3#BucketKeyEnabled", + "traits": { + "smithy.api#documentation": "

Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with AWS KMS (SSE-KMS).

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-bucket-key-enabled" + } + }, + "RequestCharged": { + "target": "com.amazonaws.s3#RequestCharged", + "traits": { + "smithy.api#httpHeader": "x-amz-request-charged" + } + } + } + }, + "com.amazonaws.s3#CreateMultipartUploadRequest": { + "type": "structure", + "members": { + "ACL": { + "target": "com.amazonaws.s3#ObjectCannedACL", + "traits": { + "smithy.api#documentation": "

The canned ACL to apply to the object.

\n

This action is not supported by Amazon S3 on Outposts.

", + "smithy.api#httpHeader": "x-amz-acl" + } + }, + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket to which to initiate the upload

\n

When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.

\n

When using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "CacheControl": { + "target": "com.amazonaws.s3#CacheControl", + "traits": { + "smithy.api#documentation": "

Specifies caching behavior along the request/reply chain.

", + "smithy.api#httpHeader": "Cache-Control" + } + }, + "ContentDisposition": { + "target": "com.amazonaws.s3#ContentDisposition", + "traits": { + "smithy.api#documentation": "

Specifies presentational information for the object.

", + "smithy.api#httpHeader": "Content-Disposition" + } + }, + "ContentEncoding": { + "target": "com.amazonaws.s3#ContentEncoding", + "traits": { + "smithy.api#documentation": "

Specifies what content encodings have been applied to the object and thus what decoding\n mechanisms must be applied to obtain the media-type referenced by the Content-Type header\n field.

", + "smithy.api#httpHeader": "Content-Encoding" + } + }, + "ContentLanguage": { + "target": "com.amazonaws.s3#ContentLanguage", + "traits": { + "smithy.api#documentation": "

The language the content is in.

", + "smithy.api#httpHeader": "Content-Language" + } + }, + "ContentType": { + "target": "com.amazonaws.s3#ContentType", + "traits": { + "smithy.api#documentation": "

A standard MIME type describing the format of the object data.

", + "smithy.api#httpHeader": "Content-Type" + } + }, + "Expires": { + "target": "com.amazonaws.s3#Expires", + "traits": { + "smithy.api#documentation": "

The date and time at which the object is no longer cacheable.

", + "smithy.api#httpHeader": "Expires" + } + }, + "GrantFullControl": { + "target": "com.amazonaws.s3#GrantFullControl", + "traits": { + "smithy.api#documentation": "

Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the\n object.

\n

This action is not supported by Amazon S3 on Outposts.

", + "smithy.api#httpHeader": "x-amz-grant-full-control" + } + }, + "GrantRead": { + "target": "com.amazonaws.s3#GrantRead", + "traits": { + "smithy.api#documentation": "

Allows grantee to read the object data and its\n metadata.

\n

This action is not supported by Amazon S3 on Outposts.

", + "smithy.api#httpHeader": "x-amz-grant-read" + } + }, + "GrantReadACP": { + "target": "com.amazonaws.s3#GrantReadACP", + "traits": { + "smithy.api#documentation": "

Allows grantee to read the object ACL.

\n

This action is not supported by Amazon S3 on Outposts.

", + "smithy.api#httpHeader": "x-amz-grant-read-acp" + } + }, + "GrantWriteACP": { + "target": "com.amazonaws.s3#GrantWriteACP", + "traits": { + "smithy.api#documentation": "

Allows grantee to write the ACL for the applicable\n object.

\n

This action is not supported by Amazon S3 on Outposts.

", + "smithy.api#httpHeader": "x-amz-grant-write-acp" + } + }, + "Key": { + "target": "com.amazonaws.s3#ObjectKey", + "traits": { + "smithy.api#documentation": "

Object key for which the multipart upload is to be initiated.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Metadata": { + "target": "com.amazonaws.s3#Metadata", + "traits": { + "smithy.api#documentation": "

A map of metadata to store with the object in S3.

", + "smithy.api#httpPrefixHeaders": "x-amz-meta-" + } + }, + "ServerSideEncryption": { + "target": "com.amazonaws.s3#ServerSideEncryption", + "traits": { + "smithy.api#documentation": "

The server-side encryption algorithm used when storing this object in Amazon S3 (for example,\n AES256, aws:kms).

", + "smithy.api#httpHeader": "x-amz-server-side-encryption" + } + }, + "StorageClass": { + "target": "com.amazonaws.s3#StorageClass", + "traits": { + "smithy.api#documentation": "

By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The\n STANDARD storage class provides high durability and high availability. Depending on\n performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses\n the OUTPOSTS Storage Class. For more information, see Storage Classes in the Amazon S3\n Service Developer Guide.

", + "smithy.api#httpHeader": "x-amz-storage-class" + } + }, + "WebsiteRedirectLocation": { + "target": "com.amazonaws.s3#WebsiteRedirectLocation", + "traits": { + "smithy.api#documentation": "

If the bucket is configured as a website, redirects requests for this object to another\n object in the same bucket or to an external URL. Amazon S3 stores the value of this header in\n the object metadata.

", + "smithy.api#httpHeader": "x-amz-website-redirect-location" + } + }, + "SSECustomerAlgorithm": { + "target": "com.amazonaws.s3#SSECustomerAlgorithm", + "traits": { + "smithy.api#documentation": "

Specifies the algorithm to use to when encrypting the object (for example,\n AES256).

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-algorithm" + } + }, + "SSECustomerKey": { + "target": "com.amazonaws.s3#SSECustomerKey", + "traits": { + "smithy.api#documentation": "

Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This\n value is used to store the object and then it is discarded; Amazon S3 does not store the\n encryption key. The key must be appropriate for use with the algorithm specified in the\n x-amz-server-side-encryption-customer-algorithm header.

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key" + } + }, + "SSECustomerKeyMD5": { + "target": "com.amazonaws.s3#SSECustomerKeyMD5", + "traits": { + "smithy.api#documentation": "

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses\n this header for a message integrity check to ensure that the encryption key was transmitted\n without error.

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key-MD5" + } + }, + "SSEKMSKeyId": { + "target": "com.amazonaws.s3#SSEKMSKeyId", + "traits": { + "smithy.api#documentation": "

Specifies the ID of the symmetric customer managed AWS KMS CMK to use for object\n encryption. All GET and PUT requests for an object protected by AWS KMS will fail if not\n made via SSL or using SigV4. For information about configuring using any of the officially\n supported AWS SDKs and AWS CLI, see Specifying the Signature Version in Request Authentication\n in the Amazon S3 Developer Guide.

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" + } + }, + "SSEKMSEncryptionContext": { + "target": "com.amazonaws.s3#SSEKMSEncryptionContext", + "traits": { + "smithy.api#documentation": "

Specifies the AWS KMS Encryption Context to use for object encryption. The value of this\n header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value\n pairs.

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-context" + } + }, + "BucketKeyEnabled": { + "target": "com.amazonaws.s3#BucketKeyEnabled", + "traits": { + "smithy.api#documentation": "

Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using AWS KMS (SSE-KMS). Setting this header to true causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS.

\n

Specifying this header with an object operation doesn’t affect bucket-level settings for S3 Bucket Key.

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-bucket-key-enabled" + } + }, + "RequestPayer": { + "target": "com.amazonaws.s3#RequestPayer", + "traits": { + "smithy.api#httpHeader": "x-amz-request-payer" + } + }, + "Tagging": { + "target": "com.amazonaws.s3#TaggingHeader", + "traits": { + "smithy.api#documentation": "

The tag-set for the object. The tag-set must be encoded as URL Query parameters.

", + "smithy.api#httpHeader": "x-amz-tagging" + } + }, + "ObjectLockMode": { + "target": "com.amazonaws.s3#ObjectLockMode", + "traits": { + "smithy.api#documentation": "

Specifies the Object Lock mode that you want to apply to the uploaded object.

", + "smithy.api#httpHeader": "x-amz-object-lock-mode" + } + }, + "ObjectLockRetainUntilDate": { + "target": "com.amazonaws.s3#ObjectLockRetainUntilDate", + "traits": { + "smithy.api#documentation": "

Specifies the date and time when you want the Object Lock to expire.

", + "smithy.api#httpHeader": "x-amz-object-lock-retain-until-date" + } + }, + "ObjectLockLegalHoldStatus": { + "target": "com.amazonaws.s3#ObjectLockLegalHoldStatus", + "traits": { + "smithy.api#documentation": "

Specifies whether you want to apply a Legal Hold to the uploaded object.

", + "smithy.api#httpHeader": "x-amz-object-lock-legal-hold" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + } + }, + "com.amazonaws.s3#CreationDate": { + "type": "timestamp" + }, + "com.amazonaws.s3#Date": { + "type": "timestamp", + "traits": { + "smithy.api#timestampFormat": "date-time" + } + }, + "com.amazonaws.s3#Days": { + "type": "integer" + }, + "com.amazonaws.s3#DaysAfterInitiation": { + "type": "integer" + }, + "com.amazonaws.s3#DefaultRetention": { + "type": "structure", + "members": { + "Mode": { + "target": "com.amazonaws.s3#ObjectLockRetentionMode", + "traits": { + "smithy.api#documentation": "

The default Object Lock retention mode you want to apply to new objects placed in the\n specified bucket.

" + } + }, + "Days": { + "target": "com.amazonaws.s3#Days", + "traits": { + "smithy.api#documentation": "

The number of days that you want to specify for the default retention period.

" + } + }, + "Years": { + "target": "com.amazonaws.s3#Years", + "traits": { + "smithy.api#documentation": "

The number of years that you want to specify for the default retention period.

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

The container element for specifying the default Object Lock retention settings for new\n objects placed in the specified bucket.

" + } + }, + "com.amazonaws.s3#Delete": { + "type": "structure", + "members": { + "Objects": { + "target": "com.amazonaws.s3#ObjectIdentifierList", + "traits": { + "smithy.api#documentation": "

The objects to delete.

", + "smithy.api#required": {}, + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "Object" + } + }, + "Quiet": { + "target": "com.amazonaws.s3#Quiet", + "traits": { + "smithy.api#documentation": "

Element to enable quiet mode for the request. When you add this element, you must set\n its value to true.

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

Container for the objects to delete.

" + } + }, + "com.amazonaws.s3#DeleteBucket": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#DeleteBucketRequest" + }, + "traits": { + "smithy.api#documentation": "

Deletes the S3 bucket. All objects (including all object versions and delete markers) in\n the bucket must be deleted before the bucket itself can be deleted.

\n \n

\n Related Resources\n

\n ", + "smithy.api#http": { + "method": "DELETE", + "uri": "/{Bucket}", + "code": 204 + } + } + }, + "com.amazonaws.s3#DeleteBucketAnalyticsConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#DeleteBucketAnalyticsConfigurationRequest" + }, + "traits": { + "smithy.api#documentation": "

Deletes an analytics configuration for the bucket (specified by the analytics\n configuration ID).

\n

To use this operation, you must have permissions to perform the\n s3:PutAnalyticsConfiguration action. The bucket owner has this permission\n by default. The bucket owner can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources.

\n\n

For information about the Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class\n Analysis.

\n\n

The following operations are related to\n DeleteBucketAnalyticsConfiguration:

\n ", + "smithy.api#http": { + "method": "DELETE", + "uri": "/{Bucket}?analytics", + "code": 204 + } + } + }, + "com.amazonaws.s3#DeleteBucketAnalyticsConfigurationRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket from which an analytics configuration is deleted.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Id": { + "target": "com.amazonaws.s3#AnalyticsId", + "traits": { + "smithy.api#documentation": "

The ID that identifies the analytics configuration.

", + "smithy.api#httpQuery": "id", + "smithy.api#required": {} + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + } + }, + "com.amazonaws.s3#DeleteBucketCors": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#DeleteBucketCorsRequest" + }, + "traits": { + "smithy.api#documentation": "

Deletes the cors configuration information set for the bucket.

\n

To use this operation, you must have permission to perform the\n s3:PutBucketCORS action. The bucket owner has this permission by default\n and can grant this permission to others.

\n

For information about cors, see Enabling\n Cross-Origin Resource Sharing in the Amazon Simple Storage Service Developer Guide.

\n \n

\n Related Resources:\n

\n ", + "smithy.api#http": { + "method": "DELETE", + "uri": "/{Bucket}?cors", + "code": 204 + } + } + }, + "com.amazonaws.s3#DeleteBucketCorsRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

Specifies the bucket whose cors configuration is being deleted.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + } + }, + "com.amazonaws.s3#DeleteBucketEncryption": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#DeleteBucketEncryptionRequest" + }, + "traits": { + "smithy.api#documentation": "

This implementation of the DELETE operation removes default encryption from the bucket.\n For information about the Amazon S3 default encryption feature, see Amazon S3 Default Bucket Encryption in the\n Amazon Simple Storage Service Developer Guide.

\n

To use this operation, you must have permissions to perform the\n s3:PutEncryptionConfiguration action. The bucket owner has this permission\n by default. The bucket owner can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to your Amazon S3\n Resources in the Amazon Simple Storage Service Developer Guide.

\n \n

\n Related Resources\n

\n ", + "smithy.api#http": { + "method": "DELETE", + "uri": "/{Bucket}?encryption", + "code": 204 + } + } + }, + "com.amazonaws.s3#DeleteBucketEncryptionRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket containing the server-side encryption configuration to\n delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + } + }, + "com.amazonaws.s3#DeleteBucketIntelligentTieringConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#DeleteBucketIntelligentTieringConfigurationRequest" + }, + "traits": { + "smithy.api#documentation": "

Deletes the S3 Intelligent-Tiering configuration from the specified bucket.

\n

The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without additional operational overhead. S3 Intelligent-Tiering delivers automatic cost savings by moving data between access tiers, when access patterns change.

\n

The S3 Intelligent-Tiering storage class is suitable for objects larger than 128 KB that you plan to store for at least 30 days. If the size of an object is less than 128 KB, it is not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the frequent access tier rates in the S3 Intelligent-Tiering storage class.

\n

If you delete an object before the end of the 30-day minimum storage duration period, you are charged for 30 days. For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.

\n

Operations related to\n DeleteBucketIntelligentTieringConfiguration include:

\n ", + "smithy.api#http": { + "method": "DELETE", + "uri": "/{Bucket}?intelligent-tiering", + "code": 204 + } + } + }, + "com.amazonaws.s3#DeleteBucketIntelligentTieringConfigurationRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the Amazon S3 bucket whose configuration you want to modify or retrieve.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Id": { + "target": "com.amazonaws.s3#IntelligentTieringId", + "traits": { + "smithy.api#documentation": "

The ID used to identify the S3 Intelligent-Tiering configuration.

", + "smithy.api#httpQuery": "id", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.s3#DeleteBucketInventoryConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#DeleteBucketInventoryConfigurationRequest" + }, + "traits": { + "smithy.api#documentation": "

Deletes an inventory configuration (identified by the inventory ID) from the\n bucket.

\n

To use this operation, you must have permissions to perform the\n s3:PutInventoryConfiguration action. The bucket owner has this permission\n by default. The bucket owner can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources.

\n

For information about the Amazon S3 inventory feature, see Amazon S3 Inventory.

\n

Operations related to DeleteBucketInventoryConfiguration include:

\n ", + "smithy.api#http": { + "method": "DELETE", + "uri": "/{Bucket}?inventory", + "code": 204 + } + } + }, + "com.amazonaws.s3#DeleteBucketInventoryConfigurationRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket containing the inventory configuration to delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Id": { + "target": "com.amazonaws.s3#InventoryId", + "traits": { + "smithy.api#documentation": "

The ID used to identify the inventory configuration.

", + "smithy.api#httpQuery": "id", + "smithy.api#required": {} + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + } + }, + "com.amazonaws.s3#DeleteBucketLifecycle": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#DeleteBucketLifecycleRequest" + }, + "traits": { + "smithy.api#documentation": "

Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all the\n lifecycle configuration rules in the lifecycle subresource associated with the bucket. Your\n objects never expire, and Amazon S3 no longer automatically deletes any objects on the basis of\n rules contained in the deleted lifecycle configuration.

\n

To use this operation, you must have permission to perform the\n s3:PutLifecycleConfiguration action. By default, the bucket owner has this\n permission and the bucket owner can grant this permission to others.

\n\n

There is usually some time lag before lifecycle configuration deletion is fully\n propagated to all the Amazon S3 systems.

\n\n

For more information about the object expiration, see Elements to\n Describe Lifecycle Actions.

\n

Related actions include:

\n ", + "smithy.api#http": { + "method": "DELETE", + "uri": "/{Bucket}?lifecycle", + "code": 204 + } + } + }, + "com.amazonaws.s3#DeleteBucketLifecycleRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The bucket name of the lifecycle to delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + } + }, + "com.amazonaws.s3#DeleteBucketMetricsConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#DeleteBucketMetricsConfigurationRequest" + }, + "traits": { + "smithy.api#documentation": "

Deletes a metrics configuration for the Amazon CloudWatch request metrics (specified by the\n metrics configuration ID) from the bucket. Note that this doesn't include the daily storage\n metrics.

\n\n

To use this operation, you must have permissions to perform the\n s3:PutMetricsConfiguration action. The bucket owner has this permission by\n default. The bucket owner can grant this permission to others. For more information about\n permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources.

\n\n

For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon CloudWatch.

\n

The following operations are related to\n DeleteBucketMetricsConfiguration:

\n ", + "smithy.api#http": { + "method": "DELETE", + "uri": "/{Bucket}?metrics", + "code": 204 + } + } + }, + "com.amazonaws.s3#DeleteBucketMetricsConfigurationRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket containing the metrics configuration to delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Id": { + "target": "com.amazonaws.s3#MetricsId", + "traits": { + "smithy.api#documentation": "

The ID used to identify the metrics configuration.

", + "smithy.api#httpQuery": "id", + "smithy.api#required": {} + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + } + }, + "com.amazonaws.s3#DeleteBucketOwnershipControls": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#DeleteBucketOwnershipControlsRequest" + }, + "traits": { + "smithy.api#documentation": "

Removes OwnershipControls for an Amazon S3 bucket. To use this operation, you\n must have the s3:PutBucketOwnershipControls permission. For more information\n about Amazon S3 permissions, see Specifying\n Permissions in a Policy.

\n

For information about Amazon S3 Object Ownership, see Using Object Ownership.

\n

The following operations are related to\n DeleteBucketOwnershipControls:

\n ", + "smithy.api#http": { + "method": "DELETE", + "uri": "/{Bucket}?ownershipControls", + "code": 204 + } + } + }, + "com.amazonaws.s3#DeleteBucketOwnershipControlsRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The Amazon S3 bucket whose OwnershipControls you want to delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + } + }, + "com.amazonaws.s3#DeleteBucketPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#DeleteBucketPolicyRequest" + }, + "traits": { + "smithy.api#documentation": "

This implementation of the DELETE operation uses the policy subresource to delete the\n policy of a specified bucket. If you are using an identity other than the root user of the\n AWS account that owns the bucket, the calling identity must have the\n DeleteBucketPolicy permissions on the specified bucket and belong to the\n bucket owner's account to use this operation.

\n\n

If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a 403\n Access Denied error. If you have the correct permissions, but you're not using an\n identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not\n Allowed error.

\n\n\n \n

As a security precaution, the root user of the AWS account that owns a bucket can\n always use this operation, even if the policy explicitly denies the root user the\n ability to perform this action.

\n \n\n

For more information about bucket policies, see Using Bucket Policies and\n UserPolicies.

\n

The following operations are related to DeleteBucketPolicy\n

\n ", + "smithy.api#http": { + "method": "DELETE", + "uri": "/{Bucket}?policy", + "code": 204 + } + } + }, + "com.amazonaws.s3#DeleteBucketPolicyRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The bucket name.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + } + }, + "com.amazonaws.s3#DeleteBucketReplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#DeleteBucketReplicationRequest" + }, + "traits": { + "smithy.api#documentation": "

Deletes the replication configuration from the bucket.

\n

To use this operation, you must have permissions to perform the\n s3:PutReplicationConfiguration action. The bucket owner has these\n permissions by default and can grant it to others. For more information about permissions,\n see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources.

\n \n

It can take a while for the deletion of a replication configuration to fully\n propagate.

\n \n\n

For information about replication configuration, see Replication in the Amazon S3 Developer\n Guide.

\n\n

The following operations are related to DeleteBucketReplication:

\n ", + "smithy.api#http": { + "method": "DELETE", + "uri": "/{Bucket}?replication", + "code": 204 + } + } + }, + "com.amazonaws.s3#DeleteBucketReplicationRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The bucket name.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + } + }, + "com.amazonaws.s3#DeleteBucketRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

Specifies the bucket being deleted.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + } + }, + "com.amazonaws.s3#DeleteBucketTagging": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#DeleteBucketTaggingRequest" + }, + "traits": { + "smithy.api#documentation": "

Deletes the tags from the bucket.

\n\n

To use this operation, you must have permission to perform the\n s3:PutBucketTagging action. By default, the bucket owner has this\n permission and can grant this permission to others.

\n

The following operations are related to DeleteBucketTagging:

\n ", + "smithy.api#http": { + "method": "DELETE", + "uri": "/{Bucket}?tagging", + "code": 204 + } + } + }, + "com.amazonaws.s3#DeleteBucketTaggingRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The bucket that has the tag set to be removed.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + } + }, + "com.amazonaws.s3#DeleteBucketWebsite": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#DeleteBucketWebsiteRequest" + }, + "traits": { + "smithy.api#documentation": "

This operation removes the website configuration for a bucket. Amazon S3 returns a 200\n OK response upon successfully deleting a website configuration on the specified\n bucket. You will get a 200 OK response if the website configuration you are\n trying to delete does not exist on the bucket. Amazon S3 returns a 404 response if\n the bucket specified in the request does not exist.

\n\n

This DELETE operation requires the S3:DeleteBucketWebsite permission. By\n default, only the bucket owner can delete the website configuration attached to a bucket.\n However, bucket owners can grant other users permission to delete the website configuration\n by writing a bucket policy granting them the S3:DeleteBucketWebsite\n permission.

\n\n

For more information about hosting websites, see Hosting Websites on Amazon S3.

\n\n

The following operations are related to DeleteBucketWebsite:

\n ", + "smithy.api#http": { + "method": "DELETE", + "uri": "/{Bucket}?website", + "code": 204 + } + } + }, + "com.amazonaws.s3#DeleteBucketWebsiteRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The bucket name for which you want to remove the website configuration.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + } + }, + "com.amazonaws.s3#DeleteMarker": { + "type": "boolean" + }, + "com.amazonaws.s3#DeleteMarkerEntry": { + "type": "structure", + "members": { + "Owner": { + "target": "com.amazonaws.s3#Owner", + "traits": { + "smithy.api#documentation": "

The account that created the delete marker.>

" + } + }, + "Key": { + "target": "com.amazonaws.s3#ObjectKey", + "traits": { + "smithy.api#documentation": "

The object key.

" + } + }, + "VersionId": { + "target": "com.amazonaws.s3#ObjectVersionId", + "traits": { + "smithy.api#documentation": "

Version ID of an object.

" + } + }, + "IsLatest": { + "target": "com.amazonaws.s3#IsLatest", + "traits": { + "smithy.api#documentation": "

Specifies whether the object is (true) or is not (false) the latest version of an\n object.

" + } + }, + "LastModified": { + "target": "com.amazonaws.s3#LastModified", + "traits": { + "smithy.api#documentation": "

Date and time the object was last modified.

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

Information about the delete marker.

" + } + }, + "com.amazonaws.s3#DeleteMarkerReplication": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.s3#DeleteMarkerReplicationStatus", + "traits": { + "smithy.api#documentation": "

Indicates whether to replicate delete markers.

\n \n

Indicates whether to replicate delete markers.

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

Specifies whether Amazon S3 replicates delete markers. If you specify a Filter\n in your replication configuration, you must also include a\n DeleteMarkerReplication element. If your Filter includes a\n Tag element, the DeleteMarkerReplication\n Status must be set to Disabled, because Amazon S3 does not support replicating\n delete markers for tag-based rules. For an example configuration, see Basic Rule Configuration.

\n

For more information about delete marker replication, see Basic Rule\n Configuration.

\n \n

If you are using an earlier version of the replication configuration, Amazon S3 handles\n replication of delete markers differently. For more information, see Backward Compatibility.

\n " + } + }, + "com.amazonaws.s3#DeleteMarkerReplicationStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Enabled", + "name": "Enabled" + }, + { + "value": "Disabled", + "name": "Disabled" + } + ] + } + }, + "com.amazonaws.s3#DeleteMarkerVersionId": { + "type": "string" + }, + "com.amazonaws.s3#DeleteMarkers": { + "type": "list", + "member": { + "target": "com.amazonaws.s3#DeleteMarkerEntry" + } + }, + "com.amazonaws.s3#DeleteObject": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#DeleteObjectRequest" + }, + "output": { + "target": "com.amazonaws.s3#DeleteObjectOutput" + }, + "traits": { + "smithy.api#documentation": "

Removes the null version (if there is one) of an object and inserts a delete marker,\n which becomes the latest version of the object. If there isn't a null version, Amazon S3 does\n not remove any objects.

\n\n

To remove a specific version, you must be the bucket owner and you must use the version\n Id subresource. Using this subresource permanently deletes the version. If the object\n deleted is a delete marker, Amazon S3 sets the response header,\n x-amz-delete-marker, to true.

\n\n

If the object you want to delete is in a bucket where the bucket versioning\n configuration is MFA Delete enabled, you must include the x-amz-mfa request\n header in the DELETE versionId request. Requests that include\n x-amz-mfa must use HTTPS.

\n\n

For more information about MFA Delete, see Using MFA Delete. To see sample requests that use versioning, see Sample Request.

\n\n

You can delete objects by explicitly calling the DELETE Object API or configure its\n lifecycle (PutBucketLifecycle) to\n enable Amazon S3 to remove them for you. If you want to block users or accounts from removing or\n deleting objects from your bucket, you must deny them the s3:DeleteObject,\n s3:DeleteObjectVersion, and s3:PutLifeCycleConfiguration\n actions.

\n\n

The following operation is related to DeleteObject:

\n ", + "smithy.api#http": { + "method": "DELETE", + "uri": "/{Bucket}/{Key+}?x-id=DeleteObject", + "code": 204 + } + } + }, + "com.amazonaws.s3#DeleteObjectOutput": { + "type": "structure", + "members": { + "DeleteMarker": { + "target": "com.amazonaws.s3#DeleteMarker", + "traits": { + "smithy.api#documentation": "

Specifies whether the versioned object that was permanently deleted was (true) or was\n not (false) a delete marker.

", + "smithy.api#httpHeader": "x-amz-delete-marker" + } + }, + "VersionId": { + "target": "com.amazonaws.s3#ObjectVersionId", + "traits": { + "smithy.api#documentation": "

Returns the version ID of the delete marker created as a result of the DELETE\n operation.

", + "smithy.api#httpHeader": "x-amz-version-id" + } + }, + "RequestCharged": { + "target": "com.amazonaws.s3#RequestCharged", + "traits": { + "smithy.api#httpHeader": "x-amz-request-charged" + } + } + } + }, + "com.amazonaws.s3#DeleteObjectRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The bucket name of the bucket containing the object.

\n

When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.

\n

When using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Key": { + "target": "com.amazonaws.s3#ObjectKey", + "traits": { + "smithy.api#documentation": "

Key name of the object to delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "MFA": { + "target": "com.amazonaws.s3#MFA", + "traits": { + "smithy.api#documentation": "

The concatenation of the authentication device's serial number, a space, and the value\n that is displayed on your authentication device. Required to permanently delete a versioned\n object if versioning is configured with MFA delete enabled.

", + "smithy.api#httpHeader": "x-amz-mfa" + } + }, + "VersionId": { + "target": "com.amazonaws.s3#ObjectVersionId", + "traits": { + "smithy.api#documentation": "

VersionId used to reference a specific version of the object.

", + "smithy.api#httpQuery": "versionId" + } + }, + "RequestPayer": { + "target": "com.amazonaws.s3#RequestPayer", + "traits": { + "smithy.api#httpHeader": "x-amz-request-payer" + } + }, + "BypassGovernanceRetention": { + "target": "com.amazonaws.s3#BypassGovernanceRetention", + "traits": { + "smithy.api#documentation": "

Indicates whether S3 Object Lock should bypass Governance-mode restrictions to process\n this operation.

", + "smithy.api#httpHeader": "x-amz-bypass-governance-retention" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + } + }, + "com.amazonaws.s3#DeleteObjectTagging": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#DeleteObjectTaggingRequest" + }, + "output": { + "target": "com.amazonaws.s3#DeleteObjectTaggingOutput" + }, + "traits": { + "smithy.api#documentation": "

Removes the entire tag set from the specified object. For more information about\n managing object tags, see Object\n Tagging.

\n\n

To use this operation, you must have permission to perform the\n s3:DeleteObjectTagging action.

\n\n

To delete tags of a specific object version, add the versionId query\n parameter in the request. You will need permission for the\n s3:DeleteObjectVersionTagging action.

\n\n

The following operations are related to\n DeleteBucketMetricsConfiguration:

\n ", + "smithy.api#http": { + "method": "DELETE", + "uri": "/{Bucket}/{Key+}?tagging", + "code": 204 + } + } + }, + "com.amazonaws.s3#DeleteObjectTaggingOutput": { + "type": "structure", + "members": { + "VersionId": { + "target": "com.amazonaws.s3#ObjectVersionId", + "traits": { + "smithy.api#documentation": "

The versionId of the object the tag-set was removed from.

", + "smithy.api#httpHeader": "x-amz-version-id" + } + } + } + }, + "com.amazonaws.s3#DeleteObjectTaggingRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The bucket name containing the objects from which to remove the tags.

\n

When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.

\n

When using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Key": { + "target": "com.amazonaws.s3#ObjectKey", + "traits": { + "smithy.api#documentation": "

Name of the object key.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "VersionId": { + "target": "com.amazonaws.s3#ObjectVersionId", + "traits": { + "smithy.api#documentation": "

The versionId of the object that the tag-set will be removed from.

", + "smithy.api#httpQuery": "versionId" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + } + }, + "com.amazonaws.s3#DeleteObjects": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#DeleteObjectsRequest" + }, + "output": { + "target": "com.amazonaws.s3#DeleteObjectsOutput" + }, + "traits": { + "smithy.api#documentation": "

This operation enables you to delete multiple objects from a bucket using a single HTTP\n request. If you know the object keys that you want to delete, then this operation provides\n a suitable alternative to sending individual delete requests, reducing per-request\n overhead.

\n\n

The request contains a list of up to 1000 keys that you want to delete. In the XML, you\n provide the object key names, and optionally, version IDs if you want to delete a specific\n version of the object from a versioning-enabled bucket. For each key, Amazon S3 performs a\n delete operation and returns the result of that delete, success, or failure, in the\n response. Note that if the object specified in the request is not found, Amazon S3 returns the\n result as deleted.

\n\n

The operation supports two modes for the response: verbose and quiet. By default, the\n operation uses verbose mode in which the response includes the result of deletion of each\n key in your request. In quiet mode the response includes only keys where the delete\n operation encountered an error. For a successful deletion, the operation does not return\n any information about the delete in the response body.

\n\n

When performing this operation on an MFA Delete enabled bucket, that attempts to delete\n any versioned objects, you must include an MFA token. If you do not provide one, the entire\n request will fail, even if there are non-versioned objects you are trying to delete. If you\n provide an invalid token, whether there are versioned keys in the request or not, the\n entire Multi-Object Delete request will fail. For information about MFA Delete, see MFA\n Delete.

\n\n

Finally, the Content-MD5 header is required for all Multi-Object Delete requests. Amazon\n S3 uses the header value to ensure that your request body has not been altered in\n transit.

\n\n

The following operations are related to DeleteObjects:

\n ", + "smithy.api#http": { + "method": "POST", + "uri": "/{Bucket}?delete", + "code": 200 + }, + "smithy.api#httpChecksumRequired": {} + } + }, + "com.amazonaws.s3#DeleteObjectsOutput": { + "type": "structure", + "members": { + "Deleted": { + "target": "com.amazonaws.s3#DeletedObjects", + "traits": { + "smithy.api#documentation": "

Container element for a successful delete. It identifies the object that was\n successfully deleted.

", + "smithy.api#xmlFlattened": {} + } + }, + "RequestCharged": { + "target": "com.amazonaws.s3#RequestCharged", + "traits": { + "smithy.api#httpHeader": "x-amz-request-charged" + } + }, + "Errors": { + "target": "com.amazonaws.s3#Errors", + "traits": { + "smithy.api#documentation": "

Container for a failed delete operation that describes the object that Amazon S3 attempted to\n delete and the error it encountered.

", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "Error" + } + } + } + }, + "com.amazonaws.s3#DeleteObjectsRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The bucket name containing the objects to delete.

\n

When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.

\n

When using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Delete": { + "target": "com.amazonaws.s3#Delete", + "traits": { + "smithy.api#documentation": "

Container for the request.

", + "smithy.api#httpPayload": {}, + "smithy.api#required": {} + } + }, + "MFA": { + "target": "com.amazonaws.s3#MFA", + "traits": { + "smithy.api#documentation": "

The concatenation of the authentication device's serial number, a space, and the value\n that is displayed on your authentication device. Required to permanently delete a versioned\n object if versioning is configured with MFA delete enabled.

", + "smithy.api#httpHeader": "x-amz-mfa" + } + }, + "RequestPayer": { + "target": "com.amazonaws.s3#RequestPayer", + "traits": { + "smithy.api#httpHeader": "x-amz-request-payer" + } + }, + "BypassGovernanceRetention": { + "target": "com.amazonaws.s3#BypassGovernanceRetention", + "traits": { + "smithy.api#documentation": "

Specifies whether you want to delete this object even if it has a Governance-type Object\n Lock in place. You must have sufficient permissions to perform this operation.

", + "smithy.api#httpHeader": "x-amz-bypass-governance-retention" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + } + }, + "com.amazonaws.s3#DeletePublicAccessBlock": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#DeletePublicAccessBlockRequest" + }, + "traits": { + "smithy.api#documentation": "

Removes the PublicAccessBlock configuration for an Amazon S3 bucket. To use this\n operation, you must have the s3:PutBucketPublicAccessBlock permission. For\n more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources.

\n\n

The following operations are related to DeletePublicAccessBlock:

\n ", + "smithy.api#http": { + "method": "DELETE", + "uri": "/{Bucket}?publicAccessBlock", + "code": 204 + } + } + }, + "com.amazonaws.s3#DeletePublicAccessBlockRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The Amazon S3 bucket whose PublicAccessBlock configuration you want to delete.\n

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + } + }, + "com.amazonaws.s3#DeletedObject": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.s3#ObjectKey", + "traits": { + "smithy.api#documentation": "

The name of the deleted object.

" + } + }, + "VersionId": { + "target": "com.amazonaws.s3#ObjectVersionId", + "traits": { + "smithy.api#documentation": "

The version ID of the deleted object.

" + } + }, + "DeleteMarker": { + "target": "com.amazonaws.s3#DeleteMarker", + "traits": { + "smithy.api#documentation": "

Specifies whether the versioned object that was permanently deleted was (true) or was\n not (false) a delete marker. In a simple DELETE, this header indicates whether (true) or\n not (false) a delete marker was created.

" + } + }, + "DeleteMarkerVersionId": { + "target": "com.amazonaws.s3#DeleteMarkerVersionId", + "traits": { + "smithy.api#documentation": "

The version ID of the delete marker created as a result of the DELETE operation. If you\n delete a specific object version, the value returned by this header is the version ID of\n the object version deleted.

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

Information about the deleted object.

" + } + }, + "com.amazonaws.s3#DeletedObjects": { + "type": "list", + "member": { + "target": "com.amazonaws.s3#DeletedObject" + } + }, + "com.amazonaws.s3#Delimiter": { + "type": "string" + }, + "com.amazonaws.s3#Description": { + "type": "string" + }, + "com.amazonaws.s3#Destination": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the bucket where you want Amazon S3 to store the\n results.

", + "smithy.api#required": {} + } + }, + "Account": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

Destination bucket owner account ID. In a cross-account scenario, if you direct Amazon S3 to\n change replica ownership to the AWS account that owns the destination bucket by specifying\n the AccessControlTranslation property, this is the account ID of the\n destination bucket owner. For more information, see Replication Additional\n Configuration: Changing the Replica Owner in the Amazon Simple Storage\n Service Developer Guide.

" + } + }, + "StorageClass": { + "target": "com.amazonaws.s3#StorageClass", + "traits": { + "smithy.api#documentation": "

The storage class to use when replicating objects, such as S3 Standard or reduced\n redundancy. By default, Amazon S3 uses the storage class of the source object to create the\n object replica.

\n

For valid values, see the StorageClass element of the PUT Bucket\n replication action in the Amazon Simple Storage Service API Reference.

" + } + }, + "AccessControlTranslation": { + "target": "com.amazonaws.s3#AccessControlTranslation", + "traits": { + "smithy.api#documentation": "

Specify this only in a cross-account scenario (where source and destination bucket\n owners are not the same), and you want to change replica ownership to the AWS account that\n owns the destination bucket. If this is not specified in the replication configuration, the\n replicas are owned by same AWS account that owns the source object.

" + } + }, + "EncryptionConfiguration": { + "target": "com.amazonaws.s3#EncryptionConfiguration", + "traits": { + "smithy.api#documentation": "

A container that provides information about encryption. If\n SourceSelectionCriteria is specified, you must specify this element.

" + } + }, + "ReplicationTime": { + "target": "com.amazonaws.s3#ReplicationTime", + "traits": { + "smithy.api#documentation": "

A container specifying S3 Replication Time Control (S3 RTC), including whether S3 RTC is enabled and the time\n when all objects and operations on objects must be replicated. Must be specified together\n with a Metrics block.

" + } + }, + "Metrics": { + "target": "com.amazonaws.s3#Metrics", + "traits": { + "smithy.api#documentation": "

A container specifying replication metrics-related settings enabling replication\n metrics and events.

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

Specifies information about where to publish analysis or configuration results for an\n Amazon S3 bucket and S3 Replication Time Control (S3 RTC).

" + } + }, + "com.amazonaws.s3#DisplayName": { + "type": "string" + }, + "com.amazonaws.s3#ETag": { + "type": "string" + }, + "com.amazonaws.s3#EmailAddress": { + "type": "string" + }, + "com.amazonaws.s3#EnableRequestProgress": { + "type": "boolean" + }, + "com.amazonaws.s3#EncodingType": { + "type": "string", + "traits": { + "smithy.api#documentation": "

Requests Amazon S3 to encode the object keys in the response and specifies the encoding\n method to use. An object key may contain any Unicode character; however, XML 1.0 parser\n cannot parse some characters, such as characters with an ASCII value from 0 to 10. For\n characters that are not supported in XML 1.0, you can add this parameter to request that\n Amazon S3 encode the keys in the response.

", + "smithy.api#enum": [ + { + "value": "url", + "name": "url" + } + ] + } + }, + "com.amazonaws.s3#Encryption": { + "type": "structure", + "members": { + "EncryptionType": { + "target": "com.amazonaws.s3#ServerSideEncryption", + "traits": { + "smithy.api#documentation": "

The server-side encryption algorithm used when storing job results in Amazon S3 (for example,\n AES256, aws:kms).

", + "smithy.api#required": {} + } + }, + "KMSKeyId": { + "target": "com.amazonaws.s3#SSEKMSKeyId", + "traits": { + "smithy.api#documentation": "

If the encryption type is aws:kms, this optional value specifies the ID of\n the symmetric customer managed AWS KMS CMK to use for encryption of job results. Amazon S3 only\n supports symmetric CMKs. For more information, see Using Symmetric and\n Asymmetric Keys in the AWS Key Management Service Developer\n Guide.

" + } + }, + "KMSContext": { + "target": "com.amazonaws.s3#KMSContext", + "traits": { + "smithy.api#documentation": "

If the encryption type is aws:kms, this optional value can be used to\n specify the encryption context for the restore results.

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

Contains the type of server-side encryption used.

" + } + }, + "com.amazonaws.s3#EncryptionConfiguration": { + "type": "structure", + "members": { + "ReplicaKmsKeyID": { + "target": "com.amazonaws.s3#ReplicaKmsKeyID", + "traits": { + "smithy.api#documentation": "

Specifies the ID (Key ARN or Alias ARN) of the customer managed customer master key\n (CMK) stored in AWS Key Management Service (KMS) for the destination bucket. Amazon S3 uses\n this key to encrypt replica objects. Amazon S3 only supports symmetric customer managed CMKs.\n For more information, see Using Symmetric and\n Asymmetric Keys in the AWS Key Management Service Developer\n Guide.

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

Specifies encryption-related information for an Amazon S3 bucket that is a destination for\n replicated objects.

" + } + }, + "com.amazonaws.s3#End": { + "type": "long" + }, + "com.amazonaws.s3#EndEvent": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

A message that indicates the request is complete and no more messages will be sent. You\n should not assume that the request is complete until the client receives an\n EndEvent.

" + } + }, + "com.amazonaws.s3#Error": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.s3#ObjectKey", + "traits": { + "smithy.api#documentation": "

The error key.

" + } + }, + "VersionId": { + "target": "com.amazonaws.s3#ObjectVersionId", + "traits": { + "smithy.api#documentation": "

The version ID of the error.

" + } + }, + "Code": { + "target": "com.amazonaws.s3#Code", + "traits": { + "smithy.api#documentation": "

The error code is a string that uniquely identifies an error condition. It is meant to\n be read and understood by programs that detect and handle errors by type.

\n

\n Amazon S3 error codes\n

\n \n

" + } + }, + "Message": { + "target": "com.amazonaws.s3#Message", + "traits": { + "smithy.api#documentation": "

The error message contains a generic description of the error condition in English. It\n is intended for a human audience. Simple programs display the message directly to the end\n user if they encounter an error condition they don't know how or don't care to handle.\n Sophisticated programs with more exhaustive error handling and proper internationalization\n are more likely to ignore the error message.

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

Container for all error elements.

" + } + }, + "com.amazonaws.s3#ErrorDocument": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.s3#ObjectKey", + "traits": { + "smithy.api#documentation": "

The object key name to use when a 4XX class error occurs.

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

The error information.

" + } + }, + "com.amazonaws.s3#Errors": { + "type": "list", + "member": { + "target": "com.amazonaws.s3#Error" + } + }, + "com.amazonaws.s3#Event": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The bucket event for which to send notifications.

", + "smithy.api#enum": [ + { + "value": "s3:ReducedRedundancyLostObject" + }, + { + "value": "s3:ObjectCreated:*" + }, + { + "value": "s3:ObjectCreated:Put" + }, + { + "value": "s3:ObjectCreated:Post" + }, + { + "value": "s3:ObjectCreated:Copy" + }, + { + "value": "s3:ObjectCreated:CompleteMultipartUpload" + }, + { + "value": "s3:ObjectRemoved:*" + }, + { + "value": "s3:ObjectRemoved:Delete" + }, + { + "value": "s3:ObjectRemoved:DeleteMarkerCreated" + }, + { + "value": "s3:ObjectRestore:*" + }, + { + "value": "s3:ObjectRestore:Post" + }, + { + "value": "s3:ObjectRestore:Completed" + }, + { + "value": "s3:Replication:*" + }, + { + "value": "s3:Replication:OperationFailedReplication" + }, + { + "value": "s3:Replication:OperationNotTracked" + }, + { + "value": "s3:Replication:OperationMissedThreshold" + }, + { + "value": "s3:Replication:OperationReplicatedAfterThreshold" + } + ] + } + }, + "com.amazonaws.s3#EventList": { + "type": "list", + "member": { + "target": "com.amazonaws.s3#Event" + } + }, + "com.amazonaws.s3#ExistingObjectReplication": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.s3#ExistingObjectReplicationStatus", + "traits": { + "smithy.api#documentation": "

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

Optional configuration to replicate existing source bucket objects. For more\n information, see Replicating Existing Objects in the Amazon S3 Developer Guide.\n

" + } + }, + "com.amazonaws.s3#ExistingObjectReplicationStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Enabled", + "name": "Enabled" + }, + { + "value": "Disabled", + "name": "Disabled" + } + ] + } + }, + "com.amazonaws.s3#Expiration": { + "type": "string" + }, + "com.amazonaws.s3#ExpirationStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Enabled", + "name": "Enabled" + }, + { + "value": "Disabled", + "name": "Disabled" + } + ] + } + }, + "com.amazonaws.s3#ExpiredObjectDeleteMarker": { + "type": "boolean" + }, + "com.amazonaws.s3#Expires": { + "type": "timestamp" + }, + "com.amazonaws.s3#ExposeHeader": { + "type": "string" + }, + "com.amazonaws.s3#ExposeHeaders": { + "type": "list", + "member": { + "target": "com.amazonaws.s3#ExposeHeader" + } + }, + "com.amazonaws.s3#Expression": { + "type": "string" + }, + "com.amazonaws.s3#ExpressionType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "SQL", + "name": "SQL" + } + ] + } + }, + "com.amazonaws.s3#FetchOwner": { + "type": "boolean" + }, + "com.amazonaws.s3#FieldDelimiter": { + "type": "string" + }, + "com.amazonaws.s3#FileHeaderInfo": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "USE", + "name": "USE" + }, + { + "value": "IGNORE", + "name": "IGNORE" + }, + { + "value": "NONE", + "name": "NONE" + } + ] + } + }, + "com.amazonaws.s3#FilterRule": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.s3#FilterRuleName", + "traits": { + "smithy.api#documentation": "

The object key name prefix or suffix identifying one or more objects to which the\n filtering rule applies. The maximum length is 1,024 characters. Overlapping prefixes and\n suffixes are not supported. For more information, see Configuring Event Notifications\n in the Amazon Simple Storage Service Developer Guide.

" + } + }, + "Value": { + "target": "com.amazonaws.s3#FilterRuleValue", + "traits": { + "smithy.api#documentation": "

The value that the filter searches for in object key names.

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

Specifies the Amazon S3 object key name to filter on and whether to filter on the suffix or\n prefix of the key name.

" + } + }, + "com.amazonaws.s3#FilterRuleList": { + "type": "list", + "member": { + "target": "com.amazonaws.s3#FilterRule" + }, + "traits": { + "smithy.api#documentation": "

A list of containers for the key-value pair that defines the criteria for the filter\n rule.

" + } + }, + "com.amazonaws.s3#FilterRuleName": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "prefix", + "name": "prefix" + }, + { + "value": "suffix", + "name": "suffix" + } + ] + } + }, + "com.amazonaws.s3#FilterRuleValue": { + "type": "string" + }, + "com.amazonaws.s3#GetBucketAccelerateConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#GetBucketAccelerateConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.s3#GetBucketAccelerateConfigurationOutput" + }, + "traits": { + "smithy.api#documentation": "

This implementation of the GET operation uses the accelerate subresource to\n return the Transfer Acceleration state of a bucket, which is either Enabled or\n Suspended. Amazon S3 Transfer Acceleration is a bucket-level feature that\n enables you to perform faster data transfers to and from Amazon S3.

\n

To use this operation, you must have permission to perform the\n s3:GetAccelerateConfiguration action. The bucket owner has this permission\n by default. The bucket owner can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to your Amazon S3\n Resources in the Amazon Simple Storage Service Developer Guide.

\n

You set the Transfer Acceleration state of an existing bucket to Enabled or\n Suspended by using the PutBucketAccelerateConfiguration operation.

\n

A GET accelerate request does not return a state value for a bucket that\n has no transfer acceleration state. A bucket has no Transfer Acceleration state if a state\n has never been set on the bucket.

\n \n

For more information about transfer acceleration, see Transfer Acceleration in the\n Amazon Simple Storage Service Developer Guide.

\n

\n Related Resources\n

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/{Bucket}?accelerate", + "code": 200 + } + } + }, + "com.amazonaws.s3#GetBucketAccelerateConfigurationOutput": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.s3#BucketAccelerateStatus", + "traits": { + "smithy.api#documentation": "

The accelerate configuration of the bucket.

" + } + } + } + }, + "com.amazonaws.s3#GetBucketAccelerateConfigurationRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket for which the accelerate configuration is retrieved.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + } + }, + "com.amazonaws.s3#GetBucketAcl": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#GetBucketAclRequest" + }, + "output": { + "target": "com.amazonaws.s3#GetBucketAclOutput" + }, + "traits": { + "smithy.api#documentation": "

This implementation of the GET operation uses the acl\n subresource to return the access control list (ACL) of a bucket. To use GET to\n return the ACL of the bucket, you must have READ_ACP access to the bucket. If\n READ_ACP permission is granted to the anonymous user, you can return the\n ACL of the bucket without using an authorization header.

\n \n

\n Related Resources\n

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/{Bucket}?acl", + "code": 200 + } + } + }, + "com.amazonaws.s3#GetBucketAclOutput": { + "type": "structure", + "members": { + "Owner": { + "target": "com.amazonaws.s3#Owner", + "traits": { + "smithy.api#documentation": "

Container for the bucket owner's display name and ID.

" + } + }, + "Grants": { + "target": "com.amazonaws.s3#Grants", + "traits": { + "smithy.api#documentation": "

A list of grants.

", + "smithy.api#xmlName": "AccessControlList" + } + } + } + }, + "com.amazonaws.s3#GetBucketAclRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

Specifies the S3 bucket whose ACL is being requested.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + } + }, + "com.amazonaws.s3#GetBucketAnalyticsConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#GetBucketAnalyticsConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.s3#GetBucketAnalyticsConfigurationOutput" + }, + "traits": { + "smithy.api#documentation": "

This implementation of the GET operation returns an analytics configuration (identified\n by the analytics configuration ID) from the bucket.

\n

To use this operation, you must have permissions to perform the\n s3:GetAnalyticsConfiguration action. The bucket owner has this permission\n by default. The bucket owner can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources in the Amazon Simple Storage Service Developer Guide.

\n

For information about Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class\n Analysis in the Amazon Simple Storage Service Developer Guide.

\n \n

\n Related Resources\n

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/{Bucket}?analytics&x-id=GetBucketAnalyticsConfiguration", + "code": 200 + } + } + }, + "com.amazonaws.s3#GetBucketAnalyticsConfigurationOutput": { + "type": "structure", + "members": { + "AnalyticsConfiguration": { + "target": "com.amazonaws.s3#AnalyticsConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration and any analyses for the analytics filter.

", + "smithy.api#httpPayload": {} + } + } + } + }, + "com.amazonaws.s3#GetBucketAnalyticsConfigurationRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket from which an analytics configuration is retrieved.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Id": { + "target": "com.amazonaws.s3#AnalyticsId", + "traits": { + "smithy.api#documentation": "

The ID that identifies the analytics configuration.

", + "smithy.api#httpQuery": "id", + "smithy.api#required": {} + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + } + }, + "com.amazonaws.s3#GetBucketCors": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#GetBucketCorsRequest" + }, + "output": { + "target": "com.amazonaws.s3#GetBucketCorsOutput" + }, + "traits": { + "smithy.api#documentation": "

Returns the cors configuration information set for the bucket.

\n\n

To use this operation, you must have permission to perform the s3:GetBucketCORS action.\n By default, the bucket owner has this permission and can grant it to others.

\n\n

For more information about cors, see Enabling\n Cross-Origin Resource Sharing.

\n\n

The following operations are related to GetBucketCors:

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/{Bucket}?cors", + "code": 200 + } + } + }, + "com.amazonaws.s3#GetBucketCorsOutput": { + "type": "structure", + "members": { + "CORSRules": { + "target": "com.amazonaws.s3#CORSRules", + "traits": { + "smithy.api#documentation": "

A set of origins and methods (cross-origin access that you want to allow). You can add\n up to 100 rules to the configuration.

", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "CORSRule" + } + } + } + }, + "com.amazonaws.s3#GetBucketCorsRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The bucket name for which to get the cors configuration.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + } + }, + "com.amazonaws.s3#GetBucketEncryption": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#GetBucketEncryptionRequest" + }, + "output": { + "target": "com.amazonaws.s3#GetBucketEncryptionOutput" + }, + "traits": { + "smithy.api#documentation": "

Returns the default encryption configuration for an Amazon S3 bucket. For information about\n the Amazon S3 default encryption feature, see Amazon S3 Default Bucket Encryption.

\n\n

To use this operation, you must have permission to perform the\n s3:GetEncryptionConfiguration action. The bucket owner has this permission\n by default. The bucket owner can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources.

\n

The following operations are related to GetBucketEncryption:

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/{Bucket}?encryption", + "code": 200 + } + } + }, + "com.amazonaws.s3#GetBucketEncryptionOutput": { + "type": "structure", + "members": { + "ServerSideEncryptionConfiguration": { + "target": "com.amazonaws.s3#ServerSideEncryptionConfiguration", + "traits": { + "smithy.api#httpPayload": {} + } + } + } + }, + "com.amazonaws.s3#GetBucketEncryptionRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket from which the server-side encryption configuration is\n retrieved.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + } + }, + "com.amazonaws.s3#GetBucketIntelligentTieringConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#GetBucketIntelligentTieringConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.s3#GetBucketIntelligentTieringConfigurationOutput" + }, + "traits": { + "smithy.api#documentation": "

Gets the S3 Intelligent-Tiering configuration from the specified bucket.

\n

The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without additional operational overhead. S3 Intelligent-Tiering delivers automatic cost savings by moving data between access tiers, when access patterns change.

\n

The S3 Intelligent-Tiering storage class is suitable for objects larger than 128 KB that you plan to store for at least 30 days. If the size of an object is less than 128 KB, it is not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the frequent access tier rates in the S3 Intelligent-Tiering storage class.

\n

If you delete an object before the end of the 30-day minimum storage duration period, you are charged for 30 days. For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.

\n

Operations related to\n GetBucketIntelligentTieringConfiguration include:

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/{Bucket}?intelligent-tiering&x-id=GetBucketIntelligentTieringConfiguration", + "code": 200 + } + } + }, + "com.amazonaws.s3#GetBucketIntelligentTieringConfigurationOutput": { + "type": "structure", + "members": { + "IntelligentTieringConfiguration": { + "target": "com.amazonaws.s3#IntelligentTieringConfiguration", + "traits": { + "smithy.api#documentation": "

Container for S3 Intelligent-Tiering configuration.

", + "smithy.api#httpPayload": {} + } + } + } + }, + "com.amazonaws.s3#GetBucketIntelligentTieringConfigurationRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the Amazon S3 bucket whose configuration you want to modify or retrieve.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Id": { + "target": "com.amazonaws.s3#IntelligentTieringId", + "traits": { + "smithy.api#documentation": "

The ID used to identify the S3 Intelligent-Tiering configuration.

", + "smithy.api#httpQuery": "id", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.s3#GetBucketInventoryConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#GetBucketInventoryConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.s3#GetBucketInventoryConfigurationOutput" + }, + "traits": { + "smithy.api#documentation": "

Returns an inventory configuration (identified by the inventory configuration ID) from\n the bucket.

\n\n

To use this operation, you must have permissions to perform the\n s3:GetInventoryConfiguration action. The bucket owner has this permission\n by default and can grant this permission to others. For more information about permissions,\n see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources.

\n\n

For information about the Amazon S3 inventory feature, see Amazon S3 Inventory.

\n\n

The following operations are related to\n GetBucketInventoryConfiguration:

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/{Bucket}?inventory&x-id=GetBucketInventoryConfiguration", + "code": 200 + } + } + }, + "com.amazonaws.s3#GetBucketInventoryConfigurationOutput": { + "type": "structure", + "members": { + "InventoryConfiguration": { + "target": "com.amazonaws.s3#InventoryConfiguration", + "traits": { + "smithy.api#documentation": "

Specifies the inventory configuration.

", + "smithy.api#httpPayload": {} + } + } + } + }, + "com.amazonaws.s3#GetBucketInventoryConfigurationRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket containing the inventory configuration to retrieve.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Id": { + "target": "com.amazonaws.s3#InventoryId", + "traits": { + "smithy.api#documentation": "

The ID used to identify the inventory configuration.

", + "smithy.api#httpQuery": "id", + "smithy.api#required": {} + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + } + }, + "com.amazonaws.s3#GetBucketLifecycleConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#GetBucketLifecycleConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.s3#GetBucketLifecycleConfigurationOutput" + }, + "traits": { + "smithy.api#documentation": "\n

Bucket lifecycle configuration now supports specifying a lifecycle rule using an\n object key name prefix, one or more object tags, or a combination of both. Accordingly,\n this section describes the latest API. The response describes the new filter element\n that you can use to specify a filter to select a subset of objects to which the rule\n applies. If you are using a previous version of the lifecycle configuration, it still\n works. For the earlier API description, see GetBucketLifecycle.

\n \n

Returns the lifecycle configuration information set on the bucket. For information about\n lifecycle configuration, see Object\n Lifecycle Management.

\n\n

To use this operation, you must have permission to perform the\n s3:GetLifecycleConfiguration action. The bucket owner has this permission,\n by default. The bucket owner can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources.

\n\n

\n GetBucketLifecycleConfiguration has the following special error:

\n \n

The following operations are related to\n GetBucketLifecycleConfiguration:

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/{Bucket}?lifecycle", + "code": 200 + } + } + }, + "com.amazonaws.s3#GetBucketLifecycleConfigurationOutput": { + "type": "structure", + "members": { + "Rules": { + "target": "com.amazonaws.s3#LifecycleRules", + "traits": { + "smithy.api#documentation": "

Container for a lifecycle rule.

", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "Rule" + } + } + } + }, + "com.amazonaws.s3#GetBucketLifecycleConfigurationRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket for which to get the lifecycle information.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + } + }, + "com.amazonaws.s3#GetBucketLocation": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#GetBucketLocationRequest" + }, + "output": { + "target": "com.amazonaws.s3#GetBucketLocationOutput" + }, + "traits": { + "smithy.api#documentation": "

Returns the Region the bucket resides in. You set the bucket's Region using the\n LocationConstraint request parameter in a CreateBucket\n request. For more information, see CreateBucket.

\n\n

To use this implementation of the operation, you must be the bucket owner.

\n\n

The following operations are related to GetBucketLocation:

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/{Bucket}?location", + "code": 200 + } + } + }, + "com.amazonaws.s3#GetBucketLocationOutput": { + "type": "structure", + "members": { + "LocationConstraint": { + "target": "com.amazonaws.s3#BucketLocationConstraint", + "traits": { + "smithy.api#documentation": "

Specifies the Region where the bucket resides. For a list of all the Amazon S3 supported\n location constraints by Region, see Regions and Endpoints.\n Buckets in Region us-east-1 have a LocationConstraint of\n null.

" + } + } + } + }, + "com.amazonaws.s3#GetBucketLocationRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket for which to get the location.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + } + }, + "com.amazonaws.s3#GetBucketLogging": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#GetBucketLoggingRequest" + }, + "output": { + "target": "com.amazonaws.s3#GetBucketLoggingOutput" + }, + "traits": { + "smithy.api#documentation": "

Returns the logging status of a bucket and the permissions users have to view and modify\n that status. To use GET, you must be the bucket owner.

\n\n

The following operations are related to GetBucketLogging:

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/{Bucket}?logging", + "code": 200 + } + } }, - { - "target": "com.amazonaws.s3#GetBucketOwnershipControls" + "com.amazonaws.s3#GetBucketLoggingOutput": { + "type": "structure", + "members": { + "LoggingEnabled": { + "target": "com.amazonaws.s3#LoggingEnabled" + } + } + }, + "com.amazonaws.s3#GetBucketLoggingRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The bucket name for which to get the logging information.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + } + }, + "com.amazonaws.s3#GetBucketMetricsConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#GetBucketMetricsConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.s3#GetBucketMetricsConfigurationOutput" + }, + "traits": { + "smithy.api#documentation": "

Gets a metrics configuration (specified by the metrics configuration ID) from the\n bucket. Note that this doesn't include the daily storage metrics.

\n\n

To use this operation, you must have permissions to perform the\n s3:GetMetricsConfiguration action. The bucket owner has this permission by\n default. The bucket owner can grant this permission to others. For more information about\n permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources.

\n\n

For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon\n CloudWatch.

\n\n

The following operations are related to\n GetBucketMetricsConfiguration:

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/{Bucket}?metrics&x-id=GetBucketMetricsConfiguration", + "code": 200 + } + } + }, + "com.amazonaws.s3#GetBucketMetricsConfigurationOutput": { + "type": "structure", + "members": { + "MetricsConfiguration": { + "target": "com.amazonaws.s3#MetricsConfiguration", + "traits": { + "smithy.api#documentation": "

Specifies the metrics configuration.

", + "smithy.api#httpPayload": {} + } + } + } + }, + "com.amazonaws.s3#GetBucketMetricsConfigurationRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket containing the metrics configuration to retrieve.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Id": { + "target": "com.amazonaws.s3#MetricsId", + "traits": { + "smithy.api#documentation": "

The ID used to identify the metrics configuration.

", + "smithy.api#httpQuery": "id", + "smithy.api#required": {} + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + } + }, + "com.amazonaws.s3#GetBucketNotificationConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#GetBucketNotificationConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.s3#NotificationConfiguration" + }, + "traits": { + "smithy.api#documentation": "

Returns the notification configuration of a bucket.

\n

If notifications are not enabled on the bucket, the operation returns an empty\n NotificationConfiguration element.

\n\n

By default, you must be the bucket owner to read the notification configuration of a\n bucket. However, the bucket owner can use a bucket policy to grant permission to other\n users to read this configuration with the s3:GetBucketNotification\n permission.

\n\n

For more information about setting and reading the notification configuration on a\n bucket, see Setting Up Notification of\n Bucket Events. For more information about bucket policies, see Using Bucket Policies.

\n\n

The following operation is related to GetBucketNotification:

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/{Bucket}?notification", + "code": 200 + } + } + }, + "com.amazonaws.s3#GetBucketNotificationConfigurationRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket for which to get the notification configuration.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + } + }, + "com.amazonaws.s3#GetBucketOwnershipControls": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#GetBucketOwnershipControlsRequest" + }, + "output": { + "target": "com.amazonaws.s3#GetBucketOwnershipControlsOutput" + }, + "traits": { + "smithy.api#documentation": "

Retrieves OwnershipControls for an Amazon S3 bucket. To use this operation, you\n must have the s3:GetBucketOwnershipControls permission. For more information\n about Amazon S3 permissions, see Specifying\n Permissions in a Policy.

\n

For information about Amazon S3 Object Ownership, see Using Object Ownership.

\n

The following operations are related to GetBucketOwnershipControls:

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/{Bucket}?ownershipControls", + "code": 200 + } + } + }, + "com.amazonaws.s3#GetBucketOwnershipControlsOutput": { + "type": "structure", + "members": { + "OwnershipControls": { + "target": "com.amazonaws.s3#OwnershipControls", + "traits": { + "smithy.api#documentation": "

The OwnershipControls (BucketOwnerPreferred or ObjectWriter) currently in\n effect for this Amazon S3 bucket.

", + "smithy.api#httpPayload": {} + } + } + } + }, + "com.amazonaws.s3#GetBucketOwnershipControlsRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the Amazon S3 bucket whose OwnershipControls you want to retrieve.\n

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + } + }, + "com.amazonaws.s3#GetBucketPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#GetBucketPolicyRequest" + }, + "output": { + "target": "com.amazonaws.s3#GetBucketPolicyOutput" + }, + "traits": { + "smithy.api#documentation": "

Returns the policy of a specified bucket. If you are using an identity other than the\n root user of the AWS account that owns the bucket, the calling identity must have the\n GetBucketPolicy permissions on the specified bucket and belong to the\n bucket owner's account in order to use this operation.

\n\n

If you don't have GetBucketPolicy permissions, Amazon S3 returns a 403\n Access Denied error. If you have the correct permissions, but you're not using an\n identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not\n Allowed error.

\n\n \n

As a security precaution, the root user of the AWS account that owns a bucket can\n always use this operation, even if the policy explicitly denies the root user the\n ability to perform this action.

\n \n\n

For more information about bucket policies, see Using Bucket Policies and User\n Policies.

\n\n

The following operation is related to GetBucketPolicy:

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/{Bucket}?policy", + "code": 200 + } + } + }, + "com.amazonaws.s3#GetBucketPolicyOutput": { + "type": "structure", + "members": { + "Policy": { + "target": "com.amazonaws.s3#Policy", + "traits": { + "smithy.api#documentation": "

The bucket policy as a JSON document.

" + } + } + } + }, + "com.amazonaws.s3#GetBucketPolicyRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The bucket name for which to get the bucket policy.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + } + }, + "com.amazonaws.s3#GetBucketPolicyStatus": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#GetBucketPolicyStatusRequest" + }, + "output": { + "target": "com.amazonaws.s3#GetBucketPolicyStatusOutput" + }, + "traits": { + "smithy.api#documentation": "

Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket is public.\n In order to use this operation, you must have the s3:GetBucketPolicyStatus\n permission. For more information about Amazon S3 permissions, see Specifying Permissions in a\n Policy.

\n\n

For more information about when Amazon S3 considers a bucket public, see The Meaning of \"Public\".

\n\n

The following operations are related to GetBucketPolicyStatus:

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/{Bucket}?policyStatus", + "code": 200 + } + } + }, + "com.amazonaws.s3#GetBucketPolicyStatusOutput": { + "type": "structure", + "members": { + "PolicyStatus": { + "target": "com.amazonaws.s3#PolicyStatus", + "traits": { + "smithy.api#documentation": "

The policy status for the specified bucket.

", + "smithy.api#httpPayload": {} + } + } + } + }, + "com.amazonaws.s3#GetBucketPolicyStatusRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the Amazon S3 bucket whose policy status you want to retrieve.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + } + }, + "com.amazonaws.s3#GetBucketReplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#GetBucketReplicationRequest" + }, + "output": { + "target": "com.amazonaws.s3#GetBucketReplicationOutput" + }, + "traits": { + "smithy.api#documentation": "

Returns the replication configuration of a bucket.

\n \n

It can take a while to propagate the put or delete a replication configuration to\n all Amazon S3 systems. Therefore, a get request soon after put or delete can return a wrong\n result.

\n \n

For information about replication configuration, see Replication in the\n Amazon Simple Storage Service Developer Guide.

\n\n

This operation requires permissions for the s3:GetReplicationConfiguration\n action. For more information about permissions, see Using Bucket Policies and User\n Policies.

\n\n

If you include the Filter element in a replication configuration, you must\n also include the DeleteMarkerReplication and Priority elements.\n The response also returns those elements.

\n\n

For information about GetBucketReplication errors, see List of\n replication-related error codes\n

\n\n\n

The following operations are related to GetBucketReplication:

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/{Bucket}?replication", + "code": 200 + } + } + }, + "com.amazonaws.s3#GetBucketReplicationOutput": { + "type": "structure", + "members": { + "ReplicationConfiguration": { + "target": "com.amazonaws.s3#ReplicationConfiguration", + "traits": { + "smithy.api#httpPayload": {} + } + } + } + }, + "com.amazonaws.s3#GetBucketReplicationRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The bucket name for which to get the replication information.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + } + }, + "com.amazonaws.s3#GetBucketRequestPayment": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#GetBucketRequestPaymentRequest" + }, + "output": { + "target": "com.amazonaws.s3#GetBucketRequestPaymentOutput" + }, + "traits": { + "smithy.api#documentation": "

Returns the request payment configuration of a bucket. To use this version of the\n operation, you must be the bucket owner. For more information, see Requester Pays Buckets.

\n\n

The following operations are related to GetBucketRequestPayment:

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/{Bucket}?requestPayment", + "code": 200 + } + } + }, + "com.amazonaws.s3#GetBucketRequestPaymentOutput": { + "type": "structure", + "members": { + "Payer": { + "target": "com.amazonaws.s3#Payer", + "traits": { + "smithy.api#documentation": "

Specifies who pays for the download and request fees.

" + } + } + } + }, + "com.amazonaws.s3#GetBucketRequestPaymentRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket for which to get the payment request configuration

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + } + }, + "com.amazonaws.s3#GetBucketTagging": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#GetBucketTaggingRequest" + }, + "output": { + "target": "com.amazonaws.s3#GetBucketTaggingOutput" + }, + "traits": { + "smithy.api#documentation": "

Returns the tag set associated with the bucket.

\n

To use this operation, you must have permission to perform the\n s3:GetBucketTagging action. By default, the bucket owner has this\n permission and can grant this permission to others.

\n\n

\n GetBucketTagging has the following special error:

\n \n\n

The following operations are related to GetBucketTagging:

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/{Bucket}?tagging", + "code": 200 + } + } + }, + "com.amazonaws.s3#GetBucketTaggingOutput": { + "type": "structure", + "members": { + "TagSet": { + "target": "com.amazonaws.s3#TagSet", + "traits": { + "smithy.api#documentation": "

Contains the tag set.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.s3#GetBucketTaggingRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket for which to get the tagging information.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + } + }, + "com.amazonaws.s3#GetBucketVersioning": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#GetBucketVersioningRequest" + }, + "output": { + "target": "com.amazonaws.s3#GetBucketVersioningOutput" + }, + "traits": { + "smithy.api#documentation": "

Returns the versioning state of a bucket.

\n

To retrieve the versioning state of a bucket, you must be the bucket owner.

\n\n

This implementation also returns the MFA Delete status of the versioning state. If the\n MFA Delete status is enabled, the bucket owner must use an authentication\n device to change the versioning state of the bucket.

\n\n

The following operations are related to GetBucketVersioning:

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/{Bucket}?versioning", + "code": 200 + } + } + }, + "com.amazonaws.s3#GetBucketVersioningOutput": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.s3#BucketVersioningStatus", + "traits": { + "smithy.api#documentation": "

The versioning state of the bucket.

" + } + }, + "MFADelete": { + "target": "com.amazonaws.s3#MFADeleteStatus", + "traits": { + "smithy.api#documentation": "

Specifies whether MFA delete is enabled in the bucket versioning configuration. This\n element is only returned if the bucket has been configured with MFA delete. If the bucket\n has never been so configured, this element is not returned.

", + "smithy.api#xmlName": "MfaDelete" + } + } + } + }, + "com.amazonaws.s3#GetBucketVersioningRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket for which to get the versioning information.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + } + }, + "com.amazonaws.s3#GetBucketWebsite": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#GetBucketWebsiteRequest" + }, + "output": { + "target": "com.amazonaws.s3#GetBucketWebsiteOutput" + }, + "traits": { + "smithy.api#documentation": "

Returns the website configuration for a bucket. To host website on Amazon S3, you can\n configure a bucket as website by adding a website configuration. For more information about\n hosting websites, see Hosting Websites on\n Amazon S3.

\n

This GET operation requires the S3:GetBucketWebsite permission. By default,\n only the bucket owner can read the bucket website configuration. However, bucket owners can\n allow other users to read the website configuration by writing a bucket policy granting\n them the S3:GetBucketWebsite permission.

\n

The following operations are related to DeleteBucketWebsite:

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/{Bucket}?website", + "code": 200 + } + } + }, + "com.amazonaws.s3#GetBucketWebsiteOutput": { + "type": "structure", + "members": { + "RedirectAllRequestsTo": { + "target": "com.amazonaws.s3#RedirectAllRequestsTo", + "traits": { + "smithy.api#documentation": "

Specifies the redirect behavior of all requests to a website endpoint of an Amazon S3\n bucket.

" + } + }, + "IndexDocument": { + "target": "com.amazonaws.s3#IndexDocument", + "traits": { + "smithy.api#documentation": "

The name of the index document for the website (for example\n index.html).

" + } + }, + "ErrorDocument": { + "target": "com.amazonaws.s3#ErrorDocument", + "traits": { + "smithy.api#documentation": "

The object key name of the website error document to use for 4XX class errors.

" + } + }, + "RoutingRules": { + "target": "com.amazonaws.s3#RoutingRules", + "traits": { + "smithy.api#documentation": "

Rules that define when a redirect is applied and the redirect behavior.

" + } + } + } + }, + "com.amazonaws.s3#GetBucketWebsiteRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The bucket name for which to get the website configuration.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + } + }, + "com.amazonaws.s3#GetObject": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#GetObjectRequest" + }, + "output": { + "target": "com.amazonaws.s3#GetObjectOutput" + }, + "errors": [ + { + "target": "com.amazonaws.s3#InvalidObjectState" + }, + { + "target": "com.amazonaws.s3#NoSuchKey" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves objects from Amazon S3. To use GET, you must have READ\n access to the object. If you grant READ access to the anonymous user, you can\n return the object without using an authorization header.

\n\n

An Amazon S3 bucket has no directory hierarchy such as you would find in a typical computer\n file system. You can, however, create a logical hierarchy by using object key names that\n imply a folder structure. For example, instead of naming an object sample.jpg,\n you can name it photos/2006/February/sample.jpg.

\n\n

To get an object from such a logical hierarchy, specify the full key name for the object\n in the GET operation. For a virtual hosted-style request example, if you have\n the object photos/2006/February/sample.jpg, specify the resource as\n /photos/2006/February/sample.jpg. For a path-style request example, if you\n have the object photos/2006/February/sample.jpg in the bucket named\n examplebucket, specify the resource as\n /examplebucket/photos/2006/February/sample.jpg. For more information about\n request types, see HTTP Host Header Bucket Specification.

\n\n

To distribute large files to many people, you can save bandwidth costs by using\n BitTorrent. For more information, see Amazon S3\n Torrent. For more information about returning the ACL of an object, see GetObjectAcl.

\n\n

If the object you are retrieving is stored in the S3 Glacier or\n S3 Glacier Deep Archive storage class, or S3 Intelligent-Tiering Archive or\n S3 Intelligent-Tiering Deep Archive tiers, before you can retrieve the object you must first restore a\n copy using RestoreObject. Otherwise, this operation returns an\n InvalidObjectStateError error. For information about restoring archived\n objects, see Restoring Archived\n Objects.

\n\n

Encryption request headers, like x-amz-server-side-encryption, should not\n be sent for GET requests if your object uses server-side encryption with CMKs stored in AWS\n KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption keys (SSE-S3). If your\n object does use these types of keys, you’ll get an HTTP 400 BadRequest error.

\n

If you encrypt an object by using server-side encryption with customer-provided\n encryption keys (SSE-C) when you store the object in Amazon S3, then when you GET the object,\n you must use the following headers:

\n \n

For more information about SSE-C, see Server-Side Encryption (Using\n Customer-Provided Encryption Keys).

\n\n

Assuming you have permission to read object tags (permission for the\n s3:GetObjectVersionTagging action), the response also returns the\n x-amz-tagging-count header that provides the count of number of tags\n associated with the object. You can use GetObjectTagging to retrieve\n the tag set associated with an object.

\n\n

\n Permissions\n

\n

You need the s3:GetObject permission for this operation. For more\n information, see Specifying Permissions\n in a Policy. If the object you request does not exist, the error Amazon S3 returns\n depends on whether you also have the s3:ListBucket permission.

\n \n\n\n

\n Versioning\n

\n

By default, the GET operation returns the current version of an object. To return a\n different version, use the versionId subresource.

\n\n \n

If the current version of the object is a delete marker, Amazon S3 behaves as if the\n object was deleted and includes x-amz-delete-marker: true in the\n response.

\n \n\n\n

For more information about versioning, see PutBucketVersioning.

\n\n

\n Overriding Response Header Values\n

\n

There are times when you want to override certain response header values in a GET\n response. For example, you might override the Content-Disposition response header value in\n your GET request.

\n\n

You can override values for a set of response headers using the following query\n parameters. These response header values are sent only on a successful request, that is,\n when status code 200 OK is returned. The set of headers you can override using these\n parameters is a subset of the headers that Amazon S3 accepts when you create an object. The\n response headers that you can override for the GET response are Content-Type,\n Content-Language, Expires, Cache-Control,\n Content-Disposition, and Content-Encoding. To override these\n header values in the GET response, you use the following request parameters.

\n\n \n

You must sign the request, either using an Authorization header or a presigned URL,\n when using these parameters. They cannot be used with an unsigned (anonymous)\n request.

\n \n \n\n

\n Additional Considerations about Request Headers\n

\n\n

If both of the If-Match and If-Unmodified-Since headers are\n present in the request as follows: If-Match condition evaluates to\n true, and; If-Unmodified-Since condition evaluates to\n false; then, S3 returns 200 OK and the data requested.

\n\n

If both of the If-None-Match and If-Modified-Since headers are\n present in the request as follows: If-None-Match condition evaluates to\n false, and; If-Modified-Since condition evaluates to\n true; then, S3 returns 304 Not Modified response code.

\n\n

For more information about conditional requests, see RFC 7232.

\n\n

The following operations are related to GetObject:

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/{Bucket}/{Key+}?x-id=GetObject", + "code": 200 + } + } + }, + "com.amazonaws.s3#GetObjectAcl": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#GetObjectAclRequest" + }, + "output": { + "target": "com.amazonaws.s3#GetObjectAclOutput" + }, + "errors": [ + { + "target": "com.amazonaws.s3#NoSuchKey" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the access control list (ACL) of an object. To use this operation, you must have\n READ_ACP access to the object.

\n

This action is not supported by Amazon S3 on Outposts.

\n

\n Versioning\n

\n

By default, GET returns ACL information about the current version of an object. To\n return ACL information about a different version, use the versionId subresource.

\n\n

The following operations are related to GetObjectAcl:

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/{Bucket}/{Key+}?acl", + "code": 200 + } + } + }, + "com.amazonaws.s3#GetObjectAclOutput": { + "type": "structure", + "members": { + "Owner": { + "target": "com.amazonaws.s3#Owner", + "traits": { + "smithy.api#documentation": "

Container for the bucket owner's display name and ID.

" + } + }, + "Grants": { + "target": "com.amazonaws.s3#Grants", + "traits": { + "smithy.api#documentation": "

A list of grants.

", + "smithy.api#xmlName": "AccessControlList" + } + }, + "RequestCharged": { + "target": "com.amazonaws.s3#RequestCharged", + "traits": { + "smithy.api#httpHeader": "x-amz-request-charged" + } + } + } + }, + "com.amazonaws.s3#GetObjectAclRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The bucket name that contains the object for which to get the ACL information.

\n

When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Key": { + "target": "com.amazonaws.s3#ObjectKey", + "traits": { + "smithy.api#documentation": "

The key of the object for which to get the ACL information.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "VersionId": { + "target": "com.amazonaws.s3#ObjectVersionId", + "traits": { + "smithy.api#documentation": "

VersionId used to reference a specific version of the object.

", + "smithy.api#httpQuery": "versionId" + } + }, + "RequestPayer": { + "target": "com.amazonaws.s3#RequestPayer", + "traits": { + "smithy.api#httpHeader": "x-amz-request-payer" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + } + }, + "com.amazonaws.s3#GetObjectLegalHold": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#GetObjectLegalHoldRequest" + }, + "output": { + "target": "com.amazonaws.s3#GetObjectLegalHoldOutput" + }, + "traits": { + "smithy.api#documentation": "

Gets an object's current Legal Hold status. For more information, see Locking Objects.

\n

This action is not supported by Amazon S3 on Outposts.

", + "smithy.api#http": { + "method": "GET", + "uri": "/{Bucket}/{Key+}?legal-hold", + "code": 200 + } + } + }, + "com.amazonaws.s3#GetObjectLegalHoldOutput": { + "type": "structure", + "members": { + "LegalHold": { + "target": "com.amazonaws.s3#ObjectLockLegalHold", + "traits": { + "smithy.api#documentation": "

The current Legal Hold status for the specified object.

", + "smithy.api#httpPayload": {} + } + } + } + }, + "com.amazonaws.s3#GetObjectLegalHoldRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The bucket name containing the object whose Legal Hold status you want to retrieve.

\n

When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Key": { + "target": "com.amazonaws.s3#ObjectKey", + "traits": { + "smithy.api#documentation": "

The key name for the object whose Legal Hold status you want to retrieve.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "VersionId": { + "target": "com.amazonaws.s3#ObjectVersionId", + "traits": { + "smithy.api#documentation": "

The version ID of the object whose Legal Hold status you want to retrieve.

", + "smithy.api#httpQuery": "versionId" + } + }, + "RequestPayer": { + "target": "com.amazonaws.s3#RequestPayer", + "traits": { + "smithy.api#httpHeader": "x-amz-request-payer" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + } + }, + "com.amazonaws.s3#GetObjectLockConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#GetObjectLockConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.s3#GetObjectLockConfigurationOutput" + }, + "traits": { + "smithy.api#documentation": "

Gets the Object Lock configuration for a bucket. The rule specified in the Object Lock\n configuration will be applied by default to every new object placed in the specified\n bucket. For more information, see Locking\n Objects.

", + "smithy.api#http": { + "method": "GET", + "uri": "/{Bucket}?object-lock", + "code": 200 + } + } + }, + "com.amazonaws.s3#GetObjectLockConfigurationOutput": { + "type": "structure", + "members": { + "ObjectLockConfiguration": { + "target": "com.amazonaws.s3#ObjectLockConfiguration", + "traits": { + "smithy.api#documentation": "

The specified bucket's Object Lock configuration.

", + "smithy.api#httpPayload": {} + } + } + } + }, + "com.amazonaws.s3#GetObjectLockConfigurationRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The bucket whose Object Lock configuration you want to retrieve.

\n

When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + } + }, + "com.amazonaws.s3#GetObjectOutput": { + "type": "structure", + "members": { + "Body": { + "target": "com.amazonaws.s3#StreamingBlob", + "traits": { + "smithy.api#documentation": "

Object data.

", + "smithy.api#httpPayload": {} + } + }, + "DeleteMarker": { + "target": "com.amazonaws.s3#DeleteMarker", + "traits": { + "smithy.api#documentation": "

Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If\n false, this response header does not appear in the response.

", + "smithy.api#httpHeader": "x-amz-delete-marker" + } + }, + "AcceptRanges": { + "target": "com.amazonaws.s3#AcceptRanges", + "traits": { + "smithy.api#documentation": "

Indicates that a range of bytes was specified.

", + "smithy.api#httpHeader": "accept-ranges" + } + }, + "Expiration": { + "target": "com.amazonaws.s3#Expiration", + "traits": { + "smithy.api#documentation": "

If the object expiration is configured (see PUT Bucket lifecycle), the response includes\n this header. It includes the expiry-date and rule-id key-value pairs providing object\n expiration information. The value of the rule-id is URL encoded.

", + "smithy.api#httpHeader": "x-amz-expiration" + } + }, + "Restore": { + "target": "com.amazonaws.s3#Restore", + "traits": { + "smithy.api#documentation": "

Provides information about object restoration operation and expiration time of the\n restored object copy.

", + "smithy.api#httpHeader": "x-amz-restore" + } + }, + "LastModified": { + "target": "com.amazonaws.s3#LastModified", + "traits": { + "smithy.api#documentation": "

Last modified date of the object

", + "smithy.api#httpHeader": "Last-Modified" + } + }, + "ContentLength": { + "target": "com.amazonaws.s3#ContentLength", + "traits": { + "smithy.api#documentation": "

Size of the body in bytes.

", + "smithy.api#httpHeader": "Content-Length" + } + }, + "ETag": { + "target": "com.amazonaws.s3#ETag", + "traits": { + "smithy.api#documentation": "

An ETag is an opaque identifier assigned by a web server to a specific version of a\n resource found at a URL.

", + "smithy.api#httpHeader": "ETag" + } + }, + "MissingMeta": { + "target": "com.amazonaws.s3#MissingMeta", + "traits": { + "smithy.api#documentation": "

This is set to the number of metadata entries not returned in x-amz-meta\n headers. This can happen if you create metadata using an API like SOAP that supports more\n flexible metadata than the REST API. For example, using SOAP, you can create metadata whose\n values are not legal HTTP headers.

", + "smithy.api#httpHeader": "x-amz-missing-meta" + } + }, + "VersionId": { + "target": "com.amazonaws.s3#ObjectVersionId", + "traits": { + "smithy.api#documentation": "

Version of the object.

", + "smithy.api#httpHeader": "x-amz-version-id" + } + }, + "CacheControl": { + "target": "com.amazonaws.s3#CacheControl", + "traits": { + "smithy.api#documentation": "

Specifies caching behavior along the request/reply chain.

", + "smithy.api#httpHeader": "Cache-Control" + } + }, + "ContentDisposition": { + "target": "com.amazonaws.s3#ContentDisposition", + "traits": { + "smithy.api#documentation": "

Specifies presentational information for the object.

", + "smithy.api#httpHeader": "Content-Disposition" + } + }, + "ContentEncoding": { + "target": "com.amazonaws.s3#ContentEncoding", + "traits": { + "smithy.api#documentation": "

Specifies what content encodings have been applied to the object and thus what decoding\n mechanisms must be applied to obtain the media-type referenced by the Content-Type header\n field.

", + "smithy.api#httpHeader": "Content-Encoding" + } + }, + "ContentLanguage": { + "target": "com.amazonaws.s3#ContentLanguage", + "traits": { + "smithy.api#documentation": "

The language the content is in.

", + "smithy.api#httpHeader": "Content-Language" + } + }, + "ContentRange": { + "target": "com.amazonaws.s3#ContentRange", + "traits": { + "smithy.api#documentation": "

The portion of the object returned in the response.

", + "smithy.api#httpHeader": "Content-Range" + } + }, + "ContentType": { + "target": "com.amazonaws.s3#ContentType", + "traits": { + "smithy.api#documentation": "

A standard MIME type describing the format of the object data.

", + "smithy.api#httpHeader": "Content-Type" + } + }, + "Expires": { + "target": "com.amazonaws.s3#Expires", + "traits": { + "smithy.api#documentation": "

The date and time at which the object is no longer cacheable.

", + "smithy.api#httpHeader": "Expires" + } + }, + "WebsiteRedirectLocation": { + "target": "com.amazonaws.s3#WebsiteRedirectLocation", + "traits": { + "smithy.api#documentation": "

If the bucket is configured as a website, redirects requests for this object to another\n object in the same bucket or to an external URL. Amazon S3 stores the value of this header in\n the object metadata.

", + "smithy.api#httpHeader": "x-amz-website-redirect-location" + } + }, + "ServerSideEncryption": { + "target": "com.amazonaws.s3#ServerSideEncryption", + "traits": { + "smithy.api#documentation": "

The server-side encryption algorithm used when storing this object in Amazon S3 (for example,\n AES256, aws:kms).

", + "smithy.api#httpHeader": "x-amz-server-side-encryption" + } + }, + "Metadata": { + "target": "com.amazonaws.s3#Metadata", + "traits": { + "smithy.api#documentation": "

A map of metadata to store with the object in S3.

", + "smithy.api#httpPrefixHeaders": "x-amz-meta-" + } + }, + "SSECustomerAlgorithm": { + "target": "com.amazonaws.s3#SSECustomerAlgorithm", + "traits": { + "smithy.api#documentation": "

If server-side encryption with a customer-provided encryption key was requested, the\n response will include this header confirming the encryption algorithm used.

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-algorithm" + } + }, + "SSECustomerKeyMD5": { + "target": "com.amazonaws.s3#SSECustomerKeyMD5", + "traits": { + "smithy.api#documentation": "

If server-side encryption with a customer-provided encryption key was requested, the\n response will include this header to provide round-trip message integrity verification of\n the customer-provided encryption key.

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key-MD5" + } + }, + "SSEKMSKeyId": { + "target": "com.amazonaws.s3#SSEKMSKeyId", + "traits": { + "smithy.api#documentation": "

If present, specifies the ID of the AWS Key Management Service (AWS KMS) symmetric\n customer managed customer master key (CMK) that was used for the object.

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" + } + }, + "BucketKeyEnabled": { + "target": "com.amazonaws.s3#BucketKeyEnabled", + "traits": { + "smithy.api#documentation": "

Indicates whether the object uses an S3 Bucket Key for server-side encryption with AWS KMS (SSE-KMS).

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-bucket-key-enabled" + } + }, + "StorageClass": { + "target": "com.amazonaws.s3#StorageClass", + "traits": { + "smithy.api#documentation": "

Provides storage class information of the object. Amazon S3 returns this header for all\n objects except for S3 Standard storage class objects.

", + "smithy.api#httpHeader": "x-amz-storage-class" + } + }, + "RequestCharged": { + "target": "com.amazonaws.s3#RequestCharged", + "traits": { + "smithy.api#httpHeader": "x-amz-request-charged" + } + }, + "ReplicationStatus": { + "target": "com.amazonaws.s3#ReplicationStatus", + "traits": { + "smithy.api#documentation": "

Amazon S3 can return this if your request involves a bucket that is either a source or\n destination in a replication rule.

", + "smithy.api#httpHeader": "x-amz-replication-status" + } + }, + "PartsCount": { + "target": "com.amazonaws.s3#PartsCount", + "traits": { + "smithy.api#documentation": "

The count of parts this object has.

", + "smithy.api#httpHeader": "x-amz-mp-parts-count" + } + }, + "TagCount": { + "target": "com.amazonaws.s3#TagCount", + "traits": { + "smithy.api#documentation": "

The number of tags, if any, on the object.

", + "smithy.api#httpHeader": "x-amz-tagging-count" + } + }, + "ObjectLockMode": { + "target": "com.amazonaws.s3#ObjectLockMode", + "traits": { + "smithy.api#documentation": "

The Object Lock mode currently in place for this object.

", + "smithy.api#httpHeader": "x-amz-object-lock-mode" + } + }, + "ObjectLockRetainUntilDate": { + "target": "com.amazonaws.s3#ObjectLockRetainUntilDate", + "traits": { + "smithy.api#documentation": "

The date and time when this object's Object Lock will expire.

", + "smithy.api#httpHeader": "x-amz-object-lock-retain-until-date" + } + }, + "ObjectLockLegalHoldStatus": { + "target": "com.amazonaws.s3#ObjectLockLegalHoldStatus", + "traits": { + "smithy.api#documentation": "

Indicates whether this object has an active legal hold. This field is only returned if\n you have permission to view an object's legal hold status.

", + "smithy.api#httpHeader": "x-amz-object-lock-legal-hold" + } + } + } + }, + "com.amazonaws.s3#GetObjectRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The bucket name containing the object.

\n

When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.

\n

When using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "IfMatch": { + "target": "com.amazonaws.s3#IfMatch", + "traits": { + "smithy.api#documentation": "

Return the object only if its entity tag (ETag) is the same as the one specified,\n otherwise return a 412 (precondition failed).

", + "smithy.api#httpHeader": "If-Match" + } + }, + "IfModifiedSince": { + "target": "com.amazonaws.s3#IfModifiedSince", + "traits": { + "smithy.api#documentation": "

Return the object only if it has been modified since the specified time, otherwise\n return a 304 (not modified).

", + "smithy.api#httpHeader": "If-Modified-Since" + } + }, + "IfNoneMatch": { + "target": "com.amazonaws.s3#IfNoneMatch", + "traits": { + "smithy.api#documentation": "

Return the object only if its entity tag (ETag) is different from the one specified,\n otherwise return a 304 (not modified).

", + "smithy.api#httpHeader": "If-None-Match" + } + }, + "IfUnmodifiedSince": { + "target": "com.amazonaws.s3#IfUnmodifiedSince", + "traits": { + "smithy.api#documentation": "

Return the object only if it has not been modified since the specified time, otherwise\n return a 412 (precondition failed).

", + "smithy.api#httpHeader": "If-Unmodified-Since" + } + }, + "Key": { + "target": "com.amazonaws.s3#ObjectKey", + "traits": { + "smithy.api#documentation": "

Key of the object to get.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Range": { + "target": "com.amazonaws.s3#Range", + "traits": { + "smithy.api#documentation": "

Downloads the specified range bytes of an object. For more information about the HTTP\n Range header, see https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.

\n \n

Amazon S3 doesn't support retrieving multiple ranges of data per GET\n request.

\n ", + "smithy.api#httpHeader": "Range" + } + }, + "ResponseCacheControl": { + "target": "com.amazonaws.s3#ResponseCacheControl", + "traits": { + "smithy.api#documentation": "

Sets the Cache-Control header of the response.

", + "smithy.api#httpQuery": "response-cache-control" + } + }, + "ResponseContentDisposition": { + "target": "com.amazonaws.s3#ResponseContentDisposition", + "traits": { + "smithy.api#documentation": "

Sets the Content-Disposition header of the response

", + "smithy.api#httpQuery": "response-content-disposition" + } + }, + "ResponseContentEncoding": { + "target": "com.amazonaws.s3#ResponseContentEncoding", + "traits": { + "smithy.api#documentation": "

Sets the Content-Encoding header of the response.

", + "smithy.api#httpQuery": "response-content-encoding" + } + }, + "ResponseContentLanguage": { + "target": "com.amazonaws.s3#ResponseContentLanguage", + "traits": { + "smithy.api#documentation": "

Sets the Content-Language header of the response.

", + "smithy.api#httpQuery": "response-content-language" + } + }, + "ResponseContentType": { + "target": "com.amazonaws.s3#ResponseContentType", + "traits": { + "smithy.api#documentation": "

Sets the Content-Type header of the response.

", + "smithy.api#httpQuery": "response-content-type" + } + }, + "ResponseExpires": { + "target": "com.amazonaws.s3#ResponseExpires", + "traits": { + "smithy.api#documentation": "

Sets the Expires header of the response.

", + "smithy.api#httpQuery": "response-expires" + } + }, + "VersionId": { + "target": "com.amazonaws.s3#ObjectVersionId", + "traits": { + "smithy.api#documentation": "

VersionId used to reference a specific version of the object.

", + "smithy.api#httpQuery": "versionId" + } + }, + "SSECustomerAlgorithm": { + "target": "com.amazonaws.s3#SSECustomerAlgorithm", + "traits": { + "smithy.api#documentation": "

Specifies the algorithm to use to when encrypting the object (for example,\n AES256).

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-algorithm" + } + }, + "SSECustomerKey": { + "target": "com.amazonaws.s3#SSECustomerKey", + "traits": { + "smithy.api#documentation": "

Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This\n value is used to store the object and then it is discarded; Amazon S3 does not store the\n encryption key. The key must be appropriate for use with the algorithm specified in the\n x-amz-server-side-encryption-customer-algorithm header.

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key" + } + }, + "SSECustomerKeyMD5": { + "target": "com.amazonaws.s3#SSECustomerKeyMD5", + "traits": { + "smithy.api#documentation": "

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses\n this header for a message integrity check to ensure that the encryption key was transmitted\n without error.

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key-MD5" + } + }, + "RequestPayer": { + "target": "com.amazonaws.s3#RequestPayer", + "traits": { + "smithy.api#httpHeader": "x-amz-request-payer" + } + }, + "PartNumber": { + "target": "com.amazonaws.s3#PartNumber", + "traits": { + "smithy.api#documentation": "

Part number of the object being read. This is a positive integer between 1 and 10,000.\n Effectively performs a 'ranged' GET request for the part specified. Useful for downloading\n just a part of an object.

", + "smithy.api#httpQuery": "partNumber" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + } + }, + "com.amazonaws.s3#GetObjectRetention": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#GetObjectRetentionRequest" + }, + "output": { + "target": "com.amazonaws.s3#GetObjectRetentionOutput" + }, + "traits": { + "smithy.api#documentation": "

Retrieves an object's retention settings. For more information, see Locking Objects.

\n

This action is not supported by Amazon S3 on Outposts.

", + "smithy.api#http": { + "method": "GET", + "uri": "/{Bucket}/{Key+}?retention", + "code": 200 + } + } + }, + "com.amazonaws.s3#GetObjectRetentionOutput": { + "type": "structure", + "members": { + "Retention": { + "target": "com.amazonaws.s3#ObjectLockRetention", + "traits": { + "smithy.api#documentation": "

The container element for an object's retention settings.

", + "smithy.api#httpPayload": {} + } + } + } + }, + "com.amazonaws.s3#GetObjectRetentionRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The bucket name containing the object whose retention settings you want to retrieve.

\n

When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Key": { + "target": "com.amazonaws.s3#ObjectKey", + "traits": { + "smithy.api#documentation": "

The key name for the object whose retention settings you want to retrieve.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "VersionId": { + "target": "com.amazonaws.s3#ObjectVersionId", + "traits": { + "smithy.api#documentation": "

The version ID for the object whose retention settings you want to retrieve.

", + "smithy.api#httpQuery": "versionId" + } + }, + "RequestPayer": { + "target": "com.amazonaws.s3#RequestPayer", + "traits": { + "smithy.api#httpHeader": "x-amz-request-payer" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + } + }, + "com.amazonaws.s3#GetObjectTagging": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#GetObjectTaggingRequest" + }, + "output": { + "target": "com.amazonaws.s3#GetObjectTaggingOutput" + }, + "traits": { + "smithy.api#documentation": "

Returns the tag-set of an object. You send the GET request against the tagging\n subresource associated with the object.

\n\n

To use this operation, you must have permission to perform the\n s3:GetObjectTagging action. By default, the GET operation returns\n information about current version of an object. For a versioned bucket, you can have\n multiple versions of an object in your bucket. To retrieve tags of any other version, use\n the versionId query parameter. You also need permission for the\n s3:GetObjectVersionTagging action.

\n\n

By default, the bucket owner has this permission and can grant this permission to\n others.

\n\n

For information about the Amazon S3 object tagging feature, see Object Tagging.

\n\n

The following operation is related to GetObjectTagging:

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/{Bucket}/{Key+}?tagging", + "code": 200 + } + } + }, + "com.amazonaws.s3#GetObjectTaggingOutput": { + "type": "structure", + "members": { + "VersionId": { + "target": "com.amazonaws.s3#ObjectVersionId", + "traits": { + "smithy.api#documentation": "

The versionId of the object for which you got the tagging information.

", + "smithy.api#httpHeader": "x-amz-version-id" + } + }, + "TagSet": { + "target": "com.amazonaws.s3#TagSet", + "traits": { + "smithy.api#documentation": "

Contains the tag set.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.s3#GetObjectTaggingRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The bucket name containing the object for which to get the tagging information.

\n

When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.

\n

When using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Key": { + "target": "com.amazonaws.s3#ObjectKey", + "traits": { + "smithy.api#documentation": "

Object key for which to get the tagging information.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "VersionId": { + "target": "com.amazonaws.s3#ObjectVersionId", + "traits": { + "smithy.api#documentation": "

The versionId of the object for which to get the tagging information.

", + "smithy.api#httpQuery": "versionId" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + } + }, + "com.amazonaws.s3#GetObjectTorrent": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#GetObjectTorrentRequest" + }, + "output": { + "target": "com.amazonaws.s3#GetObjectTorrentOutput" + }, + "traits": { + "smithy.api#documentation": "

Returns torrent files from a bucket. BitTorrent can save you bandwidth when you're\n distributing large files. For more information about BitTorrent, see Using BitTorrent with Amazon S3.

\n \n

You can get torrent only for objects that are less than 5 GB in size, and that are\n not encrypted using server-side encryption with a customer-provided encryption\n key.

\n \n

To use GET, you must have READ access to the object.

\n

This action is not supported by Amazon S3 on Outposts.

\n

The following operation is related to GetObjectTorrent:

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/{Bucket}/{Key+}?torrent", + "code": 200 + } + } + }, + "com.amazonaws.s3#GetObjectTorrentOutput": { + "type": "structure", + "members": { + "Body": { + "target": "com.amazonaws.s3#StreamingBlob", + "traits": { + "smithy.api#documentation": "

A Bencoded dictionary as defined by the BitTorrent specification

", + "smithy.api#httpPayload": {} + } + }, + "RequestCharged": { + "target": "com.amazonaws.s3#RequestCharged", + "traits": { + "smithy.api#httpHeader": "x-amz-request-charged" + } + } + } + }, + "com.amazonaws.s3#GetObjectTorrentRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket containing the object for which to get the torrent files.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Key": { + "target": "com.amazonaws.s3#ObjectKey", + "traits": { + "smithy.api#documentation": "

The object key for which to get the information.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "RequestPayer": { + "target": "com.amazonaws.s3#RequestPayer", + "traits": { + "smithy.api#httpHeader": "x-amz-request-payer" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + } + }, + "com.amazonaws.s3#GetPublicAccessBlock": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#GetPublicAccessBlockRequest" + }, + "output": { + "target": "com.amazonaws.s3#GetPublicAccessBlockOutput" + }, + "traits": { + "smithy.api#documentation": "

Retrieves the PublicAccessBlock configuration for an Amazon S3 bucket. To use\n this operation, you must have the s3:GetBucketPublicAccessBlock permission.\n For more information about Amazon S3 permissions, see Specifying Permissions in a\n Policy.

\n\n \n

When Amazon S3 evaluates the PublicAccessBlock configuration for a bucket or\n an object, it checks the PublicAccessBlock configuration for both the\n bucket (or the bucket that contains the object) and the bucket owner's account. If the\n PublicAccessBlock settings are different between the bucket and the\n account, Amazon S3 uses the most restrictive combination of the bucket-level and\n account-level settings.

\n \n\n

For more information about when Amazon S3 considers a bucket or an object public, see The Meaning of \"Public\".

\n\n

The following operations are related to GetPublicAccessBlock:

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/{Bucket}?publicAccessBlock", + "code": 200 + } + } + }, + "com.amazonaws.s3#GetPublicAccessBlockOutput": { + "type": "structure", + "members": { + "PublicAccessBlockConfiguration": { + "target": "com.amazonaws.s3#PublicAccessBlockConfiguration", + "traits": { + "smithy.api#documentation": "

The PublicAccessBlock configuration currently in effect for this Amazon S3\n bucket.

", + "smithy.api#httpPayload": {} + } + } + } + }, + "com.amazonaws.s3#GetPublicAccessBlockRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the Amazon S3 bucket whose PublicAccessBlock configuration you want\n to retrieve.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + } + }, + "com.amazonaws.s3#GlacierJobParameters": { + "type": "structure", + "members": { + "Tier": { + "target": "com.amazonaws.s3#Tier", + "traits": { + "smithy.api#documentation": "

Retrieval tier at which the restore will be processed.

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

Container for S3 Glacier job parameters.

" + } + }, + "com.amazonaws.s3#Grant": { + "type": "structure", + "members": { + "Grantee": { + "target": "com.amazonaws.s3#Grantee", + "traits": { + "smithy.api#documentation": "

The person being granted permissions.

" + } + }, + "Permission": { + "target": "com.amazonaws.s3#Permission", + "traits": { + "smithy.api#documentation": "

Specifies the permission given to the grantee.

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

Container for grant information.

" + } + }, + "com.amazonaws.s3#GrantFullControl": { + "type": "string" + }, + "com.amazonaws.s3#GrantRead": { + "type": "string" + }, + "com.amazonaws.s3#GrantReadACP": { + "type": "string" + }, + "com.amazonaws.s3#GrantWrite": { + "type": "string" + }, + "com.amazonaws.s3#GrantWriteACP": { + "type": "string" + }, + "com.amazonaws.s3#Grantee": { + "type": "structure", + "members": { + "DisplayName": { + "target": "com.amazonaws.s3#DisplayName", + "traits": { + "smithy.api#documentation": "

Screen name of the grantee.

" + } + }, + "EmailAddress": { + "target": "com.amazonaws.s3#EmailAddress", + "traits": { + "smithy.api#documentation": "

Email address of the grantee.

\n \n

Using email addresses to specify a grantee is only supported in the following AWS Regions:

\n \n

For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the AWS General Reference.

\n " + } + }, + "ID": { + "target": "com.amazonaws.s3#ID", + "traits": { + "smithy.api#documentation": "

The canonical user ID of the grantee.

" + } + }, + "URI": { + "target": "com.amazonaws.s3#URI", + "traits": { + "smithy.api#documentation": "

URI of the grantee group.

" + } + }, + "Type": { + "target": "com.amazonaws.s3#Type", + "traits": { + "smithy.api#documentation": "

Type of grantee

", + "smithy.api#required": {}, + "smithy.api#xmlAttribute": {}, + "smithy.api#xmlName": "xsi:type" + } + } + }, + "traits": { + "smithy.api#documentation": "

Container for the person being granted permissions.

", + "smithy.api#xmlNamespace": { + "uri": "http://www.w3.org/2001/XMLSchema-instance", + "prefix": "xsi" + } + } + }, + "com.amazonaws.s3#Grants": { + "type": "list", + "member": { + "target": "com.amazonaws.s3#Grant", + "traits": { + "smithy.api#xmlName": "Grant" + } + } + }, + "com.amazonaws.s3#HeadBucket": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#HeadBucketRequest" + }, + "errors": [ + { + "target": "com.amazonaws.s3#NoSuchBucket" + } + ], + "traits": { + "smithy.api#documentation": "

This operation is useful to determine if a bucket exists and you have permission to\n access it. The operation returns a 200 OK if the bucket exists and you have\n permission to access it. Otherwise, the operation might return responses such as 404\n Not Found and 403 Forbidden.

\n\n

To use this operation, you must have permissions to perform the\n s3:ListBucket action. The bucket owner has this permission by default and\n can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources.

", + "smithy.api#http": { + "method": "HEAD", + "uri": "/{Bucket}", + "code": 200 + }, + "smithy.waiters#waitable": { + "BucketExists": { + "acceptors": [ + { + "state": "success", + "matcher": { + "success": true + } + } + ], + "minDelay": 5 + } + } + } + }, + "com.amazonaws.s3#HeadBucketRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The bucket name.

\n

When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.

\n

When using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + } + }, + "com.amazonaws.s3#HeadObject": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#HeadObjectRequest" + }, + "output": { + "target": "com.amazonaws.s3#HeadObjectOutput" + }, + "errors": [ + { + "target": "com.amazonaws.s3#NoSuchKey" + } + ], + "traits": { + "smithy.api#documentation": "

The HEAD operation retrieves metadata from an object without returning the object\n itself. This operation is useful if you're only interested in an object's metadata. To use\n HEAD, you must have READ access to the object.

\n\n

A HEAD request has the same options as a GET operation on an\n object. The response is identical to the GET response except that there is no\n response body.

\n\n

If you encrypt an object by using server-side encryption with customer-provided\n encryption keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the\n metadata from the object, you must use the following headers:

\n \n

For more information about SSE-C, see Server-Side Encryption (Using\n Customer-Provided Encryption Keys).

\n \n

Encryption request headers, like x-amz-server-side-encryption, should\n not be sent for GET requests if your object uses server-side encryption with CMKs stored\n in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption keys\n (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 BadRequest\n error.

\n \n\n\n\n\n\n\n\n

Request headers are limited to 8 KB in size. For more information, see Common Request\n Headers.

\n

Consider the following when using request headers:

\n \n\n

For more information about conditional requests, see RFC 7232.

\n\n

\n Permissions\n

\n

You need the s3:GetObject permission for this operation. For more\n information, see Specifying Permissions\n in a Policy. If the object you request does not exist, the error Amazon S3 returns\n depends on whether you also have the s3:ListBucket permission.

\n \n\n

The following operation is related to HeadObject:

\n ", + "smithy.api#http": { + "method": "HEAD", + "uri": "/{Bucket}/{Key+}", + "code": 200 + }, + "smithy.waiters#waitable": { + "ObjectExists": { + "acceptors": [ + { + "state": "success", + "matcher": { + "success": true + } + } + ], + "minDelay": 5 + } + } + } + }, + "com.amazonaws.s3#HeadObjectOutput": { + "type": "structure", + "members": { + "DeleteMarker": { + "target": "com.amazonaws.s3#DeleteMarker", + "traits": { + "smithy.api#documentation": "

Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If\n false, this response header does not appear in the response.

", + "smithy.api#httpHeader": "x-amz-delete-marker" + } + }, + "AcceptRanges": { + "target": "com.amazonaws.s3#AcceptRanges", + "traits": { + "smithy.api#documentation": "

Indicates that a range of bytes was specified.

", + "smithy.api#httpHeader": "accept-ranges" + } + }, + "Expiration": { + "target": "com.amazonaws.s3#Expiration", + "traits": { + "smithy.api#documentation": "

If the object expiration is configured (see PUT Bucket lifecycle), the response includes\n this header. It includes the expiry-date and rule-id key-value pairs providing object\n expiration information. The value of the rule-id is URL encoded.

", + "smithy.api#httpHeader": "x-amz-expiration" + } + }, + "Restore": { + "target": "com.amazonaws.s3#Restore", + "traits": { + "smithy.api#documentation": "

If the object is an archived object (an object whose storage class is GLACIER), the\n response includes this header if either the archive restoration is in progress (see RestoreObject or an archive copy is already restored.

\n\n

If an archive copy is already restored, the header value indicates when Amazon S3 is\n scheduled to delete the object copy. For example:

\n\n

\n x-amz-restore: ongoing-request=\"false\", expiry-date=\"Fri, 23 Dec 2012 00:00:00\n GMT\"\n

\n\n

If the object restoration is in progress, the header returns the value\n ongoing-request=\"true\".

\n\n

For more information about archiving objects, see Transitioning Objects: General Considerations.

", + "smithy.api#httpHeader": "x-amz-restore" + } + }, + "ArchiveStatus": { + "target": "com.amazonaws.s3#ArchiveStatus", + "traits": { + "smithy.api#documentation": "

The archive state of the head object.

", + "smithy.api#httpHeader": "x-amz-archive-status" + } + }, + "LastModified": { + "target": "com.amazonaws.s3#LastModified", + "traits": { + "smithy.api#documentation": "

Last modified date of the object

", + "smithy.api#httpHeader": "Last-Modified" + } + }, + "ContentLength": { + "target": "com.amazonaws.s3#ContentLength", + "traits": { + "smithy.api#documentation": "

Size of the body in bytes.

", + "smithy.api#httpHeader": "Content-Length" + } + }, + "ETag": { + "target": "com.amazonaws.s3#ETag", + "traits": { + "smithy.api#documentation": "

An ETag is an opaque identifier assigned by a web server to a specific version of a\n resource found at a URL.

", + "smithy.api#httpHeader": "ETag" + } + }, + "MissingMeta": { + "target": "com.amazonaws.s3#MissingMeta", + "traits": { + "smithy.api#documentation": "

This is set to the number of metadata entries not returned in x-amz-meta\n headers. This can happen if you create metadata using an API like SOAP that supports more\n flexible metadata than the REST API. For example, using SOAP, you can create metadata whose\n values are not legal HTTP headers.

", + "smithy.api#httpHeader": "x-amz-missing-meta" + } + }, + "VersionId": { + "target": "com.amazonaws.s3#ObjectVersionId", + "traits": { + "smithy.api#documentation": "

Version of the object.

", + "smithy.api#httpHeader": "x-amz-version-id" + } + }, + "CacheControl": { + "target": "com.amazonaws.s3#CacheControl", + "traits": { + "smithy.api#documentation": "

Specifies caching behavior along the request/reply chain.

", + "smithy.api#httpHeader": "Cache-Control" + } + }, + "ContentDisposition": { + "target": "com.amazonaws.s3#ContentDisposition", + "traits": { + "smithy.api#documentation": "

Specifies presentational information for the object.

", + "smithy.api#httpHeader": "Content-Disposition" + } + }, + "ContentEncoding": { + "target": "com.amazonaws.s3#ContentEncoding", + "traits": { + "smithy.api#documentation": "

Specifies what content encodings have been applied to the object and thus what decoding\n mechanisms must be applied to obtain the media-type referenced by the Content-Type header\n field.

", + "smithy.api#httpHeader": "Content-Encoding" + } + }, + "ContentLanguage": { + "target": "com.amazonaws.s3#ContentLanguage", + "traits": { + "smithy.api#documentation": "

The language the content is in.

", + "smithy.api#httpHeader": "Content-Language" + } + }, + "ContentType": { + "target": "com.amazonaws.s3#ContentType", + "traits": { + "smithy.api#documentation": "

A standard MIME type describing the format of the object data.

", + "smithy.api#httpHeader": "Content-Type" + } + }, + "Expires": { + "target": "com.amazonaws.s3#Expires", + "traits": { + "smithy.api#documentation": "

The date and time at which the object is no longer cacheable.

", + "smithy.api#httpHeader": "Expires" + } + }, + "WebsiteRedirectLocation": { + "target": "com.amazonaws.s3#WebsiteRedirectLocation", + "traits": { + "smithy.api#documentation": "

If the bucket is configured as a website, redirects requests for this object to another\n object in the same bucket or to an external URL. Amazon S3 stores the value of this header in\n the object metadata.

", + "smithy.api#httpHeader": "x-amz-website-redirect-location" + } + }, + "ServerSideEncryption": { + "target": "com.amazonaws.s3#ServerSideEncryption", + "traits": { + "smithy.api#documentation": "

If the object is stored using server-side encryption either with an AWS KMS customer\n master key (CMK) or an Amazon S3-managed encryption key, the response includes this header with\n the value of the server-side encryption algorithm used when storing this object in Amazon\n S3 (for example, AES256, aws:kms).

", + "smithy.api#httpHeader": "x-amz-server-side-encryption" + } + }, + "Metadata": { + "target": "com.amazonaws.s3#Metadata", + "traits": { + "smithy.api#documentation": "

A map of metadata to store with the object in S3.

", + "smithy.api#httpPrefixHeaders": "x-amz-meta-" + } + }, + "SSECustomerAlgorithm": { + "target": "com.amazonaws.s3#SSECustomerAlgorithm", + "traits": { + "smithy.api#documentation": "

If server-side encryption with a customer-provided encryption key was requested, the\n response will include this header confirming the encryption algorithm used.

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-algorithm" + } + }, + "SSECustomerKeyMD5": { + "target": "com.amazonaws.s3#SSECustomerKeyMD5", + "traits": { + "smithy.api#documentation": "

If server-side encryption with a customer-provided encryption key was requested, the\n response will include this header to provide round-trip message integrity verification of\n the customer-provided encryption key.

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key-MD5" + } + }, + "SSEKMSKeyId": { + "target": "com.amazonaws.s3#SSEKMSKeyId", + "traits": { + "smithy.api#documentation": "

If present, specifies the ID of the AWS Key Management Service (AWS KMS) symmetric\n customer managed customer master key (CMK) that was used for the object.

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" + } + }, + "BucketKeyEnabled": { + "target": "com.amazonaws.s3#BucketKeyEnabled", + "traits": { + "smithy.api#documentation": "

Indicates whether the object uses an S3 Bucket Key for server-side encryption with AWS KMS (SSE-KMS).

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-bucket-key-enabled" + } + }, + "StorageClass": { + "target": "com.amazonaws.s3#StorageClass", + "traits": { + "smithy.api#documentation": "

Provides storage class information of the object. Amazon S3 returns this header for all\n objects except for S3 Standard storage class objects.

\n\n

For more information, see Storage\n Classes.

", + "smithy.api#httpHeader": "x-amz-storage-class" + } + }, + "RequestCharged": { + "target": "com.amazonaws.s3#RequestCharged", + "traits": { + "smithy.api#httpHeader": "x-amz-request-charged" + } + }, + "ReplicationStatus": { + "target": "com.amazonaws.s3#ReplicationStatus", + "traits": { + "smithy.api#documentation": "

Amazon S3 can return this header if your request involves a bucket that is either a source or\n a destination in a replication rule.

\n\n

In replication, you have a source bucket on which you configure replication and\n destination bucket or buckets where Amazon S3 stores object replicas. When you request an object\n (GetObject) or object metadata (HeadObject) from these\n buckets, Amazon S3 will return the x-amz-replication-status header in the response\n as follows:

\n \n\n

For more information, see Replication.

", + "smithy.api#httpHeader": "x-amz-replication-status" + } + }, + "PartsCount": { + "target": "com.amazonaws.s3#PartsCount", + "traits": { + "smithy.api#documentation": "

The count of parts this object has.

", + "smithy.api#httpHeader": "x-amz-mp-parts-count" + } + }, + "ObjectLockMode": { + "target": "com.amazonaws.s3#ObjectLockMode", + "traits": { + "smithy.api#documentation": "

The Object Lock mode, if any, that's in effect for this object. This header is only\n returned if the requester has the s3:GetObjectRetention permission. For more\n information about S3 Object Lock, see Object\n Lock.

", + "smithy.api#httpHeader": "x-amz-object-lock-mode" + } + }, + "ObjectLockRetainUntilDate": { + "target": "com.amazonaws.s3#ObjectLockRetainUntilDate", + "traits": { + "smithy.api#documentation": "

The date and time when the Object Lock retention period expires. This header is only\n returned if the requester has the s3:GetObjectRetention permission.

", + "smithy.api#httpHeader": "x-amz-object-lock-retain-until-date" + } + }, + "ObjectLockLegalHoldStatus": { + "target": "com.amazonaws.s3#ObjectLockLegalHoldStatus", + "traits": { + "smithy.api#documentation": "

Specifies whether a legal hold is in effect for this object. This header is only\n returned if the requester has the s3:GetObjectLegalHold permission. This\n header is not returned if the specified version of this object has never had a legal hold\n applied. For more information about S3 Object Lock, see Object Lock.

", + "smithy.api#httpHeader": "x-amz-object-lock-legal-hold" + } + } + } + }, + "com.amazonaws.s3#HeadObjectRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket containing the object.

\n

When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.

\n

When using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "IfMatch": { + "target": "com.amazonaws.s3#IfMatch", + "traits": { + "smithy.api#documentation": "

Return the object only if its entity tag (ETag) is the same as the one specified,\n otherwise return a 412 (precondition failed).

", + "smithy.api#httpHeader": "If-Match" + } + }, + "IfModifiedSince": { + "target": "com.amazonaws.s3#IfModifiedSince", + "traits": { + "smithy.api#documentation": "

Return the object only if it has been modified since the specified time, otherwise\n return a 304 (not modified).

", + "smithy.api#httpHeader": "If-Modified-Since" + } + }, + "IfNoneMatch": { + "target": "com.amazonaws.s3#IfNoneMatch", + "traits": { + "smithy.api#documentation": "

Return the object only if its entity tag (ETag) is different from the one specified,\n otherwise return a 304 (not modified).

", + "smithy.api#httpHeader": "If-None-Match" + } + }, + "IfUnmodifiedSince": { + "target": "com.amazonaws.s3#IfUnmodifiedSince", + "traits": { + "smithy.api#documentation": "

Return the object only if it has not been modified since the specified time, otherwise\n return a 412 (precondition failed).

", + "smithy.api#httpHeader": "If-Unmodified-Since" + } + }, + "Key": { + "target": "com.amazonaws.s3#ObjectKey", + "traits": { + "smithy.api#documentation": "

The object key.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Range": { + "target": "com.amazonaws.s3#Range", + "traits": { + "smithy.api#documentation": "

Downloads the specified range bytes of an object. For more information about the HTTP\n Range header, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.

\n \n

Amazon S3 doesn't support retrieving multiple ranges of data per GET\n request.

\n ", + "smithy.api#httpHeader": "Range" + } + }, + "VersionId": { + "target": "com.amazonaws.s3#ObjectVersionId", + "traits": { + "smithy.api#documentation": "

VersionId used to reference a specific version of the object.

", + "smithy.api#httpQuery": "versionId" + } + }, + "SSECustomerAlgorithm": { + "target": "com.amazonaws.s3#SSECustomerAlgorithm", + "traits": { + "smithy.api#documentation": "

Specifies the algorithm to use to when encrypting the object (for example,\n AES256).

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-algorithm" + } + }, + "SSECustomerKey": { + "target": "com.amazonaws.s3#SSECustomerKey", + "traits": { + "smithy.api#documentation": "

Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This\n value is used to store the object and then it is discarded; Amazon S3 does not store the\n encryption key. The key must be appropriate for use with the algorithm specified in the\n x-amz-server-side-encryption-customer-algorithm header.

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key" + } + }, + "SSECustomerKeyMD5": { + "target": "com.amazonaws.s3#SSECustomerKeyMD5", + "traits": { + "smithy.api#documentation": "

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses\n this header for a message integrity check to ensure that the encryption key was transmitted\n without error.

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key-MD5" + } + }, + "RequestPayer": { + "target": "com.amazonaws.s3#RequestPayer", + "traits": { + "smithy.api#httpHeader": "x-amz-request-payer" + } + }, + "PartNumber": { + "target": "com.amazonaws.s3#PartNumber", + "traits": { + "smithy.api#documentation": "

Part number of the object being read. This is a positive integer between 1 and 10,000.\n Effectively performs a 'ranged' HEAD request for the part specified. Useful querying about\n the size of the part and the number of parts in this object.

", + "smithy.api#httpQuery": "partNumber" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + } }, - { - "target": "com.amazonaws.s3#GetBucketPolicy" + "com.amazonaws.s3#HostName": { + "type": "string" }, - { - "target": "com.amazonaws.s3#GetBucketPolicyStatus" + "com.amazonaws.s3#HttpErrorCodeReturnedEquals": { + "type": "string" }, - { - "target": "com.amazonaws.s3#GetBucketReplication" + "com.amazonaws.s3#HttpRedirectCode": { + "type": "string" }, - { - "target": "com.amazonaws.s3#GetBucketRequestPayment" + "com.amazonaws.s3#ID": { + "type": "string" }, - { - "target": "com.amazonaws.s3#GetBucketTagging" + "com.amazonaws.s3#IfMatch": { + "type": "string" }, - { - "target": "com.amazonaws.s3#GetBucketVersioning" + "com.amazonaws.s3#IfModifiedSince": { + "type": "timestamp" }, - { - "target": "com.amazonaws.s3#GetBucketWebsite" + "com.amazonaws.s3#IfNoneMatch": { + "type": "string" }, - { - "target": "com.amazonaws.s3#GetObject" + "com.amazonaws.s3#IfUnmodifiedSince": { + "type": "timestamp" }, - { - "target": "com.amazonaws.s3#GetObjectAcl" - }, - { - "target": "com.amazonaws.s3#GetObjectLegalHold" - }, - { - "target": "com.amazonaws.s3#GetObjectLockConfiguration" - }, - { - "target": "com.amazonaws.s3#GetObjectRetention" - }, - { - "target": "com.amazonaws.s3#GetObjectTagging" - }, - { - "target": "com.amazonaws.s3#GetObjectTorrent" - }, - { - "target": "com.amazonaws.s3#GetPublicAccessBlock" - }, - { - "target": "com.amazonaws.s3#HeadBucket" - }, - { - "target": "com.amazonaws.s3#HeadObject" - }, - { - "target": "com.amazonaws.s3#ListBucketAnalyticsConfigurations" - }, - { - "target": "com.amazonaws.s3#ListBucketIntelligentTieringConfigurations" - }, - { - "target": "com.amazonaws.s3#ListBucketInventoryConfigurations" - }, - { - "target": "com.amazonaws.s3#ListBucketMetricsConfigurations" - }, - { - "target": "com.amazonaws.s3#ListBuckets" - }, - { - "target": "com.amazonaws.s3#ListMultipartUploads" - }, - { - "target": "com.amazonaws.s3#ListObjects" - }, - { - "target": "com.amazonaws.s3#ListObjectsV2" - }, - { - "target": "com.amazonaws.s3#ListObjectVersions" - }, - { - "target": "com.amazonaws.s3#ListParts" - }, - { - "target": "com.amazonaws.s3#PutBucketAccelerateConfiguration" - }, - { - "target": "com.amazonaws.s3#PutBucketAcl" - }, - { - "target": "com.amazonaws.s3#PutBucketAnalyticsConfiguration" - }, - { - "target": "com.amazonaws.s3#PutBucketCors" - }, - { - "target": "com.amazonaws.s3#PutBucketEncryption" - }, - { - "target": "com.amazonaws.s3#PutBucketIntelligentTieringConfiguration" - }, - { - "target": "com.amazonaws.s3#PutBucketInventoryConfiguration" - }, - { - "target": "com.amazonaws.s3#PutBucketLifecycleConfiguration" - }, - { - "target": "com.amazonaws.s3#PutBucketLogging" - }, - { - "target": "com.amazonaws.s3#PutBucketMetricsConfiguration" - }, - { - "target": "com.amazonaws.s3#PutBucketNotificationConfiguration" - }, - { - "target": "com.amazonaws.s3#PutBucketOwnershipControls" - }, - { - "target": "com.amazonaws.s3#PutBucketPolicy" - }, - { - "target": "com.amazonaws.s3#PutBucketReplication" - }, - { - "target": "com.amazonaws.s3#PutBucketRequestPayment" - }, - { - "target": "com.amazonaws.s3#PutBucketTagging" - }, - { - "target": "com.amazonaws.s3#PutBucketVersioning" - }, - { - "target": "com.amazonaws.s3#PutBucketWebsite" - }, - { - "target": "com.amazonaws.s3#PutObject" - }, - { - "target": "com.amazonaws.s3#PutObjectAcl" - }, - { - "target": "com.amazonaws.s3#PutObjectLegalHold" - }, - { - "target": "com.amazonaws.s3#PutObjectLockConfiguration" - }, - { - "target": "com.amazonaws.s3#PutObjectRetention" - }, - { - "target": "com.amazonaws.s3#PutObjectTagging" - }, - { - "target": "com.amazonaws.s3#PutPublicAccessBlock" - }, - { - "target": "com.amazonaws.s3#RestoreObject" - }, - { - "target": "com.amazonaws.s3#SelectObjectContent" + "com.amazonaws.s3#IndexDocument": { + "type": "structure", + "members": { + "Suffix": { + "target": "com.amazonaws.s3#Suffix", + "traits": { + "smithy.api#documentation": "

A suffix that is appended to a request that is for a directory on the website endpoint\n (for example,if the suffix is index.html and you make a request to samplebucket/images/ the\n data that is returned will be for the object with the key name images/index.html) The\n suffix must not be empty and must not include a slash character.

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

Container for the Suffix element.

" + } + }, + "com.amazonaws.s3#Initiated": { + "type": "timestamp" + }, + "com.amazonaws.s3#Initiator": { + "type": "structure", + "members": { + "ID": { + "target": "com.amazonaws.s3#ID", + "traits": { + "smithy.api#documentation": "

If the principal is an AWS account, it provides the Canonical User ID. If the principal\n is an IAM User, it provides a user ARN value.

" + } + }, + "DisplayName": { + "target": "com.amazonaws.s3#DisplayName", + "traits": { + "smithy.api#documentation": "

Name of the Principal.

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

Container element that identifies who initiated the multipart upload.

" + } + }, + "com.amazonaws.s3#InputSerialization": { + "type": "structure", + "members": { + "CSV": { + "target": "com.amazonaws.s3#CSVInput", + "traits": { + "smithy.api#documentation": "

Describes the serialization of a CSV-encoded object.

" + } + }, + "CompressionType": { + "target": "com.amazonaws.s3#CompressionType", + "traits": { + "smithy.api#documentation": "

Specifies object's compression format. Valid values: NONE, GZIP, BZIP2. Default Value:\n NONE.

" + } + }, + "JSON": { + "target": "com.amazonaws.s3#JSONInput", + "traits": { + "smithy.api#documentation": "

Specifies JSON as object's input serialization format.

" + } + }, + "Parquet": { + "target": "com.amazonaws.s3#ParquetInput", + "traits": { + "smithy.api#documentation": "

Specifies Parquet as object's input serialization format.

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

Describes the serialization format of the object.

" + } + }, + "com.amazonaws.s3#IntelligentTieringAccessTier": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ARCHIVE_ACCESS", + "name": "ARCHIVE_ACCESS" + }, + { + "value": "DEEP_ARCHIVE_ACCESS", + "name": "DEEP_ARCHIVE_ACCESS" + } + ] + } + }, + "com.amazonaws.s3#IntelligentTieringAndOperator": { + "type": "structure", + "members": { + "Prefix": { + "target": "com.amazonaws.s3#Prefix", + "traits": { + "smithy.api#documentation": "

An object key name prefix that identifies the subset of objects to which the\n configuration applies.

" + } + }, + "Tags": { + "target": "com.amazonaws.s3#TagSet", + "traits": { + "smithy.api#documentation": "

All of these tags must exist in the object's tag set in order for the configuration to\n apply.

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

A container for specifying S3 Intelligent-Tiering filters. The filters determine the\n subset of objects to which the rule applies.

" + } + }, + "com.amazonaws.s3#IntelligentTieringConfiguration": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.s3#IntelligentTieringId", + "traits": { + "smithy.api#documentation": "

The ID used to identify the S3 Intelligent-Tiering configuration.

", + "smithy.api#required": {} + } + }, + "Filter": { + "target": "com.amazonaws.s3#IntelligentTieringFilter", + "traits": { + "smithy.api#documentation": "

Specifies a bucket filter. The configuration only includes objects that meet the\n filter's criteria.

" + } + }, + "Status": { + "target": "com.amazonaws.s3#IntelligentTieringStatus", + "traits": { + "smithy.api#documentation": "

Specifies the status of the configuration.

", + "smithy.api#required": {} + } + }, + "Tierings": { + "target": "com.amazonaws.s3#TieringList", + "traits": { + "smithy.api#documentation": "

Specifies the S3 Intelligent-Tiering storage class tier of the configuration.

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

Specifies the S3 Intelligent-Tiering configuration for an Amazon S3 bucket.

\n

For information about the S3 Intelligent-Tiering storage class, see Storage class for\n automatically optimizing frequently and infrequently accessed objects.

" + } + }, + "com.amazonaws.s3#IntelligentTieringConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.s3#IntelligentTieringConfiguration" + } + }, + "com.amazonaws.s3#IntelligentTieringDays": { + "type": "integer" + }, + "com.amazonaws.s3#IntelligentTieringFilter": { + "type": "structure", + "members": { + "Prefix": { + "target": "com.amazonaws.s3#Prefix", + "traits": { + "smithy.api#documentation": "

An object key name prefix that identifies the subset of objects to which the rule\n applies.

" + } + }, + "Tag": { + "target": "com.amazonaws.s3#Tag" + }, + "And": { + "target": "com.amazonaws.s3#IntelligentTieringAndOperator", + "traits": { + "smithy.api#documentation": "

A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter.\n The operator must have at least two predicates, and an object must match all of the\n predicates in order for the filter to apply.

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

The Filter is used to identify objects that the S3 Intelligent-Tiering\n configuration applies to.

" + } + }, + "com.amazonaws.s3#IntelligentTieringId": { + "type": "string" + }, + "com.amazonaws.s3#IntelligentTieringStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Enabled", + "name": "Enabled" + }, + { + "value": "Disabled", + "name": "Disabled" + } + ] + } + }, + "com.amazonaws.s3#InvalidObjectState": { + "type": "structure", + "members": { + "StorageClass": { + "target": "com.amazonaws.s3#StorageClass" + }, + "AccessTier": { + "target": "com.amazonaws.s3#IntelligentTieringAccessTier" + } + }, + "traits": { + "smithy.api#documentation": "

Object is archived and inaccessible until restored.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.s3#InventoryConfiguration": { + "type": "structure", + "members": { + "Destination": { + "target": "com.amazonaws.s3#InventoryDestination", + "traits": { + "smithy.api#documentation": "

Contains information about where to publish the inventory results.

", + "smithy.api#required": {} + } + }, + "IsEnabled": { + "target": "com.amazonaws.s3#IsEnabled", + "traits": { + "smithy.api#documentation": "

Specifies whether the inventory is enabled or disabled. If set to True, an\n inventory list is generated. If set to False, no inventory list is\n generated.

", + "smithy.api#required": {} + } + }, + "Filter": { + "target": "com.amazonaws.s3#InventoryFilter", + "traits": { + "smithy.api#documentation": "

Specifies an inventory filter. The inventory only includes objects that meet the\n filter's criteria.

" + } + }, + "Id": { + "target": "com.amazonaws.s3#InventoryId", + "traits": { + "smithy.api#documentation": "

The ID used to identify the inventory configuration.

", + "smithy.api#required": {} + } + }, + "IncludedObjectVersions": { + "target": "com.amazonaws.s3#InventoryIncludedObjectVersions", + "traits": { + "smithy.api#documentation": "

Object versions to include in the inventory list. If set to All, the list\n includes all the object versions, which adds the version-related fields\n VersionId, IsLatest, and DeleteMarker to the\n list. If set to Current, the list does not contain these version-related\n fields.

", + "smithy.api#required": {} + } + }, + "OptionalFields": { + "target": "com.amazonaws.s3#InventoryOptionalFields", + "traits": { + "smithy.api#documentation": "

Contains the optional fields that are included in the inventory results.

" + } + }, + "Schedule": { + "target": "com.amazonaws.s3#InventorySchedule", + "traits": { + "smithy.api#documentation": "

Specifies the schedule for generating inventory results.

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

Specifies the inventory configuration for an Amazon S3 bucket. For more information, see\n GET Bucket inventory in the Amazon Simple Storage Service API Reference.\n

" + } + }, + "com.amazonaws.s3#InventoryConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.s3#InventoryConfiguration" + } + }, + "com.amazonaws.s3#InventoryDestination": { + "type": "structure", + "members": { + "S3BucketDestination": { + "target": "com.amazonaws.s3#InventoryS3BucketDestination", + "traits": { + "smithy.api#documentation": "

Contains the bucket name, file format, bucket owner (optional), and prefix (optional)\n where inventory results are published.

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

Specifies the inventory configuration for an Amazon S3 bucket.

" + } + }, + "com.amazonaws.s3#InventoryEncryption": { + "type": "structure", + "members": { + "SSES3": { + "target": "com.amazonaws.s3#SSES3", + "traits": { + "smithy.api#documentation": "

Specifies the use of SSE-S3 to encrypt delivered inventory reports.

", + "smithy.api#xmlName": "SSE-S3" + } + }, + "SSEKMS": { + "target": "com.amazonaws.s3#SSEKMS", + "traits": { + "smithy.api#documentation": "

Specifies the use of SSE-KMS to encrypt delivered inventory reports.

", + "smithy.api#xmlName": "SSE-KMS" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the type of server-side encryption used to encrypt the inventory\n results.

" + } + }, + "com.amazonaws.s3#InventoryFilter": { + "type": "structure", + "members": { + "Prefix": { + "target": "com.amazonaws.s3#Prefix", + "traits": { + "smithy.api#documentation": "

The prefix that an object must have to be included in the inventory results.

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

Specifies an inventory filter. The inventory only includes objects that meet the\n filter's criteria.

" + } + }, + "com.amazonaws.s3#InventoryFormat": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CSV", + "name": "CSV" + }, + { + "value": "ORC", + "name": "ORC" + }, + { + "value": "Parquet", + "name": "Parquet" + } + ] + } + }, + "com.amazonaws.s3#InventoryFrequency": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Daily", + "name": "Daily" + }, + { + "value": "Weekly", + "name": "Weekly" + } + ] + } + }, + "com.amazonaws.s3#InventoryId": { + "type": "string" + }, + "com.amazonaws.s3#InventoryIncludedObjectVersions": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "All", + "name": "All" + }, + { + "value": "Current", + "name": "Current" + } + ] + } + }, + "com.amazonaws.s3#InventoryOptionalField": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Size", + "name": "Size" + }, + { + "value": "LastModifiedDate", + "name": "LastModifiedDate" + }, + { + "value": "StorageClass", + "name": "StorageClass" + }, + { + "value": "ETag", + "name": "ETag" + }, + { + "value": "IsMultipartUploaded", + "name": "IsMultipartUploaded" + }, + { + "value": "ReplicationStatus", + "name": "ReplicationStatus" + }, + { + "value": "EncryptionStatus", + "name": "EncryptionStatus" + }, + { + "value": "ObjectLockRetainUntilDate", + "name": "ObjectLockRetainUntilDate" + }, + { + "value": "ObjectLockMode", + "name": "ObjectLockMode" + }, + { + "value": "ObjectLockLegalHoldStatus", + "name": "ObjectLockLegalHoldStatus" + }, + { + "value": "IntelligentTieringAccessTier", + "name": "IntelligentTieringAccessTier" + } + ] + } + }, + "com.amazonaws.s3#InventoryOptionalFields": { + "type": "list", + "member": { + "target": "com.amazonaws.s3#InventoryOptionalField", + "traits": { + "smithy.api#xmlName": "Field" + } + } + }, + "com.amazonaws.s3#InventoryS3BucketDestination": { + "type": "structure", + "members": { + "AccountId": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID that owns the destination S3 bucket. If no account ID is provided, the\n owner is not validated before exporting data.

\n \n

Although this value is optional, we strongly recommend that you set it to help\n prevent problems if the destination bucket ownership changes.

\n " + } + }, + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the bucket where inventory results will be\n published.

", + "smithy.api#required": {} + } + }, + "Format": { + "target": "com.amazonaws.s3#InventoryFormat", + "traits": { + "smithy.api#documentation": "

Specifies the output format of the inventory results.

", + "smithy.api#required": {} + } + }, + "Prefix": { + "target": "com.amazonaws.s3#Prefix", + "traits": { + "smithy.api#documentation": "

The prefix that is prepended to all inventory results.

" + } + }, + "Encryption": { + "target": "com.amazonaws.s3#InventoryEncryption", + "traits": { + "smithy.api#documentation": "

Contains the type of server-side encryption used to encrypt the inventory\n results.

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

Contains the bucket name, file format, bucket owner (optional), and prefix (optional)\n where inventory results are published.

" + } + }, + "com.amazonaws.s3#InventorySchedule": { + "type": "structure", + "members": { + "Frequency": { + "target": "com.amazonaws.s3#InventoryFrequency", + "traits": { + "smithy.api#documentation": "

Specifies how frequently inventory results are produced.

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

Specifies the schedule for generating inventory results.

" + } + }, + "com.amazonaws.s3#IsEnabled": { + "type": "boolean" + }, + "com.amazonaws.s3#IsLatest": { + "type": "boolean" + }, + "com.amazonaws.s3#IsPublic": { + "type": "boolean" + }, + "com.amazonaws.s3#IsTruncated": { + "type": "boolean" + }, + "com.amazonaws.s3#JSONInput": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.s3#JSONType", + "traits": { + "smithy.api#documentation": "

The type of JSON. Valid values: Document, Lines.

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

Specifies JSON as object's input serialization format.

" + } + }, + "com.amazonaws.s3#JSONOutput": { + "type": "structure", + "members": { + "RecordDelimiter": { + "target": "com.amazonaws.s3#RecordDelimiter", + "traits": { + "smithy.api#documentation": "

The value used to separate individual records in the output. If no value is specified,\n Amazon S3 uses a newline character ('\\n').

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

Specifies JSON as request's output serialization format.

" + } + }, + "com.amazonaws.s3#JSONType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "DOCUMENT", + "name": "DOCUMENT" + }, + { + "value": "LINES", + "name": "LINES" + } + ] + } + }, + "com.amazonaws.s3#KMSContext": { + "type": "string" + }, + "com.amazonaws.s3#KeyCount": { + "type": "integer" + }, + "com.amazonaws.s3#KeyMarker": { + "type": "string" + }, + "com.amazonaws.s3#KeyPrefixEquals": { + "type": "string" + }, + "com.amazonaws.s3#LambdaFunctionArn": { + "type": "string" + }, + "com.amazonaws.s3#LambdaFunctionConfiguration": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.s3#NotificationId" + }, + "LambdaFunctionArn": { + "target": "com.amazonaws.s3#LambdaFunctionArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS Lambda function that Amazon S3 invokes when the\n specified event type occurs.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "CloudFunction" + } + }, + "Events": { + "target": "com.amazonaws.s3#EventList", + "traits": { + "smithy.api#documentation": "

The Amazon S3 bucket event for which to invoke the AWS Lambda function. For more information,\n see Supported\n Event Types in the Amazon Simple Storage Service Developer Guide.

", + "smithy.api#required": {}, + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "Event" + } + }, + "Filter": { + "target": "com.amazonaws.s3#NotificationConfigurationFilter" + } + }, + "traits": { + "smithy.api#documentation": "

A container for specifying the configuration for AWS Lambda notifications.

" + } + }, + "com.amazonaws.s3#LambdaFunctionConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.s3#LambdaFunctionConfiguration" + } + }, + "com.amazonaws.s3#LastModified": { + "type": "timestamp" + }, + "com.amazonaws.s3#LifecycleExpiration": { + "type": "structure", + "members": { + "Date": { + "target": "com.amazonaws.s3#Date", + "traits": { + "smithy.api#documentation": "

Indicates at what date the object is to be moved or deleted. Should be in GMT ISO 8601\n Format.

" + } + }, + "Days": { + "target": "com.amazonaws.s3#Days", + "traits": { + "smithy.api#documentation": "

Indicates the lifetime, in days, of the objects that are subject to the rule. The value\n must be a non-zero positive integer.

" + } + }, + "ExpiredObjectDeleteMarker": { + "target": "com.amazonaws.s3#ExpiredObjectDeleteMarker", + "traits": { + "smithy.api#documentation": "

Indicates whether Amazon S3 will remove a delete marker with no noncurrent versions. If set\n to true, the delete marker will be expired; if set to false the policy takes no action.\n This cannot be specified with Days or Date in a Lifecycle Expiration Policy.

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

Container for the expiration for the lifecycle of the object.

" + } + }, + "com.amazonaws.s3#LifecycleRule": { + "type": "structure", + "members": { + "Expiration": { + "target": "com.amazonaws.s3#LifecycleExpiration", + "traits": { + "smithy.api#documentation": "

Specifies the expiration for the lifecycle of the object in the form of date, days and,\n whether the object has a delete marker.

" + } + }, + "ID": { + "target": "com.amazonaws.s3#ID", + "traits": { + "smithy.api#documentation": "

Unique identifier for the rule. The value cannot be longer than 255 characters.

" + } + }, + "Prefix": { + "target": "com.amazonaws.s3#Prefix", + "traits": { + "smithy.api#deprecated": {}, + "smithy.api#documentation": "

Prefix identifying one or more objects to which the rule applies. This is\n No longer used; use Filter instead.

" + } + }, + "Filter": { + "target": "com.amazonaws.s3#LifecycleRuleFilter" + }, + "Status": { + "target": "com.amazonaws.s3#ExpirationStatus", + "traits": { + "smithy.api#documentation": "

If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is not\n currently being applied.

", + "smithy.api#required": {} + } + }, + "Transitions": { + "target": "com.amazonaws.s3#TransitionList", + "traits": { + "smithy.api#documentation": "

Specifies when an Amazon S3 object transitions to a specified storage class.

", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "Transition" + } + }, + "NoncurrentVersionTransitions": { + "target": "com.amazonaws.s3#NoncurrentVersionTransitionList", + "traits": { + "smithy.api#documentation": "

Specifies the transition rule for the lifecycle rule that describes when noncurrent\n objects transition to a specific storage class. If your bucket is versioning-enabled (or\n versioning is suspended), you can set this action to request that Amazon S3 transition\n noncurrent object versions to a specific storage class at a set period in the object's\n lifetime.

", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "NoncurrentVersionTransition" + } + }, + "NoncurrentVersionExpiration": { + "target": "com.amazonaws.s3#NoncurrentVersionExpiration" + }, + "AbortIncompleteMultipartUpload": { + "target": "com.amazonaws.s3#AbortIncompleteMultipartUpload" + } + }, + "traits": { + "smithy.api#documentation": "

A lifecycle rule for individual objects in an Amazon S3 bucket.

" + } + }, + "com.amazonaws.s3#LifecycleRuleAndOperator": { + "type": "structure", + "members": { + "Prefix": { + "target": "com.amazonaws.s3#Prefix", + "traits": { + "smithy.api#documentation": "

Prefix identifying one or more objects to which the rule applies.

" + } + }, + "Tags": { + "target": "com.amazonaws.s3#TagSet", + "traits": { + "smithy.api#documentation": "

All of these tags must exist in the object's tag set in order for the rule to\n apply.

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

This is used in a Lifecycle Rule Filter to apply a logical AND to two or more\n predicates. The Lifecycle Rule will apply to any object matching all of the predicates\n configured inside the And operator.

" + } + }, + "com.amazonaws.s3#LifecycleRuleFilter": { + "type": "union", + "members": { + "Prefix": { + "target": "com.amazonaws.s3#Prefix", + "traits": { + "smithy.api#documentation": "

Prefix identifying one or more objects to which the rule applies.

" + } + }, + "Tag": { + "target": "com.amazonaws.s3#Tag", + "traits": { + "smithy.api#documentation": "

This tag must exist in the object's tag set in order for the rule to apply.

" + } + }, + "And": { + "target": "com.amazonaws.s3#LifecycleRuleAndOperator" + } + }, + "traits": { + "smithy.api#documentation": "

The Filter is used to identify objects that a Lifecycle Rule applies to. A\n Filter must have exactly one of Prefix, Tag, or\n And specified.

" + } + }, + "com.amazonaws.s3#LifecycleRules": { + "type": "list", + "member": { + "target": "com.amazonaws.s3#LifecycleRule" + } + }, + "com.amazonaws.s3#ListBucketAnalyticsConfigurations": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#ListBucketAnalyticsConfigurationsRequest" + }, + "output": { + "target": "com.amazonaws.s3#ListBucketAnalyticsConfigurationsOutput" + }, + "traits": { + "smithy.api#documentation": "

Lists the analytics configurations for the bucket. You can have up to 1,000 analytics\n configurations per bucket.

\n\n

This operation supports list pagination and does not return more than 100 configurations\n at a time. You should always check the IsTruncated element in the response. If\n there are no more configurations to list, IsTruncated is set to false. If\n there are more configurations to list, IsTruncated is set to true, and there\n will be a value in NextContinuationToken. You use the\n NextContinuationToken value to continue the pagination of the list by\n passing the value in continuation-token in the request to GET the next\n page.

\n\n

To use this operation, you must have permissions to perform the\n s3:GetAnalyticsConfiguration action. The bucket owner has this permission\n by default. The bucket owner can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources.

\n\n

For information about Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class\n Analysis.

\n\n

The following operations are related to\n ListBucketAnalyticsConfigurations:

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/{Bucket}?analytics&x-id=ListBucketAnalyticsConfigurations", + "code": 200 + } + } + }, + "com.amazonaws.s3#ListBucketAnalyticsConfigurationsOutput": { + "type": "structure", + "members": { + "IsTruncated": { + "target": "com.amazonaws.s3#IsTruncated", + "traits": { + "smithy.api#documentation": "

Indicates whether the returned list of analytics configurations is complete. A value of\n true indicates that the list is not complete and the NextContinuationToken will be provided\n for a subsequent request.

" + } + }, + "ContinuationToken": { + "target": "com.amazonaws.s3#Token", + "traits": { + "smithy.api#documentation": "

The marker that is used as a starting point for this analytics configuration list\n response. This value is present if it was sent in the request.

" + } + }, + "NextContinuationToken": { + "target": "com.amazonaws.s3#NextToken", + "traits": { + "smithy.api#documentation": "

\n NextContinuationToken is sent when isTruncated is true, which\n indicates that there are more analytics configurations to list. The next request must\n include this NextContinuationToken. The token is obfuscated and is not a\n usable value.

" + } + }, + "AnalyticsConfigurationList": { + "target": "com.amazonaws.s3#AnalyticsConfigurationList", + "traits": { + "smithy.api#documentation": "

The list of analytics configurations for a bucket.

", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "AnalyticsConfiguration" + } + } + } + }, + "com.amazonaws.s3#ListBucketAnalyticsConfigurationsRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket from which analytics configurations are retrieved.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ContinuationToken": { + "target": "com.amazonaws.s3#Token", + "traits": { + "smithy.api#documentation": "

The ContinuationToken that represents a placeholder from where this request should\n begin.

", + "smithy.api#httpQuery": "continuation-token" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + } + }, + "com.amazonaws.s3#ListBucketIntelligentTieringConfigurations": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#ListBucketIntelligentTieringConfigurationsRequest" + }, + "output": { + "target": "com.amazonaws.s3#ListBucketIntelligentTieringConfigurationsOutput" + }, + "traits": { + "smithy.api#documentation": "

Lists the S3 Intelligent-Tiering configuration from the specified bucket.

\n

The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without additional operational overhead. S3 Intelligent-Tiering delivers automatic cost savings by moving data between access tiers, when access patterns change.

\n

The S3 Intelligent-Tiering storage class is suitable for objects larger than 128 KB that you plan to store for at least 30 days. If the size of an object is less than 128 KB, it is not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the frequent access tier rates in the S3 Intelligent-Tiering storage class.

\n

If you delete an object before the end of the 30-day minimum storage duration period, you are charged for 30 days. For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.

\n

Operations related to\n ListBucketIntelligentTieringConfigurations include:

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/{Bucket}?intelligent-tiering&x-id=ListBucketIntelligentTieringConfigurations", + "code": 200 + } + } + }, + "com.amazonaws.s3#ListBucketIntelligentTieringConfigurationsOutput": { + "type": "structure", + "members": { + "IsTruncated": { + "target": "com.amazonaws.s3#IsTruncated", + "traits": { + "smithy.api#documentation": "

Indicates whether the returned list of analytics configurations is complete. A value of\n true indicates that the list is not complete and the NextContinuationToken will be provided\n for a subsequent request.

" + } + }, + "ContinuationToken": { + "target": "com.amazonaws.s3#Token", + "traits": { + "smithy.api#documentation": "

The ContinuationToken that represents a placeholder from where this request should\n begin.

" + } + }, + "NextContinuationToken": { + "target": "com.amazonaws.s3#NextToken", + "traits": { + "smithy.api#documentation": "

The marker used to continue this inventory configuration listing. Use the\n NextContinuationToken from this response to continue the listing in a\n subsequent request. The continuation token is an opaque value that Amazon S3 understands.

" + } + }, + "IntelligentTieringConfigurationList": { + "target": "com.amazonaws.s3#IntelligentTieringConfigurationList", + "traits": { + "smithy.api#documentation": "

The list of S3 Intelligent-Tiering configurations for a bucket.

", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "IntelligentTieringConfiguration" + } + } + } + }, + "com.amazonaws.s3#ListBucketIntelligentTieringConfigurationsRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the Amazon S3 bucket whose configuration you want to modify or retrieve.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ContinuationToken": { + "target": "com.amazonaws.s3#Token", + "traits": { + "smithy.api#documentation": "

The ContinuationToken that represents a placeholder from where this request should\n begin.

", + "smithy.api#httpQuery": "continuation-token" + } + } + } + }, + "com.amazonaws.s3#ListBucketInventoryConfigurations": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#ListBucketInventoryConfigurationsRequest" + }, + "output": { + "target": "com.amazonaws.s3#ListBucketInventoryConfigurationsOutput" + }, + "traits": { + "smithy.api#documentation": "

Returns a list of inventory configurations for the bucket. You can have up to 1,000\n analytics configurations per bucket.

\n\n

This operation supports list pagination and does not return more than 100 configurations\n at a time. Always check the IsTruncated element in the response. If there are\n no more configurations to list, IsTruncated is set to false. If there are more\n configurations to list, IsTruncated is set to true, and there is a value in\n NextContinuationToken. You use the NextContinuationToken value\n to continue the pagination of the list by passing the value in continuation-token in the\n request to GET the next page.

\n\n

To use this operation, you must have permissions to perform the\n s3:GetInventoryConfiguration action. The bucket owner has this permission\n by default. The bucket owner can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources.

\n\n

For information about the Amazon S3 inventory feature, see Amazon S3 Inventory\n

\n\n

The following operations are related to\n ListBucketInventoryConfigurations:

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/{Bucket}?inventory&x-id=ListBucketInventoryConfigurations", + "code": 200 + } + } + }, + "com.amazonaws.s3#ListBucketInventoryConfigurationsOutput": { + "type": "structure", + "members": { + "ContinuationToken": { + "target": "com.amazonaws.s3#Token", + "traits": { + "smithy.api#documentation": "

If sent in the request, the marker that is used as a starting point for this inventory\n configuration list response.

" + } + }, + "InventoryConfigurationList": { + "target": "com.amazonaws.s3#InventoryConfigurationList", + "traits": { + "smithy.api#documentation": "

The list of inventory configurations for a bucket.

", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "InventoryConfiguration" + } + }, + "IsTruncated": { + "target": "com.amazonaws.s3#IsTruncated", + "traits": { + "smithy.api#documentation": "

Tells whether the returned list of inventory configurations is complete. A value of true\n indicates that the list is not complete and the NextContinuationToken is provided for a\n subsequent request.

" + } + }, + "NextContinuationToken": { + "target": "com.amazonaws.s3#NextToken", + "traits": { + "smithy.api#documentation": "

The marker used to continue this inventory configuration listing. Use the\n NextContinuationToken from this response to continue the listing in a\n subsequent request. The continuation token is an opaque value that Amazon S3 understands.

" + } + } + } + }, + "com.amazonaws.s3#ListBucketInventoryConfigurationsRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket containing the inventory configurations to retrieve.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ContinuationToken": { + "target": "com.amazonaws.s3#Token", + "traits": { + "smithy.api#documentation": "

The marker used to continue an inventory configuration listing that has been truncated.\n Use the NextContinuationToken from a previously truncated list response to continue the\n listing. The continuation token is an opaque value that Amazon S3 understands.

", + "smithy.api#httpQuery": "continuation-token" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + } + }, + "com.amazonaws.s3#ListBucketMetricsConfigurations": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#ListBucketMetricsConfigurationsRequest" + }, + "output": { + "target": "com.amazonaws.s3#ListBucketMetricsConfigurationsOutput" + }, + "traits": { + "smithy.api#documentation": "

Lists the metrics configurations for the bucket. The metrics configurations are only for\n the request metrics of the bucket and do not provide information on daily storage metrics.\n You can have up to 1,000 configurations per bucket.

\n\n

This operation supports list pagination and does not return more than 100 configurations\n at a time. Always check the IsTruncated element in the response. If there are\n no more configurations to list, IsTruncated is set to false. If there are more\n configurations to list, IsTruncated is set to true, and there is a value in\n NextContinuationToken. You use the NextContinuationToken value\n to continue the pagination of the list by passing the value in\n continuation-token in the request to GET the next page.

\n\n

To use this operation, you must have permissions to perform the\n s3:GetMetricsConfiguration action. The bucket owner has this permission by\n default. The bucket owner can grant this permission to others. For more information about\n permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources.

\n\n

For more information about metrics configurations and CloudWatch request metrics, see\n Monitoring Metrics with Amazon\n CloudWatch.

\n\n

The following operations are related to\n ListBucketMetricsConfigurations:

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/{Bucket}?metrics&x-id=ListBucketMetricsConfigurations", + "code": 200 + } + } + }, + "com.amazonaws.s3#ListBucketMetricsConfigurationsOutput": { + "type": "structure", + "members": { + "IsTruncated": { + "target": "com.amazonaws.s3#IsTruncated", + "traits": { + "smithy.api#documentation": "

Indicates whether the returned list of metrics configurations is complete. A value of\n true indicates that the list is not complete and the NextContinuationToken will be provided\n for a subsequent request.

" + } + }, + "ContinuationToken": { + "target": "com.amazonaws.s3#Token", + "traits": { + "smithy.api#documentation": "

The marker that is used as a starting point for this metrics configuration list\n response. This value is present if it was sent in the request.

" + } + }, + "NextContinuationToken": { + "target": "com.amazonaws.s3#NextToken", + "traits": { + "smithy.api#documentation": "

The marker used to continue a metrics configuration listing that has been truncated. Use\n the NextContinuationToken from a previously truncated list response to\n continue the listing. The continuation token is an opaque value that Amazon S3\n understands.

" + } + }, + "MetricsConfigurationList": { + "target": "com.amazonaws.s3#MetricsConfigurationList", + "traits": { + "smithy.api#documentation": "

The list of metrics configurations for a bucket.

", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "MetricsConfiguration" + } + } + } + }, + "com.amazonaws.s3#ListBucketMetricsConfigurationsRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket containing the metrics configurations to retrieve.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ContinuationToken": { + "target": "com.amazonaws.s3#Token", + "traits": { + "smithy.api#documentation": "

The marker that is used to continue a metrics configuration listing that has been\n truncated. Use the NextContinuationToken from a previously truncated list response to\n continue the listing. The continuation token is an opaque value that Amazon S3\n understands.

", + "smithy.api#httpQuery": "continuation-token" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + } + }, + "com.amazonaws.s3#ListBuckets": { + "type": "operation", + "output": { + "target": "com.amazonaws.s3#ListBucketsOutput" + }, + "traits": { + "smithy.api#documentation": "

Returns a list of all buckets owned by the authenticated sender of the request.

", + "smithy.api#http": { + "method": "GET", + "uri": "/", + "code": 200 + } + } + }, + "com.amazonaws.s3#ListBucketsOutput": { + "type": "structure", + "members": { + "Buckets": { + "target": "com.amazonaws.s3#Buckets", + "traits": { + "smithy.api#documentation": "

The list of buckets owned by the requestor.

" + } + }, + "Owner": { + "target": "com.amazonaws.s3#Owner", + "traits": { + "smithy.api#documentation": "

The owner of the buckets listed.

" + } + } + } + }, + "com.amazonaws.s3#ListMultipartUploads": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#ListMultipartUploadsRequest" + }, + "output": { + "target": "com.amazonaws.s3#ListMultipartUploadsOutput" + }, + "traits": { + "smithy.api#documentation": "

This operation lists in-progress multipart uploads. An in-progress multipart upload is a\n multipart upload that has been initiated using the Initiate Multipart Upload request, but\n has not yet been completed or aborted.

\n\n

This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart\n uploads is the maximum number of uploads a response can include, which is also the default\n value. You can further limit the number of uploads in a response by specifying the\n max-uploads parameter in the response. If additional multipart uploads\n satisfy the list criteria, the response will contain an IsTruncated element\n with the value true. To list the additional multipart uploads, use the\n key-marker and upload-id-marker request parameters.

\n\n

In the response, the uploads are sorted by key. If your application has initiated more\n than one multipart upload using the same object key, then uploads in the response are first\n sorted by key. Additionally, uploads are sorted in ascending order within each key by the\n upload initiation time.

\n\n

For more information on multipart uploads, see Uploading Objects Using Multipart\n Upload.

\n\n

For information on permissions required to use the multipart upload API, see Multipart Upload API and\n Permissions.

\n\n

The following operations are related to ListMultipartUploads:

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/{Bucket}?uploads", + "code": 200 + } + } + }, + "com.amazonaws.s3#ListMultipartUploadsOutput": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket to which the multipart upload was initiated.

" + } + }, + "KeyMarker": { + "target": "com.amazonaws.s3#KeyMarker", + "traits": { + "smithy.api#documentation": "

The key at or after which the listing began.

" + } + }, + "UploadIdMarker": { + "target": "com.amazonaws.s3#UploadIdMarker", + "traits": { + "smithy.api#documentation": "

Upload ID after which listing began.

" + } + }, + "NextKeyMarker": { + "target": "com.amazonaws.s3#NextKeyMarker", + "traits": { + "smithy.api#documentation": "

When a list is truncated, this element specifies the value that should be used for the\n key-marker request parameter in a subsequent request.

" + } + }, + "Prefix": { + "target": "com.amazonaws.s3#Prefix", + "traits": { + "smithy.api#documentation": "

When a prefix is provided in the request, this field contains the specified prefix. The\n result contains only keys starting with the specified prefix.

" + } + }, + "Delimiter": { + "target": "com.amazonaws.s3#Delimiter", + "traits": { + "smithy.api#documentation": "

Contains the delimiter you specified in the request. If you don't specify a delimiter in\n your request, this element is absent from the response.

" + } + }, + "NextUploadIdMarker": { + "target": "com.amazonaws.s3#NextUploadIdMarker", + "traits": { + "smithy.api#documentation": "

When a list is truncated, this element specifies the value that should be used for the\n upload-id-marker request parameter in a subsequent request.

" + } + }, + "MaxUploads": { + "target": "com.amazonaws.s3#MaxUploads", + "traits": { + "smithy.api#documentation": "

Maximum number of multipart uploads that could have been included in the\n response.

" + } + }, + "IsTruncated": { + "target": "com.amazonaws.s3#IsTruncated", + "traits": { + "smithy.api#documentation": "

Indicates whether the returned list of multipart uploads is truncated. A value of true\n indicates that the list was truncated. The list can be truncated if the number of multipart\n uploads exceeds the limit allowed or specified by max uploads.

" + } + }, + "Uploads": { + "target": "com.amazonaws.s3#MultipartUploadList", + "traits": { + "smithy.api#documentation": "

Container for elements related to a particular multipart upload. A response can contain\n zero or more Upload elements.

", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "Upload" + } + }, + "CommonPrefixes": { + "target": "com.amazonaws.s3#CommonPrefixList", + "traits": { + "smithy.api#documentation": "

If you specify a delimiter in the request, then the result returns each distinct key\n prefix containing the delimiter in a CommonPrefixes element. The distinct key\n prefixes are returned in the Prefix child element.

", + "smithy.api#xmlFlattened": {} + } + }, + "EncodingType": { + "target": "com.amazonaws.s3#EncodingType", + "traits": { + "smithy.api#documentation": "

Encoding type used by Amazon S3 to encode object keys in the response.

\n

If you specify encoding-type request parameter, Amazon S3 includes this element\n in the response, and returns encoded key name values in the following response\n elements:

\n\n

\n Delimiter, KeyMarker, Prefix,\n NextKeyMarker, Key.

" + } + } + } + }, + "com.amazonaws.s3#ListMultipartUploadsRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket to which the multipart upload was initiated.

\n

When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.

\n

When using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Delimiter": { + "target": "com.amazonaws.s3#Delimiter", + "traits": { + "smithy.api#documentation": "

Character you use to group keys.

\n

All keys that contain the same string between the prefix, if specified, and the first\n occurrence of the delimiter after the prefix are grouped under a single result element,\n CommonPrefixes. If you don't specify the prefix parameter, then the\n substring starts at the beginning of the key. The keys that are grouped under\n CommonPrefixes result element are not returned elsewhere in the\n response.

", + "smithy.api#httpQuery": "delimiter" + } + }, + "EncodingType": { + "target": "com.amazonaws.s3#EncodingType", + "traits": { + "smithy.api#httpQuery": "encoding-type" + } + }, + "KeyMarker": { + "target": "com.amazonaws.s3#KeyMarker", + "traits": { + "smithy.api#documentation": "

Together with upload-id-marker, this parameter specifies the multipart upload after\n which listing should begin.

\n

If upload-id-marker is not specified, only the keys lexicographically\n greater than the specified key-marker will be included in the list.

\n\n

If upload-id-marker is specified, any multipart uploads for a key equal to\n the key-marker might also be included, provided those multipart uploads have\n upload IDs lexicographically greater than the specified\n upload-id-marker.

", + "smithy.api#httpQuery": "key-marker" + } + }, + "MaxUploads": { + "target": "com.amazonaws.s3#MaxUploads", + "traits": { + "smithy.api#documentation": "

Sets the maximum number of multipart uploads, from 1 to 1,000, to return in the response\n body. 1,000 is the maximum number of uploads that can be returned in a response.

", + "smithy.api#httpQuery": "max-uploads" + } + }, + "Prefix": { + "target": "com.amazonaws.s3#Prefix", + "traits": { + "smithy.api#documentation": "

Lists in-progress uploads only for those keys that begin with the specified prefix. You\n can use prefixes to separate a bucket into different grouping of keys. (You can think of\n using prefix to make groups in the same way you'd use a folder in a file system.)

", + "smithy.api#httpQuery": "prefix" + } + }, + "UploadIdMarker": { + "target": "com.amazonaws.s3#UploadIdMarker", + "traits": { + "smithy.api#documentation": "

Together with key-marker, specifies the multipart upload after which listing should\n begin. If key-marker is not specified, the upload-id-marker parameter is ignored.\n Otherwise, any multipart uploads for a key equal to the key-marker might be included in the\n list only if they have an upload ID lexicographically greater than the specified\n upload-id-marker.

", + "smithy.api#httpQuery": "upload-id-marker" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + } + }, + "com.amazonaws.s3#ListObjectVersions": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#ListObjectVersionsRequest" + }, + "output": { + "target": "com.amazonaws.s3#ListObjectVersionsOutput" + }, + "traits": { + "smithy.api#documentation": "

Returns metadata about all versions of the objects in a bucket. You can also use request\n parameters as selection criteria to return metadata about a subset of all the object\n versions.

\n \n

A 200 OK response can contain valid or invalid XML. Make sure to design your\n application to parse the contents of the response and handle it appropriately.

\n \n

To use this operation, you must have READ access to the bucket.

\n

This action is not supported by Amazon S3 on Outposts.

\n

The following operations are related to\n ListObjectVersions:

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/{Bucket}?versions", + "code": 200 + } + } + }, + "com.amazonaws.s3#ListObjectVersionsOutput": { + "type": "structure", + "members": { + "IsTruncated": { + "target": "com.amazonaws.s3#IsTruncated", + "traits": { + "smithy.api#documentation": "

A flag that indicates whether Amazon S3 returned all of the results that satisfied the search\n criteria. If your results were truncated, you can make a follow-up paginated request using\n the NextKeyMarker and NextVersionIdMarker response parameters as a starting place in\n another request to return the rest of the results.

" + } + }, + "KeyMarker": { + "target": "com.amazonaws.s3#KeyMarker", + "traits": { + "smithy.api#documentation": "

Marks the last key returned in a truncated response.

" + } + }, + "VersionIdMarker": { + "target": "com.amazonaws.s3#VersionIdMarker", + "traits": { + "smithy.api#documentation": "

Marks the last version of the key returned in a truncated response.

" + } + }, + "NextKeyMarker": { + "target": "com.amazonaws.s3#NextKeyMarker", + "traits": { + "smithy.api#documentation": "

When the number of responses exceeds the value of MaxKeys,\n NextKeyMarker specifies the first key not returned that satisfies the\n search criteria. Use this value for the key-marker request parameter in a subsequent\n request.

" + } + }, + "NextVersionIdMarker": { + "target": "com.amazonaws.s3#NextVersionIdMarker", + "traits": { + "smithy.api#documentation": "

When the number of responses exceeds the value of MaxKeys,\n NextVersionIdMarker specifies the first object version not returned that\n satisfies the search criteria. Use this value for the version-id-marker request parameter\n in a subsequent request.

" + } + }, + "Versions": { + "target": "com.amazonaws.s3#ObjectVersionList", + "traits": { + "smithy.api#documentation": "

Container for version information.

", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "Version" + } + }, + "DeleteMarkers": { + "target": "com.amazonaws.s3#DeleteMarkers", + "traits": { + "smithy.api#documentation": "

Container for an object that is a delete marker.

", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "DeleteMarker" + } + }, + "Name": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The bucket name.

" + } + }, + "Prefix": { + "target": "com.amazonaws.s3#Prefix", + "traits": { + "smithy.api#documentation": "

Selects objects that start with the value supplied by this parameter.

" + } + }, + "Delimiter": { + "target": "com.amazonaws.s3#Delimiter", + "traits": { + "smithy.api#documentation": "

The delimiter grouping the included keys. A delimiter is a character that you specify to\n group keys. All keys that contain the same string between the prefix and the first\n occurrence of the delimiter are grouped under a single result element in\n CommonPrefixes. These groups are counted as one result against the max-keys\n limitation. These keys are not returned elsewhere in the response.

" + } + }, + "MaxKeys": { + "target": "com.amazonaws.s3#MaxKeys", + "traits": { + "smithy.api#documentation": "

Specifies the maximum number of objects to return.

" + } + }, + "CommonPrefixes": { + "target": "com.amazonaws.s3#CommonPrefixList", + "traits": { + "smithy.api#documentation": "

All of the keys rolled up into a common prefix count as a single return when calculating\n the number of returns.

", + "smithy.api#xmlFlattened": {} + } + }, + "EncodingType": { + "target": "com.amazonaws.s3#EncodingType", + "traits": { + "smithy.api#documentation": "

Encoding type used by Amazon S3 to encode object key names in the XML response.

\n\n

If you specify encoding-type request parameter, Amazon S3 includes this element in the\n response, and returns encoded key name values in the following response elements:

\n\n

\n KeyMarker, NextKeyMarker, Prefix, Key, and Delimiter.

" + } + } + } + }, + "com.amazonaws.s3#ListObjectVersionsRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The bucket name that contains the objects.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Delimiter": { + "target": "com.amazonaws.s3#Delimiter", + "traits": { + "smithy.api#documentation": "

A delimiter is a character that you specify to group keys. All keys that contain the\n same string between the prefix and the first occurrence of the delimiter are\n grouped under a single result element in CommonPrefixes. These groups are counted as one\n result against the max-keys limitation. These keys are not returned elsewhere in the\n response.

", + "smithy.api#httpQuery": "delimiter" + } + }, + "EncodingType": { + "target": "com.amazonaws.s3#EncodingType", + "traits": { + "smithy.api#httpQuery": "encoding-type" + } + }, + "KeyMarker": { + "target": "com.amazonaws.s3#KeyMarker", + "traits": { + "smithy.api#documentation": "

Specifies the key to start with when listing objects in a bucket.

", + "smithy.api#httpQuery": "key-marker" + } + }, + "MaxKeys": { + "target": "com.amazonaws.s3#MaxKeys", + "traits": { + "smithy.api#documentation": "

Sets the maximum number of keys returned in the response. By default the API returns up\n to 1,000 key names. The response might contain fewer keys but will never contain more. If\n additional keys satisfy the search criteria, but were not returned because max-keys was\n exceeded, the response contains true. To return the\n additional keys, see key-marker and version-id-marker.

", + "smithy.api#httpQuery": "max-keys" + } + }, + "Prefix": { + "target": "com.amazonaws.s3#Prefix", + "traits": { + "smithy.api#documentation": "

Use this parameter to select only those keys that begin with the specified prefix. You\n can use prefixes to separate a bucket into different groupings of keys. (You can think of\n using prefix to make groups in the same way you'd use a folder in a file system.) You can\n use prefix with delimiter to roll up numerous objects into a single result under\n CommonPrefixes.

", + "smithy.api#httpQuery": "prefix" + } + }, + "VersionIdMarker": { + "target": "com.amazonaws.s3#VersionIdMarker", + "traits": { + "smithy.api#documentation": "

Specifies the object version you want to start listing from.

", + "smithy.api#httpQuery": "version-id-marker" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + } + }, + "com.amazonaws.s3#ListObjects": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#ListObjectsRequest" + }, + "output": { + "target": "com.amazonaws.s3#ListObjectsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.s3#NoSuchBucket" + } + ], + "traits": { + "smithy.api#documentation": "

Returns some or all (up to 1,000) of the objects in a bucket. You can use the request\n parameters as selection criteria to return a subset of the objects in a bucket. A 200 OK\n response can contain valid or invalid XML. Be sure to design your application to parse the\n contents of the response and handle it appropriately.

\n \n

This API has been revised. We recommend that you use the newer version, ListObjectsV2, when developing applications. For backward compatibility,\n Amazon S3 continues to support ListObjects.

\n \n\n\n

The following operations are related to ListObjects:

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/{Bucket}", + "code": 200 + } + } + }, + "com.amazonaws.s3#ListObjectsOutput": { + "type": "structure", + "members": { + "IsTruncated": { + "target": "com.amazonaws.s3#IsTruncated", + "traits": { + "smithy.api#documentation": "

A flag that indicates whether Amazon S3 returned all of the results that satisfied the search\n criteria.

" + } + }, + "Marker": { + "target": "com.amazonaws.s3#Marker", + "traits": { + "smithy.api#documentation": "

Indicates where in the bucket listing begins. Marker is included in the response if it\n was sent with the request.

" + } + }, + "NextMarker": { + "target": "com.amazonaws.s3#NextMarker", + "traits": { + "smithy.api#documentation": "

When response is truncated (the IsTruncated element value in the response is true), you\n can use the key name in this field as marker in the subsequent request to get next set of\n objects. Amazon S3 lists objects in alphabetical order Note: This element is returned only if\n you have delimiter request parameter specified. If response does not include the NextMarker\n and it is truncated, you can use the value of the last Key in the response as the marker in\n the subsequent request to get the next set of object keys.

" + } + }, + "Contents": { + "target": "com.amazonaws.s3#ObjectList", + "traits": { + "smithy.api#documentation": "

Metadata about each object returned.

", + "smithy.api#xmlFlattened": {} + } + }, + "Name": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The bucket name.

" + } + }, + "Prefix": { + "target": "com.amazonaws.s3#Prefix", + "traits": { + "smithy.api#documentation": "

Keys that begin with the indicated prefix.

" + } + }, + "Delimiter": { + "target": "com.amazonaws.s3#Delimiter", + "traits": { + "smithy.api#documentation": "

Causes keys that contain the same string between the prefix and the first occurrence of\n the delimiter to be rolled up into a single result element in the\n CommonPrefixes collection. These rolled-up keys are not returned elsewhere\n in the response. Each rolled-up result counts as only one return against the\n MaxKeys value.

" + } + }, + "MaxKeys": { + "target": "com.amazonaws.s3#MaxKeys", + "traits": { + "smithy.api#documentation": "

The maximum number of keys returned in the response body.

" + } + }, + "CommonPrefixes": { + "target": "com.amazonaws.s3#CommonPrefixList", + "traits": { + "smithy.api#documentation": "

All of the keys rolled up in a common prefix count as a single return when calculating\n the number of returns.

\n\n

A response can contain CommonPrefixes only if you specify a delimiter.

\n\n

CommonPrefixes contains all (if there are any) keys between Prefix and the next\n occurrence of the string specified by the delimiter.

\n\n

CommonPrefixes lists keys that act like subdirectories in the directory specified by\n Prefix.

\n\n

For example, if the prefix is notes/ and the delimiter is a slash (/) as in\n notes/summer/july, the common prefix is notes/summer/. All of the keys that roll up into a\n common prefix count as a single return when calculating the number of returns.

", + "smithy.api#xmlFlattened": {} + } + }, + "EncodingType": { + "target": "com.amazonaws.s3#EncodingType", + "traits": { + "smithy.api#documentation": "

Encoding type used by Amazon S3 to encode object keys in the response.

" + } + } + } + }, + "com.amazonaws.s3#ListObjectsRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket containing the objects.

\n

When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.

\n

When using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Delimiter": { + "target": "com.amazonaws.s3#Delimiter", + "traits": { + "smithy.api#documentation": "

A delimiter is a character you use to group keys.

", + "smithy.api#httpQuery": "delimiter" + } + }, + "EncodingType": { + "target": "com.amazonaws.s3#EncodingType", + "traits": { + "smithy.api#httpQuery": "encoding-type" + } + }, + "Marker": { + "target": "com.amazonaws.s3#Marker", + "traits": { + "smithy.api#documentation": "

Specifies the key to start with when listing objects in a bucket.

", + "smithy.api#httpQuery": "marker" + } + }, + "MaxKeys": { + "target": "com.amazonaws.s3#MaxKeys", + "traits": { + "smithy.api#documentation": "

Sets the maximum number of keys returned in the response. By default the API returns up\n to 1,000 key names. The response might contain fewer keys but will never contain more.\n

", + "smithy.api#httpQuery": "max-keys" + } + }, + "Prefix": { + "target": "com.amazonaws.s3#Prefix", + "traits": { + "smithy.api#documentation": "

Limits the response to keys that begin with the specified prefix.

", + "smithy.api#httpQuery": "prefix" + } + }, + "RequestPayer": { + "target": "com.amazonaws.s3#RequestPayer", + "traits": { + "smithy.api#documentation": "

Confirms that the requester knows that she or he will be charged for the list objects\n request. Bucket owners need not specify this parameter in their requests.

", + "smithy.api#httpHeader": "x-amz-request-payer" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + } + }, + "com.amazonaws.s3#ListObjectsV2": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#ListObjectsV2Request" + }, + "output": { + "target": "com.amazonaws.s3#ListObjectsV2Output" + }, + "errors": [ + { + "target": "com.amazonaws.s3#NoSuchBucket" + } + ], + "traits": { + "smithy.api#documentation": "

Returns some or all (up to 1,000) of the objects in a bucket. You can use the request\n parameters as selection criteria to return a subset of the objects in a bucket. A 200\n OK response can contain valid or invalid XML. Make sure to design your\n application to parse the contents of the response and handle it appropriately.

\n\n

To use this operation, you must have READ access to the bucket.

\n\n

To use this operation in an AWS Identity and Access Management (IAM) policy, you must\n have permissions to perform the s3:ListBucket action. The bucket owner has\n this permission by default and can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources.

\n \n

This section describes the latest revision of the API. We recommend that you use this\n revised API for application development. For backward compatibility, Amazon S3 continues to\n support the prior version of this API, ListObjects.

\n \n\n

To get a list of your buckets, see ListBuckets.

\n\n

The following operations are related to ListObjectsV2:

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/{Bucket}?list-type=2", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "ContinuationToken", + "outputToken": "NextContinuationToken", + "pageSize": "MaxKeys" + } + } + }, + "com.amazonaws.s3#ListObjectsV2Output": { + "type": "structure", + "members": { + "IsTruncated": { + "target": "com.amazonaws.s3#IsTruncated", + "traits": { + "smithy.api#documentation": "

Set to false if all of the results were returned. Set to true if more keys are available\n to return. If the number of results exceeds that specified by MaxKeys, all of the results\n might not be returned.

" + } + }, + "Contents": { + "target": "com.amazonaws.s3#ObjectList", + "traits": { + "smithy.api#documentation": "

Metadata about each object returned.

", + "smithy.api#xmlFlattened": {} + } + }, + "Name": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The bucket name.

\n

When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.

\n

When using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.

" + } + }, + "Prefix": { + "target": "com.amazonaws.s3#Prefix", + "traits": { + "smithy.api#documentation": "

Keys that begin with the indicated prefix.

" + } + }, + "Delimiter": { + "target": "com.amazonaws.s3#Delimiter", + "traits": { + "smithy.api#documentation": "

Causes keys that contain the same string between the prefix and the first occurrence of\n the delimiter to be rolled up into a single result element in the CommonPrefixes\n collection. These rolled-up keys are not returned elsewhere in the response. Each rolled-up\n result counts as only one return against the MaxKeys value.

" + } + }, + "MaxKeys": { + "target": "com.amazonaws.s3#MaxKeys", + "traits": { + "smithy.api#documentation": "

Sets the maximum number of keys returned in the response. By default the API returns up\n to 1,000 key names. The response might contain fewer keys but will never contain\n more.

" + } + }, + "CommonPrefixes": { + "target": "com.amazonaws.s3#CommonPrefixList", + "traits": { + "smithy.api#documentation": "

All of the keys rolled up into a common prefix count as a single return when calculating\n the number of returns.

\n\n

A response can contain CommonPrefixes only if you specify a\n delimiter.

\n\n

\n CommonPrefixes contains all (if there are any) keys between\n Prefix and the next occurrence of the string specified by a\n delimiter.

\n\n

\n CommonPrefixes lists keys that act like subdirectories in the directory\n specified by Prefix.

\n\n

For example, if the prefix is notes/ and the delimiter is a slash\n (/) as in notes/summer/july, the common prefix is\n notes/summer/. All of the keys that roll up into a common prefix count as a\n single return when calculating the number of returns.

", + "smithy.api#xmlFlattened": {} + } + }, + "EncodingType": { + "target": "com.amazonaws.s3#EncodingType", + "traits": { + "smithy.api#documentation": "

Encoding type used by Amazon S3 to encode object key names in the XML response.

\n\n

If you specify the encoding-type request parameter, Amazon S3 includes this element in the\n response, and returns encoded key name values in the following response elements:

\n\n

\n Delimiter, Prefix, Key, and StartAfter.

" + } + }, + "KeyCount": { + "target": "com.amazonaws.s3#KeyCount", + "traits": { + "smithy.api#documentation": "

KeyCount is the number of keys returned with this request. KeyCount will always be less\n than equals to MaxKeys field. Say you ask for 50 keys, your result will include less than\n equals 50 keys

" + } + }, + "ContinuationToken": { + "target": "com.amazonaws.s3#Token", + "traits": { + "smithy.api#documentation": "

If ContinuationToken was sent with the request, it is included in the response.

" + } + }, + "NextContinuationToken": { + "target": "com.amazonaws.s3#NextToken", + "traits": { + "smithy.api#documentation": "

\n NextContinuationToken is sent when isTruncated is true, which\n means there are more keys in the bucket that can be listed. The next list requests to Amazon S3\n can be continued with this NextContinuationToken.\n NextContinuationToken is obfuscated and is not a real key

" + } + }, + "StartAfter": { + "target": "com.amazonaws.s3#StartAfter", + "traits": { + "smithy.api#documentation": "

If StartAfter was sent with the request, it is included in the response.

" + } + } + } + }, + "com.amazonaws.s3#ListObjectsV2Request": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

Bucket name to list.

\n

When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.

\n

When using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Delimiter": { + "target": "com.amazonaws.s3#Delimiter", + "traits": { + "smithy.api#documentation": "

A delimiter is a character you use to group keys.

", + "smithy.api#httpQuery": "delimiter" + } + }, + "EncodingType": { + "target": "com.amazonaws.s3#EncodingType", + "traits": { + "smithy.api#documentation": "

Encoding type used by Amazon S3 to encode object keys in the response.

", + "smithy.api#httpQuery": "encoding-type" + } + }, + "MaxKeys": { + "target": "com.amazonaws.s3#MaxKeys", + "traits": { + "smithy.api#documentation": "

Sets the maximum number of keys returned in the response. By default the API returns up\n to 1,000 key names. The response might contain fewer keys but will never contain\n more.

", + "smithy.api#httpQuery": "max-keys" + } + }, + "Prefix": { + "target": "com.amazonaws.s3#Prefix", + "traits": { + "smithy.api#documentation": "

Limits the response to keys that begin with the specified prefix.

", + "smithy.api#httpQuery": "prefix" + } + }, + "ContinuationToken": { + "target": "com.amazonaws.s3#Token", + "traits": { + "smithy.api#documentation": "

ContinuationToken indicates Amazon S3 that the list is being continued on this bucket with a\n token. ContinuationToken is obfuscated and is not a real key.

", + "smithy.api#httpQuery": "continuation-token" + } + }, + "FetchOwner": { + "target": "com.amazonaws.s3#FetchOwner", + "traits": { + "smithy.api#documentation": "

The owner field is not present in listV2 by default, if you want to return owner field\n with each key in the result then set the fetch owner field to true.

", + "smithy.api#httpQuery": "fetch-owner" + } + }, + "StartAfter": { + "target": "com.amazonaws.s3#StartAfter", + "traits": { + "smithy.api#documentation": "

StartAfter is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this\n specified key. StartAfter can be any key in the bucket.

", + "smithy.api#httpQuery": "start-after" + } + }, + "RequestPayer": { + "target": "com.amazonaws.s3#RequestPayer", + "traits": { + "smithy.api#documentation": "

Confirms that the requester knows that she or he will be charged for the list objects\n request in V2 style. Bucket owners need not specify this parameter in their\n requests.

", + "smithy.api#httpHeader": "x-amz-request-payer" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + } + }, + "com.amazonaws.s3#ListParts": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#ListPartsRequest" + }, + "output": { + "target": "com.amazonaws.s3#ListPartsOutput" + }, + "traits": { + "smithy.api#documentation": "

Lists the parts that have been uploaded for a specific multipart upload. This operation\n must include the upload ID, which you obtain by sending the initiate multipart upload\n request (see CreateMultipartUpload).\n This request returns a maximum of 1,000 uploaded parts. The default number of parts\n returned is 1,000 parts. You can restrict the number of parts returned by specifying the\n max-parts request parameter. If your multipart upload consists of more than\n 1,000 parts, the response returns an IsTruncated field with the value of true,\n and a NextPartNumberMarker element. In subsequent ListParts\n requests you can include the part-number-marker query string parameter and set its value to\n the NextPartNumberMarker field value from the previous response.

\n\n

For more information on multipart uploads, see Uploading Objects Using Multipart\n Upload.

\n\n

For information on permissions required to use the multipart upload API, see Multipart Upload API and\n Permissions.

\n\n

The following operations are related to ListParts:

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/{Bucket}/{Key+}?x-id=ListParts", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "PartNumberMarker", + "outputToken": "NextPartNumberMarker", + "items": "Parts", + "pageSize": "MaxParts" + } + } + }, + "com.amazonaws.s3#ListPartsOutput": { + "type": "structure", + "members": { + "AbortDate": { + "target": "com.amazonaws.s3#AbortDate", + "traits": { + "smithy.api#documentation": "

If the bucket has a lifecycle rule configured with an action to abort incomplete\n multipart uploads and the prefix in the lifecycle rule matches the object name in the\n request, then the response includes this header indicating when the initiated multipart\n upload will become eligible for abort operation. For more information, see Aborting\n Incomplete Multipart Uploads Using a Bucket Lifecycle Policy.

\n\n

The response will also include the x-amz-abort-rule-id header that will\n provide the ID of the lifecycle configuration rule that defines this action.

", + "smithy.api#httpHeader": "x-amz-abort-date" + } + }, + "AbortRuleId": { + "target": "com.amazonaws.s3#AbortRuleId", + "traits": { + "smithy.api#documentation": "

This header is returned along with the x-amz-abort-date header. It\n identifies applicable lifecycle configuration rule that defines the action to abort\n incomplete multipart uploads.

", + "smithy.api#httpHeader": "x-amz-abort-rule-id" + } + }, + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket to which the multipart upload was initiated.

" + } + }, + "Key": { + "target": "com.amazonaws.s3#ObjectKey", + "traits": { + "smithy.api#documentation": "

Object key for which the multipart upload was initiated.

" + } + }, + "UploadId": { + "target": "com.amazonaws.s3#MultipartUploadId", + "traits": { + "smithy.api#documentation": "

Upload ID identifying the multipart upload whose parts are being listed.

" + } + }, + "PartNumberMarker": { + "target": "com.amazonaws.s3#PartNumberMarker", + "traits": { + "smithy.api#documentation": "

When a list is truncated, this element specifies the last part in the list, as well as\n the value to use for the part-number-marker request parameter in a subsequent\n request.

" + } + }, + "NextPartNumberMarker": { + "target": "com.amazonaws.s3#NextPartNumberMarker", + "traits": { + "smithy.api#documentation": "

When a list is truncated, this element specifies the last part in the list, as well as\n the value to use for the part-number-marker request parameter in a subsequent\n request.

" + } + }, + "MaxParts": { + "target": "com.amazonaws.s3#MaxParts", + "traits": { + "smithy.api#documentation": "

Maximum number of parts that were allowed in the response.

" + } + }, + "IsTruncated": { + "target": "com.amazonaws.s3#IsTruncated", + "traits": { + "smithy.api#documentation": "

Indicates whether the returned list of parts is truncated. A true value indicates that\n the list was truncated. A list can be truncated if the number of parts exceeds the limit\n returned in the MaxParts element.

" + } + }, + "Parts": { + "target": "com.amazonaws.s3#Parts", + "traits": { + "smithy.api#documentation": "

Container for elements related to a particular part. A response can contain zero or\n more Part elements.

", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "Part" + } + }, + "Initiator": { + "target": "com.amazonaws.s3#Initiator", + "traits": { + "smithy.api#documentation": "

Container element that identifies who initiated the multipart upload. If the initiator\n is an AWS account, this element provides the same information as the Owner\n element. If the initiator is an IAM User, this element provides the user ARN and display\n name.

" + } + }, + "Owner": { + "target": "com.amazonaws.s3#Owner", + "traits": { + "smithy.api#documentation": "

Container element that identifies the object owner, after the object is created. If\n multipart upload is initiated by an IAM user, this element provides the parent account ID\n and display name.

" + } + }, + "StorageClass": { + "target": "com.amazonaws.s3#StorageClass", + "traits": { + "smithy.api#documentation": "

Class of storage (STANDARD or REDUCED_REDUNDANCY) used to store the uploaded\n object.

" + } + }, + "RequestCharged": { + "target": "com.amazonaws.s3#RequestCharged", + "traits": { + "smithy.api#httpHeader": "x-amz-request-charged" + } + } + } + }, + "com.amazonaws.s3#ListPartsRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket to which the parts are being uploaded.

\n

When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.

\n

When using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Key": { + "target": "com.amazonaws.s3#ObjectKey", + "traits": { + "smithy.api#documentation": "

Object key for which the multipart upload was initiated.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "MaxParts": { + "target": "com.amazonaws.s3#MaxParts", + "traits": { + "smithy.api#documentation": "

Sets the maximum number of parts to return.

", + "smithy.api#httpQuery": "max-parts" + } + }, + "PartNumberMarker": { + "target": "com.amazonaws.s3#PartNumberMarker", + "traits": { + "smithy.api#documentation": "

Specifies the part after which listing should begin. Only parts with higher part numbers\n will be listed.

", + "smithy.api#httpQuery": "part-number-marker" + } + }, + "UploadId": { + "target": "com.amazonaws.s3#MultipartUploadId", + "traits": { + "smithy.api#documentation": "

Upload ID identifying the multipart upload whose parts are being listed.

", + "smithy.api#httpQuery": "uploadId", + "smithy.api#required": {} + } + }, + "RequestPayer": { + "target": "com.amazonaws.s3#RequestPayer", + "traits": { + "smithy.api#httpHeader": "x-amz-request-payer" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + } + }, + "com.amazonaws.s3#Location": { + "type": "string" + }, + "com.amazonaws.s3#LocationPrefix": { + "type": "string" + }, + "com.amazonaws.s3#LoggingEnabled": { + "type": "structure", + "members": { + "TargetBucket": { + "target": "com.amazonaws.s3#TargetBucket", + "traits": { + "smithy.api#documentation": "

Specifies the bucket where you want Amazon S3 to store server access logs. You can have your\n logs delivered to any bucket that you own, including the same bucket that is being logged.\n You can also configure multiple buckets to deliver their logs to the same target bucket. In\n this case, you should choose a different TargetPrefix for each source bucket\n so that the delivered log files can be distinguished by key.

", + "smithy.api#required": {} + } + }, + "TargetGrants": { + "target": "com.amazonaws.s3#TargetGrants", + "traits": { + "smithy.api#documentation": "

Container for granting information.

" + } + }, + "TargetPrefix": { + "target": "com.amazonaws.s3#TargetPrefix", + "traits": { + "smithy.api#documentation": "

A prefix for all log object keys. If you store log files from multiple Amazon S3 buckets in a\n single bucket, you can use a prefix to distinguish which log files came from which\n bucket.

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

Describes where logs are stored and the prefix that Amazon S3 assigns to all log object keys\n for a bucket. For more information, see PUT Bucket logging in the\n Amazon Simple Storage Service API Reference.

" + } + }, + "com.amazonaws.s3#MFA": { + "type": "string" + }, + "com.amazonaws.s3#MFADelete": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Enabled", + "name": "Enabled" + }, + { + "value": "Disabled", + "name": "Disabled" + } + ] + } + }, + "com.amazonaws.s3#MFADeleteStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Enabled", + "name": "Enabled" + }, + { + "value": "Disabled", + "name": "Disabled" + } + ] + } + }, + "com.amazonaws.s3#Marker": { + "type": "string" + }, + "com.amazonaws.s3#MaxAgeSeconds": { + "type": "integer" + }, + "com.amazonaws.s3#MaxKeys": { + "type": "integer" + }, + "com.amazonaws.s3#MaxParts": { + "type": "integer" + }, + "com.amazonaws.s3#MaxUploads": { + "type": "integer" + }, + "com.amazonaws.s3#Message": { + "type": "string" + }, + "com.amazonaws.s3#Metadata": { + "type": "map", + "key": { + "target": "com.amazonaws.s3#MetadataKey" + }, + "value": { + "target": "com.amazonaws.s3#MetadataValue" + } + }, + "com.amazonaws.s3#MetadataDirective": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "COPY", + "name": "COPY" + }, + { + "value": "REPLACE", + "name": "REPLACE" + } + ] + } + }, + "com.amazonaws.s3#MetadataEntry": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.s3#MetadataKey", + "traits": { + "smithy.api#documentation": "

Name of the Object.

" + } + }, + "Value": { + "target": "com.amazonaws.s3#MetadataValue", + "traits": { + "smithy.api#documentation": "

Value of the Object.

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

A metadata key-value pair to store with an object.

" + } + }, + "com.amazonaws.s3#MetadataKey": { + "type": "string" + }, + "com.amazonaws.s3#MetadataValue": { + "type": "string" + }, + "com.amazonaws.s3#Metrics": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.s3#MetricsStatus", + "traits": { + "smithy.api#documentation": "

Specifies whether the replication metrics are enabled.

", + "smithy.api#required": {} + } + }, + "EventThreshold": { + "target": "com.amazonaws.s3#ReplicationTimeValue", + "traits": { + "smithy.api#documentation": "

A container specifying the time threshold for emitting the\n s3:Replication:OperationMissedThreshold event.

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

A container specifying replication metrics-related settings enabling replication\n metrics and events.

" + } + }, + "com.amazonaws.s3#MetricsAndOperator": { + "type": "structure", + "members": { + "Prefix": { + "target": "com.amazonaws.s3#Prefix", + "traits": { + "smithy.api#documentation": "

The prefix used when evaluating an AND predicate.

" + } + }, + "Tags": { + "target": "com.amazonaws.s3#TagSet", + "traits": { + "smithy.api#documentation": "

The list of tags used when evaluating an AND predicate.

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

A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter.\n The operator must have at least two predicates, and an object must match all of the\n predicates in order for the filter to apply.

" + } + }, + "com.amazonaws.s3#MetricsConfiguration": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.s3#MetricsId", + "traits": { + "smithy.api#documentation": "

The ID used to identify the metrics configuration.

", + "smithy.api#required": {} + } + }, + "Filter": { + "target": "com.amazonaws.s3#MetricsFilter", + "traits": { + "smithy.api#documentation": "

Specifies a metrics configuration filter. The metrics configuration will only include\n objects that meet the filter's criteria. A filter must be a prefix, a tag, or a conjunction\n (MetricsAndOperator).

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

Specifies a metrics configuration for the CloudWatch request metrics (specified by the\n metrics configuration ID) from an Amazon S3 bucket. If you're updating an existing metrics\n configuration, note that this is a full replacement of the existing metrics configuration.\n If you don't include the elements you want to keep, they are erased. For more information,\n see PUT Bucket\n metrics in the Amazon Simple Storage Service API Reference.

" + } + }, + "com.amazonaws.s3#MetricsConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.s3#MetricsConfiguration" + } + }, + "com.amazonaws.s3#MetricsFilter": { + "type": "union", + "members": { + "Prefix": { + "target": "com.amazonaws.s3#Prefix", + "traits": { + "smithy.api#documentation": "

The prefix used when evaluating a metrics filter.

" + } + }, + "Tag": { + "target": "com.amazonaws.s3#Tag", + "traits": { + "smithy.api#documentation": "

The tag used when evaluating a metrics filter.

" + } + }, + "And": { + "target": "com.amazonaws.s3#MetricsAndOperator", + "traits": { + "smithy.api#documentation": "

A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter.\n The operator must have at least two predicates, and an object must match all of the\n predicates in order for the filter to apply.

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

Specifies a metrics configuration filter. The metrics configuration only includes\n objects that meet the filter's criteria. A filter must be a prefix, a tag, or a conjunction\n (MetricsAndOperator).

" + } + }, + "com.amazonaws.s3#MetricsId": { + "type": "string" + }, + "com.amazonaws.s3#MetricsStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Enabled", + "name": "Enabled" + }, + { + "value": "Disabled", + "name": "Disabled" + } + ] + } + }, + "com.amazonaws.s3#Minutes": { + "type": "integer" + }, + "com.amazonaws.s3#MissingMeta": { + "type": "integer" + }, + "com.amazonaws.s3#MultipartUpload": { + "type": "structure", + "members": { + "UploadId": { + "target": "com.amazonaws.s3#MultipartUploadId", + "traits": { + "smithy.api#documentation": "

Upload ID that identifies the multipart upload.

" + } + }, + "Key": { + "target": "com.amazonaws.s3#ObjectKey", + "traits": { + "smithy.api#documentation": "

Key of the object for which the multipart upload was initiated.

" + } + }, + "Initiated": { + "target": "com.amazonaws.s3#Initiated", + "traits": { + "smithy.api#documentation": "

Date and time at which the multipart upload was initiated.

" + } + }, + "StorageClass": { + "target": "com.amazonaws.s3#StorageClass", + "traits": { + "smithy.api#documentation": "

The class of storage used to store the object.

" + } + }, + "Owner": { + "target": "com.amazonaws.s3#Owner", + "traits": { + "smithy.api#documentation": "

Specifies the owner of the object that is part of the multipart upload.

" + } + }, + "Initiator": { + "target": "com.amazonaws.s3#Initiator", + "traits": { + "smithy.api#documentation": "

Identifies who initiated the multipart upload.

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

Container for the MultipartUpload for the Amazon S3 object.

" + } + }, + "com.amazonaws.s3#MultipartUploadId": { + "type": "string" + }, + "com.amazonaws.s3#MultipartUploadList": { + "type": "list", + "member": { + "target": "com.amazonaws.s3#MultipartUpload" + } + }, + "com.amazonaws.s3#NextKeyMarker": { + "type": "string" + }, + "com.amazonaws.s3#NextMarker": { + "type": "string" + }, + "com.amazonaws.s3#NextPartNumberMarker": { + "type": "string" + }, + "com.amazonaws.s3#NextToken": { + "type": "string" + }, + "com.amazonaws.s3#NextUploadIdMarker": { + "type": "string" + }, + "com.amazonaws.s3#NextVersionIdMarker": { + "type": "string" + }, + "com.amazonaws.s3#NoSuchBucket": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

The specified bucket does not exist.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.s3#NoSuchKey": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

The specified key does not exist.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.s3#NoSuchUpload": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

The specified multipart upload does not exist.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.s3#NoncurrentVersionExpiration": { + "type": "structure", + "members": { + "NoncurrentDays": { + "target": "com.amazonaws.s3#Days", + "traits": { + "smithy.api#documentation": "

Specifies the number of days an object is noncurrent before Amazon S3 can perform the\n associated action. For information about the noncurrent days calculations, see How\n Amazon S3 Calculates When an Object Became Noncurrent in the Amazon Simple\n Storage Service Developer Guide.

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

Specifies when noncurrent object versions expire. Upon expiration, Amazon S3 permanently\n deletes the noncurrent object versions. You set this lifecycle configuration action on a\n bucket that has versioning enabled (or suspended) to request that Amazon S3 delete noncurrent\n object versions at a specific period in the object's lifetime.

" + } + }, + "com.amazonaws.s3#NoncurrentVersionTransition": { + "type": "structure", + "members": { + "NoncurrentDays": { + "target": "com.amazonaws.s3#Days", + "traits": { + "smithy.api#documentation": "

Specifies the number of days an object is noncurrent before Amazon S3 can perform the\n associated action. For information about the noncurrent days calculations, see How\n Amazon S3 Calculates How Long an Object Has Been Noncurrent in the\n Amazon Simple Storage Service Developer Guide.

" + } + }, + "StorageClass": { + "target": "com.amazonaws.s3#TransitionStorageClass", + "traits": { + "smithy.api#documentation": "

The class of storage used to store the object.

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

Container for the transition rule that describes when noncurrent objects transition to\n the STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING,\n GLACIER, or DEEP_ARCHIVE storage class. If your bucket is\n versioning-enabled (or versioning is suspended), you can set this action to request that\n Amazon S3 transition noncurrent object versions to the STANDARD_IA,\n ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, or\n DEEP_ARCHIVE storage class at a specific period in the object's\n lifetime.

" + } + }, + "com.amazonaws.s3#NoncurrentVersionTransitionList": { + "type": "list", + "member": { + "target": "com.amazonaws.s3#NoncurrentVersionTransition" + } + }, + "com.amazonaws.s3#NotificationConfiguration": { + "type": "structure", + "members": { + "TopicConfigurations": { + "target": "com.amazonaws.s3#TopicConfigurationList", + "traits": { + "smithy.api#documentation": "

The topic to which notifications are sent and the events for which notifications are\n generated.

", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "TopicConfiguration" + } + }, + "QueueConfigurations": { + "target": "com.amazonaws.s3#QueueConfigurationList", + "traits": { + "smithy.api#documentation": "

The Amazon Simple Queue Service queues to publish messages to and the events for which\n to publish messages.

", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "QueueConfiguration" + } + }, + "LambdaFunctionConfigurations": { + "target": "com.amazonaws.s3#LambdaFunctionConfigurationList", + "traits": { + "smithy.api#documentation": "

Describes the AWS Lambda functions to invoke and the events for which to invoke\n them.

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

A container for specifying the notification configuration of the bucket. If this element\n is empty, notifications are turned off for the bucket.

" + } + }, + "com.amazonaws.s3#NotificationConfigurationFilter": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.s3#S3KeyFilter", + "traits": { + "smithy.api#xmlName": "S3Key" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies object key name filtering rules. For information about key name filtering, see\n Configuring\n Event Notifications in the Amazon Simple Storage Service Developer\n Guide.

" + } + }, + "com.amazonaws.s3#NotificationId": { + "type": "string", + "traits": { + "smithy.api#documentation": "

An optional unique identifier for configurations in a notification configuration. If you\n don't provide one, Amazon S3 will assign an ID.

" + } + }, + "com.amazonaws.s3#Object": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.s3#ObjectKey", + "traits": { + "smithy.api#documentation": "

The name that you assign to an object. You use the object key to retrieve the\n object.

" + } + }, + "LastModified": { + "target": "com.amazonaws.s3#LastModified", + "traits": { + "smithy.api#documentation": "

The date the Object was Last Modified

" + } + }, + "ETag": { + "target": "com.amazonaws.s3#ETag", + "traits": { + "smithy.api#documentation": "

The entity tag is a hash of the object. The ETag reflects changes only to the contents\n of an object, not its metadata. The ETag may or may not be an MD5 digest of the object\n data. Whether or not it is depends on how the object was created and how it is encrypted as\n described below:

\n " + } + }, + "Size": { + "target": "com.amazonaws.s3#Size", + "traits": { + "smithy.api#documentation": "

Size in bytes of the object

" + } + }, + "StorageClass": { + "target": "com.amazonaws.s3#ObjectStorageClass", + "traits": { + "smithy.api#documentation": "

The class of storage used to store the object.

" + } + }, + "Owner": { + "target": "com.amazonaws.s3#Owner", + "traits": { + "smithy.api#documentation": "

The owner of the object

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

An object consists of data and its descriptive metadata.

" + } + }, + "com.amazonaws.s3#ObjectAlreadyInActiveTierError": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

This operation is not allowed against this storage tier.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.s3#ObjectCannedACL": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "private", + "name": "private" + }, + { + "value": "public-read", + "name": "public_read" + }, + { + "value": "public-read-write", + "name": "public_read_write" + }, + { + "value": "authenticated-read", + "name": "authenticated_read" + }, + { + "value": "aws-exec-read", + "name": "aws_exec_read" + }, + { + "value": "bucket-owner-read", + "name": "bucket_owner_read" + }, + { + "value": "bucket-owner-full-control", + "name": "bucket_owner_full_control" + } + ] + } + }, + "com.amazonaws.s3#ObjectIdentifier": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.s3#ObjectKey", + "traits": { + "smithy.api#documentation": "

Key name of the object to delete.

", + "smithy.api#required": {} + } + }, + "VersionId": { + "target": "com.amazonaws.s3#ObjectVersionId", + "traits": { + "smithy.api#documentation": "

VersionId for the specific version of the object to delete.

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

Object Identifier is unique value to identify objects.

" + } + }, + "com.amazonaws.s3#ObjectIdentifierList": { + "type": "list", + "member": { + "target": "com.amazonaws.s3#ObjectIdentifier" + } + }, + "com.amazonaws.s3#ObjectKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.s3#ObjectList": { + "type": "list", + "member": { + "target": "com.amazonaws.s3#Object" + } + }, + "com.amazonaws.s3#ObjectLockConfiguration": { + "type": "structure", + "members": { + "ObjectLockEnabled": { + "target": "com.amazonaws.s3#ObjectLockEnabled", + "traits": { + "smithy.api#documentation": "

Indicates whether this bucket has an Object Lock configuration enabled.

" + } + }, + "Rule": { + "target": "com.amazonaws.s3#ObjectLockRule", + "traits": { + "smithy.api#documentation": "

The Object Lock rule in place for the specified object.

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

The container element for Object Lock configuration parameters.

" + } + }, + "com.amazonaws.s3#ObjectLockEnabled": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Enabled", + "name": "Enabled" + } + ] + } + }, + "com.amazonaws.s3#ObjectLockEnabledForBucket": { + "type": "boolean" + }, + "com.amazonaws.s3#ObjectLockLegalHold": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.s3#ObjectLockLegalHoldStatus", + "traits": { + "smithy.api#documentation": "

Indicates whether the specified object has a Legal Hold in place.

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

A Legal Hold configuration for an object.

" + } + }, + "com.amazonaws.s3#ObjectLockLegalHoldStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ON", + "name": "ON" + }, + { + "value": "OFF", + "name": "OFF" + } + ] + } + }, + "com.amazonaws.s3#ObjectLockMode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "GOVERNANCE", + "name": "GOVERNANCE" + }, + { + "value": "COMPLIANCE", + "name": "COMPLIANCE" + } + ] + } + }, + "com.amazonaws.s3#ObjectLockRetainUntilDate": { + "type": "timestamp", + "traits": { + "smithy.api#timestampFormat": "date-time" + } + }, + "com.amazonaws.s3#ObjectLockRetention": { + "type": "structure", + "members": { + "Mode": { + "target": "com.amazonaws.s3#ObjectLockRetentionMode", + "traits": { + "smithy.api#documentation": "

Indicates the Retention mode for the specified object.

" + } + }, + "RetainUntilDate": { + "target": "com.amazonaws.s3#Date", + "traits": { + "smithy.api#documentation": "

The date on which this Object Lock Retention will expire.

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

A Retention configuration for an object.

" + } + }, + "com.amazonaws.s3#ObjectLockRetentionMode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "GOVERNANCE", + "name": "GOVERNANCE" + }, + { + "value": "COMPLIANCE", + "name": "COMPLIANCE" + } + ] + } + }, + "com.amazonaws.s3#ObjectLockRule": { + "type": "structure", + "members": { + "DefaultRetention": { + "target": "com.amazonaws.s3#DefaultRetention", + "traits": { + "smithy.api#documentation": "

The default retention period that you want to apply to new objects placed in the\n specified bucket.

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

The container element for an Object Lock rule.

" + } + }, + "com.amazonaws.s3#ObjectLockToken": { + "type": "string" + }, + "com.amazonaws.s3#ObjectNotInActiveTierError": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

The source object of the COPY operation is not in the active tier and is only stored in\n Amazon S3 Glacier.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.s3#ObjectOwnership": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The container element for object ownership for a bucket's ownership controls.

\n

BucketOwnerPreferred - Objects uploaded to the bucket change ownership to the bucket\n owner if the objects are uploaded with the bucket-owner-full-control canned\n ACL.

\n

ObjectWriter - The uploading account will own the object if the object is uploaded with\n the bucket-owner-full-control canned ACL.

", + "smithy.api#enum": [ + { + "value": "BucketOwnerPreferred", + "name": "BucketOwnerPreferred" + }, + { + "value": "ObjectWriter", + "name": "ObjectWriter" + } + ] + } + }, + "com.amazonaws.s3#ObjectStorageClass": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "STANDARD", + "name": "STANDARD" + }, + { + "value": "REDUCED_REDUNDANCY", + "name": "REDUCED_REDUNDANCY" + }, + { + "value": "GLACIER", + "name": "GLACIER" + }, + { + "value": "STANDARD_IA", + "name": "STANDARD_IA" + }, + { + "value": "ONEZONE_IA", + "name": "ONEZONE_IA" + }, + { + "value": "INTELLIGENT_TIERING", + "name": "INTELLIGENT_TIERING" + }, + { + "value": "DEEP_ARCHIVE", + "name": "DEEP_ARCHIVE" + }, + { + "value": "OUTPOSTS", + "name": "OUTPOSTS" + } + ] + } + }, + "com.amazonaws.s3#ObjectVersion": { + "type": "structure", + "members": { + "ETag": { + "target": "com.amazonaws.s3#ETag", + "traits": { + "smithy.api#documentation": "

The entity tag is an MD5 hash of that version of the object.

" + } + }, + "Size": { + "target": "com.amazonaws.s3#Size", + "traits": { + "smithy.api#documentation": "

Size in bytes of the object.

" + } + }, + "StorageClass": { + "target": "com.amazonaws.s3#ObjectVersionStorageClass", + "traits": { + "smithy.api#documentation": "

The class of storage used to store the object.

" + } + }, + "Key": { + "target": "com.amazonaws.s3#ObjectKey", + "traits": { + "smithy.api#documentation": "

The object key.

" + } + }, + "VersionId": { + "target": "com.amazonaws.s3#ObjectVersionId", + "traits": { + "smithy.api#documentation": "

Version ID of an object.

" + } + }, + "IsLatest": { + "target": "com.amazonaws.s3#IsLatest", + "traits": { + "smithy.api#documentation": "

Specifies whether the object is (true) or is not (false) the latest version of an\n object.

" + } + }, + "LastModified": { + "target": "com.amazonaws.s3#LastModified", + "traits": { + "smithy.api#documentation": "

Date and time the object was last modified.

" + } + }, + "Owner": { + "target": "com.amazonaws.s3#Owner", + "traits": { + "smithy.api#documentation": "

Specifies the owner of the object.

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

The version of an object.

" + } + }, + "com.amazonaws.s3#ObjectVersionId": { + "type": "string" + }, + "com.amazonaws.s3#ObjectVersionList": { + "type": "list", + "member": { + "target": "com.amazonaws.s3#ObjectVersion" + } + }, + "com.amazonaws.s3#ObjectVersionStorageClass": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "STANDARD", + "name": "STANDARD" + } + ] + } + }, + "com.amazonaws.s3#OutputLocation": { + "type": "structure", + "members": { + "S3": { + "target": "com.amazonaws.s3#S3Location", + "traits": { + "smithy.api#documentation": "

Describes an S3 location that will receive the results of the restore request.

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

Describes the location where the restore job's output is stored.

" + } + }, + "com.amazonaws.s3#OutputSerialization": { + "type": "structure", + "members": { + "CSV": { + "target": "com.amazonaws.s3#CSVOutput", + "traits": { + "smithy.api#documentation": "

Describes the serialization of CSV-encoded Select results.

" + } + }, + "JSON": { + "target": "com.amazonaws.s3#JSONOutput", + "traits": { + "smithy.api#documentation": "

Specifies JSON as request's output serialization format.

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

Describes how results of the Select job are serialized.

" + } + }, + "com.amazonaws.s3#Owner": { + "type": "structure", + "members": { + "DisplayName": { + "target": "com.amazonaws.s3#DisplayName", + "traits": { + "smithy.api#documentation": "

Container for the display name of the owner.

" + } + }, + "ID": { + "target": "com.amazonaws.s3#ID", + "traits": { + "smithy.api#documentation": "

Container for the ID of the owner.

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

Container for the owner's display name and ID.

" + } + }, + "com.amazonaws.s3#OwnerOverride": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Destination", + "name": "Destination" + } + ] + } + }, + "com.amazonaws.s3#OwnershipControls": { + "type": "structure", + "members": { + "Rules": { + "target": "com.amazonaws.s3#OwnershipControlsRules", + "traits": { + "smithy.api#documentation": "

The container element for an ownership control rule.

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

The container element for a bucket's ownership controls.

" + } + }, + "com.amazonaws.s3#OwnershipControlsRule": { + "type": "structure", + "members": { + "ObjectOwnership": { + "target": "com.amazonaws.s3#ObjectOwnership", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The container element for an ownership control rule.

" + } + }, + "com.amazonaws.s3#OwnershipControlsRules": { + "type": "list", + "member": { + "target": "com.amazonaws.s3#OwnershipControlsRule" + } + }, + "com.amazonaws.s3#ParquetInput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

Container for Parquet.

" + } + }, + "com.amazonaws.s3#Part": { + "type": "structure", + "members": { + "PartNumber": { + "target": "com.amazonaws.s3#PartNumber", + "traits": { + "smithy.api#documentation": "

Part number identifying the part. This is a positive integer between 1 and\n 10,000.

" + } + }, + "LastModified": { + "target": "com.amazonaws.s3#LastModified", + "traits": { + "smithy.api#documentation": "

Date and time at which the part was uploaded.

" + } + }, + "ETag": { + "target": "com.amazonaws.s3#ETag", + "traits": { + "smithy.api#documentation": "

Entity tag returned when the part was uploaded.

" + } + }, + "Size": { + "target": "com.amazonaws.s3#Size", + "traits": { + "smithy.api#documentation": "

Size in bytes of the uploaded part data.

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

Container for elements related to a part.

" + } + }, + "com.amazonaws.s3#PartNumber": { + "type": "integer" + }, + "com.amazonaws.s3#PartNumberMarker": { + "type": "string" + }, + "com.amazonaws.s3#Parts": { + "type": "list", + "member": { + "target": "com.amazonaws.s3#Part" + } + }, + "com.amazonaws.s3#PartsCount": { + "type": "integer" + }, + "com.amazonaws.s3#Payer": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Requester", + "name": "Requester" + }, + { + "value": "BucketOwner", + "name": "BucketOwner" + } + ] + } + }, + "com.amazonaws.s3#Permission": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "FULL_CONTROL", + "name": "FULL_CONTROL" + }, + { + "value": "WRITE", + "name": "WRITE" + }, + { + "value": "WRITE_ACP", + "name": "WRITE_ACP" + }, + { + "value": "READ", + "name": "READ" + }, + { + "value": "READ_ACP", + "name": "READ_ACP" + } + ] + } + }, + "com.amazonaws.s3#Policy": { + "type": "string" + }, + "com.amazonaws.s3#PolicyStatus": { + "type": "structure", + "members": { + "IsPublic": { + "target": "com.amazonaws.s3#IsPublic", + "traits": { + "smithy.api#documentation": "

The policy status for this bucket. TRUE indicates that this bucket is\n public. FALSE indicates that the bucket is not public.

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

The container element for a bucket's policy status.

" + } + }, + "com.amazonaws.s3#Prefix": { + "type": "string" + }, + "com.amazonaws.s3#Priority": { + "type": "integer" + }, + "com.amazonaws.s3#Progress": { + "type": "structure", + "members": { + "BytesScanned": { + "target": "com.amazonaws.s3#BytesScanned", + "traits": { + "smithy.api#documentation": "

The current number of object bytes scanned.

" + } + }, + "BytesProcessed": { + "target": "com.amazonaws.s3#BytesProcessed", + "traits": { + "smithy.api#documentation": "

The current number of uncompressed object bytes processed.

" + } + }, + "BytesReturned": { + "target": "com.amazonaws.s3#BytesReturned", + "traits": { + "smithy.api#documentation": "

The current number of bytes of records payload data returned.

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

This data type contains information about progress of an operation.

" + } + }, + "com.amazonaws.s3#ProgressEvent": { + "type": "structure", + "members": { + "Details": { + "target": "com.amazonaws.s3#Progress", + "traits": { + "smithy.api#documentation": "

The Progress event details.

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

This data type contains information about the progress event of an operation.

" + } + }, + "com.amazonaws.s3#Protocol": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "http", + "name": "http" + }, + { + "value": "https", + "name": "https" + } + ] + } + }, + "com.amazonaws.s3#PublicAccessBlockConfiguration": { + "type": "structure", + "members": { + "BlockPublicAcls": { + "target": "com.amazonaws.s3#Setting", + "traits": { + "smithy.api#documentation": "

Specifies whether Amazon S3 should block public access control lists (ACLs) for this bucket\n and objects in this bucket. Setting this element to TRUE causes the following\n behavior:

\n \n

Enabling this setting doesn't affect existing policies or ACLs.

", + "smithy.api#xmlName": "BlockPublicAcls" + } + }, + "IgnorePublicAcls": { + "target": "com.amazonaws.s3#Setting", + "traits": { + "smithy.api#documentation": "

Specifies whether Amazon S3 should ignore public ACLs for this bucket and objects in this\n bucket. Setting this element to TRUE causes Amazon S3 to ignore all public ACLs on\n this bucket and objects in this bucket.

\n

Enabling this setting doesn't affect the persistence of any existing ACLs and doesn't\n prevent new public ACLs from being set.

", + "smithy.api#xmlName": "IgnorePublicAcls" + } + }, + "BlockPublicPolicy": { + "target": "com.amazonaws.s3#Setting", + "traits": { + "smithy.api#documentation": "

Specifies whether Amazon S3 should block public bucket policies for this bucket. Setting this\n element to TRUE causes Amazon S3 to reject calls to PUT Bucket policy if the\n specified bucket policy allows public access.

\n

Enabling this setting doesn't affect existing bucket policies.

", + "smithy.api#xmlName": "BlockPublicPolicy" + } + }, + "RestrictPublicBuckets": { + "target": "com.amazonaws.s3#Setting", + "traits": { + "smithy.api#documentation": "

Specifies whether Amazon S3 should restrict public bucket policies for this bucket. Setting\n this element to TRUE restricts access to this bucket to only AWS service\n principals and authorized users within this account if the bucket has a public\n policy.

\n

Enabling this setting doesn't affect previously stored bucket policies, except that\n public and cross-account access within any public bucket policy, including non-public\n delegation to specific accounts, is blocked.

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

The PublicAccessBlock configuration that you want to apply to this Amazon S3 bucket. You can\n enable the configuration options in any combination. For more information about when Amazon S3\n considers a bucket or object public, see The Meaning of \"Public\" in the Amazon Simple Storage Service Developer Guide.

" + } + }, + "com.amazonaws.s3#PutBucketAccelerateConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#PutBucketAccelerateConfigurationRequest" + }, + "traits": { + "smithy.api#documentation": "

Sets the accelerate configuration of an existing bucket. Amazon S3 Transfer Acceleration is a\n bucket-level feature that enables you to perform faster data transfers to Amazon S3.

\n\n

To use this operation, you must have permission to perform the\n s3:PutAccelerateConfiguration action. The bucket owner has this permission by default. The\n bucket owner can grant this permission to others. For more information about permissions,\n see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources.

\n\n

The Transfer Acceleration state of a bucket can be set to one of the following two\n values:

\n \n\n\n

The GetBucketAccelerateConfiguration operation returns the transfer acceleration\n state of a bucket.

\n\n

After setting the Transfer Acceleration state of a bucket to Enabled, it might take up\n to thirty minutes before the data transfer rates to the bucket increase.

\n\n

The name of the bucket used for Transfer Acceleration must be DNS-compliant and must\n not contain periods (\".\").

\n\n

For more information about transfer acceleration, see Transfer Acceleration.

\n\n

The following operations are related to\n PutBucketAccelerateConfiguration:

\n ", + "smithy.api#http": { + "method": "PUT", + "uri": "/{Bucket}?accelerate", + "code": 200 + } + } + }, + "com.amazonaws.s3#PutBucketAccelerateConfigurationRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket for which the accelerate configuration is set.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AccelerateConfiguration": { + "target": "com.amazonaws.s3#AccelerateConfiguration", + "traits": { + "smithy.api#documentation": "

Container for setting the transfer acceleration state.

", + "smithy.api#httpPayload": {}, + "smithy.api#required": {} + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + } + }, + "com.amazonaws.s3#PutBucketAcl": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#PutBucketAclRequest" + }, + "traits": { + "smithy.api#documentation": "

Sets the permissions on an existing bucket using access control lists (ACL). For more\n information, see Using ACLs. To set\n the ACL of a bucket, you must have WRITE_ACP permission.

\n\n

You can use one of the following two ways to set a bucket's permissions:

\n \n\n \n

You cannot specify access permission using both the body and the request\n headers.

\n \n\n

Depending on your application needs, you may choose to set the ACL on a bucket using\n either the request body or the headers. For example, if you have an existing application\n that updates a bucket ACL using the request body, then you can continue to use that\n approach.

\n\n\n

\n Access Permissions\n

\n

You can set access permissions using one of the following methods:

\n \n

You can use either a canned ACL or specify access permissions explicitly. You cannot do\n both.

\n

\n Grantee Values\n

\n

You can specify the person (grantee) to whom you're assigning access rights (using\n request elements) in the following ways:

\n \n\n\n

\n Related Resources\n

\n ", + "smithy.api#http": { + "method": "PUT", + "uri": "/{Bucket}?acl", + "code": 200 + }, + "smithy.api#httpChecksumRequired": {} + } + }, + "com.amazonaws.s3#PutBucketAclRequest": { + "type": "structure", + "members": { + "ACL": { + "target": "com.amazonaws.s3#BucketCannedACL", + "traits": { + "smithy.api#documentation": "

The canned ACL to apply to the bucket.

", + "smithy.api#httpHeader": "x-amz-acl" + } + }, + "AccessControlPolicy": { + "target": "com.amazonaws.s3#AccessControlPolicy", + "traits": { + "smithy.api#documentation": "

Contains the elements that set the ACL permissions for an object per grantee.

", + "smithy.api#httpPayload": {} + } + }, + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The bucket to which to apply the ACL.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ContentMD5": { + "target": "com.amazonaws.s3#ContentMD5", + "traits": { + "smithy.api#documentation": "

The base64-encoded 128-bit MD5 digest of the data. This header must be used as a message\n integrity check to verify that the request body was not corrupted in transit. For more\n information, go to RFC\n 1864.\n

\n

For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically.

", + "smithy.api#httpHeader": "Content-MD5" + } + }, + "GrantFullControl": { + "target": "com.amazonaws.s3#GrantFullControl", + "traits": { + "smithy.api#documentation": "

Allows grantee the read, write, read ACP, and write ACP permissions on the\n bucket.

", + "smithy.api#httpHeader": "x-amz-grant-full-control" + } + }, + "GrantRead": { + "target": "com.amazonaws.s3#GrantRead", + "traits": { + "smithy.api#documentation": "

Allows grantee to list the objects in the bucket.

", + "smithy.api#httpHeader": "x-amz-grant-read" + } + }, + "GrantReadACP": { + "target": "com.amazonaws.s3#GrantReadACP", + "traits": { + "smithy.api#documentation": "

Allows grantee to read the bucket ACL.

", + "smithy.api#httpHeader": "x-amz-grant-read-acp" + } + }, + "GrantWrite": { + "target": "com.amazonaws.s3#GrantWrite", + "traits": { + "smithy.api#documentation": "

Allows grantee to create, overwrite, and delete any object in the bucket.

", + "smithy.api#httpHeader": "x-amz-grant-write" + } + }, + "GrantWriteACP": { + "target": "com.amazonaws.s3#GrantWriteACP", + "traits": { + "smithy.api#documentation": "

Allows grantee to write the ACL for the applicable bucket.

", + "smithy.api#httpHeader": "x-amz-grant-write-acp" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + } + }, + "com.amazonaws.s3#PutBucketAnalyticsConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#PutBucketAnalyticsConfigurationRequest" + }, + "traits": { + "smithy.api#documentation": "

Sets an analytics configuration for the bucket (specified by the analytics configuration\n ID). You can have up to 1,000 analytics configurations per bucket.

\n\n

You can choose to have storage class analysis export analysis reports sent to a\n comma-separated values (CSV) flat file. See the DataExport request element.\n Reports are updated daily and are based on the object filters that you configure. When\n selecting data export, you specify a destination bucket and an optional destination prefix\n where the file is written. You can export the data to a destination bucket in a different\n account. However, the destination bucket must be in the same Region as the bucket that you\n are making the PUT analytics configuration to. For more information, see Amazon S3 Analytics – Storage Class\n Analysis.

\n\n \n

You must create a bucket policy on the destination bucket where the exported file is\n written to grant permissions to Amazon S3 to write objects to the bucket. For an example\n policy, see Granting Permissions for Amazon S3 Inventory and Storage Class Analysis.

\n \n\n

To use this operation, you must have permissions to perform the\n s3:PutAnalyticsConfiguration action. The bucket owner has this permission\n by default. The bucket owner can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources.

\n\n\n

\n Special Errors\n

\n \n\n \n\n\n\n\n

\n Related Resources\n

\n ", + "smithy.api#http": { + "method": "PUT", + "uri": "/{Bucket}?analytics", + "code": 200 + } + } + }, + "com.amazonaws.s3#PutBucketAnalyticsConfigurationRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket to which an analytics configuration is stored.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Id": { + "target": "com.amazonaws.s3#AnalyticsId", + "traits": { + "smithy.api#documentation": "

The ID that identifies the analytics configuration.

", + "smithy.api#httpQuery": "id", + "smithy.api#required": {} + } + }, + "AnalyticsConfiguration": { + "target": "com.amazonaws.s3#AnalyticsConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration and any analyses for the analytics filter.

", + "smithy.api#httpPayload": {}, + "smithy.api#required": {} + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + } + }, + "com.amazonaws.s3#PutBucketCors": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#PutBucketCorsRequest" + }, + "traits": { + "smithy.api#documentation": "

Sets the cors configuration for your bucket. If the configuration exists,\n Amazon S3 replaces it.

\n

To use this operation, you must be allowed to perform the s3:PutBucketCORS\n action. By default, the bucket owner has this permission and can grant it to others.

\n

You set this configuration on a bucket so that the bucket can service cross-origin\n requests. For example, you might want to enable a request whose origin is\n http://www.example.com to access your Amazon S3 bucket at\n my.example.bucket.com by using the browser's XMLHttpRequest\n capability.

\n

To enable cross-origin resource sharing (CORS) on a bucket, you add the\n cors subresource to the bucket. The cors subresource is an XML\n document in which you configure rules that identify origins and the HTTP methods that can\n be executed on your bucket. The document is limited to 64 KB in size.

\n

When Amazon S3 receives a cross-origin request (or a pre-flight OPTIONS request) against a\n bucket, it evaluates the cors configuration on the bucket and uses the first\n CORSRule rule that matches the incoming browser request to enable a\n cross-origin request. For a rule to match, the following conditions must be met:

\n \n

For more information about CORS, go to Enabling\n Cross-Origin Resource Sharing in the Amazon Simple Storage Service Developer Guide.

\n \n

\n Related Resources\n

\n ", + "smithy.api#http": { + "method": "PUT", + "uri": "/{Bucket}?cors", + "code": 200 + }, + "smithy.api#httpChecksumRequired": {} + } + }, + "com.amazonaws.s3#PutBucketCorsRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

Specifies the bucket impacted by the corsconfiguration.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "CORSConfiguration": { + "target": "com.amazonaws.s3#CORSConfiguration", + "traits": { + "smithy.api#documentation": "

Describes the cross-origin access configuration for objects in an Amazon S3 bucket. For more\n information, see Enabling Cross-Origin Resource\n Sharing in the Amazon Simple Storage Service Developer Guide.

", + "smithy.api#httpPayload": {}, + "smithy.api#required": {} + } + }, + "ContentMD5": { + "target": "com.amazonaws.s3#ContentMD5", + "traits": { + "smithy.api#documentation": "

The base64-encoded 128-bit MD5 digest of the data. This header must be used as a message\n integrity check to verify that the request body was not corrupted in transit. For more\n information, go to RFC\n 1864.\n

\n

For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically.

", + "smithy.api#httpHeader": "Content-MD5" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + } + }, + "com.amazonaws.s3#PutBucketEncryption": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#PutBucketEncryptionRequest" + }, + "traits": { + "smithy.api#documentation": "

This operation uses the encryption subresource to configure default\n encryption and Amazon S3 Bucket Key for an existing bucket.

\n

Default encryption for a bucket can use server-side encryption with Amazon S3-managed keys\n (SSE-S3) or AWS KMS customer master keys (SSE-KMS). If you specify default encryption\n using SSE-KMS, you can also configure Amazon S3 Bucket Key. For information about default\n encryption, see Amazon S3 default bucket encryption\n in the Amazon Simple Storage Service Developer Guide. For more information about S3 Bucket Keys,\n see Amazon S3 Bucket Keys in the Amazon Simple Storage Service Developer Guide.

\n \n

This operation requires AWS Signature Version 4. For more information, see Authenticating Requests (AWS Signature\n Version 4).

\n \n

To use this operation, you must have permissions to perform the\n s3:PutEncryptionConfiguration action. The bucket owner has this permission\n by default. The bucket owner can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources in the Amazon Simple Storage Service Developer Guide.

\n \n

\n Related Resources\n

\n ", + "smithy.api#http": { + "method": "PUT", + "uri": "/{Bucket}?encryption", + "code": 200 + }, + "smithy.api#httpChecksumRequired": {} + } + }, + "com.amazonaws.s3#PutBucketEncryptionRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

Specifies default encryption for a bucket using server-side encryption with Amazon S3-managed\n keys (SSE-S3) or customer master keys stored in AWS KMS (SSE-KMS). For information about\n the Amazon S3 default encryption feature, see Amazon S3 Default Bucket Encryption\n in the Amazon Simple Storage Service Developer Guide.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ContentMD5": { + "target": "com.amazonaws.s3#ContentMD5", + "traits": { + "smithy.api#documentation": "

The base64-encoded 128-bit MD5 digest of the server-side encryption configuration.

\n

For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically.

", + "smithy.api#httpHeader": "Content-MD5" + } + }, + "ServerSideEncryptionConfiguration": { + "target": "com.amazonaws.s3#ServerSideEncryptionConfiguration", + "traits": { + "smithy.api#httpPayload": {}, + "smithy.api#required": {} + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + } + }, + "com.amazonaws.s3#PutBucketIntelligentTieringConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#PutBucketIntelligentTieringConfigurationRequest" + }, + "traits": { + "smithy.api#documentation": "

Puts a S3 Intelligent-Tiering configuration to the specified bucket.

\n

The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without additional operational overhead. S3 Intelligent-Tiering delivers automatic cost savings by moving data between access tiers, when access patterns change.

\n

The S3 Intelligent-Tiering storage class is suitable for objects larger than 128 KB that you plan to store for at least 30 days. If the size of an object is less than 128 KB, it is not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the frequent access tier rates in the S3 Intelligent-Tiering storage class.

\n

If you delete an object before the end of the 30-day minimum storage duration period, you are charged for 30 days. For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.

\n

Operations related to\n PutBucketIntelligentTieringConfiguration include:

\n ", + "smithy.api#http": { + "method": "PUT", + "uri": "/{Bucket}?intelligent-tiering", + "code": 200 + } + } + }, + "com.amazonaws.s3#PutBucketIntelligentTieringConfigurationRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the Amazon S3 bucket whose configuration you want to modify or retrieve.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Id": { + "target": "com.amazonaws.s3#IntelligentTieringId", + "traits": { + "smithy.api#documentation": "

The ID used to identify the S3 Intelligent-Tiering configuration.

", + "smithy.api#httpQuery": "id", + "smithy.api#required": {} + } + }, + "IntelligentTieringConfiguration": { + "target": "com.amazonaws.s3#IntelligentTieringConfiguration", + "traits": { + "smithy.api#documentation": "

Container for S3 Intelligent-Tiering configuration.

", + "smithy.api#httpPayload": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.s3#PutBucketInventoryConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#PutBucketInventoryConfigurationRequest" + }, + "traits": { + "smithy.api#documentation": "

This implementation of the PUT operation adds an inventory configuration\n (identified by the inventory ID) to the bucket. You can have up to 1,000 inventory\n configurations per bucket.

\n

Amazon S3 inventory generates inventories of the objects in the bucket on a daily or weekly\n basis, and the results are published to a flat file. The bucket that is inventoried is\n called the source bucket, and the bucket where the inventory flat file\n is stored is called the destination bucket. The\n destination bucket must be in the same AWS Region as the\n source bucket.

\n

When you configure an inventory for a source bucket, you specify\n the destination bucket where you want the inventory to be stored, and\n whether to generate the inventory daily or weekly. You can also configure what object\n metadata to include and whether to inventory all object versions or only current versions.\n For more information, see Amazon S3\n Inventory in the Amazon Simple Storage Service Developer Guide.

\n \n

You must create a bucket policy on the destination bucket to\n grant permissions to Amazon S3 to write objects to the bucket in the defined location. For an\n example policy, see \n Granting Permissions for Amazon S3 Inventory and Storage Class Analysis.

\n \n

To use this operation, you must have permissions to perform the\n s3:PutInventoryConfiguration action. The bucket owner has this permission\n by default and can grant this permission to others. For more information about permissions,\n see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources in the Amazon Simple Storage Service Developer Guide.

\n \n

\n Special Errors\n

\n \n \n

\n Related Resources\n

\n ", + "smithy.api#http": { + "method": "PUT", + "uri": "/{Bucket}?inventory", + "code": 200 + } + } + }, + "com.amazonaws.s3#PutBucketInventoryConfigurationRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket where the inventory configuration will be stored.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Id": { + "target": "com.amazonaws.s3#InventoryId", + "traits": { + "smithy.api#documentation": "

The ID used to identify the inventory configuration.

", + "smithy.api#httpQuery": "id", + "smithy.api#required": {} + } + }, + "InventoryConfiguration": { + "target": "com.amazonaws.s3#InventoryConfiguration", + "traits": { + "smithy.api#documentation": "

Specifies the inventory configuration.

", + "smithy.api#httpPayload": {}, + "smithy.api#required": {} + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + } + }, + "com.amazonaws.s3#PutBucketLifecycleConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#PutBucketLifecycleConfigurationRequest" + }, + "traits": { + "smithy.api#documentation": "

Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle\n configuration. For information about lifecycle configuration, see Managing Access Permissions to Your Amazon S3\n Resources.

\n\n \n

Bucket lifecycle configuration now supports specifying a lifecycle rule using an\n object key name prefix, one or more object tags, or a combination of both. Accordingly,\n this section describes the latest API. The previous version of the API supported\n filtering based only on an object key name prefix, which is supported for backward\n compatibility. For the related API description, see PutBucketLifecycle.

\n \n\n \n\n

\n Rules\n

\n

You specify the lifecycle configuration in your request body. The lifecycle\n configuration is specified as XML consisting of one or more rules. Each rule consists of\n the following:

\n\n \n\n

For more information, see Object\n Lifecycle Management and Lifecycle Configuration Elements.

\n\n\n

\n Permissions\n

\n\n\n

By default, all Amazon S3 resources are private, including buckets, objects, and related\n subresources (for example, lifecycle configuration and website configuration). Only the\n resource owner (that is, the AWS account that created it) can access the resource. The\n resource owner can optionally grant access permissions to others by writing an access\n policy. For this operation, a user must get the s3:PutLifecycleConfiguration\n permission.

\n\n

You can also explicitly deny permissions. Explicit deny also supersedes any other\n permissions. If you want to block users or accounts from removing or deleting objects from\n your bucket, you must deny them permissions for the following actions:

\n\n \n\n\n

For more information about permissions, see Managing Access Permissions to Your Amazon S3\n Resources.

\n\n

The following are related to PutBucketLifecycleConfiguration:

\n ", + "smithy.api#http": { + "method": "PUT", + "uri": "/{Bucket}?lifecycle", + "code": 200 + }, + "smithy.api#httpChecksumRequired": {} + } + }, + "com.amazonaws.s3#PutBucketLifecycleConfigurationRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket for which to set the configuration.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "LifecycleConfiguration": { + "target": "com.amazonaws.s3#BucketLifecycleConfiguration", + "traits": { + "smithy.api#documentation": "

Container for lifecycle rules. You can add as many as 1,000 rules.

", + "smithy.api#httpPayload": {} + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + } + }, + "com.amazonaws.s3#PutBucketLogging": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#PutBucketLoggingRequest" + }, + "traits": { + "smithy.api#documentation": "

Set the logging parameters for a bucket and to specify permissions for who can view and\n modify the logging parameters. All logs are saved to buckets in the same AWS Region as the\n source bucket. To set the logging status of a bucket, you must be the bucket owner.

\n\n

The bucket owner is automatically granted FULL_CONTROL to all logs. You use the\n Grantee request element to grant access to other people. The\n Permissions request element specifies the kind of access the grantee has to\n the logs.

\n\n

\n Grantee Values\n

\n

You can specify the person (grantee) to whom you're assigning access rights (using\n request elements) in the following ways:

\n\n \n\n\n

To enable logging, you use LoggingEnabled and its children request elements. To disable\n logging, you use an empty BucketLoggingStatus request element:

\n\n

\n \n

\n\n

For more information about server access logging, see Server Access Logging.

\n\n

For more information about creating a bucket, see CreateBucket. For more\n information about returning the logging status of a bucket, see GetBucketLogging.

\n\n

The following operations are related to PutBucketLogging:

\n ", + "smithy.api#http": { + "method": "PUT", + "uri": "/{Bucket}?logging", + "code": 200 + }, + "smithy.api#httpChecksumRequired": {} + } + }, + "com.amazonaws.s3#PutBucketLoggingRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket for which to set the logging parameters.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "BucketLoggingStatus": { + "target": "com.amazonaws.s3#BucketLoggingStatus", + "traits": { + "smithy.api#documentation": "

Container for logging status information.

", + "smithy.api#httpPayload": {}, + "smithy.api#required": {} + } + }, + "ContentMD5": { + "target": "com.amazonaws.s3#ContentMD5", + "traits": { + "smithy.api#documentation": "

The MD5 hash of the PutBucketLogging request body.

\n

For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically.

", + "smithy.api#httpHeader": "Content-MD5" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + } + }, + "com.amazonaws.s3#PutBucketMetricsConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#PutBucketMetricsConfigurationRequest" + }, + "traits": { + "smithy.api#documentation": "

Sets a metrics configuration (specified by the metrics configuration ID) for the bucket.\n You can have up to 1,000 metrics configurations per bucket. If you're updating an existing\n metrics configuration, note that this is a full replacement of the existing metrics\n configuration. If you don't include the elements you want to keep, they are erased.

\n\n

To use this operation, you must have permissions to perform the\n s3:PutMetricsConfiguration action. The bucket owner has this permission by\n default. The bucket owner can grant this permission to others. For more information about\n permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources.

\n\n

For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon\n CloudWatch.

\n\n

The following operations are related to\n PutBucketMetricsConfiguration:

\n \n\n\n\n\n\n\n

\n GetBucketLifecycle has the following special error:

\n ", + "smithy.api#http": { + "method": "PUT", + "uri": "/{Bucket}?metrics", + "code": 200 + } + } + }, + "com.amazonaws.s3#PutBucketMetricsConfigurationRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket for which the metrics configuration is set.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Id": { + "target": "com.amazonaws.s3#MetricsId", + "traits": { + "smithy.api#documentation": "

The ID used to identify the metrics configuration.

", + "smithy.api#httpQuery": "id", + "smithy.api#required": {} + } + }, + "MetricsConfiguration": { + "target": "com.amazonaws.s3#MetricsConfiguration", + "traits": { + "smithy.api#documentation": "

Specifies the metrics configuration.

", + "smithy.api#httpPayload": {}, + "smithy.api#required": {} + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + } + }, + "com.amazonaws.s3#PutBucketNotificationConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#PutBucketNotificationConfigurationRequest" + }, + "traits": { + "smithy.api#documentation": "

Enables notifications of specified events for a bucket. For more information about event\n notifications, see Configuring Event\n Notifications.

\n\n

Using this API, you can replace an existing notification configuration. The\n configuration is an XML file that defines the event types that you want Amazon S3 to publish and\n the destination where you want Amazon S3 to publish an event notification when it detects an\n event of the specified type.

\n\n

By default, your bucket has no event notifications configured. That is, the notification\n configuration will be an empty NotificationConfiguration.

\n\n

\n \n

\n

\n \n

\n

This operation replaces the existing notification configuration with the configuration\n you include in the request body.

\n\n

After Amazon S3 receives this request, it first verifies that any Amazon Simple Notification\n Service (Amazon SNS) or Amazon Simple Queue Service (Amazon SQS) destination exists, and\n that the bucket owner has permission to publish to it by sending a test notification. In\n the case of AWS Lambda destinations, Amazon S3 verifies that the Lambda function permissions\n grant Amazon S3 permission to invoke the function from the Amazon S3 bucket. For more information,\n see Configuring Notifications for Amazon S3\n Events.

\n\n

You can disable notifications by adding the empty NotificationConfiguration\n element.

\n\n

By default, only the bucket owner can configure notifications on a bucket. However,\n bucket owners can use a bucket policy to grant permission to other users to set this\n configuration with s3:PutBucketNotification permission.

\n\n \n

The PUT notification is an atomic operation. For example, suppose your notification\n configuration includes SNS topic, SQS queue, and Lambda function configurations. When\n you send a PUT request with this configuration, Amazon S3 sends test messages to your SNS\n topic. If the message fails, the entire PUT operation will fail, and Amazon S3 will not add\n the configuration to your bucket.

\n \n\n

\n Responses\n

\n

If the configuration in the request body includes only one\n TopicConfiguration specifying only the\n s3:ReducedRedundancyLostObject event type, the response will also include\n the x-amz-sns-test-message-id header containing the message ID of the test\n notification sent to the topic.

\n\n

The following operation is related to\n PutBucketNotificationConfiguration:

\n ", + "smithy.api#http": { + "method": "PUT", + "uri": "/{Bucket}?notification", + "code": 200 + } + } + }, + "com.amazonaws.s3#PutBucketNotificationConfigurationRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NotificationConfiguration": { + "target": "com.amazonaws.s3#NotificationConfiguration", + "traits": { + "smithy.api#httpPayload": {}, + "smithy.api#required": {} + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + } + }, + "com.amazonaws.s3#PutBucketOwnershipControls": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#PutBucketOwnershipControlsRequest" + }, + "traits": { + "smithy.api#documentation": "

Creates or modifies OwnershipControls for an Amazon S3 bucket. To use this\n operation, you must have the s3:PutBucketOwnershipControls permission. For\n more information about Amazon S3 permissions, see Specifying Permissions in a Policy.

\n

For information about Amazon S3 Object Ownership, see Using Object Ownership.

\n

The following operations are related to PutBucketOwnershipControls:

\n ", + "smithy.api#http": { + "method": "PUT", + "uri": "/{Bucket}?ownershipControls", + "code": 200 + }, + "smithy.api#httpChecksumRequired": {} + } + }, + "com.amazonaws.s3#PutBucketOwnershipControlsRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the Amazon S3 bucket whose OwnershipControls you want to set.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ContentMD5": { + "target": "com.amazonaws.s3#ContentMD5", + "traits": { + "smithy.api#documentation": "

The MD5 hash of the OwnershipControls request body.

\n

For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically.

", + "smithy.api#httpHeader": "Content-MD5" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + }, + "OwnershipControls": { + "target": "com.amazonaws.s3#OwnershipControls", + "traits": { + "smithy.api#documentation": "

The OwnershipControls (BucketOwnerPreferred or ObjectWriter) that you want\n to apply to this Amazon S3 bucket.

", + "smithy.api#httpPayload": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.s3#PutBucketPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#PutBucketPolicyRequest" + }, + "traits": { + "smithy.api#documentation": "

Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity other than\n the root user of the AWS account that owns the bucket, the calling identity must have the\n PutBucketPolicy permissions on the specified bucket and belong to the\n bucket owner's account in order to use this operation.

\n\n

If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403\n Access Denied error. If you have the correct permissions, but you're not using an\n identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not\n Allowed error.

\n\n \n

As a security precaution, the root user of the AWS account that owns a bucket can\n always use this operation, even if the policy explicitly denies the root user the\n ability to perform this action.

\n \n\n\n

For more information about bucket policies, see Using Bucket Policies and User\n Policies.

\n\n

The following operations are related to PutBucketPolicy:

\n ", + "smithy.api#http": { + "method": "PUT", + "uri": "/{Bucket}?policy", + "code": 200 + }, + "smithy.api#httpChecksumRequired": {} + } + }, + "com.amazonaws.s3#PutBucketPolicyRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ContentMD5": { + "target": "com.amazonaws.s3#ContentMD5", + "traits": { + "smithy.api#documentation": "

The MD5 hash of the request body.

\n

For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically.

", + "smithy.api#httpHeader": "Content-MD5" + } + }, + "ConfirmRemoveSelfBucketAccess": { + "target": "com.amazonaws.s3#ConfirmRemoveSelfBucketAccess", + "traits": { + "smithy.api#documentation": "

Set this parameter to true to confirm that you want to remove your permissions to change\n this bucket policy in the future.

", + "smithy.api#httpHeader": "x-amz-confirm-remove-self-bucket-access" + } + }, + "Policy": { + "target": "com.amazonaws.s3#Policy", + "traits": { + "smithy.api#documentation": "

The bucket policy as a JSON document.

", + "smithy.api#httpPayload": {}, + "smithy.api#required": {} + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + } + }, + "com.amazonaws.s3#PutBucketReplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#PutBucketReplicationRequest" + }, + "traits": { + "smithy.api#documentation": "

Creates a replication configuration or replaces an existing one. For more information,\n see Replication in the Amazon S3 Developer Guide.

\n \n

To perform this operation, the user or role performing the operation must have the\n iam:PassRole permission.

\n \n

Specify the replication configuration in the request body. In the replication\n configuration, you provide the name of the destination bucket or buckets where you want\n Amazon S3 to replicate objects, the IAM role that Amazon S3 can assume to replicate objects on your\n behalf, and other relevant information.

\n\n\n

A replication configuration must include at least one rule, and can contain a maximum of\n 1,000. Each rule identifies a subset of objects to replicate by filtering the objects in\n the source bucket. To choose additional subsets of objects to replicate, add a rule for\n each subset.

\n\n

To specify a subset of the objects in the source bucket to apply a replication rule to,\n add the Filter element as a child of the Rule element. You can filter objects based on an\n object key prefix, one or more object tags, or both. When you add the Filter element in the\n configuration, you must also add the following elements:\n DeleteMarkerReplication, Status, and\n Priority.

\n \n

If you are using an earlier version of the replication configuration, Amazon S3 handles\n replication of delete markers differently. For more information, see Backward Compatibility.

\n \n

For information about enabling versioning on a bucket, see Using Versioning.

\n\n

By default, a resource owner, in this case the AWS account that created the bucket, can\n perform this operation. The resource owner can also grant others permissions to perform the\n operation. For more information about permissions, see Specifying Permissions in a Policy\n and Managing Access Permissions to Your\n Amazon S3 Resources.

\n\n

\n Handling Replication of Encrypted Objects\n

\n

By default, Amazon S3 doesn't replicate objects that are stored at rest using server-side\n encryption with CMKs stored in AWS KMS. To replicate AWS KMS-encrypted objects, add the\n following: SourceSelectionCriteria, SseKmsEncryptedObjects,\n Status, EncryptionConfiguration, and\n ReplicaKmsKeyID. For information about replication configuration, see\n Replicating Objects\n Created with SSE Using CMKs stored in AWS KMS.

\n\n

For information on PutBucketReplication errors, see List of\n replication-related error codes\n

\n\n\n

The following operations are related to PutBucketReplication:

\n ", + "smithy.api#http": { + "method": "PUT", + "uri": "/{Bucket}?replication", + "code": 200 + }, + "smithy.api#httpChecksumRequired": {} + } + }, + "com.amazonaws.s3#PutBucketReplicationRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ContentMD5": { + "target": "com.amazonaws.s3#ContentMD5", + "traits": { + "smithy.api#documentation": "

The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message\n integrity check to verify that the request body was not corrupted in transit. For more\n information, see RFC 1864.

\n

For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically.

", + "smithy.api#httpHeader": "Content-MD5" + } + }, + "ReplicationConfiguration": { + "target": "com.amazonaws.s3#ReplicationConfiguration", + "traits": { + "smithy.api#httpPayload": {}, + "smithy.api#required": {} + } + }, + "Token": { + "target": "com.amazonaws.s3#ObjectLockToken", + "traits": { + "smithy.api#documentation": "

A token to allow Object Lock to be enabled for an existing bucket.

", + "smithy.api#httpHeader": "x-amz-bucket-object-lock-token" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + } + }, + "com.amazonaws.s3#PutBucketRequestPayment": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#PutBucketRequestPaymentRequest" + }, + "traits": { + "smithy.api#documentation": "

Sets the request payment configuration for a bucket. By default, the bucket owner pays\n for downloads from the bucket. This configuration parameter enables the bucket owner (only)\n to specify that the person requesting the download will be charged for the download. For\n more information, see Requester Pays\n Buckets.

\n\n

The following operations are related to PutBucketRequestPayment:

\n ", + "smithy.api#http": { + "method": "PUT", + "uri": "/{Bucket}?requestPayment", + "code": 200 + }, + "smithy.api#httpChecksumRequired": {} + } + }, + "com.amazonaws.s3#PutBucketRequestPaymentRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The bucket name.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ContentMD5": { + "target": "com.amazonaws.s3#ContentMD5", + "traits": { + "smithy.api#documentation": "

>The base64-encoded 128-bit MD5 digest of the data. You must use this header as a\n message integrity check to verify that the request body was not corrupted in transit. For\n more information, see RFC\n 1864.

\n

For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically.

", + "smithy.api#httpHeader": "Content-MD5" + } + }, + "RequestPaymentConfiguration": { + "target": "com.amazonaws.s3#RequestPaymentConfiguration", + "traits": { + "smithy.api#documentation": "

Container for Payer.

", + "smithy.api#httpPayload": {}, + "smithy.api#required": {} + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + } + }, + "com.amazonaws.s3#PutBucketTagging": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#PutBucketTaggingRequest" + }, + "traits": { + "smithy.api#documentation": "

Sets the tags for a bucket.

\n

Use tags to organize your AWS bill to reflect your own cost structure. To do this, sign\n up to get your AWS account bill with tag key values included. Then, to see the cost of\n combined resources, organize your billing information according to resources with the same\n tag key values. For example, you can tag several resources with a specific application\n name, and then organize your billing information to see the total cost of that application\n across several services. For more information, see Cost Allocation\n and Tagging.

\n\n \n

Within a bucket, if you add a tag that has the same key as an existing tag, the new\n value overwrites the old value. For more information, see Using Cost Allocation in Amazon S3 Bucket\n Tags.

\n \n

To use this operation, you must have permissions to perform the\n s3:PutBucketTagging action. The bucket owner has this permission by default\n and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources.

\n\n

\n PutBucketTagging has the following special errors:

\n \n\n\n

The following operations are related to PutBucketTagging:

\n ", + "smithy.api#http": { + "method": "PUT", + "uri": "/{Bucket}?tagging", + "code": 200 + }, + "smithy.api#httpChecksumRequired": {} + } + }, + "com.amazonaws.s3#PutBucketTaggingRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The bucket name.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ContentMD5": { + "target": "com.amazonaws.s3#ContentMD5", + "traits": { + "smithy.api#documentation": "

The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message\n integrity check to verify that the request body was not corrupted in transit. For more\n information, see RFC 1864.

\n

For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically.

", + "smithy.api#httpHeader": "Content-MD5" + } + }, + "Tagging": { + "target": "com.amazonaws.s3#Tagging", + "traits": { + "smithy.api#documentation": "

Container for the TagSet and Tag elements.

", + "smithy.api#httpPayload": {}, + "smithy.api#required": {} + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + } + }, + "com.amazonaws.s3#PutBucketVersioning": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#PutBucketVersioningRequest" + }, + "traits": { + "smithy.api#documentation": "

Sets the versioning state of an existing bucket. To set the versioning state, you must\n be the bucket owner.

\n

You can set the versioning state with one of the following values:

\n\n

\n Enabled—Enables versioning for the objects in the\n bucket. All objects added to the bucket receive a unique version ID.

\n\n

\n Suspended—Disables versioning for the objects in the\n bucket. All objects added to the bucket receive the version ID null.

\n\n

If the versioning state has never been set on a bucket, it has no versioning state; a\n GetBucketVersioning request does not return a versioning state value.

\n\n

If the bucket owner enables MFA Delete in the bucket versioning configuration, the\n bucket owner must include the x-amz-mfa request header and the\n Status and the MfaDelete request elements in a request to set\n the versioning state of the bucket.

\n\n \n

If you have an object expiration lifecycle policy in your non-versioned bucket and\n you want to maintain the same permanent delete behavior when you enable versioning, you\n must add a noncurrent expiration policy. The noncurrent expiration lifecycle policy will\n manage the deletes of the noncurrent object versions in the version-enabled bucket. (A\n version-enabled bucket maintains one current and zero or more noncurrent object\n versions.) For more information, see Lifecycle and Versioning.

\n \n\n

\n Related Resources\n

\n ", + "smithy.api#http": { + "method": "PUT", + "uri": "/{Bucket}?versioning", + "code": 200 + }, + "smithy.api#httpChecksumRequired": {} + } + }, + "com.amazonaws.s3#PutBucketVersioningRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The bucket name.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ContentMD5": { + "target": "com.amazonaws.s3#ContentMD5", + "traits": { + "smithy.api#documentation": "

>The base64-encoded 128-bit MD5 digest of the data. You must use this header as a\n message integrity check to verify that the request body was not corrupted in transit. For\n more information, see RFC\n 1864.

\n

For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically.

", + "smithy.api#httpHeader": "Content-MD5" + } + }, + "MFA": { + "target": "com.amazonaws.s3#MFA", + "traits": { + "smithy.api#documentation": "

The concatenation of the authentication device's serial number, a space, and the value\n that is displayed on your authentication device.

", + "smithy.api#httpHeader": "x-amz-mfa" + } + }, + "VersioningConfiguration": { + "target": "com.amazonaws.s3#VersioningConfiguration", + "traits": { + "smithy.api#documentation": "

Container for setting the versioning state.

", + "smithy.api#httpPayload": {}, + "smithy.api#required": {} + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + } + }, + "com.amazonaws.s3#PutBucketWebsite": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#PutBucketWebsiteRequest" + }, + "traits": { + "smithy.api#documentation": "

Sets the configuration of the website that is specified in the website\n subresource. To configure a bucket as a website, you can add this subresource on the bucket\n with website configuration information such as the file name of the index document and any\n redirect rules. For more information, see Hosting Websites on Amazon S3.

\n\n

This PUT operation requires the S3:PutBucketWebsite permission. By default,\n only the bucket owner can configure the website attached to a bucket; however, bucket\n owners can allow other users to set the website configuration by writing a bucket policy\n that grants them the S3:PutBucketWebsite permission.

\n\n

To redirect all website requests sent to the bucket's website endpoint, you add a\n website configuration with the following elements. Because all requests are sent to another\n website, you don't need to provide index document name for the bucket.

\n \n\n

If you want granular control over redirects, you can use the following elements to add\n routing rules that describe conditions for redirecting requests and information about the\n redirect destination. In this case, the website configuration must provide an index\n document for the bucket, because some requests might not be redirected.

\n \n\n

Amazon S3 has a limitation of 50 routing rules per website configuration. If you require more\n than 50 routing rules, you can use object redirect. For more information, see Configuring an\n Object Redirect in the Amazon Simple Storage Service Developer Guide.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/{Bucket}?website", + "code": 200 + }, + "smithy.api#httpChecksumRequired": {} + } + }, + "com.amazonaws.s3#PutBucketWebsiteRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The bucket name.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ContentMD5": { + "target": "com.amazonaws.s3#ContentMD5", + "traits": { + "smithy.api#documentation": "

The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message\n integrity check to verify that the request body was not corrupted in transit. For more\n information, see RFC 1864.

\n

For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically.

", + "smithy.api#httpHeader": "Content-MD5" + } + }, + "WebsiteConfiguration": { + "target": "com.amazonaws.s3#WebsiteConfiguration", + "traits": { + "smithy.api#documentation": "

Container for the request.

", + "smithy.api#httpPayload": {}, + "smithy.api#required": {} + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + } + }, + "com.amazonaws.s3#PutObject": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#PutObjectRequest" + }, + "output": { + "target": "com.amazonaws.s3#PutObjectOutput" + }, + "traits": { + "smithy.api#documentation": "

Adds an object to a bucket. You must have WRITE permissions on a bucket to add an object\n to it.

\n\n\n

Amazon S3 never adds partial objects; if you receive a success response, Amazon S3 added the\n entire object to the bucket.

\n\n

Amazon S3 is a distributed system. If it receives multiple write requests for the same object\n simultaneously, it overwrites all but the last object written. Amazon S3 does not provide object\n locking; if you need this, make sure to build it into your application layer or use\n versioning instead.

\n\n

To ensure that data is not corrupted traversing the network, use the\n Content-MD5 header. When you use this header, Amazon S3 checks the object\n against the provided MD5 value and, if they do not match, returns an error. Additionally,\n you can calculate the MD5 while putting an object to Amazon S3 and compare the returned ETag to\n the calculated MD5 value.

\n \n

The Content-MD5 header is required for any request to upload an object\n with a retention period configured using Amazon S3 Object Lock. For more information about\n Amazon S3 Object Lock, see Amazon S3 Object Lock Overview\n in the Amazon Simple Storage Service Developer Guide.

\n \n\n\n

\n Server-side Encryption\n

\n

You can optionally request server-side encryption. With server-side encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts the data\n when you access it. You have the option to provide your own encryption key or use AWS\n managed encryption keys (SSE-S3 or SSE-KMS). For more information, see Using Server-Side\n Encryption.

\n

If you request server-side encryption using AWS Key Management Service (SSE-KMS), you can enable an S3 Bucket Key at the object-level. For more information, see Amazon S3 Bucket Keys in the Amazon Simple Storage Service Developer Guide.

\n

\n Access Control List (ACL)-Specific Request\n Headers\n

\n

You can use headers to grant ACL- based permissions. By default, all objects are\n private. Only the owner has full access control. When adding a new object, you can grant\n permissions to individual AWS accounts or to predefined groups defined by Amazon S3. These\n permissions are then added to the ACL on the object. For more information, see Access Control List\n (ACL) Overview and Managing ACLs Using the REST\n API.

\n\n

\n Storage Class Options\n

\n

By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The\n STANDARD storage class provides high durability and high availability. Depending on\n performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses\n the OUTPOSTS Storage Class. For more information, see Storage Classes in the Amazon S3\n Service Developer Guide.

\n\n\n

\n Versioning\n

\n

If you enable versioning for a bucket, Amazon S3 automatically generates a unique version ID\n for the object being stored. Amazon S3 returns this ID in the response. When you enable\n versioning for a bucket, if Amazon S3 receives multiple write requests for the same object\n simultaneously, it stores all of the objects.

\n

For more information about versioning, see Adding Objects to\n Versioning Enabled Buckets. For information about returning the versioning state\n of a bucket, see GetBucketVersioning.

\n\n\n

\n Related Resources\n

\n ", + "smithy.api#http": { + "method": "PUT", + "uri": "/{Bucket}/{Key+}?x-id=PutObject", + "code": 200 + } + } + }, + "com.amazonaws.s3#PutObjectAcl": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#PutObjectAclRequest" + }, + "output": { + "target": "com.amazonaws.s3#PutObjectAclOutput" + }, + "errors": [ + { + "target": "com.amazonaws.s3#NoSuchKey" + } + ], + "traits": { + "smithy.api#documentation": "

Uses the acl subresource to set the access control list (ACL) permissions\n for a new or existing object in an S3 bucket. You must have WRITE_ACP\n permission to set the ACL of an object. For more information, see What\n permissions can I grant? in the Amazon Simple Storage Service Developer Guide.

\n

This action is not supported by Amazon S3 on Outposts.

\n

Depending on your application needs, you can choose to set\n the ACL on an object using either the request body or the headers. For example, if you have\n an existing application that updates a bucket ACL using the request body, you can continue\n to use that approach. For more information, see Access Control List (ACL) Overview in the Amazon S3 Developer\n Guide.

\n\n\n\n

\n Access Permissions\n

\n

You can set access permissions using one of the following methods:

\n \n

You can use either a canned ACL or specify access permissions explicitly. You cannot do\n both.

\n

\n Grantee Values\n

\n

You can specify the person (grantee) to whom you're assigning access rights (using\n request elements) in the following ways:

\n \n

\n Versioning\n

\n

The ACL of an object is set at the object version level. By default, PUT sets the ACL of\n the current version of an object. To set the ACL of a different version, use the\n versionId subresource.

\n

\n Related Resources\n

\n ", + "smithy.api#http": { + "method": "PUT", + "uri": "/{Bucket}/{Key+}?acl", + "code": 200 + }, + "smithy.api#httpChecksumRequired": {} + } + }, + "com.amazonaws.s3#PutObjectAclOutput": { + "type": "structure", + "members": { + "RequestCharged": { + "target": "com.amazonaws.s3#RequestCharged", + "traits": { + "smithy.api#httpHeader": "x-amz-request-charged" + } + } + } + }, + "com.amazonaws.s3#PutObjectAclRequest": { + "type": "structure", + "members": { + "ACL": { + "target": "com.amazonaws.s3#ObjectCannedACL", + "traits": { + "smithy.api#documentation": "

The canned ACL to apply to the object. For more information, see Canned ACL.

", + "smithy.api#httpHeader": "x-amz-acl" + } + }, + "AccessControlPolicy": { + "target": "com.amazonaws.s3#AccessControlPolicy", + "traits": { + "smithy.api#documentation": "

Contains the elements that set the ACL permissions for an object per grantee.

", + "smithy.api#httpPayload": {} + } + }, + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The bucket name that contains the object to which you want to attach the ACL.

\n

When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ContentMD5": { + "target": "com.amazonaws.s3#ContentMD5", + "traits": { + "smithy.api#documentation": "

The base64-encoded 128-bit MD5 digest of the data. This header must be used as a message\n integrity check to verify that the request body was not corrupted in transit. For more\n information, go to RFC\n 1864.>\n

\n

For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically.

", + "smithy.api#httpHeader": "Content-MD5" + } + }, + "GrantFullControl": { + "target": "com.amazonaws.s3#GrantFullControl", + "traits": { + "smithy.api#documentation": "

Allows grantee the read, write, read ACP, and write ACP permissions on the\n bucket.

\n

This action is not supported by Amazon S3 on Outposts.

", + "smithy.api#httpHeader": "x-amz-grant-full-control" + } + }, + "GrantRead": { + "target": "com.amazonaws.s3#GrantRead", + "traits": { + "smithy.api#documentation": "

Allows grantee to list the objects in the\n bucket.

\n

This action is not supported by Amazon S3 on Outposts.

", + "smithy.api#httpHeader": "x-amz-grant-read" + } + }, + "GrantReadACP": { + "target": "com.amazonaws.s3#GrantReadACP", + "traits": { + "smithy.api#documentation": "

Allows grantee to read the bucket ACL.

\n

This action is not supported by Amazon S3 on Outposts.

", + "smithy.api#httpHeader": "x-amz-grant-read-acp" + } + }, + "GrantWrite": { + "target": "com.amazonaws.s3#GrantWrite", + "traits": { + "smithy.api#documentation": "

Allows grantee to create, overwrite, and delete any object in the bucket.

", + "smithy.api#httpHeader": "x-amz-grant-write" + } + }, + "GrantWriteACP": { + "target": "com.amazonaws.s3#GrantWriteACP", + "traits": { + "smithy.api#documentation": "

Allows grantee to write the ACL for the applicable\n bucket.

\n

This action is not supported by Amazon S3 on Outposts.

", + "smithy.api#httpHeader": "x-amz-grant-write-acp" + } + }, + "Key": { + "target": "com.amazonaws.s3#ObjectKey", + "traits": { + "smithy.api#documentation": "

Key for which the PUT operation was initiated.

\n

When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.

\n

When using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "RequestPayer": { + "target": "com.amazonaws.s3#RequestPayer", + "traits": { + "smithy.api#httpHeader": "x-amz-request-payer" + } + }, + "VersionId": { + "target": "com.amazonaws.s3#ObjectVersionId", + "traits": { + "smithy.api#documentation": "

VersionId used to reference a specific version of the object.

", + "smithy.api#httpQuery": "versionId" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + } + }, + "com.amazonaws.s3#PutObjectLegalHold": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#PutObjectLegalHoldRequest" + }, + "output": { + "target": "com.amazonaws.s3#PutObjectLegalHoldOutput" + }, + "traits": { + "smithy.api#documentation": "

Applies a Legal Hold configuration to the specified object.

\n

This action is not supported by Amazon S3 on Outposts.

\n

\n Related Resources\n

\n ", + "smithy.api#http": { + "method": "PUT", + "uri": "/{Bucket}/{Key+}?legal-hold", + "code": 200 + }, + "smithy.api#httpChecksumRequired": {} + } + }, + "com.amazonaws.s3#PutObjectLegalHoldOutput": { + "type": "structure", + "members": { + "RequestCharged": { + "target": "com.amazonaws.s3#RequestCharged", + "traits": { + "smithy.api#httpHeader": "x-amz-request-charged" + } + } + } + }, + "com.amazonaws.s3#PutObjectLegalHoldRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The bucket name containing the object that you want to place a Legal Hold on.

\n

When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Key": { + "target": "com.amazonaws.s3#ObjectKey", + "traits": { + "smithy.api#documentation": "

The key name for the object that you want to place a Legal Hold on.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "LegalHold": { + "target": "com.amazonaws.s3#ObjectLockLegalHold", + "traits": { + "smithy.api#documentation": "

Container element for the Legal Hold configuration you want to apply to the specified\n object.

", + "smithy.api#httpPayload": {} + } + }, + "RequestPayer": { + "target": "com.amazonaws.s3#RequestPayer", + "traits": { + "smithy.api#httpHeader": "x-amz-request-payer" + } + }, + "VersionId": { + "target": "com.amazonaws.s3#ObjectVersionId", + "traits": { + "smithy.api#documentation": "

The version ID of the object that you want to place a Legal Hold on.

", + "smithy.api#httpQuery": "versionId" + } + }, + "ContentMD5": { + "target": "com.amazonaws.s3#ContentMD5", + "traits": { + "smithy.api#documentation": "

The MD5 hash for the request body.

\n

For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically.

", + "smithy.api#httpHeader": "Content-MD5" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + } + }, + "com.amazonaws.s3#PutObjectLockConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#PutObjectLockConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.s3#PutObjectLockConfigurationOutput" + }, + "traits": { + "smithy.api#documentation": "

Places an Object Lock configuration on the specified bucket. The rule specified in the\n Object Lock configuration will be applied by default to every new object placed in the\n specified bucket.

\n \n

\n DefaultRetention requires either Days or Years. You can't specify both\n at the same time.

\n \n

\n Related Resources\n

\n ", + "smithy.api#http": { + "method": "PUT", + "uri": "/{Bucket}?object-lock", + "code": 200 + }, + "smithy.api#httpChecksumRequired": {} + } + }, + "com.amazonaws.s3#PutObjectLockConfigurationOutput": { + "type": "structure", + "members": { + "RequestCharged": { + "target": "com.amazonaws.s3#RequestCharged", + "traits": { + "smithy.api#httpHeader": "x-amz-request-charged" + } + } + } + }, + "com.amazonaws.s3#PutObjectLockConfigurationRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The bucket whose Object Lock configuration you want to create or replace.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ObjectLockConfiguration": { + "target": "com.amazonaws.s3#ObjectLockConfiguration", + "traits": { + "smithy.api#documentation": "

The Object Lock configuration that you want to apply to the specified bucket.

", + "smithy.api#httpPayload": {} + } + }, + "RequestPayer": { + "target": "com.amazonaws.s3#RequestPayer", + "traits": { + "smithy.api#httpHeader": "x-amz-request-payer" + } + }, + "Token": { + "target": "com.amazonaws.s3#ObjectLockToken", + "traits": { + "smithy.api#documentation": "

A token to allow Object Lock to be enabled for an existing bucket.

", + "smithy.api#httpHeader": "x-amz-bucket-object-lock-token" + } + }, + "ContentMD5": { + "target": "com.amazonaws.s3#ContentMD5", + "traits": { + "smithy.api#documentation": "

The MD5 hash for the request body.

\n

For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically.

", + "smithy.api#httpHeader": "Content-MD5" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + } + }, + "com.amazonaws.s3#PutObjectOutput": { + "type": "structure", + "members": { + "Expiration": { + "target": "com.amazonaws.s3#Expiration", + "traits": { + "smithy.api#documentation": "

If the expiration is configured for the object (see PutBucketLifecycleConfiguration), the response includes this header. It\n includes the expiry-date and rule-id key-value pairs that provide information about object\n expiration. The value of the rule-id is URL encoded.

", + "smithy.api#httpHeader": "x-amz-expiration" + } + }, + "ETag": { + "target": "com.amazonaws.s3#ETag", + "traits": { + "smithy.api#documentation": "

Entity tag for the uploaded object.

", + "smithy.api#httpHeader": "ETag" + } + }, + "ServerSideEncryption": { + "target": "com.amazonaws.s3#ServerSideEncryption", + "traits": { + "smithy.api#documentation": "

If you specified server-side encryption either with an AWS KMS customer master key (CMK)\n or Amazon S3-managed encryption key in your PUT request, the response includes this header. It\n confirms the encryption algorithm that Amazon S3 used to encrypt the object.

", + "smithy.api#httpHeader": "x-amz-server-side-encryption" + } + }, + "VersionId": { + "target": "com.amazonaws.s3#ObjectVersionId", + "traits": { + "smithy.api#documentation": "

Version of the object.

", + "smithy.api#httpHeader": "x-amz-version-id" + } + }, + "SSECustomerAlgorithm": { + "target": "com.amazonaws.s3#SSECustomerAlgorithm", + "traits": { + "smithy.api#documentation": "

If server-side encryption with a customer-provided encryption key was requested, the\n response will include this header confirming the encryption algorithm used.

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-algorithm" + } + }, + "SSECustomerKeyMD5": { + "target": "com.amazonaws.s3#SSECustomerKeyMD5", + "traits": { + "smithy.api#documentation": "

If server-side encryption with a customer-provided encryption key was requested, the\n response will include this header to provide round-trip message integrity verification of\n the customer-provided encryption key.

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key-MD5" + } + }, + "SSEKMSKeyId": { + "target": "com.amazonaws.s3#SSEKMSKeyId", + "traits": { + "smithy.api#documentation": "

If x-amz-server-side-encryption is present and has the value of\n aws:kms, this header specifies the ID of the AWS Key Management Service\n (AWS KMS) symmetric customer managed customer master key (CMK) that was used for the\n object.

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" + } + }, + "SSEKMSEncryptionContext": { + "target": "com.amazonaws.s3#SSEKMSEncryptionContext", + "traits": { + "smithy.api#documentation": "

If present, specifies the AWS KMS Encryption Context to use for object encryption. The\n value of this header is a base64-encoded UTF-8 string holding JSON with the encryption\n context key-value pairs.

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-context" + } + }, + "BucketKeyEnabled": { + "target": "com.amazonaws.s3#BucketKeyEnabled", + "traits": { + "smithy.api#documentation": "

Indicates whether the uploaded object uses an S3 Bucket Key for server-side encryption with AWS KMS (SSE-KMS).

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-bucket-key-enabled" + } + }, + "RequestCharged": { + "target": "com.amazonaws.s3#RequestCharged", + "traits": { + "smithy.api#httpHeader": "x-amz-request-charged" + } + } + } + }, + "com.amazonaws.s3#PutObjectRequest": { + "type": "structure", + "members": { + "ACL": { + "target": "com.amazonaws.s3#ObjectCannedACL", + "traits": { + "smithy.api#documentation": "

The canned ACL to apply to the object. For more information, see Canned\n ACL.

\n

This action is not supported by Amazon S3 on Outposts.

", + "smithy.api#httpHeader": "x-amz-acl" + } + }, + "Body": { + "target": "com.amazonaws.s3#StreamingBlob", + "traits": { + "smithy.api#documentation": "

Object data.

", + "smithy.api#httpPayload": {} + } + }, + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The bucket name to which the PUT operation was initiated.

\n

When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.

\n

When using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "CacheControl": { + "target": "com.amazonaws.s3#CacheControl", + "traits": { + "smithy.api#documentation": "

Can be used to specify caching behavior along the request/reply chain. For more\n information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.

", + "smithy.api#httpHeader": "Cache-Control" + } + }, + "ContentDisposition": { + "target": "com.amazonaws.s3#ContentDisposition", + "traits": { + "smithy.api#documentation": "

Specifies presentational information for the object. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec19.html#sec19.5.1.

", + "smithy.api#httpHeader": "Content-Disposition" + } + }, + "ContentEncoding": { + "target": "com.amazonaws.s3#ContentEncoding", + "traits": { + "smithy.api#documentation": "

Specifies what content encodings have been applied to the object and thus what decoding\n mechanisms must be applied to obtain the media-type referenced by the Content-Type header\n field. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.11.

", + "smithy.api#httpHeader": "Content-Encoding" + } + }, + "ContentLanguage": { + "target": "com.amazonaws.s3#ContentLanguage", + "traits": { + "smithy.api#documentation": "

The language the content is in.

", + "smithy.api#httpHeader": "Content-Language" + } + }, + "ContentLength": { + "target": "com.amazonaws.s3#ContentLength", + "traits": { + "smithy.api#documentation": "

Size of the body in bytes. This parameter is useful when the size of the body cannot be\n determined automatically. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.13.

", + "smithy.api#httpHeader": "Content-Length" + } + }, + "ContentMD5": { + "target": "com.amazonaws.s3#ContentMD5", + "traits": { + "smithy.api#documentation": "

The base64-encoded 128-bit MD5 digest of the message (without the headers) according to\n RFC 1864. This header can be used as a message integrity check to verify that the data is\n the same data that was originally sent. Although it is optional, we recommend using the\n Content-MD5 mechanism as an end-to-end integrity check. For more information about REST\n request authentication, see REST\n Authentication.

", + "smithy.api#httpHeader": "Content-MD5" + } + }, + "ContentType": { + "target": "com.amazonaws.s3#ContentType", + "traits": { + "smithy.api#documentation": "

A standard MIME type describing the format of the contents. For more information, see\n http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17.

", + "smithy.api#httpHeader": "Content-Type" + } + }, + "Expires": { + "target": "com.amazonaws.s3#Expires", + "traits": { + "smithy.api#documentation": "

The date and time at which the object is no longer cacheable. For more information, see\n http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.21.

", + "smithy.api#httpHeader": "Expires" + } + }, + "GrantFullControl": { + "target": "com.amazonaws.s3#GrantFullControl", + "traits": { + "smithy.api#documentation": "

Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the\n object.

\n

This action is not supported by Amazon S3 on Outposts.

", + "smithy.api#httpHeader": "x-amz-grant-full-control" + } + }, + "GrantRead": { + "target": "com.amazonaws.s3#GrantRead", + "traits": { + "smithy.api#documentation": "

Allows grantee to read the object data and its\n metadata.

\n

This action is not supported by Amazon S3 on Outposts.

", + "smithy.api#httpHeader": "x-amz-grant-read" + } + }, + "GrantReadACP": { + "target": "com.amazonaws.s3#GrantReadACP", + "traits": { + "smithy.api#documentation": "

Allows grantee to read the object ACL.

\n

This action is not supported by Amazon S3 on Outposts.

", + "smithy.api#httpHeader": "x-amz-grant-read-acp" + } + }, + "GrantWriteACP": { + "target": "com.amazonaws.s3#GrantWriteACP", + "traits": { + "smithy.api#documentation": "

Allows grantee to write the ACL for the applicable\n object.

\n

This action is not supported by Amazon S3 on Outposts.

", + "smithy.api#httpHeader": "x-amz-grant-write-acp" + } + }, + "Key": { + "target": "com.amazonaws.s3#ObjectKey", + "traits": { + "smithy.api#documentation": "

Object key for which the PUT operation was initiated.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Metadata": { + "target": "com.amazonaws.s3#Metadata", + "traits": { + "smithy.api#documentation": "

A map of metadata to store with the object in S3.

", + "smithy.api#httpPrefixHeaders": "x-amz-meta-" + } + }, + "ServerSideEncryption": { + "target": "com.amazonaws.s3#ServerSideEncryption", + "traits": { + "smithy.api#documentation": "

The server-side encryption algorithm used when storing this object in Amazon S3 (for example,\n AES256, aws:kms).

", + "smithy.api#httpHeader": "x-amz-server-side-encryption" + } + }, + "StorageClass": { + "target": "com.amazonaws.s3#StorageClass", + "traits": { + "smithy.api#documentation": "

By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The\n STANDARD storage class provides high durability and high availability. Depending on\n performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses\n the OUTPOSTS Storage Class. For more information, see Storage Classes in the Amazon S3\n Service Developer Guide.

", + "smithy.api#httpHeader": "x-amz-storage-class" + } + }, + "WebsiteRedirectLocation": { + "target": "com.amazonaws.s3#WebsiteRedirectLocation", + "traits": { + "smithy.api#documentation": "

If the bucket is configured as a website, redirects requests for this object to another\n object in the same bucket or to an external URL. Amazon S3 stores the value of this header in\n the object metadata. For information about object metadata, see Object Key and Metadata.

\n\n

In the following example, the request header sets the redirect to an object\n (anotherPage.html) in the same bucket:

\n\n

\n x-amz-website-redirect-location: /anotherPage.html\n

\n\n

In the following example, the request header sets the object redirect to another\n website:

\n\n

\n x-amz-website-redirect-location: http://www.example.com/\n

\n\n

For more information about website hosting in Amazon S3, see Hosting Websites on Amazon S3 and How to Configure Website Page\n Redirects.

", + "smithy.api#httpHeader": "x-amz-website-redirect-location" + } + }, + "SSECustomerAlgorithm": { + "target": "com.amazonaws.s3#SSECustomerAlgorithm", + "traits": { + "smithy.api#documentation": "

Specifies the algorithm to use to when encrypting the object (for example,\n AES256).

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-algorithm" + } + }, + "SSECustomerKey": { + "target": "com.amazonaws.s3#SSECustomerKey", + "traits": { + "smithy.api#documentation": "

Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This\n value is used to store the object and then it is discarded; Amazon S3 does not store the\n encryption key. The key must be appropriate for use with the algorithm specified in the\n x-amz-server-side-encryption-customer-algorithm header.

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key" + } + }, + "SSECustomerKeyMD5": { + "target": "com.amazonaws.s3#SSECustomerKeyMD5", + "traits": { + "smithy.api#documentation": "

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses\n this header for a message integrity check to ensure that the encryption key was transmitted\n without error.

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key-MD5" + } + }, + "SSEKMSKeyId": { + "target": "com.amazonaws.s3#SSEKMSKeyId", + "traits": { + "smithy.api#documentation": "

If x-amz-server-side-encryption is present and has the value of\n aws:kms, this header specifies the ID of the AWS Key Management Service\n (AWS KMS) symmetrical customer managed customer master key (CMK) that was used for the\n object.

\n

If the value of x-amz-server-side-encryption is aws:kms, this\n header specifies the ID of the symmetric customer managed AWS KMS CMK that will be used for\n the object. If you specify x-amz-server-side-encryption:aws:kms, but do not\n provide x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS\n managed CMK in AWS to protect the data.

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" + } + }, + "SSEKMSEncryptionContext": { + "target": "com.amazonaws.s3#SSEKMSEncryptionContext", + "traits": { + "smithy.api#documentation": "

Specifies the AWS KMS Encryption Context to use for object encryption. The value of this\n header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value\n pairs.

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-context" + } + }, + "BucketKeyEnabled": { + "target": "com.amazonaws.s3#BucketKeyEnabled", + "traits": { + "smithy.api#documentation": "

Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using AWS KMS (SSE-KMS). Setting this header to true causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS.

\n

Specifying this header with a PUT operation doesn’t affect bucket-level settings for S3 Bucket Key.

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-bucket-key-enabled" + } + }, + "RequestPayer": { + "target": "com.amazonaws.s3#RequestPayer", + "traits": { + "smithy.api#httpHeader": "x-amz-request-payer" + } + }, + "Tagging": { + "target": "com.amazonaws.s3#TaggingHeader", + "traits": { + "smithy.api#documentation": "

The tag-set for the object. The tag-set must be encoded as URL Query parameters. (For\n example, \"Key1=Value1\")

", + "smithy.api#httpHeader": "x-amz-tagging" + } + }, + "ObjectLockMode": { + "target": "com.amazonaws.s3#ObjectLockMode", + "traits": { + "smithy.api#documentation": "

The Object Lock mode that you want to apply to this object.

", + "smithy.api#httpHeader": "x-amz-object-lock-mode" + } + }, + "ObjectLockRetainUntilDate": { + "target": "com.amazonaws.s3#ObjectLockRetainUntilDate", + "traits": { + "smithy.api#documentation": "

The date and time when you want this object's Object Lock to expire.

", + "smithy.api#httpHeader": "x-amz-object-lock-retain-until-date" + } + }, + "ObjectLockLegalHoldStatus": { + "target": "com.amazonaws.s3#ObjectLockLegalHoldStatus", + "traits": { + "smithy.api#documentation": "

Specifies whether a legal hold will be applied to this object. For more information\n about S3 Object Lock, see Object\n Lock.

", + "smithy.api#httpHeader": "x-amz-object-lock-legal-hold" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + } + }, + "com.amazonaws.s3#PutObjectRetention": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#PutObjectRetentionRequest" + }, + "output": { + "target": "com.amazonaws.s3#PutObjectRetentionOutput" + }, + "traits": { + "smithy.api#documentation": "

Places an Object Retention configuration on an object.

\n

This action is not supported by Amazon S3 on Outposts.

\n

\n Related Resources\n

\n ", + "smithy.api#http": { + "method": "PUT", + "uri": "/{Bucket}/{Key+}?retention", + "code": 200 + }, + "smithy.api#httpChecksumRequired": {} + } + }, + "com.amazonaws.s3#PutObjectRetentionOutput": { + "type": "structure", + "members": { + "RequestCharged": { + "target": "com.amazonaws.s3#RequestCharged", + "traits": { + "smithy.api#httpHeader": "x-amz-request-charged" + } + } + } + }, + "com.amazonaws.s3#PutObjectRetentionRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The bucket name that contains the object you want to apply this Object Retention\n configuration to.

\n

When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Key": { + "target": "com.amazonaws.s3#ObjectKey", + "traits": { + "smithy.api#documentation": "

The key name for the object that you want to apply this Object Retention configuration\n to.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Retention": { + "target": "com.amazonaws.s3#ObjectLockRetention", + "traits": { + "smithy.api#documentation": "

The container element for the Object Retention configuration.

", + "smithy.api#httpPayload": {} + } + }, + "RequestPayer": { + "target": "com.amazonaws.s3#RequestPayer", + "traits": { + "smithy.api#httpHeader": "x-amz-request-payer" + } + }, + "VersionId": { + "target": "com.amazonaws.s3#ObjectVersionId", + "traits": { + "smithy.api#documentation": "

The version ID for the object that you want to apply this Object Retention configuration\n to.

", + "smithy.api#httpQuery": "versionId" + } + }, + "BypassGovernanceRetention": { + "target": "com.amazonaws.s3#BypassGovernanceRetention", + "traits": { + "smithy.api#documentation": "

Indicates whether this operation should bypass Governance-mode restrictions.

", + "smithy.api#httpHeader": "x-amz-bypass-governance-retention" + } + }, + "ContentMD5": { + "target": "com.amazonaws.s3#ContentMD5", + "traits": { + "smithy.api#documentation": "

The MD5 hash for the request body.

\n

For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically.

", + "smithy.api#httpHeader": "Content-MD5" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + } + }, + "com.amazonaws.s3#PutObjectTagging": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#PutObjectTaggingRequest" + }, + "output": { + "target": "com.amazonaws.s3#PutObjectTaggingOutput" + }, + "traits": { + "smithy.api#documentation": "

Sets the supplied tag-set to an object that already exists in a bucket.

\n

A tag is a key-value pair. You can associate tags with an object by sending a PUT\n request against the tagging subresource that is associated with the object. You can\n retrieve tags by sending a GET request. For more information, see GetObjectTagging.

\n\n

For tagging-related restrictions related to characters and encodings, see Tag\n Restrictions. Note that Amazon S3 limits the maximum number of tags to 10 tags per\n object.

\n\n

To use this operation, you must have permission to perform the\n s3:PutObjectTagging action. By default, the bucket owner has this\n permission and can grant this permission to others.

\n\n

To put tags of any other version, use the versionId query parameter. You\n also need permission for the s3:PutObjectVersionTagging action.

\n\n

For information about the Amazon S3 object tagging feature, see Object Tagging.

\n\n\n

\n Special Errors\n

\n \n\n \n\n\n\n\n

\n Related Resources\n

\n ", + "smithy.api#http": { + "method": "PUT", + "uri": "/{Bucket}/{Key+}?tagging", + "code": 200 + }, + "smithy.api#httpChecksumRequired": {} + } + }, + "com.amazonaws.s3#PutObjectTaggingOutput": { + "type": "structure", + "members": { + "VersionId": { + "target": "com.amazonaws.s3#ObjectVersionId", + "traits": { + "smithy.api#documentation": "

The versionId of the object the tag-set was added to.

", + "smithy.api#httpHeader": "x-amz-version-id" + } + } + } + }, + "com.amazonaws.s3#PutObjectTaggingRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The bucket name containing the object.

\n

When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.

\n

When using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Key": { + "target": "com.amazonaws.s3#ObjectKey", + "traits": { + "smithy.api#documentation": "

Name of the object key.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "VersionId": { + "target": "com.amazonaws.s3#ObjectVersionId", + "traits": { + "smithy.api#documentation": "

The versionId of the object that the tag-set will be added to.

", + "smithy.api#httpQuery": "versionId" + } + }, + "ContentMD5": { + "target": "com.amazonaws.s3#ContentMD5", + "traits": { + "smithy.api#documentation": "

The MD5 hash for the request body.

\n

For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically.

", + "smithy.api#httpHeader": "Content-MD5" + } + }, + "Tagging": { + "target": "com.amazonaws.s3#Tagging", + "traits": { + "smithy.api#documentation": "

Container for the TagSet and Tag elements

", + "smithy.api#httpPayload": {}, + "smithy.api#required": {} + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + } + }, + "com.amazonaws.s3#PutPublicAccessBlock": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#PutPublicAccessBlockRequest" + }, + "traits": { + "smithy.api#documentation": "

Creates or modifies the PublicAccessBlock configuration for an Amazon S3 bucket.\n To use this operation, you must have the s3:PutBucketPublicAccessBlock\n permission. For more information about Amazon S3 permissions, see Specifying Permissions in a\n Policy.

\n\n \n

When Amazon S3 evaluates the PublicAccessBlock configuration for a bucket or\n an object, it checks the PublicAccessBlock configuration for both the\n bucket (or the bucket that contains the object) and the bucket owner's account. If the\n PublicAccessBlock configurations are different between the bucket and\n the account, Amazon S3 uses the most restrictive combination of the bucket-level and\n account-level settings.

\n \n\n\n

For more information about when Amazon S3 considers a bucket or an object public, see The Meaning of \"Public\".

\n\n\n\n

\n Related Resources\n

\n ", + "smithy.api#http": { + "method": "PUT", + "uri": "/{Bucket}?publicAccessBlock", + "code": 200 + }, + "smithy.api#httpChecksumRequired": {} + } + }, + "com.amazonaws.s3#PutPublicAccessBlockRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the Amazon S3 bucket whose PublicAccessBlock configuration you want\n to set.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ContentMD5": { + "target": "com.amazonaws.s3#ContentMD5", + "traits": { + "smithy.api#documentation": "

The MD5 hash of the PutPublicAccessBlock request body.

\n

For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically.

", + "smithy.api#httpHeader": "Content-MD5" + } + }, + "PublicAccessBlockConfiguration": { + "target": "com.amazonaws.s3#PublicAccessBlockConfiguration", + "traits": { + "smithy.api#documentation": "

The PublicAccessBlock configuration that you want to apply to this Amazon S3\n bucket. You can enable the configuration options in any combination. For more information\n about when Amazon S3 considers a bucket or object public, see The Meaning of \"Public\" in the Amazon Simple Storage Service Developer\n Guide.

", + "smithy.api#httpPayload": {}, + "smithy.api#required": {} + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + } + }, + "com.amazonaws.s3#QueueArn": { + "type": "string" + }, + "com.amazonaws.s3#QueueConfiguration": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.s3#NotificationId" + }, + "QueueArn": { + "target": "com.amazonaws.s3#QueueArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon SQS queue to which Amazon S3 publishes a message\n when it detects events of the specified type.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "Queue" + } + }, + "Events": { + "target": "com.amazonaws.s3#EventList", + "traits": { + "smithy.api#documentation": "

A collection of bucket events for which to send notifications

", + "smithy.api#required": {}, + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "Event" + } + }, + "Filter": { + "target": "com.amazonaws.s3#NotificationConfigurationFilter" + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the configuration for publishing messages to an Amazon Simple Queue Service\n (Amazon SQS) queue when Amazon S3 detects specified events.

" + } + }, + "com.amazonaws.s3#QueueConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.s3#QueueConfiguration" + } + }, + "com.amazonaws.s3#Quiet": { + "type": "boolean" + }, + "com.amazonaws.s3#QuoteCharacter": { + "type": "string" + }, + "com.amazonaws.s3#QuoteEscapeCharacter": { + "type": "string" + }, + "com.amazonaws.s3#QuoteFields": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ALWAYS", + "name": "ALWAYS" + }, + { + "value": "ASNEEDED", + "name": "ASNEEDED" + } + ] + } + }, + "com.amazonaws.s3#Range": { + "type": "string" + }, + "com.amazonaws.s3#RecordDelimiter": { + "type": "string" + }, + "com.amazonaws.s3#RecordsEvent": { + "type": "structure", + "members": { + "Payload": { + "target": "com.amazonaws.s3#Body", + "traits": { + "smithy.api#documentation": "

The byte array of partial, one or more result records.

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

The container for the records event.

" + } + }, + "com.amazonaws.s3#Redirect": { + "type": "structure", + "members": { + "HostName": { + "target": "com.amazonaws.s3#HostName", + "traits": { + "smithy.api#documentation": "

The host name to use in the redirect request.

" + } + }, + "HttpRedirectCode": { + "target": "com.amazonaws.s3#HttpRedirectCode", + "traits": { + "smithy.api#documentation": "

The HTTP redirect code to use on the response. Not required if one of the siblings is\n present.

" + } + }, + "Protocol": { + "target": "com.amazonaws.s3#Protocol", + "traits": { + "smithy.api#documentation": "

Protocol to use when redirecting requests. The default is the protocol that is used in\n the original request.

" + } + }, + "ReplaceKeyPrefixWith": { + "target": "com.amazonaws.s3#ReplaceKeyPrefixWith", + "traits": { + "smithy.api#documentation": "

The object key prefix to use in the redirect request. For example, to redirect requests\n for all pages with prefix docs/ (objects in the docs/ folder) to\n documents/, you can set a condition block with KeyPrefixEquals\n set to docs/ and in the Redirect set ReplaceKeyPrefixWith to\n /documents. Not required if one of the siblings is present. Can be present\n only if ReplaceKeyWith is not provided.

" + } + }, + "ReplaceKeyWith": { + "target": "com.amazonaws.s3#ReplaceKeyWith", + "traits": { + "smithy.api#documentation": "

The specific object key to use in the redirect request. For example, redirect request to\n error.html. Not required if one of the siblings is present. Can be present\n only if ReplaceKeyPrefixWith is not provided.

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

Specifies how requests are redirected. In the event of an error, you can specify a\n different error code to return.

" + } + }, + "com.amazonaws.s3#RedirectAllRequestsTo": { + "type": "structure", + "members": { + "HostName": { + "target": "com.amazonaws.s3#HostName", + "traits": { + "smithy.api#documentation": "

Name of the host where requests are redirected.

", + "smithy.api#required": {} + } + }, + "Protocol": { + "target": "com.amazonaws.s3#Protocol", + "traits": { + "smithy.api#documentation": "

Protocol to use when redirecting requests. The default is the protocol that is used in\n the original request.

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

Specifies the redirect behavior of all requests to a website endpoint of an Amazon S3\n bucket.

" + } + }, + "com.amazonaws.s3#ReplaceKeyPrefixWith": { + "type": "string" + }, + "com.amazonaws.s3#ReplaceKeyWith": { + "type": "string" + }, + "com.amazonaws.s3#ReplicaKmsKeyID": { + "type": "string" + }, + "com.amazonaws.s3#ReplicaModifications": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.s3#ReplicaModificationsStatus", + "traits": { + "smithy.api#documentation": "

Specifies whether Amazon S3 replicates modifications on replicas.

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

A filter that you can specify for selection for modifications on replicas. Amazon S3 doesn't\n replicate replica modifications by default. In the latest version of replication\n configuration (when Filter is specified), you can specify this element and set\n the status to Enabled to replicate modifications on replicas.

\n \n

If you don't specify the Filter element, Amazon S3 assumes that the\n replication configuration is the earlier version, V1. In the earlier version, this\n element is not allowed.

\n " + } + }, + "com.amazonaws.s3#ReplicaModificationsStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Enabled", + "name": "Enabled" + }, + { + "value": "Disabled", + "name": "Disabled" + } + ] + } + }, + "com.amazonaws.s3#ReplicationConfiguration": { + "type": "structure", + "members": { + "Role": { + "target": "com.amazonaws.s3#Role", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that\n Amazon S3 assumes when replicating objects. For more information, see How to Set Up\n Replication in the Amazon Simple Storage Service Developer Guide.

", + "smithy.api#required": {} + } + }, + "Rules": { + "target": "com.amazonaws.s3#ReplicationRules", + "traits": { + "smithy.api#documentation": "

A container for one or more replication rules. A replication configuration must have at\n least one rule and can contain a maximum of 1,000 rules.

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

A container for replication rules. You can add up to 1,000 rules. The maximum size of a\n replication configuration is 2 MB.

" + } + }, + "com.amazonaws.s3#ReplicationRule": { + "type": "structure", + "members": { + "ID": { + "target": "com.amazonaws.s3#ID", + "traits": { + "smithy.api#documentation": "

A unique identifier for the rule. The maximum value is 255 characters.

" + } + }, + "Priority": { + "target": "com.amazonaws.s3#Priority", + "traits": { + "smithy.api#documentation": "

The priority indicates which rule has precedence whenever two or more replication rules\n conflict. Amazon S3 will attempt to replicate objects according to all replication rules.\n However, if there are two or more rules with the same destination bucket, then objects will\n be replicated according to the rule with the highest priority. The higher the number, the\n higher the priority.

\n

For more information, see Replication in the\n Amazon Simple Storage Service Developer Guide.

" + } + }, + "Prefix": { + "target": "com.amazonaws.s3#Prefix", + "traits": { + "smithy.api#deprecated": {}, + "smithy.api#documentation": "

An object key name prefix that identifies the object or objects to which the rule\n applies. The maximum prefix length is 1,024 characters. To include all objects in a bucket,\n specify an empty string.

" + } + }, + "Filter": { + "target": "com.amazonaws.s3#ReplicationRuleFilter" + }, + "Status": { + "target": "com.amazonaws.s3#ReplicationRuleStatus", + "traits": { + "smithy.api#documentation": "

Specifies whether the rule is enabled.

", + "smithy.api#required": {} + } + }, + "SourceSelectionCriteria": { + "target": "com.amazonaws.s3#SourceSelectionCriteria", + "traits": { + "smithy.api#documentation": "

A container that describes additional filters for identifying the source objects that\n you want to replicate. You can choose to enable or disable the replication of these\n objects. Currently, Amazon S3 supports only the filter that you can specify for objects created\n with server-side encryption using a customer master key (CMK) stored in AWS Key Management\n Service (SSE-KMS).

" + } + }, + "ExistingObjectReplication": { + "target": "com.amazonaws.s3#ExistingObjectReplication", + "traits": { + "smithy.api#documentation": "

" + } + }, + "Destination": { + "target": "com.amazonaws.s3#Destination", + "traits": { + "smithy.api#documentation": "

A container for information about the replication destination and its configurations\n including enabling the S3 Replication Time Control (S3 RTC).

", + "smithy.api#required": {} + } + }, + "DeleteMarkerReplication": { + "target": "com.amazonaws.s3#DeleteMarkerReplication" + } + }, + "traits": { + "smithy.api#documentation": "

Specifies which Amazon S3 objects to replicate and where to store the replicas.

" + } + }, + "com.amazonaws.s3#ReplicationRuleAndOperator": { + "type": "structure", + "members": { + "Prefix": { + "target": "com.amazonaws.s3#Prefix", + "traits": { + "smithy.api#documentation": "

An object key name prefix that identifies the subset of objects to which the rule\n applies.

" + } + }, + "Tags": { + "target": "com.amazonaws.s3#TagSet", + "traits": { + "smithy.api#documentation": "

An array of tags containing key and value pairs.

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

A container for specifying rule filters. The filters determine the subset of objects to\n which the rule applies. This element is required only if you specify more than one filter.

\n

For example:

\n " + } + }, + "com.amazonaws.s3#ReplicationRuleFilter": { + "type": "union", + "members": { + "Prefix": { + "target": "com.amazonaws.s3#Prefix", + "traits": { + "smithy.api#documentation": "

An object key name prefix that identifies the subset of objects to which the rule\n applies.

" + } + }, + "Tag": { + "target": "com.amazonaws.s3#Tag", + "traits": { + "smithy.api#documentation": "

A container for specifying a tag key and value.

\n

The rule applies only to objects that have the tag in their tag set.

" + } + }, + "And": { + "target": "com.amazonaws.s3#ReplicationRuleAndOperator", + "traits": { + "smithy.api#documentation": "

A container for specifying rule filters. The filters determine the subset of objects to\n which the rule applies. This element is required only if you specify more than one filter.\n For example:

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

A filter that identifies the subset of objects to which the replication rule applies. A\n Filter must specify exactly one Prefix, Tag, or\n an And child element.

" + } + }, + "com.amazonaws.s3#ReplicationRuleStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Enabled", + "name": "Enabled" + }, + { + "value": "Disabled", + "name": "Disabled" + } + ] + } + }, + "com.amazonaws.s3#ReplicationRules": { + "type": "list", + "member": { + "target": "com.amazonaws.s3#ReplicationRule" + } + }, + "com.amazonaws.s3#ReplicationStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "COMPLETE", + "name": "COMPLETE" + }, + { + "value": "PENDING", + "name": "PENDING" + }, + { + "value": "FAILED", + "name": "FAILED" + }, + { + "value": "REPLICA", + "name": "REPLICA" + } + ] + } + }, + "com.amazonaws.s3#ReplicationTime": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.s3#ReplicationTimeStatus", + "traits": { + "smithy.api#documentation": "

Specifies whether the replication time is enabled.

", + "smithy.api#required": {} + } + }, + "Time": { + "target": "com.amazonaws.s3#ReplicationTimeValue", + "traits": { + "smithy.api#documentation": "

A container specifying the time by which replication should be complete for all objects\n and operations on objects.

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

A container specifying S3 Replication Time Control (S3 RTC) related information, including whether S3 RTC is\n enabled and the time when all objects and operations on objects must be replicated. Must be\n specified together with a Metrics block.

" + } + }, + "com.amazonaws.s3#ReplicationTimeStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Enabled", + "name": "Enabled" + }, + { + "value": "Disabled", + "name": "Disabled" + } + ] + } + }, + "com.amazonaws.s3#ReplicationTimeValue": { + "type": "structure", + "members": { + "Minutes": { + "target": "com.amazonaws.s3#Minutes", + "traits": { + "smithy.api#documentation": "

Contains an integer specifying time in minutes.

\n

Valid values: 15 minutes.

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

A container specifying the time value for S3 Replication Time Control (S3 RTC) and replication metrics\n EventThreshold.

" + } + }, + "com.amazonaws.s3#RequestCharged": { + "type": "string", + "traits": { + "smithy.api#documentation": "

If present, indicates that the requester was successfully charged for the\n request.

", + "smithy.api#enum": [ + { + "value": "requester", + "name": "requester" + } + ] + } + }, + "com.amazonaws.s3#RequestPayer": { + "type": "string", + "traits": { + "smithy.api#documentation": "

Confirms that the requester knows that they will be charged for the request. Bucket\n owners need not specify this parameter in their requests. For information about downloading\n objects from requester pays buckets, see Downloading Objects in\n Requestor Pays Buckets in the Amazon S3 Developer Guide.

", + "smithy.api#enum": [ + { + "value": "requester", + "name": "requester" + } + ] + } + }, + "com.amazonaws.s3#RequestPaymentConfiguration": { + "type": "structure", + "members": { + "Payer": { + "target": "com.amazonaws.s3#Payer", + "traits": { + "smithy.api#documentation": "

Specifies who pays for the download and request fees.

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

Container for Payer.

" + } + }, + "com.amazonaws.s3#RequestProgress": { + "type": "structure", + "members": { + "Enabled": { + "target": "com.amazonaws.s3#EnableRequestProgress", + "traits": { + "smithy.api#documentation": "

Specifies whether periodic QueryProgress frames should be sent. Valid values: TRUE,\n FALSE. Default value: FALSE.

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

Container for specifying if periodic QueryProgress messages should be\n sent.

" + } + }, + "com.amazonaws.s3#ResponseCacheControl": { + "type": "string" + }, + "com.amazonaws.s3#ResponseContentDisposition": { + "type": "string" + }, + "com.amazonaws.s3#ResponseContentEncoding": { + "type": "string" + }, + "com.amazonaws.s3#ResponseContentLanguage": { + "type": "string" + }, + "com.amazonaws.s3#ResponseContentType": { + "type": "string" + }, + "com.amazonaws.s3#ResponseExpires": { + "type": "timestamp", + "traits": { + "smithy.api#timestampFormat": "http-date" + } + }, + "com.amazonaws.s3#Restore": { + "type": "string" + }, + "com.amazonaws.s3#RestoreObject": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#RestoreObjectRequest" + }, + "output": { + "target": "com.amazonaws.s3#RestoreObjectOutput" + }, + "errors": [ + { + "target": "com.amazonaws.s3#ObjectAlreadyInActiveTierError" + } + ], + "traits": { + "smithy.api#documentation": "

Restores an archived copy of an object back into Amazon S3

\n

This action is not supported by Amazon S3 on Outposts.

\n

This action performs the following types of requests:

\n \n

To use this operation, you must have permissions to perform the\n s3:RestoreObject action. The bucket owner has this permission by default\n and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources in the Amazon Simple Storage Service Developer Guide.

\n

\n Querying Archives with Select Requests\n

\n

You use a select type of request to perform SQL queries on archived objects. The\n archived objects that are being queried by the select request must be formatted as\n uncompressed comma-separated values (CSV) files. You can run queries and custom analytics\n on your archived data without having to restore your data to a hotter Amazon S3 tier. For an\n overview about select requests, see Querying Archived Objects in the Amazon Simple Storage Service Developer Guide.

\n

When making a select request, do the following:

\n \n

For more information about using SQL with S3 Glacier Select restore, see SQL Reference for Amazon S3 Select and\n S3 Glacier Select in the Amazon Simple Storage Service Developer Guide.

\n

When making a select request, you can also do the following:

\n \n

The following are additional important facts about the select feature:

\n \n

\n Restoring objects\n

\n

Objects that you archive to the S3 Glacier or\n S3 Glacier Deep Archive storage class, and S3 Intelligent-Tiering Archive or\n S3 Intelligent-Tiering Deep Archive tiers are not accessible in real time. For objects in\n Archive Access or Deep Archive Access tiers you must first initiate a restore request, and\n then wait until the object is moved into the Frequent Access tier. For objects in\n S3 Glacier or S3 Glacier Deep Archive storage classes you must\n first initiate a restore request, and then wait until a temporary copy of the object is\n available. To access an archived object, you must restore the object for the duration\n (number of days) that you specify.

\n

To restore a specific object version, you can provide a version ID. If you don't provide\n a version ID, Amazon S3 restores the current version.

\n

When restoring an archived object (or using a select request), you can specify one of\n the following data access tier options in the Tier element of the request\n body:

\n \n

For more information about archive retrieval options and provisioned capacity for\n Expedited data access, see Restoring Archived Objects in the Amazon Simple Storage Service Developer Guide.

\n

You can use Amazon S3 restore speed upgrade to change the restore speed to a faster speed\n while it is in progress. For more information, see \n Upgrading the speed of an in-progress restore in the\n Amazon Simple Storage Service Developer Guide.

\n

To get the status of object restoration, you can send a HEAD request.\n Operations return the x-amz-restore header, which provides information about\n the restoration status, in the response. You can use Amazon S3 event notifications to notify you\n when a restore is initiated or completed. For more information, see Configuring Amazon S3 Event Notifications in\n the Amazon Simple Storage Service Developer Guide.

\n

After restoring an archived object, you can update the restoration period by reissuing\n the request with a new period. Amazon S3 updates the restoration period relative to the current\n time and charges only for the request-there are no data transfer charges. You cannot\n update the restoration period when Amazon S3 is actively processing your current restore request\n for the object.

\n

If your bucket has a lifecycle configuration with a rule that includes an expiration\n action, the object expiration overrides the life span that you specify in a restore\n request. For example, if you restore an object copy for 10 days, but the object is\n scheduled to expire in 3 days, Amazon S3 deletes the object in 3 days. For more information\n about lifecycle configuration, see PutBucketLifecycleConfiguration and Object Lifecycle Management in\n Amazon Simple Storage Service Developer Guide.

\n

\n Responses\n

\n

A successful operation returns either the 200 OK or 202\n Accepted status code.

\n \n

\n Special Errors\n

\n \n \n

\n Related Resources\n

\n ", + "smithy.api#http": { + "method": "POST", + "uri": "/{Bucket}/{Key+}?restore", + "code": 200 + } + } + }, + "com.amazonaws.s3#RestoreObjectOutput": { + "type": "structure", + "members": { + "RequestCharged": { + "target": "com.amazonaws.s3#RequestCharged", + "traits": { + "smithy.api#httpHeader": "x-amz-request-charged" + } + }, + "RestoreOutputPath": { + "target": "com.amazonaws.s3#RestoreOutputPath", + "traits": { + "smithy.api#documentation": "

Indicates the path in the provided S3 output location where Select results will be\n restored to.

", + "smithy.api#httpHeader": "x-amz-restore-output-path" + } + } + } + }, + "com.amazonaws.s3#RestoreObjectRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The bucket name containing the object to restore.

\n

When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.

\n

When using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Key": { + "target": "com.amazonaws.s3#ObjectKey", + "traits": { + "smithy.api#documentation": "

Object key for which the operation was initiated.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "VersionId": { + "target": "com.amazonaws.s3#ObjectVersionId", + "traits": { + "smithy.api#documentation": "

VersionId used to reference a specific version of the object.

", + "smithy.api#httpQuery": "versionId" + } + }, + "RestoreRequest": { + "target": "com.amazonaws.s3#RestoreRequest", + "traits": { + "smithy.api#httpPayload": {} + } + }, + "RequestPayer": { + "target": "com.amazonaws.s3#RequestPayer", + "traits": { + "smithy.api#httpHeader": "x-amz-request-payer" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + } + }, + "com.amazonaws.s3#RestoreOutputPath": { + "type": "string" + }, + "com.amazonaws.s3#RestoreRequest": { + "type": "structure", + "members": { + "Days": { + "target": "com.amazonaws.s3#Days", + "traits": { + "smithy.api#documentation": "

Lifetime of the active copy in days. Do not use with restores that specify\n OutputLocation.

\n

The Days element is required for regular restores, and must not be provided for select\n requests.

" + } + }, + "GlacierJobParameters": { + "target": "com.amazonaws.s3#GlacierJobParameters", + "traits": { + "smithy.api#documentation": "

S3 Glacier related parameters pertaining to this job. Do not use with restores that\n specify OutputLocation.

" + } + }, + "Type": { + "target": "com.amazonaws.s3#RestoreRequestType", + "traits": { + "smithy.api#documentation": "

Type of restore request.

" + } + }, + "Tier": { + "target": "com.amazonaws.s3#Tier", + "traits": { + "smithy.api#documentation": "

Retrieval tier at which the restore will be processed.

" + } + }, + "Description": { + "target": "com.amazonaws.s3#Description", + "traits": { + "smithy.api#documentation": "

The optional description for the job.

" + } + }, + "SelectParameters": { + "target": "com.amazonaws.s3#SelectParameters", + "traits": { + "smithy.api#documentation": "

Describes the parameters for Select job types.

" + } + }, + "OutputLocation": { + "target": "com.amazonaws.s3#OutputLocation", + "traits": { + "smithy.api#documentation": "

Describes the location where the restore job's output is stored.

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

Container for restore job parameters.

" + } + }, + "com.amazonaws.s3#RestoreRequestType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "SELECT", + "name": "SELECT" + } + ] + } + }, + "com.amazonaws.s3#Role": { + "type": "string" + }, + "com.amazonaws.s3#RoutingRule": { + "type": "structure", + "members": { + "Condition": { + "target": "com.amazonaws.s3#Condition", + "traits": { + "smithy.api#documentation": "

A container for describing a condition that must be met for the specified redirect to\n apply. For example, 1. If request is for pages in the /docs folder, redirect\n to the /documents folder. 2. If request results in HTTP error 4xx, redirect\n request to another host where you might process the error.

" + } + }, + "Redirect": { + "target": "com.amazonaws.s3#Redirect", + "traits": { + "smithy.api#documentation": "

Container for redirect information. You can redirect requests to another host, to\n another page, or with another protocol. In the event of an error, you can specify a\n different error code to return.

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

Specifies the redirect behavior and when a redirect is applied. For more information\n about routing rules, see Configuring advanced conditional redirects in the\n Amazon Simple Storage Service Developer Guide.

" + } + }, + "com.amazonaws.s3#RoutingRules": { + "type": "list", + "member": { + "target": "com.amazonaws.s3#RoutingRule", + "traits": { + "smithy.api#xmlName": "RoutingRule" + } + } + }, + "com.amazonaws.s3#S3KeyFilter": { + "type": "structure", + "members": { + "FilterRules": { + "target": "com.amazonaws.s3#FilterRuleList", + "traits": { + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "FilterRule" + } + } + }, + "traits": { + "smithy.api#documentation": "

A container for object key name prefix and suffix filtering rules.

" + } + }, + "com.amazonaws.s3#S3Location": { + "type": "structure", + "members": { + "BucketName": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket where the restore results will be placed.

", + "smithy.api#required": {} + } + }, + "Prefix": { + "target": "com.amazonaws.s3#LocationPrefix", + "traits": { + "smithy.api#documentation": "

The prefix that is prepended to the restore results for this request.

", + "smithy.api#required": {} + } + }, + "Encryption": { + "target": "com.amazonaws.s3#Encryption" + }, + "CannedACL": { + "target": "com.amazonaws.s3#ObjectCannedACL", + "traits": { + "smithy.api#documentation": "

The canned ACL to apply to the restore results.

" + } + }, + "AccessControlList": { + "target": "com.amazonaws.s3#Grants", + "traits": { + "smithy.api#documentation": "

A list of grants that control access to the staged results.

" + } + }, + "Tagging": { + "target": "com.amazonaws.s3#Tagging", + "traits": { + "smithy.api#documentation": "

The tag-set that is applied to the restore results.

" + } + }, + "UserMetadata": { + "target": "com.amazonaws.s3#UserMetadata", + "traits": { + "smithy.api#documentation": "

A list of metadata to store with the restore results in S3.

" + } + }, + "StorageClass": { + "target": "com.amazonaws.s3#StorageClass", + "traits": { + "smithy.api#documentation": "

The class of storage used to store the restore results.

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

Describes an Amazon S3 location that will receive the results of the restore request.

" + } + }, + "com.amazonaws.s3#SSECustomerAlgorithm": { + "type": "string" + }, + "com.amazonaws.s3#SSECustomerKey": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.s3#SSECustomerKeyMD5": { + "type": "string" + }, + "com.amazonaws.s3#SSEKMS": { + "type": "structure", + "members": { + "KeyId": { + "target": "com.amazonaws.s3#SSEKMSKeyId", + "traits": { + "smithy.api#documentation": "

Specifies the ID of the AWS Key Management Service (AWS KMS) symmetric customer managed\n customer master key (CMK) to use for encrypting inventory reports.

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

Specifies the use of SSE-KMS to encrypt delivered inventory reports.

", + "smithy.api#xmlName": "SSE-KMS" + } + }, + "com.amazonaws.s3#SSEKMSEncryptionContext": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.s3#SSEKMSKeyId": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.s3#SSES3": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

Specifies the use of SSE-S3 to encrypt delivered inventory reports.

", + "smithy.api#xmlName": "SSE-S3" + } + }, + "com.amazonaws.s3#ScanRange": { + "type": "structure", + "members": { + "Start": { + "target": "com.amazonaws.s3#Start", + "traits": { + "smithy.api#documentation": "

Specifies the start of the byte range. This parameter is optional. Valid values:\n non-negative integers. The default value is 0. If only start is supplied, it means scan\n from that point to the end of the file.For example;\n 50 means scan\n from byte 50 until the end of the file.

" + } + }, + "End": { + "target": "com.amazonaws.s3#End", + "traits": { + "smithy.api#documentation": "

Specifies the end of the byte range. This parameter is optional. Valid values:\n non-negative integers. The default value is one less than the size of the object being\n queried. If only the End parameter is supplied, it is interpreted to mean scan the last N\n bytes of the file. For example,\n 50 means scan the\n last 50 bytes.

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

Specifies the byte range of the object to get the records from. A record is processed\n when its first byte is contained by the range. This parameter is optional, but when\n specified, it must not be empty. See RFC 2616, Section 14.35.1 about how to specify the\n start and end of the range.

" + } + }, + "com.amazonaws.s3#SelectObjectContent": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#SelectObjectContentRequest" + }, + "output": { + "target": "com.amazonaws.s3#SelectObjectContentOutput" + }, + "traits": { + "smithy.api#documentation": "

This operation filters the contents of an Amazon S3 object based on a simple structured query\n language (SQL) statement. In the request, along with the SQL expression, you must also\n specify a data serialization format (JSON, CSV, or Apache Parquet) of the object. Amazon S3 uses\n this format to parse object data into records, and returns only records that match the\n specified SQL expression. You must also specify the data serialization format for the\n response.

\n

This action is not supported by Amazon S3 on Outposts.

\n

For more information about Amazon S3 Select,\n see Selecting Content from\n Objects in the Amazon Simple Storage Service Developer Guide.

\n

For more information about using SQL with Amazon S3 Select, see SQL Reference for Amazon S3 Select\n and S3 Glacier Select in the Amazon Simple Storage Service Developer Guide.

\n

\n

\n Permissions\n

\n

You must have s3:GetObject permission for this operation. Amazon S3 Select does\n not support anonymous access. For more information about permissions, see Specifying Permissions in a Policy\n in the Amazon Simple Storage Service Developer Guide.

\n

\n

\n Object Data Formats\n

\n

You can use Amazon S3 Select to query objects that have the following format\n properties:

\n \n\n

\n Working with the Response Body\n

\n

Given the response size is unknown, Amazon S3 Select streams the response as a series of\n messages and includes a Transfer-Encoding header with chunked as\n its value in the response. For more information, see Appendix: SelectObjectContent\n Response\n .

\n\n

\n

\n GetObject Support\n

\n

The SelectObjectContent operation does not support the following\n GetObject functionality. For more information, see GetObject.

\n \n

\n

\n Special Errors\n

\n\n

For a list of special errors for this operation, see List of\n SELECT Object Content Error Codes\n

\n

\n Related Resources\n

\n ", + "smithy.api#http": { + "method": "POST", + "uri": "/{Bucket}/{Key+}?select&select-type=2", + "code": 200 + } + } + }, + "com.amazonaws.s3#SelectObjectContentEventStream": { + "type": "union", + "members": { + "Records": { + "target": "com.amazonaws.s3#RecordsEvent", + "traits": { + "smithy.api#documentation": "

The Records Event.

" + } + }, + "Stats": { + "target": "com.amazonaws.s3#StatsEvent", + "traits": { + "smithy.api#documentation": "

The Stats Event.

" + } + }, + "Progress": { + "target": "com.amazonaws.s3#ProgressEvent", + "traits": { + "smithy.api#documentation": "

The Progress Event.

" + } + }, + "Cont": { + "target": "com.amazonaws.s3#ContinuationEvent", + "traits": { + "smithy.api#documentation": "

The Continuation Event.

" + } + }, + "End": { + "target": "com.amazonaws.s3#EndEvent", + "traits": { + "smithy.api#documentation": "

The End Event.

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

The container for selecting objects from a content event stream.

", + "smithy.api#streaming": {} + } + }, + "com.amazonaws.s3#SelectObjectContentOutput": { + "type": "structure", + "members": { + "Payload": { + "target": "com.amazonaws.s3#SelectObjectContentEventStream", + "traits": { + "smithy.api#documentation": "

The array of results.

", + "smithy.api#httpPayload": {} + } + } + } + }, + "com.amazonaws.s3#SelectObjectContentRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The S3 bucket.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Key": { + "target": "com.amazonaws.s3#ObjectKey", + "traits": { + "smithy.api#documentation": "

The object key.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "SSECustomerAlgorithm": { + "target": "com.amazonaws.s3#SSECustomerAlgorithm", + "traits": { + "smithy.api#documentation": "

The SSE Algorithm used to encrypt the object. For more information, see Server-Side Encryption (Using Customer-Provided Encryption Keys.

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-algorithm" + } + }, + "SSECustomerKey": { + "target": "com.amazonaws.s3#SSECustomerKey", + "traits": { + "smithy.api#documentation": "

The SSE Customer Key. For more information, see Server-Side Encryption\n (Using Customer-Provided Encryption Keys.

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key" + } + }, + "SSECustomerKeyMD5": { + "target": "com.amazonaws.s3#SSECustomerKeyMD5", + "traits": { + "smithy.api#documentation": "

The SSE Customer Key MD5. For more information, see Server-Side Encryption\n (Using Customer-Provided Encryption Keys.

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key-MD5" + } + }, + "Expression": { + "target": "com.amazonaws.s3#Expression", + "traits": { + "smithy.api#documentation": "

The expression that is used to query the object.

", + "smithy.api#required": {} + } + }, + "ExpressionType": { + "target": "com.amazonaws.s3#ExpressionType", + "traits": { + "smithy.api#documentation": "

The type of the provided expression (for example, SQL).

", + "smithy.api#required": {} + } + }, + "RequestProgress": { + "target": "com.amazonaws.s3#RequestProgress", + "traits": { + "smithy.api#documentation": "

Specifies if periodic request progress information should be enabled.

" + } + }, + "InputSerialization": { + "target": "com.amazonaws.s3#InputSerialization", + "traits": { + "smithy.api#documentation": "

Describes the format of the data in the object that is being queried.

", + "smithy.api#required": {} + } + }, + "OutputSerialization": { + "target": "com.amazonaws.s3#OutputSerialization", + "traits": { + "smithy.api#documentation": "

Describes the format of the data that you want Amazon S3 to return in response.

", + "smithy.api#required": {} + } + }, + "ScanRange": { + "target": "com.amazonaws.s3#ScanRange", + "traits": { + "smithy.api#documentation": "

Specifies the byte range of the object to get the records from. A record is processed\n when its first byte is contained by the range. This parameter is optional, but when\n specified, it must not be empty. See RFC 2616, Section 14.35.1 about how to specify the\n start and end of the range.

\n

\n ScanRangemay be used in the following ways:

\n " + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + }, + "traits": { + "smithy.api#documentation": "

Request to filter the contents of an Amazon S3 object based on a simple Structured Query\n Language (SQL) statement. In the request, along with the SQL expression, you must specify a\n data serialization format (JSON or CSV) of the object. Amazon S3 uses this to parse object data\n into records. It returns only records that match the specified SQL expression. You must\n also specify the data serialization format for the response. For more information, see\n S3Select API Documentation.

" + } + }, + "com.amazonaws.s3#SelectParameters": { + "type": "structure", + "members": { + "InputSerialization": { + "target": "com.amazonaws.s3#InputSerialization", + "traits": { + "smithy.api#documentation": "

Describes the serialization format of the object.

", + "smithy.api#required": {} + } + }, + "ExpressionType": { + "target": "com.amazonaws.s3#ExpressionType", + "traits": { + "smithy.api#documentation": "

The type of the provided expression (for example, SQL).

", + "smithy.api#required": {} + } + }, + "Expression": { + "target": "com.amazonaws.s3#Expression", + "traits": { + "smithy.api#documentation": "

The expression that is used to query the object.

", + "smithy.api#required": {} + } + }, + "OutputSerialization": { + "target": "com.amazonaws.s3#OutputSerialization", + "traits": { + "smithy.api#documentation": "

Describes how the results of the Select job are serialized.

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

Describes the parameters for Select job types.

" + } + }, + "com.amazonaws.s3#ServerSideEncryption": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "AES256", + "name": "AES256" + }, + { + "value": "aws:kms", + "name": "aws_kms" + } + ] + } + }, + "com.amazonaws.s3#ServerSideEncryptionByDefault": { + "type": "structure", + "members": { + "SSEAlgorithm": { + "target": "com.amazonaws.s3#ServerSideEncryption", + "traits": { + "smithy.api#documentation": "

Server-side encryption algorithm to use for the default encryption.

", + "smithy.api#required": {} + } + }, + "KMSMasterKeyID": { + "target": "com.amazonaws.s3#SSEKMSKeyId", + "traits": { + "smithy.api#documentation": "

AWS Key Management Service (KMS) customer master key ID to use for the default\n encryption. This parameter is allowed if and only if SSEAlgorithm is set to\n aws:kms.

\n

You can specify the key ID or the Amazon Resource Name (ARN) of the CMK. However, if you\n are using encryption with cross-account operations, you must use a fully qualified CMK ARN.\n For more information, see Using encryption for cross-account operations.

\n

\n For example:\n

\n \n \n

Amazon S3 only supports symmetric CMKs and not asymmetric CMKs. For more information, see\n Using Symmetric and\n Asymmetric Keys in the AWS Key Management Service Developer\n Guide.

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

Describes the default server-side encryption to apply to new objects in the bucket. If a\n PUT Object request doesn't specify any server-side encryption, this default encryption will\n be applied. For more information, see PUT Bucket encryption in\n the Amazon Simple Storage Service API Reference.

" + } + }, + "com.amazonaws.s3#ServerSideEncryptionConfiguration": { + "type": "structure", + "members": { + "Rules": { + "target": "com.amazonaws.s3#ServerSideEncryptionRules", + "traits": { + "smithy.api#documentation": "

Container for information about a particular server-side encryption configuration\n rule.

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

Specifies the default server-side-encryption configuration.

" + } + }, + "com.amazonaws.s3#ServerSideEncryptionRule": { + "type": "structure", + "members": { + "ApplyServerSideEncryptionByDefault": { + "target": "com.amazonaws.s3#ServerSideEncryptionByDefault", + "traits": { + "smithy.api#documentation": "

Specifies the default server-side encryption to apply to new objects in the bucket. If a\n PUT Object request doesn't specify any server-side encryption, this default encryption will\n be applied.

" + } + }, + "BucketKeyEnabled": { + "target": "com.amazonaws.s3#BucketKeyEnabled", + "traits": { + "smithy.api#documentation": "

Specifies whether Amazon S3 should use an S3 Bucket Key with server-side encryption using KMS (SSE-KMS) for new objects in the bucket. Existing objects are not affected. Setting the BucketKeyEnabled element to true causes Amazon S3 to use an S3 Bucket Key. By default, S3 Bucket Key is not enabled.

\n

For more information, see Amazon S3 Bucket Keys in the Amazon Simple Storage Service Developer Guide.

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

Specifies the default server-side encryption configuration.

" + } + }, + "com.amazonaws.s3#ServerSideEncryptionRules": { + "type": "list", + "member": { + "target": "com.amazonaws.s3#ServerSideEncryptionRule" + } + }, + "com.amazonaws.s3#Setting": { + "type": "boolean" + }, + "com.amazonaws.s3#Size": { + "type": "integer" + }, + "com.amazonaws.s3#SourceSelectionCriteria": { + "type": "structure", + "members": { + "SseKmsEncryptedObjects": { + "target": "com.amazonaws.s3#SseKmsEncryptedObjects", + "traits": { + "smithy.api#documentation": "

A container for filter information for the selection of Amazon S3 objects encrypted with AWS\n KMS. If you include SourceSelectionCriteria in the replication configuration,\n this element is required.

" + } + }, + "ReplicaModifications": { + "target": "com.amazonaws.s3#ReplicaModifications", + "traits": { + "smithy.api#documentation": "

A filter that you can specify for selections for modifications on replicas. Amazon S3 doesn't\n replicate replica modifications by default. In the latest version of replication\n configuration (when Filter is specified), you can specify this element and set\n the status to Enabled to replicate modifications on replicas.

\n \n

If you don't specify the Filter element, Amazon S3 assumes that the\n replication configuration is the earlier version, V1. In the earlier version, this\n element is not allowed

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

A container that describes additional filters for identifying the source objects that\n you want to replicate. You can choose to enable or disable the replication of these\n objects. Currently, Amazon S3 supports only the filter that you can specify for objects created\n with server-side encryption using a customer master key (CMK) stored in AWS Key Management\n Service (SSE-KMS).

" + } + }, + "com.amazonaws.s3#SseKmsEncryptedObjects": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.s3#SseKmsEncryptedObjectsStatus", + "traits": { + "smithy.api#documentation": "

Specifies whether Amazon S3 replicates objects created with server-side encryption using a\n customer master key (CMK) stored in AWS Key Management Service.

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

A container for filter information for the selection of S3 objects encrypted with AWS\n KMS.

" + } + }, + "com.amazonaws.s3#SseKmsEncryptedObjectsStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Enabled", + "name": "Enabled" + }, + { + "value": "Disabled", + "name": "Disabled" + } + ] + } + }, + "com.amazonaws.s3#Start": { + "type": "long" + }, + "com.amazonaws.s3#StartAfter": { + "type": "string" + }, + "com.amazonaws.s3#Stats": { + "type": "structure", + "members": { + "BytesScanned": { + "target": "com.amazonaws.s3#BytesScanned", + "traits": { + "smithy.api#documentation": "

The total number of object bytes scanned.

" + } + }, + "BytesProcessed": { + "target": "com.amazonaws.s3#BytesProcessed", + "traits": { + "smithy.api#documentation": "

The total number of uncompressed object bytes processed.

" + } + }, + "BytesReturned": { + "target": "com.amazonaws.s3#BytesReturned", + "traits": { + "smithy.api#documentation": "

The total number of bytes of records payload data returned.

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

Container for the stats details.

" + } + }, + "com.amazonaws.s3#StatsEvent": { + "type": "structure", + "members": { + "Details": { + "target": "com.amazonaws.s3#Stats", + "traits": { + "smithy.api#documentation": "

The Stats event details.

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

Container for the Stats Event.

" + } + }, + "com.amazonaws.s3#StorageClass": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "STANDARD", + "name": "STANDARD" + }, + { + "value": "REDUCED_REDUNDANCY", + "name": "REDUCED_REDUNDANCY" + }, + { + "value": "STANDARD_IA", + "name": "STANDARD_IA" + }, + { + "value": "ONEZONE_IA", + "name": "ONEZONE_IA" + }, + { + "value": "INTELLIGENT_TIERING", + "name": "INTELLIGENT_TIERING" + }, + { + "value": "GLACIER", + "name": "GLACIER" + }, + { + "value": "DEEP_ARCHIVE", + "name": "DEEP_ARCHIVE" + }, + { + "value": "OUTPOSTS", + "name": "OUTPOSTS" + } + ] + } + }, + "com.amazonaws.s3#StorageClassAnalysis": { + "type": "structure", + "members": { + "DataExport": { + "target": "com.amazonaws.s3#StorageClassAnalysisDataExport", + "traits": { + "smithy.api#documentation": "

Specifies how data related to the storage class analysis for an Amazon S3 bucket should be\n exported.

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

Specifies data related to access patterns to be collected and made available to analyze\n the tradeoffs between different storage classes for an Amazon S3 bucket.

" + } + }, + "com.amazonaws.s3#StorageClassAnalysisDataExport": { + "type": "structure", + "members": { + "OutputSchemaVersion": { + "target": "com.amazonaws.s3#StorageClassAnalysisSchemaVersion", + "traits": { + "smithy.api#documentation": "

The version of the output schema to use when exporting data. Must be\n V_1.

", + "smithy.api#required": {} + } + }, + "Destination": { + "target": "com.amazonaws.s3#AnalyticsExportDestination", + "traits": { + "smithy.api#documentation": "

The place to store the data for an analysis.

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

Container for data related to the storage class analysis for an Amazon S3 bucket for\n export.

" + } + }, + "com.amazonaws.s3#StorageClassAnalysisSchemaVersion": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "V_1", + "name": "V_1" + } + ] + } + }, + "com.amazonaws.s3#StreamingBlob": { + "type": "blob", + "traits": { + "smithy.api#streaming": {} + } + }, + "com.amazonaws.s3#Suffix": { + "type": "string" + }, + "com.amazonaws.s3#Tag": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.s3#ObjectKey", + "traits": { + "smithy.api#documentation": "

Name of the object key.

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

Value of the tag.

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

A container of a key value name pair.

" + } + }, + "com.amazonaws.s3#TagCount": { + "type": "integer" + }, + "com.amazonaws.s3#TagSet": { + "type": "list", + "member": { + "target": "com.amazonaws.s3#Tag", + "traits": { + "smithy.api#xmlName": "Tag" + } + } + }, + "com.amazonaws.s3#Tagging": { + "type": "structure", + "members": { + "TagSet": { + "target": "com.amazonaws.s3#TagSet", + "traits": { + "smithy.api#documentation": "

A collection for a set of tags

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

Container for TagSet elements.

" + } + }, + "com.amazonaws.s3#TaggingDirective": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "COPY", + "name": "COPY" + }, + { + "value": "REPLACE", + "name": "REPLACE" + } + ] + } + }, + "com.amazonaws.s3#TaggingHeader": { + "type": "string" + }, + "com.amazonaws.s3#TargetBucket": { + "type": "string" + }, + "com.amazonaws.s3#TargetGrant": { + "type": "structure", + "members": { + "Grantee": { + "target": "com.amazonaws.s3#Grantee", + "traits": { + "smithy.api#documentation": "

Container for the person being granted permissions.

" + } + }, + "Permission": { + "target": "com.amazonaws.s3#BucketLogsPermission", + "traits": { + "smithy.api#documentation": "

Logging permissions assigned to the grantee for the bucket.

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

Container for granting information.

" + } + }, + "com.amazonaws.s3#TargetGrants": { + "type": "list", + "member": { + "target": "com.amazonaws.s3#TargetGrant", + "traits": { + "smithy.api#xmlName": "Grant" + } + } + }, + "com.amazonaws.s3#TargetPrefix": { + "type": "string" + }, + "com.amazonaws.s3#Tier": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Standard", + "name": "Standard" + }, + { + "value": "Bulk", + "name": "Bulk" + }, + { + "value": "Expedited", + "name": "Expedited" + } + ] + } + }, + "com.amazonaws.s3#Tiering": { + "type": "structure", + "members": { + "Days": { + "target": "com.amazonaws.s3#IntelligentTieringDays", + "traits": { + "smithy.api#documentation": "

The number of consecutive days of no access after which an object will be eligible to be\n transitioned to the corresponding tier. The minimum number of days specified for\n Archive Access tier must be at least 90 days and Deep Archive Access tier must be at least\n 180 days. The maximum can be up to 2 years (730 days).

", + "smithy.api#required": {} + } + }, + "AccessTier": { + "target": "com.amazonaws.s3#IntelligentTieringAccessTier", + "traits": { + "smithy.api#documentation": "

S3 Intelligent-Tiering access tier. See Storage class for\n automatically optimizing frequently and infrequently accessed objects for a list\n of access tiers in the S3 Intelligent-Tiering storage class.

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

The S3 Intelligent-Tiering storage class is designed to optimize storage costs by\n automatically moving data to the most cost-effective storage access tier, without\n additional operational overhead.

" + } + }, + "com.amazonaws.s3#TieringList": { + "type": "list", + "member": { + "target": "com.amazonaws.s3#Tiering" + } + }, + "com.amazonaws.s3#Token": { + "type": "string" + }, + "com.amazonaws.s3#TopicArn": { + "type": "string" + }, + "com.amazonaws.s3#TopicConfiguration": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.s3#NotificationId" + }, + "TopicArn": { + "target": "com.amazonaws.s3#TopicArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon SNS topic to which Amazon S3 publishes a message\n when it detects events of the specified type.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "Topic" + } + }, + "Events": { + "target": "com.amazonaws.s3#EventList", + "traits": { + "smithy.api#documentation": "

The Amazon S3 bucket event about which to send notifications. For more information, see\n Supported\n Event Types in the Amazon Simple Storage Service Developer Guide.

", + "smithy.api#required": {}, + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "Event" + } + }, + "Filter": { + "target": "com.amazonaws.s3#NotificationConfigurationFilter" + } + }, + "traits": { + "smithy.api#documentation": "

A container for specifying the configuration for publication of messages to an Amazon\n Simple Notification Service (Amazon SNS) topic when Amazon S3 detects specified events.

" + } + }, + "com.amazonaws.s3#TopicConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.s3#TopicConfiguration" + } + }, + "com.amazonaws.s3#Transition": { + "type": "structure", + "members": { + "Date": { + "target": "com.amazonaws.s3#Date", + "traits": { + "smithy.api#documentation": "

Indicates when objects are transitioned to the specified storage class. The date value\n must be in ISO 8601 format. The time is always midnight UTC.

" + } + }, + "Days": { + "target": "com.amazonaws.s3#Days", + "traits": { + "smithy.api#documentation": "

Indicates the number of days after creation when objects are transitioned to the\n specified storage class. The value must be a positive integer.

" + } + }, + "StorageClass": { + "target": "com.amazonaws.s3#TransitionStorageClass", + "traits": { + "smithy.api#documentation": "

The storage class to which you want the object to transition.

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

Specifies when an object transitions to a specified storage class. For more information\n about Amazon S3 lifecycle configuration rules, see Transitioning\n Objects Using Amazon S3 Lifecycle in the Amazon Simple Storage Service Developer Guide.

" + } + }, + "com.amazonaws.s3#TransitionList": { + "type": "list", + "member": { + "target": "com.amazonaws.s3#Transition" + } + }, + "com.amazonaws.s3#TransitionStorageClass": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "GLACIER", + "name": "GLACIER" + }, + { + "value": "STANDARD_IA", + "name": "STANDARD_IA" + }, + { + "value": "ONEZONE_IA", + "name": "ONEZONE_IA" + }, + { + "value": "INTELLIGENT_TIERING", + "name": "INTELLIGENT_TIERING" + }, + { + "value": "DEEP_ARCHIVE", + "name": "DEEP_ARCHIVE" + } + ] + } + }, + "com.amazonaws.s3#Type": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CanonicalUser", + "name": "CanonicalUser" + }, + { + "value": "AmazonCustomerByEmail", + "name": "AmazonCustomerByEmail" + }, + { + "value": "Group", + "name": "Group" + } + ] + } + }, + "com.amazonaws.s3#URI": { + "type": "string" + }, + "com.amazonaws.s3#UploadIdMarker": { + "type": "string" + }, + "com.amazonaws.s3#UploadPart": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#UploadPartRequest" + }, + "output": { + "target": "com.amazonaws.s3#UploadPartOutput" + }, + "traits": { + "smithy.api#documentation": "

Uploads a part in a multipart upload.

\n \n

In this operation, you provide part data in your request. However, you have an option\n to specify your existing Amazon S3 object as a data source for the part you are uploading. To\n upload a part from an existing object, you use the UploadPartCopy operation.\n

\n \n\n

You must initiate a multipart upload (see CreateMultipartUpload)\n before you can upload any part. In response to your initiate request, Amazon S3 returns an\n upload ID, a unique identifier, that you must include in your upload part request.

\n

Part numbers can be any number from 1 to 10,000, inclusive. A part number uniquely\n identifies a part and also defines its position within the object being created. If you\n upload a new part using the same part number that was used with a previous part, the\n previously uploaded part is overwritten. Each part must be at least 5 MB in size, except\n the last part. There is no size limit on the last part of your multipart upload.

\n

To ensure that data is not corrupted when traversing the network, specify the\n Content-MD5 header in the upload part request. Amazon S3 checks the part data\n against the provided MD5 value. If they do not match, Amazon S3 returns an error.

\n\n

If the upload request is signed with Signature Version 4, then AWS S3 uses the\n x-amz-content-sha256 header as a checksum instead of\n Content-MD5. For more information see Authenticating Requests: Using the Authorization Header (AWS Signature Version\n 4).

\n\n\n\n

\n Note: After you initiate multipart upload and upload\n one or more parts, you must either complete or abort multipart upload in order to stop\n getting charged for storage of the uploaded parts. Only after you either complete or abort\n multipart upload, Amazon S3 frees up the parts storage and stops charging you for the parts\n storage.

\n\n

For more information on multipart uploads, go to Multipart Upload Overview in the\n Amazon Simple Storage Service Developer Guide .

\n

For information on the permissions required to use the multipart upload API, go to\n Multipart Upload API and\n Permissions in the Amazon Simple Storage Service Developer Guide.

\n\n

You can optionally request server-side encryption where Amazon S3 encrypts your data as it\n writes it to disks in its data centers and decrypts it for you when you access it. You have\n the option of providing your own encryption key, or you can use the AWS managed encryption\n keys. If you choose to provide your own encryption key, the request headers you provide in\n the request must match the headers you used in the request to initiate the upload by using\n CreateMultipartUpload. For more information, go to Using Server-Side Encryption in\n the Amazon Simple Storage Service Developer Guide.

\n\n

Server-side encryption is supported by the S3 Multipart Upload actions. Unless you are\n using a customer-provided encryption key, you don't need to specify the encryption\n parameters in each UploadPart request. Instead, you only need to specify the server-side\n encryption parameters in the initial Initiate Multipart request. For more information, see\n CreateMultipartUpload.

\n\n

If you requested server-side encryption using a customer-provided encryption key in your\n initiate multipart upload request, you must provide identical encryption information in\n each part upload using the following headers.

\n\n\n \n\n

\n Special Errors\n

\n \n\n \n\n\n\n\n

\n Related Resources\n

\n ", + "smithy.api#http": { + "method": "PUT", + "uri": "/{Bucket}/{Key+}?x-id=UploadPart", + "code": 200 + } + } + }, + "com.amazonaws.s3#UploadPartCopy": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#UploadPartCopyRequest" + }, + "output": { + "target": "com.amazonaws.s3#UploadPartCopyOutput" + }, + "traits": { + "smithy.api#documentation": "

Uploads a part by copying data from an existing object as data source. You specify the\n data source by adding the request header x-amz-copy-source in your request and\n a byte range by adding the request header x-amz-copy-source-range in your\n request.

\n

The minimum allowable part size for a multipart upload is 5 MB. For more information\n about multipart upload limits, go to Quick\n Facts in the Amazon Simple Storage Service Developer Guide.

\n \n

Instead of using an existing object as part data, you might use the UploadPart\n operation and provide data in your request.

\n \n\n

You must initiate a multipart upload before you can upload any part. In response to your\n initiate request. Amazon S3 returns a unique identifier, the upload ID, that you must include in\n your upload part request.

\n

For more information about using the UploadPartCopy operation, see the\n following:

\n\n \n

Note the following additional considerations about the request headers\n x-amz-copy-source-if-match, x-amz-copy-source-if-none-match,\n x-amz-copy-source-if-unmodified-since, and\n x-amz-copy-source-if-modified-since:

\n

\n \n

\n Versioning\n

\n

If your bucket has versioning enabled, you could have multiple versions of the same\n object. By default, x-amz-copy-source identifies the current version of the\n object to copy. If the current version is a delete marker and you don't specify a versionId\n in the x-amz-copy-source, Amazon S3 returns a 404 error, because the object does\n not exist. If you specify versionId in the x-amz-copy-source and the versionId\n is a delete marker, Amazon S3 returns an HTTP 400 error, because you are not allowed to specify\n a delete marker as a version for the x-amz-copy-source.

\n

You can optionally specify a specific version of the source object to copy by adding the\n versionId subresource as shown in the following example:

\n

\n x-amz-copy-source: /bucket/object?versionId=version id\n

\n\n

\n Special Errors\n

\n \n\n \n\n\n\n\n

\n Related Resources\n

\n ", + "smithy.api#http": { + "method": "PUT", + "uri": "/{Bucket}/{Key+}?x-id=UploadPartCopy", + "code": 200 + } + } + }, + "com.amazonaws.s3#UploadPartCopyOutput": { + "type": "structure", + "members": { + "CopySourceVersionId": { + "target": "com.amazonaws.s3#CopySourceVersionId", + "traits": { + "smithy.api#documentation": "

The version of the source object that was copied, if you have enabled versioning on the\n source bucket.

", + "smithy.api#httpHeader": "x-amz-copy-source-version-id" + } + }, + "CopyPartResult": { + "target": "com.amazonaws.s3#CopyPartResult", + "traits": { + "smithy.api#documentation": "

Container for all response elements.

", + "smithy.api#httpPayload": {} + } + }, + "ServerSideEncryption": { + "target": "com.amazonaws.s3#ServerSideEncryption", + "traits": { + "smithy.api#documentation": "

The server-side encryption algorithm used when storing this object in Amazon S3 (for example,\n AES256, aws:kms).

", + "smithy.api#httpHeader": "x-amz-server-side-encryption" + } + }, + "SSECustomerAlgorithm": { + "target": "com.amazonaws.s3#SSECustomerAlgorithm", + "traits": { + "smithy.api#documentation": "

If server-side encryption with a customer-provided encryption key was requested, the\n response will include this header confirming the encryption algorithm used.

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-algorithm" + } + }, + "SSECustomerKeyMD5": { + "target": "com.amazonaws.s3#SSECustomerKeyMD5", + "traits": { + "smithy.api#documentation": "

If server-side encryption with a customer-provided encryption key was requested, the\n response will include this header to provide round-trip message integrity verification of\n the customer-provided encryption key.

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key-MD5" + } + }, + "SSEKMSKeyId": { + "target": "com.amazonaws.s3#SSEKMSKeyId", + "traits": { + "smithy.api#documentation": "

If present, specifies the ID of the AWS Key Management Service (AWS KMS) symmetric\n customer managed customer master key (CMK) that was used for the object.

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" + } + }, + "BucketKeyEnabled": { + "target": "com.amazonaws.s3#BucketKeyEnabled", + "traits": { + "smithy.api#documentation": "

Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with AWS KMS (SSE-KMS).

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-bucket-key-enabled" + } + }, + "RequestCharged": { + "target": "com.amazonaws.s3#RequestCharged", + "traits": { + "smithy.api#httpHeader": "x-amz-request-charged" + } + } + } + }, + "com.amazonaws.s3#UploadPartCopyRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The bucket name.

\n

When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.

\n

When using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "CopySource": { + "target": "com.amazonaws.s3#CopySource", + "traits": { + "smithy.api#documentation": "

Specifies the source object for the copy operation. You specify the value in one of two\n formats, depending on whether you want to access the source object through an access\n point:

\n \n

To copy a specific version of an object, append ?versionId=\n to the value (for example,\n awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893).\n If you don't specify a version ID, Amazon S3 copies the latest version of the source\n object.

", + "smithy.api#httpHeader": "x-amz-copy-source", + "smithy.api#required": {} + } + }, + "CopySourceIfMatch": { + "target": "com.amazonaws.s3#CopySourceIfMatch", + "traits": { + "smithy.api#documentation": "

Copies the object if its entity tag (ETag) matches the specified tag.

", + "smithy.api#httpHeader": "x-amz-copy-source-if-match" + } + }, + "CopySourceIfModifiedSince": { + "target": "com.amazonaws.s3#CopySourceIfModifiedSince", + "traits": { + "smithy.api#documentation": "

Copies the object if it has been modified since the specified time.

", + "smithy.api#httpHeader": "x-amz-copy-source-if-modified-since" + } + }, + "CopySourceIfNoneMatch": { + "target": "com.amazonaws.s3#CopySourceIfNoneMatch", + "traits": { + "smithy.api#documentation": "

Copies the object if its entity tag (ETag) is different than the specified ETag.

", + "smithy.api#httpHeader": "x-amz-copy-source-if-none-match" + } + }, + "CopySourceIfUnmodifiedSince": { + "target": "com.amazonaws.s3#CopySourceIfUnmodifiedSince", + "traits": { + "smithy.api#documentation": "

Copies the object if it hasn't been modified since the specified time.

", + "smithy.api#httpHeader": "x-amz-copy-source-if-unmodified-since" + } + }, + "CopySourceRange": { + "target": "com.amazonaws.s3#CopySourceRange", + "traits": { + "smithy.api#documentation": "

The range of bytes to copy from the source object. The range value must use the form\n bytes=first-last, where the first and last are the zero-based byte offsets to copy. For\n example, bytes=0-9 indicates that you want to copy the first 10 bytes of the source. You\n can copy a range only if the source object is greater than 5 MB.

", + "smithy.api#httpHeader": "x-amz-copy-source-range" + } + }, + "Key": { + "target": "com.amazonaws.s3#ObjectKey", + "traits": { + "smithy.api#documentation": "

Object key for which the multipart upload was initiated.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "PartNumber": { + "target": "com.amazonaws.s3#PartNumber", + "traits": { + "smithy.api#documentation": "

Part number of part being copied. This is a positive integer between 1 and\n 10,000.

", + "smithy.api#httpQuery": "partNumber", + "smithy.api#required": {} + } + }, + "UploadId": { + "target": "com.amazonaws.s3#MultipartUploadId", + "traits": { + "smithy.api#documentation": "

Upload ID identifying the multipart upload whose part is being copied.

", + "smithy.api#httpQuery": "uploadId", + "smithy.api#required": {} + } + }, + "SSECustomerAlgorithm": { + "target": "com.amazonaws.s3#SSECustomerAlgorithm", + "traits": { + "smithy.api#documentation": "

Specifies the algorithm to use to when encrypting the object (for example,\n AES256).

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-algorithm" + } + }, + "SSECustomerKey": { + "target": "com.amazonaws.s3#SSECustomerKey", + "traits": { + "smithy.api#documentation": "

Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This\n value is used to store the object and then it is discarded; Amazon S3 does not store the\n encryption key. The key must be appropriate for use with the algorithm specified in the\n x-amz-server-side-encryption-customer-algorithm header. This must be the\n same encryption key specified in the initiate multipart upload request.

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key" + } + }, + "SSECustomerKeyMD5": { + "target": "com.amazonaws.s3#SSECustomerKeyMD5", + "traits": { + "smithy.api#documentation": "

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses\n this header for a message integrity check to ensure that the encryption key was transmitted\n without error.

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key-MD5" + } + }, + "CopySourceSSECustomerAlgorithm": { + "target": "com.amazonaws.s3#CopySourceSSECustomerAlgorithm", + "traits": { + "smithy.api#documentation": "

Specifies the algorithm to use when decrypting the source object (for example,\n AES256).

", + "smithy.api#httpHeader": "x-amz-copy-source-server-side-encryption-customer-algorithm" + } + }, + "CopySourceSSECustomerKey": { + "target": "com.amazonaws.s3#CopySourceSSECustomerKey", + "traits": { + "smithy.api#documentation": "

Specifies the customer-provided encryption key for Amazon S3 to use to decrypt the source\n object. The encryption key provided in this header must be one that was used when the\n source object was created.

", + "smithy.api#httpHeader": "x-amz-copy-source-server-side-encryption-customer-key" + } + }, + "CopySourceSSECustomerKeyMD5": { + "target": "com.amazonaws.s3#CopySourceSSECustomerKeyMD5", + "traits": { + "smithy.api#documentation": "

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses\n this header for a message integrity check to ensure that the encryption key was transmitted\n without error.

", + "smithy.api#httpHeader": "x-amz-copy-source-server-side-encryption-customer-key-MD5" + } + }, + "RequestPayer": { + "target": "com.amazonaws.s3#RequestPayer", + "traits": { + "smithy.api#httpHeader": "x-amz-request-payer" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account id of the expected destination bucket owner. If the destination bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + }, + "ExpectedSourceBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account id of the expected source bucket owner. If the source bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", + "smithy.api#httpHeader": "x-amz-source-expected-bucket-owner" + } + } + } + }, + "com.amazonaws.s3#UploadPartOutput": { + "type": "structure", + "members": { + "ServerSideEncryption": { + "target": "com.amazonaws.s3#ServerSideEncryption", + "traits": { + "smithy.api#documentation": "

The server-side encryption algorithm used when storing this object in Amazon S3 (for example,\n AES256, aws:kms).

", + "smithy.api#httpHeader": "x-amz-server-side-encryption" + } + }, + "ETag": { + "target": "com.amazonaws.s3#ETag", + "traits": { + "smithy.api#documentation": "

Entity tag for the uploaded object.

", + "smithy.api#httpHeader": "ETag" + } + }, + "SSECustomerAlgorithm": { + "target": "com.amazonaws.s3#SSECustomerAlgorithm", + "traits": { + "smithy.api#documentation": "

If server-side encryption with a customer-provided encryption key was requested, the\n response will include this header confirming the encryption algorithm used.

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-algorithm" + } + }, + "SSECustomerKeyMD5": { + "target": "com.amazonaws.s3#SSECustomerKeyMD5", + "traits": { + "smithy.api#documentation": "

If server-side encryption with a customer-provided encryption key was requested, the\n response will include this header to provide round-trip message integrity verification of\n the customer-provided encryption key.

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key-MD5" + } + }, + "SSEKMSKeyId": { + "target": "com.amazonaws.s3#SSEKMSKeyId", + "traits": { + "smithy.api#documentation": "

If present, specifies the ID of the AWS Key Management Service (AWS KMS) symmetric\n customer managed customer master key (CMK) was used for the object.

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" + } + }, + "BucketKeyEnabled": { + "target": "com.amazonaws.s3#BucketKeyEnabled", + "traits": { + "smithy.api#documentation": "

Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with AWS KMS (SSE-KMS).

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-bucket-key-enabled" + } + }, + "RequestCharged": { + "target": "com.amazonaws.s3#RequestCharged", + "traits": { + "smithy.api#httpHeader": "x-amz-request-charged" + } + } + } + }, + "com.amazonaws.s3#UploadPartRequest": { + "type": "structure", + "members": { + "Body": { + "target": "com.amazonaws.s3#StreamingBlob", + "traits": { + "smithy.api#documentation": "

Object data.

", + "smithy.api#httpPayload": {} + } + }, + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket to which the multipart upload was initiated.

\n

When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.

\n

When using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ContentLength": { + "target": "com.amazonaws.s3#ContentLength", + "traits": { + "smithy.api#documentation": "

Size of the body in bytes. This parameter is useful when the size of the body cannot be\n determined automatically.

", + "smithy.api#httpHeader": "Content-Length" + } + }, + "ContentMD5": { + "target": "com.amazonaws.s3#ContentMD5", + "traits": { + "smithy.api#documentation": "

The base64-encoded 128-bit MD5 digest of the part data. This parameter is auto-populated\n when using the command from the CLI. This parameter is required if object lock parameters\n are specified.

", + "smithy.api#httpHeader": "Content-MD5" + } + }, + "Key": { + "target": "com.amazonaws.s3#ObjectKey", + "traits": { + "smithy.api#documentation": "

Object key for which the multipart upload was initiated.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "PartNumber": { + "target": "com.amazonaws.s3#PartNumber", + "traits": { + "smithy.api#documentation": "

Part number of part being uploaded. This is a positive integer between 1 and\n 10,000.

", + "smithy.api#httpQuery": "partNumber", + "smithy.api#required": {} + } + }, + "UploadId": { + "target": "com.amazonaws.s3#MultipartUploadId", + "traits": { + "smithy.api#documentation": "

Upload ID identifying the multipart upload whose part is being uploaded.

", + "smithy.api#httpQuery": "uploadId", + "smithy.api#required": {} + } + }, + "SSECustomerAlgorithm": { + "target": "com.amazonaws.s3#SSECustomerAlgorithm", + "traits": { + "smithy.api#documentation": "

Specifies the algorithm to use to when encrypting the object (for example,\n AES256).

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-algorithm" + } + }, + "SSECustomerKey": { + "target": "com.amazonaws.s3#SSECustomerKey", + "traits": { + "smithy.api#documentation": "

Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This\n value is used to store the object and then it is discarded; Amazon S3 does not store the\n encryption key. The key must be appropriate for use with the algorithm specified in the\n x-amz-server-side-encryption-customer-algorithm header. This must be the\n same encryption key specified in the initiate multipart upload request.

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key" + } + }, + "SSECustomerKeyMD5": { + "target": "com.amazonaws.s3#SSECustomerKeyMD5", + "traits": { + "smithy.api#documentation": "

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses\n this header for a message integrity check to ensure that the encryption key was transmitted\n without error.

", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key-MD5" + } + }, + "RequestPayer": { + "target": "com.amazonaws.s3#RequestPayer", + "traits": { + "smithy.api#httpHeader": "x-amz-request-payer" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", + "smithy.api#httpHeader": "x-amz-expected-bucket-owner" + } + } + } + }, + "com.amazonaws.s3#UserMetadata": { + "type": "list", + "member": { + "target": "com.amazonaws.s3#MetadataEntry", + "traits": { + "smithy.api#xmlName": "MetadataEntry" + } + } + }, + "com.amazonaws.s3#Value": { + "type": "string" + }, + "com.amazonaws.s3#VersionIdMarker": { + "type": "string" + }, + "com.amazonaws.s3#VersioningConfiguration": { + "type": "structure", + "members": { + "MFADelete": { + "target": "com.amazonaws.s3#MFADelete", + "traits": { + "smithy.api#documentation": "

Specifies whether MFA delete is enabled in the bucket versioning configuration. This\n element is only returned if the bucket has been configured with MFA delete. If the bucket\n has never been so configured, this element is not returned.

", + "smithy.api#xmlName": "MfaDelete" + } + }, + "Status": { + "target": "com.amazonaws.s3#BucketVersioningStatus", + "traits": { + "smithy.api#documentation": "

The versioning state of the bucket.

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

Describes the versioning state of an Amazon S3 bucket. For more information, see PUT\n Bucket versioning in the Amazon Simple Storage Service API Reference.

" + } + }, + "com.amazonaws.s3#WebsiteConfiguration": { + "type": "structure", + "members": { + "ErrorDocument": { + "target": "com.amazonaws.s3#ErrorDocument", + "traits": { + "smithy.api#documentation": "

The name of the error document for the website.

" + } + }, + "IndexDocument": { + "target": "com.amazonaws.s3#IndexDocument", + "traits": { + "smithy.api#documentation": "

The name of the index document for the website.

" + } + }, + "RedirectAllRequestsTo": { + "target": "com.amazonaws.s3#RedirectAllRequestsTo", + "traits": { + "smithy.api#documentation": "

The redirect behavior for every request to this bucket's website endpoint.

\n \n

If you specify this property, you can't specify any other property.

\n " + } + }, + "RoutingRules": { + "target": "com.amazonaws.s3#RoutingRules", + "traits": { + "smithy.api#documentation": "

Rules that define when a redirect is applied and the redirect behavior.

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

Specifies website configuration parameters for an Amazon S3 bucket.

" + } }, - { - "target": "com.amazonaws.s3#UploadPart" + "com.amazonaws.s3#WebsiteRedirectLocation": { + "type": "string" }, - { - "target": "com.amazonaws.s3#UploadPartCopy" + "com.amazonaws.s3#Years": { + "type": "integer" } - ], - "traits": { - "aws.api#service": { - "sdkId": "S3", - "arnNamespace": "s3", - "cloudFormationName": "S3", - "cloudTrailEventSource": "s3.amazonaws.com", - "endpointPrefix": "s3" - }, - "aws.auth#sigv4": { - "name": "s3" - }, - "aws.protocols#restXml": { - "noErrorWrapping": true - }, - "smithy.api#documentation": "

", - "smithy.api#title": "Amazon Simple Storage Service", - "smithy.api#xmlNamespace": { - "uri": "http://s3.amazonaws.com/doc/2006-03-01/" - } - } - }, - "com.amazonaws.s3#AnalyticsAndOperator": { - "type": "structure", - "members": { - "Prefix": { - "target": "com.amazonaws.s3#Prefix", - "traits": { - "smithy.api#documentation": "

The prefix to use when evaluating an AND predicate: The prefix that an object must have\n to be included in the metrics results.

" - } - }, - "Tags": { - "target": "com.amazonaws.s3#TagSet", - "traits": { - "smithy.api#documentation": "

The list of tags to use when evaluating an AND predicate.

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

A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter.\n The operator must have at least two predicates in any combination, and an object must match\n all of the predicates for the filter to apply.

" - } - }, - "com.amazonaws.s3#AnalyticsConfiguration": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.s3#AnalyticsId", - "traits": { - "smithy.api#documentation": "

The ID that identifies the analytics configuration.

", - "smithy.api#required": {} - } - }, - "Filter": { - "target": "com.amazonaws.s3#AnalyticsFilter", - "traits": { - "smithy.api#documentation": "

The filter used to describe a set of objects for analyses. A filter must have exactly\n one prefix, one tag, or one conjunction (AnalyticsAndOperator). If no filter is provided,\n all objects will be considered in any analysis.

" - } - }, - "StorageClassAnalysis": { - "target": "com.amazonaws.s3#StorageClassAnalysis", - "traits": { - "smithy.api#documentation": "

Contains data related to access patterns to be collected and made available to analyze\n the tradeoffs between different storage classes.

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

Specifies the configuration and any analyses for the analytics filter of an Amazon S3\n bucket.

" - } - }, - "com.amazonaws.s3#AnalyticsConfigurationList": { - "type": "list", - "member": { - "target": "com.amazonaws.s3#AnalyticsConfiguration" - } - }, - "com.amazonaws.s3#AnalyticsExportDestination": { - "type": "structure", - "members": { - "S3BucketDestination": { - "target": "com.amazonaws.s3#AnalyticsS3BucketDestination", - "traits": { - "smithy.api#documentation": "

A destination signifying output to an S3 bucket.

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

Where to publish the analytics results.

" - } - }, - "com.amazonaws.s3#AnalyticsFilter": { - "type": "union", - "members": { - "Prefix": { - "target": "com.amazonaws.s3#Prefix", - "traits": { - "smithy.api#documentation": "

The prefix to use when evaluating an analytics filter.

" - } - }, - "Tag": { - "target": "com.amazonaws.s3#Tag", - "traits": { - "smithy.api#documentation": "

The tag to use when evaluating an analytics filter.

" - } - }, - "And": { - "target": "com.amazonaws.s3#AnalyticsAndOperator", - "traits": { - "smithy.api#documentation": "

A conjunction (logical AND) of predicates, which is used in evaluating an analytics\n filter. The operator must have at least two predicates.

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

The filter used to describe a set of objects for analyses. A filter must have exactly\n one prefix, one tag, or one conjunction (AnalyticsAndOperator). If no filter is provided,\n all objects will be considered in any analysis.

" - } - }, - "com.amazonaws.s3#AnalyticsId": { - "type": "string" - }, - "com.amazonaws.s3#AnalyticsS3BucketDestination": { - "type": "structure", - "members": { - "Format": { - "target": "com.amazonaws.s3#AnalyticsS3ExportFileFormat", - "traits": { - "smithy.api#documentation": "

Specifies the file format used when exporting data to Amazon S3.

", - "smithy.api#required": {} - } - }, - "BucketAccountId": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "

The account ID that owns the destination S3 bucket. If no account ID is provided, the\n owner is not validated before exporting data.

\n \n

Although this value is optional, we strongly recommend that you set it to help\n prevent problems if the destination bucket ownership changes.

\n " - } - }, - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the bucket to which data is exported.

", - "smithy.api#required": {} - } - }, - "Prefix": { - "target": "com.amazonaws.s3#Prefix", - "traits": { - "smithy.api#documentation": "

The prefix to use when exporting data. The prefix is prepended to all results.

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

Contains information about where to publish the analytics results.

" - } - }, - "com.amazonaws.s3#AnalyticsS3ExportFileFormat": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CSV" - } - ] - } - }, - "com.amazonaws.s3#ArchiveStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ARCHIVE_ACCESS" - }, - { - "value": "DEEP_ARCHIVE_ACCESS" - } - ] - } - }, - "com.amazonaws.s3#Body": { - "type": "blob" - }, - "com.amazonaws.s3#Bucket": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

The name of the bucket.

" - } - }, - "CreationDate": { - "target": "com.amazonaws.s3#CreationDate", - "traits": { - "smithy.api#documentation": "

Date the bucket was created. This date can change when making changes to your bucket, such as editing its bucket policy.

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

In terms of implementation, a Bucket is a resource. An Amazon S3 bucket name is globally\n unique, and the namespace is shared by all AWS accounts.

" - } - }, - "com.amazonaws.s3#BucketAccelerateStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Enabled" - }, - { - "value": "Suspended" - } - ] - } - }, - "com.amazonaws.s3#BucketAlreadyExists": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "

The requested bucket name is not available. The bucket namespace is shared by all users\n of the system. Select a different name and try again.

", - "smithy.api#error": "client" - } - }, - "com.amazonaws.s3#BucketAlreadyOwnedByYou": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "

The bucket you tried to create already exists, and you own it. Amazon S3 returns this error\n in all AWS Regions except in the North Virginia Region. For legacy compatibility, if you\n re-create an existing bucket that you already own in the North Virginia Region, Amazon S3\n returns 200 OK and resets the bucket access control lists (ACLs).

", - "smithy.api#error": "client" - } - }, - "com.amazonaws.s3#BucketCannedACL": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "private" - }, - { - "value": "public-read" - }, - { - "value": "public-read-write" - }, - { - "value": "authenticated-read" - } - ] - } - }, - "com.amazonaws.s3#BucketKeyEnabled": { - "type": "boolean" - }, - "com.amazonaws.s3#BucketLifecycleConfiguration": { - "type": "structure", - "members": { - "Rules": { - "target": "com.amazonaws.s3#LifecycleRules", - "traits": { - "smithy.api#documentation": "

A lifecycle rule for individual objects in an Amazon S3 bucket.

", - "smithy.api#required": {}, - "smithy.api#xmlFlattened": {}, - "smithy.api#xmlName": "Rule" - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies the lifecycle configuration for objects in an Amazon S3 bucket. For more\n information, see Object Lifecycle Management\n in the Amazon Simple Storage Service Developer Guide.

" - } - }, - "com.amazonaws.s3#BucketLocationConstraint": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "af-south-1" - }, - { - "value": "ap-east-1" - }, - { - "value": "ap-northeast-1" - }, - { - "value": "ap-northeast-2" - }, - { - "value": "ap-northeast-3" - }, - { - "value": "ap-south-1" - }, - { - "value": "ap-southeast-1" - }, - { - "value": "ap-southeast-2" - }, - { - "value": "ca-central-1" - }, - { - "value": "cn-north-1" - }, - { - "value": "cn-northwest-1" - }, - { - "value": "EU" - }, - { - "value": "eu-central-1" - }, - { - "value": "eu-north-1" - }, - { - "value": "eu-south-1" - }, - { - "value": "eu-west-1" - }, - { - "value": "eu-west-2" - }, - { - "value": "eu-west-3" - }, - { - "value": "me-south-1" - }, - { - "value": "sa-east-1" - }, - { - "value": "us-east-2" - }, - { - "value": "us-gov-east-1" - }, - { - "value": "us-gov-west-1" - }, - { - "value": "us-west-1" - }, - { - "value": "us-west-2" - } - ] - } - }, - "com.amazonaws.s3#BucketLoggingStatus": { - "type": "structure", - "members": { - "LoggingEnabled": { - "target": "com.amazonaws.s3#LoggingEnabled" - } - }, - "traits": { - "smithy.api#documentation": "

Container for logging status information.

" - } - }, - "com.amazonaws.s3#BucketLogsPermission": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "FULL_CONTROL" - }, - { - "value": "READ" - }, - { - "value": "WRITE" - } - ] - } - }, - "com.amazonaws.s3#BucketName": { - "type": "string" - }, - "com.amazonaws.s3#BucketVersioningStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Enabled" - }, - { - "value": "Suspended" - } - ] - } - }, - "com.amazonaws.s3#Buckets": { - "type": "list", - "member": { - "target": "com.amazonaws.s3#Bucket", - "traits": { - "smithy.api#xmlName": "Bucket" - } - } - }, - "com.amazonaws.s3#BypassGovernanceRetention": { - "type": "boolean" - }, - "com.amazonaws.s3#BytesProcessed": { - "type": "long" - }, - "com.amazonaws.s3#BytesReturned": { - "type": "long" - }, - "com.amazonaws.s3#BytesScanned": { - "type": "long" - }, - "com.amazonaws.s3#CORSConfiguration": { - "type": "structure", - "members": { - "CORSRules": { - "target": "com.amazonaws.s3#CORSRules", - "traits": { - "smithy.api#documentation": "

A set of origins and methods (cross-origin access that you want to allow). You can add\n up to 100 rules to the configuration.

", - "smithy.api#required": {}, - "smithy.api#xmlFlattened": {}, - "smithy.api#xmlName": "CORSRule" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the cross-origin access configuration for objects in an Amazon S3 bucket. For more\n information, see Enabling\n Cross-Origin Resource Sharing in the Amazon Simple Storage Service Developer\n Guide.

" - } - }, - "com.amazonaws.s3#CORSRule": { - "type": "structure", - "members": { - "AllowedHeaders": { - "target": "com.amazonaws.s3#AllowedHeaders", - "traits": { - "smithy.api#documentation": "

Headers that are specified in the Access-Control-Request-Headers header.\n These headers are allowed in a preflight OPTIONS request. In response to any preflight\n OPTIONS request, Amazon S3 returns any requested headers that are allowed.

", - "smithy.api#xmlFlattened": {}, - "smithy.api#xmlName": "AllowedHeader" - } - }, - "AllowedMethods": { - "target": "com.amazonaws.s3#AllowedMethods", - "traits": { - "smithy.api#documentation": "

An HTTP method that you allow the origin to execute. Valid values are GET,\n PUT, HEAD, POST, and DELETE.

", - "smithy.api#required": {}, - "smithy.api#xmlFlattened": {}, - "smithy.api#xmlName": "AllowedMethod" - } - }, - "AllowedOrigins": { - "target": "com.amazonaws.s3#AllowedOrigins", - "traits": { - "smithy.api#documentation": "

One or more origins you want customers to be able to access the bucket from.

", - "smithy.api#required": {}, - "smithy.api#xmlFlattened": {}, - "smithy.api#xmlName": "AllowedOrigin" - } - }, - "ExposeHeaders": { - "target": "com.amazonaws.s3#ExposeHeaders", - "traits": { - "smithy.api#documentation": "

One or more headers in the response that you want customers to be able to access from\n their applications (for example, from a JavaScript XMLHttpRequest\n object).

", - "smithy.api#xmlFlattened": {}, - "smithy.api#xmlName": "ExposeHeader" - } - }, - "MaxAgeSeconds": { - "target": "com.amazonaws.s3#MaxAgeSeconds", - "traits": { - "smithy.api#documentation": "

The time in seconds that your browser is to cache the preflight response for the\n specified resource.

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

Specifies a cross-origin access rule for an Amazon S3 bucket.

" - } - }, - "com.amazonaws.s3#CORSRules": { - "type": "list", - "member": { - "target": "com.amazonaws.s3#CORSRule" - } - }, - "com.amazonaws.s3#CSVInput": { - "type": "structure", - "members": { - "FileHeaderInfo": { - "target": "com.amazonaws.s3#FileHeaderInfo", - "traits": { - "smithy.api#documentation": "

Describes the first line of input. Valid values are:

\n " - } - }, - "Comments": { - "target": "com.amazonaws.s3#Comments", - "traits": { - "smithy.api#documentation": "

A single character used to indicate that a row should be ignored when the character is\n present at the start of that row. You can specify any character to indicate a comment\n line.

" - } - }, - "QuoteEscapeCharacter": { - "target": "com.amazonaws.s3#QuoteEscapeCharacter", - "traits": { - "smithy.api#documentation": "

A single character used for escaping the quotation mark character inside an already\n escaped value. For example, the value \"\"\" a , b \"\"\" is parsed as \" a , b \".

" - } - }, - "RecordDelimiter": { - "target": "com.amazonaws.s3#RecordDelimiter", - "traits": { - "smithy.api#documentation": "

A single character used to separate individual records in the input. Instead of the\n default value, you can specify an arbitrary delimiter.

" - } - }, - "FieldDelimiter": { - "target": "com.amazonaws.s3#FieldDelimiter", - "traits": { - "smithy.api#documentation": "

A single character used to separate individual fields in a record. You can specify an\n arbitrary delimiter.

" - } - }, - "QuoteCharacter": { - "target": "com.amazonaws.s3#QuoteCharacter", - "traits": { - "smithy.api#documentation": "

A single character used for escaping when the field delimiter is part of the value. For\n example, if the value is a, b, Amazon S3 wraps this field value in quotation marks,\n as follows: \" a , b \".

\n

Type: String

\n

Default: \"\n

\n

Ancestors: CSV\n

" - } - }, - "AllowQuotedRecordDelimiter": { - "target": "com.amazonaws.s3#AllowQuotedRecordDelimiter", - "traits": { - "smithy.api#documentation": "

Specifies that CSV field values may contain quoted record delimiters and such records\n should be allowed. Default value is FALSE. Setting this value to TRUE may lower\n performance.

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

Describes how an uncompressed comma-separated values (CSV)-formatted input object is\n formatted.

" - } - }, - "com.amazonaws.s3#CSVOutput": { - "type": "structure", - "members": { - "QuoteFields": { - "target": "com.amazonaws.s3#QuoteFields", - "traits": { - "smithy.api#documentation": "

Indicates whether to use quotation marks around output fields.

\n " - } - }, - "QuoteEscapeCharacter": { - "target": "com.amazonaws.s3#QuoteEscapeCharacter", - "traits": { - "smithy.api#documentation": "

The single character used for escaping the quote character inside an already escaped\n value.

" - } - }, - "RecordDelimiter": { - "target": "com.amazonaws.s3#RecordDelimiter", - "traits": { - "smithy.api#documentation": "

A single character used to separate individual records in the output. Instead of the\n default value, you can specify an arbitrary delimiter.

" - } - }, - "FieldDelimiter": { - "target": "com.amazonaws.s3#FieldDelimiter", - "traits": { - "smithy.api#documentation": "

The value used to separate individual fields in a record. You can specify an arbitrary\n delimiter.

" - } - }, - "QuoteCharacter": { - "target": "com.amazonaws.s3#QuoteCharacter", - "traits": { - "smithy.api#documentation": "

A single character used for escaping when the field delimiter is part of the value. For\n example, if the value is a, b, Amazon S3 wraps this field value in quotation marks,\n as follows: \" a , b \".

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

Describes how uncompressed comma-separated values (CSV)-formatted results are\n formatted.

" - } - }, - "com.amazonaws.s3#CacheControl": { - "type": "string" - }, - "com.amazonaws.s3#Code": { - "type": "string" - }, - "com.amazonaws.s3#Comments": { - "type": "string" - }, - "com.amazonaws.s3#CommonPrefix": { - "type": "structure", - "members": { - "Prefix": { - "target": "com.amazonaws.s3#Prefix", - "traits": { - "smithy.api#documentation": "

Container for the specified common prefix.

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

Container for all (if there are any) keys between Prefix and the next occurrence of the\n string specified by a delimiter. CommonPrefixes lists keys that act like subdirectories in\n the directory specified by Prefix. For example, if the prefix is notes/ and the delimiter\n is a slash (/) as in notes/summer/july, the common prefix is notes/summer/.

" - } - }, - "com.amazonaws.s3#CommonPrefixList": { - "type": "list", - "member": { - "target": "com.amazonaws.s3#CommonPrefix" - } - }, - "com.amazonaws.s3#CompleteMultipartUpload": { - "type": "operation", - "input": { - "target": "com.amazonaws.s3#CompleteMultipartUploadRequest" - }, - "output": { - "target": "com.amazonaws.s3#CompleteMultipartUploadOutput" - }, - "traits": { - "smithy.api#documentation": "

Completes a multipart upload by assembling previously uploaded parts.

\n

You first initiate the multipart upload and then upload all parts using the UploadPart\n operation. After successfully uploading all relevant parts of an upload, you call this\n operation to complete the upload. Upon receiving this request, Amazon S3 concatenates all\n the parts in ascending order by part number to create a new object. In the Complete\n Multipart Upload request, you must provide the parts list. You must ensure that the parts\n list is complete. This operation concatenates the parts that you provide in the list. For\n each part in the list, you must provide the part number and the ETag value,\n returned after that part was uploaded.

\n

Processing of a Complete Multipart Upload request could take several minutes to\n complete. After Amazon S3 begins processing the request, it sends an HTTP response header that\n specifies a 200 OK response. While processing is in progress, Amazon S3 periodically sends white\n space characters to keep the connection from timing out. Because a request could fail after\n the initial 200 OK response has been sent, it is important that you check the response body\n to determine whether the request succeeded.

\n

Note that if CompleteMultipartUpload fails, applications should be prepared\n to retry the failed requests. For more information, see Amazon S3 Error Best Practices.

\n

For more information about multipart uploads, see Uploading Objects Using Multipart\n Upload.

\n

For information about permissions required to use the multipart upload API, see Multipart Upload API and\n Permissions.

\n\n\n

\n CompleteMultipartUpload has the following special errors:

\n \n\n

The following operations are related to CompleteMultipartUpload:

\n ", - "smithy.api#http": { - "method": "POST", - "uri": "/{Bucket}/{Key+}", - "code": 200 - } - } - }, - "com.amazonaws.s3#CompleteMultipartUploadOutput": { - "type": "structure", - "members": { - "Location": { - "target": "com.amazonaws.s3#Location", - "traits": { - "smithy.api#documentation": "

The URI that identifies the newly created object.

" - } - }, - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

The name of the bucket that contains the newly created object.

\n

When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.

\n

When using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.

" - } - }, - "Key": { - "target": "com.amazonaws.s3#ObjectKey", - "traits": { - "smithy.api#documentation": "

The object key of the newly created object.

" - } - }, - "Expiration": { - "target": "com.amazonaws.s3#Expiration", - "traits": { - "smithy.api#documentation": "

If the object expiration is configured, this will contain the expiration date\n (expiry-date) and rule ID (rule-id). The value of rule-id is URL encoded.

", - "smithy.api#httpHeader": "x-amz-expiration" - } - }, - "ETag": { - "target": "com.amazonaws.s3#ETag", - "traits": { - "smithy.api#documentation": "

Entity tag that identifies the newly created object's data. Objects with different\n object data will have different entity tags. The entity tag is an opaque string. The entity\n tag may or may not be an MD5 digest of the object data. If the entity tag is not an MD5\n digest of the object data, it will contain one or more nonhexadecimal characters and/or\n will consist of less than 32 or more than 32 hexadecimal digits.

" - } - }, - "ServerSideEncryption": { - "target": "com.amazonaws.s3#ServerSideEncryption", - "traits": { - "smithy.api#documentation": "

If you specified server-side encryption either with an Amazon S3-managed encryption key or an\n AWS KMS customer master key (CMK) in your initiate multipart upload request, the response\n includes this header. It confirms the encryption algorithm that Amazon S3 used to encrypt the\n object.

", - "smithy.api#httpHeader": "x-amz-server-side-encryption" - } - }, - "VersionId": { - "target": "com.amazonaws.s3#ObjectVersionId", - "traits": { - "smithy.api#documentation": "

Version ID of the newly created object, in case the bucket has versioning turned\n on.

", - "smithy.api#httpHeader": "x-amz-version-id" - } - }, - "SSEKMSKeyId": { - "target": "com.amazonaws.s3#SSEKMSKeyId", - "traits": { - "smithy.api#documentation": "

If present, specifies the ID of the AWS Key Management Service (AWS KMS) symmetric\n customer managed customer master key (CMK) that was used for the object.

", - "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" - } - }, - "BucketKeyEnabled": { - "target": "com.amazonaws.s3#BucketKeyEnabled", - "traits": { - "smithy.api#documentation": "

Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with AWS KMS (SSE-KMS).

", - "smithy.api#httpHeader": "x-amz-server-side-encryption-bucket-key-enabled" - } - }, - "RequestCharged": { - "target": "com.amazonaws.s3#RequestCharged", - "traits": { - "smithy.api#httpHeader": "x-amz-request-charged" - } - } - } - }, - "com.amazonaws.s3#CompleteMultipartUploadRequest": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

Name of the bucket to which the multipart upload was initiated.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Key": { - "target": "com.amazonaws.s3#ObjectKey", - "traits": { - "smithy.api#documentation": "

Object key for which the multipart upload was initiated.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "MultipartUpload": { - "target": "com.amazonaws.s3#CompletedMultipartUpload", - "traits": { - "smithy.api#documentation": "

The container for the multipart upload request information.

", - "smithy.api#httpPayload": {}, - "smithy.api#xmlName": "CompleteMultipartUpload" - } - }, - "UploadId": { - "target": "com.amazonaws.s3#MultipartUploadId", - "traits": { - "smithy.api#documentation": "

ID for the initiated multipart upload.

", - "smithy.api#httpQuery": "uploadId", - "smithy.api#required": {} - } - }, - "RequestPayer": { - "target": "com.amazonaws.s3#RequestPayer", - "traits": { - "smithy.api#httpHeader": "x-amz-request-payer" - } - }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", - "smithy.api#httpHeader": "x-amz-expected-bucket-owner" - } - } - } - }, - "com.amazonaws.s3#CompletedMultipartUpload": { - "type": "structure", - "members": { - "Parts": { - "target": "com.amazonaws.s3#CompletedPartList", - "traits": { - "smithy.api#documentation": "

Array of CompletedPart data types.

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

The container for the completed multipart upload details.

" - } - }, - "com.amazonaws.s3#CompletedPart": { - "type": "structure", - "members": { - "ETag": { - "target": "com.amazonaws.s3#ETag", - "traits": { - "smithy.api#documentation": "

Entity tag returned when the part was uploaded.

" - } - }, - "PartNumber": { - "target": "com.amazonaws.s3#PartNumber", - "traits": { - "smithy.api#documentation": "

Part number that identifies the part. This is a positive integer between 1 and\n 10,000.

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

Details of the parts that were uploaded.

" - } - }, - "com.amazonaws.s3#CompletedPartList": { - "type": "list", - "member": { - "target": "com.amazonaws.s3#CompletedPart" - } - }, - "com.amazonaws.s3#CompressionType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "NONE" - }, - { - "value": "GZIP" - }, - { - "value": "BZIP2" - } - ] - } - }, - "com.amazonaws.s3#Condition": { - "type": "structure", - "members": { - "HttpErrorCodeReturnedEquals": { - "target": "com.amazonaws.s3#HttpErrorCodeReturnedEquals", - "traits": { - "smithy.api#documentation": "

The HTTP error code when the redirect is applied. In the event of an error, if the error\n code equals this value, then the specified redirect is applied. Required when parent\n element Condition is specified and sibling KeyPrefixEquals is not\n specified. If both are specified, then both must be true for the redirect to be\n applied.

" - } - }, - "KeyPrefixEquals": { - "target": "com.amazonaws.s3#KeyPrefixEquals", - "traits": { - "smithy.api#documentation": "

The object key name prefix when the redirect is applied. For example, to redirect\n requests for ExamplePage.html, the key prefix will be\n ExamplePage.html. To redirect request for all pages with the prefix\n docs/, the key prefix will be /docs, which identifies all\n objects in the docs/ folder. Required when the parent element\n Condition is specified and sibling HttpErrorCodeReturnedEquals\n is not specified. If both conditions are specified, both must be true for the redirect to\n be applied.

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

A container for describing a condition that must be met for the specified redirect to\n apply. For example, 1. If request is for pages in the /docs folder, redirect\n to the /documents folder. 2. If request results in HTTP error 4xx, redirect\n request to another host where you might process the error.

" - } - }, - "com.amazonaws.s3#ConfirmRemoveSelfBucketAccess": { - "type": "boolean" - }, - "com.amazonaws.s3#ContentDisposition": { - "type": "string" - }, - "com.amazonaws.s3#ContentEncoding": { - "type": "string" - }, - "com.amazonaws.s3#ContentLanguage": { - "type": "string" - }, - "com.amazonaws.s3#ContentLength": { - "type": "long" - }, - "com.amazonaws.s3#ContentMD5": { - "type": "string" - }, - "com.amazonaws.s3#ContentRange": { - "type": "string" - }, - "com.amazonaws.s3#ContentType": { - "type": "string" - }, - "com.amazonaws.s3#ContinuationEvent": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "

" - } - }, - "com.amazonaws.s3#CopyObject": { - "type": "operation", - "input": { - "target": "com.amazonaws.s3#CopyObjectRequest" - }, - "output": { - "target": "com.amazonaws.s3#CopyObjectOutput" - }, - "errors": [ - { - "target": "com.amazonaws.s3#ObjectNotInActiveTierError" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a copy of an object that is already stored in Amazon S3.

\n \n

You can store individual objects of up to 5 TB in Amazon S3. You create a copy of your\n object up to 5 GB in size in a single atomic operation using this API. However, to copy\n an object greater than 5 GB, you must use the multipart upload Upload Part - Copy API.\n For more information, see Copy Object Using the REST Multipart Upload API.

\n \n

All copy requests must be authenticated. Additionally, you must have\n read access to the source object and write\n access to the destination bucket. For more information, see REST Authentication. Both the Region\n that you want to copy the object from and the Region that you want to copy the object to\n must be enabled for your account.

\n

A copy request might return an error when Amazon S3 receives the copy request or while Amazon S3\n is copying the files. If the error occurs before the copy operation starts, you receive a\n standard Amazon S3 error. If the error occurs during the copy operation, the error response is\n embedded in the 200 OK response. This means that a 200 OK\n response can contain either a success or an error. Design your application to parse the\n contents of the response and handle it appropriately.

\n

If the copy is successful, you receive a response with information about the copied\n object.

\n \n

If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not,\n it would not contain the content-length, and you would need to read the entire\n body.

\n \n

The copy request charge is based on the storage class and Region that you specify for\n the destination object. For pricing information, see Amazon S3 pricing.

\n \n

Amazon S3 transfer acceleration does not support cross-Region copies. If you request a\n cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad\n Request error. For more information, see Transfer Acceleration.

\n \n

\n Metadata\n

\n

When copying an object, you can preserve all metadata (default) or specify new metadata.\n However, the ACL is not preserved and is set to private for the user making the request. To\n override the default ACL setting, specify a new ACL when generating a copy request. For\n more information, see Using ACLs.

\n

To specify whether you want the object metadata copied from the source object or\n replaced with metadata provided in the request, you can optionally add the\n x-amz-metadata-directive header. When you grant permissions, you can use\n the s3:x-amz-metadata-directive condition key to enforce certain metadata\n behavior when objects are uploaded. For more information, see Specifying Conditions in a\n Policy in the Amazon S3 Developer Guide. For a complete list of\n Amazon S3-specific condition keys, see Actions, Resources, and Condition Keys for\n Amazon S3.

\n

\n \n x-amz-copy-source-if Headers\n

\n

To only copy an object under certain conditions, such as whether the Etag\n matches or whether the object was modified before or after a specified date, use the\n following request parameters:

\n \n

If both the x-amz-copy-source-if-match and\n x-amz-copy-source-if-unmodified-since headers are present in the request\n and evaluate as follows, Amazon S3 returns 200 OK and copies the data:

\n \n\n

If both the x-amz-copy-source-if-none-match and\n x-amz-copy-source-if-modified-since headers are present in the request and\n evaluate as follows, Amazon S3 returns the 412 Precondition Failed response\n code:

\n \n\n \n

All headers with the x-amz- prefix, including\n x-amz-copy-source, must be signed.

\n \n

\n Server-side encryption\n

\n

When you perform a CopyObject operation, you can optionally use the appropriate encryption-related headers to encrypt the object using server-side encryption with AWS managed encryption keys (SSE-S3 or SSE-KMS) or a customer-provided encryption key. With server-side encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts the data when you access it. For more information about server-side encryption, see Using\n Server-Side Encryption.

\n

If a target object uses SSE-KMS, you can enable an S3 Bucket Key for the object. For more\n information, see Amazon S3 Bucket Keys in the Amazon Simple Storage Service Developer Guide.

\n

\n Access Control List (ACL)-Specific Request\n Headers\n

\n

When copying an object, you can optionally use headers to grant ACL-based permissions.\n By default, all objects are private. Only the owner has full access control. When adding a\n new object, you can grant permissions to individual AWS accounts or to predefined groups\n defined by Amazon S3. These permissions are then added to the ACL on the object. For more\n information, see Access Control List (ACL) Overview and Managing ACLs Using the REST\n API.

\n\n

\n Storage Class Options\n

\n

You can use the CopyObject operation to change the storage class of an\n object that is already stored in Amazon S3 using the StorageClass parameter. For\n more information, see Storage\n Classes in the Amazon S3 Service Developer Guide.

\n

\n Versioning\n

\n

By default, x-amz-copy-source identifies the current version of an object\n to copy. If the current version is a delete marker, Amazon S3 behaves as if the object was\n deleted. To copy a different version, use the versionId subresource.

\n

If you enable versioning on the target bucket, Amazon S3 generates a unique version ID for\n the object being copied. This version ID is different from the version ID of the source\n object. Amazon S3 returns the version ID of the copied object in the\n x-amz-version-id response header in the response.

\n

If you do not enable versioning or suspend it on the target bucket, the version ID that\n Amazon S3 generates is always null.

\n

If the source object's storage class is GLACIER, you must restore a copy of this object\n before you can use it as a source object for the copy operation. For more information, see\n RestoreObject.

\n

The following operations are related to CopyObject:

\n \n

For more information, see Copying\n Objects.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/{Bucket}/{Key+}?x-id=CopyObject", - "code": 200 - } - } - }, - "com.amazonaws.s3#CopyObjectOutput": { - "type": "structure", - "members": { - "CopyObjectResult": { - "target": "com.amazonaws.s3#CopyObjectResult", - "traits": { - "smithy.api#documentation": "

Container for all response elements.

", - "smithy.api#httpPayload": {} - } - }, - "Expiration": { - "target": "com.amazonaws.s3#Expiration", - "traits": { - "smithy.api#documentation": "

If the object expiration is configured, the response includes this header.

", - "smithy.api#httpHeader": "x-amz-expiration" - } - }, - "CopySourceVersionId": { - "target": "com.amazonaws.s3#CopySourceVersionId", - "traits": { - "smithy.api#documentation": "

Version of the copied object in the destination bucket.

", - "smithy.api#httpHeader": "x-amz-copy-source-version-id" - } - }, - "VersionId": { - "target": "com.amazonaws.s3#ObjectVersionId", - "traits": { - "smithy.api#documentation": "

Version ID of the newly created copy.

", - "smithy.api#httpHeader": "x-amz-version-id" - } - }, - "ServerSideEncryption": { - "target": "com.amazonaws.s3#ServerSideEncryption", - "traits": { - "smithy.api#documentation": "

The server-side encryption algorithm used when storing this object in Amazon S3 (for example,\n AES256, aws:kms).

", - "smithy.api#httpHeader": "x-amz-server-side-encryption" - } - }, - "SSECustomerAlgorithm": { - "target": "com.amazonaws.s3#SSECustomerAlgorithm", - "traits": { - "smithy.api#documentation": "

If server-side encryption with a customer-provided encryption key was requested, the\n response will include this header confirming the encryption algorithm used.

", - "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-algorithm" - } - }, - "SSECustomerKeyMD5": { - "target": "com.amazonaws.s3#SSECustomerKeyMD5", - "traits": { - "smithy.api#documentation": "

If server-side encryption with a customer-provided encryption key was requested, the\n response will include this header to provide round-trip message integrity verification of\n the customer-provided encryption key.

", - "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key-MD5" - } - }, - "SSEKMSKeyId": { - "target": "com.amazonaws.s3#SSEKMSKeyId", - "traits": { - "smithy.api#documentation": "

If present, specifies the ID of the AWS Key Management Service (AWS KMS) symmetric\n customer managed customer master key (CMK) that was used for the object.

", - "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" - } - }, - "SSEKMSEncryptionContext": { - "target": "com.amazonaws.s3#SSEKMSEncryptionContext", - "traits": { - "smithy.api#documentation": "

If present, specifies the AWS KMS Encryption Context to use for object encryption. The\n value of this header is a base64-encoded UTF-8 string holding JSON with the encryption\n context key-value pairs.

", - "smithy.api#httpHeader": "x-amz-server-side-encryption-context" - } - }, - "BucketKeyEnabled": { - "target": "com.amazonaws.s3#BucketKeyEnabled", - "traits": { - "smithy.api#documentation": "

Indicates whether the copied object uses an S3 Bucket Key for server-side encryption with AWS KMS (SSE-KMS).

", - "smithy.api#httpHeader": "x-amz-server-side-encryption-bucket-key-enabled" - } - }, - "RequestCharged": { - "target": "com.amazonaws.s3#RequestCharged", - "traits": { - "smithy.api#httpHeader": "x-amz-request-charged" - } - } - } - }, - "com.amazonaws.s3#CopyObjectRequest": { - "type": "structure", - "members": { - "ACL": { - "target": "com.amazonaws.s3#ObjectCannedACL", - "traits": { - "smithy.api#documentation": "

The canned ACL to apply to the object.

\n

This action is not supported by Amazon S3 on Outposts.

", - "smithy.api#httpHeader": "x-amz-acl" - } - }, - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

The name of the destination bucket.

\n

When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.

\n

When using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "CacheControl": { - "target": "com.amazonaws.s3#CacheControl", - "traits": { - "smithy.api#documentation": "

Specifies caching behavior along the request/reply chain.

", - "smithy.api#httpHeader": "Cache-Control" - } - }, - "ContentDisposition": { - "target": "com.amazonaws.s3#ContentDisposition", - "traits": { - "smithy.api#documentation": "

Specifies presentational information for the object.

", - "smithy.api#httpHeader": "Content-Disposition" - } - }, - "ContentEncoding": { - "target": "com.amazonaws.s3#ContentEncoding", - "traits": { - "smithy.api#documentation": "

Specifies what content encodings have been applied to the object and thus what decoding\n mechanisms must be applied to obtain the media-type referenced by the Content-Type header\n field.

", - "smithy.api#httpHeader": "Content-Encoding" - } - }, - "ContentLanguage": { - "target": "com.amazonaws.s3#ContentLanguage", - "traits": { - "smithy.api#documentation": "

The language the content is in.

", - "smithy.api#httpHeader": "Content-Language" - } - }, - "ContentType": { - "target": "com.amazonaws.s3#ContentType", - "traits": { - "smithy.api#documentation": "

A standard MIME type describing the format of the object data.

", - "smithy.api#httpHeader": "Content-Type" - } - }, - "CopySource": { - "target": "com.amazonaws.s3#CopySource", - "traits": { - "smithy.api#documentation": "

Specifies the source object for the copy operation. You specify the value in one of two\n formats, depending on whether you want to access the source object through an access\n point:

\n \n

To copy a specific version of an object, append ?versionId=\n to the value (for example,\n awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893).\n If you don't specify a version ID, Amazon S3 copies the latest version of the source\n object.

", - "smithy.api#httpHeader": "x-amz-copy-source", - "smithy.api#required": {} - } - }, - "CopySourceIfMatch": { - "target": "com.amazonaws.s3#CopySourceIfMatch", - "traits": { - "smithy.api#documentation": "

Copies the object if its entity tag (ETag) matches the specified tag.

", - "smithy.api#httpHeader": "x-amz-copy-source-if-match" - } - }, - "CopySourceIfModifiedSince": { - "target": "com.amazonaws.s3#CopySourceIfModifiedSince", - "traits": { - "smithy.api#documentation": "

Copies the object if it has been modified since the specified time.

", - "smithy.api#httpHeader": "x-amz-copy-source-if-modified-since" - } - }, - "CopySourceIfNoneMatch": { - "target": "com.amazonaws.s3#CopySourceIfNoneMatch", - "traits": { - "smithy.api#documentation": "

Copies the object if its entity tag (ETag) is different than the specified ETag.

", - "smithy.api#httpHeader": "x-amz-copy-source-if-none-match" - } - }, - "CopySourceIfUnmodifiedSince": { - "target": "com.amazonaws.s3#CopySourceIfUnmodifiedSince", - "traits": { - "smithy.api#documentation": "

Copies the object if it hasn't been modified since the specified time.

", - "smithy.api#httpHeader": "x-amz-copy-source-if-unmodified-since" - } - }, - "Expires": { - "target": "com.amazonaws.s3#Expires", - "traits": { - "smithy.api#documentation": "

The date and time at which the object is no longer cacheable.

", - "smithy.api#httpHeader": "Expires" - } - }, - "GrantFullControl": { - "target": "com.amazonaws.s3#GrantFullControl", - "traits": { - "smithy.api#documentation": "

Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the\n object.

\n

This action is not supported by Amazon S3 on Outposts.

", - "smithy.api#httpHeader": "x-amz-grant-full-control" - } - }, - "GrantRead": { - "target": "com.amazonaws.s3#GrantRead", - "traits": { - "smithy.api#documentation": "

Allows grantee to read the object data and its\n metadata.

\n

This action is not supported by Amazon S3 on Outposts.

", - "smithy.api#httpHeader": "x-amz-grant-read" - } - }, - "GrantReadACP": { - "target": "com.amazonaws.s3#GrantReadACP", - "traits": { - "smithy.api#documentation": "

Allows grantee to read the object ACL.

\n

This action is not supported by Amazon S3 on Outposts.

", - "smithy.api#httpHeader": "x-amz-grant-read-acp" - } - }, - "GrantWriteACP": { - "target": "com.amazonaws.s3#GrantWriteACP", - "traits": { - "smithy.api#documentation": "

Allows grantee to write the ACL for the applicable\n object.

\n

This action is not supported by Amazon S3 on Outposts.

", - "smithy.api#httpHeader": "x-amz-grant-write-acp" - } - }, - "Key": { - "target": "com.amazonaws.s3#ObjectKey", - "traits": { - "smithy.api#documentation": "

The key of the destination object.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Metadata": { - "target": "com.amazonaws.s3#Metadata", - "traits": { - "smithy.api#documentation": "

A map of metadata to store with the object in S3.

", - "smithy.api#httpPrefixHeaders": "x-amz-meta-" - } - }, - "MetadataDirective": { - "target": "com.amazonaws.s3#MetadataDirective", - "traits": { - "smithy.api#documentation": "

Specifies whether the metadata is copied from the source object or replaced with\n metadata provided in the request.

", - "smithy.api#httpHeader": "x-amz-metadata-directive" - } - }, - "TaggingDirective": { - "target": "com.amazonaws.s3#TaggingDirective", - "traits": { - "smithy.api#documentation": "

Specifies whether the object tag-set are copied from the source object or replaced with\n tag-set provided in the request.

", - "smithy.api#httpHeader": "x-amz-tagging-directive" - } - }, - "ServerSideEncryption": { - "target": "com.amazonaws.s3#ServerSideEncryption", - "traits": { - "smithy.api#documentation": "

The server-side encryption algorithm used when storing this object in Amazon S3 (for example,\n AES256, aws:kms).

", - "smithy.api#httpHeader": "x-amz-server-side-encryption" - } - }, - "StorageClass": { - "target": "com.amazonaws.s3#StorageClass", - "traits": { - "smithy.api#documentation": "

By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The\n STANDARD storage class provides high durability and high availability. Depending on\n performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses\n the OUTPOSTS Storage Class. For more information, see Storage Classes in the Amazon S3\n Service Developer Guide.

", - "smithy.api#httpHeader": "x-amz-storage-class" - } - }, - "WebsiteRedirectLocation": { - "target": "com.amazonaws.s3#WebsiteRedirectLocation", - "traits": { - "smithy.api#documentation": "

If the bucket is configured as a website, redirects requests for this object to another\n object in the same bucket or to an external URL. Amazon S3 stores the value of this header in\n the object metadata.

", - "smithy.api#httpHeader": "x-amz-website-redirect-location" - } - }, - "SSECustomerAlgorithm": { - "target": "com.amazonaws.s3#SSECustomerAlgorithm", - "traits": { - "smithy.api#documentation": "

Specifies the algorithm to use to when encrypting the object (for example,\n AES256).

", - "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-algorithm" - } - }, - "SSECustomerKey": { - "target": "com.amazonaws.s3#SSECustomerKey", - "traits": { - "smithy.api#documentation": "

Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This\n value is used to store the object and then it is discarded; Amazon S3 does not store the\n encryption key. The key must be appropriate for use with the algorithm specified in the\n x-amz-server-side-encryption-customer-algorithm header.

", - "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key" - } - }, - "SSECustomerKeyMD5": { - "target": "com.amazonaws.s3#SSECustomerKeyMD5", - "traits": { - "smithy.api#documentation": "

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses\n this header for a message integrity check to ensure that the encryption key was transmitted\n without error.

", - "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key-MD5" - } - }, - "SSEKMSKeyId": { - "target": "com.amazonaws.s3#SSEKMSKeyId", - "traits": { - "smithy.api#documentation": "

Specifies the AWS KMS key ID to use for object encryption. All GET and PUT requests for\n an object protected by AWS KMS will fail if not made via SSL or using SigV4. For\n information about configuring using any of the officially supported AWS SDKs and AWS CLI,\n see Specifying the\n Signature Version in Request Authentication in the Amazon S3 Developer\n Guide.

", - "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" - } - }, - "SSEKMSEncryptionContext": { - "target": "com.amazonaws.s3#SSEKMSEncryptionContext", - "traits": { - "smithy.api#documentation": "

Specifies the AWS KMS Encryption Context to use for object encryption. The value of this\n header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value\n pairs.

", - "smithy.api#httpHeader": "x-amz-server-side-encryption-context" - } - }, - "BucketKeyEnabled": { - "target": "com.amazonaws.s3#BucketKeyEnabled", - "traits": { - "smithy.api#documentation": "

Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using AWS KMS (SSE-KMS). Setting this header to true causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS.

\n

Specifying this header with a COPY operation doesn’t affect bucket-level settings for S3 Bucket Key.

", - "smithy.api#httpHeader": "x-amz-server-side-encryption-bucket-key-enabled" - } - }, - "CopySourceSSECustomerAlgorithm": { - "target": "com.amazonaws.s3#CopySourceSSECustomerAlgorithm", - "traits": { - "smithy.api#documentation": "

Specifies the algorithm to use when decrypting the source object (for example,\n AES256).

", - "smithy.api#httpHeader": "x-amz-copy-source-server-side-encryption-customer-algorithm" - } - }, - "CopySourceSSECustomerKey": { - "target": "com.amazonaws.s3#CopySourceSSECustomerKey", - "traits": { - "smithy.api#documentation": "

Specifies the customer-provided encryption key for Amazon S3 to use to decrypt the source\n object. The encryption key provided in this header must be one that was used when the\n source object was created.

", - "smithy.api#httpHeader": "x-amz-copy-source-server-side-encryption-customer-key" - } - }, - "CopySourceSSECustomerKeyMD5": { - "target": "com.amazonaws.s3#CopySourceSSECustomerKeyMD5", - "traits": { - "smithy.api#documentation": "

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses\n this header for a message integrity check to ensure that the encryption key was transmitted\n without error.

", - "smithy.api#httpHeader": "x-amz-copy-source-server-side-encryption-customer-key-MD5" - } - }, - "RequestPayer": { - "target": "com.amazonaws.s3#RequestPayer", - "traits": { - "smithy.api#httpHeader": "x-amz-request-payer" - } - }, - "Tagging": { - "target": "com.amazonaws.s3#TaggingHeader", - "traits": { - "smithy.api#documentation": "

The tag-set for the object destination object this value must be used in conjunction\n with the TaggingDirective. The tag-set must be encoded as URL Query\n parameters.

", - "smithy.api#httpHeader": "x-amz-tagging" - } - }, - "ObjectLockMode": { - "target": "com.amazonaws.s3#ObjectLockMode", - "traits": { - "smithy.api#documentation": "

The Object Lock mode that you want to apply to the copied object.

", - "smithy.api#httpHeader": "x-amz-object-lock-mode" - } - }, - "ObjectLockRetainUntilDate": { - "target": "com.amazonaws.s3#ObjectLockRetainUntilDate", - "traits": { - "smithy.api#documentation": "

The date and time when you want the copied object's Object Lock to expire.

", - "smithy.api#httpHeader": "x-amz-object-lock-retain-until-date" - } - }, - "ObjectLockLegalHoldStatus": { - "target": "com.amazonaws.s3#ObjectLockLegalHoldStatus", - "traits": { - "smithy.api#documentation": "

Specifies whether you want to apply a Legal Hold to the copied object.

", - "smithy.api#httpHeader": "x-amz-object-lock-legal-hold" - } - }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "

The account id of the expected destination bucket owner. If the destination bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", - "smithy.api#httpHeader": "x-amz-expected-bucket-owner" - } - }, - "ExpectedSourceBucketOwner": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "

The account id of the expected source bucket owner. If the source bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", - "smithy.api#httpHeader": "x-amz-source-expected-bucket-owner" - } - } - } - }, - "com.amazonaws.s3#CopyObjectResult": { - "type": "structure", - "members": { - "ETag": { - "target": "com.amazonaws.s3#ETag", - "traits": { - "smithy.api#documentation": "

Returns the ETag of the new object. The ETag reflects only changes to the contents of an\n object, not its metadata. The source and destination ETag is identical for a successfully\n copied object.

" - } - }, - "LastModified": { - "target": "com.amazonaws.s3#LastModified", - "traits": { - "smithy.api#documentation": "

Returns the date that the object was last modified.

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

Container for all response elements.

" - } - }, - "com.amazonaws.s3#CopyPartResult": { - "type": "structure", - "members": { - "ETag": { - "target": "com.amazonaws.s3#ETag", - "traits": { - "smithy.api#documentation": "

Entity tag of the object.

" - } - }, - "LastModified": { - "target": "com.amazonaws.s3#LastModified", - "traits": { - "smithy.api#documentation": "

Date and time at which the object was uploaded.

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

Container for all response elements.

" - } - }, - "com.amazonaws.s3#CopySource": { - "type": "string", - "traits": { - "smithy.api#pattern": "\\/.+\\/.+" - } - }, - "com.amazonaws.s3#CopySourceIfMatch": { - "type": "string" - }, - "com.amazonaws.s3#CopySourceIfModifiedSince": { - "type": "timestamp" - }, - "com.amazonaws.s3#CopySourceIfNoneMatch": { - "type": "string" - }, - "com.amazonaws.s3#CopySourceIfUnmodifiedSince": { - "type": "timestamp" - }, - "com.amazonaws.s3#CopySourceRange": { - "type": "string" - }, - "com.amazonaws.s3#CopySourceSSECustomerAlgorithm": { - "type": "string" - }, - "com.amazonaws.s3#CopySourceSSECustomerKey": { - "type": "string", - "traits": { - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.s3#CopySourceSSECustomerKeyMD5": { - "type": "string" - }, - "com.amazonaws.s3#CopySourceVersionId": { - "type": "string" - }, - "com.amazonaws.s3#CreateBucket": { - "type": "operation", - "input": { - "target": "com.amazonaws.s3#CreateBucketRequest" - }, - "output": { - "target": "com.amazonaws.s3#CreateBucketOutput" - }, - "errors": [ - { - "target": "com.amazonaws.s3#BucketAlreadyExists" - }, - { - "target": "com.amazonaws.s3#BucketAlreadyOwnedByYou" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a new S3 bucket. To create a bucket, you must register with Amazon S3 and have a\n valid AWS Access Key ID to authenticate requests. Anonymous requests are never allowed to\n create buckets. By creating the bucket, you become the bucket owner.

\n

Not every string is an acceptable bucket name. For information about bucket naming\n restrictions, see Working with Amazon S3\n buckets.

\n

If you want to create an Amazon S3 on Outposts bucket, see Create Bucket.

\n

By default, the bucket is created in the US East (N. Virginia) Region. You can\n optionally specify a Region in the request body. You might choose a Region to optimize\n latency, minimize costs, or address regulatory requirements. For example, if you reside in\n Europe, you will probably find it advantageous to create buckets in the Europe (Ireland)\n Region. For more information, see Accessing a\n bucket.

\n \n

If you send your create bucket request to the s3.amazonaws.com endpoint,\n the request goes to the us-east-1 Region. Accordingly, the signature calculations in\n Signature Version 4 must use us-east-1 as the Region, even if the location constraint in\n the request specifies another Region where the bucket is to be created. If you create a\n bucket in a Region other than US East (N. Virginia), your application must be able to\n handle 307 redirect. For more information, see Virtual hosting of buckets.

\n \n

When creating a bucket using this operation, you can optionally specify the accounts or\n groups that should be granted specific permissions on the bucket. There are two ways to\n grant the appropriate permissions using the request headers.

\n \n \n

You can use either a canned ACL or specify access permissions explicitly. You cannot\n do both.

\n \n\n\n

The following operations are related to CreateBucket:

\n ", - "smithy.api#http": { - "method": "PUT", - "uri": "/{Bucket}", - "code": 200 - } - } - }, - "com.amazonaws.s3#CreateBucketConfiguration": { - "type": "structure", - "members": { - "LocationConstraint": { - "target": "com.amazonaws.s3#BucketLocationConstraint", - "traits": { - "smithy.api#documentation": "

Specifies the Region where the bucket will be created. If you don't specify a Region,\n the bucket is created in the US East (N. Virginia) Region (us-east-1).

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

The configuration information for the bucket.

" - } - }, - "com.amazonaws.s3#CreateBucketOutput": { - "type": "structure", - "members": { - "Location": { - "target": "com.amazonaws.s3#Location", - "traits": { - "smithy.api#documentation": "

Specifies the Region where the bucket will be created. If you are creating a bucket on\n the US East (N. Virginia) Region (us-east-1), you do not need to specify the\n location.

", - "smithy.api#httpHeader": "Location" - } - } - } - }, - "com.amazonaws.s3#CreateBucketRequest": { - "type": "structure", - "members": { - "ACL": { - "target": "com.amazonaws.s3#BucketCannedACL", - "traits": { - "smithy.api#documentation": "

The canned ACL to apply to the bucket.

", - "smithy.api#httpHeader": "x-amz-acl" - } - }, - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

The name of the bucket to create.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "CreateBucketConfiguration": { - "target": "com.amazonaws.s3#CreateBucketConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration information for the bucket.

", - "smithy.api#httpPayload": {} - } - }, - "GrantFullControl": { - "target": "com.amazonaws.s3#GrantFullControl", - "traits": { - "smithy.api#documentation": "

Allows grantee the read, write, read ACP, and write ACP permissions on the\n bucket.

", - "smithy.api#httpHeader": "x-amz-grant-full-control" - } - }, - "GrantRead": { - "target": "com.amazonaws.s3#GrantRead", - "traits": { - "smithy.api#documentation": "

Allows grantee to list the objects in the bucket.

", - "smithy.api#httpHeader": "x-amz-grant-read" - } - }, - "GrantReadACP": { - "target": "com.amazonaws.s3#GrantReadACP", - "traits": { - "smithy.api#documentation": "

Allows grantee to read the bucket ACL.

", - "smithy.api#httpHeader": "x-amz-grant-read-acp" - } - }, - "GrantWrite": { - "target": "com.amazonaws.s3#GrantWrite", - "traits": { - "smithy.api#documentation": "

Allows grantee to create, overwrite, and delete any object in the bucket.

", - "smithy.api#httpHeader": "x-amz-grant-write" - } - }, - "GrantWriteACP": { - "target": "com.amazonaws.s3#GrantWriteACP", - "traits": { - "smithy.api#documentation": "

Allows grantee to write the ACL for the applicable bucket.

", - "smithy.api#httpHeader": "x-amz-grant-write-acp" - } - }, - "ObjectLockEnabledForBucket": { - "target": "com.amazonaws.s3#ObjectLockEnabledForBucket", - "traits": { - "smithy.api#documentation": "

Specifies whether you want S3 Object Lock to be enabled for the new bucket.

", - "smithy.api#httpHeader": "x-amz-bucket-object-lock-enabled" - } - } - } - }, - "com.amazonaws.s3#CreateMultipartUpload": { - "type": "operation", - "input": { - "target": "com.amazonaws.s3#CreateMultipartUploadRequest" - }, - "output": { - "target": "com.amazonaws.s3#CreateMultipartUploadOutput" - }, - "traits": { - "smithy.api#documentation": "

This operation initiates a multipart upload and returns an upload ID. This upload ID is\n used to associate all of the parts in the specific multipart upload. You specify this\n upload ID in each of your subsequent upload part requests (see UploadPart). You also include this\n upload ID in the final request to either complete or abort the multipart upload\n request.

\n\n

For more information about multipart uploads, see Multipart Upload Overview.

\n\n

If you have configured a lifecycle rule to abort incomplete multipart uploads, the\n upload must complete within the number of days specified in the bucket lifecycle\n configuration. Otherwise, the incomplete multipart upload becomes eligible for an abort\n operation and Amazon S3 aborts the multipart upload. For more information, see Aborting\n Incomplete Multipart Uploads Using a Bucket Lifecycle Policy.

\n\n

For information about the permissions required to use the multipart upload API, see\n Multipart Upload API and\n Permissions.

\n\n

For request signing, multipart upload is just a series of regular requests. You initiate\n a multipart upload, send one or more requests to upload parts, and then complete the\n multipart upload process. You sign each request individually. There is nothing special\n about signing multipart upload requests. For more information about signing, see Authenticating\n Requests (AWS Signature Version 4).

\n\n \n

After you initiate a multipart upload and upload one or more parts, to stop being\n charged for storing the uploaded parts, you must either complete or abort the multipart\n upload. Amazon S3 frees up the space used to store the parts and stop charging you for\n storing them only after you either complete or abort a multipart upload.

\n \n\n

You can optionally request server-side encryption. For server-side encryption, Amazon S3\n encrypts your data as it writes it to disks in its data centers and decrypts it when you\n access it. You can provide your own encryption key, or use AWS Key Management Service (AWS\n KMS) customer master keys (CMKs) or Amazon S3-managed encryption keys. If you choose to provide\n your own encryption key, the request headers you provide in UploadPart and UploadPartCopy requests must match the headers you used in the request to\n initiate the upload by using CreateMultipartUpload.

\n

To perform a multipart upload with encryption using an AWS KMS CMK, the requester must\n have permission to the kms:Encrypt, kms:Decrypt,\n kms:ReEncrypt*, kms:GenerateDataKey*, and\n kms:DescribeKey actions on the key. These permissions are required because\n Amazon S3 must decrypt and read data from the encrypted file parts before it completes the\n multipart upload.

\n\n

If your AWS Identity and Access Management (IAM) user or role is in the same AWS account\n as the AWS KMS CMK, then you must have these permissions on the key policy. If your IAM\n user or role belongs to a different account than the key, then you must have the\n permissions on both the key policy and your IAM user or role.

\n\n\n

For more information, see Protecting\n Data Using Server-Side Encryption.

\n\n
\n
Access Permissions
\n
\n

When copying an object, you can optionally specify the accounts or groups that\n should be granted specific permissions on the new object. There are two ways to\n grant the permissions using the request headers:

\n
    \n
  • \n

    Specify a canned ACL with the x-amz-acl request header. For\n more information, see Canned ACL.

    \n
    • \n
  • \n

    Specify access permissions explicitly with the\n x-amz-grant-read, x-amz-grant-read-acp,\n x-amz-grant-write-acp, and\n x-amz-grant-full-control headers. These parameters map to\n the set of permissions that Amazon S3 supports in an ACL. For more information,\n see Access Control List (ACL)\n Overview.

    \n
    • \n
\n

You can use either a canned ACL or specify access permissions explicitly. You\n cannot do both.

\n
\n
Server-Side- Encryption-Specific Request Headers
\n
\n

You can optionally tell Amazon S3 to encrypt data at rest using server-side\n encryption. Server-side encryption is for data encryption at rest. Amazon S3 encrypts\n your data as it writes it to disks in its data centers and decrypts it when you\n access it. The option you use depends on whether you want to use AWS managed\n encryption keys or provide your own encryption key.

\n
    \n
  • \n

    Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored\n in AWS Key Management Service (AWS KMS) – If you want AWS to manage the keys\n used to encrypt data, specify the following headers in the request.

    \n
      \n
    • \n

      x-amz-server-side-encryption

      \n
      • \n
    • \n

      x-amz-server-side-encryption-aws-kms-key-id

      \n
      • \n
    • \n

      x-amz-server-side-encryption-context

      \n
      • \n
    \n \n

    If you specify x-amz-server-side-encryption:aws:kms, but\n don't provide x-amz-server-side-encryption-aws-kms-key-id,\n Amazon S3 uses the AWS managed CMK in AWS KMS to protect the data.

    \n     \n \n

    All GET and PUT requests for an object protected by AWS KMS fail if\n you don't make them with SSL or by using SigV4.

    \n     \n

    For more information about server-side encryption with CMKs stored in AWS\n KMS (SSE-KMS), see Protecting Data Using Server-Side Encryption with CMKs stored in AWS\n KMS.

    \n
    • \n
  • \n

    Use customer-provided encryption keys – If you want to manage your own\n encryption keys, provide all the following headers in the request.

    \n
      \n
    • \n

      x-amz-server-side-encryption-customer-algorithm

      \n
      • \n
    • \n

      x-amz-server-side-encryption-customer-key

      \n
      • \n
    • \n

      x-amz-server-side-encryption-customer-key-MD5

      \n
      • \n
    \n

    For more information about server-side encryption with CMKs stored in AWS\n KMS (SSE-KMS), see Protecting Data Using Server-Side Encryption with CMKs stored in AWS\n KMS.

    \n
    • \n
\n
\n
Access-Control-List (ACL)-Specific Request Headers
\n
\n

You also can use the following access control–related headers with this\n operation. By default, all objects are private. Only the owner has full access\n control. When adding a new object, you can grant permissions to individual AWS\n accounts or to predefined groups defined by Amazon S3. These permissions are then added\n to the access control list (ACL) on the object. For more information, see Using ACLs. With this\n operation, you can grant access permissions using one of the following two\n methods:

\n
    \n
  • \n

    Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of\n predefined ACLs, known as canned ACLs. Each canned ACL\n has a predefined set of grantees and permissions. For more information, see\n Canned\n ACL.

    \n
    • \n
  • \n

    Specify access permissions explicitly — To explicitly grant access\n permissions to specific AWS accounts or groups, use the following headers.\n Each header maps to specific permissions that Amazon S3 supports in an ACL. For\n more information, see Access\n Control List (ACL) Overview. In the header, you specify a list of\n grantees who get the specific permission. To grant permissions explicitly,\n use:

    \n
      \n
    • \n

      x-amz-grant-read

      \n
      • \n
    • \n

      x-amz-grant-write

      \n
      • \n
    • \n

      x-amz-grant-read-acp

      \n
      • \n
    • \n

      x-amz-grant-write-acp

      \n
      • \n
    • \n

      x-amz-grant-full-control

      \n
      • \n
    \n

    You specify each grantee as a type=value pair, where the type is one of\n the following:

    \n
      \n
    • \n

      \n id – if the value specified is the canonical user ID\n of an AWS account

      \n
      • \n
    • \n

      \n uri – if you are granting permissions to a predefined\n group

      \n
      • \n
    • \n

      \n emailAddress – if the value specified is the email\n address of an AWS account

      \n \n

      Using email addresses to specify a grantee is only supported in the following AWS Regions:

      \n
        \n
      • \n

        US East (N. Virginia)

        \n
        • \n
      • \n

        US West (N. California)

        \n
        • \n
      • \n

        US West (Oregon)

        \n
        • \n
      • \n

        Asia Pacific (Singapore)

        \n
        • \n
      • \n

        Asia Pacific (Sydney)

        \n
        • \n
      • \n

        Asia Pacific (Tokyo)

        \n
        • \n
      • \n

        Europe (Ireland)

        \n
        • \n
      • \n

        South America (São Paulo)

        \n
        • \n
      \n

      For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the AWS General Reference.

      \n       \n
      • \n
    \n

    For example, the following x-amz-grant-read header grants the AWS accounts identified by account IDs permissions to read object data and its metadata:

    \n

    \n x-amz-grant-read: id=\"11112222333\", id=\"444455556666\" \n

    \n
    • \n
\n\n
\n
\n\n

The following operations are related to CreateMultipartUpload:

\n ", - "smithy.api#http": { - "method": "POST", - "uri": "/{Bucket}/{Key+}?uploads", - "code": 200 - } - } - }, - "com.amazonaws.s3#CreateMultipartUploadOutput": { - "type": "structure", - "members": { - "AbortDate": { - "target": "com.amazonaws.s3#AbortDate", - "traits": { - "smithy.api#documentation": "

If the bucket has a lifecycle rule configured with an action to abort incomplete\n multipart uploads and the prefix in the lifecycle rule matches the object name in the\n request, the response includes this header. The header indicates when the initiated\n multipart upload becomes eligible for an abort operation. For more information, see \n Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy.

\n\n

The response also includes the x-amz-abort-rule-id header that provides the\n ID of the lifecycle configuration rule that defines this action.

", - "smithy.api#httpHeader": "x-amz-abort-date" - } - }, - "AbortRuleId": { - "target": "com.amazonaws.s3#AbortRuleId", - "traits": { - "smithy.api#documentation": "

This header is returned along with the x-amz-abort-date header. It\n identifies the applicable lifecycle configuration rule that defines the action to abort\n incomplete multipart uploads.

", - "smithy.api#httpHeader": "x-amz-abort-rule-id" - } - }, - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

The name of the bucket to which the multipart upload was initiated.

\n

When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.

\n

When using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.

", - "smithy.api#xmlName": "Bucket" - } - }, - "Key": { - "target": "com.amazonaws.s3#ObjectKey", - "traits": { - "smithy.api#documentation": "

Object key for which the multipart upload was initiated.

" - } - }, - "UploadId": { - "target": "com.amazonaws.s3#MultipartUploadId", - "traits": { - "smithy.api#documentation": "

ID for the initiated multipart upload.

" - } - }, - "ServerSideEncryption": { - "target": "com.amazonaws.s3#ServerSideEncryption", - "traits": { - "smithy.api#documentation": "

The server-side encryption algorithm used when storing this object in Amazon S3 (for example,\n AES256, aws:kms).

", - "smithy.api#httpHeader": "x-amz-server-side-encryption" - } - }, - "SSECustomerAlgorithm": { - "target": "com.amazonaws.s3#SSECustomerAlgorithm", - "traits": { - "smithy.api#documentation": "

If server-side encryption with a customer-provided encryption key was requested, the\n response will include this header confirming the encryption algorithm used.

", - "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-algorithm" - } - }, - "SSECustomerKeyMD5": { - "target": "com.amazonaws.s3#SSECustomerKeyMD5", - "traits": { - "smithy.api#documentation": "

If server-side encryption with a customer-provided encryption key was requested, the\n response will include this header to provide round-trip message integrity verification of\n the customer-provided encryption key.

", - "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key-MD5" - } - }, - "SSEKMSKeyId": { - "target": "com.amazonaws.s3#SSEKMSKeyId", - "traits": { - "smithy.api#documentation": "

If present, specifies the ID of the AWS Key Management Service (AWS KMS) symmetric\n customer managed customer master key (CMK) that was used for the object.

", - "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" - } - }, - "SSEKMSEncryptionContext": { - "target": "com.amazonaws.s3#SSEKMSEncryptionContext", - "traits": { - "smithy.api#documentation": "

If present, specifies the AWS KMS Encryption Context to use for object encryption. The\n value of this header is a base64-encoded UTF-8 string holding JSON with the encryption\n context key-value pairs.

", - "smithy.api#httpHeader": "x-amz-server-side-encryption-context" - } - }, - "BucketKeyEnabled": { - "target": "com.amazonaws.s3#BucketKeyEnabled", - "traits": { - "smithy.api#documentation": "

Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with AWS KMS (SSE-KMS).

", - "smithy.api#httpHeader": "x-amz-server-side-encryption-bucket-key-enabled" - } - }, - "RequestCharged": { - "target": "com.amazonaws.s3#RequestCharged", - "traits": { - "smithy.api#httpHeader": "x-amz-request-charged" - } - } - } - }, - "com.amazonaws.s3#CreateMultipartUploadRequest": { - "type": "structure", - "members": { - "ACL": { - "target": "com.amazonaws.s3#ObjectCannedACL", - "traits": { - "smithy.api#documentation": "

The canned ACL to apply to the object.

\n

This action is not supported by Amazon S3 on Outposts.

", - "smithy.api#httpHeader": "x-amz-acl" - } - }, - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

The name of the bucket to which to initiate the upload

\n

When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.

\n

When using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "CacheControl": { - "target": "com.amazonaws.s3#CacheControl", - "traits": { - "smithy.api#documentation": "

Specifies caching behavior along the request/reply chain.

", - "smithy.api#httpHeader": "Cache-Control" - } - }, - "ContentDisposition": { - "target": "com.amazonaws.s3#ContentDisposition", - "traits": { - "smithy.api#documentation": "

Specifies presentational information for the object.

", - "smithy.api#httpHeader": "Content-Disposition" - } - }, - "ContentEncoding": { - "target": "com.amazonaws.s3#ContentEncoding", - "traits": { - "smithy.api#documentation": "

Specifies what content encodings have been applied to the object and thus what decoding\n mechanisms must be applied to obtain the media-type referenced by the Content-Type header\n field.

", - "smithy.api#httpHeader": "Content-Encoding" - } - }, - "ContentLanguage": { - "target": "com.amazonaws.s3#ContentLanguage", - "traits": { - "smithy.api#documentation": "

The language the content is in.

", - "smithy.api#httpHeader": "Content-Language" - } - }, - "ContentType": { - "target": "com.amazonaws.s3#ContentType", - "traits": { - "smithy.api#documentation": "

A standard MIME type describing the format of the object data.

", - "smithy.api#httpHeader": "Content-Type" - } - }, - "Expires": { - "target": "com.amazonaws.s3#Expires", - "traits": { - "smithy.api#documentation": "

The date and time at which the object is no longer cacheable.

", - "smithy.api#httpHeader": "Expires" - } - }, - "GrantFullControl": { - "target": "com.amazonaws.s3#GrantFullControl", - "traits": { - "smithy.api#documentation": "

Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the\n object.

\n

This action is not supported by Amazon S3 on Outposts.

", - "smithy.api#httpHeader": "x-amz-grant-full-control" - } - }, - "GrantRead": { - "target": "com.amazonaws.s3#GrantRead", - "traits": { - "smithy.api#documentation": "

Allows grantee to read the object data and its\n metadata.

\n

This action is not supported by Amazon S3 on Outposts.

", - "smithy.api#httpHeader": "x-amz-grant-read" - } - }, - "GrantReadACP": { - "target": "com.amazonaws.s3#GrantReadACP", - "traits": { - "smithy.api#documentation": "

Allows grantee to read the object ACL.

\n

This action is not supported by Amazon S3 on Outposts.

", - "smithy.api#httpHeader": "x-amz-grant-read-acp" - } - }, - "GrantWriteACP": { - "target": "com.amazonaws.s3#GrantWriteACP", - "traits": { - "smithy.api#documentation": "

Allows grantee to write the ACL for the applicable\n object.

\n

This action is not supported by Amazon S3 on Outposts.

", - "smithy.api#httpHeader": "x-amz-grant-write-acp" - } - }, - "Key": { - "target": "com.amazonaws.s3#ObjectKey", - "traits": { - "smithy.api#documentation": "

Object key for which the multipart upload is to be initiated.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Metadata": { - "target": "com.amazonaws.s3#Metadata", - "traits": { - "smithy.api#documentation": "

A map of metadata to store with the object in S3.

", - "smithy.api#httpPrefixHeaders": "x-amz-meta-" - } - }, - "ServerSideEncryption": { - "target": "com.amazonaws.s3#ServerSideEncryption", - "traits": { - "smithy.api#documentation": "

The server-side encryption algorithm used when storing this object in Amazon S3 (for example,\n AES256, aws:kms).

", - "smithy.api#httpHeader": "x-amz-server-side-encryption" - } - }, - "StorageClass": { - "target": "com.amazonaws.s3#StorageClass", - "traits": { - "smithy.api#documentation": "

By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The\n STANDARD storage class provides high durability and high availability. Depending on\n performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses\n the OUTPOSTS Storage Class. For more information, see Storage Classes in the Amazon S3\n Service Developer Guide.

", - "smithy.api#httpHeader": "x-amz-storage-class" - } - }, - "WebsiteRedirectLocation": { - "target": "com.amazonaws.s3#WebsiteRedirectLocation", - "traits": { - "smithy.api#documentation": "

If the bucket is configured as a website, redirects requests for this object to another\n object in the same bucket or to an external URL. Amazon S3 stores the value of this header in\n the object metadata.

", - "smithy.api#httpHeader": "x-amz-website-redirect-location" - } - }, - "SSECustomerAlgorithm": { - "target": "com.amazonaws.s3#SSECustomerAlgorithm", - "traits": { - "smithy.api#documentation": "

Specifies the algorithm to use to when encrypting the object (for example,\n AES256).

", - "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-algorithm" - } - }, - "SSECustomerKey": { - "target": "com.amazonaws.s3#SSECustomerKey", - "traits": { - "smithy.api#documentation": "

Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This\n value is used to store the object and then it is discarded; Amazon S3 does not store the\n encryption key. The key must be appropriate for use with the algorithm specified in the\n x-amz-server-side-encryption-customer-algorithm header.

", - "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key" - } - }, - "SSECustomerKeyMD5": { - "target": "com.amazonaws.s3#SSECustomerKeyMD5", - "traits": { - "smithy.api#documentation": "

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses\n this header for a message integrity check to ensure that the encryption key was transmitted\n without error.

", - "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key-MD5" - } - }, - "SSEKMSKeyId": { - "target": "com.amazonaws.s3#SSEKMSKeyId", - "traits": { - "smithy.api#documentation": "

Specifies the ID of the symmetric customer managed AWS KMS CMK to use for object\n encryption. All GET and PUT requests for an object protected by AWS KMS will fail if not\n made via SSL or using SigV4. For information about configuring using any of the officially\n supported AWS SDKs and AWS CLI, see Specifying the Signature Version in Request Authentication\n in the Amazon S3 Developer Guide.

", - "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" - } - }, - "SSEKMSEncryptionContext": { - "target": "com.amazonaws.s3#SSEKMSEncryptionContext", - "traits": { - "smithy.api#documentation": "

Specifies the AWS KMS Encryption Context to use for object encryption. The value of this\n header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value\n pairs.

", - "smithy.api#httpHeader": "x-amz-server-side-encryption-context" - } - }, - "BucketKeyEnabled": { - "target": "com.amazonaws.s3#BucketKeyEnabled", - "traits": { - "smithy.api#documentation": "

Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using AWS KMS (SSE-KMS). Setting this header to true causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS.

\n

Specifying this header with an object operation doesn’t affect bucket-level settings for S3 Bucket Key.

", - "smithy.api#httpHeader": "x-amz-server-side-encryption-bucket-key-enabled" - } - }, - "RequestPayer": { - "target": "com.amazonaws.s3#RequestPayer", - "traits": { - "smithy.api#httpHeader": "x-amz-request-payer" - } - }, - "Tagging": { - "target": "com.amazonaws.s3#TaggingHeader", - "traits": { - "smithy.api#documentation": "

The tag-set for the object. The tag-set must be encoded as URL Query parameters.

", - "smithy.api#httpHeader": "x-amz-tagging" - } - }, - "ObjectLockMode": { - "target": "com.amazonaws.s3#ObjectLockMode", - "traits": { - "smithy.api#documentation": "

Specifies the Object Lock mode that you want to apply to the uploaded object.

", - "smithy.api#httpHeader": "x-amz-object-lock-mode" - } - }, - "ObjectLockRetainUntilDate": { - "target": "com.amazonaws.s3#ObjectLockRetainUntilDate", - "traits": { - "smithy.api#documentation": "

Specifies the date and time when you want the Object Lock to expire.

", - "smithy.api#httpHeader": "x-amz-object-lock-retain-until-date" - } - }, - "ObjectLockLegalHoldStatus": { - "target": "com.amazonaws.s3#ObjectLockLegalHoldStatus", - "traits": { - "smithy.api#documentation": "

Specifies whether you want to apply a Legal Hold to the uploaded object.

", - "smithy.api#httpHeader": "x-amz-object-lock-legal-hold" - } - }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", - "smithy.api#httpHeader": "x-amz-expected-bucket-owner" - } - } - } - }, - "com.amazonaws.s3#CreationDate": { - "type": "timestamp" - }, - "com.amazonaws.s3#Date": { - "type": "timestamp", - "traits": { - "smithy.api#timestampFormat": "date-time" - } - }, - "com.amazonaws.s3#Days": { - "type": "integer" - }, - "com.amazonaws.s3#DaysAfterInitiation": { - "type": "integer" - }, - "com.amazonaws.s3#DefaultRetention": { - "type": "structure", - "members": { - "Mode": { - "target": "com.amazonaws.s3#ObjectLockRetentionMode", - "traits": { - "smithy.api#documentation": "

The default Object Lock retention mode you want to apply to new objects placed in the\n specified bucket.

" - } - }, - "Days": { - "target": "com.amazonaws.s3#Days", - "traits": { - "smithy.api#documentation": "

The number of days that you want to specify for the default retention period.

" - } - }, - "Years": { - "target": "com.amazonaws.s3#Years", - "traits": { - "smithy.api#documentation": "

The number of years that you want to specify for the default retention period.

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

The container element for specifying the default Object Lock retention settings for new\n objects placed in the specified bucket.

" - } - }, - "com.amazonaws.s3#Delete": { - "type": "structure", - "members": { - "Objects": { - "target": "com.amazonaws.s3#ObjectIdentifierList", - "traits": { - "smithy.api#documentation": "

The objects to delete.

", - "smithy.api#required": {}, - "smithy.api#xmlFlattened": {}, - "smithy.api#xmlName": "Object" - } - }, - "Quiet": { - "target": "com.amazonaws.s3#Quiet", - "traits": { - "smithy.api#documentation": "

Element to enable quiet mode for the request. When you add this element, you must set\n its value to true.

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

Container for the objects to delete.

" - } - }, - "com.amazonaws.s3#DeleteBucket": { - "type": "operation", - "input": { - "target": "com.amazonaws.s3#DeleteBucketRequest" - }, - "traits": { - "smithy.api#documentation": "

Deletes the S3 bucket. All objects (including all object versions and delete markers) in\n the bucket must be deleted before the bucket itself can be deleted.

\n \n

\n Related Resources\n

\n ", - "smithy.api#http": { - "method": "DELETE", - "uri": "/{Bucket}", - "code": 204 - } - } - }, - "com.amazonaws.s3#DeleteBucketAnalyticsConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.s3#DeleteBucketAnalyticsConfigurationRequest" - }, - "traits": { - "smithy.api#documentation": "

Deletes an analytics configuration for the bucket (specified by the analytics\n configuration ID).

\n

To use this operation, you must have permissions to perform the\n s3:PutAnalyticsConfiguration action. The bucket owner has this permission\n by default. The bucket owner can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources.

\n\n

For information about the Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class\n Analysis.

\n\n

The following operations are related to\n DeleteBucketAnalyticsConfiguration:

\n ", - "smithy.api#http": { - "method": "DELETE", - "uri": "/{Bucket}?analytics", - "code": 204 - } - } - }, - "com.amazonaws.s3#DeleteBucketAnalyticsConfigurationRequest": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

The name of the bucket from which an analytics configuration is deleted.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Id": { - "target": "com.amazonaws.s3#AnalyticsId", - "traits": { - "smithy.api#documentation": "

The ID that identifies the analytics configuration.

", - "smithy.api#httpQuery": "id", - "smithy.api#required": {} - } - }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", - "smithy.api#httpHeader": "x-amz-expected-bucket-owner" - } - } - } - }, - "com.amazonaws.s3#DeleteBucketCors": { - "type": "operation", - "input": { - "target": "com.amazonaws.s3#DeleteBucketCorsRequest" - }, - "traits": { - "smithy.api#documentation": "

Deletes the cors configuration information set for the bucket.

\n

To use this operation, you must have permission to perform the\n s3:PutBucketCORS action. The bucket owner has this permission by default\n and can grant this permission to others.

\n

For information about cors, see Enabling\n Cross-Origin Resource Sharing in the Amazon Simple Storage Service Developer Guide.

\n \n

\n Related Resources:\n

\n ", - "smithy.api#http": { - "method": "DELETE", - "uri": "/{Bucket}?cors", - "code": 204 - } - } - }, - "com.amazonaws.s3#DeleteBucketCorsRequest": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

Specifies the bucket whose cors configuration is being deleted.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", - "smithy.api#httpHeader": "x-amz-expected-bucket-owner" - } - } - } - }, - "com.amazonaws.s3#DeleteBucketEncryption": { - "type": "operation", - "input": { - "target": "com.amazonaws.s3#DeleteBucketEncryptionRequest" - }, - "traits": { - "smithy.api#documentation": "

This implementation of the DELETE operation removes default encryption from the bucket.\n For information about the Amazon S3 default encryption feature, see Amazon S3 Default Bucket Encryption in the\n Amazon Simple Storage Service Developer Guide.

\n

To use this operation, you must have permissions to perform the\n s3:PutEncryptionConfiguration action. The bucket owner has this permission\n by default. The bucket owner can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to your Amazon S3\n Resources in the Amazon Simple Storage Service Developer Guide.

\n \n

\n Related Resources\n

\n ", - "smithy.api#http": { - "method": "DELETE", - "uri": "/{Bucket}?encryption", - "code": 204 - } - } - }, - "com.amazonaws.s3#DeleteBucketEncryptionRequest": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

The name of the bucket containing the server-side encryption configuration to\n delete.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", - "smithy.api#httpHeader": "x-amz-expected-bucket-owner" - } - } - } - }, - "com.amazonaws.s3#DeleteBucketIntelligentTieringConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.s3#DeleteBucketIntelligentTieringConfigurationRequest" - }, - "traits": { - "smithy.api#documentation": "

Deletes the S3 Intelligent-Tiering configuration from the specified bucket.

\n

The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without additional operational overhead. S3 Intelligent-Tiering delivers automatic cost savings by moving data between access tiers, when access patterns change.

\n

The S3 Intelligent-Tiering storage class is suitable for objects larger than 128 KB that you plan to store for at least 30 days. If the size of an object is less than 128 KB, it is not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the frequent access tier rates in the S3 Intelligent-Tiering storage class.

\n

If you delete an object before the end of the 30-day minimum storage duration period, you are charged for 30 days. For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.

\n

Operations related to\n DeleteBucketIntelligentTieringConfiguration include:

\n ", - "smithy.api#http": { - "method": "DELETE", - "uri": "/{Bucket}?intelligent-tiering", - "code": 204 - } - } - }, - "com.amazonaws.s3#DeleteBucketIntelligentTieringConfigurationRequest": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

The name of the Amazon S3 bucket whose configuration you want to modify or retrieve.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Id": { - "target": "com.amazonaws.s3#IntelligentTieringId", - "traits": { - "smithy.api#documentation": "

The ID used to identify the S3 Intelligent-Tiering configuration.

", - "smithy.api#httpQuery": "id", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.s3#DeleteBucketInventoryConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.s3#DeleteBucketInventoryConfigurationRequest" - }, - "traits": { - "smithy.api#documentation": "

Deletes an inventory configuration (identified by the inventory ID) from the\n bucket.

\n

To use this operation, you must have permissions to perform the\n s3:PutInventoryConfiguration action. The bucket owner has this permission\n by default. The bucket owner can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources.

\n

For information about the Amazon S3 inventory feature, see Amazon S3 Inventory.

\n

Operations related to DeleteBucketInventoryConfiguration include:

\n ", - "smithy.api#http": { - "method": "DELETE", - "uri": "/{Bucket}?inventory", - "code": 204 - } - } - }, - "com.amazonaws.s3#DeleteBucketInventoryConfigurationRequest": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

The name of the bucket containing the inventory configuration to delete.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Id": { - "target": "com.amazonaws.s3#InventoryId", - "traits": { - "smithy.api#documentation": "

The ID used to identify the inventory configuration.

", - "smithy.api#httpQuery": "id", - "smithy.api#required": {} - } - }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", - "smithy.api#httpHeader": "x-amz-expected-bucket-owner" - } - } - } - }, - "com.amazonaws.s3#DeleteBucketLifecycle": { - "type": "operation", - "input": { - "target": "com.amazonaws.s3#DeleteBucketLifecycleRequest" - }, - "traits": { - "smithy.api#documentation": "

Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all the\n lifecycle configuration rules in the lifecycle subresource associated with the bucket. Your\n objects never expire, and Amazon S3 no longer automatically deletes any objects on the basis of\n rules contained in the deleted lifecycle configuration.

\n

To use this operation, you must have permission to perform the\n s3:PutLifecycleConfiguration action. By default, the bucket owner has this\n permission and the bucket owner can grant this permission to others.

\n\n

There is usually some time lag before lifecycle configuration deletion is fully\n propagated to all the Amazon S3 systems.

\n\n

For more information about the object expiration, see Elements to\n Describe Lifecycle Actions.

\n

Related actions include:

\n ", - "smithy.api#http": { - "method": "DELETE", - "uri": "/{Bucket}?lifecycle", - "code": 204 - } - } - }, - "com.amazonaws.s3#DeleteBucketLifecycleRequest": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

The bucket name of the lifecycle to delete.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", - "smithy.api#httpHeader": "x-amz-expected-bucket-owner" - } - } - } - }, - "com.amazonaws.s3#DeleteBucketMetricsConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.s3#DeleteBucketMetricsConfigurationRequest" - }, - "traits": { - "smithy.api#documentation": "

Deletes a metrics configuration for the Amazon CloudWatch request metrics (specified by the\n metrics configuration ID) from the bucket. Note that this doesn't include the daily storage\n metrics.

\n\n

To use this operation, you must have permissions to perform the\n s3:PutMetricsConfiguration action. The bucket owner has this permission by\n default. The bucket owner can grant this permission to others. For more information about\n permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources.

\n\n

For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon CloudWatch.

\n

The following operations are related to\n DeleteBucketMetricsConfiguration:

\n ", - "smithy.api#http": { - "method": "DELETE", - "uri": "/{Bucket}?metrics", - "code": 204 - } - } - }, - "com.amazonaws.s3#DeleteBucketMetricsConfigurationRequest": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

The name of the bucket containing the metrics configuration to delete.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Id": { - "target": "com.amazonaws.s3#MetricsId", - "traits": { - "smithy.api#documentation": "

The ID used to identify the metrics configuration.

", - "smithy.api#httpQuery": "id", - "smithy.api#required": {} - } - }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", - "smithy.api#httpHeader": "x-amz-expected-bucket-owner" - } - } - } - }, - "com.amazonaws.s3#DeleteBucketOwnershipControls": { - "type": "operation", - "input": { - "target": "com.amazonaws.s3#DeleteBucketOwnershipControlsRequest" - }, - "traits": { - "smithy.api#documentation": "

Removes OwnershipControls for an Amazon S3 bucket. To use this operation, you\n must have the s3:PutBucketOwnershipControls permission. For more information\n about Amazon S3 permissions, see Specifying\n Permissions in a Policy.

\n

For information about Amazon S3 Object Ownership, see Using Object Ownership.

\n

The following operations are related to\n DeleteBucketOwnershipControls:

\n ", - "smithy.api#http": { - "method": "DELETE", - "uri": "/{Bucket}?ownershipControls", - "code": 204 - } - } - }, - "com.amazonaws.s3#DeleteBucketOwnershipControlsRequest": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

The Amazon S3 bucket whose OwnershipControls you want to delete.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", - "smithy.api#httpHeader": "x-amz-expected-bucket-owner" - } - } - } - }, - "com.amazonaws.s3#DeleteBucketPolicy": { - "type": "operation", - "input": { - "target": "com.amazonaws.s3#DeleteBucketPolicyRequest" - }, - "traits": { - "smithy.api#documentation": "

This implementation of the DELETE operation uses the policy subresource to delete the\n policy of a specified bucket. If you are using an identity other than the root user of the\n AWS account that owns the bucket, the calling identity must have the\n DeleteBucketPolicy permissions on the specified bucket and belong to the\n bucket owner's account to use this operation.

\n\n

If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a 403\n Access Denied error. If you have the correct permissions, but you're not using an\n identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not\n Allowed error.

\n\n\n \n

As a security precaution, the root user of the AWS account that owns a bucket can\n always use this operation, even if the policy explicitly denies the root user the\n ability to perform this action.

\n \n\n

For more information about bucket policies, see Using Bucket Policies and\n UserPolicies.

\n

The following operations are related to DeleteBucketPolicy\n

\n ", - "smithy.api#http": { - "method": "DELETE", - "uri": "/{Bucket}?policy", - "code": 204 - } - } - }, - "com.amazonaws.s3#DeleteBucketPolicyRequest": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

The bucket name.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", - "smithy.api#httpHeader": "x-amz-expected-bucket-owner" - } - } - } - }, - "com.amazonaws.s3#DeleteBucketReplication": { - "type": "operation", - "input": { - "target": "com.amazonaws.s3#DeleteBucketReplicationRequest" - }, - "traits": { - "smithy.api#documentation": "

Deletes the replication configuration from the bucket.

\n

To use this operation, you must have permissions to perform the\n s3:PutReplicationConfiguration action. The bucket owner has these\n permissions by default and can grant it to others. For more information about permissions,\n see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources.

\n \n

It can take a while for the deletion of a replication configuration to fully\n propagate.

\n \n\n

For information about replication configuration, see Replication in the Amazon S3 Developer\n Guide.

\n\n

The following operations are related to DeleteBucketReplication:

\n ", - "smithy.api#http": { - "method": "DELETE", - "uri": "/{Bucket}?replication", - "code": 204 - } - } - }, - "com.amazonaws.s3#DeleteBucketReplicationRequest": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

The bucket name.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", - "smithy.api#httpHeader": "x-amz-expected-bucket-owner" - } - } - } - }, - "com.amazonaws.s3#DeleteBucketRequest": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

Specifies the bucket being deleted.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", - "smithy.api#httpHeader": "x-amz-expected-bucket-owner" - } - } - } - }, - "com.amazonaws.s3#DeleteBucketTagging": { - "type": "operation", - "input": { - "target": "com.amazonaws.s3#DeleteBucketTaggingRequest" - }, - "traits": { - "smithy.api#documentation": "

Deletes the tags from the bucket.

\n\n

To use this operation, you must have permission to perform the\n s3:PutBucketTagging action. By default, the bucket owner has this\n permission and can grant this permission to others.

\n

The following operations are related to DeleteBucketTagging:

\n ", - "smithy.api#http": { - "method": "DELETE", - "uri": "/{Bucket}?tagging", - "code": 204 - } - } - }, - "com.amazonaws.s3#DeleteBucketTaggingRequest": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

The bucket that has the tag set to be removed.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", - "smithy.api#httpHeader": "x-amz-expected-bucket-owner" - } - } - } - }, - "com.amazonaws.s3#DeleteBucketWebsite": { - "type": "operation", - "input": { - "target": "com.amazonaws.s3#DeleteBucketWebsiteRequest" - }, - "traits": { - "smithy.api#documentation": "

This operation removes the website configuration for a bucket. Amazon S3 returns a 200\n OK response upon successfully deleting a website configuration on the specified\n bucket. You will get a 200 OK response if the website configuration you are\n trying to delete does not exist on the bucket. Amazon S3 returns a 404 response if\n the bucket specified in the request does not exist.

\n\n

This DELETE operation requires the S3:DeleteBucketWebsite permission. By\n default, only the bucket owner can delete the website configuration attached to a bucket.\n However, bucket owners can grant other users permission to delete the website configuration\n by writing a bucket policy granting them the S3:DeleteBucketWebsite\n permission.

\n\n

For more information about hosting websites, see Hosting Websites on Amazon S3.

\n\n

The following operations are related to DeleteBucketWebsite:

\n ", - "smithy.api#http": { - "method": "DELETE", - "uri": "/{Bucket}?website", - "code": 204 - } - } - }, - "com.amazonaws.s3#DeleteBucketWebsiteRequest": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

The bucket name for which you want to remove the website configuration.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", - "smithy.api#httpHeader": "x-amz-expected-bucket-owner" - } - } - } - }, - "com.amazonaws.s3#DeleteMarker": { - "type": "boolean" - }, - "com.amazonaws.s3#DeleteMarkerEntry": { - "type": "structure", - "members": { - "Owner": { - "target": "com.amazonaws.s3#Owner", - "traits": { - "smithy.api#documentation": "

The account that created the delete marker.>

" - } - }, - "Key": { - "target": "com.amazonaws.s3#ObjectKey", - "traits": { - "smithy.api#documentation": "

The object key.

" - } - }, - "VersionId": { - "target": "com.amazonaws.s3#ObjectVersionId", - "traits": { - "smithy.api#documentation": "

Version ID of an object.

" - } - }, - "IsLatest": { - "target": "com.amazonaws.s3#IsLatest", - "traits": { - "smithy.api#documentation": "

Specifies whether the object is (true) or is not (false) the latest version of an\n object.

" - } - }, - "LastModified": { - "target": "com.amazonaws.s3#LastModified", - "traits": { - "smithy.api#documentation": "

Date and time the object was last modified.

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

Information about the delete marker.

" - } - }, - "com.amazonaws.s3#DeleteMarkerReplication": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.s3#DeleteMarkerReplicationStatus", - "traits": { - "smithy.api#documentation": "

Indicates whether to replicate delete markers.

\n \n

Indicates whether to replicate delete markers.

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

Specifies whether Amazon S3 replicates delete markers. If you specify a Filter\n in your replication configuration, you must also include a\n DeleteMarkerReplication element. If your Filter includes a\n Tag element, the DeleteMarkerReplication\n Status must be set to Disabled, because Amazon S3 does not support replicating\n delete markers for tag-based rules. For an example configuration, see Basic Rule Configuration.

\n

For more information about delete marker replication, see Basic Rule\n Configuration.

\n \n

If you are using an earlier version of the replication configuration, Amazon S3 handles\n replication of delete markers differently. For more information, see Backward Compatibility.

\n " - } - }, - "com.amazonaws.s3#DeleteMarkerReplicationStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Enabled" - }, - { - "value": "Disabled" - } - ] - } - }, - "com.amazonaws.s3#DeleteMarkerVersionId": { - "type": "string" - }, - "com.amazonaws.s3#DeleteMarkers": { - "type": "list", - "member": { - "target": "com.amazonaws.s3#DeleteMarkerEntry" - } - }, - "com.amazonaws.s3#DeleteObject": { - "type": "operation", - "input": { - "target": "com.amazonaws.s3#DeleteObjectRequest" - }, - "output": { - "target": "com.amazonaws.s3#DeleteObjectOutput" - }, - "traits": { - "smithy.api#documentation": "

Removes the null version (if there is one) of an object and inserts a delete marker,\n which becomes the latest version of the object. If there isn't a null version, Amazon S3 does\n not remove any objects.

\n\n

To remove a specific version, you must be the bucket owner and you must use the version\n Id subresource. Using this subresource permanently deletes the version. If the object\n deleted is a delete marker, Amazon S3 sets the response header,\n x-amz-delete-marker, to true.

\n\n

If the object you want to delete is in a bucket where the bucket versioning\n configuration is MFA Delete enabled, you must include the x-amz-mfa request\n header in the DELETE versionId request. Requests that include\n x-amz-mfa must use HTTPS.

\n\n

For more information about MFA Delete, see Using MFA Delete. To see sample requests that use versioning, see Sample Request.

\n\n

You can delete objects by explicitly calling the DELETE Object API or configure its\n lifecycle (PutBucketLifecycle) to\n enable Amazon S3 to remove them for you. If you want to block users or accounts from removing or\n deleting objects from your bucket, you must deny them the s3:DeleteObject,\n s3:DeleteObjectVersion, and s3:PutLifeCycleConfiguration\n actions.

\n\n

The following operation is related to DeleteObject:

\n ", - "smithy.api#http": { - "method": "DELETE", - "uri": "/{Bucket}/{Key+}?x-id=DeleteObject", - "code": 204 - } - } - }, - "com.amazonaws.s3#DeleteObjectOutput": { - "type": "structure", - "members": { - "DeleteMarker": { - "target": "com.amazonaws.s3#DeleteMarker", - "traits": { - "smithy.api#documentation": "

Specifies whether the versioned object that was permanently deleted was (true) or was\n not (false) a delete marker.

", - "smithy.api#httpHeader": "x-amz-delete-marker" - } - }, - "VersionId": { - "target": "com.amazonaws.s3#ObjectVersionId", - "traits": { - "smithy.api#documentation": "

Returns the version ID of the delete marker created as a result of the DELETE\n operation.

", - "smithy.api#httpHeader": "x-amz-version-id" - } - }, - "RequestCharged": { - "target": "com.amazonaws.s3#RequestCharged", - "traits": { - "smithy.api#httpHeader": "x-amz-request-charged" - } - } - } - }, - "com.amazonaws.s3#DeleteObjectRequest": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

The bucket name of the bucket containing the object.

\n

When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.

\n

When using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Key": { - "target": "com.amazonaws.s3#ObjectKey", - "traits": { - "smithy.api#documentation": "

Key name of the object to delete.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "MFA": { - "target": "com.amazonaws.s3#MFA", - "traits": { - "smithy.api#documentation": "

The concatenation of the authentication device's serial number, a space, and the value\n that is displayed on your authentication device. Required to permanently delete a versioned\n object if versioning is configured with MFA delete enabled.

", - "smithy.api#httpHeader": "x-amz-mfa" - } - }, - "VersionId": { - "target": "com.amazonaws.s3#ObjectVersionId", - "traits": { - "smithy.api#documentation": "

VersionId used to reference a specific version of the object.

", - "smithy.api#httpQuery": "versionId" - } - }, - "RequestPayer": { - "target": "com.amazonaws.s3#RequestPayer", - "traits": { - "smithy.api#httpHeader": "x-amz-request-payer" - } - }, - "BypassGovernanceRetention": { - "target": "com.amazonaws.s3#BypassGovernanceRetention", - "traits": { - "smithy.api#documentation": "

Indicates whether S3 Object Lock should bypass Governance-mode restrictions to process\n this operation.

", - "smithy.api#httpHeader": "x-amz-bypass-governance-retention" - } - }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", - "smithy.api#httpHeader": "x-amz-expected-bucket-owner" - } - } - } - }, - "com.amazonaws.s3#DeleteObjectTagging": { - "type": "operation", - "input": { - "target": "com.amazonaws.s3#DeleteObjectTaggingRequest" - }, - "output": { - "target": "com.amazonaws.s3#DeleteObjectTaggingOutput" - }, - "traits": { - "smithy.api#documentation": "

Removes the entire tag set from the specified object. For more information about\n managing object tags, see Object\n Tagging.

\n\n

To use this operation, you must have permission to perform the\n s3:DeleteObjectTagging action.

\n\n

To delete tags of a specific object version, add the versionId query\n parameter in the request. You will need permission for the\n s3:DeleteObjectVersionTagging action.

\n\n

The following operations are related to\n DeleteBucketMetricsConfiguration:

\n ", - "smithy.api#http": { - "method": "DELETE", - "uri": "/{Bucket}/{Key+}?tagging", - "code": 204 - } - } - }, - "com.amazonaws.s3#DeleteObjectTaggingOutput": { - "type": "structure", - "members": { - "VersionId": { - "target": "com.amazonaws.s3#ObjectVersionId", - "traits": { - "smithy.api#documentation": "

The versionId of the object the tag-set was removed from.

", - "smithy.api#httpHeader": "x-amz-version-id" - } - } - } - }, - "com.amazonaws.s3#DeleteObjectTaggingRequest": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

The bucket name containing the objects from which to remove the tags.

\n

When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.

\n

When using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Key": { - "target": "com.amazonaws.s3#ObjectKey", - "traits": { - "smithy.api#documentation": "

Name of the object key.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "VersionId": { - "target": "com.amazonaws.s3#ObjectVersionId", - "traits": { - "smithy.api#documentation": "

The versionId of the object that the tag-set will be removed from.

", - "smithy.api#httpQuery": "versionId" - } - }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", - "smithy.api#httpHeader": "x-amz-expected-bucket-owner" - } - } - } - }, - "com.amazonaws.s3#DeleteObjects": { - "type": "operation", - "input": { - "target": "com.amazonaws.s3#DeleteObjectsRequest" - }, - "output": { - "target": "com.amazonaws.s3#DeleteObjectsOutput" - }, - "traits": { - "smithy.api#documentation": "

This operation enables you to delete multiple objects from a bucket using a single HTTP\n request. If you know the object keys that you want to delete, then this operation provides\n a suitable alternative to sending individual delete requests, reducing per-request\n overhead.

\n\n

The request contains a list of up to 1000 keys that you want to delete. In the XML, you\n provide the object key names, and optionally, version IDs if you want to delete a specific\n version of the object from a versioning-enabled bucket. For each key, Amazon S3 performs a\n delete operation and returns the result of that delete, success, or failure, in the\n response. Note that if the object specified in the request is not found, Amazon S3 returns the\n result as deleted.

\n\n

The operation supports two modes for the response: verbose and quiet. By default, the\n operation uses verbose mode in which the response includes the result of deletion of each\n key in your request. In quiet mode the response includes only keys where the delete\n operation encountered an error. For a successful deletion, the operation does not return\n any information about the delete in the response body.

\n\n

When performing this operation on an MFA Delete enabled bucket, that attempts to delete\n any versioned objects, you must include an MFA token. If you do not provide one, the entire\n request will fail, even if there are non-versioned objects you are trying to delete. If you\n provide an invalid token, whether there are versioned keys in the request or not, the\n entire Multi-Object Delete request will fail. For information about MFA Delete, see MFA\n Delete.

\n\n

Finally, the Content-MD5 header is required for all Multi-Object Delete requests. Amazon\n S3 uses the header value to ensure that your request body has not been altered in\n transit.

\n\n

The following operations are related to DeleteObjects:

\n ", - "smithy.api#http": { - "method": "POST", - "uri": "/{Bucket}?delete", - "code": 200 - }, - "smithy.api#httpChecksumRequired": {} - } - }, - "com.amazonaws.s3#DeleteObjectsOutput": { - "type": "structure", - "members": { - "Deleted": { - "target": "com.amazonaws.s3#DeletedObjects", - "traits": { - "smithy.api#documentation": "

Container element for a successful delete. It identifies the object that was\n successfully deleted.

", - "smithy.api#xmlFlattened": {} - } - }, - "RequestCharged": { - "target": "com.amazonaws.s3#RequestCharged", - "traits": { - "smithy.api#httpHeader": "x-amz-request-charged" - } - }, - "Errors": { - "target": "com.amazonaws.s3#Errors", - "traits": { - "smithy.api#documentation": "

Container for a failed delete operation that describes the object that Amazon S3 attempted to\n delete and the error it encountered.

", - "smithy.api#xmlFlattened": {}, - "smithy.api#xmlName": "Error" - } - } - } - }, - "com.amazonaws.s3#DeleteObjectsRequest": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

The bucket name containing the objects to delete.

\n

When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.

\n

When using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Delete": { - "target": "com.amazonaws.s3#Delete", - "traits": { - "smithy.api#documentation": "

Container for the request.

", - "smithy.api#httpPayload": {}, - "smithy.api#required": {} - } - }, - "MFA": { - "target": "com.amazonaws.s3#MFA", - "traits": { - "smithy.api#documentation": "

The concatenation of the authentication device's serial number, a space, and the value\n that is displayed on your authentication device. Required to permanently delete a versioned\n object if versioning is configured with MFA delete enabled.

", - "smithy.api#httpHeader": "x-amz-mfa" - } - }, - "RequestPayer": { - "target": "com.amazonaws.s3#RequestPayer", - "traits": { - "smithy.api#httpHeader": "x-amz-request-payer" - } - }, - "BypassGovernanceRetention": { - "target": "com.amazonaws.s3#BypassGovernanceRetention", - "traits": { - "smithy.api#documentation": "

Specifies whether you want to delete this object even if it has a Governance-type Object\n Lock in place. You must have sufficient permissions to perform this operation.

", - "smithy.api#httpHeader": "x-amz-bypass-governance-retention" - } - }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", - "smithy.api#httpHeader": "x-amz-expected-bucket-owner" - } - } - } - }, - "com.amazonaws.s3#DeletePublicAccessBlock": { - "type": "operation", - "input": { - "target": "com.amazonaws.s3#DeletePublicAccessBlockRequest" - }, - "traits": { - "smithy.api#documentation": "

Removes the PublicAccessBlock configuration for an Amazon S3 bucket. To use this\n operation, you must have the s3:PutBucketPublicAccessBlock permission. For\n more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources.

\n\n

The following operations are related to DeletePublicAccessBlock:

\n ", - "smithy.api#http": { - "method": "DELETE", - "uri": "/{Bucket}?publicAccessBlock", - "code": 204 - } - } - }, - "com.amazonaws.s3#DeletePublicAccessBlockRequest": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

The Amazon S3 bucket whose PublicAccessBlock configuration you want to delete.\n

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", - "smithy.api#httpHeader": "x-amz-expected-bucket-owner" - } - } - } - }, - "com.amazonaws.s3#DeletedObject": { - "type": "structure", - "members": { - "Key": { - "target": "com.amazonaws.s3#ObjectKey", - "traits": { - "smithy.api#documentation": "

The name of the deleted object.

" - } - }, - "VersionId": { - "target": "com.amazonaws.s3#ObjectVersionId", - "traits": { - "smithy.api#documentation": "

The version ID of the deleted object.

" - } - }, - "DeleteMarker": { - "target": "com.amazonaws.s3#DeleteMarker", - "traits": { - "smithy.api#documentation": "

Specifies whether the versioned object that was permanently deleted was (true) or was\n not (false) a delete marker. In a simple DELETE, this header indicates whether (true) or\n not (false) a delete marker was created.

" - } - }, - "DeleteMarkerVersionId": { - "target": "com.amazonaws.s3#DeleteMarkerVersionId", - "traits": { - "smithy.api#documentation": "

The version ID of the delete marker created as a result of the DELETE operation. If you\n delete a specific object version, the value returned by this header is the version ID of\n the object version deleted.

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

Information about the deleted object.

" - } - }, - "com.amazonaws.s3#DeletedObjects": { - "type": "list", - "member": { - "target": "com.amazonaws.s3#DeletedObject" - } - }, - "com.amazonaws.s3#Delimiter": { - "type": "string" - }, - "com.amazonaws.s3#Description": { - "type": "string" - }, - "com.amazonaws.s3#Destination": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the bucket where you want Amazon S3 to store the\n results.

", - "smithy.api#required": {} - } - }, - "Account": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "

Destination bucket owner account ID. In a cross-account scenario, if you direct Amazon S3 to\n change replica ownership to the AWS account that owns the destination bucket by specifying\n the AccessControlTranslation property, this is the account ID of the\n destination bucket owner. For more information, see Replication Additional\n Configuration: Changing the Replica Owner in the Amazon Simple Storage\n Service Developer Guide.

" - } - }, - "StorageClass": { - "target": "com.amazonaws.s3#StorageClass", - "traits": { - "smithy.api#documentation": "

The storage class to use when replicating objects, such as S3 Standard or reduced\n redundancy. By default, Amazon S3 uses the storage class of the source object to create the\n object replica.

\n

For valid values, see the StorageClass element of the PUT Bucket\n replication action in the Amazon Simple Storage Service API Reference.

" - } - }, - "AccessControlTranslation": { - "target": "com.amazonaws.s3#AccessControlTranslation", - "traits": { - "smithy.api#documentation": "

Specify this only in a cross-account scenario (where source and destination bucket\n owners are not the same), and you want to change replica ownership to the AWS account that\n owns the destination bucket. If this is not specified in the replication configuration, the\n replicas are owned by same AWS account that owns the source object.

" - } - }, - "EncryptionConfiguration": { - "target": "com.amazonaws.s3#EncryptionConfiguration", - "traits": { - "smithy.api#documentation": "

A container that provides information about encryption. If\n SourceSelectionCriteria is specified, you must specify this element.

" - } - }, - "ReplicationTime": { - "target": "com.amazonaws.s3#ReplicationTime", - "traits": { - "smithy.api#documentation": "

A container specifying S3 Replication Time Control (S3 RTC), including whether S3 RTC is enabled and the time\n when all objects and operations on objects must be replicated. Must be specified together\n with a Metrics block.

" - } - }, - "Metrics": { - "target": "com.amazonaws.s3#Metrics", - "traits": { - "smithy.api#documentation": "

A container specifying replication metrics-related settings enabling replication\n metrics and events.

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

Specifies information about where to publish analysis or configuration results for an\n Amazon S3 bucket and S3 Replication Time Control (S3 RTC).

" - } - }, - "com.amazonaws.s3#DisplayName": { - "type": "string" - }, - "com.amazonaws.s3#ETag": { - "type": "string" - }, - "com.amazonaws.s3#EmailAddress": { - "type": "string" - }, - "com.amazonaws.s3#EnableRequestProgress": { - "type": "boolean" - }, - "com.amazonaws.s3#EncodingType": { - "type": "string", - "traits": { - "smithy.api#documentation": "

Requests Amazon S3 to encode the object keys in the response and specifies the encoding\n method to use. An object key may contain any Unicode character; however, XML 1.0 parser\n cannot parse some characters, such as characters with an ASCII value from 0 to 10. For\n characters that are not supported in XML 1.0, you can add this parameter to request that\n Amazon S3 encode the keys in the response.

", - "smithy.api#enum": [ - { - "value": "url" - } - ] - } - }, - "com.amazonaws.s3#Encryption": { - "type": "structure", - "members": { - "EncryptionType": { - "target": "com.amazonaws.s3#ServerSideEncryption", - "traits": { - "smithy.api#documentation": "

The server-side encryption algorithm used when storing job results in Amazon S3 (for example,\n AES256, aws:kms).

", - "smithy.api#required": {} - } - }, - "KMSKeyId": { - "target": "com.amazonaws.s3#SSEKMSKeyId", - "traits": { - "smithy.api#documentation": "

If the encryption type is aws:kms, this optional value specifies the ID of\n the symmetric customer managed AWS KMS CMK to use for encryption of job results. Amazon S3 only\n supports symmetric CMKs. For more information, see Using Symmetric and\n Asymmetric Keys in the AWS Key Management Service Developer\n Guide.

" - } - }, - "KMSContext": { - "target": "com.amazonaws.s3#KMSContext", - "traits": { - "smithy.api#documentation": "

If the encryption type is aws:kms, this optional value can be used to\n specify the encryption context for the restore results.

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

Contains the type of server-side encryption used.

" - } - }, - "com.amazonaws.s3#EncryptionConfiguration": { - "type": "structure", - "members": { - "ReplicaKmsKeyID": { - "target": "com.amazonaws.s3#ReplicaKmsKeyID", - "traits": { - "smithy.api#documentation": "

Specifies the ID (Key ARN or Alias ARN) of the customer managed customer master key\n (CMK) stored in AWS Key Management Service (KMS) for the destination bucket. Amazon S3 uses\n this key to encrypt replica objects. Amazon S3 only supports symmetric customer managed CMKs.\n For more information, see Using Symmetric and\n Asymmetric Keys in the AWS Key Management Service Developer\n Guide.

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

Specifies encryption-related information for an Amazon S3 bucket that is a destination for\n replicated objects.

" - } - }, - "com.amazonaws.s3#End": { - "type": "long" - }, - "com.amazonaws.s3#EndEvent": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "

A message that indicates the request is complete and no more messages will be sent. You\n should not assume that the request is complete until the client receives an\n EndEvent.

" - } - }, - "com.amazonaws.s3#Error": { - "type": "structure", - "members": { - "Key": { - "target": "com.amazonaws.s3#ObjectKey", - "traits": { - "smithy.api#documentation": "

The error key.

" - } - }, - "VersionId": { - "target": "com.amazonaws.s3#ObjectVersionId", - "traits": { - "smithy.api#documentation": "

The version ID of the error.

" - } - }, - "Code": { - "target": "com.amazonaws.s3#Code", - "traits": { - "smithy.api#documentation": "

The error code is a string that uniquely identifies an error condition. It is meant to\n be read and understood by programs that detect and handle errors by type.

\n

\n Amazon S3 error codes\n

\n \n

" - } - }, - "Message": { - "target": "com.amazonaws.s3#Message", - "traits": { - "smithy.api#documentation": "

The error message contains a generic description of the error condition in English. It\n is intended for a human audience. Simple programs display the message directly to the end\n user if they encounter an error condition they don't know how or don't care to handle.\n Sophisticated programs with more exhaustive error handling and proper internationalization\n are more likely to ignore the error message.

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

Container for all error elements.

" - } - }, - "com.amazonaws.s3#ErrorDocument": { - "type": "structure", - "members": { - "Key": { - "target": "com.amazonaws.s3#ObjectKey", - "traits": { - "smithy.api#documentation": "

The object key name to use when a 4XX class error occurs.

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

The error information.

" - } - }, - "com.amazonaws.s3#Errors": { - "type": "list", - "member": { - "target": "com.amazonaws.s3#Error" - } - }, - "com.amazonaws.s3#Event": { - "type": "string", - "traits": { - "smithy.api#documentation": "

The bucket event for which to send notifications.

", - "smithy.api#enum": [ - { - "value": "s3:ReducedRedundancyLostObject" - }, - { - "value": "s3:ObjectCreated:*" - }, - { - "value": "s3:ObjectCreated:Put" - }, - { - "value": "s3:ObjectCreated:Post" - }, - { - "value": "s3:ObjectCreated:Copy" - }, - { - "value": "s3:ObjectCreated:CompleteMultipartUpload" - }, - { - "value": "s3:ObjectRemoved:*" - }, - { - "value": "s3:ObjectRemoved:Delete" - }, - { - "value": "s3:ObjectRemoved:DeleteMarkerCreated" - }, - { - "value": "s3:ObjectRestore:*" - }, - { - "value": "s3:ObjectRestore:Post" - }, - { - "value": "s3:ObjectRestore:Completed" - }, - { - "value": "s3:Replication:*" - }, - { - "value": "s3:Replication:OperationFailedReplication" - }, - { - "value": "s3:Replication:OperationNotTracked" - }, - { - "value": "s3:Replication:OperationMissedThreshold" - }, - { - "value": "s3:Replication:OperationReplicatedAfterThreshold" - } - ] - } - }, - "com.amazonaws.s3#EventList": { - "type": "list", - "member": { - "target": "com.amazonaws.s3#Event" - } - }, - "com.amazonaws.s3#ExistingObjectReplication": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.s3#ExistingObjectReplicationStatus", - "traits": { - "smithy.api#documentation": "

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

Optional configuration to replicate existing source bucket objects. For more\n information, see Replicating Existing Objects in the Amazon S3 Developer Guide.\n

" - } - }, - "com.amazonaws.s3#ExistingObjectReplicationStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Enabled" - }, - { - "value": "Disabled" - } - ] - } - }, - "com.amazonaws.s3#Expiration": { - "type": "string" - }, - "com.amazonaws.s3#ExpirationStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Enabled" - }, - { - "value": "Disabled" - } - ] - } - }, - "com.amazonaws.s3#ExpiredObjectDeleteMarker": { - "type": "boolean" - }, - "com.amazonaws.s3#Expires": { - "type": "timestamp" - }, - "com.amazonaws.s3#ExposeHeader": { - "type": "string" - }, - "com.amazonaws.s3#ExposeHeaders": { - "type": "list", - "member": { - "target": "com.amazonaws.s3#ExposeHeader" - } - }, - "com.amazonaws.s3#Expression": { - "type": "string" - }, - "com.amazonaws.s3#ExpressionType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "SQL" - } - ] - } - }, - "com.amazonaws.s3#FetchOwner": { - "type": "boolean" - }, - "com.amazonaws.s3#FieldDelimiter": { - "type": "string" - }, - "com.amazonaws.s3#FileHeaderInfo": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "USE", - "name": "USE" - }, - { - "value": "IGNORE", - "name": "IGNORE" - }, - { - "value": "NONE", - "name": "NONE" - } - ] - } - }, - "com.amazonaws.s3#FilterRule": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.s3#FilterRuleName", - "traits": { - "smithy.api#documentation": "

The object key name prefix or suffix identifying one or more objects to which the\n filtering rule applies. The maximum length is 1,024 characters. Overlapping prefixes and\n suffixes are not supported. For more information, see Configuring Event Notifications\n in the Amazon Simple Storage Service Developer Guide.

" - } - }, - "Value": { - "target": "com.amazonaws.s3#FilterRuleValue", - "traits": { - "smithy.api#documentation": "

The value that the filter searches for in object key names.

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

Specifies the Amazon S3 object key name to filter on and whether to filter on the suffix or\n prefix of the key name.

" - } - }, - "com.amazonaws.s3#FilterRuleList": { - "type": "list", - "member": { - "target": "com.amazonaws.s3#FilterRule" - }, - "traits": { - "smithy.api#documentation": "

A list of containers for the key-value pair that defines the criteria for the filter\n rule.

" - } - }, - "com.amazonaws.s3#FilterRuleName": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "prefix" - }, - { - "value": "suffix" - } - ] - } - }, - "com.amazonaws.s3#FilterRuleValue": { - "type": "string" - }, - "com.amazonaws.s3#GetBucketAccelerateConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.s3#GetBucketAccelerateConfigurationRequest" - }, - "output": { - "target": "com.amazonaws.s3#GetBucketAccelerateConfigurationOutput" - }, - "traits": { - "smithy.api#documentation": "

This implementation of the GET operation uses the accelerate subresource to\n return the Transfer Acceleration state of a bucket, which is either Enabled or\n Suspended. Amazon S3 Transfer Acceleration is a bucket-level feature that\n enables you to perform faster data transfers to and from Amazon S3.

\n

To use this operation, you must have permission to perform the\n s3:GetAccelerateConfiguration action. The bucket owner has this permission\n by default. The bucket owner can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to your Amazon S3\n Resources in the Amazon Simple Storage Service Developer Guide.

\n

You set the Transfer Acceleration state of an existing bucket to Enabled or\n Suspended by using the PutBucketAccelerateConfiguration operation.

\n

A GET accelerate request does not return a state value for a bucket that\n has no transfer acceleration state. A bucket has no Transfer Acceleration state if a state\n has never been set on the bucket.

\n \n

For more information about transfer acceleration, see Transfer Acceleration in the\n Amazon Simple Storage Service Developer Guide.

\n

\n Related Resources\n

\n ", - "smithy.api#http": { - "method": "GET", - "uri": "/{Bucket}?accelerate", - "code": 200 - } - } - }, - "com.amazonaws.s3#GetBucketAccelerateConfigurationOutput": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.s3#BucketAccelerateStatus", - "traits": { - "smithy.api#documentation": "

The accelerate configuration of the bucket.

" - } - } - } - }, - "com.amazonaws.s3#GetBucketAccelerateConfigurationRequest": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

The name of the bucket for which the accelerate configuration is retrieved.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", - "smithy.api#httpHeader": "x-amz-expected-bucket-owner" - } - } - } - }, - "com.amazonaws.s3#GetBucketAcl": { - "type": "operation", - "input": { - "target": "com.amazonaws.s3#GetBucketAclRequest" - }, - "output": { - "target": "com.amazonaws.s3#GetBucketAclOutput" - }, - "traits": { - "smithy.api#documentation": "

This implementation of the GET operation uses the acl\n subresource to return the access control list (ACL) of a bucket. To use GET to\n return the ACL of the bucket, you must have READ_ACP access to the bucket. If\n READ_ACP permission is granted to the anonymous user, you can return the\n ACL of the bucket without using an authorization header.

\n \n

\n Related Resources\n

\n ", - "smithy.api#http": { - "method": "GET", - "uri": "/{Bucket}?acl", - "code": 200 - } - } - }, - "com.amazonaws.s3#GetBucketAclOutput": { - "type": "structure", - "members": { - "Owner": { - "target": "com.amazonaws.s3#Owner", - "traits": { - "smithy.api#documentation": "

Container for the bucket owner's display name and ID.

" - } - }, - "Grants": { - "target": "com.amazonaws.s3#Grants", - "traits": { - "smithy.api#documentation": "

A list of grants.

", - "smithy.api#xmlName": "AccessControlList" - } - } - } - }, - "com.amazonaws.s3#GetBucketAclRequest": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

Specifies the S3 bucket whose ACL is being requested.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", - "smithy.api#httpHeader": "x-amz-expected-bucket-owner" - } - } - } - }, - "com.amazonaws.s3#GetBucketAnalyticsConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.s3#GetBucketAnalyticsConfigurationRequest" - }, - "output": { - "target": "com.amazonaws.s3#GetBucketAnalyticsConfigurationOutput" - }, - "traits": { - "smithy.api#documentation": "

This implementation of the GET operation returns an analytics configuration (identified\n by the analytics configuration ID) from the bucket.

\n

To use this operation, you must have permissions to perform the\n s3:GetAnalyticsConfiguration action. The bucket owner has this permission\n by default. The bucket owner can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources in the Amazon Simple Storage Service Developer Guide.

\n

For information about Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class\n Analysis in the Amazon Simple Storage Service Developer Guide.

\n \n

\n Related Resources\n

\n ", - "smithy.api#http": { - "method": "GET", - "uri": "/{Bucket}?analytics&x-id=GetBucketAnalyticsConfiguration", - "code": 200 - } - } - }, - "com.amazonaws.s3#GetBucketAnalyticsConfigurationOutput": { - "type": "structure", - "members": { - "AnalyticsConfiguration": { - "target": "com.amazonaws.s3#AnalyticsConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration and any analyses for the analytics filter.

", - "smithy.api#httpPayload": {} - } - } - } - }, - "com.amazonaws.s3#GetBucketAnalyticsConfigurationRequest": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

The name of the bucket from which an analytics configuration is retrieved.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Id": { - "target": "com.amazonaws.s3#AnalyticsId", - "traits": { - "smithy.api#documentation": "

The ID that identifies the analytics configuration.

", - "smithy.api#httpQuery": "id", - "smithy.api#required": {} - } - }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", - "smithy.api#httpHeader": "x-amz-expected-bucket-owner" - } - } - } - }, - "com.amazonaws.s3#GetBucketCors": { - "type": "operation", - "input": { - "target": "com.amazonaws.s3#GetBucketCorsRequest" - }, - "output": { - "target": "com.amazonaws.s3#GetBucketCorsOutput" - }, - "traits": { - "smithy.api#documentation": "

Returns the cors configuration information set for the bucket.

\n\n

To use this operation, you must have permission to perform the s3:GetBucketCORS action.\n By default, the bucket owner has this permission and can grant it to others.

\n\n

For more information about cors, see Enabling\n Cross-Origin Resource Sharing.

\n\n

The following operations are related to GetBucketCors:

\n ", - "smithy.api#http": { - "method": "GET", - "uri": "/{Bucket}?cors", - "code": 200 - } - } - }, - "com.amazonaws.s3#GetBucketCorsOutput": { - "type": "structure", - "members": { - "CORSRules": { - "target": "com.amazonaws.s3#CORSRules", - "traits": { - "smithy.api#documentation": "

A set of origins and methods (cross-origin access that you want to allow). You can add\n up to 100 rules to the configuration.

", - "smithy.api#xmlFlattened": {}, - "smithy.api#xmlName": "CORSRule" - } - } - } - }, - "com.amazonaws.s3#GetBucketCorsRequest": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

The bucket name for which to get the cors configuration.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", - "smithy.api#httpHeader": "x-amz-expected-bucket-owner" - } - } - } - }, - "com.amazonaws.s3#GetBucketEncryption": { - "type": "operation", - "input": { - "target": "com.amazonaws.s3#GetBucketEncryptionRequest" - }, - "output": { - "target": "com.amazonaws.s3#GetBucketEncryptionOutput" - }, - "traits": { - "smithy.api#documentation": "

Returns the default encryption configuration for an Amazon S3 bucket. For information about\n the Amazon S3 default encryption feature, see Amazon S3 Default Bucket Encryption.

\n\n

To use this operation, you must have permission to perform the\n s3:GetEncryptionConfiguration action. The bucket owner has this permission\n by default. The bucket owner can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources.

\n

The following operations are related to GetBucketEncryption:

\n ", - "smithy.api#http": { - "method": "GET", - "uri": "/{Bucket}?encryption", - "code": 200 - } - } - }, - "com.amazonaws.s3#GetBucketEncryptionOutput": { - "type": "structure", - "members": { - "ServerSideEncryptionConfiguration": { - "target": "com.amazonaws.s3#ServerSideEncryptionConfiguration", - "traits": { - "smithy.api#httpPayload": {} - } - } - } - }, - "com.amazonaws.s3#GetBucketEncryptionRequest": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

The name of the bucket from which the server-side encryption configuration is\n retrieved.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", - "smithy.api#httpHeader": "x-amz-expected-bucket-owner" - } - } - } - }, - "com.amazonaws.s3#GetBucketIntelligentTieringConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.s3#GetBucketIntelligentTieringConfigurationRequest" - }, - "output": { - "target": "com.amazonaws.s3#GetBucketIntelligentTieringConfigurationOutput" - }, - "traits": { - "smithy.api#documentation": "

Gets the S3 Intelligent-Tiering configuration from the specified bucket.

\n

The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without additional operational overhead. S3 Intelligent-Tiering delivers automatic cost savings by moving data between access tiers, when access patterns change.

\n

The S3 Intelligent-Tiering storage class is suitable for objects larger than 128 KB that you plan to store for at least 30 days. If the size of an object is less than 128 KB, it is not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the frequent access tier rates in the S3 Intelligent-Tiering storage class.

\n

If you delete an object before the end of the 30-day minimum storage duration period, you are charged for 30 days. For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.

\n

Operations related to\n GetBucketIntelligentTieringConfiguration include:

\n ", - "smithy.api#http": { - "method": "GET", - "uri": "/{Bucket}?intelligent-tiering&x-id=GetBucketIntelligentTieringConfiguration", - "code": 200 - } - } - }, - "com.amazonaws.s3#GetBucketIntelligentTieringConfigurationOutput": { - "type": "structure", - "members": { - "IntelligentTieringConfiguration": { - "target": "com.amazonaws.s3#IntelligentTieringConfiguration", - "traits": { - "smithy.api#documentation": "

Container for S3 Intelligent-Tiering configuration.

", - "smithy.api#httpPayload": {} - } - } - } - }, - "com.amazonaws.s3#GetBucketIntelligentTieringConfigurationRequest": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

The name of the Amazon S3 bucket whose configuration you want to modify or retrieve.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Id": { - "target": "com.amazonaws.s3#IntelligentTieringId", - "traits": { - "smithy.api#documentation": "

The ID used to identify the S3 Intelligent-Tiering configuration.

", - "smithy.api#httpQuery": "id", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.s3#GetBucketInventoryConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.s3#GetBucketInventoryConfigurationRequest" - }, - "output": { - "target": "com.amazonaws.s3#GetBucketInventoryConfigurationOutput" - }, - "traits": { - "smithy.api#documentation": "

Returns an inventory configuration (identified by the inventory configuration ID) from\n the bucket.

\n\n

To use this operation, you must have permissions to perform the\n s3:GetInventoryConfiguration action. The bucket owner has this permission\n by default and can grant this permission to others. For more information about permissions,\n see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources.

\n\n

For information about the Amazon S3 inventory feature, see Amazon S3 Inventory.

\n\n

The following operations are related to\n GetBucketInventoryConfiguration:

\n ", - "smithy.api#http": { - "method": "GET", - "uri": "/{Bucket}?inventory&x-id=GetBucketInventoryConfiguration", - "code": 200 - } - } - }, - "com.amazonaws.s3#GetBucketInventoryConfigurationOutput": { - "type": "structure", - "members": { - "InventoryConfiguration": { - "target": "com.amazonaws.s3#InventoryConfiguration", - "traits": { - "smithy.api#documentation": "

Specifies the inventory configuration.

", - "smithy.api#httpPayload": {} - } - } - } - }, - "com.amazonaws.s3#GetBucketInventoryConfigurationRequest": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

The name of the bucket containing the inventory configuration to retrieve.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Id": { - "target": "com.amazonaws.s3#InventoryId", - "traits": { - "smithy.api#documentation": "

The ID used to identify the inventory configuration.

", - "smithy.api#httpQuery": "id", - "smithy.api#required": {} - } - }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", - "smithy.api#httpHeader": "x-amz-expected-bucket-owner" - } - } - } - }, - "com.amazonaws.s3#GetBucketLifecycleConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.s3#GetBucketLifecycleConfigurationRequest" - }, - "output": { - "target": "com.amazonaws.s3#GetBucketLifecycleConfigurationOutput" - }, - "traits": { - "smithy.api#documentation": "\n

Bucket lifecycle configuration now supports specifying a lifecycle rule using an\n object key name prefix, one or more object tags, or a combination of both. Accordingly,\n this section describes the latest API. The response describes the new filter element\n that you can use to specify a filter to select a subset of objects to which the rule\n applies. If you are using a previous version of the lifecycle configuration, it still\n works. For the earlier API description, see GetBucketLifecycle.

\n \n

Returns the lifecycle configuration information set on the bucket. For information about\n lifecycle configuration, see Object\n Lifecycle Management.

\n\n

To use this operation, you must have permission to perform the\n s3:GetLifecycleConfiguration action. The bucket owner has this permission,\n by default. The bucket owner can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources.

\n\n

\n GetBucketLifecycleConfiguration has the following special error:

\n \n

The following operations are related to\n GetBucketLifecycleConfiguration:

\n ", - "smithy.api#http": { - "method": "GET", - "uri": "/{Bucket}?lifecycle", - "code": 200 - } - } - }, - "com.amazonaws.s3#GetBucketLifecycleConfigurationOutput": { - "type": "structure", - "members": { - "Rules": { - "target": "com.amazonaws.s3#LifecycleRules", - "traits": { - "smithy.api#documentation": "

Container for a lifecycle rule.

", - "smithy.api#xmlFlattened": {}, - "smithy.api#xmlName": "Rule" - } - } - } - }, - "com.amazonaws.s3#GetBucketLifecycleConfigurationRequest": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

The name of the bucket for which to get the lifecycle information.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", - "smithy.api#httpHeader": "x-amz-expected-bucket-owner" - } - } - } - }, - "com.amazonaws.s3#GetBucketLocation": { - "type": "operation", - "input": { - "target": "com.amazonaws.s3#GetBucketLocationRequest" - }, - "output": { - "target": "com.amazonaws.s3#GetBucketLocationOutput" - }, - "traits": { - "smithy.api#documentation": "

Returns the Region the bucket resides in. You set the bucket's Region using the\n LocationConstraint request parameter in a CreateBucket\n request. For more information, see CreateBucket.

\n\n

To use this implementation of the operation, you must be the bucket owner.

\n\n

The following operations are related to GetBucketLocation:

\n ", - "smithy.api#http": { - "method": "GET", - "uri": "/{Bucket}?location", - "code": 200 - } - } - }, - "com.amazonaws.s3#GetBucketLocationOutput": { - "type": "structure", - "members": { - "LocationConstraint": { - "target": "com.amazonaws.s3#BucketLocationConstraint", - "traits": { - "smithy.api#documentation": "

Specifies the Region where the bucket resides. For a list of all the Amazon S3 supported\n location constraints by Region, see Regions and Endpoints.\n Buckets in Region us-east-1 have a LocationConstraint of\n null.

" - } - } - } - }, - "com.amazonaws.s3#GetBucketLocationRequest": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

The name of the bucket for which to get the location.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", - "smithy.api#httpHeader": "x-amz-expected-bucket-owner" - } - } - } - }, - "com.amazonaws.s3#GetBucketLogging": { - "type": "operation", - "input": { - "target": "com.amazonaws.s3#GetBucketLoggingRequest" - }, - "output": { - "target": "com.amazonaws.s3#GetBucketLoggingOutput" - }, - "traits": { - "smithy.api#documentation": "

Returns the logging status of a bucket and the permissions users have to view and modify\n that status. To use GET, you must be the bucket owner.

\n\n

The following operations are related to GetBucketLogging:

\n ", - "smithy.api#http": { - "method": "GET", - "uri": "/{Bucket}?logging", - "code": 200 - } - } - }, - "com.amazonaws.s3#GetBucketLoggingOutput": { - "type": "structure", - "members": { - "LoggingEnabled": { - "target": "com.amazonaws.s3#LoggingEnabled" - } - } - }, - "com.amazonaws.s3#GetBucketLoggingRequest": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

The bucket name for which to get the logging information.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", - "smithy.api#httpHeader": "x-amz-expected-bucket-owner" - } - } - } - }, - "com.amazonaws.s3#GetBucketMetricsConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.s3#GetBucketMetricsConfigurationRequest" - }, - "output": { - "target": "com.amazonaws.s3#GetBucketMetricsConfigurationOutput" - }, - "traits": { - "smithy.api#documentation": "

Gets a metrics configuration (specified by the metrics configuration ID) from the\n bucket. Note that this doesn't include the daily storage metrics.

\n\n

To use this operation, you must have permissions to perform the\n s3:GetMetricsConfiguration action. The bucket owner has this permission by\n default. The bucket owner can grant this permission to others. For more information about\n permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources.

\n\n

For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon\n CloudWatch.

\n\n

The following operations are related to\n GetBucketMetricsConfiguration:

\n ", - "smithy.api#http": { - "method": "GET", - "uri": "/{Bucket}?metrics&x-id=GetBucketMetricsConfiguration", - "code": 200 - } - } - }, - "com.amazonaws.s3#GetBucketMetricsConfigurationOutput": { - "type": "structure", - "members": { - "MetricsConfiguration": { - "target": "com.amazonaws.s3#MetricsConfiguration", - "traits": { - "smithy.api#documentation": "

Specifies the metrics configuration.

", - "smithy.api#httpPayload": {} - } - } - } - }, - "com.amazonaws.s3#GetBucketMetricsConfigurationRequest": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

The name of the bucket containing the metrics configuration to retrieve.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Id": { - "target": "com.amazonaws.s3#MetricsId", - "traits": { - "smithy.api#documentation": "

The ID used to identify the metrics configuration.

", - "smithy.api#httpQuery": "id", - "smithy.api#required": {} - } - }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", - "smithy.api#httpHeader": "x-amz-expected-bucket-owner" - } - } - } - }, - "com.amazonaws.s3#GetBucketNotificationConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.s3#GetBucketNotificationConfigurationRequest" - }, - "output": { - "target": "com.amazonaws.s3#NotificationConfiguration" - }, - "traits": { - "smithy.api#documentation": "

Returns the notification configuration of a bucket.

\n

If notifications are not enabled on the bucket, the operation returns an empty\n NotificationConfiguration element.

\n\n

By default, you must be the bucket owner to read the notification configuration of a\n bucket. However, the bucket owner can use a bucket policy to grant permission to other\n users to read this configuration with the s3:GetBucketNotification\n permission.

\n\n

For more information about setting and reading the notification configuration on a\n bucket, see Setting Up Notification of\n Bucket Events. For more information about bucket policies, see Using Bucket Policies.

\n\n

The following operation is related to GetBucketNotification:

\n ", - "smithy.api#http": { - "method": "GET", - "uri": "/{Bucket}?notification", - "code": 200 - } - } - }, - "com.amazonaws.s3#GetBucketNotificationConfigurationRequest": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

The name of the bucket for which to get the notification configuration.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", - "smithy.api#httpHeader": "x-amz-expected-bucket-owner" - } - } - } - }, - "com.amazonaws.s3#GetBucketOwnershipControls": { - "type": "operation", - "input": { - "target": "com.amazonaws.s3#GetBucketOwnershipControlsRequest" - }, - "output": { - "target": "com.amazonaws.s3#GetBucketOwnershipControlsOutput" - }, - "traits": { - "smithy.api#documentation": "

Retrieves OwnershipControls for an Amazon S3 bucket. To use this operation, you\n must have the s3:GetBucketOwnershipControls permission. For more information\n about Amazon S3 permissions, see Specifying\n Permissions in a Policy.

\n

For information about Amazon S3 Object Ownership, see Using Object Ownership.

\n

The following operations are related to GetBucketOwnershipControls:

\n ", - "smithy.api#http": { - "method": "GET", - "uri": "/{Bucket}?ownershipControls", - "code": 200 - } - } - }, - "com.amazonaws.s3#GetBucketOwnershipControlsOutput": { - "type": "structure", - "members": { - "OwnershipControls": { - "target": "com.amazonaws.s3#OwnershipControls", - "traits": { - "smithy.api#documentation": "

The OwnershipControls (BucketOwnerPreferred or ObjectWriter) currently in\n effect for this Amazon S3 bucket.

", - "smithy.api#httpPayload": {} - } - } - } - }, - "com.amazonaws.s3#GetBucketOwnershipControlsRequest": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

The name of the Amazon S3 bucket whose OwnershipControls you want to retrieve.\n

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", - "smithy.api#httpHeader": "x-amz-expected-bucket-owner" - } - } - } - }, - "com.amazonaws.s3#GetBucketPolicy": { - "type": "operation", - "input": { - "target": "com.amazonaws.s3#GetBucketPolicyRequest" - }, - "output": { - "target": "com.amazonaws.s3#GetBucketPolicyOutput" - }, - "traits": { - "smithy.api#documentation": "

Returns the policy of a specified bucket. If you are using an identity other than the\n root user of the AWS account that owns the bucket, the calling identity must have the\n GetBucketPolicy permissions on the specified bucket and belong to the\n bucket owner's account in order to use this operation.

\n\n

If you don't have GetBucketPolicy permissions, Amazon S3 returns a 403\n Access Denied error. If you have the correct permissions, but you're not using an\n identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not\n Allowed error.

\n\n \n

As a security precaution, the root user of the AWS account that owns a bucket can\n always use this operation, even if the policy explicitly denies the root user the\n ability to perform this action.

\n \n\n

For more information about bucket policies, see Using Bucket Policies and User\n Policies.

\n\n

The following operation is related to GetBucketPolicy:

\n ", - "smithy.api#http": { - "method": "GET", - "uri": "/{Bucket}?policy", - "code": 200 - } - } - }, - "com.amazonaws.s3#GetBucketPolicyOutput": { - "type": "structure", - "members": { - "Policy": { - "target": "com.amazonaws.s3#Policy", - "traits": { - "smithy.api#documentation": "

The bucket policy as a JSON document.

" - } - } - } - }, - "com.amazonaws.s3#GetBucketPolicyRequest": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

The bucket name for which to get the bucket policy.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", - "smithy.api#httpHeader": "x-amz-expected-bucket-owner" - } - } - } - }, - "com.amazonaws.s3#GetBucketPolicyStatus": { - "type": "operation", - "input": { - "target": "com.amazonaws.s3#GetBucketPolicyStatusRequest" - }, - "output": { - "target": "com.amazonaws.s3#GetBucketPolicyStatusOutput" - }, - "traits": { - "smithy.api#documentation": "

Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket is public.\n In order to use this operation, you must have the s3:GetBucketPolicyStatus\n permission. For more information about Amazon S3 permissions, see Specifying Permissions in a\n Policy.

\n\n

For more information about when Amazon S3 considers a bucket public, see The Meaning of \"Public\".

\n\n

The following operations are related to GetBucketPolicyStatus:

\n ", - "smithy.api#http": { - "method": "GET", - "uri": "/{Bucket}?policyStatus", - "code": 200 - } - } - }, - "com.amazonaws.s3#GetBucketPolicyStatusOutput": { - "type": "structure", - "members": { - "PolicyStatus": { - "target": "com.amazonaws.s3#PolicyStatus", - "traits": { - "smithy.api#documentation": "

The policy status for the specified bucket.

", - "smithy.api#httpPayload": {} - } - } - } - }, - "com.amazonaws.s3#GetBucketPolicyStatusRequest": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

The name of the Amazon S3 bucket whose policy status you want to retrieve.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", - "smithy.api#httpHeader": "x-amz-expected-bucket-owner" - } - } - } - }, - "com.amazonaws.s3#GetBucketReplication": { - "type": "operation", - "input": { - "target": "com.amazonaws.s3#GetBucketReplicationRequest" - }, - "output": { - "target": "com.amazonaws.s3#GetBucketReplicationOutput" - }, - "traits": { - "smithy.api#documentation": "

Returns the replication configuration of a bucket.

\n \n

It can take a while to propagate the put or delete a replication configuration to\n all Amazon S3 systems. Therefore, a get request soon after put or delete can return a wrong\n result.

\n \n

For information about replication configuration, see Replication in the\n Amazon Simple Storage Service Developer Guide.

\n\n

This operation requires permissions for the s3:GetReplicationConfiguration\n action. For more information about permissions, see Using Bucket Policies and User\n Policies.

\n\n

If you include the Filter element in a replication configuration, you must\n also include the DeleteMarkerReplication and Priority elements.\n The response also returns those elements.

\n\n

For information about GetBucketReplication errors, see List of\n replication-related error codes\n

\n\n\n

The following operations are related to GetBucketReplication:

\n ", - "smithy.api#http": { - "method": "GET", - "uri": "/{Bucket}?replication", - "code": 200 - } - } - }, - "com.amazonaws.s3#GetBucketReplicationOutput": { - "type": "structure", - "members": { - "ReplicationConfiguration": { - "target": "com.amazonaws.s3#ReplicationConfiguration", - "traits": { - "smithy.api#httpPayload": {} - } - } - } - }, - "com.amazonaws.s3#GetBucketReplicationRequest": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

The bucket name for which to get the replication information.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", - "smithy.api#httpHeader": "x-amz-expected-bucket-owner" - } - } - } - }, - "com.amazonaws.s3#GetBucketRequestPayment": { - "type": "operation", - "input": { - "target": "com.amazonaws.s3#GetBucketRequestPaymentRequest" - }, - "output": { - "target": "com.amazonaws.s3#GetBucketRequestPaymentOutput" - }, - "traits": { - "smithy.api#documentation": "

Returns the request payment configuration of a bucket. To use this version of the\n operation, you must be the bucket owner. For more information, see Requester Pays Buckets.

\n\n

The following operations are related to GetBucketRequestPayment:

\n ", - "smithy.api#http": { - "method": "GET", - "uri": "/{Bucket}?requestPayment", - "code": 200 - } - } - }, - "com.amazonaws.s3#GetBucketRequestPaymentOutput": { - "type": "structure", - "members": { - "Payer": { - "target": "com.amazonaws.s3#Payer", - "traits": { - "smithy.api#documentation": "

Specifies who pays for the download and request fees.

" - } - } - } - }, - "com.amazonaws.s3#GetBucketRequestPaymentRequest": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

The name of the bucket for which to get the payment request configuration

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", - "smithy.api#httpHeader": "x-amz-expected-bucket-owner" - } - } - } - }, - "com.amazonaws.s3#GetBucketTagging": { - "type": "operation", - "input": { - "target": "com.amazonaws.s3#GetBucketTaggingRequest" - }, - "output": { - "target": "com.amazonaws.s3#GetBucketTaggingOutput" - }, - "traits": { - "smithy.api#documentation": "

Returns the tag set associated with the bucket.

\n

To use this operation, you must have permission to perform the\n s3:GetBucketTagging action. By default, the bucket owner has this\n permission and can grant this permission to others.

\n\n

\n GetBucketTagging has the following special error:

\n \n\n

The following operations are related to GetBucketTagging:

\n ", - "smithy.api#http": { - "method": "GET", - "uri": "/{Bucket}?tagging", - "code": 200 - } - } - }, - "com.amazonaws.s3#GetBucketTaggingOutput": { - "type": "structure", - "members": { - "TagSet": { - "target": "com.amazonaws.s3#TagSet", - "traits": { - "smithy.api#documentation": "

Contains the tag set.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.s3#GetBucketTaggingRequest": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

The name of the bucket for which to get the tagging information.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", - "smithy.api#httpHeader": "x-amz-expected-bucket-owner" - } - } - } - }, - "com.amazonaws.s3#GetBucketVersioning": { - "type": "operation", - "input": { - "target": "com.amazonaws.s3#GetBucketVersioningRequest" - }, - "output": { - "target": "com.amazonaws.s3#GetBucketVersioningOutput" - }, - "traits": { - "smithy.api#documentation": "

Returns the versioning state of a bucket.

\n

To retrieve the versioning state of a bucket, you must be the bucket owner.

\n\n

This implementation also returns the MFA Delete status of the versioning state. If the\n MFA Delete status is enabled, the bucket owner must use an authentication\n device to change the versioning state of the bucket.

\n\n

The following operations are related to GetBucketVersioning:

\n ", - "smithy.api#http": { - "method": "GET", - "uri": "/{Bucket}?versioning", - "code": 200 - } - } - }, - "com.amazonaws.s3#GetBucketVersioningOutput": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.s3#BucketVersioningStatus", - "traits": { - "smithy.api#documentation": "

The versioning state of the bucket.

" - } - }, - "MFADelete": { - "target": "com.amazonaws.s3#MFADeleteStatus", - "traits": { - "smithy.api#documentation": "

Specifies whether MFA delete is enabled in the bucket versioning configuration. This\n element is only returned if the bucket has been configured with MFA delete. If the bucket\n has never been so configured, this element is not returned.

", - "smithy.api#xmlName": "MfaDelete" - } - } - } - }, - "com.amazonaws.s3#GetBucketVersioningRequest": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

The name of the bucket for which to get the versioning information.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", - "smithy.api#httpHeader": "x-amz-expected-bucket-owner" - } - } - } - }, - "com.amazonaws.s3#GetBucketWebsite": { - "type": "operation", - "input": { - "target": "com.amazonaws.s3#GetBucketWebsiteRequest" - }, - "output": { - "target": "com.amazonaws.s3#GetBucketWebsiteOutput" - }, - "traits": { - "smithy.api#documentation": "

Returns the website configuration for a bucket. To host website on Amazon S3, you can\n configure a bucket as website by adding a website configuration. For more information about\n hosting websites, see Hosting Websites on\n Amazon S3.

\n

This GET operation requires the S3:GetBucketWebsite permission. By default,\n only the bucket owner can read the bucket website configuration. However, bucket owners can\n allow other users to read the website configuration by writing a bucket policy granting\n them the S3:GetBucketWebsite permission.

\n

The following operations are related to DeleteBucketWebsite:

\n ", - "smithy.api#http": { - "method": "GET", - "uri": "/{Bucket}?website", - "code": 200 - } - } - }, - "com.amazonaws.s3#GetBucketWebsiteOutput": { - "type": "structure", - "members": { - "RedirectAllRequestsTo": { - "target": "com.amazonaws.s3#RedirectAllRequestsTo", - "traits": { - "smithy.api#documentation": "

Specifies the redirect behavior of all requests to a website endpoint of an Amazon S3\n bucket.

" - } - }, - "IndexDocument": { - "target": "com.amazonaws.s3#IndexDocument", - "traits": { - "smithy.api#documentation": "

The name of the index document for the website (for example\n index.html).

" - } - }, - "ErrorDocument": { - "target": "com.amazonaws.s3#ErrorDocument", - "traits": { - "smithy.api#documentation": "

The object key name of the website error document to use for 4XX class errors.

" - } - }, - "RoutingRules": { - "target": "com.amazonaws.s3#RoutingRules", - "traits": { - "smithy.api#documentation": "

Rules that define when a redirect is applied and the redirect behavior.

" - } - } - } - }, - "com.amazonaws.s3#GetBucketWebsiteRequest": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

The bucket name for which to get the website configuration.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", - "smithy.api#httpHeader": "x-amz-expected-bucket-owner" - } - } - } - }, - "com.amazonaws.s3#GetObject": { - "type": "operation", - "input": { - "target": "com.amazonaws.s3#GetObjectRequest" - }, - "output": { - "target": "com.amazonaws.s3#GetObjectOutput" - }, - "errors": [ - { - "target": "com.amazonaws.s3#InvalidObjectState" - }, - { - "target": "com.amazonaws.s3#NoSuchKey" - } - ], - "traits": { - "smithy.api#documentation": "

Retrieves objects from Amazon S3. To use GET, you must have READ\n access to the object. If you grant READ access to the anonymous user, you can\n return the object without using an authorization header.

\n\n

An Amazon S3 bucket has no directory hierarchy such as you would find in a typical computer\n file system. You can, however, create a logical hierarchy by using object key names that\n imply a folder structure. For example, instead of naming an object sample.jpg,\n you can name it photos/2006/February/sample.jpg.

\n\n

To get an object from such a logical hierarchy, specify the full key name for the object\n in the GET operation. For a virtual hosted-style request example, if you have\n the object photos/2006/February/sample.jpg, specify the resource as\n /photos/2006/February/sample.jpg. For a path-style request example, if you\n have the object photos/2006/February/sample.jpg in the bucket named\n examplebucket, specify the resource as\n /examplebucket/photos/2006/February/sample.jpg. For more information about\n request types, see HTTP Host Header Bucket Specification.

\n\n

To distribute large files to many people, you can save bandwidth costs by using\n BitTorrent. For more information, see Amazon S3\n Torrent. For more information about returning the ACL of an object, see GetObjectAcl.

\n\n

If the object you are retrieving is stored in the S3 Glacier or\n S3 Glacier Deep Archive storage class, or S3 Intelligent-Tiering Archive or\n S3 Intelligent-Tiering Deep Archive tiers, before you can retrieve the object you must first restore a\n copy using RestoreObject. Otherwise, this operation returns an\n InvalidObjectStateError error. For information about restoring archived\n objects, see Restoring Archived\n Objects.

\n\n

Encryption request headers, like x-amz-server-side-encryption, should not\n be sent for GET requests if your object uses server-side encryption with CMKs stored in AWS\n KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption keys (SSE-S3). If your\n object does use these types of keys, you’ll get an HTTP 400 BadRequest error.

\n

If you encrypt an object by using server-side encryption with customer-provided\n encryption keys (SSE-C) when you store the object in Amazon S3, then when you GET the object,\n you must use the following headers:

\n \n

For more information about SSE-C, see Server-Side Encryption (Using\n Customer-Provided Encryption Keys).

\n\n

Assuming you have permission to read object tags (permission for the\n s3:GetObjectVersionTagging action), the response also returns the\n x-amz-tagging-count header that provides the count of number of tags\n associated with the object. You can use GetObjectTagging to retrieve\n the tag set associated with an object.

\n\n

\n Permissions\n

\n

You need the s3:GetObject permission for this operation. For more\n information, see Specifying Permissions\n in a Policy. If the object you request does not exist, the error Amazon S3 returns\n depends on whether you also have the s3:ListBucket permission.

\n \n\n\n

\n Versioning\n

\n

By default, the GET operation returns the current version of an object. To return a\n different version, use the versionId subresource.

\n\n \n

If the current version of the object is a delete marker, Amazon S3 behaves as if the\n object was deleted and includes x-amz-delete-marker: true in the\n response.

\n \n\n\n

For more information about versioning, see PutBucketVersioning.

\n\n

\n Overriding Response Header Values\n

\n

There are times when you want to override certain response header values in a GET\n response. For example, you might override the Content-Disposition response header value in\n your GET request.

\n\n

You can override values for a set of response headers using the following query\n parameters. These response header values are sent only on a successful request, that is,\n when status code 200 OK is returned. The set of headers you can override using these\n parameters is a subset of the headers that Amazon S3 accepts when you create an object. The\n response headers that you can override for the GET response are Content-Type,\n Content-Language, Expires, Cache-Control,\n Content-Disposition, and Content-Encoding. To override these\n header values in the GET response, you use the following request parameters.

\n\n \n

You must sign the request, either using an Authorization header or a presigned URL,\n when using these parameters. They cannot be used with an unsigned (anonymous)\n request.

\n \n \n\n

\n Additional Considerations about Request Headers\n

\n\n

If both of the If-Match and If-Unmodified-Since headers are\n present in the request as follows: If-Match condition evaluates to\n true, and; If-Unmodified-Since condition evaluates to\n false; then, S3 returns 200 OK and the data requested.

\n\n

If both of the If-None-Match and If-Modified-Since headers are\n present in the request as follows: If-None-Match condition evaluates to\n false, and; If-Modified-Since condition evaluates to\n true; then, S3 returns 304 Not Modified response code.

\n\n

For more information about conditional requests, see RFC 7232.

\n\n

The following operations are related to GetObject:

\n ", - "smithy.api#http": { - "method": "GET", - "uri": "/{Bucket}/{Key+}?x-id=GetObject", - "code": 200 - } - } - }, - "com.amazonaws.s3#GetObjectAcl": { - "type": "operation", - "input": { - "target": "com.amazonaws.s3#GetObjectAclRequest" - }, - "output": { - "target": "com.amazonaws.s3#GetObjectAclOutput" - }, - "errors": [ - { - "target": "com.amazonaws.s3#NoSuchKey" - } - ], - "traits": { - "smithy.api#documentation": "

Returns the access control list (ACL) of an object. To use this operation, you must have\n READ_ACP access to the object.

\n

This action is not supported by Amazon S3 on Outposts.

\n

\n Versioning\n

\n

By default, GET returns ACL information about the current version of an object. To\n return ACL information about a different version, use the versionId subresource.

\n\n

The following operations are related to GetObjectAcl:

\n ", - "smithy.api#http": { - "method": "GET", - "uri": "/{Bucket}/{Key+}?acl", - "code": 200 - } - } - }, - "com.amazonaws.s3#GetObjectAclOutput": { - "type": "structure", - "members": { - "Owner": { - "target": "com.amazonaws.s3#Owner", - "traits": { - "smithy.api#documentation": "

Container for the bucket owner's display name and ID.

" - } - }, - "Grants": { - "target": "com.amazonaws.s3#Grants", - "traits": { - "smithy.api#documentation": "

A list of grants.

", - "smithy.api#xmlName": "AccessControlList" - } - }, - "RequestCharged": { - "target": "com.amazonaws.s3#RequestCharged", - "traits": { - "smithy.api#httpHeader": "x-amz-request-charged" - } - } - } - }, - "com.amazonaws.s3#GetObjectAclRequest": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

The bucket name that contains the object for which to get the ACL information.

\n

When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Key": { - "target": "com.amazonaws.s3#ObjectKey", - "traits": { - "smithy.api#documentation": "

The key of the object for which to get the ACL information.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "VersionId": { - "target": "com.amazonaws.s3#ObjectVersionId", - "traits": { - "smithy.api#documentation": "

VersionId used to reference a specific version of the object.

", - "smithy.api#httpQuery": "versionId" - } - }, - "RequestPayer": { - "target": "com.amazonaws.s3#RequestPayer", - "traits": { - "smithy.api#httpHeader": "x-amz-request-payer" - } - }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", - "smithy.api#httpHeader": "x-amz-expected-bucket-owner" - } - } - } - }, - "com.amazonaws.s3#GetObjectLegalHold": { - "type": "operation", - "input": { - "target": "com.amazonaws.s3#GetObjectLegalHoldRequest" - }, - "output": { - "target": "com.amazonaws.s3#GetObjectLegalHoldOutput" - }, - "traits": { - "smithy.api#documentation": "

Gets an object's current Legal Hold status. For more information, see Locking Objects.

\n

This action is not supported by Amazon S3 on Outposts.

", - "smithy.api#http": { - "method": "GET", - "uri": "/{Bucket}/{Key+}?legal-hold", - "code": 200 - } - } - }, - "com.amazonaws.s3#GetObjectLegalHoldOutput": { - "type": "structure", - "members": { - "LegalHold": { - "target": "com.amazonaws.s3#ObjectLockLegalHold", - "traits": { - "smithy.api#documentation": "

The current Legal Hold status for the specified object.

", - "smithy.api#httpPayload": {} - } - } - } - }, - "com.amazonaws.s3#GetObjectLegalHoldRequest": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

The bucket name containing the object whose Legal Hold status you want to retrieve.

\n

When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Key": { - "target": "com.amazonaws.s3#ObjectKey", - "traits": { - "smithy.api#documentation": "

The key name for the object whose Legal Hold status you want to retrieve.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "VersionId": { - "target": "com.amazonaws.s3#ObjectVersionId", - "traits": { - "smithy.api#documentation": "

The version ID of the object whose Legal Hold status you want to retrieve.

", - "smithy.api#httpQuery": "versionId" - } - }, - "RequestPayer": { - "target": "com.amazonaws.s3#RequestPayer", - "traits": { - "smithy.api#httpHeader": "x-amz-request-payer" - } - }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", - "smithy.api#httpHeader": "x-amz-expected-bucket-owner" - } - } - } - }, - "com.amazonaws.s3#GetObjectLockConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.s3#GetObjectLockConfigurationRequest" - }, - "output": { - "target": "com.amazonaws.s3#GetObjectLockConfigurationOutput" - }, - "traits": { - "smithy.api#documentation": "

Gets the Object Lock configuration for a bucket. The rule specified in the Object Lock\n configuration will be applied by default to every new object placed in the specified\n bucket. For more information, see Locking\n Objects.

", - "smithy.api#http": { - "method": "GET", - "uri": "/{Bucket}?object-lock", - "code": 200 - } - } - }, - "com.amazonaws.s3#GetObjectLockConfigurationOutput": { - "type": "structure", - "members": { - "ObjectLockConfiguration": { - "target": "com.amazonaws.s3#ObjectLockConfiguration", - "traits": { - "smithy.api#documentation": "

The specified bucket's Object Lock configuration.

", - "smithy.api#httpPayload": {} - } - } - } - }, - "com.amazonaws.s3#GetObjectLockConfigurationRequest": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

The bucket whose Object Lock configuration you want to retrieve.

\n

When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", - "smithy.api#httpHeader": "x-amz-expected-bucket-owner" - } - } - } - }, - "com.amazonaws.s3#GetObjectOutput": { - "type": "structure", - "members": { - "Body": { - "target": "com.amazonaws.s3#StreamingBlob", - "traits": { - "smithy.api#documentation": "

Object data.

", - "smithy.api#httpPayload": {} - } - }, - "DeleteMarker": { - "target": "com.amazonaws.s3#DeleteMarker", - "traits": { - "smithy.api#documentation": "

Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If\n false, this response header does not appear in the response.

", - "smithy.api#httpHeader": "x-amz-delete-marker" - } - }, - "AcceptRanges": { - "target": "com.amazonaws.s3#AcceptRanges", - "traits": { - "smithy.api#documentation": "

Indicates that a range of bytes was specified.

", - "smithy.api#httpHeader": "accept-ranges" - } - }, - "Expiration": { - "target": "com.amazonaws.s3#Expiration", - "traits": { - "smithy.api#documentation": "

If the object expiration is configured (see PUT Bucket lifecycle), the response includes\n this header. It includes the expiry-date and rule-id key-value pairs providing object\n expiration information. The value of the rule-id is URL encoded.

", - "smithy.api#httpHeader": "x-amz-expiration" - } - }, - "Restore": { - "target": "com.amazonaws.s3#Restore", - "traits": { - "smithy.api#documentation": "

Provides information about object restoration operation and expiration time of the\n restored object copy.

", - "smithy.api#httpHeader": "x-amz-restore" - } - }, - "LastModified": { - "target": "com.amazonaws.s3#LastModified", - "traits": { - "smithy.api#documentation": "

Last modified date of the object

", - "smithy.api#httpHeader": "Last-Modified" - } - }, - "ContentLength": { - "target": "com.amazonaws.s3#ContentLength", - "traits": { - "smithy.api#documentation": "

Size of the body in bytes.

", - "smithy.api#httpHeader": "Content-Length" - } - }, - "ETag": { - "target": "com.amazonaws.s3#ETag", - "traits": { - "smithy.api#documentation": "

An ETag is an opaque identifier assigned by a web server to a specific version of a\n resource found at a URL.

", - "smithy.api#httpHeader": "ETag" - } - }, - "MissingMeta": { - "target": "com.amazonaws.s3#MissingMeta", - "traits": { - "smithy.api#documentation": "

This is set to the number of metadata entries not returned in x-amz-meta\n headers. This can happen if you create metadata using an API like SOAP that supports more\n flexible metadata than the REST API. For example, using SOAP, you can create metadata whose\n values are not legal HTTP headers.

", - "smithy.api#httpHeader": "x-amz-missing-meta" - } - }, - "VersionId": { - "target": "com.amazonaws.s3#ObjectVersionId", - "traits": { - "smithy.api#documentation": "

Version of the object.

", - "smithy.api#httpHeader": "x-amz-version-id" - } - }, - "CacheControl": { - "target": "com.amazonaws.s3#CacheControl", - "traits": { - "smithy.api#documentation": "

Specifies caching behavior along the request/reply chain.

", - "smithy.api#httpHeader": "Cache-Control" - } - }, - "ContentDisposition": { - "target": "com.amazonaws.s3#ContentDisposition", - "traits": { - "smithy.api#documentation": "

Specifies presentational information for the object.

", - "smithy.api#httpHeader": "Content-Disposition" - } - }, - "ContentEncoding": { - "target": "com.amazonaws.s3#ContentEncoding", - "traits": { - "smithy.api#documentation": "

Specifies what content encodings have been applied to the object and thus what decoding\n mechanisms must be applied to obtain the media-type referenced by the Content-Type header\n field.

", - "smithy.api#httpHeader": "Content-Encoding" - } - }, - "ContentLanguage": { - "target": "com.amazonaws.s3#ContentLanguage", - "traits": { - "smithy.api#documentation": "

The language the content is in.

", - "smithy.api#httpHeader": "Content-Language" - } - }, - "ContentRange": { - "target": "com.amazonaws.s3#ContentRange", - "traits": { - "smithy.api#documentation": "

The portion of the object returned in the response.

", - "smithy.api#httpHeader": "Content-Range" - } - }, - "ContentType": { - "target": "com.amazonaws.s3#ContentType", - "traits": { - "smithy.api#documentation": "

A standard MIME type describing the format of the object data.

", - "smithy.api#httpHeader": "Content-Type" - } - }, - "Expires": { - "target": "com.amazonaws.s3#Expires", - "traits": { - "smithy.api#documentation": "

The date and time at which the object is no longer cacheable.

", - "smithy.api#httpHeader": "Expires" - } - }, - "WebsiteRedirectLocation": { - "target": "com.amazonaws.s3#WebsiteRedirectLocation", - "traits": { - "smithy.api#documentation": "

If the bucket is configured as a website, redirects requests for this object to another\n object in the same bucket or to an external URL. Amazon S3 stores the value of this header in\n the object metadata.

", - "smithy.api#httpHeader": "x-amz-website-redirect-location" - } - }, - "ServerSideEncryption": { - "target": "com.amazonaws.s3#ServerSideEncryption", - "traits": { - "smithy.api#documentation": "

The server-side encryption algorithm used when storing this object in Amazon S3 (for example,\n AES256, aws:kms).

", - "smithy.api#httpHeader": "x-amz-server-side-encryption" - } - }, - "Metadata": { - "target": "com.amazonaws.s3#Metadata", - "traits": { - "smithy.api#documentation": "

A map of metadata to store with the object in S3.

", - "smithy.api#httpPrefixHeaders": "x-amz-meta-" - } - }, - "SSECustomerAlgorithm": { - "target": "com.amazonaws.s3#SSECustomerAlgorithm", - "traits": { - "smithy.api#documentation": "

If server-side encryption with a customer-provided encryption key was requested, the\n response will include this header confirming the encryption algorithm used.

", - "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-algorithm" - } - }, - "SSECustomerKeyMD5": { - "target": "com.amazonaws.s3#SSECustomerKeyMD5", - "traits": { - "smithy.api#documentation": "

If server-side encryption with a customer-provided encryption key was requested, the\n response will include this header to provide round-trip message integrity verification of\n the customer-provided encryption key.

", - "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key-MD5" - } - }, - "SSEKMSKeyId": { - "target": "com.amazonaws.s3#SSEKMSKeyId", - "traits": { - "smithy.api#documentation": "

If present, specifies the ID of the AWS Key Management Service (AWS KMS) symmetric\n customer managed customer master key (CMK) that was used for the object.

", - "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" - } - }, - "BucketKeyEnabled": { - "target": "com.amazonaws.s3#BucketKeyEnabled", - "traits": { - "smithy.api#documentation": "

Indicates whether the object uses an S3 Bucket Key for server-side encryption with AWS KMS (SSE-KMS).

", - "smithy.api#httpHeader": "x-amz-server-side-encryption-bucket-key-enabled" - } - }, - "StorageClass": { - "target": "com.amazonaws.s3#StorageClass", - "traits": { - "smithy.api#documentation": "

Provides storage class information of the object. Amazon S3 returns this header for all\n objects except for S3 Standard storage class objects.

", - "smithy.api#httpHeader": "x-amz-storage-class" - } - }, - "RequestCharged": { - "target": "com.amazonaws.s3#RequestCharged", - "traits": { - "smithy.api#httpHeader": "x-amz-request-charged" - } - }, - "ReplicationStatus": { - "target": "com.amazonaws.s3#ReplicationStatus", - "traits": { - "smithy.api#documentation": "

Amazon S3 can return this if your request involves a bucket that is either a source or\n destination in a replication rule.

", - "smithy.api#httpHeader": "x-amz-replication-status" - } - }, - "PartsCount": { - "target": "com.amazonaws.s3#PartsCount", - "traits": { - "smithy.api#documentation": "

The count of parts this object has.

", - "smithy.api#httpHeader": "x-amz-mp-parts-count" - } - }, - "TagCount": { - "target": "com.amazonaws.s3#TagCount", - "traits": { - "smithy.api#documentation": "

The number of tags, if any, on the object.

", - "smithy.api#httpHeader": "x-amz-tagging-count" - } - }, - "ObjectLockMode": { - "target": "com.amazonaws.s3#ObjectLockMode", - "traits": { - "smithy.api#documentation": "

The Object Lock mode currently in place for this object.

", - "smithy.api#httpHeader": "x-amz-object-lock-mode" - } - }, - "ObjectLockRetainUntilDate": { - "target": "com.amazonaws.s3#ObjectLockRetainUntilDate", - "traits": { - "smithy.api#documentation": "

The date and time when this object's Object Lock will expire.

", - "smithy.api#httpHeader": "x-amz-object-lock-retain-until-date" - } - }, - "ObjectLockLegalHoldStatus": { - "target": "com.amazonaws.s3#ObjectLockLegalHoldStatus", - "traits": { - "smithy.api#documentation": "

Indicates whether this object has an active legal hold. This field is only returned if\n you have permission to view an object's legal hold status.

", - "smithy.api#httpHeader": "x-amz-object-lock-legal-hold" - } - } - } - }, - "com.amazonaws.s3#GetObjectRequest": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

The bucket name containing the object.

\n

When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.

\n

When using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "IfMatch": { - "target": "com.amazonaws.s3#IfMatch", - "traits": { - "smithy.api#documentation": "

Return the object only if its entity tag (ETag) is the same as the one specified,\n otherwise return a 412 (precondition failed).

", - "smithy.api#httpHeader": "If-Match" - } - }, - "IfModifiedSince": { - "target": "com.amazonaws.s3#IfModifiedSince", - "traits": { - "smithy.api#documentation": "

Return the object only if it has been modified since the specified time, otherwise\n return a 304 (not modified).

", - "smithy.api#httpHeader": "If-Modified-Since" - } - }, - "IfNoneMatch": { - "target": "com.amazonaws.s3#IfNoneMatch", - "traits": { - "smithy.api#documentation": "

Return the object only if its entity tag (ETag) is different from the one specified,\n otherwise return a 304 (not modified).

", - "smithy.api#httpHeader": "If-None-Match" - } - }, - "IfUnmodifiedSince": { - "target": "com.amazonaws.s3#IfUnmodifiedSince", - "traits": { - "smithy.api#documentation": "

Return the object only if it has not been modified since the specified time, otherwise\n return a 412 (precondition failed).

", - "smithy.api#httpHeader": "If-Unmodified-Since" - } - }, - "Key": { - "target": "com.amazonaws.s3#ObjectKey", - "traits": { - "smithy.api#documentation": "

Key of the object to get.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Range": { - "target": "com.amazonaws.s3#Range", - "traits": { - "smithy.api#documentation": "

Downloads the specified range bytes of an object. For more information about the HTTP\n Range header, see https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.

\n \n

Amazon S3 doesn't support retrieving multiple ranges of data per GET\n request.

\n ", - "smithy.api#httpHeader": "Range" - } - }, - "ResponseCacheControl": { - "target": "com.amazonaws.s3#ResponseCacheControl", - "traits": { - "smithy.api#documentation": "

Sets the Cache-Control header of the response.

", - "smithy.api#httpQuery": "response-cache-control" - } - }, - "ResponseContentDisposition": { - "target": "com.amazonaws.s3#ResponseContentDisposition", - "traits": { - "smithy.api#documentation": "

Sets the Content-Disposition header of the response

", - "smithy.api#httpQuery": "response-content-disposition" - } - }, - "ResponseContentEncoding": { - "target": "com.amazonaws.s3#ResponseContentEncoding", - "traits": { - "smithy.api#documentation": "

Sets the Content-Encoding header of the response.

", - "smithy.api#httpQuery": "response-content-encoding" - } - }, - "ResponseContentLanguage": { - "target": "com.amazonaws.s3#ResponseContentLanguage", - "traits": { - "smithy.api#documentation": "

Sets the Content-Language header of the response.

", - "smithy.api#httpQuery": "response-content-language" - } - }, - "ResponseContentType": { - "target": "com.amazonaws.s3#ResponseContentType", - "traits": { - "smithy.api#documentation": "

Sets the Content-Type header of the response.

", - "smithy.api#httpQuery": "response-content-type" - } - }, - "ResponseExpires": { - "target": "com.amazonaws.s3#ResponseExpires", - "traits": { - "smithy.api#documentation": "

Sets the Expires header of the response.

", - "smithy.api#httpQuery": "response-expires" - } - }, - "VersionId": { - "target": "com.amazonaws.s3#ObjectVersionId", - "traits": { - "smithy.api#documentation": "

VersionId used to reference a specific version of the object.

", - "smithy.api#httpQuery": "versionId" - } - }, - "SSECustomerAlgorithm": { - "target": "com.amazonaws.s3#SSECustomerAlgorithm", - "traits": { - "smithy.api#documentation": "

Specifies the algorithm to use to when encrypting the object (for example,\n AES256).

", - "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-algorithm" - } - }, - "SSECustomerKey": { - "target": "com.amazonaws.s3#SSECustomerKey", - "traits": { - "smithy.api#documentation": "

Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This\n value is used to store the object and then it is discarded; Amazon S3 does not store the\n encryption key. The key must be appropriate for use with the algorithm specified in the\n x-amz-server-side-encryption-customer-algorithm header.

", - "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key" - } - }, - "SSECustomerKeyMD5": { - "target": "com.amazonaws.s3#SSECustomerKeyMD5", - "traits": { - "smithy.api#documentation": "

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses\n this header for a message integrity check to ensure that the encryption key was transmitted\n without error.

", - "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key-MD5" - } - }, - "RequestPayer": { - "target": "com.amazonaws.s3#RequestPayer", - "traits": { - "smithy.api#httpHeader": "x-amz-request-payer" - } - }, - "PartNumber": { - "target": "com.amazonaws.s3#PartNumber", - "traits": { - "smithy.api#documentation": "

Part number of the object being read. This is a positive integer between 1 and 10,000.\n Effectively performs a 'ranged' GET request for the part specified. Useful for downloading\n just a part of an object.

", - "smithy.api#httpQuery": "partNumber" - } - }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", - "smithy.api#httpHeader": "x-amz-expected-bucket-owner" - } - } - } - }, - "com.amazonaws.s3#GetObjectRetention": { - "type": "operation", - "input": { - "target": "com.amazonaws.s3#GetObjectRetentionRequest" - }, - "output": { - "target": "com.amazonaws.s3#GetObjectRetentionOutput" - }, - "traits": { - "smithy.api#documentation": "

Retrieves an object's retention settings. For more information, see Locking Objects.

\n

This action is not supported by Amazon S3 on Outposts.

", - "smithy.api#http": { - "method": "GET", - "uri": "/{Bucket}/{Key+}?retention", - "code": 200 - } - } - }, - "com.amazonaws.s3#GetObjectRetentionOutput": { - "type": "structure", - "members": { - "Retention": { - "target": "com.amazonaws.s3#ObjectLockRetention", - "traits": { - "smithy.api#documentation": "

The container element for an object's retention settings.

", - "smithy.api#httpPayload": {} - } - } - } - }, - "com.amazonaws.s3#GetObjectRetentionRequest": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

The bucket name containing the object whose retention settings you want to retrieve.

\n

When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Key": { - "target": "com.amazonaws.s3#ObjectKey", - "traits": { - "smithy.api#documentation": "

The key name for the object whose retention settings you want to retrieve.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "VersionId": { - "target": "com.amazonaws.s3#ObjectVersionId", - "traits": { - "smithy.api#documentation": "

The version ID for the object whose retention settings you want to retrieve.

", - "smithy.api#httpQuery": "versionId" - } - }, - "RequestPayer": { - "target": "com.amazonaws.s3#RequestPayer", - "traits": { - "smithy.api#httpHeader": "x-amz-request-payer" - } - }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", - "smithy.api#httpHeader": "x-amz-expected-bucket-owner" - } - } - } - }, - "com.amazonaws.s3#GetObjectTagging": { - "type": "operation", - "input": { - "target": "com.amazonaws.s3#GetObjectTaggingRequest" - }, - "output": { - "target": "com.amazonaws.s3#GetObjectTaggingOutput" - }, - "traits": { - "smithy.api#documentation": "

Returns the tag-set of an object. You send the GET request against the tagging\n subresource associated with the object.

\n\n

To use this operation, you must have permission to perform the\n s3:GetObjectTagging action. By default, the GET operation returns\n information about current version of an object. For a versioned bucket, you can have\n multiple versions of an object in your bucket. To retrieve tags of any other version, use\n the versionId query parameter. You also need permission for the\n s3:GetObjectVersionTagging action.

\n\n

By default, the bucket owner has this permission and can grant this permission to\n others.

\n\n

For information about the Amazon S3 object tagging feature, see Object Tagging.

\n\n

The following operation is related to GetObjectTagging:

\n ", - "smithy.api#http": { - "method": "GET", - "uri": "/{Bucket}/{Key+}?tagging", - "code": 200 - } - } - }, - "com.amazonaws.s3#GetObjectTaggingOutput": { - "type": "structure", - "members": { - "VersionId": { - "target": "com.amazonaws.s3#ObjectVersionId", - "traits": { - "smithy.api#documentation": "

The versionId of the object for which you got the tagging information.

", - "smithy.api#httpHeader": "x-amz-version-id" - } - }, - "TagSet": { - "target": "com.amazonaws.s3#TagSet", - "traits": { - "smithy.api#documentation": "

Contains the tag set.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.s3#GetObjectTaggingRequest": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

The bucket name containing the object for which to get the tagging information.

\n

When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.

\n

When using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Key": { - "target": "com.amazonaws.s3#ObjectKey", - "traits": { - "smithy.api#documentation": "

Object key for which to get the tagging information.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "VersionId": { - "target": "com.amazonaws.s3#ObjectVersionId", - "traits": { - "smithy.api#documentation": "

The versionId of the object for which to get the tagging information.

", - "smithy.api#httpQuery": "versionId" - } - }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", - "smithy.api#httpHeader": "x-amz-expected-bucket-owner" - } - } - } - }, - "com.amazonaws.s3#GetObjectTorrent": { - "type": "operation", - "input": { - "target": "com.amazonaws.s3#GetObjectTorrentRequest" - }, - "output": { - "target": "com.amazonaws.s3#GetObjectTorrentOutput" - }, - "traits": { - "smithy.api#documentation": "

Returns torrent files from a bucket. BitTorrent can save you bandwidth when you're\n distributing large files. For more information about BitTorrent, see Using BitTorrent with Amazon S3.

\n \n

You can get torrent only for objects that are less than 5 GB in size, and that are\n not encrypted using server-side encryption with a customer-provided encryption\n key.

\n \n

To use GET, you must have READ access to the object.

\n

This action is not supported by Amazon S3 on Outposts.

\n

The following operation is related to GetObjectTorrent:

\n ", - "smithy.api#http": { - "method": "GET", - "uri": "/{Bucket}/{Key+}?torrent", - "code": 200 - } - } - }, - "com.amazonaws.s3#GetObjectTorrentOutput": { - "type": "structure", - "members": { - "Body": { - "target": "com.amazonaws.s3#StreamingBlob", - "traits": { - "smithy.api#documentation": "

A Bencoded dictionary as defined by the BitTorrent specification

", - "smithy.api#httpPayload": {} - } - }, - "RequestCharged": { - "target": "com.amazonaws.s3#RequestCharged", - "traits": { - "smithy.api#httpHeader": "x-amz-request-charged" - } - } - } - }, - "com.amazonaws.s3#GetObjectTorrentRequest": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

The name of the bucket containing the object for which to get the torrent files.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Key": { - "target": "com.amazonaws.s3#ObjectKey", - "traits": { - "smithy.api#documentation": "

The object key for which to get the information.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "RequestPayer": { - "target": "com.amazonaws.s3#RequestPayer", - "traits": { - "smithy.api#httpHeader": "x-amz-request-payer" - } - }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", - "smithy.api#httpHeader": "x-amz-expected-bucket-owner" - } - } - } - }, - "com.amazonaws.s3#GetPublicAccessBlock": { - "type": "operation", - "input": { - "target": "com.amazonaws.s3#GetPublicAccessBlockRequest" - }, - "output": { - "target": "com.amazonaws.s3#GetPublicAccessBlockOutput" - }, - "traits": { - "smithy.api#documentation": "

Retrieves the PublicAccessBlock configuration for an Amazon S3 bucket. To use\n this operation, you must have the s3:GetBucketPublicAccessBlock permission.\n For more information about Amazon S3 permissions, see Specifying Permissions in a\n Policy.

\n\n \n

When Amazon S3 evaluates the PublicAccessBlock configuration for a bucket or\n an object, it checks the PublicAccessBlock configuration for both the\n bucket (or the bucket that contains the object) and the bucket owner's account. If the\n PublicAccessBlock settings are different between the bucket and the\n account, Amazon S3 uses the most restrictive combination of the bucket-level and\n account-level settings.

\n \n\n

For more information about when Amazon S3 considers a bucket or an object public, see The Meaning of \"Public\".

\n\n

The following operations are related to GetPublicAccessBlock:

\n ", - "smithy.api#http": { - "method": "GET", - "uri": "/{Bucket}?publicAccessBlock", - "code": 200 - } - } - }, - "com.amazonaws.s3#GetPublicAccessBlockOutput": { - "type": "structure", - "members": { - "PublicAccessBlockConfiguration": { - "target": "com.amazonaws.s3#PublicAccessBlockConfiguration", - "traits": { - "smithy.api#documentation": "

The PublicAccessBlock configuration currently in effect for this Amazon S3\n bucket.

", - "smithy.api#httpPayload": {} - } - } - } - }, - "com.amazonaws.s3#GetPublicAccessBlockRequest": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

The name of the Amazon S3 bucket whose PublicAccessBlock configuration you want\n to retrieve.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", - "smithy.api#httpHeader": "x-amz-expected-bucket-owner" - } - } - } - }, - "com.amazonaws.s3#GlacierJobParameters": { - "type": "structure", - "members": { - "Tier": { - "target": "com.amazonaws.s3#Tier", - "traits": { - "smithy.api#documentation": "

Retrieval tier at which the restore will be processed.

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

Container for S3 Glacier job parameters.

" - } - }, - "com.amazonaws.s3#Grant": { - "type": "structure", - "members": { - "Grantee": { - "target": "com.amazonaws.s3#Grantee", - "traits": { - "smithy.api#documentation": "

The person being granted permissions.

" - } - }, - "Permission": { - "target": "com.amazonaws.s3#Permission", - "traits": { - "smithy.api#documentation": "

Specifies the permission given to the grantee.

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

Container for grant information.

" - } - }, - "com.amazonaws.s3#GrantFullControl": { - "type": "string" - }, - "com.amazonaws.s3#GrantRead": { - "type": "string" - }, - "com.amazonaws.s3#GrantReadACP": { - "type": "string" - }, - "com.amazonaws.s3#GrantWrite": { - "type": "string" - }, - "com.amazonaws.s3#GrantWriteACP": { - "type": "string" - }, - "com.amazonaws.s3#Grantee": { - "type": "structure", - "members": { - "DisplayName": { - "target": "com.amazonaws.s3#DisplayName", - "traits": { - "smithy.api#documentation": "

Screen name of the grantee.

" - } - }, - "EmailAddress": { - "target": "com.amazonaws.s3#EmailAddress", - "traits": { - "smithy.api#documentation": "

Email address of the grantee.

\n \n

Using email addresses to specify a grantee is only supported in the following AWS Regions:

\n \n

For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the AWS General Reference.

\n " - } - }, - "ID": { - "target": "com.amazonaws.s3#ID", - "traits": { - "smithy.api#documentation": "

The canonical user ID of the grantee.

" - } - }, - "URI": { - "target": "com.amazonaws.s3#URI", - "traits": { - "smithy.api#documentation": "

URI of the grantee group.

" - } - }, - "Type": { - "target": "com.amazonaws.s3#Type", - "traits": { - "smithy.api#documentation": "

Type of grantee

", - "smithy.api#required": {}, - "smithy.api#xmlAttribute": {}, - "smithy.api#xmlName": "xsi:type" - } - } - }, - "traits": { - "smithy.api#documentation": "

Container for the person being granted permissions.

", - "smithy.api#xmlNamespace": { - "uri": "http://www.w3.org/2001/XMLSchema-instance", - "prefix": "xsi" - } - } - }, - "com.amazonaws.s3#Grants": { - "type": "list", - "member": { - "target": "com.amazonaws.s3#Grant", - "traits": { - "smithy.api#xmlName": "Grant" - } - } - }, - "com.amazonaws.s3#HeadBucket": { - "type": "operation", - "input": { - "target": "com.amazonaws.s3#HeadBucketRequest" - }, - "errors": [ - { - "target": "com.amazonaws.s3#NoSuchBucket" - } - ], - "traits": { - "smithy.api#documentation": "

This operation is useful to determine if a bucket exists and you have permission to\n access it. The operation returns a 200 OK if the bucket exists and you have\n permission to access it. Otherwise, the operation might return responses such as 404\n Not Found and 403 Forbidden.

\n\n

To use this operation, you must have permissions to perform the\n s3:ListBucket action. The bucket owner has this permission by default and\n can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources.

", - "smithy.api#http": { - "method": "HEAD", - "uri": "/{Bucket}", - "code": 200 - }, - "smithy.waiters#waitable": { - "BucketExists": { - "acceptors": [ - { - "state": "success", - "matcher": { - "success": true - } - } - ], - "minDelay": 5 - } - } - } - }, - "com.amazonaws.s3#HeadBucketRequest": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

The bucket name.

\n

When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.

\n

When using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", - "smithy.api#httpHeader": "x-amz-expected-bucket-owner" - } - } - } - }, - "com.amazonaws.s3#HeadObject": { - "type": "operation", - "input": { - "target": "com.amazonaws.s3#HeadObjectRequest" - }, - "output": { - "target": "com.amazonaws.s3#HeadObjectOutput" - }, - "errors": [ - { - "target": "com.amazonaws.s3#NoSuchKey" - } - ], - "traits": { - "smithy.api#documentation": "

The HEAD operation retrieves metadata from an object without returning the object\n itself. This operation is useful if you're only interested in an object's metadata. To use\n HEAD, you must have READ access to the object.

\n\n

A HEAD request has the same options as a GET operation on an\n object. The response is identical to the GET response except that there is no\n response body.

\n\n

If you encrypt an object by using server-side encryption with customer-provided\n encryption keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the\n metadata from the object, you must use the following headers:

\n \n

For more information about SSE-C, see Server-Side Encryption (Using\n Customer-Provided Encryption Keys).

\n \n

Encryption request headers, like x-amz-server-side-encryption, should\n not be sent for GET requests if your object uses server-side encryption with CMKs stored\n in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption keys\n (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 BadRequest\n error.

\n \n\n\n\n\n\n\n\n

Request headers are limited to 8 KB in size. For more information, see Common Request\n Headers.

\n

Consider the following when using request headers:

\n \n\n

For more information about conditional requests, see RFC 7232.

\n\n

\n Permissions\n

\n

You need the s3:GetObject permission for this operation. For more\n information, see Specifying Permissions\n in a Policy. If the object you request does not exist, the error Amazon S3 returns\n depends on whether you also have the s3:ListBucket permission.

\n \n\n

The following operation is related to HeadObject:

\n ", - "smithy.api#http": { - "method": "HEAD", - "uri": "/{Bucket}/{Key+}", - "code": 200 - }, - "smithy.waiters#waitable": { - "ObjectExists": { - "acceptors": [ - { - "state": "success", - "matcher": { - "success": true - } - } - ], - "minDelay": 5 - } - } - } - }, - "com.amazonaws.s3#HeadObjectOutput": { - "type": "structure", - "members": { - "DeleteMarker": { - "target": "com.amazonaws.s3#DeleteMarker", - "traits": { - "smithy.api#documentation": "

Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If\n false, this response header does not appear in the response.

", - "smithy.api#httpHeader": "x-amz-delete-marker" - } - }, - "AcceptRanges": { - "target": "com.amazonaws.s3#AcceptRanges", - "traits": { - "smithy.api#documentation": "

Indicates that a range of bytes was specified.

", - "smithy.api#httpHeader": "accept-ranges" - } - }, - "Expiration": { - "target": "com.amazonaws.s3#Expiration", - "traits": { - "smithy.api#documentation": "

If the object expiration is configured (see PUT Bucket lifecycle), the response includes\n this header. It includes the expiry-date and rule-id key-value pairs providing object\n expiration information. The value of the rule-id is URL encoded.

", - "smithy.api#httpHeader": "x-amz-expiration" - } - }, - "Restore": { - "target": "com.amazonaws.s3#Restore", - "traits": { - "smithy.api#documentation": "

If the object is an archived object (an object whose storage class is GLACIER), the\n response includes this header if either the archive restoration is in progress (see RestoreObject or an archive copy is already restored.

\n\n

If an archive copy is already restored, the header value indicates when Amazon S3 is\n scheduled to delete the object copy. For example:

\n\n

\n x-amz-restore: ongoing-request=\"false\", expiry-date=\"Fri, 23 Dec 2012 00:00:00\n GMT\"\n

\n\n

If the object restoration is in progress, the header returns the value\n ongoing-request=\"true\".

\n\n

For more information about archiving objects, see Transitioning Objects: General Considerations.

", - "smithy.api#httpHeader": "x-amz-restore" - } - }, - "ArchiveStatus": { - "target": "com.amazonaws.s3#ArchiveStatus", - "traits": { - "smithy.api#documentation": "

The archive state of the head object.

", - "smithy.api#httpHeader": "x-amz-archive-status" - } - }, - "LastModified": { - "target": "com.amazonaws.s3#LastModified", - "traits": { - "smithy.api#documentation": "

Last modified date of the object

", - "smithy.api#httpHeader": "Last-Modified" - } - }, - "ContentLength": { - "target": "com.amazonaws.s3#ContentLength", - "traits": { - "smithy.api#documentation": "

Size of the body in bytes.

", - "smithy.api#httpHeader": "Content-Length" - } - }, - "ETag": { - "target": "com.amazonaws.s3#ETag", - "traits": { - "smithy.api#documentation": "

An ETag is an opaque identifier assigned by a web server to a specific version of a\n resource found at a URL.

", - "smithy.api#httpHeader": "ETag" - } - }, - "MissingMeta": { - "target": "com.amazonaws.s3#MissingMeta", - "traits": { - "smithy.api#documentation": "

This is set to the number of metadata entries not returned in x-amz-meta\n headers. This can happen if you create metadata using an API like SOAP that supports more\n flexible metadata than the REST API. For example, using SOAP, you can create metadata whose\n values are not legal HTTP headers.

", - "smithy.api#httpHeader": "x-amz-missing-meta" - } - }, - "VersionId": { - "target": "com.amazonaws.s3#ObjectVersionId", - "traits": { - "smithy.api#documentation": "

Version of the object.

", - "smithy.api#httpHeader": "x-amz-version-id" - } - }, - "CacheControl": { - "target": "com.amazonaws.s3#CacheControl", - "traits": { - "smithy.api#documentation": "

Specifies caching behavior along the request/reply chain.

", - "smithy.api#httpHeader": "Cache-Control" - } - }, - "ContentDisposition": { - "target": "com.amazonaws.s3#ContentDisposition", - "traits": { - "smithy.api#documentation": "

Specifies presentational information for the object.

", - "smithy.api#httpHeader": "Content-Disposition" - } - }, - "ContentEncoding": { - "target": "com.amazonaws.s3#ContentEncoding", - "traits": { - "smithy.api#documentation": "

Specifies what content encodings have been applied to the object and thus what decoding\n mechanisms must be applied to obtain the media-type referenced by the Content-Type header\n field.

", - "smithy.api#httpHeader": "Content-Encoding" - } - }, - "ContentLanguage": { - "target": "com.amazonaws.s3#ContentLanguage", - "traits": { - "smithy.api#documentation": "

The language the content is in.

", - "smithy.api#httpHeader": "Content-Language" - } - }, - "ContentType": { - "target": "com.amazonaws.s3#ContentType", - "traits": { - "smithy.api#documentation": "

A standard MIME type describing the format of the object data.

", - "smithy.api#httpHeader": "Content-Type" - } - }, - "Expires": { - "target": "com.amazonaws.s3#Expires", - "traits": { - "smithy.api#documentation": "

The date and time at which the object is no longer cacheable.

", - "smithy.api#httpHeader": "Expires" - } - }, - "WebsiteRedirectLocation": { - "target": "com.amazonaws.s3#WebsiteRedirectLocation", - "traits": { - "smithy.api#documentation": "

If the bucket is configured as a website, redirects requests for this object to another\n object in the same bucket or to an external URL. Amazon S3 stores the value of this header in\n the object metadata.

", - "smithy.api#httpHeader": "x-amz-website-redirect-location" - } - }, - "ServerSideEncryption": { - "target": "com.amazonaws.s3#ServerSideEncryption", - "traits": { - "smithy.api#documentation": "

If the object is stored using server-side encryption either with an AWS KMS customer\n master key (CMK) or an Amazon S3-managed encryption key, the response includes this header with\n the value of the server-side encryption algorithm used when storing this object in Amazon\n S3 (for example, AES256, aws:kms).

", - "smithy.api#httpHeader": "x-amz-server-side-encryption" - } - }, - "Metadata": { - "target": "com.amazonaws.s3#Metadata", - "traits": { - "smithy.api#documentation": "

A map of metadata to store with the object in S3.

", - "smithy.api#httpPrefixHeaders": "x-amz-meta-" - } - }, - "SSECustomerAlgorithm": { - "target": "com.amazonaws.s3#SSECustomerAlgorithm", - "traits": { - "smithy.api#documentation": "

If server-side encryption with a customer-provided encryption key was requested, the\n response will include this header confirming the encryption algorithm used.

", - "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-algorithm" - } - }, - "SSECustomerKeyMD5": { - "target": "com.amazonaws.s3#SSECustomerKeyMD5", - "traits": { - "smithy.api#documentation": "

If server-side encryption with a customer-provided encryption key was requested, the\n response will include this header to provide round-trip message integrity verification of\n the customer-provided encryption key.

", - "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key-MD5" - } - }, - "SSEKMSKeyId": { - "target": "com.amazonaws.s3#SSEKMSKeyId", - "traits": { - "smithy.api#documentation": "

If present, specifies the ID of the AWS Key Management Service (AWS KMS) symmetric\n customer managed customer master key (CMK) that was used for the object.

", - "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" - } - }, - "BucketKeyEnabled": { - "target": "com.amazonaws.s3#BucketKeyEnabled", - "traits": { - "smithy.api#documentation": "

Indicates whether the object uses an S3 Bucket Key for server-side encryption with AWS KMS (SSE-KMS).

", - "smithy.api#httpHeader": "x-amz-server-side-encryption-bucket-key-enabled" - } - }, - "StorageClass": { - "target": "com.amazonaws.s3#StorageClass", - "traits": { - "smithy.api#documentation": "

Provides storage class information of the object. Amazon S3 returns this header for all\n objects except for S3 Standard storage class objects.

\n\n

For more information, see Storage\n Classes.

", - "smithy.api#httpHeader": "x-amz-storage-class" - } - }, - "RequestCharged": { - "target": "com.amazonaws.s3#RequestCharged", - "traits": { - "smithy.api#httpHeader": "x-amz-request-charged" - } - }, - "ReplicationStatus": { - "target": "com.amazonaws.s3#ReplicationStatus", - "traits": { - "smithy.api#documentation": "

Amazon S3 can return this header if your request involves a bucket that is either a source or\n a destination in a replication rule.

\n\n

In replication, you have a source bucket on which you configure replication and\n destination bucket or buckets where Amazon S3 stores object replicas. When you request an object\n (GetObject) or object metadata (HeadObject) from these\n buckets, Amazon S3 will return the x-amz-replication-status header in the response\n as follows:

\n \n\n

For more information, see Replication.

", - "smithy.api#httpHeader": "x-amz-replication-status" - } - }, - "PartsCount": { - "target": "com.amazonaws.s3#PartsCount", - "traits": { - "smithy.api#documentation": "

The count of parts this object has.

", - "smithy.api#httpHeader": "x-amz-mp-parts-count" - } - }, - "ObjectLockMode": { - "target": "com.amazonaws.s3#ObjectLockMode", - "traits": { - "smithy.api#documentation": "

The Object Lock mode, if any, that's in effect for this object. This header is only\n returned if the requester has the s3:GetObjectRetention permission. For more\n information about S3 Object Lock, see Object\n Lock.

", - "smithy.api#httpHeader": "x-amz-object-lock-mode" - } - }, - "ObjectLockRetainUntilDate": { - "target": "com.amazonaws.s3#ObjectLockRetainUntilDate", - "traits": { - "smithy.api#documentation": "

The date and time when the Object Lock retention period expires. This header is only\n returned if the requester has the s3:GetObjectRetention permission.

", - "smithy.api#httpHeader": "x-amz-object-lock-retain-until-date" - } - }, - "ObjectLockLegalHoldStatus": { - "target": "com.amazonaws.s3#ObjectLockLegalHoldStatus", - "traits": { - "smithy.api#documentation": "

Specifies whether a legal hold is in effect for this object. This header is only\n returned if the requester has the s3:GetObjectLegalHold permission. This\n header is not returned if the specified version of this object has never had a legal hold\n applied. For more information about S3 Object Lock, see Object Lock.

", - "smithy.api#httpHeader": "x-amz-object-lock-legal-hold" - } - } - } - }, - "com.amazonaws.s3#HeadObjectRequest": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

The name of the bucket containing the object.

\n

When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.

\n

When using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "IfMatch": { - "target": "com.amazonaws.s3#IfMatch", - "traits": { - "smithy.api#documentation": "

Return the object only if its entity tag (ETag) is the same as the one specified,\n otherwise return a 412 (precondition failed).

", - "smithy.api#httpHeader": "If-Match" - } - }, - "IfModifiedSince": { - "target": "com.amazonaws.s3#IfModifiedSince", - "traits": { - "smithy.api#documentation": "

Return the object only if it has been modified since the specified time, otherwise\n return a 304 (not modified).

", - "smithy.api#httpHeader": "If-Modified-Since" - } - }, - "IfNoneMatch": { - "target": "com.amazonaws.s3#IfNoneMatch", - "traits": { - "smithy.api#documentation": "

Return the object only if its entity tag (ETag) is different from the one specified,\n otherwise return a 304 (not modified).

", - "smithy.api#httpHeader": "If-None-Match" - } - }, - "IfUnmodifiedSince": { - "target": "com.amazonaws.s3#IfUnmodifiedSince", - "traits": { - "smithy.api#documentation": "

Return the object only if it has not been modified since the specified time, otherwise\n return a 412 (precondition failed).

", - "smithy.api#httpHeader": "If-Unmodified-Since" - } - }, - "Key": { - "target": "com.amazonaws.s3#ObjectKey", - "traits": { - "smithy.api#documentation": "

The object key.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Range": { - "target": "com.amazonaws.s3#Range", - "traits": { - "smithy.api#documentation": "

Downloads the specified range bytes of an object. For more information about the HTTP\n Range header, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.

\n \n

Amazon S3 doesn't support retrieving multiple ranges of data per GET\n request.

\n ", - "smithy.api#httpHeader": "Range" - } - }, - "VersionId": { - "target": "com.amazonaws.s3#ObjectVersionId", - "traits": { - "smithy.api#documentation": "

VersionId used to reference a specific version of the object.

", - "smithy.api#httpQuery": "versionId" - } - }, - "SSECustomerAlgorithm": { - "target": "com.amazonaws.s3#SSECustomerAlgorithm", - "traits": { - "smithy.api#documentation": "

Specifies the algorithm to use to when encrypting the object (for example,\n AES256).

", - "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-algorithm" - } - }, - "SSECustomerKey": { - "target": "com.amazonaws.s3#SSECustomerKey", - "traits": { - "smithy.api#documentation": "

Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This\n value is used to store the object and then it is discarded; Amazon S3 does not store the\n encryption key. The key must be appropriate for use with the algorithm specified in the\n x-amz-server-side-encryption-customer-algorithm header.

", - "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key" - } - }, - "SSECustomerKeyMD5": { - "target": "com.amazonaws.s3#SSECustomerKeyMD5", - "traits": { - "smithy.api#documentation": "

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses\n this header for a message integrity check to ensure that the encryption key was transmitted\n without error.

", - "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key-MD5" - } - }, - "RequestPayer": { - "target": "com.amazonaws.s3#RequestPayer", - "traits": { - "smithy.api#httpHeader": "x-amz-request-payer" - } - }, - "PartNumber": { - "target": "com.amazonaws.s3#PartNumber", - "traits": { - "smithy.api#documentation": "

Part number of the object being read. This is a positive integer between 1 and 10,000.\n Effectively performs a 'ranged' HEAD request for the part specified. Useful querying about\n the size of the part and the number of parts in this object.

", - "smithy.api#httpQuery": "partNumber" - } - }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", - "smithy.api#httpHeader": "x-amz-expected-bucket-owner" - } - } - } - }, - "com.amazonaws.s3#HostName": { - "type": "string" - }, - "com.amazonaws.s3#HttpErrorCodeReturnedEquals": { - "type": "string" - }, - "com.amazonaws.s3#HttpRedirectCode": { - "type": "string" - }, - "com.amazonaws.s3#ID": { - "type": "string" - }, - "com.amazonaws.s3#IfMatch": { - "type": "string" - }, - "com.amazonaws.s3#IfModifiedSince": { - "type": "timestamp" - }, - "com.amazonaws.s3#IfNoneMatch": { - "type": "string" - }, - "com.amazonaws.s3#IfUnmodifiedSince": { - "type": "timestamp" - }, - "com.amazonaws.s3#IndexDocument": { - "type": "structure", - "members": { - "Suffix": { - "target": "com.amazonaws.s3#Suffix", - "traits": { - "smithy.api#documentation": "

A suffix that is appended to a request that is for a directory on the website endpoint\n (for example,if the suffix is index.html and you make a request to samplebucket/images/ the\n data that is returned will be for the object with the key name images/index.html) The\n suffix must not be empty and must not include a slash character.

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

Container for the Suffix element.

" - } - }, - "com.amazonaws.s3#Initiated": { - "type": "timestamp" - }, - "com.amazonaws.s3#Initiator": { - "type": "structure", - "members": { - "ID": { - "target": "com.amazonaws.s3#ID", - "traits": { - "smithy.api#documentation": "

If the principal is an AWS account, it provides the Canonical User ID. If the principal\n is an IAM User, it provides a user ARN value.

" - } - }, - "DisplayName": { - "target": "com.amazonaws.s3#DisplayName", - "traits": { - "smithy.api#documentation": "

Name of the Principal.

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

Container element that identifies who initiated the multipart upload.

" - } - }, - "com.amazonaws.s3#InputSerialization": { - "type": "structure", - "members": { - "CSV": { - "target": "com.amazonaws.s3#CSVInput", - "traits": { - "smithy.api#documentation": "

Describes the serialization of a CSV-encoded object.

" - } - }, - "CompressionType": { - "target": "com.amazonaws.s3#CompressionType", - "traits": { - "smithy.api#documentation": "

Specifies object's compression format. Valid values: NONE, GZIP, BZIP2. Default Value:\n NONE.

" - } - }, - "JSON": { - "target": "com.amazonaws.s3#JSONInput", - "traits": { - "smithy.api#documentation": "

Specifies JSON as object's input serialization format.

" - } - }, - "Parquet": { - "target": "com.amazonaws.s3#ParquetInput", - "traits": { - "smithy.api#documentation": "

Specifies Parquet as object's input serialization format.

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

Describes the serialization format of the object.

" - } - }, - "com.amazonaws.s3#IntelligentTieringAccessTier": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ARCHIVE_ACCESS" - }, - { - "value": "DEEP_ARCHIVE_ACCESS" - } - ] - } - }, - "com.amazonaws.s3#IntelligentTieringAndOperator": { - "type": "structure", - "members": { - "Prefix": { - "target": "com.amazonaws.s3#Prefix", - "traits": { - "smithy.api#documentation": "

An object key name prefix that identifies the subset of objects to which the\n configuration applies.

" - } - }, - "Tags": { - "target": "com.amazonaws.s3#TagSet", - "traits": { - "smithy.api#documentation": "

All of these tags must exist in the object's tag set in order for the configuration to\n apply.

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

A container for specifying S3 Intelligent-Tiering filters. The filters determine the\n subset of objects to which the rule applies.

" - } - }, - "com.amazonaws.s3#IntelligentTieringConfiguration": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.s3#IntelligentTieringId", - "traits": { - "smithy.api#documentation": "

The ID used to identify the S3 Intelligent-Tiering configuration.

", - "smithy.api#required": {} - } - }, - "Filter": { - "target": "com.amazonaws.s3#IntelligentTieringFilter", - "traits": { - "smithy.api#documentation": "

Specifies a bucket filter. The configuration only includes objects that meet the\n filter's criteria.

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

Specifies the status of the configuration.

", - "smithy.api#required": {} - } - }, - "Tierings": { - "target": "com.amazonaws.s3#TieringList", - "traits": { - "smithy.api#documentation": "

Specifies the S3 Intelligent-Tiering storage class tier of the configuration.

", - "smithy.api#required": {}, - "smithy.api#xmlFlattened": {}, - "smithy.api#xmlName": "Tiering" - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies the S3 Intelligent-Tiering configuration for an Amazon S3 bucket.

\n

For information about the S3 Intelligent-Tiering storage class, see Storage class for\n automatically optimizing frequently and infrequently accessed objects.

" - } - }, - "com.amazonaws.s3#IntelligentTieringConfigurationList": { - "type": "list", - "member": { - "target": "com.amazonaws.s3#IntelligentTieringConfiguration" - } - }, - "com.amazonaws.s3#IntelligentTieringDays": { - "type": "integer" - }, - "com.amazonaws.s3#IntelligentTieringFilter": { - "type": "structure", - "members": { - "Prefix": { - "target": "com.amazonaws.s3#Prefix", - "traits": { - "smithy.api#documentation": "

An object key name prefix that identifies the subset of objects to which the rule\n applies.

" - } - }, - "Tag": { - "target": "com.amazonaws.s3#Tag" - }, - "And": { - "target": "com.amazonaws.s3#IntelligentTieringAndOperator", - "traits": { - "smithy.api#documentation": "

A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter.\n The operator must have at least two predicates, and an object must match all of the\n predicates in order for the filter to apply.

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

The Filter is used to identify objects that the S3 Intelligent-Tiering\n configuration applies to.

" - } - }, - "com.amazonaws.s3#IntelligentTieringId": { - "type": "string" - }, - "com.amazonaws.s3#IntelligentTieringStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Enabled" - }, - { - "value": "Disabled" - } - ] - } - }, - "com.amazonaws.s3#InvalidObjectState": { - "type": "structure", - "members": { - "StorageClass": { - "target": "com.amazonaws.s3#StorageClass" - }, - "AccessTier": { - "target": "com.amazonaws.s3#IntelligentTieringAccessTier" - } - }, - "traits": { - "smithy.api#documentation": "

Object is archived and inaccessible until restored.

", - "smithy.api#error": "client" - } - }, - "com.amazonaws.s3#InventoryConfiguration": { - "type": "structure", - "members": { - "Destination": { - "target": "com.amazonaws.s3#InventoryDestination", - "traits": { - "smithy.api#documentation": "

Contains information about where to publish the inventory results.

", - "smithy.api#required": {} - } - }, - "IsEnabled": { - "target": "com.amazonaws.s3#IsEnabled", - "traits": { - "smithy.api#documentation": "

Specifies whether the inventory is enabled or disabled. If set to True, an\n inventory list is generated. If set to False, no inventory list is\n generated.

", - "smithy.api#required": {} - } - }, - "Filter": { - "target": "com.amazonaws.s3#InventoryFilter", - "traits": { - "smithy.api#documentation": "

Specifies an inventory filter. The inventory only includes objects that meet the\n filter's criteria.

" - } - }, - "Id": { - "target": "com.amazonaws.s3#InventoryId", - "traits": { - "smithy.api#documentation": "

The ID used to identify the inventory configuration.

", - "smithy.api#required": {} - } - }, - "IncludedObjectVersions": { - "target": "com.amazonaws.s3#InventoryIncludedObjectVersions", - "traits": { - "smithy.api#documentation": "

Object versions to include in the inventory list. If set to All, the list\n includes all the object versions, which adds the version-related fields\n VersionId, IsLatest, and DeleteMarker to the\n list. If set to Current, the list does not contain these version-related\n fields.

", - "smithy.api#required": {} - } - }, - "OptionalFields": { - "target": "com.amazonaws.s3#InventoryOptionalFields", - "traits": { - "smithy.api#documentation": "

Contains the optional fields that are included in the inventory results.

" - } - }, - "Schedule": { - "target": "com.amazonaws.s3#InventorySchedule", - "traits": { - "smithy.api#documentation": "

Specifies the schedule for generating inventory results.

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

Specifies the inventory configuration for an Amazon S3 bucket. For more information, see\n GET Bucket inventory in the Amazon Simple Storage Service API Reference.\n

" - } - }, - "com.amazonaws.s3#InventoryConfigurationList": { - "type": "list", - "member": { - "target": "com.amazonaws.s3#InventoryConfiguration" - } - }, - "com.amazonaws.s3#InventoryDestination": { - "type": "structure", - "members": { - "S3BucketDestination": { - "target": "com.amazonaws.s3#InventoryS3BucketDestination", - "traits": { - "smithy.api#documentation": "

Contains the bucket name, file format, bucket owner (optional), and prefix (optional)\n where inventory results are published.

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

Specifies the inventory configuration for an Amazon S3 bucket.

" - } - }, - "com.amazonaws.s3#InventoryEncryption": { - "type": "structure", - "members": { - "SSES3": { - "target": "com.amazonaws.s3#SSES3", - "traits": { - "smithy.api#documentation": "

Specifies the use of SSE-S3 to encrypt delivered inventory reports.

", - "smithy.api#xmlName": "SSE-S3" - } - }, - "SSEKMS": { - "target": "com.amazonaws.s3#SSEKMS", - "traits": { - "smithy.api#documentation": "

Specifies the use of SSE-KMS to encrypt delivered inventory reports.

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

Contains the type of server-side encryption used to encrypt the inventory\n results.

" - } - }, - "com.amazonaws.s3#InventoryFilter": { - "type": "structure", - "members": { - "Prefix": { - "target": "com.amazonaws.s3#Prefix", - "traits": { - "smithy.api#documentation": "

The prefix that an object must have to be included in the inventory results.

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

Specifies an inventory filter. The inventory only includes objects that meet the\n filter's criteria.

" - } - }, - "com.amazonaws.s3#InventoryFormat": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CSV" - }, - { - "value": "ORC" - }, - { - "value": "Parquet" - } - ] - } - }, - "com.amazonaws.s3#InventoryFrequency": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Daily" - }, - { - "value": "Weekly" - } - ] - } - }, - "com.amazonaws.s3#InventoryId": { - "type": "string" - }, - "com.amazonaws.s3#InventoryIncludedObjectVersions": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "All" - }, - { - "value": "Current" - } - ] - } - }, - "com.amazonaws.s3#InventoryOptionalField": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Size" - }, - { - "value": "LastModifiedDate" - }, - { - "value": "StorageClass" - }, - { - "value": "ETag" - }, - { - "value": "IsMultipartUploaded" - }, - { - "value": "ReplicationStatus" - }, - { - "value": "EncryptionStatus" - }, - { - "value": "ObjectLockRetainUntilDate" - }, - { - "value": "ObjectLockMode" - }, - { - "value": "ObjectLockLegalHoldStatus" - }, - { - "value": "IntelligentTieringAccessTier" - } - ] - } - }, - "com.amazonaws.s3#InventoryOptionalFields": { - "type": "list", - "member": { - "target": "com.amazonaws.s3#InventoryOptionalField", - "traits": { - "smithy.api#xmlName": "Field" - } - } - }, - "com.amazonaws.s3#InventoryS3BucketDestination": { - "type": "structure", - "members": { - "AccountId": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "

The account ID that owns the destination S3 bucket. If no account ID is provided, the\n owner is not validated before exporting data.

\n \n

Although this value is optional, we strongly recommend that you set it to help\n prevent problems if the destination bucket ownership changes.

\n " - } - }, - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the bucket where inventory results will be\n published.

", - "smithy.api#required": {} - } - }, - "Format": { - "target": "com.amazonaws.s3#InventoryFormat", - "traits": { - "smithy.api#documentation": "

Specifies the output format of the inventory results.

", - "smithy.api#required": {} - } - }, - "Prefix": { - "target": "com.amazonaws.s3#Prefix", - "traits": { - "smithy.api#documentation": "

The prefix that is prepended to all inventory results.

" - } - }, - "Encryption": { - "target": "com.amazonaws.s3#InventoryEncryption", - "traits": { - "smithy.api#documentation": "

Contains the type of server-side encryption used to encrypt the inventory\n results.

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

Contains the bucket name, file format, bucket owner (optional), and prefix (optional)\n where inventory results are published.

" - } - }, - "com.amazonaws.s3#InventorySchedule": { - "type": "structure", - "members": { - "Frequency": { - "target": "com.amazonaws.s3#InventoryFrequency", - "traits": { - "smithy.api#documentation": "

Specifies how frequently inventory results are produced.

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

Specifies the schedule for generating inventory results.

" - } - }, - "com.amazonaws.s3#IsEnabled": { - "type": "boolean" - }, - "com.amazonaws.s3#IsLatest": { - "type": "boolean" - }, - "com.amazonaws.s3#IsPublic": { - "type": "boolean" - }, - "com.amazonaws.s3#IsTruncated": { - "type": "boolean" - }, - "com.amazonaws.s3#JSONInput": { - "type": "structure", - "members": { - "Type": { - "target": "com.amazonaws.s3#JSONType", - "traits": { - "smithy.api#documentation": "

The type of JSON. Valid values: Document, Lines.

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

Specifies JSON as object's input serialization format.

" - } - }, - "com.amazonaws.s3#JSONOutput": { - "type": "structure", - "members": { - "RecordDelimiter": { - "target": "com.amazonaws.s3#RecordDelimiter", - "traits": { - "smithy.api#documentation": "

The value used to separate individual records in the output. If no value is specified,\n Amazon S3 uses a newline character ('\\n').

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

Specifies JSON as request's output serialization format.

" - } - }, - "com.amazonaws.s3#JSONType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "DOCUMENT", - "name": "DOCUMENT" - }, - { - "value": "LINES", - "name": "LINES" - } - ] - } - }, - "com.amazonaws.s3#KMSContext": { - "type": "string" - }, - "com.amazonaws.s3#KeyCount": { - "type": "integer" - }, - "com.amazonaws.s3#KeyMarker": { - "type": "string" - }, - "com.amazonaws.s3#KeyPrefixEquals": { - "type": "string" - }, - "com.amazonaws.s3#LambdaFunctionArn": { - "type": "string" - }, - "com.amazonaws.s3#LambdaFunctionConfiguration": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.s3#NotificationId" - }, - "LambdaFunctionArn": { - "target": "com.amazonaws.s3#LambdaFunctionArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS Lambda function that Amazon S3 invokes when the\n specified event type occurs.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "CloudFunction" - } - }, - "Events": { - "target": "com.amazonaws.s3#EventList", - "traits": { - "smithy.api#documentation": "

The Amazon S3 bucket event for which to invoke the AWS Lambda function. For more information,\n see Supported\n Event Types in the Amazon Simple Storage Service Developer Guide.

", - "smithy.api#required": {}, - "smithy.api#xmlFlattened": {}, - "smithy.api#xmlName": "Event" - } - }, - "Filter": { - "target": "com.amazonaws.s3#NotificationConfigurationFilter" - } - }, - "traits": { - "smithy.api#documentation": "

A container for specifying the configuration for AWS Lambda notifications.

" - } - }, - "com.amazonaws.s3#LambdaFunctionConfigurationList": { - "type": "list", - "member": { - "target": "com.amazonaws.s3#LambdaFunctionConfiguration" - } - }, - "com.amazonaws.s3#LastModified": { - "type": "timestamp" - }, - "com.amazonaws.s3#LifecycleExpiration": { - "type": "structure", - "members": { - "Date": { - "target": "com.amazonaws.s3#Date", - "traits": { - "smithy.api#documentation": "

Indicates at what date the object is to be moved or deleted. Should be in GMT ISO 8601\n Format.

" - } - }, - "Days": { - "target": "com.amazonaws.s3#Days", - "traits": { - "smithy.api#documentation": "

Indicates the lifetime, in days, of the objects that are subject to the rule. The value\n must be a non-zero positive integer.

" - } - }, - "ExpiredObjectDeleteMarker": { - "target": "com.amazonaws.s3#ExpiredObjectDeleteMarker", - "traits": { - "smithy.api#documentation": "

Indicates whether Amazon S3 will remove a delete marker with no noncurrent versions. If set\n to true, the delete marker will be expired; if set to false the policy takes no action.\n This cannot be specified with Days or Date in a Lifecycle Expiration Policy.

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

Container for the expiration for the lifecycle of the object.

" - } - }, - "com.amazonaws.s3#LifecycleRule": { - "type": "structure", - "members": { - "Expiration": { - "target": "com.amazonaws.s3#LifecycleExpiration", - "traits": { - "smithy.api#documentation": "

Specifies the expiration for the lifecycle of the object in the form of date, days and,\n whether the object has a delete marker.

" - } - }, - "ID": { - "target": "com.amazonaws.s3#ID", - "traits": { - "smithy.api#documentation": "

Unique identifier for the rule. The value cannot be longer than 255 characters.

" - } - }, - "Prefix": { - "target": "com.amazonaws.s3#Prefix", - "traits": { - "smithy.api#deprecated": {}, - "smithy.api#documentation": "

Prefix identifying one or more objects to which the rule applies. This is\n No longer used; use Filter instead.

" - } - }, - "Filter": { - "target": "com.amazonaws.s3#LifecycleRuleFilter" - }, - "Status": { - "target": "com.amazonaws.s3#ExpirationStatus", - "traits": { - "smithy.api#documentation": "

If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is not\n currently being applied.

", - "smithy.api#required": {} - } - }, - "Transitions": { - "target": "com.amazonaws.s3#TransitionList", - "traits": { - "smithy.api#documentation": "

Specifies when an Amazon S3 object transitions to a specified storage class.

", - "smithy.api#xmlFlattened": {}, - "smithy.api#xmlName": "Transition" - } - }, - "NoncurrentVersionTransitions": { - "target": "com.amazonaws.s3#NoncurrentVersionTransitionList", - "traits": { - "smithy.api#documentation": "

Specifies the transition rule for the lifecycle rule that describes when noncurrent\n objects transition to a specific storage class. If your bucket is versioning-enabled (or\n versioning is suspended), you can set this action to request that Amazon S3 transition\n noncurrent object versions to a specific storage class at a set period in the object's\n lifetime.

", - "smithy.api#xmlFlattened": {}, - "smithy.api#xmlName": "NoncurrentVersionTransition" - } - }, - "NoncurrentVersionExpiration": { - "target": "com.amazonaws.s3#NoncurrentVersionExpiration" - }, - "AbortIncompleteMultipartUpload": { - "target": "com.amazonaws.s3#AbortIncompleteMultipartUpload" - } - }, - "traits": { - "smithy.api#documentation": "

A lifecycle rule for individual objects in an Amazon S3 bucket.

" - } - }, - "com.amazonaws.s3#LifecycleRuleAndOperator": { - "type": "structure", - "members": { - "Prefix": { - "target": "com.amazonaws.s3#Prefix", - "traits": { - "smithy.api#documentation": "

Prefix identifying one or more objects to which the rule applies.

" - } - }, - "Tags": { - "target": "com.amazonaws.s3#TagSet", - "traits": { - "smithy.api#documentation": "

All of these tags must exist in the object's tag set in order for the rule to\n apply.

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

This is used in a Lifecycle Rule Filter to apply a logical AND to two or more\n predicates. The Lifecycle Rule will apply to any object matching all of the predicates\n configured inside the And operator.

" - } - }, - "com.amazonaws.s3#LifecycleRuleFilter": { - "type": "union", - "members": { - "Prefix": { - "target": "com.amazonaws.s3#Prefix", - "traits": { - "smithy.api#documentation": "

Prefix identifying one or more objects to which the rule applies.

" - } - }, - "Tag": { - "target": "com.amazonaws.s3#Tag", - "traits": { - "smithy.api#documentation": "

This tag must exist in the object's tag set in order for the rule to apply.

" - } - }, - "And": { - "target": "com.amazonaws.s3#LifecycleRuleAndOperator" - } - }, - "traits": { - "smithy.api#documentation": "

The Filter is used to identify objects that a Lifecycle Rule applies to. A\n Filter must have exactly one of Prefix, Tag, or\n And specified.

" - } - }, - "com.amazonaws.s3#LifecycleRules": { - "type": "list", - "member": { - "target": "com.amazonaws.s3#LifecycleRule" - } - }, - "com.amazonaws.s3#ListBucketAnalyticsConfigurations": { - "type": "operation", - "input": { - "target": "com.amazonaws.s3#ListBucketAnalyticsConfigurationsRequest" - }, - "output": { - "target": "com.amazonaws.s3#ListBucketAnalyticsConfigurationsOutput" - }, - "traits": { - "smithy.api#documentation": "

Lists the analytics configurations for the bucket. You can have up to 1,000 analytics\n configurations per bucket.

\n\n

This operation supports list pagination and does not return more than 100 configurations\n at a time. You should always check the IsTruncated element in the response. If\n there are no more configurations to list, IsTruncated is set to false. If\n there are more configurations to list, IsTruncated is set to true, and there\n will be a value in NextContinuationToken. You use the\n NextContinuationToken value to continue the pagination of the list by\n passing the value in continuation-token in the request to GET the next\n page.

\n\n

To use this operation, you must have permissions to perform the\n s3:GetAnalyticsConfiguration action. The bucket owner has this permission\n by default. The bucket owner can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources.

\n\n

For information about Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class\n Analysis.

\n\n

The following operations are related to\n ListBucketAnalyticsConfigurations:

\n ", - "smithy.api#http": { - "method": "GET", - "uri": "/{Bucket}?analytics&x-id=ListBucketAnalyticsConfigurations", - "code": 200 - } - } - }, - "com.amazonaws.s3#ListBucketAnalyticsConfigurationsOutput": { - "type": "structure", - "members": { - "IsTruncated": { - "target": "com.amazonaws.s3#IsTruncated", - "traits": { - "smithy.api#documentation": "

Indicates whether the returned list of analytics configurations is complete. A value of\n true indicates that the list is not complete and the NextContinuationToken will be provided\n for a subsequent request.

" - } - }, - "ContinuationToken": { - "target": "com.amazonaws.s3#Token", - "traits": { - "smithy.api#documentation": "

The marker that is used as a starting point for this analytics configuration list\n response. This value is present if it was sent in the request.

" - } - }, - "NextContinuationToken": { - "target": "com.amazonaws.s3#NextToken", - "traits": { - "smithy.api#documentation": "

\n NextContinuationToken is sent when isTruncated is true, which\n indicates that there are more analytics configurations to list. The next request must\n include this NextContinuationToken. The token is obfuscated and is not a\n usable value.

" - } - }, - "AnalyticsConfigurationList": { - "target": "com.amazonaws.s3#AnalyticsConfigurationList", - "traits": { - "smithy.api#documentation": "

The list of analytics configurations for a bucket.

", - "smithy.api#xmlFlattened": {}, - "smithy.api#xmlName": "AnalyticsConfiguration" - } - } - } - }, - "com.amazonaws.s3#ListBucketAnalyticsConfigurationsRequest": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

The name of the bucket from which analytics configurations are retrieved.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ContinuationToken": { - "target": "com.amazonaws.s3#Token", - "traits": { - "smithy.api#documentation": "

The ContinuationToken that represents a placeholder from where this request should\n begin.

", - "smithy.api#httpQuery": "continuation-token" - } - }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", - "smithy.api#httpHeader": "x-amz-expected-bucket-owner" - } - } - } - }, - "com.amazonaws.s3#ListBucketIntelligentTieringConfigurations": { - "type": "operation", - "input": { - "target": "com.amazonaws.s3#ListBucketIntelligentTieringConfigurationsRequest" - }, - "output": { - "target": "com.amazonaws.s3#ListBucketIntelligentTieringConfigurationsOutput" - }, - "traits": { - "smithy.api#documentation": "

Lists the S3 Intelligent-Tiering configuration from the specified bucket.

\n

The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without additional operational overhead. S3 Intelligent-Tiering delivers automatic cost savings by moving data between access tiers, when access patterns change.

\n

The S3 Intelligent-Tiering storage class is suitable for objects larger than 128 KB that you plan to store for at least 30 days. If the size of an object is less than 128 KB, it is not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the frequent access tier rates in the S3 Intelligent-Tiering storage class.

\n

If you delete an object before the end of the 30-day minimum storage duration period, you are charged for 30 days. For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.

\n

Operations related to\n ListBucketIntelligentTieringConfigurations include:

\n ", - "smithy.api#http": { - "method": "GET", - "uri": "/{Bucket}?intelligent-tiering&x-id=ListBucketIntelligentTieringConfigurations", - "code": 200 - } - } - }, - "com.amazonaws.s3#ListBucketIntelligentTieringConfigurationsOutput": { - "type": "structure", - "members": { - "IsTruncated": { - "target": "com.amazonaws.s3#IsTruncated", - "traits": { - "smithy.api#documentation": "

Indicates whether the returned list of analytics configurations is complete. A value of\n true indicates that the list is not complete and the NextContinuationToken will be provided\n for a subsequent request.

" - } - }, - "ContinuationToken": { - "target": "com.amazonaws.s3#Token", - "traits": { - "smithy.api#documentation": "

The ContinuationToken that represents a placeholder from where this request should\n begin.

" - } - }, - "NextContinuationToken": { - "target": "com.amazonaws.s3#NextToken", - "traits": { - "smithy.api#documentation": "

The marker used to continue this inventory configuration listing. Use the\n NextContinuationToken from this response to continue the listing in a\n subsequent request. The continuation token is an opaque value that Amazon S3 understands.

" - } - }, - "IntelligentTieringConfigurationList": { - "target": "com.amazonaws.s3#IntelligentTieringConfigurationList", - "traits": { - "smithy.api#documentation": "

The list of S3 Intelligent-Tiering configurations for a bucket.

", - "smithy.api#xmlFlattened": {}, - "smithy.api#xmlName": "IntelligentTieringConfiguration" - } - } - } - }, - "com.amazonaws.s3#ListBucketIntelligentTieringConfigurationsRequest": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

The name of the Amazon S3 bucket whose configuration you want to modify or retrieve.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ContinuationToken": { - "target": "com.amazonaws.s3#Token", - "traits": { - "smithy.api#documentation": "

The ContinuationToken that represents a placeholder from where this request should\n begin.

", - "smithy.api#httpQuery": "continuation-token" - } - } - } - }, - "com.amazonaws.s3#ListBucketInventoryConfigurations": { - "type": "operation", - "input": { - "target": "com.amazonaws.s3#ListBucketInventoryConfigurationsRequest" - }, - "output": { - "target": "com.amazonaws.s3#ListBucketInventoryConfigurationsOutput" - }, - "traits": { - "smithy.api#documentation": "

Returns a list of inventory configurations for the bucket. You can have up to 1,000\n analytics configurations per bucket.

\n\n

This operation supports list pagination and does not return more than 100 configurations\n at a time. Always check the IsTruncated element in the response. If there are\n no more configurations to list, IsTruncated is set to false. If there are more\n configurations to list, IsTruncated is set to true, and there is a value in\n NextContinuationToken. You use the NextContinuationToken value\n to continue the pagination of the list by passing the value in continuation-token in the\n request to GET the next page.

\n\n

To use this operation, you must have permissions to perform the\n s3:GetInventoryConfiguration action. The bucket owner has this permission\n by default. The bucket owner can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources.

\n\n

For information about the Amazon S3 inventory feature, see Amazon S3 Inventory\n

\n\n

The following operations are related to\n ListBucketInventoryConfigurations:

\n ", - "smithy.api#http": { - "method": "GET", - "uri": "/{Bucket}?inventory&x-id=ListBucketInventoryConfigurations", - "code": 200 - } - } - }, - "com.amazonaws.s3#ListBucketInventoryConfigurationsOutput": { - "type": "structure", - "members": { - "ContinuationToken": { - "target": "com.amazonaws.s3#Token", - "traits": { - "smithy.api#documentation": "

If sent in the request, the marker that is used as a starting point for this inventory\n configuration list response.

" - } - }, - "InventoryConfigurationList": { - "target": "com.amazonaws.s3#InventoryConfigurationList", - "traits": { - "smithy.api#documentation": "

The list of inventory configurations for a bucket.

", - "smithy.api#xmlFlattened": {}, - "smithy.api#xmlName": "InventoryConfiguration" - } - }, - "IsTruncated": { - "target": "com.amazonaws.s3#IsTruncated", - "traits": { - "smithy.api#documentation": "

Tells whether the returned list of inventory configurations is complete. A value of true\n indicates that the list is not complete and the NextContinuationToken is provided for a\n subsequent request.

" - } - }, - "NextContinuationToken": { - "target": "com.amazonaws.s3#NextToken", - "traits": { - "smithy.api#documentation": "

The marker used to continue this inventory configuration listing. Use the\n NextContinuationToken from this response to continue the listing in a\n subsequent request. The continuation token is an opaque value that Amazon S3 understands.

" - } - } - } - }, - "com.amazonaws.s3#ListBucketInventoryConfigurationsRequest": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

The name of the bucket containing the inventory configurations to retrieve.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ContinuationToken": { - "target": "com.amazonaws.s3#Token", - "traits": { - "smithy.api#documentation": "

The marker used to continue an inventory configuration listing that has been truncated.\n Use the NextContinuationToken from a previously truncated list response to continue the\n listing. The continuation token is an opaque value that Amazon S3 understands.

", - "smithy.api#httpQuery": "continuation-token" - } - }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", - "smithy.api#httpHeader": "x-amz-expected-bucket-owner" - } - } - } - }, - "com.amazonaws.s3#ListBucketMetricsConfigurations": { - "type": "operation", - "input": { - "target": "com.amazonaws.s3#ListBucketMetricsConfigurationsRequest" - }, - "output": { - "target": "com.amazonaws.s3#ListBucketMetricsConfigurationsOutput" - }, - "traits": { - "smithy.api#documentation": "

Lists the metrics configurations for the bucket. The metrics configurations are only for\n the request metrics of the bucket and do not provide information on daily storage metrics.\n You can have up to 1,000 configurations per bucket.

\n\n

This operation supports list pagination and does not return more than 100 configurations\n at a time. Always check the IsTruncated element in the response. If there are\n no more configurations to list, IsTruncated is set to false. If there are more\n configurations to list, IsTruncated is set to true, and there is a value in\n NextContinuationToken. You use the NextContinuationToken value\n to continue the pagination of the list by passing the value in\n continuation-token in the request to GET the next page.

\n\n

To use this operation, you must have permissions to perform the\n s3:GetMetricsConfiguration action. The bucket owner has this permission by\n default. The bucket owner can grant this permission to others. For more information about\n permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources.

\n\n

For more information about metrics configurations and CloudWatch request metrics, see\n Monitoring Metrics with Amazon\n CloudWatch.

\n\n

The following operations are related to\n ListBucketMetricsConfigurations:

\n ", - "smithy.api#http": { - "method": "GET", - "uri": "/{Bucket}?metrics&x-id=ListBucketMetricsConfigurations", - "code": 200 - } - } - }, - "com.amazonaws.s3#ListBucketMetricsConfigurationsOutput": { - "type": "structure", - "members": { - "IsTruncated": { - "target": "com.amazonaws.s3#IsTruncated", - "traits": { - "smithy.api#documentation": "

Indicates whether the returned list of metrics configurations is complete. A value of\n true indicates that the list is not complete and the NextContinuationToken will be provided\n for a subsequent request.

" - } - }, - "ContinuationToken": { - "target": "com.amazonaws.s3#Token", - "traits": { - "smithy.api#documentation": "

The marker that is used as a starting point for this metrics configuration list\n response. This value is present if it was sent in the request.

" - } - }, - "NextContinuationToken": { - "target": "com.amazonaws.s3#NextToken", - "traits": { - "smithy.api#documentation": "

The marker used to continue a metrics configuration listing that has been truncated. Use\n the NextContinuationToken from a previously truncated list response to\n continue the listing. The continuation token is an opaque value that Amazon S3\n understands.

" - } - }, - "MetricsConfigurationList": { - "target": "com.amazonaws.s3#MetricsConfigurationList", - "traits": { - "smithy.api#documentation": "

The list of metrics configurations for a bucket.

", - "smithy.api#xmlFlattened": {}, - "smithy.api#xmlName": "MetricsConfiguration" - } - } - } - }, - "com.amazonaws.s3#ListBucketMetricsConfigurationsRequest": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

The name of the bucket containing the metrics configurations to retrieve.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ContinuationToken": { - "target": "com.amazonaws.s3#Token", - "traits": { - "smithy.api#documentation": "

The marker that is used to continue a metrics configuration listing that has been\n truncated. Use the NextContinuationToken from a previously truncated list response to\n continue the listing. The continuation token is an opaque value that Amazon S3\n understands.

", - "smithy.api#httpQuery": "continuation-token" - } - }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", - "smithy.api#httpHeader": "x-amz-expected-bucket-owner" - } - } - } - }, - "com.amazonaws.s3#ListBuckets": { - "type": "operation", - "output": { - "target": "com.amazonaws.s3#ListBucketsOutput" - }, - "traits": { - "smithy.api#documentation": "

Returns a list of all buckets owned by the authenticated sender of the request.

", - "smithy.api#http": { - "method": "GET", - "uri": "/", - "code": 200 - } - } - }, - "com.amazonaws.s3#ListBucketsOutput": { - "type": "structure", - "members": { - "Buckets": { - "target": "com.amazonaws.s3#Buckets", - "traits": { - "smithy.api#documentation": "

The list of buckets owned by the requestor.

" - } - }, - "Owner": { - "target": "com.amazonaws.s3#Owner", - "traits": { - "smithy.api#documentation": "

The owner of the buckets listed.

" - } - } - } - }, - "com.amazonaws.s3#ListMultipartUploads": { - "type": "operation", - "input": { - "target": "com.amazonaws.s3#ListMultipartUploadsRequest" - }, - "output": { - "target": "com.amazonaws.s3#ListMultipartUploadsOutput" - }, - "traits": { - "smithy.api#documentation": "

This operation lists in-progress multipart uploads. An in-progress multipart upload is a\n multipart upload that has been initiated using the Initiate Multipart Upload request, but\n has not yet been completed or aborted.

\n\n

This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart\n uploads is the maximum number of uploads a response can include, which is also the default\n value. You can further limit the number of uploads in a response by specifying the\n max-uploads parameter in the response. If additional multipart uploads\n satisfy the list criteria, the response will contain an IsTruncated element\n with the value true. To list the additional multipart uploads, use the\n key-marker and upload-id-marker request parameters.

\n\n

In the response, the uploads are sorted by key. If your application has initiated more\n than one multipart upload using the same object key, then uploads in the response are first\n sorted by key. Additionally, uploads are sorted in ascending order within each key by the\n upload initiation time.

\n\n

For more information on multipart uploads, see Uploading Objects Using Multipart\n Upload.

\n\n

For information on permissions required to use the multipart upload API, see Multipart Upload API and\n Permissions.

\n\n

The following operations are related to ListMultipartUploads:

\n ", - "smithy.api#http": { - "method": "GET", - "uri": "/{Bucket}?uploads", - "code": 200 - } - } - }, - "com.amazonaws.s3#ListMultipartUploadsOutput": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

The name of the bucket to which the multipart upload was initiated.

" - } - }, - "KeyMarker": { - "target": "com.amazonaws.s3#KeyMarker", - "traits": { - "smithy.api#documentation": "

The key at or after which the listing began.

" - } - }, - "UploadIdMarker": { - "target": "com.amazonaws.s3#UploadIdMarker", - "traits": { - "smithy.api#documentation": "

Upload ID after which listing began.

" - } - }, - "NextKeyMarker": { - "target": "com.amazonaws.s3#NextKeyMarker", - "traits": { - "smithy.api#documentation": "

When a list is truncated, this element specifies the value that should be used for the\n key-marker request parameter in a subsequent request.

" - } - }, - "Prefix": { - "target": "com.amazonaws.s3#Prefix", - "traits": { - "smithy.api#documentation": "

When a prefix is provided in the request, this field contains the specified prefix. The\n result contains only keys starting with the specified prefix.

" - } - }, - "Delimiter": { - "target": "com.amazonaws.s3#Delimiter", - "traits": { - "smithy.api#documentation": "

Contains the delimiter you specified in the request. If you don't specify a delimiter in\n your request, this element is absent from the response.

" - } - }, - "NextUploadIdMarker": { - "target": "com.amazonaws.s3#NextUploadIdMarker", - "traits": { - "smithy.api#documentation": "

When a list is truncated, this element specifies the value that should be used for the\n upload-id-marker request parameter in a subsequent request.

" - } - }, - "MaxUploads": { - "target": "com.amazonaws.s3#MaxUploads", - "traits": { - "smithy.api#documentation": "

Maximum number of multipart uploads that could have been included in the\n response.

" - } - }, - "IsTruncated": { - "target": "com.amazonaws.s3#IsTruncated", - "traits": { - "smithy.api#documentation": "

Indicates whether the returned list of multipart uploads is truncated. A value of true\n indicates that the list was truncated. The list can be truncated if the number of multipart\n uploads exceeds the limit allowed or specified by max uploads.

" - } - }, - "Uploads": { - "target": "com.amazonaws.s3#MultipartUploadList", - "traits": { - "smithy.api#documentation": "

Container for elements related to a particular multipart upload. A response can contain\n zero or more Upload elements.

", - "smithy.api#xmlFlattened": {}, - "smithy.api#xmlName": "Upload" - } - }, - "CommonPrefixes": { - "target": "com.amazonaws.s3#CommonPrefixList", - "traits": { - "smithy.api#documentation": "

If you specify a delimiter in the request, then the result returns each distinct key\n prefix containing the delimiter in a CommonPrefixes element. The distinct key\n prefixes are returned in the Prefix child element.

", - "smithy.api#xmlFlattened": {} - } - }, - "EncodingType": { - "target": "com.amazonaws.s3#EncodingType", - "traits": { - "smithy.api#documentation": "

Encoding type used by Amazon S3 to encode object keys in the response.

\n

If you specify encoding-type request parameter, Amazon S3 includes this element\n in the response, and returns encoded key name values in the following response\n elements:

\n\n

\n Delimiter, KeyMarker, Prefix,\n NextKeyMarker, Key.

" - } - } - } - }, - "com.amazonaws.s3#ListMultipartUploadsRequest": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

The name of the bucket to which the multipart upload was initiated.

\n

When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.

\n

When using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Delimiter": { - "target": "com.amazonaws.s3#Delimiter", - "traits": { - "smithy.api#documentation": "

Character you use to group keys.

\n

All keys that contain the same string between the prefix, if specified, and the first\n occurrence of the delimiter after the prefix are grouped under a single result element,\n CommonPrefixes. If you don't specify the prefix parameter, then the\n substring starts at the beginning of the key. The keys that are grouped under\n CommonPrefixes result element are not returned elsewhere in the\n response.

", - "smithy.api#httpQuery": "delimiter" - } - }, - "EncodingType": { - "target": "com.amazonaws.s3#EncodingType", - "traits": { - "smithy.api#httpQuery": "encoding-type" - } - }, - "KeyMarker": { - "target": "com.amazonaws.s3#KeyMarker", - "traits": { - "smithy.api#documentation": "

Together with upload-id-marker, this parameter specifies the multipart upload after\n which listing should begin.

\n

If upload-id-marker is not specified, only the keys lexicographically\n greater than the specified key-marker will be included in the list.

\n\n

If upload-id-marker is specified, any multipart uploads for a key equal to\n the key-marker might also be included, provided those multipart uploads have\n upload IDs lexicographically greater than the specified\n upload-id-marker.

", - "smithy.api#httpQuery": "key-marker" - } - }, - "MaxUploads": { - "target": "com.amazonaws.s3#MaxUploads", - "traits": { - "smithy.api#documentation": "

Sets the maximum number of multipart uploads, from 1 to 1,000, to return in the response\n body. 1,000 is the maximum number of uploads that can be returned in a response.

", - "smithy.api#httpQuery": "max-uploads" - } - }, - "Prefix": { - "target": "com.amazonaws.s3#Prefix", - "traits": { - "smithy.api#documentation": "

Lists in-progress uploads only for those keys that begin with the specified prefix. You\n can use prefixes to separate a bucket into different grouping of keys. (You can think of\n using prefix to make groups in the same way you'd use a folder in a file system.)

", - "smithy.api#httpQuery": "prefix" - } - }, - "UploadIdMarker": { - "target": "com.amazonaws.s3#UploadIdMarker", - "traits": { - "smithy.api#documentation": "

Together with key-marker, specifies the multipart upload after which listing should\n begin. If key-marker is not specified, the upload-id-marker parameter is ignored.\n Otherwise, any multipart uploads for a key equal to the key-marker might be included in the\n list only if they have an upload ID lexicographically greater than the specified\n upload-id-marker.

", - "smithy.api#httpQuery": "upload-id-marker" - } - }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", - "smithy.api#httpHeader": "x-amz-expected-bucket-owner" - } - } - } - }, - "com.amazonaws.s3#ListObjectVersions": { - "type": "operation", - "input": { - "target": "com.amazonaws.s3#ListObjectVersionsRequest" - }, - "output": { - "target": "com.amazonaws.s3#ListObjectVersionsOutput" - }, - "traits": { - "smithy.api#documentation": "

Returns metadata about all versions of the objects in a bucket. You can also use request\n parameters as selection criteria to return metadata about a subset of all the object\n versions.

\n \n

A 200 OK response can contain valid or invalid XML. Make sure to design your\n application to parse the contents of the response and handle it appropriately.

\n \n

To use this operation, you must have READ access to the bucket.

\n

This action is not supported by Amazon S3 on Outposts.

\n

The following operations are related to\n ListObjectVersions:

\n ", - "smithy.api#http": { - "method": "GET", - "uri": "/{Bucket}?versions", - "code": 200 - } - } - }, - "com.amazonaws.s3#ListObjectVersionsOutput": { - "type": "structure", - "members": { - "IsTruncated": { - "target": "com.amazonaws.s3#IsTruncated", - "traits": { - "smithy.api#documentation": "

A flag that indicates whether Amazon S3 returned all of the results that satisfied the search\n criteria. If your results were truncated, you can make a follow-up paginated request using\n the NextKeyMarker and NextVersionIdMarker response parameters as a starting place in\n another request to return the rest of the results.

" - } - }, - "KeyMarker": { - "target": "com.amazonaws.s3#KeyMarker", - "traits": { - "smithy.api#documentation": "

Marks the last key returned in a truncated response.

" - } - }, - "VersionIdMarker": { - "target": "com.amazonaws.s3#VersionIdMarker", - "traits": { - "smithy.api#documentation": "

Marks the last version of the key returned in a truncated response.

" - } - }, - "NextKeyMarker": { - "target": "com.amazonaws.s3#NextKeyMarker", - "traits": { - "smithy.api#documentation": "

When the number of responses exceeds the value of MaxKeys,\n NextKeyMarker specifies the first key not returned that satisfies the\n search criteria. Use this value for the key-marker request parameter in a subsequent\n request.

" - } - }, - "NextVersionIdMarker": { - "target": "com.amazonaws.s3#NextVersionIdMarker", - "traits": { - "smithy.api#documentation": "

When the number of responses exceeds the value of MaxKeys,\n NextVersionIdMarker specifies the first object version not returned that\n satisfies the search criteria. Use this value for the version-id-marker request parameter\n in a subsequent request.

" - } - }, - "Versions": { - "target": "com.amazonaws.s3#ObjectVersionList", - "traits": { - "smithy.api#documentation": "

Container for version information.

", - "smithy.api#xmlFlattened": {}, - "smithy.api#xmlName": "Version" - } - }, - "DeleteMarkers": { - "target": "com.amazonaws.s3#DeleteMarkers", - "traits": { - "smithy.api#documentation": "

Container for an object that is a delete marker.

", - "smithy.api#xmlFlattened": {}, - "smithy.api#xmlName": "DeleteMarker" - } - }, - "Name": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

The bucket name.

" - } - }, - "Prefix": { - "target": "com.amazonaws.s3#Prefix", - "traits": { - "smithy.api#documentation": "

Selects objects that start with the value supplied by this parameter.

" - } - }, - "Delimiter": { - "target": "com.amazonaws.s3#Delimiter", - "traits": { - "smithy.api#documentation": "

The delimiter grouping the included keys. A delimiter is a character that you specify to\n group keys. All keys that contain the same string between the prefix and the first\n occurrence of the delimiter are grouped under a single result element in\n CommonPrefixes. These groups are counted as one result against the max-keys\n limitation. These keys are not returned elsewhere in the response.

" - } - }, - "MaxKeys": { - "target": "com.amazonaws.s3#MaxKeys", - "traits": { - "smithy.api#documentation": "

Specifies the maximum number of objects to return.

" - } - }, - "CommonPrefixes": { - "target": "com.amazonaws.s3#CommonPrefixList", - "traits": { - "smithy.api#documentation": "

All of the keys rolled up into a common prefix count as a single return when calculating\n the number of returns.

", - "smithy.api#xmlFlattened": {} - } - }, - "EncodingType": { - "target": "com.amazonaws.s3#EncodingType", - "traits": { - "smithy.api#documentation": "

Encoding type used by Amazon S3 to encode object key names in the XML response.

\n\n

If you specify encoding-type request parameter, Amazon S3 includes this element in the\n response, and returns encoded key name values in the following response elements:

\n\n

\n KeyMarker, NextKeyMarker, Prefix, Key, and Delimiter.

" - } - } - } - }, - "com.amazonaws.s3#ListObjectVersionsRequest": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

The bucket name that contains the objects.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Delimiter": { - "target": "com.amazonaws.s3#Delimiter", - "traits": { - "smithy.api#documentation": "

A delimiter is a character that you specify to group keys. All keys that contain the\n same string between the prefix and the first occurrence of the delimiter are\n grouped under a single result element in CommonPrefixes. These groups are counted as one\n result against the max-keys limitation. These keys are not returned elsewhere in the\n response.

", - "smithy.api#httpQuery": "delimiter" - } - }, - "EncodingType": { - "target": "com.amazonaws.s3#EncodingType", - "traits": { - "smithy.api#httpQuery": "encoding-type" - } - }, - "KeyMarker": { - "target": "com.amazonaws.s3#KeyMarker", - "traits": { - "smithy.api#documentation": "

Specifies the key to start with when listing objects in a bucket.

", - "smithy.api#httpQuery": "key-marker" - } - }, - "MaxKeys": { - "target": "com.amazonaws.s3#MaxKeys", - "traits": { - "smithy.api#documentation": "

Sets the maximum number of keys returned in the response. By default the API returns up\n to 1,000 key names. The response might contain fewer keys but will never contain more. If\n additional keys satisfy the search criteria, but were not returned because max-keys was\n exceeded, the response contains true. To return the\n additional keys, see key-marker and version-id-marker.

", - "smithy.api#httpQuery": "max-keys" - } - }, - "Prefix": { - "target": "com.amazonaws.s3#Prefix", - "traits": { - "smithy.api#documentation": "

Use this parameter to select only those keys that begin with the specified prefix. You\n can use prefixes to separate a bucket into different groupings of keys. (You can think of\n using prefix to make groups in the same way you'd use a folder in a file system.) You can\n use prefix with delimiter to roll up numerous objects into a single result under\n CommonPrefixes.

", - "smithy.api#httpQuery": "prefix" - } - }, - "VersionIdMarker": { - "target": "com.amazonaws.s3#VersionIdMarker", - "traits": { - "smithy.api#documentation": "

Specifies the object version you want to start listing from.

", - "smithy.api#httpQuery": "version-id-marker" - } - }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", - "smithy.api#httpHeader": "x-amz-expected-bucket-owner" - } - } - } - }, - "com.amazonaws.s3#ListObjects": { - "type": "operation", - "input": { - "target": "com.amazonaws.s3#ListObjectsRequest" - }, - "output": { - "target": "com.amazonaws.s3#ListObjectsOutput" - }, - "errors": [ - { - "target": "com.amazonaws.s3#NoSuchBucket" - } - ], - "traits": { - "smithy.api#documentation": "

Returns some or all (up to 1,000) of the objects in a bucket. You can use the request\n parameters as selection criteria to return a subset of the objects in a bucket. A 200 OK\n response can contain valid or invalid XML. Be sure to design your application to parse the\n contents of the response and handle it appropriately.

\n \n

This API has been revised. We recommend that you use the newer version, ListObjectsV2, when developing applications. For backward compatibility,\n Amazon S3 continues to support ListObjects.

\n \n\n\n

The following operations are related to ListObjects:

\n ", - "smithy.api#http": { - "method": "GET", - "uri": "/{Bucket}", - "code": 200 - } - } - }, - "com.amazonaws.s3#ListObjectsOutput": { - "type": "structure", - "members": { - "IsTruncated": { - "target": "com.amazonaws.s3#IsTruncated", - "traits": { - "smithy.api#documentation": "

A flag that indicates whether Amazon S3 returned all of the results that satisfied the search\n criteria.

" - } - }, - "Marker": { - "target": "com.amazonaws.s3#Marker", - "traits": { - "smithy.api#documentation": "

Indicates where in the bucket listing begins. Marker is included in the response if it\n was sent with the request.

" - } - }, - "NextMarker": { - "target": "com.amazonaws.s3#NextMarker", - "traits": { - "smithy.api#documentation": "

When response is truncated (the IsTruncated element value in the response is true), you\n can use the key name in this field as marker in the subsequent request to get next set of\n objects. Amazon S3 lists objects in alphabetical order Note: This element is returned only if\n you have delimiter request parameter specified. If response does not include the NextMarker\n and it is truncated, you can use the value of the last Key in the response as the marker in\n the subsequent request to get the next set of object keys.

" - } - }, - "Contents": { - "target": "com.amazonaws.s3#ObjectList", - "traits": { - "smithy.api#documentation": "

Metadata about each object returned.

", - "smithy.api#xmlFlattened": {} - } - }, - "Name": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

The bucket name.

" - } - }, - "Prefix": { - "target": "com.amazonaws.s3#Prefix", - "traits": { - "smithy.api#documentation": "

Keys that begin with the indicated prefix.

" - } - }, - "Delimiter": { - "target": "com.amazonaws.s3#Delimiter", - "traits": { - "smithy.api#documentation": "

Causes keys that contain the same string between the prefix and the first occurrence of\n the delimiter to be rolled up into a single result element in the\n CommonPrefixes collection. These rolled-up keys are not returned elsewhere\n in the response. Each rolled-up result counts as only one return against the\n MaxKeys value.

" - } - }, - "MaxKeys": { - "target": "com.amazonaws.s3#MaxKeys", - "traits": { - "smithy.api#documentation": "

The maximum number of keys returned in the response body.

" - } - }, - "CommonPrefixes": { - "target": "com.amazonaws.s3#CommonPrefixList", - "traits": { - "smithy.api#documentation": "

All of the keys rolled up in a common prefix count as a single return when calculating\n the number of returns.

\n\n

A response can contain CommonPrefixes only if you specify a delimiter.

\n\n

CommonPrefixes contains all (if there are any) keys between Prefix and the next\n occurrence of the string specified by the delimiter.

\n\n

CommonPrefixes lists keys that act like subdirectories in the directory specified by\n Prefix.

\n\n

For example, if the prefix is notes/ and the delimiter is a slash (/) as in\n notes/summer/july, the common prefix is notes/summer/. All of the keys that roll up into a\n common prefix count as a single return when calculating the number of returns.

", - "smithy.api#xmlFlattened": {} - } - }, - "EncodingType": { - "target": "com.amazonaws.s3#EncodingType", - "traits": { - "smithy.api#documentation": "

Encoding type used by Amazon S3 to encode object keys in the response.

" - } - } - } - }, - "com.amazonaws.s3#ListObjectsRequest": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

The name of the bucket containing the objects.

\n

When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.

\n

When using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Delimiter": { - "target": "com.amazonaws.s3#Delimiter", - "traits": { - "smithy.api#documentation": "

A delimiter is a character you use to group keys.

", - "smithy.api#httpQuery": "delimiter" - } - }, - "EncodingType": { - "target": "com.amazonaws.s3#EncodingType", - "traits": { - "smithy.api#httpQuery": "encoding-type" - } - }, - "Marker": { - "target": "com.amazonaws.s3#Marker", - "traits": { - "smithy.api#documentation": "

Specifies the key to start with when listing objects in a bucket.

", - "smithy.api#httpQuery": "marker" - } - }, - "MaxKeys": { - "target": "com.amazonaws.s3#MaxKeys", - "traits": { - "smithy.api#documentation": "

Sets the maximum number of keys returned in the response. By default the API returns up\n to 1,000 key names. The response might contain fewer keys but will never contain more.\n

", - "smithy.api#httpQuery": "max-keys" - } - }, - "Prefix": { - "target": "com.amazonaws.s3#Prefix", - "traits": { - "smithy.api#documentation": "

Limits the response to keys that begin with the specified prefix.

", - "smithy.api#httpQuery": "prefix" - } - }, - "RequestPayer": { - "target": "com.amazonaws.s3#RequestPayer", - "traits": { - "smithy.api#documentation": "

Confirms that the requester knows that she or he will be charged for the list objects\n request. Bucket owners need not specify this parameter in their requests.

", - "smithy.api#httpHeader": "x-amz-request-payer" - } - }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", - "smithy.api#httpHeader": "x-amz-expected-bucket-owner" - } - } - } - }, - "com.amazonaws.s3#ListObjectsV2": { - "type": "operation", - "input": { - "target": "com.amazonaws.s3#ListObjectsV2Request" - }, - "output": { - "target": "com.amazonaws.s3#ListObjectsV2Output" - }, - "errors": [ - { - "target": "com.amazonaws.s3#NoSuchBucket" - } - ], - "traits": { - "smithy.api#documentation": "

Returns some or all (up to 1,000) of the objects in a bucket. You can use the request\n parameters as selection criteria to return a subset of the objects in a bucket. A 200\n OK response can contain valid or invalid XML. Make sure to design your\n application to parse the contents of the response and handle it appropriately.

\n\n

To use this operation, you must have READ access to the bucket.

\n\n

To use this operation in an AWS Identity and Access Management (IAM) policy, you must\n have permissions to perform the s3:ListBucket action. The bucket owner has\n this permission by default and can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources.

\n \n

This section describes the latest revision of the API. We recommend that you use this\n revised API for application development. For backward compatibility, Amazon S3 continues to\n support the prior version of this API, ListObjects.

\n \n\n

To get a list of your buckets, see ListBuckets.

\n\n

The following operations are related to ListObjectsV2:

\n ", - "smithy.api#http": { - "method": "GET", - "uri": "/{Bucket}?list-type=2", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "ContinuationToken", - "outputToken": "NextContinuationToken", - "pageSize": "MaxKeys" - } - } - }, - "com.amazonaws.s3#ListObjectsV2Output": { - "type": "structure", - "members": { - "IsTruncated": { - "target": "com.amazonaws.s3#IsTruncated", - "traits": { - "smithy.api#documentation": "

Set to false if all of the results were returned. Set to true if more keys are available\n to return. If the number of results exceeds that specified by MaxKeys, all of the results\n might not be returned.

" - } - }, - "Contents": { - "target": "com.amazonaws.s3#ObjectList", - "traits": { - "smithy.api#documentation": "

Metadata about each object returned.

", - "smithy.api#xmlFlattened": {} - } - }, - "Name": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

The bucket name.

\n

When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.

\n

When using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.

" - } - }, - "Prefix": { - "target": "com.amazonaws.s3#Prefix", - "traits": { - "smithy.api#documentation": "

Keys that begin with the indicated prefix.

" - } - }, - "Delimiter": { - "target": "com.amazonaws.s3#Delimiter", - "traits": { - "smithy.api#documentation": "

Causes keys that contain the same string between the prefix and the first occurrence of\n the delimiter to be rolled up into a single result element in the CommonPrefixes\n collection. These rolled-up keys are not returned elsewhere in the response. Each rolled-up\n result counts as only one return against the MaxKeys value.

" - } - }, - "MaxKeys": { - "target": "com.amazonaws.s3#MaxKeys", - "traits": { - "smithy.api#documentation": "

Sets the maximum number of keys returned in the response. By default the API returns up\n to 1,000 key names. The response might contain fewer keys but will never contain\n more.

" - } - }, - "CommonPrefixes": { - "target": "com.amazonaws.s3#CommonPrefixList", - "traits": { - "smithy.api#documentation": "

All of the keys rolled up into a common prefix count as a single return when calculating\n the number of returns.

\n\n

A response can contain CommonPrefixes only if you specify a\n delimiter.

\n\n

\n CommonPrefixes contains all (if there are any) keys between\n Prefix and the next occurrence of the string specified by a\n delimiter.

\n\n

\n CommonPrefixes lists keys that act like subdirectories in the directory\n specified by Prefix.

\n\n

For example, if the prefix is notes/ and the delimiter is a slash\n (/) as in notes/summer/july, the common prefix is\n notes/summer/. All of the keys that roll up into a common prefix count as a\n single return when calculating the number of returns.

", - "smithy.api#xmlFlattened": {} - } - }, - "EncodingType": { - "target": "com.amazonaws.s3#EncodingType", - "traits": { - "smithy.api#documentation": "

Encoding type used by Amazon S3 to encode object key names in the XML response.

\n\n

If you specify the encoding-type request parameter, Amazon S3 includes this element in the\n response, and returns encoded key name values in the following response elements:

\n\n

\n Delimiter, Prefix, Key, and StartAfter.

" - } - }, - "KeyCount": { - "target": "com.amazonaws.s3#KeyCount", - "traits": { - "smithy.api#documentation": "

KeyCount is the number of keys returned with this request. KeyCount will always be less\n than equals to MaxKeys field. Say you ask for 50 keys, your result will include less than\n equals 50 keys

" - } - }, - "ContinuationToken": { - "target": "com.amazonaws.s3#Token", - "traits": { - "smithy.api#documentation": "

If ContinuationToken was sent with the request, it is included in the response.

" - } - }, - "NextContinuationToken": { - "target": "com.amazonaws.s3#NextToken", - "traits": { - "smithy.api#documentation": "

\n NextContinuationToken is sent when isTruncated is true, which\n means there are more keys in the bucket that can be listed. The next list requests to Amazon S3\n can be continued with this NextContinuationToken.\n NextContinuationToken is obfuscated and is not a real key

" - } - }, - "StartAfter": { - "target": "com.amazonaws.s3#StartAfter", - "traits": { - "smithy.api#documentation": "

If StartAfter was sent with the request, it is included in the response.

" - } - } - } - }, - "com.amazonaws.s3#ListObjectsV2Request": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

Bucket name to list.

\n

When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.

\n

When using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Delimiter": { - "target": "com.amazonaws.s3#Delimiter", - "traits": { - "smithy.api#documentation": "

A delimiter is a character you use to group keys.

", - "smithy.api#httpQuery": "delimiter" - } - }, - "EncodingType": { - "target": "com.amazonaws.s3#EncodingType", - "traits": { - "smithy.api#documentation": "

Encoding type used by Amazon S3 to encode object keys in the response.

", - "smithy.api#httpQuery": "encoding-type" - } - }, - "MaxKeys": { - "target": "com.amazonaws.s3#MaxKeys", - "traits": { - "smithy.api#documentation": "

Sets the maximum number of keys returned in the response. By default the API returns up\n to 1,000 key names. The response might contain fewer keys but will never contain\n more.

", - "smithy.api#httpQuery": "max-keys" - } - }, - "Prefix": { - "target": "com.amazonaws.s3#Prefix", - "traits": { - "smithy.api#documentation": "

Limits the response to keys that begin with the specified prefix.

", - "smithy.api#httpQuery": "prefix" - } - }, - "ContinuationToken": { - "target": "com.amazonaws.s3#Token", - "traits": { - "smithy.api#documentation": "

ContinuationToken indicates Amazon S3 that the list is being continued on this bucket with a\n token. ContinuationToken is obfuscated and is not a real key.

", - "smithy.api#httpQuery": "continuation-token" - } - }, - "FetchOwner": { - "target": "com.amazonaws.s3#FetchOwner", - "traits": { - "smithy.api#documentation": "

The owner field is not present in listV2 by default, if you want to return owner field\n with each key in the result then set the fetch owner field to true.

", - "smithy.api#httpQuery": "fetch-owner" - } - }, - "StartAfter": { - "target": "com.amazonaws.s3#StartAfter", - "traits": { - "smithy.api#documentation": "

StartAfter is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this\n specified key. StartAfter can be any key in the bucket.

", - "smithy.api#httpQuery": "start-after" - } - }, - "RequestPayer": { - "target": "com.amazonaws.s3#RequestPayer", - "traits": { - "smithy.api#documentation": "

Confirms that the requester knows that she or he will be charged for the list objects\n request in V2 style. Bucket owners need not specify this parameter in their\n requests.

", - "smithy.api#httpHeader": "x-amz-request-payer" - } - }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", - "smithy.api#httpHeader": "x-amz-expected-bucket-owner" - } - } - } - }, - "com.amazonaws.s3#ListParts": { - "type": "operation", - "input": { - "target": "com.amazonaws.s3#ListPartsRequest" - }, - "output": { - "target": "com.amazonaws.s3#ListPartsOutput" - }, - "traits": { - "smithy.api#documentation": "

Lists the parts that have been uploaded for a specific multipart upload. This operation\n must include the upload ID, which you obtain by sending the initiate multipart upload\n request (see CreateMultipartUpload).\n This request returns a maximum of 1,000 uploaded parts. The default number of parts\n returned is 1,000 parts. You can restrict the number of parts returned by specifying the\n max-parts request parameter. If your multipart upload consists of more than\n 1,000 parts, the response returns an IsTruncated field with the value of true,\n and a NextPartNumberMarker element. In subsequent ListParts\n requests you can include the part-number-marker query string parameter and set its value to\n the NextPartNumberMarker field value from the previous response.

\n\n

For more information on multipart uploads, see Uploading Objects Using Multipart\n Upload.

\n\n

For information on permissions required to use the multipart upload API, see Multipart Upload API and\n Permissions.

\n\n

The following operations are related to ListParts:

\n ", - "smithy.api#http": { - "method": "GET", - "uri": "/{Bucket}/{Key+}?x-id=ListParts", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "PartNumberMarker", - "outputToken": "NextPartNumberMarker", - "items": "Parts", - "pageSize": "MaxParts" - } - } - }, - "com.amazonaws.s3#ListPartsOutput": { - "type": "structure", - "members": { - "AbortDate": { - "target": "com.amazonaws.s3#AbortDate", - "traits": { - "smithy.api#documentation": "

If the bucket has a lifecycle rule configured with an action to abort incomplete\n multipart uploads and the prefix in the lifecycle rule matches the object name in the\n request, then the response includes this header indicating when the initiated multipart\n upload will become eligible for abort operation. For more information, see Aborting\n Incomplete Multipart Uploads Using a Bucket Lifecycle Policy.

\n\n

The response will also include the x-amz-abort-rule-id header that will\n provide the ID of the lifecycle configuration rule that defines this action.

", - "smithy.api#httpHeader": "x-amz-abort-date" - } - }, - "AbortRuleId": { - "target": "com.amazonaws.s3#AbortRuleId", - "traits": { - "smithy.api#documentation": "

This header is returned along with the x-amz-abort-date header. It\n identifies applicable lifecycle configuration rule that defines the action to abort\n incomplete multipart uploads.

", - "smithy.api#httpHeader": "x-amz-abort-rule-id" - } - }, - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

The name of the bucket to which the multipart upload was initiated.

" - } - }, - "Key": { - "target": "com.amazonaws.s3#ObjectKey", - "traits": { - "smithy.api#documentation": "

Object key for which the multipart upload was initiated.

" - } - }, - "UploadId": { - "target": "com.amazonaws.s3#MultipartUploadId", - "traits": { - "smithy.api#documentation": "

Upload ID identifying the multipart upload whose parts are being listed.

" - } - }, - "PartNumberMarker": { - "target": "com.amazonaws.s3#PartNumberMarker", - "traits": { - "smithy.api#documentation": "

When a list is truncated, this element specifies the last part in the list, as well as\n the value to use for the part-number-marker request parameter in a subsequent\n request.

" - } - }, - "NextPartNumberMarker": { - "target": "com.amazonaws.s3#NextPartNumberMarker", - "traits": { - "smithy.api#documentation": "

When a list is truncated, this element specifies the last part in the list, as well as\n the value to use for the part-number-marker request parameter in a subsequent\n request.

" - } - }, - "MaxParts": { - "target": "com.amazonaws.s3#MaxParts", - "traits": { - "smithy.api#documentation": "

Maximum number of parts that were allowed in the response.

" - } - }, - "IsTruncated": { - "target": "com.amazonaws.s3#IsTruncated", - "traits": { - "smithy.api#documentation": "

Indicates whether the returned list of parts is truncated. A true value indicates that\n the list was truncated. A list can be truncated if the number of parts exceeds the limit\n returned in the MaxParts element.

" - } - }, - "Parts": { - "target": "com.amazonaws.s3#Parts", - "traits": { - "smithy.api#documentation": "

Container for elements related to a particular part. A response can contain zero or\n more Part elements.

", - "smithy.api#xmlFlattened": {}, - "smithy.api#xmlName": "Part" - } - }, - "Initiator": { - "target": "com.amazonaws.s3#Initiator", - "traits": { - "smithy.api#documentation": "

Container element that identifies who initiated the multipart upload. If the initiator\n is an AWS account, this element provides the same information as the Owner\n element. If the initiator is an IAM User, this element provides the user ARN and display\n name.

" - } - }, - "Owner": { - "target": "com.amazonaws.s3#Owner", - "traits": { - "smithy.api#documentation": "

Container element that identifies the object owner, after the object is created. If\n multipart upload is initiated by an IAM user, this element provides the parent account ID\n and display name.

" - } - }, - "StorageClass": { - "target": "com.amazonaws.s3#StorageClass", - "traits": { - "smithy.api#documentation": "

Class of storage (STANDARD or REDUCED_REDUNDANCY) used to store the uploaded\n object.

" - } - }, - "RequestCharged": { - "target": "com.amazonaws.s3#RequestCharged", - "traits": { - "smithy.api#httpHeader": "x-amz-request-charged" - } - } - } - }, - "com.amazonaws.s3#ListPartsRequest": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

The name of the bucket to which the parts are being uploaded.

\n

When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.

\n

When using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Key": { - "target": "com.amazonaws.s3#ObjectKey", - "traits": { - "smithy.api#documentation": "

Object key for which the multipart upload was initiated.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "MaxParts": { - "target": "com.amazonaws.s3#MaxParts", - "traits": { - "smithy.api#documentation": "

Sets the maximum number of parts to return.

", - "smithy.api#httpQuery": "max-parts" - } - }, - "PartNumberMarker": { - "target": "com.amazonaws.s3#PartNumberMarker", - "traits": { - "smithy.api#documentation": "

Specifies the part after which listing should begin. Only parts with higher part numbers\n will be listed.

", - "smithy.api#httpQuery": "part-number-marker" - } - }, - "UploadId": { - "target": "com.amazonaws.s3#MultipartUploadId", - "traits": { - "smithy.api#documentation": "

Upload ID identifying the multipart upload whose parts are being listed.

", - "smithy.api#httpQuery": "uploadId", - "smithy.api#required": {} - } - }, - "RequestPayer": { - "target": "com.amazonaws.s3#RequestPayer", - "traits": { - "smithy.api#httpHeader": "x-amz-request-payer" - } - }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", - "smithy.api#httpHeader": "x-amz-expected-bucket-owner" - } - } - } - }, - "com.amazonaws.s3#Location": { - "type": "string" - }, - "com.amazonaws.s3#LocationPrefix": { - "type": "string" - }, - "com.amazonaws.s3#LoggingEnabled": { - "type": "structure", - "members": { - "TargetBucket": { - "target": "com.amazonaws.s3#TargetBucket", - "traits": { - "smithy.api#documentation": "

Specifies the bucket where you want Amazon S3 to store server access logs. You can have your\n logs delivered to any bucket that you own, including the same bucket that is being logged.\n You can also configure multiple buckets to deliver their logs to the same target bucket. In\n this case, you should choose a different TargetPrefix for each source bucket\n so that the delivered log files can be distinguished by key.

", - "smithy.api#required": {} - } - }, - "TargetGrants": { - "target": "com.amazonaws.s3#TargetGrants", - "traits": { - "smithy.api#documentation": "

Container for granting information.

" - } - }, - "TargetPrefix": { - "target": "com.amazonaws.s3#TargetPrefix", - "traits": { - "smithy.api#documentation": "

A prefix for all log object keys. If you store log files from multiple Amazon S3 buckets in a\n single bucket, you can use a prefix to distinguish which log files came from which\n bucket.

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

Describes where logs are stored and the prefix that Amazon S3 assigns to all log object keys\n for a bucket. For more information, see PUT Bucket logging in the\n Amazon Simple Storage Service API Reference.

" - } - }, - "com.amazonaws.s3#MFA": { - "type": "string" - }, - "com.amazonaws.s3#MFADelete": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Enabled" - }, - { - "value": "Disabled" - } - ] - } - }, - "com.amazonaws.s3#MFADeleteStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Enabled" - }, - { - "value": "Disabled" - } - ] - } - }, - "com.amazonaws.s3#Marker": { - "type": "string" - }, - "com.amazonaws.s3#MaxAgeSeconds": { - "type": "integer" - }, - "com.amazonaws.s3#MaxKeys": { - "type": "integer" - }, - "com.amazonaws.s3#MaxParts": { - "type": "integer" - }, - "com.amazonaws.s3#MaxUploads": { - "type": "integer" - }, - "com.amazonaws.s3#Message": { - "type": "string" - }, - "com.amazonaws.s3#Metadata": { - "type": "map", - "key": { - "target": "com.amazonaws.s3#MetadataKey" - }, - "value": { - "target": "com.amazonaws.s3#MetadataValue" - } - }, - "com.amazonaws.s3#MetadataDirective": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "COPY" - }, - { - "value": "REPLACE" - } - ] - } - }, - "com.amazonaws.s3#MetadataEntry": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.s3#MetadataKey", - "traits": { - "smithy.api#documentation": "

Name of the Object.

" - } - }, - "Value": { - "target": "com.amazonaws.s3#MetadataValue", - "traits": { - "smithy.api#documentation": "

Value of the Object.

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

A metadata key-value pair to store with an object.

" - } - }, - "com.amazonaws.s3#MetadataKey": { - "type": "string" - }, - "com.amazonaws.s3#MetadataValue": { - "type": "string" - }, - "com.amazonaws.s3#Metrics": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.s3#MetricsStatus", - "traits": { - "smithy.api#documentation": "

Specifies whether the replication metrics are enabled.

", - "smithy.api#required": {} - } - }, - "EventThreshold": { - "target": "com.amazonaws.s3#ReplicationTimeValue", - "traits": { - "smithy.api#documentation": "

A container specifying the time threshold for emitting the\n s3:Replication:OperationMissedThreshold event.

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

A container specifying replication metrics-related settings enabling replication\n metrics and events.

" - } - }, - "com.amazonaws.s3#MetricsAndOperator": { - "type": "structure", - "members": { - "Prefix": { - "target": "com.amazonaws.s3#Prefix", - "traits": { - "smithy.api#documentation": "

The prefix used when evaluating an AND predicate.

" - } - }, - "Tags": { - "target": "com.amazonaws.s3#TagSet", - "traits": { - "smithy.api#documentation": "

The list of tags used when evaluating an AND predicate.

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

A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter.\n The operator must have at least two predicates, and an object must match all of the\n predicates in order for the filter to apply.

" - } - }, - "com.amazonaws.s3#MetricsConfiguration": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.s3#MetricsId", - "traits": { - "smithy.api#documentation": "

The ID used to identify the metrics configuration.

", - "smithy.api#required": {} - } - }, - "Filter": { - "target": "com.amazonaws.s3#MetricsFilter", - "traits": { - "smithy.api#documentation": "

Specifies a metrics configuration filter. The metrics configuration will only include\n objects that meet the filter's criteria. A filter must be a prefix, a tag, or a conjunction\n (MetricsAndOperator).

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

Specifies a metrics configuration for the CloudWatch request metrics (specified by the\n metrics configuration ID) from an Amazon S3 bucket. If you're updating an existing metrics\n configuration, note that this is a full replacement of the existing metrics configuration.\n If you don't include the elements you want to keep, they are erased. For more information,\n see PUT Bucket\n metrics in the Amazon Simple Storage Service API Reference.

" - } - }, - "com.amazonaws.s3#MetricsConfigurationList": { - "type": "list", - "member": { - "target": "com.amazonaws.s3#MetricsConfiguration" - } - }, - "com.amazonaws.s3#MetricsFilter": { - "type": "union", - "members": { - "Prefix": { - "target": "com.amazonaws.s3#Prefix", - "traits": { - "smithy.api#documentation": "

The prefix used when evaluating a metrics filter.

" - } - }, - "Tag": { - "target": "com.amazonaws.s3#Tag", - "traits": { - "smithy.api#documentation": "

The tag used when evaluating a metrics filter.

" - } - }, - "And": { - "target": "com.amazonaws.s3#MetricsAndOperator", - "traits": { - "smithy.api#documentation": "

A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter.\n The operator must have at least two predicates, and an object must match all of the\n predicates in order for the filter to apply.

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

Specifies a metrics configuration filter. The metrics configuration only includes\n objects that meet the filter's criteria. A filter must be a prefix, a tag, or a conjunction\n (MetricsAndOperator).

" - } - }, - "com.amazonaws.s3#MetricsId": { - "type": "string" - }, - "com.amazonaws.s3#MetricsStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Enabled" - }, - { - "value": "Disabled" - } - ] - } - }, - "com.amazonaws.s3#Minutes": { - "type": "integer" - }, - "com.amazonaws.s3#MissingMeta": { - "type": "integer" - }, - "com.amazonaws.s3#MultipartUpload": { - "type": "structure", - "members": { - "UploadId": { - "target": "com.amazonaws.s3#MultipartUploadId", - "traits": { - "smithy.api#documentation": "

Upload ID that identifies the multipart upload.

" - } - }, - "Key": { - "target": "com.amazonaws.s3#ObjectKey", - "traits": { - "smithy.api#documentation": "

Key of the object for which the multipart upload was initiated.

" - } - }, - "Initiated": { - "target": "com.amazonaws.s3#Initiated", - "traits": { - "smithy.api#documentation": "

Date and time at which the multipart upload was initiated.

" - } - }, - "StorageClass": { - "target": "com.amazonaws.s3#StorageClass", - "traits": { - "smithy.api#documentation": "

The class of storage used to store the object.

" - } - }, - "Owner": { - "target": "com.amazonaws.s3#Owner", - "traits": { - "smithy.api#documentation": "

Specifies the owner of the object that is part of the multipart upload.

" - } - }, - "Initiator": { - "target": "com.amazonaws.s3#Initiator", - "traits": { - "smithy.api#documentation": "

Identifies who initiated the multipart upload.

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

Container for the MultipartUpload for the Amazon S3 object.

" - } - }, - "com.amazonaws.s3#MultipartUploadId": { - "type": "string" - }, - "com.amazonaws.s3#MultipartUploadList": { - "type": "list", - "member": { - "target": "com.amazonaws.s3#MultipartUpload" - } - }, - "com.amazonaws.s3#NextKeyMarker": { - "type": "string" - }, - "com.amazonaws.s3#NextMarker": { - "type": "string" - }, - "com.amazonaws.s3#NextPartNumberMarker": { - "type": "string" - }, - "com.amazonaws.s3#NextToken": { - "type": "string" - }, - "com.amazonaws.s3#NextUploadIdMarker": { - "type": "string" - }, - "com.amazonaws.s3#NextVersionIdMarker": { - "type": "string" - }, - "com.amazonaws.s3#NoSuchBucket": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "

The specified bucket does not exist.

", - "smithy.api#error": "client" - } - }, - "com.amazonaws.s3#NoSuchKey": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "

The specified key does not exist.

", - "smithy.api#error": "client" - } - }, - "com.amazonaws.s3#NoSuchUpload": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "

The specified multipart upload does not exist.

", - "smithy.api#error": "client" - } - }, - "com.amazonaws.s3#NoncurrentVersionExpiration": { - "type": "structure", - "members": { - "NoncurrentDays": { - "target": "com.amazonaws.s3#Days", - "traits": { - "smithy.api#documentation": "

Specifies the number of days an object is noncurrent before Amazon S3 can perform the\n associated action. For information about the noncurrent days calculations, see How\n Amazon S3 Calculates When an Object Became Noncurrent in the Amazon Simple\n Storage Service Developer Guide.

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

Specifies when noncurrent object versions expire. Upon expiration, Amazon S3 permanently\n deletes the noncurrent object versions. You set this lifecycle configuration action on a\n bucket that has versioning enabled (or suspended) to request that Amazon S3 delete noncurrent\n object versions at a specific period in the object's lifetime.

" - } - }, - "com.amazonaws.s3#NoncurrentVersionTransition": { - "type": "structure", - "members": { - "NoncurrentDays": { - "target": "com.amazonaws.s3#Days", - "traits": { - "smithy.api#documentation": "

Specifies the number of days an object is noncurrent before Amazon S3 can perform the\n associated action. For information about the noncurrent days calculations, see How\n Amazon S3 Calculates How Long an Object Has Been Noncurrent in the\n Amazon Simple Storage Service Developer Guide.

" - } - }, - "StorageClass": { - "target": "com.amazonaws.s3#TransitionStorageClass", - "traits": { - "smithy.api#documentation": "

The class of storage used to store the object.

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

Container for the transition rule that describes when noncurrent objects transition to\n the STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING,\n GLACIER, or DEEP_ARCHIVE storage class. If your bucket is\n versioning-enabled (or versioning is suspended), you can set this action to request that\n Amazon S3 transition noncurrent object versions to the STANDARD_IA,\n ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, or\n DEEP_ARCHIVE storage class at a specific period in the object's\n lifetime.

" - } - }, - "com.amazonaws.s3#NoncurrentVersionTransitionList": { - "type": "list", - "member": { - "target": "com.amazonaws.s3#NoncurrentVersionTransition" - } - }, - "com.amazonaws.s3#NotificationConfiguration": { - "type": "structure", - "members": { - "TopicConfigurations": { - "target": "com.amazonaws.s3#TopicConfigurationList", - "traits": { - "smithy.api#documentation": "

The topic to which notifications are sent and the events for which notifications are\n generated.

", - "smithy.api#xmlFlattened": {}, - "smithy.api#xmlName": "TopicConfiguration" - } - }, - "QueueConfigurations": { - "target": "com.amazonaws.s3#QueueConfigurationList", - "traits": { - "smithy.api#documentation": "

The Amazon Simple Queue Service queues to publish messages to and the events for which\n to publish messages.

", - "smithy.api#xmlFlattened": {}, - "smithy.api#xmlName": "QueueConfiguration" - } - }, - "LambdaFunctionConfigurations": { - "target": "com.amazonaws.s3#LambdaFunctionConfigurationList", - "traits": { - "smithy.api#documentation": "

Describes the AWS Lambda functions to invoke and the events for which to invoke\n them.

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

A container for specifying the notification configuration of the bucket. If this element\n is empty, notifications are turned off for the bucket.

" - } - }, - "com.amazonaws.s3#NotificationConfigurationFilter": { - "type": "structure", - "members": { - "Key": { - "target": "com.amazonaws.s3#S3KeyFilter", - "traits": { - "smithy.api#xmlName": "S3Key" - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies object key name filtering rules. For information about key name filtering, see\n Configuring\n Event Notifications in the Amazon Simple Storage Service Developer\n Guide.

" - } - }, - "com.amazonaws.s3#NotificationId": { - "type": "string", - "traits": { - "smithy.api#documentation": "

An optional unique identifier for configurations in a notification configuration. If you\n don't provide one, Amazon S3 will assign an ID.

" - } - }, - "com.amazonaws.s3#Object": { - "type": "structure", - "members": { - "Key": { - "target": "com.amazonaws.s3#ObjectKey", - "traits": { - "smithy.api#documentation": "

The name that you assign to an object. You use the object key to retrieve the\n object.

" - } - }, - "LastModified": { - "target": "com.amazonaws.s3#LastModified", - "traits": { - "smithy.api#documentation": "

The date the Object was Last Modified

" - } - }, - "ETag": { - "target": "com.amazonaws.s3#ETag", - "traits": { - "smithy.api#documentation": "

The entity tag is a hash of the object. The ETag reflects changes only to the contents\n of an object, not its metadata. The ETag may or may not be an MD5 digest of the object\n data. Whether or not it is depends on how the object was created and how it is encrypted as\n described below:

\n " - } - }, - "Size": { - "target": "com.amazonaws.s3#Size", - "traits": { - "smithy.api#documentation": "

Size in bytes of the object

" - } - }, - "StorageClass": { - "target": "com.amazonaws.s3#ObjectStorageClass", - "traits": { - "smithy.api#documentation": "

The class of storage used to store the object.

" - } - }, - "Owner": { - "target": "com.amazonaws.s3#Owner", - "traits": { - "smithy.api#documentation": "

The owner of the object

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

An object consists of data and its descriptive metadata.

" - } - }, - "com.amazonaws.s3#ObjectAlreadyInActiveTierError": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "

This operation is not allowed against this storage tier.

", - "smithy.api#error": "client" - } - }, - "com.amazonaws.s3#ObjectCannedACL": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "private" - }, - { - "value": "public-read" - }, - { - "value": "public-read-write" - }, - { - "value": "authenticated-read" - }, - { - "value": "aws-exec-read" - }, - { - "value": "bucket-owner-read" - }, - { - "value": "bucket-owner-full-control" - } - ] - } - }, - "com.amazonaws.s3#ObjectIdentifier": { - "type": "structure", - "members": { - "Key": { - "target": "com.amazonaws.s3#ObjectKey", - "traits": { - "smithy.api#documentation": "

Key name of the object to delete.

", - "smithy.api#required": {} - } - }, - "VersionId": { - "target": "com.amazonaws.s3#ObjectVersionId", - "traits": { - "smithy.api#documentation": "

VersionId for the specific version of the object to delete.

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

Object Identifier is unique value to identify objects.

" - } - }, - "com.amazonaws.s3#ObjectIdentifierList": { - "type": "list", - "member": { - "target": "com.amazonaws.s3#ObjectIdentifier" - } - }, - "com.amazonaws.s3#ObjectKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.s3#ObjectList": { - "type": "list", - "member": { - "target": "com.amazonaws.s3#Object" - } - }, - "com.amazonaws.s3#ObjectLockConfiguration": { - "type": "structure", - "members": { - "ObjectLockEnabled": { - "target": "com.amazonaws.s3#ObjectLockEnabled", - "traits": { - "smithy.api#documentation": "

Indicates whether this bucket has an Object Lock configuration enabled.

" - } - }, - "Rule": { - "target": "com.amazonaws.s3#ObjectLockRule", - "traits": { - "smithy.api#documentation": "

The Object Lock rule in place for the specified object.

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

The container element for Object Lock configuration parameters.

" - } - }, - "com.amazonaws.s3#ObjectLockEnabled": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Enabled" - } - ] - } - }, - "com.amazonaws.s3#ObjectLockEnabledForBucket": { - "type": "boolean" - }, - "com.amazonaws.s3#ObjectLockLegalHold": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.s3#ObjectLockLegalHoldStatus", - "traits": { - "smithy.api#documentation": "

Indicates whether the specified object has a Legal Hold in place.

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

A Legal Hold configuration for an object.

" - } - }, - "com.amazonaws.s3#ObjectLockLegalHoldStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ON" - }, - { - "value": "OFF" - } - ] - } - }, - "com.amazonaws.s3#ObjectLockMode": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "GOVERNANCE" - }, - { - "value": "COMPLIANCE" - } - ] - } - }, - "com.amazonaws.s3#ObjectLockRetainUntilDate": { - "type": "timestamp", - "traits": { - "smithy.api#timestampFormat": "date-time" - } - }, - "com.amazonaws.s3#ObjectLockRetention": { - "type": "structure", - "members": { - "Mode": { - "target": "com.amazonaws.s3#ObjectLockRetentionMode", - "traits": { - "smithy.api#documentation": "

Indicates the Retention mode for the specified object.

" - } - }, - "RetainUntilDate": { - "target": "com.amazonaws.s3#Date", - "traits": { - "smithy.api#documentation": "

The date on which this Object Lock Retention will expire.

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

A Retention configuration for an object.

" - } - }, - "com.amazonaws.s3#ObjectLockRetentionMode": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "GOVERNANCE" - }, - { - "value": "COMPLIANCE" - } - ] - } - }, - "com.amazonaws.s3#ObjectLockRule": { - "type": "structure", - "members": { - "DefaultRetention": { - "target": "com.amazonaws.s3#DefaultRetention", - "traits": { - "smithy.api#documentation": "

The default retention period that you want to apply to new objects placed in the\n specified bucket.

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

The container element for an Object Lock rule.

" - } - }, - "com.amazonaws.s3#ObjectLockToken": { - "type": "string" - }, - "com.amazonaws.s3#ObjectNotInActiveTierError": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "

The source object of the COPY operation is not in the active tier and is only stored in\n Amazon S3 Glacier.

", - "smithy.api#error": "client" - } - }, - "com.amazonaws.s3#ObjectOwnership": { - "type": "string", - "traits": { - "smithy.api#documentation": "

The container element for object ownership for a bucket's ownership controls.

\n

BucketOwnerPreferred - Objects uploaded to the bucket change ownership to the bucket\n owner if the objects are uploaded with the bucket-owner-full-control canned\n ACL.

\n

ObjectWriter - The uploading account will own the object if the object is uploaded with\n the bucket-owner-full-control canned ACL.

", - "smithy.api#enum": [ - { - "value": "BucketOwnerPreferred" - }, - { - "value": "ObjectWriter" - } - ] - } - }, - "com.amazonaws.s3#ObjectStorageClass": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "STANDARD" - }, - { - "value": "REDUCED_REDUNDANCY" - }, - { - "value": "GLACIER" - }, - { - "value": "STANDARD_IA" - }, - { - "value": "ONEZONE_IA" - }, - { - "value": "INTELLIGENT_TIERING" - }, - { - "value": "DEEP_ARCHIVE" - }, - { - "value": "OUTPOSTS" - } - ] - } - }, - "com.amazonaws.s3#ObjectVersion": { - "type": "structure", - "members": { - "ETag": { - "target": "com.amazonaws.s3#ETag", - "traits": { - "smithy.api#documentation": "

The entity tag is an MD5 hash of that version of the object.

" - } - }, - "Size": { - "target": "com.amazonaws.s3#Size", - "traits": { - "smithy.api#documentation": "

Size in bytes of the object.

" - } - }, - "StorageClass": { - "target": "com.amazonaws.s3#ObjectVersionStorageClass", - "traits": { - "smithy.api#documentation": "

The class of storage used to store the object.

" - } - }, - "Key": { - "target": "com.amazonaws.s3#ObjectKey", - "traits": { - "smithy.api#documentation": "

The object key.

" - } - }, - "VersionId": { - "target": "com.amazonaws.s3#ObjectVersionId", - "traits": { - "smithy.api#documentation": "

Version ID of an object.

" - } - }, - "IsLatest": { - "target": "com.amazonaws.s3#IsLatest", - "traits": { - "smithy.api#documentation": "

Specifies whether the object is (true) or is not (false) the latest version of an\n object.

" - } - }, - "LastModified": { - "target": "com.amazonaws.s3#LastModified", - "traits": { - "smithy.api#documentation": "

Date and time the object was last modified.

" - } - }, - "Owner": { - "target": "com.amazonaws.s3#Owner", - "traits": { - "smithy.api#documentation": "

Specifies the owner of the object.

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

The version of an object.

" - } - }, - "com.amazonaws.s3#ObjectVersionId": { - "type": "string" - }, - "com.amazonaws.s3#ObjectVersionList": { - "type": "list", - "member": { - "target": "com.amazonaws.s3#ObjectVersion" - } - }, - "com.amazonaws.s3#ObjectVersionStorageClass": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "STANDARD" - } - ] - } - }, - "com.amazonaws.s3#OutputLocation": { - "type": "structure", - "members": { - "S3": { - "target": "com.amazonaws.s3#S3Location", - "traits": { - "smithy.api#documentation": "

Describes an S3 location that will receive the results of the restore request.

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

Describes the location where the restore job's output is stored.

" - } - }, - "com.amazonaws.s3#OutputSerialization": { - "type": "structure", - "members": { - "CSV": { - "target": "com.amazonaws.s3#CSVOutput", - "traits": { - "smithy.api#documentation": "

Describes the serialization of CSV-encoded Select results.

" - } - }, - "JSON": { - "target": "com.amazonaws.s3#JSONOutput", - "traits": { - "smithy.api#documentation": "

Specifies JSON as request's output serialization format.

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

Describes how results of the Select job are serialized.

" - } - }, - "com.amazonaws.s3#Owner": { - "type": "structure", - "members": { - "DisplayName": { - "target": "com.amazonaws.s3#DisplayName", - "traits": { - "smithy.api#documentation": "

Container for the display name of the owner.

" - } - }, - "ID": { - "target": "com.amazonaws.s3#ID", - "traits": { - "smithy.api#documentation": "

Container for the ID of the owner.

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

Container for the owner's display name and ID.

" - } - }, - "com.amazonaws.s3#OwnerOverride": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Destination" - } - ] - } - }, - "com.amazonaws.s3#OwnershipControls": { - "type": "structure", - "members": { - "Rules": { - "target": "com.amazonaws.s3#OwnershipControlsRules", - "traits": { - "smithy.api#documentation": "

The container element for an ownership control rule.

", - "smithy.api#required": {}, - "smithy.api#xmlFlattened": {}, - "smithy.api#xmlName": "Rule" - } - } - }, - "traits": { - "smithy.api#documentation": "

The container element for a bucket's ownership controls.

" - } - }, - "com.amazonaws.s3#OwnershipControlsRule": { - "type": "structure", - "members": { - "ObjectOwnership": { - "target": "com.amazonaws.s3#ObjectOwnership", - "traits": { - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The container element for an ownership control rule.

" - } - }, - "com.amazonaws.s3#OwnershipControlsRules": { - "type": "list", - "member": { - "target": "com.amazonaws.s3#OwnershipControlsRule" - } - }, - "com.amazonaws.s3#ParquetInput": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "

Container for Parquet.

" - } - }, - "com.amazonaws.s3#Part": { - "type": "structure", - "members": { - "PartNumber": { - "target": "com.amazonaws.s3#PartNumber", - "traits": { - "smithy.api#documentation": "

Part number identifying the part. This is a positive integer between 1 and\n 10,000.

" - } - }, - "LastModified": { - "target": "com.amazonaws.s3#LastModified", - "traits": { - "smithy.api#documentation": "

Date and time at which the part was uploaded.

" - } - }, - "ETag": { - "target": "com.amazonaws.s3#ETag", - "traits": { - "smithy.api#documentation": "

Entity tag returned when the part was uploaded.

" - } - }, - "Size": { - "target": "com.amazonaws.s3#Size", - "traits": { - "smithy.api#documentation": "

Size in bytes of the uploaded part data.

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

Container for elements related to a part.

" - } - }, - "com.amazonaws.s3#PartNumber": { - "type": "integer" - }, - "com.amazonaws.s3#PartNumberMarker": { - "type": "string" - }, - "com.amazonaws.s3#Parts": { - "type": "list", - "member": { - "target": "com.amazonaws.s3#Part" - } - }, - "com.amazonaws.s3#PartsCount": { - "type": "integer" - }, - "com.amazonaws.s3#Payer": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Requester" - }, - { - "value": "BucketOwner" - } - ] - } - }, - "com.amazonaws.s3#Permission": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "FULL_CONTROL" - }, - { - "value": "WRITE" - }, - { - "value": "WRITE_ACP" - }, - { - "value": "READ" - }, - { - "value": "READ_ACP" - } - ] - } - }, - "com.amazonaws.s3#Policy": { - "type": "string" - }, - "com.amazonaws.s3#PolicyStatus": { - "type": "structure", - "members": { - "IsPublic": { - "target": "com.amazonaws.s3#IsPublic", - "traits": { - "smithy.api#documentation": "

The policy status for this bucket. TRUE indicates that this bucket is\n public. FALSE indicates that the bucket is not public.

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

The container element for a bucket's policy status.

" - } - }, - "com.amazonaws.s3#Prefix": { - "type": "string" - }, - "com.amazonaws.s3#Priority": { - "type": "integer" - }, - "com.amazonaws.s3#Progress": { - "type": "structure", - "members": { - "BytesScanned": { - "target": "com.amazonaws.s3#BytesScanned", - "traits": { - "smithy.api#documentation": "

The current number of object bytes scanned.

" - } - }, - "BytesProcessed": { - "target": "com.amazonaws.s3#BytesProcessed", - "traits": { - "smithy.api#documentation": "

The current number of uncompressed object bytes processed.

" - } - }, - "BytesReturned": { - "target": "com.amazonaws.s3#BytesReturned", - "traits": { - "smithy.api#documentation": "

The current number of bytes of records payload data returned.

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

This data type contains information about progress of an operation.

" - } - }, - "com.amazonaws.s3#ProgressEvent": { - "type": "structure", - "members": { - "Details": { - "target": "com.amazonaws.s3#Progress", - "traits": { - "smithy.api#documentation": "

The Progress event details.

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

This data type contains information about the progress event of an operation.

" - } - }, - "com.amazonaws.s3#Protocol": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "http" - }, - { - "value": "https" - } - ] - } - }, - "com.amazonaws.s3#PublicAccessBlockConfiguration": { - "type": "structure", - "members": { - "BlockPublicAcls": { - "target": "com.amazonaws.s3#Setting", - "traits": { - "smithy.api#documentation": "

Specifies whether Amazon S3 should block public access control lists (ACLs) for this bucket\n and objects in this bucket. Setting this element to TRUE causes the following\n behavior:

\n \n

Enabling this setting doesn't affect existing policies or ACLs.

", - "smithy.api#xmlName": "BlockPublicAcls" - } - }, - "IgnorePublicAcls": { - "target": "com.amazonaws.s3#Setting", - "traits": { - "smithy.api#documentation": "

Specifies whether Amazon S3 should ignore public ACLs for this bucket and objects in this\n bucket. Setting this element to TRUE causes Amazon S3 to ignore all public ACLs on\n this bucket and objects in this bucket.

\n

Enabling this setting doesn't affect the persistence of any existing ACLs and doesn't\n prevent new public ACLs from being set.

", - "smithy.api#xmlName": "IgnorePublicAcls" - } - }, - "BlockPublicPolicy": { - "target": "com.amazonaws.s3#Setting", - "traits": { - "smithy.api#documentation": "

Specifies whether Amazon S3 should block public bucket policies for this bucket. Setting this\n element to TRUE causes Amazon S3 to reject calls to PUT Bucket policy if the\n specified bucket policy allows public access.

\n

Enabling this setting doesn't affect existing bucket policies.

", - "smithy.api#xmlName": "BlockPublicPolicy" - } - }, - "RestrictPublicBuckets": { - "target": "com.amazonaws.s3#Setting", - "traits": { - "smithy.api#documentation": "

Specifies whether Amazon S3 should restrict public bucket policies for this bucket. Setting\n this element to TRUE restricts access to this bucket to only AWS service\n principals and authorized users within this account if the bucket has a public\n policy.

\n

Enabling this setting doesn't affect previously stored bucket policies, except that\n public and cross-account access within any public bucket policy, including non-public\n delegation to specific accounts, is blocked.

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

The PublicAccessBlock configuration that you want to apply to this Amazon S3 bucket. You can\n enable the configuration options in any combination. For more information about when Amazon S3\n considers a bucket or object public, see The Meaning of \"Public\" in the Amazon Simple Storage Service Developer Guide.

" - } - }, - "com.amazonaws.s3#PutBucketAccelerateConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.s3#PutBucketAccelerateConfigurationRequest" - }, - "traits": { - "smithy.api#documentation": "

Sets the accelerate configuration of an existing bucket. Amazon S3 Transfer Acceleration is a\n bucket-level feature that enables you to perform faster data transfers to Amazon S3.

\n\n

To use this operation, you must have permission to perform the\n s3:PutAccelerateConfiguration action. The bucket owner has this permission by default. The\n bucket owner can grant this permission to others. For more information about permissions,\n see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources.

\n\n

The Transfer Acceleration state of a bucket can be set to one of the following two\n values:

\n \n\n\n

The GetBucketAccelerateConfiguration operation returns the transfer acceleration\n state of a bucket.

\n\n

After setting the Transfer Acceleration state of a bucket to Enabled, it might take up\n to thirty minutes before the data transfer rates to the bucket increase.

\n\n

The name of the bucket used for Transfer Acceleration must be DNS-compliant and must\n not contain periods (\".\").

\n\n

For more information about transfer acceleration, see Transfer Acceleration.

\n\n

The following operations are related to\n PutBucketAccelerateConfiguration:

\n ", - "smithy.api#http": { - "method": "PUT", - "uri": "/{Bucket}?accelerate", - "code": 200 - } - } - }, - "com.amazonaws.s3#PutBucketAccelerateConfigurationRequest": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

The name of the bucket for which the accelerate configuration is set.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AccelerateConfiguration": { - "target": "com.amazonaws.s3#AccelerateConfiguration", - "traits": { - "smithy.api#documentation": "

Container for setting the transfer acceleration state.

", - "smithy.api#httpPayload": {}, - "smithy.api#required": {} - } - }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", - "smithy.api#httpHeader": "x-amz-expected-bucket-owner" - } - } - } - }, - "com.amazonaws.s3#PutBucketAcl": { - "type": "operation", - "input": { - "target": "com.amazonaws.s3#PutBucketAclRequest" - }, - "traits": { - "smithy.api#documentation": "

Sets the permissions on an existing bucket using access control lists (ACL). For more\n information, see Using ACLs. To set\n the ACL of a bucket, you must have WRITE_ACP permission.

\n\n

You can use one of the following two ways to set a bucket's permissions:

\n \n\n \n

You cannot specify access permission using both the body and the request\n headers.

\n \n\n

Depending on your application needs, you may choose to set the ACL on a bucket using\n either the request body or the headers. For example, if you have an existing application\n that updates a bucket ACL using the request body, then you can continue to use that\n approach.

\n\n\n

\n Access Permissions\n

\n

You can set access permissions using one of the following methods:

\n \n

You can use either a canned ACL or specify access permissions explicitly. You cannot do\n both.

\n

\n Grantee Values\n

\n

You can specify the person (grantee) to whom you're assigning access rights (using\n request elements) in the following ways:

\n \n\n\n

\n Related Resources\n

\n ", - "smithy.api#http": { - "method": "PUT", - "uri": "/{Bucket}?acl", - "code": 200 - }, - "smithy.api#httpChecksumRequired": {} - } - }, - "com.amazonaws.s3#PutBucketAclRequest": { - "type": "structure", - "members": { - "ACL": { - "target": "com.amazonaws.s3#BucketCannedACL", - "traits": { - "smithy.api#documentation": "

The canned ACL to apply to the bucket.

", - "smithy.api#httpHeader": "x-amz-acl" - } - }, - "AccessControlPolicy": { - "target": "com.amazonaws.s3#AccessControlPolicy", - "traits": { - "smithy.api#documentation": "

Contains the elements that set the ACL permissions for an object per grantee.

", - "smithy.api#httpPayload": {} - } - }, - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

The bucket to which to apply the ACL.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ContentMD5": { - "target": "com.amazonaws.s3#ContentMD5", - "traits": { - "smithy.api#documentation": "

The base64-encoded 128-bit MD5 digest of the data. This header must be used as a message\n integrity check to verify that the request body was not corrupted in transit. For more\n information, go to RFC\n 1864.\n

\n

For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically.

", - "smithy.api#httpHeader": "Content-MD5" - } - }, - "GrantFullControl": { - "target": "com.amazonaws.s3#GrantFullControl", - "traits": { - "smithy.api#documentation": "

Allows grantee the read, write, read ACP, and write ACP permissions on the\n bucket.

", - "smithy.api#httpHeader": "x-amz-grant-full-control" - } - }, - "GrantRead": { - "target": "com.amazonaws.s3#GrantRead", - "traits": { - "smithy.api#documentation": "

Allows grantee to list the objects in the bucket.

", - "smithy.api#httpHeader": "x-amz-grant-read" - } - }, - "GrantReadACP": { - "target": "com.amazonaws.s3#GrantReadACP", - "traits": { - "smithy.api#documentation": "

Allows grantee to read the bucket ACL.

", - "smithy.api#httpHeader": "x-amz-grant-read-acp" - } - }, - "GrantWrite": { - "target": "com.amazonaws.s3#GrantWrite", - "traits": { - "smithy.api#documentation": "

Allows grantee to create, overwrite, and delete any object in the bucket.

", - "smithy.api#httpHeader": "x-amz-grant-write" - } - }, - "GrantWriteACP": { - "target": "com.amazonaws.s3#GrantWriteACP", - "traits": { - "smithy.api#documentation": "

Allows grantee to write the ACL for the applicable bucket.

", - "smithy.api#httpHeader": "x-amz-grant-write-acp" - } - }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", - "smithy.api#httpHeader": "x-amz-expected-bucket-owner" - } - } - } - }, - "com.amazonaws.s3#PutBucketAnalyticsConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.s3#PutBucketAnalyticsConfigurationRequest" - }, - "traits": { - "smithy.api#documentation": "

Sets an analytics configuration for the bucket (specified by the analytics configuration\n ID). You can have up to 1,000 analytics configurations per bucket.

\n\n

You can choose to have storage class analysis export analysis reports sent to a\n comma-separated values (CSV) flat file. See the DataExport request element.\n Reports are updated daily and are based on the object filters that you configure. When\n selecting data export, you specify a destination bucket and an optional destination prefix\n where the file is written. You can export the data to a destination bucket in a different\n account. However, the destination bucket must be in the same Region as the bucket that you\n are making the PUT analytics configuration to. For more information, see Amazon S3 Analytics – Storage Class\n Analysis.

\n\n \n

You must create a bucket policy on the destination bucket where the exported file is\n written to grant permissions to Amazon S3 to write objects to the bucket. For an example\n policy, see Granting Permissions for Amazon S3 Inventory and Storage Class Analysis.

\n \n\n

To use this operation, you must have permissions to perform the\n s3:PutAnalyticsConfiguration action. The bucket owner has this permission\n by default. The bucket owner can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources.

\n\n\n

\n Special Errors\n

\n \n\n \n\n\n\n\n

\n Related Resources\n

\n ", - "smithy.api#http": { - "method": "PUT", - "uri": "/{Bucket}?analytics", - "code": 200 - } - } - }, - "com.amazonaws.s3#PutBucketAnalyticsConfigurationRequest": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

The name of the bucket to which an analytics configuration is stored.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Id": { - "target": "com.amazonaws.s3#AnalyticsId", - "traits": { - "smithy.api#documentation": "

The ID that identifies the analytics configuration.

", - "smithy.api#httpQuery": "id", - "smithy.api#required": {} - } - }, - "AnalyticsConfiguration": { - "target": "com.amazonaws.s3#AnalyticsConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration and any analyses for the analytics filter.

", - "smithy.api#httpPayload": {}, - "smithy.api#required": {} - } - }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", - "smithy.api#httpHeader": "x-amz-expected-bucket-owner" - } - } - } - }, - "com.amazonaws.s3#PutBucketCors": { - "type": "operation", - "input": { - "target": "com.amazonaws.s3#PutBucketCorsRequest" - }, - "traits": { - "smithy.api#documentation": "

Sets the cors configuration for your bucket. If the configuration exists,\n Amazon S3 replaces it.

\n

To use this operation, you must be allowed to perform the s3:PutBucketCORS\n action. By default, the bucket owner has this permission and can grant it to others.

\n

You set this configuration on a bucket so that the bucket can service cross-origin\n requests. For example, you might want to enable a request whose origin is\n http://www.example.com to access your Amazon S3 bucket at\n my.example.bucket.com by using the browser's XMLHttpRequest\n capability.

\n

To enable cross-origin resource sharing (CORS) on a bucket, you add the\n cors subresource to the bucket. The cors subresource is an XML\n document in which you configure rules that identify origins and the HTTP methods that can\n be executed on your bucket. The document is limited to 64 KB in size.

\n

When Amazon S3 receives a cross-origin request (or a pre-flight OPTIONS request) against a\n bucket, it evaluates the cors configuration on the bucket and uses the first\n CORSRule rule that matches the incoming browser request to enable a\n cross-origin request. For a rule to match, the following conditions must be met:

\n \n

For more information about CORS, go to Enabling\n Cross-Origin Resource Sharing in the Amazon Simple Storage Service Developer Guide.

\n \n

\n Related Resources\n

\n ", - "smithy.api#http": { - "method": "PUT", - "uri": "/{Bucket}?cors", - "code": 200 - }, - "smithy.api#httpChecksumRequired": {} - } - }, - "com.amazonaws.s3#PutBucketCorsRequest": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

Specifies the bucket impacted by the corsconfiguration.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "CORSConfiguration": { - "target": "com.amazonaws.s3#CORSConfiguration", - "traits": { - "smithy.api#documentation": "

Describes the cross-origin access configuration for objects in an Amazon S3 bucket. For more\n information, see Enabling Cross-Origin Resource\n Sharing in the Amazon Simple Storage Service Developer Guide.

", - "smithy.api#httpPayload": {}, - "smithy.api#required": {} - } - }, - "ContentMD5": { - "target": "com.amazonaws.s3#ContentMD5", - "traits": { - "smithy.api#documentation": "

The base64-encoded 128-bit MD5 digest of the data. This header must be used as a message\n integrity check to verify that the request body was not corrupted in transit. For more\n information, go to RFC\n 1864.\n

\n

For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically.

", - "smithy.api#httpHeader": "Content-MD5" - } - }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", - "smithy.api#httpHeader": "x-amz-expected-bucket-owner" - } - } - } - }, - "com.amazonaws.s3#PutBucketEncryption": { - "type": "operation", - "input": { - "target": "com.amazonaws.s3#PutBucketEncryptionRequest" - }, - "traits": { - "smithy.api#documentation": "

This operation uses the encryption subresource to configure default\n encryption and Amazon S3 Bucket Key for an existing bucket.

\n

Default encryption for a bucket can use server-side encryption with Amazon S3-managed keys\n (SSE-S3) or AWS KMS customer master keys (SSE-KMS). If you specify default encryption\n using SSE-KMS, you can also configure Amazon S3 Bucket Key. For information about default\n encryption, see Amazon S3 default bucket encryption\n in the Amazon Simple Storage Service Developer Guide. For more information about S3 Bucket Keys,\n see Amazon S3 Bucket Keys in the Amazon Simple Storage Service Developer Guide.

\n \n

This operation requires AWS Signature Version 4. For more information, see Authenticating Requests (AWS Signature\n Version 4).

\n \n

To use this operation, you must have permissions to perform the\n s3:PutEncryptionConfiguration action. The bucket owner has this permission\n by default. The bucket owner can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources in the Amazon Simple Storage Service Developer Guide.

\n \n

\n Related Resources\n

\n ", - "smithy.api#http": { - "method": "PUT", - "uri": "/{Bucket}?encryption", - "code": 200 - }, - "smithy.api#httpChecksumRequired": {} - } - }, - "com.amazonaws.s3#PutBucketEncryptionRequest": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

Specifies default encryption for a bucket using server-side encryption with Amazon S3-managed\n keys (SSE-S3) or customer master keys stored in AWS KMS (SSE-KMS). For information about\n the Amazon S3 default encryption feature, see Amazon S3 Default Bucket Encryption\n in the Amazon Simple Storage Service Developer Guide.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ContentMD5": { - "target": "com.amazonaws.s3#ContentMD5", - "traits": { - "smithy.api#documentation": "

The base64-encoded 128-bit MD5 digest of the server-side encryption configuration.

\n

For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically.

", - "smithy.api#httpHeader": "Content-MD5" - } - }, - "ServerSideEncryptionConfiguration": { - "target": "com.amazonaws.s3#ServerSideEncryptionConfiguration", - "traits": { - "smithy.api#httpPayload": {}, - "smithy.api#required": {} - } - }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", - "smithy.api#httpHeader": "x-amz-expected-bucket-owner" - } - } - } - }, - "com.amazonaws.s3#PutBucketIntelligentTieringConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.s3#PutBucketIntelligentTieringConfigurationRequest" - }, - "traits": { - "smithy.api#documentation": "

Puts a S3 Intelligent-Tiering configuration to the specified bucket.

\n

The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without additional operational overhead. S3 Intelligent-Tiering delivers automatic cost savings by moving data between access tiers, when access patterns change.

\n

The S3 Intelligent-Tiering storage class is suitable for objects larger than 128 KB that you plan to store for at least 30 days. If the size of an object is less than 128 KB, it is not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the frequent access tier rates in the S3 Intelligent-Tiering storage class.

\n

If you delete an object before the end of the 30-day minimum storage duration period, you are charged for 30 days. For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.

\n

Operations related to\n PutBucketIntelligentTieringConfiguration include:

\n ", - "smithy.api#http": { - "method": "PUT", - "uri": "/{Bucket}?intelligent-tiering", - "code": 200 - } - } - }, - "com.amazonaws.s3#PutBucketIntelligentTieringConfigurationRequest": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

The name of the Amazon S3 bucket whose configuration you want to modify or retrieve.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Id": { - "target": "com.amazonaws.s3#IntelligentTieringId", - "traits": { - "smithy.api#documentation": "

The ID used to identify the S3 Intelligent-Tiering configuration.

", - "smithy.api#httpQuery": "id", - "smithy.api#required": {} - } - }, - "IntelligentTieringConfiguration": { - "target": "com.amazonaws.s3#IntelligentTieringConfiguration", - "traits": { - "smithy.api#documentation": "

Container for S3 Intelligent-Tiering configuration.

", - "smithy.api#httpPayload": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.s3#PutBucketInventoryConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.s3#PutBucketInventoryConfigurationRequest" - }, - "traits": { - "smithy.api#documentation": "

This implementation of the PUT operation adds an inventory configuration\n (identified by the inventory ID) to the bucket. You can have up to 1,000 inventory\n configurations per bucket.

\n

Amazon S3 inventory generates inventories of the objects in the bucket on a daily or weekly\n basis, and the results are published to a flat file. The bucket that is inventoried is\n called the source bucket, and the bucket where the inventory flat file\n is stored is called the destination bucket. The\n destination bucket must be in the same AWS Region as the\n source bucket.

\n

When you configure an inventory for a source bucket, you specify\n the destination bucket where you want the inventory to be stored, and\n whether to generate the inventory daily or weekly. You can also configure what object\n metadata to include and whether to inventory all object versions or only current versions.\n For more information, see Amazon S3\n Inventory in the Amazon Simple Storage Service Developer Guide.

\n \n

You must create a bucket policy on the destination bucket to\n grant permissions to Amazon S3 to write objects to the bucket in the defined location. For an\n example policy, see \n Granting Permissions for Amazon S3 Inventory and Storage Class Analysis.

\n \n

To use this operation, you must have permissions to perform the\n s3:PutInventoryConfiguration action. The bucket owner has this permission\n by default and can grant this permission to others. For more information about permissions,\n see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources in the Amazon Simple Storage Service Developer Guide.

\n \n

\n Special Errors\n

\n \n \n

\n Related Resources\n

\n ", - "smithy.api#http": { - "method": "PUT", - "uri": "/{Bucket}?inventory", - "code": 200 - } - } - }, - "com.amazonaws.s3#PutBucketInventoryConfigurationRequest": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

The name of the bucket where the inventory configuration will be stored.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Id": { - "target": "com.amazonaws.s3#InventoryId", - "traits": { - "smithy.api#documentation": "

The ID used to identify the inventory configuration.

", - "smithy.api#httpQuery": "id", - "smithy.api#required": {} - } - }, - "InventoryConfiguration": { - "target": "com.amazonaws.s3#InventoryConfiguration", - "traits": { - "smithy.api#documentation": "

Specifies the inventory configuration.

", - "smithy.api#httpPayload": {}, - "smithy.api#required": {} - } - }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", - "smithy.api#httpHeader": "x-amz-expected-bucket-owner" - } - } - } - }, - "com.amazonaws.s3#PutBucketLifecycleConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.s3#PutBucketLifecycleConfigurationRequest" - }, - "traits": { - "smithy.api#documentation": "

Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle\n configuration. For information about lifecycle configuration, see Managing Access Permissions to Your Amazon S3\n Resources.

\n\n \n

Bucket lifecycle configuration now supports specifying a lifecycle rule using an\n object key name prefix, one or more object tags, or a combination of both. Accordingly,\n this section describes the latest API. The previous version of the API supported\n filtering based only on an object key name prefix, which is supported for backward\n compatibility. For the related API description, see PutBucketLifecycle.

\n \n\n \n\n

\n Rules\n

\n

You specify the lifecycle configuration in your request body. The lifecycle\n configuration is specified as XML consisting of one or more rules. Each rule consists of\n the following:

\n\n \n\n

For more information, see Object\n Lifecycle Management and Lifecycle Configuration Elements.

\n\n\n

\n Permissions\n

\n\n\n

By default, all Amazon S3 resources are private, including buckets, objects, and related\n subresources (for example, lifecycle configuration and website configuration). Only the\n resource owner (that is, the AWS account that created it) can access the resource. The\n resource owner can optionally grant access permissions to others by writing an access\n policy. For this operation, a user must get the s3:PutLifecycleConfiguration\n permission.

\n\n

You can also explicitly deny permissions. Explicit deny also supersedes any other\n permissions. If you want to block users or accounts from removing or deleting objects from\n your bucket, you must deny them permissions for the following actions:

\n\n \n\n\n

For more information about permissions, see Managing Access Permissions to Your Amazon S3\n Resources.

\n\n

The following are related to PutBucketLifecycleConfiguration:

\n ", - "smithy.api#http": { - "method": "PUT", - "uri": "/{Bucket}?lifecycle", - "code": 200 - }, - "smithy.api#httpChecksumRequired": {} - } - }, - "com.amazonaws.s3#PutBucketLifecycleConfigurationRequest": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

The name of the bucket for which to set the configuration.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "LifecycleConfiguration": { - "target": "com.amazonaws.s3#BucketLifecycleConfiguration", - "traits": { - "smithy.api#documentation": "

Container for lifecycle rules. You can add as many as 1,000 rules.

", - "smithy.api#httpPayload": {} - } - }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", - "smithy.api#httpHeader": "x-amz-expected-bucket-owner" - } - } - } - }, - "com.amazonaws.s3#PutBucketLogging": { - "type": "operation", - "input": { - "target": "com.amazonaws.s3#PutBucketLoggingRequest" - }, - "traits": { - "smithy.api#documentation": "

Set the logging parameters for a bucket and to specify permissions for who can view and\n modify the logging parameters. All logs are saved to buckets in the same AWS Region as the\n source bucket. To set the logging status of a bucket, you must be the bucket owner.

\n\n

The bucket owner is automatically granted FULL_CONTROL to all logs. You use the\n Grantee request element to grant access to other people. The\n Permissions request element specifies the kind of access the grantee has to\n the logs.

\n\n

\n Grantee Values\n

\n

You can specify the person (grantee) to whom you're assigning access rights (using\n request elements) in the following ways:

\n\n \n\n\n

To enable logging, you use LoggingEnabled and its children request elements. To disable\n logging, you use an empty BucketLoggingStatus request element:

\n\n

\n \n

\n\n

For more information about server access logging, see Server Access Logging.

\n\n

For more information about creating a bucket, see CreateBucket. For more\n information about returning the logging status of a bucket, see GetBucketLogging.

\n\n

The following operations are related to PutBucketLogging:

\n ", - "smithy.api#http": { - "method": "PUT", - "uri": "/{Bucket}?logging", - "code": 200 - }, - "smithy.api#httpChecksumRequired": {} - } - }, - "com.amazonaws.s3#PutBucketLoggingRequest": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

The name of the bucket for which to set the logging parameters.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "BucketLoggingStatus": { - "target": "com.amazonaws.s3#BucketLoggingStatus", - "traits": { - "smithy.api#documentation": "

Container for logging status information.

", - "smithy.api#httpPayload": {}, - "smithy.api#required": {} - } - }, - "ContentMD5": { - "target": "com.amazonaws.s3#ContentMD5", - "traits": { - "smithy.api#documentation": "

The MD5 hash of the PutBucketLogging request body.

\n

For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically.

", - "smithy.api#httpHeader": "Content-MD5" - } - }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", - "smithy.api#httpHeader": "x-amz-expected-bucket-owner" - } - } - } - }, - "com.amazonaws.s3#PutBucketMetricsConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.s3#PutBucketMetricsConfigurationRequest" - }, - "traits": { - "smithy.api#documentation": "

Sets a metrics configuration (specified by the metrics configuration ID) for the bucket.\n You can have up to 1,000 metrics configurations per bucket. If you're updating an existing\n metrics configuration, note that this is a full replacement of the existing metrics\n configuration. If you don't include the elements you want to keep, they are erased.

\n\n

To use this operation, you must have permissions to perform the\n s3:PutMetricsConfiguration action. The bucket owner has this permission by\n default. The bucket owner can grant this permission to others. For more information about\n permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources.

\n\n

For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon\n CloudWatch.

\n\n

The following operations are related to\n PutBucketMetricsConfiguration:

\n \n\n\n\n\n\n\n

\n GetBucketLifecycle has the following special error:

\n ", - "smithy.api#http": { - "method": "PUT", - "uri": "/{Bucket}?metrics", - "code": 200 - } - } - }, - "com.amazonaws.s3#PutBucketMetricsConfigurationRequest": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

The name of the bucket for which the metrics configuration is set.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Id": { - "target": "com.amazonaws.s3#MetricsId", - "traits": { - "smithy.api#documentation": "

The ID used to identify the metrics configuration.

", - "smithy.api#httpQuery": "id", - "smithy.api#required": {} - } - }, - "MetricsConfiguration": { - "target": "com.amazonaws.s3#MetricsConfiguration", - "traits": { - "smithy.api#documentation": "

Specifies the metrics configuration.

", - "smithy.api#httpPayload": {}, - "smithy.api#required": {} - } - }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", - "smithy.api#httpHeader": "x-amz-expected-bucket-owner" - } - } - } - }, - "com.amazonaws.s3#PutBucketNotificationConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.s3#PutBucketNotificationConfigurationRequest" - }, - "traits": { - "smithy.api#documentation": "

Enables notifications of specified events for a bucket. For more information about event\n notifications, see Configuring Event\n Notifications.

\n\n

Using this API, you can replace an existing notification configuration. The\n configuration is an XML file that defines the event types that you want Amazon S3 to publish and\n the destination where you want Amazon S3 to publish an event notification when it detects an\n event of the specified type.

\n\n

By default, your bucket has no event notifications configured. That is, the notification\n configuration will be an empty NotificationConfiguration.

\n\n

\n \n

\n

\n \n

\n

This operation replaces the existing notification configuration with the configuration\n you include in the request body.

\n\n

After Amazon S3 receives this request, it first verifies that any Amazon Simple Notification\n Service (Amazon SNS) or Amazon Simple Queue Service (Amazon SQS) destination exists, and\n that the bucket owner has permission to publish to it by sending a test notification. In\n the case of AWS Lambda destinations, Amazon S3 verifies that the Lambda function permissions\n grant Amazon S3 permission to invoke the function from the Amazon S3 bucket. For more information,\n see Configuring Notifications for Amazon S3\n Events.

\n\n

You can disable notifications by adding the empty NotificationConfiguration\n element.

\n\n

By default, only the bucket owner can configure notifications on a bucket. However,\n bucket owners can use a bucket policy to grant permission to other users to set this\n configuration with s3:PutBucketNotification permission.

\n\n \n

The PUT notification is an atomic operation. For example, suppose your notification\n configuration includes SNS topic, SQS queue, and Lambda function configurations. When\n you send a PUT request with this configuration, Amazon S3 sends test messages to your SNS\n topic. If the message fails, the entire PUT operation will fail, and Amazon S3 will not add\n the configuration to your bucket.

\n \n\n

\n Responses\n

\n

If the configuration in the request body includes only one\n TopicConfiguration specifying only the\n s3:ReducedRedundancyLostObject event type, the response will also include\n the x-amz-sns-test-message-id header containing the message ID of the test\n notification sent to the topic.

\n\n

The following operation is related to\n PutBucketNotificationConfiguration:

\n ", - "smithy.api#http": { - "method": "PUT", - "uri": "/{Bucket}?notification", - "code": 200 - } - } - }, - "com.amazonaws.s3#PutBucketNotificationConfigurationRequest": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

The name of the bucket.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "NotificationConfiguration": { - "target": "com.amazonaws.s3#NotificationConfiguration", - "traits": { - "smithy.api#httpPayload": {}, - "smithy.api#required": {} - } - }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", - "smithy.api#httpHeader": "x-amz-expected-bucket-owner" - } - } - } - }, - "com.amazonaws.s3#PutBucketOwnershipControls": { - "type": "operation", - "input": { - "target": "com.amazonaws.s3#PutBucketOwnershipControlsRequest" - }, - "traits": { - "smithy.api#documentation": "

Creates or modifies OwnershipControls for an Amazon S3 bucket. To use this\n operation, you must have the s3:PutBucketOwnershipControls permission. For\n more information about Amazon S3 permissions, see Specifying Permissions in a Policy.

\n

For information about Amazon S3 Object Ownership, see Using Object Ownership.

\n

The following operations are related to PutBucketOwnershipControls:

\n ", - "smithy.api#http": { - "method": "PUT", - "uri": "/{Bucket}?ownershipControls", - "code": 200 - }, - "smithy.api#httpChecksumRequired": {} - } - }, - "com.amazonaws.s3#PutBucketOwnershipControlsRequest": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

The name of the Amazon S3 bucket whose OwnershipControls you want to set.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ContentMD5": { - "target": "com.amazonaws.s3#ContentMD5", - "traits": { - "smithy.api#documentation": "

The MD5 hash of the OwnershipControls request body.

\n

For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically.

", - "smithy.api#httpHeader": "Content-MD5" - } - }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", - "smithy.api#httpHeader": "x-amz-expected-bucket-owner" - } - }, - "OwnershipControls": { - "target": "com.amazonaws.s3#OwnershipControls", - "traits": { - "smithy.api#documentation": "

The OwnershipControls (BucketOwnerPreferred or ObjectWriter) that you want\n to apply to this Amazon S3 bucket.

", - "smithy.api#httpPayload": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.s3#PutBucketPolicy": { - "type": "operation", - "input": { - "target": "com.amazonaws.s3#PutBucketPolicyRequest" - }, - "traits": { - "smithy.api#documentation": "

Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity other than\n the root user of the AWS account that owns the bucket, the calling identity must have the\n PutBucketPolicy permissions on the specified bucket and belong to the\n bucket owner's account in order to use this operation.

\n\n

If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403\n Access Denied error. If you have the correct permissions, but you're not using an\n identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not\n Allowed error.

\n\n \n

As a security precaution, the root user of the AWS account that owns a bucket can\n always use this operation, even if the policy explicitly denies the root user the\n ability to perform this action.

\n \n\n\n

For more information about bucket policies, see Using Bucket Policies and User\n Policies.

\n\n

The following operations are related to PutBucketPolicy:

\n ", - "smithy.api#http": { - "method": "PUT", - "uri": "/{Bucket}?policy", - "code": 200 - }, - "smithy.api#httpChecksumRequired": {} - } - }, - "com.amazonaws.s3#PutBucketPolicyRequest": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

The name of the bucket.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ContentMD5": { - "target": "com.amazonaws.s3#ContentMD5", - "traits": { - "smithy.api#documentation": "

The MD5 hash of the request body.

\n

For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically.

", - "smithy.api#httpHeader": "Content-MD5" - } - }, - "ConfirmRemoveSelfBucketAccess": { - "target": "com.amazonaws.s3#ConfirmRemoveSelfBucketAccess", - "traits": { - "smithy.api#documentation": "

Set this parameter to true to confirm that you want to remove your permissions to change\n this bucket policy in the future.

", - "smithy.api#httpHeader": "x-amz-confirm-remove-self-bucket-access" - } - }, - "Policy": { - "target": "com.amazonaws.s3#Policy", - "traits": { - "smithy.api#documentation": "

The bucket policy as a JSON document.

", - "smithy.api#httpPayload": {}, - "smithy.api#required": {} - } - }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", - "smithy.api#httpHeader": "x-amz-expected-bucket-owner" - } - } - } - }, - "com.amazonaws.s3#PutBucketReplication": { - "type": "operation", - "input": { - "target": "com.amazonaws.s3#PutBucketReplicationRequest" - }, - "traits": { - "smithy.api#documentation": "

Creates a replication configuration or replaces an existing one. For more information,\n see Replication in the Amazon S3 Developer Guide.

\n \n

To perform this operation, the user or role performing the operation must have the\n iam:PassRole permission.

\n \n

Specify the replication configuration in the request body. In the replication\n configuration, you provide the name of the destination bucket or buckets where you want\n Amazon S3 to replicate objects, the IAM role that Amazon S3 can assume to replicate objects on your\n behalf, and other relevant information.

\n\n\n

A replication configuration must include at least one rule, and can contain a maximum of\n 1,000. Each rule identifies a subset of objects to replicate by filtering the objects in\n the source bucket. To choose additional subsets of objects to replicate, add a rule for\n each subset.

\n\n

To specify a subset of the objects in the source bucket to apply a replication rule to,\n add the Filter element as a child of the Rule element. You can filter objects based on an\n object key prefix, one or more object tags, or both. When you add the Filter element in the\n configuration, you must also add the following elements:\n DeleteMarkerReplication, Status, and\n Priority.

\n \n

If you are using an earlier version of the replication configuration, Amazon S3 handles\n replication of delete markers differently. For more information, see Backward Compatibility.

\n \n

For information about enabling versioning on a bucket, see Using Versioning.

\n\n

By default, a resource owner, in this case the AWS account that created the bucket, can\n perform this operation. The resource owner can also grant others permissions to perform the\n operation. For more information about permissions, see Specifying Permissions in a Policy\n and Managing Access Permissions to Your\n Amazon S3 Resources.

\n\n

\n Handling Replication of Encrypted Objects\n

\n

By default, Amazon S3 doesn't replicate objects that are stored at rest using server-side\n encryption with CMKs stored in AWS KMS. To replicate AWS KMS-encrypted objects, add the\n following: SourceSelectionCriteria, SseKmsEncryptedObjects,\n Status, EncryptionConfiguration, and\n ReplicaKmsKeyID. For information about replication configuration, see\n Replicating Objects\n Created with SSE Using CMKs stored in AWS KMS.

\n\n

For information on PutBucketReplication errors, see List of\n replication-related error codes\n

\n\n\n

The following operations are related to PutBucketReplication:

\n ", - "smithy.api#http": { - "method": "PUT", - "uri": "/{Bucket}?replication", - "code": 200 - }, - "smithy.api#httpChecksumRequired": {} - } - }, - "com.amazonaws.s3#PutBucketReplicationRequest": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

The name of the bucket

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ContentMD5": { - "target": "com.amazonaws.s3#ContentMD5", - "traits": { - "smithy.api#documentation": "

The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message\n integrity check to verify that the request body was not corrupted in transit. For more\n information, see RFC 1864.

\n

For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically.

", - "smithy.api#httpHeader": "Content-MD5" - } - }, - "ReplicationConfiguration": { - "target": "com.amazonaws.s3#ReplicationConfiguration", - "traits": { - "smithy.api#httpPayload": {}, - "smithy.api#required": {} - } - }, - "Token": { - "target": "com.amazonaws.s3#ObjectLockToken", - "traits": { - "smithy.api#documentation": "

A token to allow Object Lock to be enabled for an existing bucket.

", - "smithy.api#httpHeader": "x-amz-bucket-object-lock-token" - } - }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", - "smithy.api#httpHeader": "x-amz-expected-bucket-owner" - } - } - } - }, - "com.amazonaws.s3#PutBucketRequestPayment": { - "type": "operation", - "input": { - "target": "com.amazonaws.s3#PutBucketRequestPaymentRequest" - }, - "traits": { - "smithy.api#documentation": "

Sets the request payment configuration for a bucket. By default, the bucket owner pays\n for downloads from the bucket. This configuration parameter enables the bucket owner (only)\n to specify that the person requesting the download will be charged for the download. For\n more information, see Requester Pays\n Buckets.

\n\n

The following operations are related to PutBucketRequestPayment:

\n ", - "smithy.api#http": { - "method": "PUT", - "uri": "/{Bucket}?requestPayment", - "code": 200 - }, - "smithy.api#httpChecksumRequired": {} - } - }, - "com.amazonaws.s3#PutBucketRequestPaymentRequest": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

The bucket name.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ContentMD5": { - "target": "com.amazonaws.s3#ContentMD5", - "traits": { - "smithy.api#documentation": "

>The base64-encoded 128-bit MD5 digest of the data. You must use this header as a\n message integrity check to verify that the request body was not corrupted in transit. For\n more information, see RFC\n 1864.

\n

For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically.

", - "smithy.api#httpHeader": "Content-MD5" - } - }, - "RequestPaymentConfiguration": { - "target": "com.amazonaws.s3#RequestPaymentConfiguration", - "traits": { - "smithy.api#documentation": "

Container for Payer.

", - "smithy.api#httpPayload": {}, - "smithy.api#required": {} - } - }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", - "smithy.api#httpHeader": "x-amz-expected-bucket-owner" - } - } - } - }, - "com.amazonaws.s3#PutBucketTagging": { - "type": "operation", - "input": { - "target": "com.amazonaws.s3#PutBucketTaggingRequest" - }, - "traits": { - "smithy.api#documentation": "

Sets the tags for a bucket.

\n

Use tags to organize your AWS bill to reflect your own cost structure. To do this, sign\n up to get your AWS account bill with tag key values included. Then, to see the cost of\n combined resources, organize your billing information according to resources with the same\n tag key values. For example, you can tag several resources with a specific application\n name, and then organize your billing information to see the total cost of that application\n across several services. For more information, see Cost Allocation\n and Tagging.

\n\n \n

Within a bucket, if you add a tag that has the same key as an existing tag, the new\n value overwrites the old value. For more information, see Using Cost Allocation in Amazon S3 Bucket\n Tags.

\n \n

To use this operation, you must have permissions to perform the\n s3:PutBucketTagging action. The bucket owner has this permission by default\n and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources.

\n\n

\n PutBucketTagging has the following special errors:

\n \n\n\n

The following operations are related to PutBucketTagging:

\n ", - "smithy.api#http": { - "method": "PUT", - "uri": "/{Bucket}?tagging", - "code": 200 - }, - "smithy.api#httpChecksumRequired": {} - } - }, - "com.amazonaws.s3#PutBucketTaggingRequest": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

The bucket name.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ContentMD5": { - "target": "com.amazonaws.s3#ContentMD5", - "traits": { - "smithy.api#documentation": "

The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message\n integrity check to verify that the request body was not corrupted in transit. For more\n information, see RFC 1864.

\n

For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically.

", - "smithy.api#httpHeader": "Content-MD5" - } - }, - "Tagging": { - "target": "com.amazonaws.s3#Tagging", - "traits": { - "smithy.api#documentation": "

Container for the TagSet and Tag elements.

", - "smithy.api#httpPayload": {}, - "smithy.api#required": {} - } - }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", - "smithy.api#httpHeader": "x-amz-expected-bucket-owner" - } - } - } - }, - "com.amazonaws.s3#PutBucketVersioning": { - "type": "operation", - "input": { - "target": "com.amazonaws.s3#PutBucketVersioningRequest" - }, - "traits": { - "smithy.api#documentation": "

Sets the versioning state of an existing bucket. To set the versioning state, you must\n be the bucket owner.

\n

You can set the versioning state with one of the following values:

\n\n

\n Enabled—Enables versioning for the objects in the\n bucket. All objects added to the bucket receive a unique version ID.

\n\n

\n Suspended—Disables versioning for the objects in the\n bucket. All objects added to the bucket receive the version ID null.

\n\n

If the versioning state has never been set on a bucket, it has no versioning state; a\n GetBucketVersioning request does not return a versioning state value.

\n\n

If the bucket owner enables MFA Delete in the bucket versioning configuration, the\n bucket owner must include the x-amz-mfa request header and the\n Status and the MfaDelete request elements in a request to set\n the versioning state of the bucket.

\n\n \n

If you have an object expiration lifecycle policy in your non-versioned bucket and\n you want to maintain the same permanent delete behavior when you enable versioning, you\n must add a noncurrent expiration policy. The noncurrent expiration lifecycle policy will\n manage the deletes of the noncurrent object versions in the version-enabled bucket. (A\n version-enabled bucket maintains one current and zero or more noncurrent object\n versions.) For more information, see Lifecycle and Versioning.

\n \n\n

\n Related Resources\n

\n ", - "smithy.api#http": { - "method": "PUT", - "uri": "/{Bucket}?versioning", - "code": 200 - }, - "smithy.api#httpChecksumRequired": {} - } - }, - "com.amazonaws.s3#PutBucketVersioningRequest": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

The bucket name.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ContentMD5": { - "target": "com.amazonaws.s3#ContentMD5", - "traits": { - "smithy.api#documentation": "

>The base64-encoded 128-bit MD5 digest of the data. You must use this header as a\n message integrity check to verify that the request body was not corrupted in transit. For\n more information, see RFC\n 1864.

\n

For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically.

", - "smithy.api#httpHeader": "Content-MD5" - } - }, - "MFA": { - "target": "com.amazonaws.s3#MFA", - "traits": { - "smithy.api#documentation": "

The concatenation of the authentication device's serial number, a space, and the value\n that is displayed on your authentication device.

", - "smithy.api#httpHeader": "x-amz-mfa" - } - }, - "VersioningConfiguration": { - "target": "com.amazonaws.s3#VersioningConfiguration", - "traits": { - "smithy.api#documentation": "

Container for setting the versioning state.

", - "smithy.api#httpPayload": {}, - "smithy.api#required": {} - } - }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", - "smithy.api#httpHeader": "x-amz-expected-bucket-owner" - } - } - } - }, - "com.amazonaws.s3#PutBucketWebsite": { - "type": "operation", - "input": { - "target": "com.amazonaws.s3#PutBucketWebsiteRequest" - }, - "traits": { - "smithy.api#documentation": "

Sets the configuration of the website that is specified in the website\n subresource. To configure a bucket as a website, you can add this subresource on the bucket\n with website configuration information such as the file name of the index document and any\n redirect rules. For more information, see Hosting Websites on Amazon S3.

\n\n

This PUT operation requires the S3:PutBucketWebsite permission. By default,\n only the bucket owner can configure the website attached to a bucket; however, bucket\n owners can allow other users to set the website configuration by writing a bucket policy\n that grants them the S3:PutBucketWebsite permission.

\n\n

To redirect all website requests sent to the bucket's website endpoint, you add a\n website configuration with the following elements. Because all requests are sent to another\n website, you don't need to provide index document name for the bucket.

\n \n\n

If you want granular control over redirects, you can use the following elements to add\n routing rules that describe conditions for redirecting requests and information about the\n redirect destination. In this case, the website configuration must provide an index\n document for the bucket, because some requests might not be redirected.

\n \n\n

Amazon S3 has a limitation of 50 routing rules per website configuration. If you require more\n than 50 routing rules, you can use object redirect. For more information, see Configuring an\n Object Redirect in the Amazon Simple Storage Service Developer Guide.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/{Bucket}?website", - "code": 200 - }, - "smithy.api#httpChecksumRequired": {} - } - }, - "com.amazonaws.s3#PutBucketWebsiteRequest": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

The bucket name.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ContentMD5": { - "target": "com.amazonaws.s3#ContentMD5", - "traits": { - "smithy.api#documentation": "

The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message\n integrity check to verify that the request body was not corrupted in transit. For more\n information, see RFC 1864.

\n

For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically.

", - "smithy.api#httpHeader": "Content-MD5" - } - }, - "WebsiteConfiguration": { - "target": "com.amazonaws.s3#WebsiteConfiguration", - "traits": { - "smithy.api#documentation": "

Container for the request.

", - "smithy.api#httpPayload": {}, - "smithy.api#required": {} - } - }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", - "smithy.api#httpHeader": "x-amz-expected-bucket-owner" - } - } - } - }, - "com.amazonaws.s3#PutObject": { - "type": "operation", - "input": { - "target": "com.amazonaws.s3#PutObjectRequest" - }, - "output": { - "target": "com.amazonaws.s3#PutObjectOutput" - }, - "traits": { - "smithy.api#documentation": "

Adds an object to a bucket. You must have WRITE permissions on a bucket to add an object\n to it.

\n\n\n

Amazon S3 never adds partial objects; if you receive a success response, Amazon S3 added the\n entire object to the bucket.

\n\n

Amazon S3 is a distributed system. If it receives multiple write requests for the same object\n simultaneously, it overwrites all but the last object written. Amazon S3 does not provide object\n locking; if you need this, make sure to build it into your application layer or use\n versioning instead.

\n\n

To ensure that data is not corrupted traversing the network, use the\n Content-MD5 header. When you use this header, Amazon S3 checks the object\n against the provided MD5 value and, if they do not match, returns an error. Additionally,\n you can calculate the MD5 while putting an object to Amazon S3 and compare the returned ETag to\n the calculated MD5 value.

\n \n

The Content-MD5 header is required for any request to upload an object\n with a retention period configured using Amazon S3 Object Lock. For more information about\n Amazon S3 Object Lock, see Amazon S3 Object Lock Overview\n in the Amazon Simple Storage Service Developer Guide.

\n \n\n\n

\n Server-side Encryption\n

\n

You can optionally request server-side encryption. With server-side encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts the data\n when you access it. You have the option to provide your own encryption key or use AWS\n managed encryption keys (SSE-S3 or SSE-KMS). For more information, see Using Server-Side\n Encryption.

\n

If you request server-side encryption using AWS Key Management Service (SSE-KMS), you can enable an S3 Bucket Key at the object-level. For more information, see Amazon S3 Bucket Keys in the Amazon Simple Storage Service Developer Guide.

\n

\n Access Control List (ACL)-Specific Request\n Headers\n

\n

You can use headers to grant ACL- based permissions. By default, all objects are\n private. Only the owner has full access control. When adding a new object, you can grant\n permissions to individual AWS accounts or to predefined groups defined by Amazon S3. These\n permissions are then added to the ACL on the object. For more information, see Access Control List\n (ACL) Overview and Managing ACLs Using the REST\n API.

\n\n

\n Storage Class Options\n

\n

By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The\n STANDARD storage class provides high durability and high availability. Depending on\n performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses\n the OUTPOSTS Storage Class. For more information, see Storage Classes in the Amazon S3\n Service Developer Guide.

\n\n\n

\n Versioning\n

\n

If you enable versioning for a bucket, Amazon S3 automatically generates a unique version ID\n for the object being stored. Amazon S3 returns this ID in the response. When you enable\n versioning for a bucket, if Amazon S3 receives multiple write requests for the same object\n simultaneously, it stores all of the objects.

\n

For more information about versioning, see Adding Objects to\n Versioning Enabled Buckets. For information about returning the versioning state\n of a bucket, see GetBucketVersioning.

\n\n\n

\n Related Resources\n

\n ", - "smithy.api#http": { - "method": "PUT", - "uri": "/{Bucket}/{Key+}?x-id=PutObject", - "code": 200 - } - } - }, - "com.amazonaws.s3#PutObjectAcl": { - "type": "operation", - "input": { - "target": "com.amazonaws.s3#PutObjectAclRequest" - }, - "output": { - "target": "com.amazonaws.s3#PutObjectAclOutput" - }, - "errors": [ - { - "target": "com.amazonaws.s3#NoSuchKey" - } - ], - "traits": { - "smithy.api#documentation": "

Uses the acl subresource to set the access control list (ACL) permissions\n for a new or existing object in an S3 bucket. You must have WRITE_ACP\n permission to set the ACL of an object. For more information, see What\n permissions can I grant? in the Amazon Simple Storage Service Developer Guide.

\n

This action is not supported by Amazon S3 on Outposts.

\n

Depending on your application needs, you can choose to set\n the ACL on an object using either the request body or the headers. For example, if you have\n an existing application that updates a bucket ACL using the request body, you can continue\n to use that approach. For more information, see Access Control List (ACL) Overview in the Amazon S3 Developer\n Guide.

\n\n\n\n

\n Access Permissions\n

\n

You can set access permissions using one of the following methods:

\n \n

You can use either a canned ACL or specify access permissions explicitly. You cannot do\n both.

\n

\n Grantee Values\n

\n

You can specify the person (grantee) to whom you're assigning access rights (using\n request elements) in the following ways:

\n \n

\n Versioning\n

\n

The ACL of an object is set at the object version level. By default, PUT sets the ACL of\n the current version of an object. To set the ACL of a different version, use the\n versionId subresource.

\n

\n Related Resources\n

\n ", - "smithy.api#http": { - "method": "PUT", - "uri": "/{Bucket}/{Key+}?acl", - "code": 200 - }, - "smithy.api#httpChecksumRequired": {} - } - }, - "com.amazonaws.s3#PutObjectAclOutput": { - "type": "structure", - "members": { - "RequestCharged": { - "target": "com.amazonaws.s3#RequestCharged", - "traits": { - "smithy.api#httpHeader": "x-amz-request-charged" - } - } - } - }, - "com.amazonaws.s3#PutObjectAclRequest": { - "type": "structure", - "members": { - "ACL": { - "target": "com.amazonaws.s3#ObjectCannedACL", - "traits": { - "smithy.api#documentation": "

The canned ACL to apply to the object. For more information, see Canned ACL.

", - "smithy.api#httpHeader": "x-amz-acl" - } - }, - "AccessControlPolicy": { - "target": "com.amazonaws.s3#AccessControlPolicy", - "traits": { - "smithy.api#documentation": "

Contains the elements that set the ACL permissions for an object per grantee.

", - "smithy.api#httpPayload": {} - } - }, - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

The bucket name that contains the object to which you want to attach the ACL.

\n

When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ContentMD5": { - "target": "com.amazonaws.s3#ContentMD5", - "traits": { - "smithy.api#documentation": "

The base64-encoded 128-bit MD5 digest of the data. This header must be used as a message\n integrity check to verify that the request body was not corrupted in transit. For more\n information, go to RFC\n 1864.>\n

\n

For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically.

", - "smithy.api#httpHeader": "Content-MD5" - } - }, - "GrantFullControl": { - "target": "com.amazonaws.s3#GrantFullControl", - "traits": { - "smithy.api#documentation": "

Allows grantee the read, write, read ACP, and write ACP permissions on the\n bucket.

\n

This action is not supported by Amazon S3 on Outposts.

", - "smithy.api#httpHeader": "x-amz-grant-full-control" - } - }, - "GrantRead": { - "target": "com.amazonaws.s3#GrantRead", - "traits": { - "smithy.api#documentation": "

Allows grantee to list the objects in the\n bucket.

\n

This action is not supported by Amazon S3 on Outposts.

", - "smithy.api#httpHeader": "x-amz-grant-read" - } - }, - "GrantReadACP": { - "target": "com.amazonaws.s3#GrantReadACP", - "traits": { - "smithy.api#documentation": "

Allows grantee to read the bucket ACL.

\n

This action is not supported by Amazon S3 on Outposts.

", - "smithy.api#httpHeader": "x-amz-grant-read-acp" - } - }, - "GrantWrite": { - "target": "com.amazonaws.s3#GrantWrite", - "traits": { - "smithy.api#documentation": "

Allows grantee to create, overwrite, and delete any object in the bucket.

", - "smithy.api#httpHeader": "x-amz-grant-write" - } - }, - "GrantWriteACP": { - "target": "com.amazonaws.s3#GrantWriteACP", - "traits": { - "smithy.api#documentation": "

Allows grantee to write the ACL for the applicable\n bucket.

\n

This action is not supported by Amazon S3 on Outposts.

", - "smithy.api#httpHeader": "x-amz-grant-write-acp" - } - }, - "Key": { - "target": "com.amazonaws.s3#ObjectKey", - "traits": { - "smithy.api#documentation": "

Key for which the PUT operation was initiated.

\n

When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.

\n

When using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "RequestPayer": { - "target": "com.amazonaws.s3#RequestPayer", - "traits": { - "smithy.api#httpHeader": "x-amz-request-payer" - } - }, - "VersionId": { - "target": "com.amazonaws.s3#ObjectVersionId", - "traits": { - "smithy.api#documentation": "

VersionId used to reference a specific version of the object.

", - "smithy.api#httpQuery": "versionId" - } - }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", - "smithy.api#httpHeader": "x-amz-expected-bucket-owner" - } - } - } - }, - "com.amazonaws.s3#PutObjectLegalHold": { - "type": "operation", - "input": { - "target": "com.amazonaws.s3#PutObjectLegalHoldRequest" - }, - "output": { - "target": "com.amazonaws.s3#PutObjectLegalHoldOutput" - }, - "traits": { - "smithy.api#documentation": "

Applies a Legal Hold configuration to the specified object.

\n

This action is not supported by Amazon S3 on Outposts.

\n

\n Related Resources\n

\n ", - "smithy.api#http": { - "method": "PUT", - "uri": "/{Bucket}/{Key+}?legal-hold", - "code": 200 - }, - "smithy.api#httpChecksumRequired": {} - } - }, - "com.amazonaws.s3#PutObjectLegalHoldOutput": { - "type": "structure", - "members": { - "RequestCharged": { - "target": "com.amazonaws.s3#RequestCharged", - "traits": { - "smithy.api#httpHeader": "x-amz-request-charged" - } - } - } - }, - "com.amazonaws.s3#PutObjectLegalHoldRequest": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

The bucket name containing the object that you want to place a Legal Hold on.

\n

When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Key": { - "target": "com.amazonaws.s3#ObjectKey", - "traits": { - "smithy.api#documentation": "

The key name for the object that you want to place a Legal Hold on.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "LegalHold": { - "target": "com.amazonaws.s3#ObjectLockLegalHold", - "traits": { - "smithy.api#documentation": "

Container element for the Legal Hold configuration you want to apply to the specified\n object.

", - "smithy.api#httpPayload": {} - } - }, - "RequestPayer": { - "target": "com.amazonaws.s3#RequestPayer", - "traits": { - "smithy.api#httpHeader": "x-amz-request-payer" - } - }, - "VersionId": { - "target": "com.amazonaws.s3#ObjectVersionId", - "traits": { - "smithy.api#documentation": "

The version ID of the object that you want to place a Legal Hold on.

", - "smithy.api#httpQuery": "versionId" - } - }, - "ContentMD5": { - "target": "com.amazonaws.s3#ContentMD5", - "traits": { - "smithy.api#documentation": "

The MD5 hash for the request body.

\n

For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically.

", - "smithy.api#httpHeader": "Content-MD5" - } - }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", - "smithy.api#httpHeader": "x-amz-expected-bucket-owner" - } - } - } - }, - "com.amazonaws.s3#PutObjectLockConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.s3#PutObjectLockConfigurationRequest" - }, - "output": { - "target": "com.amazonaws.s3#PutObjectLockConfigurationOutput" - }, - "traits": { - "smithy.api#documentation": "

Places an Object Lock configuration on the specified bucket. The rule specified in the\n Object Lock configuration will be applied by default to every new object placed in the\n specified bucket.

\n \n

\n DefaultRetention requires either Days or Years. You can't specify both\n at the same time.

\n \n

\n Related Resources\n

\n ", - "smithy.api#http": { - "method": "PUT", - "uri": "/{Bucket}?object-lock", - "code": 200 - }, - "smithy.api#httpChecksumRequired": {} - } - }, - "com.amazonaws.s3#PutObjectLockConfigurationOutput": { - "type": "structure", - "members": { - "RequestCharged": { - "target": "com.amazonaws.s3#RequestCharged", - "traits": { - "smithy.api#httpHeader": "x-amz-request-charged" - } - } - } - }, - "com.amazonaws.s3#PutObjectLockConfigurationRequest": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

The bucket whose Object Lock configuration you want to create or replace.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ObjectLockConfiguration": { - "target": "com.amazonaws.s3#ObjectLockConfiguration", - "traits": { - "smithy.api#documentation": "

The Object Lock configuration that you want to apply to the specified bucket.

", - "smithy.api#httpPayload": {} - } - }, - "RequestPayer": { - "target": "com.amazonaws.s3#RequestPayer", - "traits": { - "smithy.api#httpHeader": "x-amz-request-payer" - } - }, - "Token": { - "target": "com.amazonaws.s3#ObjectLockToken", - "traits": { - "smithy.api#documentation": "

A token to allow Object Lock to be enabled for an existing bucket.

", - "smithy.api#httpHeader": "x-amz-bucket-object-lock-token" - } - }, - "ContentMD5": { - "target": "com.amazonaws.s3#ContentMD5", - "traits": { - "smithy.api#documentation": "

The MD5 hash for the request body.

\n

For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically.

", - "smithy.api#httpHeader": "Content-MD5" - } - }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", - "smithy.api#httpHeader": "x-amz-expected-bucket-owner" - } - } - } - }, - "com.amazonaws.s3#PutObjectOutput": { - "type": "structure", - "members": { - "Expiration": { - "target": "com.amazonaws.s3#Expiration", - "traits": { - "smithy.api#documentation": "

If the expiration is configured for the object (see PutBucketLifecycleConfiguration), the response includes this header. It\n includes the expiry-date and rule-id key-value pairs that provide information about object\n expiration. The value of the rule-id is URL encoded.

", - "smithy.api#httpHeader": "x-amz-expiration" - } - }, - "ETag": { - "target": "com.amazonaws.s3#ETag", - "traits": { - "smithy.api#documentation": "

Entity tag for the uploaded object.

", - "smithy.api#httpHeader": "ETag" - } - }, - "ServerSideEncryption": { - "target": "com.amazonaws.s3#ServerSideEncryption", - "traits": { - "smithy.api#documentation": "

If you specified server-side encryption either with an AWS KMS customer master key (CMK)\n or Amazon S3-managed encryption key in your PUT request, the response includes this header. It\n confirms the encryption algorithm that Amazon S3 used to encrypt the object.

", - "smithy.api#httpHeader": "x-amz-server-side-encryption" - } - }, - "VersionId": { - "target": "com.amazonaws.s3#ObjectVersionId", - "traits": { - "smithy.api#documentation": "

Version of the object.

", - "smithy.api#httpHeader": "x-amz-version-id" - } - }, - "SSECustomerAlgorithm": { - "target": "com.amazonaws.s3#SSECustomerAlgorithm", - "traits": { - "smithy.api#documentation": "

If server-side encryption with a customer-provided encryption key was requested, the\n response will include this header confirming the encryption algorithm used.

", - "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-algorithm" - } - }, - "SSECustomerKeyMD5": { - "target": "com.amazonaws.s3#SSECustomerKeyMD5", - "traits": { - "smithy.api#documentation": "

If server-side encryption with a customer-provided encryption key was requested, the\n response will include this header to provide round-trip message integrity verification of\n the customer-provided encryption key.

", - "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key-MD5" - } - }, - "SSEKMSKeyId": { - "target": "com.amazonaws.s3#SSEKMSKeyId", - "traits": { - "smithy.api#documentation": "

If x-amz-server-side-encryption is present and has the value of\n aws:kms, this header specifies the ID of the AWS Key Management Service\n (AWS KMS) symmetric customer managed customer master key (CMK) that was used for the\n object.

", - "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" - } - }, - "SSEKMSEncryptionContext": { - "target": "com.amazonaws.s3#SSEKMSEncryptionContext", - "traits": { - "smithy.api#documentation": "

If present, specifies the AWS KMS Encryption Context to use for object encryption. The\n value of this header is a base64-encoded UTF-8 string holding JSON with the encryption\n context key-value pairs.

", - "smithy.api#httpHeader": "x-amz-server-side-encryption-context" - } - }, - "BucketKeyEnabled": { - "target": "com.amazonaws.s3#BucketKeyEnabled", - "traits": { - "smithy.api#documentation": "

Indicates whether the uploaded object uses an S3 Bucket Key for server-side encryption with AWS KMS (SSE-KMS).

", - "smithy.api#httpHeader": "x-amz-server-side-encryption-bucket-key-enabled" - } - }, - "RequestCharged": { - "target": "com.amazonaws.s3#RequestCharged", - "traits": { - "smithy.api#httpHeader": "x-amz-request-charged" - } - } - } - }, - "com.amazonaws.s3#PutObjectRequest": { - "type": "structure", - "members": { - "ACL": { - "target": "com.amazonaws.s3#ObjectCannedACL", - "traits": { - "smithy.api#documentation": "

The canned ACL to apply to the object. For more information, see Canned\n ACL.

\n

This action is not supported by Amazon S3 on Outposts.

", - "smithy.api#httpHeader": "x-amz-acl" - } - }, - "Body": { - "target": "com.amazonaws.s3#StreamingBlob", - "traits": { - "smithy.api#documentation": "

Object data.

", - "smithy.api#httpPayload": {} - } - }, - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

The bucket name to which the PUT operation was initiated.

\n

When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.

\n

When using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "CacheControl": { - "target": "com.amazonaws.s3#CacheControl", - "traits": { - "smithy.api#documentation": "

Can be used to specify caching behavior along the request/reply chain. For more\n information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.

", - "smithy.api#httpHeader": "Cache-Control" - } - }, - "ContentDisposition": { - "target": "com.amazonaws.s3#ContentDisposition", - "traits": { - "smithy.api#documentation": "

Specifies presentational information for the object. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec19.html#sec19.5.1.

", - "smithy.api#httpHeader": "Content-Disposition" - } - }, - "ContentEncoding": { - "target": "com.amazonaws.s3#ContentEncoding", - "traits": { - "smithy.api#documentation": "

Specifies what content encodings have been applied to the object and thus what decoding\n mechanisms must be applied to obtain the media-type referenced by the Content-Type header\n field. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.11.

", - "smithy.api#httpHeader": "Content-Encoding" - } - }, - "ContentLanguage": { - "target": "com.amazonaws.s3#ContentLanguage", - "traits": { - "smithy.api#documentation": "

The language the content is in.

", - "smithy.api#httpHeader": "Content-Language" - } - }, - "ContentLength": { - "target": "com.amazonaws.s3#ContentLength", - "traits": { - "smithy.api#documentation": "

Size of the body in bytes. This parameter is useful when the size of the body cannot be\n determined automatically. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.13.

", - "smithy.api#httpHeader": "Content-Length" - } - }, - "ContentMD5": { - "target": "com.amazonaws.s3#ContentMD5", - "traits": { - "smithy.api#documentation": "

The base64-encoded 128-bit MD5 digest of the message (without the headers) according to\n RFC 1864. This header can be used as a message integrity check to verify that the data is\n the same data that was originally sent. Although it is optional, we recommend using the\n Content-MD5 mechanism as an end-to-end integrity check. For more information about REST\n request authentication, see REST\n Authentication.

", - "smithy.api#httpHeader": "Content-MD5" - } - }, - "ContentType": { - "target": "com.amazonaws.s3#ContentType", - "traits": { - "smithy.api#documentation": "

A standard MIME type describing the format of the contents. For more information, see\n http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17.

", - "smithy.api#httpHeader": "Content-Type" - } - }, - "Expires": { - "target": "com.amazonaws.s3#Expires", - "traits": { - "smithy.api#documentation": "

The date and time at which the object is no longer cacheable. For more information, see\n http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.21.

", - "smithy.api#httpHeader": "Expires" - } - }, - "GrantFullControl": { - "target": "com.amazonaws.s3#GrantFullControl", - "traits": { - "smithy.api#documentation": "

Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the\n object.

\n

This action is not supported by Amazon S3 on Outposts.

", - "smithy.api#httpHeader": "x-amz-grant-full-control" - } - }, - "GrantRead": { - "target": "com.amazonaws.s3#GrantRead", - "traits": { - "smithy.api#documentation": "

Allows grantee to read the object data and its\n metadata.

\n

This action is not supported by Amazon S3 on Outposts.

", - "smithy.api#httpHeader": "x-amz-grant-read" - } - }, - "GrantReadACP": { - "target": "com.amazonaws.s3#GrantReadACP", - "traits": { - "smithy.api#documentation": "

Allows grantee to read the object ACL.

\n

This action is not supported by Amazon S3 on Outposts.

", - "smithy.api#httpHeader": "x-amz-grant-read-acp" - } - }, - "GrantWriteACP": { - "target": "com.amazonaws.s3#GrantWriteACP", - "traits": { - "smithy.api#documentation": "

Allows grantee to write the ACL for the applicable\n object.

\n

This action is not supported by Amazon S3 on Outposts.

", - "smithy.api#httpHeader": "x-amz-grant-write-acp" - } - }, - "Key": { - "target": "com.amazonaws.s3#ObjectKey", - "traits": { - "smithy.api#documentation": "

Object key for which the PUT operation was initiated.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Metadata": { - "target": "com.amazonaws.s3#Metadata", - "traits": { - "smithy.api#documentation": "

A map of metadata to store with the object in S3.

", - "smithy.api#httpPrefixHeaders": "x-amz-meta-" - } - }, - "ServerSideEncryption": { - "target": "com.amazonaws.s3#ServerSideEncryption", - "traits": { - "smithy.api#documentation": "

The server-side encryption algorithm used when storing this object in Amazon S3 (for example,\n AES256, aws:kms).

", - "smithy.api#httpHeader": "x-amz-server-side-encryption" - } - }, - "StorageClass": { - "target": "com.amazonaws.s3#StorageClass", - "traits": { - "smithy.api#documentation": "

By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The\n STANDARD storage class provides high durability and high availability. Depending on\n performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses\n the OUTPOSTS Storage Class. For more information, see Storage Classes in the Amazon S3\n Service Developer Guide.

", - "smithy.api#httpHeader": "x-amz-storage-class" - } - }, - "WebsiteRedirectLocation": { - "target": "com.amazonaws.s3#WebsiteRedirectLocation", - "traits": { - "smithy.api#documentation": "

If the bucket is configured as a website, redirects requests for this object to another\n object in the same bucket or to an external URL. Amazon S3 stores the value of this header in\n the object metadata. For information about object metadata, see Object Key and Metadata.

\n\n

In the following example, the request header sets the redirect to an object\n (anotherPage.html) in the same bucket:

\n\n

\n x-amz-website-redirect-location: /anotherPage.html\n

\n\n

In the following example, the request header sets the object redirect to another\n website:

\n\n

\n x-amz-website-redirect-location: http://www.example.com/\n

\n\n

For more information about website hosting in Amazon S3, see Hosting Websites on Amazon S3 and How to Configure Website Page\n Redirects.

", - "smithy.api#httpHeader": "x-amz-website-redirect-location" - } - }, - "SSECustomerAlgorithm": { - "target": "com.amazonaws.s3#SSECustomerAlgorithm", - "traits": { - "smithy.api#documentation": "

Specifies the algorithm to use to when encrypting the object (for example,\n AES256).

", - "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-algorithm" - } - }, - "SSECustomerKey": { - "target": "com.amazonaws.s3#SSECustomerKey", - "traits": { - "smithy.api#documentation": "

Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This\n value is used to store the object and then it is discarded; Amazon S3 does not store the\n encryption key. The key must be appropriate for use with the algorithm specified in the\n x-amz-server-side-encryption-customer-algorithm header.

", - "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key" - } - }, - "SSECustomerKeyMD5": { - "target": "com.amazonaws.s3#SSECustomerKeyMD5", - "traits": { - "smithy.api#documentation": "

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses\n this header for a message integrity check to ensure that the encryption key was transmitted\n without error.

", - "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key-MD5" - } - }, - "SSEKMSKeyId": { - "target": "com.amazonaws.s3#SSEKMSKeyId", - "traits": { - "smithy.api#documentation": "

If x-amz-server-side-encryption is present and has the value of\n aws:kms, this header specifies the ID of the AWS Key Management Service\n (AWS KMS) symmetrical customer managed customer master key (CMK) that was used for the\n object.

\n

If the value of x-amz-server-side-encryption is aws:kms, this\n header specifies the ID of the symmetric customer managed AWS KMS CMK that will be used for\n the object. If you specify x-amz-server-side-encryption:aws:kms, but do not\n provide x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS\n managed CMK in AWS to protect the data.

", - "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" - } - }, - "SSEKMSEncryptionContext": { - "target": "com.amazonaws.s3#SSEKMSEncryptionContext", - "traits": { - "smithy.api#documentation": "

Specifies the AWS KMS Encryption Context to use for object encryption. The value of this\n header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value\n pairs.

", - "smithy.api#httpHeader": "x-amz-server-side-encryption-context" - } - }, - "BucketKeyEnabled": { - "target": "com.amazonaws.s3#BucketKeyEnabled", - "traits": { - "smithy.api#documentation": "

Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using AWS KMS (SSE-KMS). Setting this header to true causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS.

\n

Specifying this header with a PUT operation doesn’t affect bucket-level settings for S3 Bucket Key.

", - "smithy.api#httpHeader": "x-amz-server-side-encryption-bucket-key-enabled" - } - }, - "RequestPayer": { - "target": "com.amazonaws.s3#RequestPayer", - "traits": { - "smithy.api#httpHeader": "x-amz-request-payer" - } - }, - "Tagging": { - "target": "com.amazonaws.s3#TaggingHeader", - "traits": { - "smithy.api#documentation": "

The tag-set for the object. The tag-set must be encoded as URL Query parameters. (For\n example, \"Key1=Value1\")

", - "smithy.api#httpHeader": "x-amz-tagging" - } - }, - "ObjectLockMode": { - "target": "com.amazonaws.s3#ObjectLockMode", - "traits": { - "smithy.api#documentation": "

The Object Lock mode that you want to apply to this object.

", - "smithy.api#httpHeader": "x-amz-object-lock-mode" - } - }, - "ObjectLockRetainUntilDate": { - "target": "com.amazonaws.s3#ObjectLockRetainUntilDate", - "traits": { - "smithy.api#documentation": "

The date and time when you want this object's Object Lock to expire.

", - "smithy.api#httpHeader": "x-amz-object-lock-retain-until-date" - } - }, - "ObjectLockLegalHoldStatus": { - "target": "com.amazonaws.s3#ObjectLockLegalHoldStatus", - "traits": { - "smithy.api#documentation": "

Specifies whether a legal hold will be applied to this object. For more information\n about S3 Object Lock, see Object\n Lock.

", - "smithy.api#httpHeader": "x-amz-object-lock-legal-hold" - } - }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", - "smithy.api#httpHeader": "x-amz-expected-bucket-owner" - } - } - } - }, - "com.amazonaws.s3#PutObjectRetention": { - "type": "operation", - "input": { - "target": "com.amazonaws.s3#PutObjectRetentionRequest" - }, - "output": { - "target": "com.amazonaws.s3#PutObjectRetentionOutput" - }, - "traits": { - "smithy.api#documentation": "

Places an Object Retention configuration on an object.

\n

This action is not supported by Amazon S3 on Outposts.

\n

\n Related Resources\n

\n ", - "smithy.api#http": { - "method": "PUT", - "uri": "/{Bucket}/{Key+}?retention", - "code": 200 - }, - "smithy.api#httpChecksumRequired": {} - } - }, - "com.amazonaws.s3#PutObjectRetentionOutput": { - "type": "structure", - "members": { - "RequestCharged": { - "target": "com.amazonaws.s3#RequestCharged", - "traits": { - "smithy.api#httpHeader": "x-amz-request-charged" - } - } - } - }, - "com.amazonaws.s3#PutObjectRetentionRequest": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

The bucket name that contains the object you want to apply this Object Retention\n configuration to.

\n

When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Key": { - "target": "com.amazonaws.s3#ObjectKey", - "traits": { - "smithy.api#documentation": "

The key name for the object that you want to apply this Object Retention configuration\n to.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Retention": { - "target": "com.amazonaws.s3#ObjectLockRetention", - "traits": { - "smithy.api#documentation": "

The container element for the Object Retention configuration.

", - "smithy.api#httpPayload": {} - } - }, - "RequestPayer": { - "target": "com.amazonaws.s3#RequestPayer", - "traits": { - "smithy.api#httpHeader": "x-amz-request-payer" - } - }, - "VersionId": { - "target": "com.amazonaws.s3#ObjectVersionId", - "traits": { - "smithy.api#documentation": "

The version ID for the object that you want to apply this Object Retention configuration\n to.

", - "smithy.api#httpQuery": "versionId" - } - }, - "BypassGovernanceRetention": { - "target": "com.amazonaws.s3#BypassGovernanceRetention", - "traits": { - "smithy.api#documentation": "

Indicates whether this operation should bypass Governance-mode restrictions.

", - "smithy.api#httpHeader": "x-amz-bypass-governance-retention" - } - }, - "ContentMD5": { - "target": "com.amazonaws.s3#ContentMD5", - "traits": { - "smithy.api#documentation": "

The MD5 hash for the request body.

\n

For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically.

", - "smithy.api#httpHeader": "Content-MD5" - } - }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", - "smithy.api#httpHeader": "x-amz-expected-bucket-owner" - } - } - } - }, - "com.amazonaws.s3#PutObjectTagging": { - "type": "operation", - "input": { - "target": "com.amazonaws.s3#PutObjectTaggingRequest" - }, - "output": { - "target": "com.amazonaws.s3#PutObjectTaggingOutput" - }, - "traits": { - "smithy.api#documentation": "

Sets the supplied tag-set to an object that already exists in a bucket.

\n

A tag is a key-value pair. You can associate tags with an object by sending a PUT\n request against the tagging subresource that is associated with the object. You can\n retrieve tags by sending a GET request. For more information, see GetObjectTagging.

\n\n

For tagging-related restrictions related to characters and encodings, see Tag\n Restrictions. Note that Amazon S3 limits the maximum number of tags to 10 tags per\n object.

\n\n

To use this operation, you must have permission to perform the\n s3:PutObjectTagging action. By default, the bucket owner has this\n permission and can grant this permission to others.

\n\n

To put tags of any other version, use the versionId query parameter. You\n also need permission for the s3:PutObjectVersionTagging action.

\n\n

For information about the Amazon S3 object tagging feature, see Object Tagging.

\n\n\n

\n Special Errors\n

\n \n\n \n\n\n\n\n

\n Related Resources\n

\n ", - "smithy.api#http": { - "method": "PUT", - "uri": "/{Bucket}/{Key+}?tagging", - "code": 200 - }, - "smithy.api#httpChecksumRequired": {} - } - }, - "com.amazonaws.s3#PutObjectTaggingOutput": { - "type": "structure", - "members": { - "VersionId": { - "target": "com.amazonaws.s3#ObjectVersionId", - "traits": { - "smithy.api#documentation": "

The versionId of the object the tag-set was added to.

", - "smithy.api#httpHeader": "x-amz-version-id" - } - } - } - }, - "com.amazonaws.s3#PutObjectTaggingRequest": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

The bucket name containing the object.

\n

When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.

\n

When using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Key": { - "target": "com.amazonaws.s3#ObjectKey", - "traits": { - "smithy.api#documentation": "

Name of the object key.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "VersionId": { - "target": "com.amazonaws.s3#ObjectVersionId", - "traits": { - "smithy.api#documentation": "

The versionId of the object that the tag-set will be added to.

", - "smithy.api#httpQuery": "versionId" - } - }, - "ContentMD5": { - "target": "com.amazonaws.s3#ContentMD5", - "traits": { - "smithy.api#documentation": "

The MD5 hash for the request body.

\n

For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically.

", - "smithy.api#httpHeader": "Content-MD5" - } - }, - "Tagging": { - "target": "com.amazonaws.s3#Tagging", - "traits": { - "smithy.api#documentation": "

Container for the TagSet and Tag elements

", - "smithy.api#httpPayload": {}, - "smithy.api#required": {} - } - }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", - "smithy.api#httpHeader": "x-amz-expected-bucket-owner" - } - } - } - }, - "com.amazonaws.s3#PutPublicAccessBlock": { - "type": "operation", - "input": { - "target": "com.amazonaws.s3#PutPublicAccessBlockRequest" - }, - "traits": { - "smithy.api#documentation": "

Creates or modifies the PublicAccessBlock configuration for an Amazon S3 bucket.\n To use this operation, you must have the s3:PutBucketPublicAccessBlock\n permission. For more information about Amazon S3 permissions, see Specifying Permissions in a\n Policy.

\n\n \n

When Amazon S3 evaluates the PublicAccessBlock configuration for a bucket or\n an object, it checks the PublicAccessBlock configuration for both the\n bucket (or the bucket that contains the object) and the bucket owner's account. If the\n PublicAccessBlock configurations are different between the bucket and\n the account, Amazon S3 uses the most restrictive combination of the bucket-level and\n account-level settings.

\n \n\n\n

For more information about when Amazon S3 considers a bucket or an object public, see The Meaning of \"Public\".

\n\n\n\n

\n Related Resources\n

\n ", - "smithy.api#http": { - "method": "PUT", - "uri": "/{Bucket}?publicAccessBlock", - "code": 200 - }, - "smithy.api#httpChecksumRequired": {} - } - }, - "com.amazonaws.s3#PutPublicAccessBlockRequest": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

The name of the Amazon S3 bucket whose PublicAccessBlock configuration you want\n to set.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ContentMD5": { - "target": "com.amazonaws.s3#ContentMD5", - "traits": { - "smithy.api#documentation": "

The MD5 hash of the PutPublicAccessBlock request body.

\n

For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically.

", - "smithy.api#httpHeader": "Content-MD5" - } - }, - "PublicAccessBlockConfiguration": { - "target": "com.amazonaws.s3#PublicAccessBlockConfiguration", - "traits": { - "smithy.api#documentation": "

The PublicAccessBlock configuration that you want to apply to this Amazon S3\n bucket. You can enable the configuration options in any combination. For more information\n about when Amazon S3 considers a bucket or object public, see The Meaning of \"Public\" in the Amazon Simple Storage Service Developer\n Guide.

", - "smithy.api#httpPayload": {}, - "smithy.api#required": {} - } - }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", - "smithy.api#httpHeader": "x-amz-expected-bucket-owner" - } - } - } - }, - "com.amazonaws.s3#QueueArn": { - "type": "string" - }, - "com.amazonaws.s3#QueueConfiguration": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.s3#NotificationId" - }, - "QueueArn": { - "target": "com.amazonaws.s3#QueueArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon SQS queue to which Amazon S3 publishes a message\n when it detects events of the specified type.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "Queue" - } - }, - "Events": { - "target": "com.amazonaws.s3#EventList", - "traits": { - "smithy.api#documentation": "

A collection of bucket events for which to send notifications

", - "smithy.api#required": {}, - "smithy.api#xmlFlattened": {}, - "smithy.api#xmlName": "Event" - } - }, - "Filter": { - "target": "com.amazonaws.s3#NotificationConfigurationFilter" - } - }, - "traits": { - "smithy.api#documentation": "

Specifies the configuration for publishing messages to an Amazon Simple Queue Service\n (Amazon SQS) queue when Amazon S3 detects specified events.

" - } - }, - "com.amazonaws.s3#QueueConfigurationList": { - "type": "list", - "member": { - "target": "com.amazonaws.s3#QueueConfiguration" - } - }, - "com.amazonaws.s3#Quiet": { - "type": "boolean" - }, - "com.amazonaws.s3#QuoteCharacter": { - "type": "string" - }, - "com.amazonaws.s3#QuoteEscapeCharacter": { - "type": "string" - }, - "com.amazonaws.s3#QuoteFields": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ALWAYS", - "name": "ALWAYS" - }, - { - "value": "ASNEEDED", - "name": "ASNEEDED" - } - ] - } - }, - "com.amazonaws.s3#Range": { - "type": "string" - }, - "com.amazonaws.s3#RecordDelimiter": { - "type": "string" - }, - "com.amazonaws.s3#RecordsEvent": { - "type": "structure", - "members": { - "Payload": { - "target": "com.amazonaws.s3#Body", - "traits": { - "smithy.api#documentation": "

The byte array of partial, one or more result records.

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

The container for the records event.

" - } - }, - "com.amazonaws.s3#Redirect": { - "type": "structure", - "members": { - "HostName": { - "target": "com.amazonaws.s3#HostName", - "traits": { - "smithy.api#documentation": "

The host name to use in the redirect request.

" - } - }, - "HttpRedirectCode": { - "target": "com.amazonaws.s3#HttpRedirectCode", - "traits": { - "smithy.api#documentation": "

The HTTP redirect code to use on the response. Not required if one of the siblings is\n present.

" - } - }, - "Protocol": { - "target": "com.amazonaws.s3#Protocol", - "traits": { - "smithy.api#documentation": "

Protocol to use when redirecting requests. The default is the protocol that is used in\n the original request.

" - } - }, - "ReplaceKeyPrefixWith": { - "target": "com.amazonaws.s3#ReplaceKeyPrefixWith", - "traits": { - "smithy.api#documentation": "

The object key prefix to use in the redirect request. For example, to redirect requests\n for all pages with prefix docs/ (objects in the docs/ folder) to\n documents/, you can set a condition block with KeyPrefixEquals\n set to docs/ and in the Redirect set ReplaceKeyPrefixWith to\n /documents. Not required if one of the siblings is present. Can be present\n only if ReplaceKeyWith is not provided.

" - } - }, - "ReplaceKeyWith": { - "target": "com.amazonaws.s3#ReplaceKeyWith", - "traits": { - "smithy.api#documentation": "

The specific object key to use in the redirect request. For example, redirect request to\n error.html. Not required if one of the siblings is present. Can be present\n only if ReplaceKeyPrefixWith is not provided.

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

Specifies how requests are redirected. In the event of an error, you can specify a\n different error code to return.

" - } - }, - "com.amazonaws.s3#RedirectAllRequestsTo": { - "type": "structure", - "members": { - "HostName": { - "target": "com.amazonaws.s3#HostName", - "traits": { - "smithy.api#documentation": "

Name of the host where requests are redirected.

", - "smithy.api#required": {} - } - }, - "Protocol": { - "target": "com.amazonaws.s3#Protocol", - "traits": { - "smithy.api#documentation": "

Protocol to use when redirecting requests. The default is the protocol that is used in\n the original request.

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

Specifies the redirect behavior of all requests to a website endpoint of an Amazon S3\n bucket.

" - } - }, - "com.amazonaws.s3#ReplaceKeyPrefixWith": { - "type": "string" - }, - "com.amazonaws.s3#ReplaceKeyWith": { - "type": "string" - }, - "com.amazonaws.s3#ReplicaKmsKeyID": { - "type": "string" - }, - "com.amazonaws.s3#ReplicaModifications": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.s3#ReplicaModificationsStatus", - "traits": { - "smithy.api#documentation": "

Specifies whether Amazon S3 replicates modifications on replicas.

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

A filter that you can specify for selection for modifications on replicas. Amazon S3 doesn't\n replicate replica modifications by default. In the latest version of replication\n configuration (when Filter is specified), you can specify this element and set\n the status to Enabled to replicate modifications on replicas.

\n \n

If you don't specify the Filter element, Amazon S3 assumes that the\n replication configuration is the earlier version, V1. In the earlier version, this\n element is not allowed.

\n " - } - }, - "com.amazonaws.s3#ReplicaModificationsStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Enabled" - }, - { - "value": "Disabled" - } - ] - } - }, - "com.amazonaws.s3#ReplicationConfiguration": { - "type": "structure", - "members": { - "Role": { - "target": "com.amazonaws.s3#Role", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that\n Amazon S3 assumes when replicating objects. For more information, see How to Set Up\n Replication in the Amazon Simple Storage Service Developer Guide.

", - "smithy.api#required": {} - } - }, - "Rules": { - "target": "com.amazonaws.s3#ReplicationRules", - "traits": { - "smithy.api#documentation": "

A container for one or more replication rules. A replication configuration must have at\n least one rule and can contain a maximum of 1,000 rules.

", - "smithy.api#required": {}, - "smithy.api#xmlFlattened": {}, - "smithy.api#xmlName": "Rule" - } - } - }, - "traits": { - "smithy.api#documentation": "

A container for replication rules. You can add up to 1,000 rules. The maximum size of a\n replication configuration is 2 MB.

" - } - }, - "com.amazonaws.s3#ReplicationRule": { - "type": "structure", - "members": { - "ID": { - "target": "com.amazonaws.s3#ID", - "traits": { - "smithy.api#documentation": "

A unique identifier for the rule. The maximum value is 255 characters.

" - } - }, - "Priority": { - "target": "com.amazonaws.s3#Priority", - "traits": { - "smithy.api#documentation": "

The priority indicates which rule has precedence whenever two or more replication rules\n conflict. Amazon S3 will attempt to replicate objects according to all replication rules.\n However, if there are two or more rules with the same destination bucket, then objects will\n be replicated according to the rule with the highest priority. The higher the number, the\n higher the priority.

\n

For more information, see Replication in the\n Amazon Simple Storage Service Developer Guide.

" - } - }, - "Prefix": { - "target": "com.amazonaws.s3#Prefix", - "traits": { - "smithy.api#deprecated": {}, - "smithy.api#documentation": "

An object key name prefix that identifies the object or objects to which the rule\n applies. The maximum prefix length is 1,024 characters. To include all objects in a bucket,\n specify an empty string.

" - } - }, - "Filter": { - "target": "com.amazonaws.s3#ReplicationRuleFilter" - }, - "Status": { - "target": "com.amazonaws.s3#ReplicationRuleStatus", - "traits": { - "smithy.api#documentation": "

Specifies whether the rule is enabled.

", - "smithy.api#required": {} - } - }, - "SourceSelectionCriteria": { - "target": "com.amazonaws.s3#SourceSelectionCriteria", - "traits": { - "smithy.api#documentation": "

A container that describes additional filters for identifying the source objects that\n you want to replicate. You can choose to enable or disable the replication of these\n objects. Currently, Amazon S3 supports only the filter that you can specify for objects created\n with server-side encryption using a customer master key (CMK) stored in AWS Key Management\n Service (SSE-KMS).

" - } - }, - "ExistingObjectReplication": { - "target": "com.amazonaws.s3#ExistingObjectReplication", - "traits": { - "smithy.api#documentation": "

" - } - }, - "Destination": { - "target": "com.amazonaws.s3#Destination", - "traits": { - "smithy.api#documentation": "

A container for information about the replication destination and its configurations\n including enabling the S3 Replication Time Control (S3 RTC).

", - "smithy.api#required": {} - } - }, - "DeleteMarkerReplication": { - "target": "com.amazonaws.s3#DeleteMarkerReplication" - } - }, - "traits": { - "smithy.api#documentation": "

Specifies which Amazon S3 objects to replicate and where to store the replicas.

" - } - }, - "com.amazonaws.s3#ReplicationRuleAndOperator": { - "type": "structure", - "members": { - "Prefix": { - "target": "com.amazonaws.s3#Prefix", - "traits": { - "smithy.api#documentation": "

An object key name prefix that identifies the subset of objects to which the rule\n applies.

" - } - }, - "Tags": { - "target": "com.amazonaws.s3#TagSet", - "traits": { - "smithy.api#documentation": "

An array of tags containing key and value pairs.

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

A container for specifying rule filters. The filters determine the subset of objects to\n which the rule applies. This element is required only if you specify more than one filter.

\n

For example:

\n " - } - }, - "com.amazonaws.s3#ReplicationRuleFilter": { - "type": "union", - "members": { - "Prefix": { - "target": "com.amazonaws.s3#Prefix", - "traits": { - "smithy.api#documentation": "

An object key name prefix that identifies the subset of objects to which the rule\n applies.

" - } - }, - "Tag": { - "target": "com.amazonaws.s3#Tag", - "traits": { - "smithy.api#documentation": "

A container for specifying a tag key and value.

\n

The rule applies only to objects that have the tag in their tag set.

" - } - }, - "And": { - "target": "com.amazonaws.s3#ReplicationRuleAndOperator", - "traits": { - "smithy.api#documentation": "

A container for specifying rule filters. The filters determine the subset of objects to\n which the rule applies. This element is required only if you specify more than one filter.\n For example:

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

A filter that identifies the subset of objects to which the replication rule applies. A\n Filter must specify exactly one Prefix, Tag, or\n an And child element.

" - } - }, - "com.amazonaws.s3#ReplicationRuleStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Enabled" - }, - { - "value": "Disabled" - } - ] - } - }, - "com.amazonaws.s3#ReplicationRules": { - "type": "list", - "member": { - "target": "com.amazonaws.s3#ReplicationRule" - } - }, - "com.amazonaws.s3#ReplicationStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "COMPLETE" - }, - { - "value": "PENDING" - }, - { - "value": "FAILED" - }, - { - "value": "REPLICA" - } - ] - } - }, - "com.amazonaws.s3#ReplicationTime": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.s3#ReplicationTimeStatus", - "traits": { - "smithy.api#documentation": "

Specifies whether the replication time is enabled.

", - "smithy.api#required": {} - } - }, - "Time": { - "target": "com.amazonaws.s3#ReplicationTimeValue", - "traits": { - "smithy.api#documentation": "

A container specifying the time by which replication should be complete for all objects\n and operations on objects.

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

A container specifying S3 Replication Time Control (S3 RTC) related information, including whether S3 RTC is\n enabled and the time when all objects and operations on objects must be replicated. Must be\n specified together with a Metrics block.

" - } - }, - "com.amazonaws.s3#ReplicationTimeStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Enabled" - }, - { - "value": "Disabled" - } - ] - } - }, - "com.amazonaws.s3#ReplicationTimeValue": { - "type": "structure", - "members": { - "Minutes": { - "target": "com.amazonaws.s3#Minutes", - "traits": { - "smithy.api#documentation": "

Contains an integer specifying time in minutes.

\n

Valid values: 15 minutes.

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

A container specifying the time value for S3 Replication Time Control (S3 RTC) and replication metrics\n EventThreshold.

" - } - }, - "com.amazonaws.s3#RequestCharged": { - "type": "string", - "traits": { - "smithy.api#documentation": "

If present, indicates that the requester was successfully charged for the\n request.

", - "smithy.api#enum": [ - { - "value": "requester" - } - ] - } - }, - "com.amazonaws.s3#RequestPayer": { - "type": "string", - "traits": { - "smithy.api#documentation": "

Confirms that the requester knows that they will be charged for the request. Bucket\n owners need not specify this parameter in their requests. For information about downloading\n objects from requester pays buckets, see Downloading Objects in\n Requestor Pays Buckets in the Amazon S3 Developer Guide.

", - "smithy.api#enum": [ - { - "value": "requester" - } - ] - } - }, - "com.amazonaws.s3#RequestPaymentConfiguration": { - "type": "structure", - "members": { - "Payer": { - "target": "com.amazonaws.s3#Payer", - "traits": { - "smithy.api#documentation": "

Specifies who pays for the download and request fees.

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

Container for Payer.

" - } - }, - "com.amazonaws.s3#RequestProgress": { - "type": "structure", - "members": { - "Enabled": { - "target": "com.amazonaws.s3#EnableRequestProgress", - "traits": { - "smithy.api#documentation": "

Specifies whether periodic QueryProgress frames should be sent. Valid values: TRUE,\n FALSE. Default value: FALSE.

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

Container for specifying if periodic QueryProgress messages should be\n sent.

" - } - }, - "com.amazonaws.s3#ResponseCacheControl": { - "type": "string" - }, - "com.amazonaws.s3#ResponseContentDisposition": { - "type": "string" - }, - "com.amazonaws.s3#ResponseContentEncoding": { - "type": "string" - }, - "com.amazonaws.s3#ResponseContentLanguage": { - "type": "string" - }, - "com.amazonaws.s3#ResponseContentType": { - "type": "string" - }, - "com.amazonaws.s3#ResponseExpires": { - "type": "timestamp" - }, - "com.amazonaws.s3#Restore": { - "type": "string" - }, - "com.amazonaws.s3#RestoreObject": { - "type": "operation", - "input": { - "target": "com.amazonaws.s3#RestoreObjectRequest" - }, - "output": { - "target": "com.amazonaws.s3#RestoreObjectOutput" - }, - "errors": [ - { - "target": "com.amazonaws.s3#ObjectAlreadyInActiveTierError" - } - ], - "traits": { - "smithy.api#documentation": "

Restores an archived copy of an object back into Amazon S3

\n

This action is not supported by Amazon S3 on Outposts.

\n

This action performs the following types of requests:

\n \n

To use this operation, you must have permissions to perform the\n s3:RestoreObject action. The bucket owner has this permission by default\n and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources in the Amazon Simple Storage Service Developer Guide.

\n

\n Querying Archives with Select Requests\n

\n

You use a select type of request to perform SQL queries on archived objects. The\n archived objects that are being queried by the select request must be formatted as\n uncompressed comma-separated values (CSV) files. You can run queries and custom analytics\n on your archived data without having to restore your data to a hotter Amazon S3 tier. For an\n overview about select requests, see Querying Archived Objects in the Amazon Simple Storage Service Developer Guide.

\n

When making a select request, do the following:

\n \n

For more information about using SQL with S3 Glacier Select restore, see SQL Reference for Amazon S3 Select and\n S3 Glacier Select in the Amazon Simple Storage Service Developer Guide.

\n

When making a select request, you can also do the following:

\n \n

The following are additional important facts about the select feature:

\n \n

\n Restoring objects\n

\n

Objects that you archive to the S3 Glacier or\n S3 Glacier Deep Archive storage class, and S3 Intelligent-Tiering Archive or\n S3 Intelligent-Tiering Deep Archive tiers are not accessible in real time. For objects in\n Archive Access or Deep Archive Access tiers you must first initiate a restore request, and\n then wait until the object is moved into the Frequent Access tier. For objects in\n S3 Glacier or S3 Glacier Deep Archive storage classes you must\n first initiate a restore request, and then wait until a temporary copy of the object is\n available. To access an archived object, you must restore the object for the duration\n (number of days) that you specify.

\n

To restore a specific object version, you can provide a version ID. If you don't provide\n a version ID, Amazon S3 restores the current version.

\n

When restoring an archived object (or using a select request), you can specify one of\n the following data access tier options in the Tier element of the request\n body:

\n \n

For more information about archive retrieval options and provisioned capacity for\n Expedited data access, see Restoring Archived Objects in the Amazon Simple Storage Service Developer Guide.

\n

You can use Amazon S3 restore speed upgrade to change the restore speed to a faster speed\n while it is in progress. For more information, see \n Upgrading the speed of an in-progress restore in the\n Amazon Simple Storage Service Developer Guide.

\n

To get the status of object restoration, you can send a HEAD request.\n Operations return the x-amz-restore header, which provides information about\n the restoration status, in the response. You can use Amazon S3 event notifications to notify you\n when a restore is initiated or completed. For more information, see Configuring Amazon S3 Event Notifications in\n the Amazon Simple Storage Service Developer Guide.

\n

After restoring an archived object, you can update the restoration period by reissuing\n the request with a new period. Amazon S3 updates the restoration period relative to the current\n time and charges only for the request-there are no data transfer charges. You cannot\n update the restoration period when Amazon S3 is actively processing your current restore request\n for the object.

\n

If your bucket has a lifecycle configuration with a rule that includes an expiration\n action, the object expiration overrides the life span that you specify in a restore\n request. For example, if you restore an object copy for 10 days, but the object is\n scheduled to expire in 3 days, Amazon S3 deletes the object in 3 days. For more information\n about lifecycle configuration, see PutBucketLifecycleConfiguration and Object Lifecycle Management in\n Amazon Simple Storage Service Developer Guide.

\n

\n Responses\n

\n

A successful operation returns either the 200 OK or 202\n Accepted status code.

\n \n

\n Special Errors\n

\n \n \n

\n Related Resources\n

\n ", - "smithy.api#http": { - "method": "POST", - "uri": "/{Bucket}/{Key+}?restore", - "code": 200 - } - } - }, - "com.amazonaws.s3#RestoreObjectOutput": { - "type": "structure", - "members": { - "RequestCharged": { - "target": "com.amazonaws.s3#RequestCharged", - "traits": { - "smithy.api#httpHeader": "x-amz-request-charged" - } - }, - "RestoreOutputPath": { - "target": "com.amazonaws.s3#RestoreOutputPath", - "traits": { - "smithy.api#documentation": "

Indicates the path in the provided S3 output location where Select results will be\n restored to.

", - "smithy.api#httpHeader": "x-amz-restore-output-path" - } - } - } - }, - "com.amazonaws.s3#RestoreObjectRequest": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

The bucket name containing the object to restore.

\n

When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.

\n

When using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Key": { - "target": "com.amazonaws.s3#ObjectKey", - "traits": { - "smithy.api#documentation": "

Object key for which the operation was initiated.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "VersionId": { - "target": "com.amazonaws.s3#ObjectVersionId", - "traits": { - "smithy.api#documentation": "

VersionId used to reference a specific version of the object.

", - "smithy.api#httpQuery": "versionId" - } - }, - "RestoreRequest": { - "target": "com.amazonaws.s3#RestoreRequest", - "traits": { - "smithy.api#httpPayload": {} - } - }, - "RequestPayer": { - "target": "com.amazonaws.s3#RequestPayer", - "traits": { - "smithy.api#httpHeader": "x-amz-request-payer" - } - }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", - "smithy.api#httpHeader": "x-amz-expected-bucket-owner" - } - } - } - }, - "com.amazonaws.s3#RestoreOutputPath": { - "type": "string" - }, - "com.amazonaws.s3#RestoreRequest": { - "type": "structure", - "members": { - "Days": { - "target": "com.amazonaws.s3#Days", - "traits": { - "smithy.api#documentation": "

Lifetime of the active copy in days. Do not use with restores that specify\n OutputLocation.

\n

The Days element is required for regular restores, and must not be provided for select\n requests.

" - } - }, - "GlacierJobParameters": { - "target": "com.amazonaws.s3#GlacierJobParameters", - "traits": { - "smithy.api#documentation": "

S3 Glacier related parameters pertaining to this job. Do not use with restores that\n specify OutputLocation.

" - } - }, - "Type": { - "target": "com.amazonaws.s3#RestoreRequestType", - "traits": { - "smithy.api#documentation": "

Type of restore request.

" - } - }, - "Tier": { - "target": "com.amazonaws.s3#Tier", - "traits": { - "smithy.api#documentation": "

Retrieval tier at which the restore will be processed.

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

The optional description for the job.

" - } - }, - "SelectParameters": { - "target": "com.amazonaws.s3#SelectParameters", - "traits": { - "smithy.api#documentation": "

Describes the parameters for Select job types.

" - } - }, - "OutputLocation": { - "target": "com.amazonaws.s3#OutputLocation", - "traits": { - "smithy.api#documentation": "

Describes the location where the restore job's output is stored.

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

Container for restore job parameters.

" - } - }, - "com.amazonaws.s3#RestoreRequestType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "SELECT", - "name": "SELECT" - } - ] - } - }, - "com.amazonaws.s3#Role": { - "type": "string" - }, - "com.amazonaws.s3#RoutingRule": { - "type": "structure", - "members": { - "Condition": { - "target": "com.amazonaws.s3#Condition", - "traits": { - "smithy.api#documentation": "

A container for describing a condition that must be met for the specified redirect to\n apply. For example, 1. If request is for pages in the /docs folder, redirect\n to the /documents folder. 2. If request results in HTTP error 4xx, redirect\n request to another host where you might process the error.

" - } - }, - "Redirect": { - "target": "com.amazonaws.s3#Redirect", - "traits": { - "smithy.api#documentation": "

Container for redirect information. You can redirect requests to another host, to\n another page, or with another protocol. In the event of an error, you can specify a\n different error code to return.

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

Specifies the redirect behavior and when a redirect is applied. For more information\n about routing rules, see Configuring advanced conditional redirects in the\n Amazon Simple Storage Service Developer Guide.

" - } - }, - "com.amazonaws.s3#RoutingRules": { - "type": "list", - "member": { - "target": "com.amazonaws.s3#RoutingRule", - "traits": { - "smithy.api#xmlName": "RoutingRule" - } - } - }, - "com.amazonaws.s3#S3KeyFilter": { - "type": "structure", - "members": { - "FilterRules": { - "target": "com.amazonaws.s3#FilterRuleList", - "traits": { - "smithy.api#xmlFlattened": {}, - "smithy.api#xmlName": "FilterRule" - } - } - }, - "traits": { - "smithy.api#documentation": "

A container for object key name prefix and suffix filtering rules.

" - } - }, - "com.amazonaws.s3#S3Location": { - "type": "structure", - "members": { - "BucketName": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

The name of the bucket where the restore results will be placed.

", - "smithy.api#required": {} - } - }, - "Prefix": { - "target": "com.amazonaws.s3#LocationPrefix", - "traits": { - "smithy.api#documentation": "

The prefix that is prepended to the restore results for this request.

", - "smithy.api#required": {} - } - }, - "Encryption": { - "target": "com.amazonaws.s3#Encryption" - }, - "CannedACL": { - "target": "com.amazonaws.s3#ObjectCannedACL", - "traits": { - "smithy.api#documentation": "

The canned ACL to apply to the restore results.

" - } - }, - "AccessControlList": { - "target": "com.amazonaws.s3#Grants", - "traits": { - "smithy.api#documentation": "

A list of grants that control access to the staged results.

" - } - }, - "Tagging": { - "target": "com.amazonaws.s3#Tagging", - "traits": { - "smithy.api#documentation": "

The tag-set that is applied to the restore results.

" - } - }, - "UserMetadata": { - "target": "com.amazonaws.s3#UserMetadata", - "traits": { - "smithy.api#documentation": "

A list of metadata to store with the restore results in S3.

" - } - }, - "StorageClass": { - "target": "com.amazonaws.s3#StorageClass", - "traits": { - "smithy.api#documentation": "

The class of storage used to store the restore results.

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

Describes an Amazon S3 location that will receive the results of the restore request.

" - } - }, - "com.amazonaws.s3#SSECustomerAlgorithm": { - "type": "string" - }, - "com.amazonaws.s3#SSECustomerKey": { - "type": "string", - "traits": { - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.s3#SSECustomerKeyMD5": { - "type": "string" - }, - "com.amazonaws.s3#SSEKMS": { - "type": "structure", - "members": { - "KeyId": { - "target": "com.amazonaws.s3#SSEKMSKeyId", - "traits": { - "smithy.api#documentation": "

Specifies the ID of the AWS Key Management Service (AWS KMS) symmetric customer managed\n customer master key (CMK) to use for encrypting inventory reports.

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

Specifies the use of SSE-KMS to encrypt delivered inventory reports.

", - "smithy.api#xmlName": "SSE-KMS" - } - }, - "com.amazonaws.s3#SSEKMSEncryptionContext": { - "type": "string", - "traits": { - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.s3#SSEKMSKeyId": { - "type": "string", - "traits": { - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.s3#SSES3": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "

Specifies the use of SSE-S3 to encrypt delivered inventory reports.

", - "smithy.api#xmlName": "SSE-S3" - } - }, - "com.amazonaws.s3#ScanRange": { - "type": "structure", - "members": { - "Start": { - "target": "com.amazonaws.s3#Start", - "traits": { - "smithy.api#documentation": "

Specifies the start of the byte range. This parameter is optional. Valid values:\n non-negative integers. The default value is 0. If only start is supplied, it means scan\n from that point to the end of the file.For example;\n 50 means scan\n from byte 50 until the end of the file.

" - } - }, - "End": { - "target": "com.amazonaws.s3#End", - "traits": { - "smithy.api#documentation": "

Specifies the end of the byte range. This parameter is optional. Valid values:\n non-negative integers. The default value is one less than the size of the object being\n queried. If only the End parameter is supplied, it is interpreted to mean scan the last N\n bytes of the file. For example,\n 50 means scan the\n last 50 bytes.

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

Specifies the byte range of the object to get the records from. A record is processed\n when its first byte is contained by the range. This parameter is optional, but when\n specified, it must not be empty. See RFC 2616, Section 14.35.1 about how to specify the\n start and end of the range.

" - } - }, - "com.amazonaws.s3#SelectObjectContent": { - "type": "operation", - "input": { - "target": "com.amazonaws.s3#SelectObjectContentRequest" - }, - "output": { - "target": "com.amazonaws.s3#SelectObjectContentOutput" - }, - "traits": { - "smithy.api#documentation": "

This operation filters the contents of an Amazon S3 object based on a simple structured query\n language (SQL) statement. In the request, along with the SQL expression, you must also\n specify a data serialization format (JSON, CSV, or Apache Parquet) of the object. Amazon S3 uses\n this format to parse object data into records, and returns only records that match the\n specified SQL expression. You must also specify the data serialization format for the\n response.

\n

This action is not supported by Amazon S3 on Outposts.

\n

For more information about Amazon S3 Select,\n see Selecting Content from\n Objects in the Amazon Simple Storage Service Developer Guide.

\n

For more information about using SQL with Amazon S3 Select, see SQL Reference for Amazon S3 Select\n and S3 Glacier Select in the Amazon Simple Storage Service Developer Guide.

\n

\n

\n Permissions\n

\n

You must have s3:GetObject permission for this operation. Amazon S3 Select does\n not support anonymous access. For more information about permissions, see Specifying Permissions in a Policy\n in the Amazon Simple Storage Service Developer Guide.

\n

\n

\n Object Data Formats\n

\n

You can use Amazon S3 Select to query objects that have the following format\n properties:

\n \n\n

\n Working with the Response Body\n

\n

Given the response size is unknown, Amazon S3 Select streams the response as a series of\n messages and includes a Transfer-Encoding header with chunked as\n its value in the response. For more information, see Appendix: SelectObjectContent\n Response\n .

\n\n

\n

\n GetObject Support\n

\n

The SelectObjectContent operation does not support the following\n GetObject functionality. For more information, see GetObject.

\n \n

\n

\n Special Errors\n

\n\n

For a list of special errors for this operation, see List of\n SELECT Object Content Error Codes\n

\n

\n Related Resources\n

\n ", - "smithy.api#http": { - "method": "POST", - "uri": "/{Bucket}/{Key+}?select&select-type=2", - "code": 200 - } - } - }, - "com.amazonaws.s3#SelectObjectContentEventStream": { - "type": "union", - "members": { - "Records": { - "target": "com.amazonaws.s3#RecordsEvent", - "traits": { - "smithy.api#documentation": "

The Records Event.

" - } - }, - "Stats": { - "target": "com.amazonaws.s3#StatsEvent", - "traits": { - "smithy.api#documentation": "

The Stats Event.

" - } - }, - "Progress": { - "target": "com.amazonaws.s3#ProgressEvent", - "traits": { - "smithy.api#documentation": "

The Progress Event.

" - } - }, - "Cont": { - "target": "com.amazonaws.s3#ContinuationEvent", - "traits": { - "smithy.api#documentation": "

The Continuation Event.

" - } - }, - "End": { - "target": "com.amazonaws.s3#EndEvent", - "traits": { - "smithy.api#documentation": "

The End Event.

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

The container for selecting objects from a content event stream.

", - "smithy.api#streaming": {} - } - }, - "com.amazonaws.s3#SelectObjectContentOutput": { - "type": "structure", - "members": { - "Payload": { - "target": "com.amazonaws.s3#SelectObjectContentEventStream", - "traits": { - "smithy.api#documentation": "

The array of results.

", - "smithy.api#httpPayload": {} - } - } - } - }, - "com.amazonaws.s3#SelectObjectContentRequest": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

The S3 bucket.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Key": { - "target": "com.amazonaws.s3#ObjectKey", - "traits": { - "smithy.api#documentation": "

The object key.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "SSECustomerAlgorithm": { - "target": "com.amazonaws.s3#SSECustomerAlgorithm", - "traits": { - "smithy.api#documentation": "

The SSE Algorithm used to encrypt the object. For more information, see Server-Side Encryption (Using Customer-Provided Encryption Keys.

", - "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-algorithm" - } - }, - "SSECustomerKey": { - "target": "com.amazonaws.s3#SSECustomerKey", - "traits": { - "smithy.api#documentation": "

The SSE Customer Key. For more information, see Server-Side Encryption\n (Using Customer-Provided Encryption Keys.

", - "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key" - } - }, - "SSECustomerKeyMD5": { - "target": "com.amazonaws.s3#SSECustomerKeyMD5", - "traits": { - "smithy.api#documentation": "

The SSE Customer Key MD5. For more information, see Server-Side Encryption\n (Using Customer-Provided Encryption Keys.

", - "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key-MD5" - } - }, - "Expression": { - "target": "com.amazonaws.s3#Expression", - "traits": { - "smithy.api#documentation": "

The expression that is used to query the object.

", - "smithy.api#required": {} - } - }, - "ExpressionType": { - "target": "com.amazonaws.s3#ExpressionType", - "traits": { - "smithy.api#documentation": "

The type of the provided expression (for example, SQL).

", - "smithy.api#required": {} - } - }, - "RequestProgress": { - "target": "com.amazonaws.s3#RequestProgress", - "traits": { - "smithy.api#documentation": "

Specifies if periodic request progress information should be enabled.

" - } - }, - "InputSerialization": { - "target": "com.amazonaws.s3#InputSerialization", - "traits": { - "smithy.api#documentation": "

Describes the format of the data in the object that is being queried.

", - "smithy.api#required": {} - } - }, - "OutputSerialization": { - "target": "com.amazonaws.s3#OutputSerialization", - "traits": { - "smithy.api#documentation": "

Describes the format of the data that you want Amazon S3 to return in response.

", - "smithy.api#required": {} - } - }, - "ScanRange": { - "target": "com.amazonaws.s3#ScanRange", - "traits": { - "smithy.api#documentation": "

Specifies the byte range of the object to get the records from. A record is processed\n when its first byte is contained by the range. This parameter is optional, but when\n specified, it must not be empty. See RFC 2616, Section 14.35.1 about how to specify the\n start and end of the range.

\n

\n ScanRangemay be used in the following ways:

\n " - } - }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", - "smithy.api#httpHeader": "x-amz-expected-bucket-owner" - } - } - }, - "traits": { - "smithy.api#documentation": "

Request to filter the contents of an Amazon S3 object based on a simple Structured Query\n Language (SQL) statement. In the request, along with the SQL expression, you must specify a\n data serialization format (JSON or CSV) of the object. Amazon S3 uses this to parse object data\n into records. It returns only records that match the specified SQL expression. You must\n also specify the data serialization format for the response. For more information, see\n S3Select API Documentation.

" - } - }, - "com.amazonaws.s3#SelectParameters": { - "type": "structure", - "members": { - "InputSerialization": { - "target": "com.amazonaws.s3#InputSerialization", - "traits": { - "smithy.api#documentation": "

Describes the serialization format of the object.

", - "smithy.api#required": {} - } - }, - "ExpressionType": { - "target": "com.amazonaws.s3#ExpressionType", - "traits": { - "smithy.api#documentation": "

The type of the provided expression (for example, SQL).

", - "smithy.api#required": {} - } - }, - "Expression": { - "target": "com.amazonaws.s3#Expression", - "traits": { - "smithy.api#documentation": "

The expression that is used to query the object.

", - "smithy.api#required": {} - } - }, - "OutputSerialization": { - "target": "com.amazonaws.s3#OutputSerialization", - "traits": { - "smithy.api#documentation": "

Describes how the results of the Select job are serialized.

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

Describes the parameters for Select job types.

" - } - }, - "com.amazonaws.s3#ServerSideEncryption": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "AES256" - }, - { - "value": "aws:kms" - } - ] - } - }, - "com.amazonaws.s3#ServerSideEncryptionByDefault": { - "type": "structure", - "members": { - "SSEAlgorithm": { - "target": "com.amazonaws.s3#ServerSideEncryption", - "traits": { - "smithy.api#documentation": "

Server-side encryption algorithm to use for the default encryption.

", - "smithy.api#required": {} - } - }, - "KMSMasterKeyID": { - "target": "com.amazonaws.s3#SSEKMSKeyId", - "traits": { - "smithy.api#documentation": "

AWS Key Management Service (KMS) customer master key ID to use for the default\n encryption. This parameter is allowed if and only if SSEAlgorithm is set to\n aws:kms.

\n

You can specify the key ID or the Amazon Resource Name (ARN) of the CMK. However, if you\n are using encryption with cross-account operations, you must use a fully qualified CMK ARN.\n For more information, see Using encryption for cross-account operations.

\n

\n For example:\n

\n \n \n

Amazon S3 only supports symmetric CMKs and not asymmetric CMKs. For more information, see\n Using Symmetric and\n Asymmetric Keys in the AWS Key Management Service Developer\n Guide.

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

Describes the default server-side encryption to apply to new objects in the bucket. If a\n PUT Object request doesn't specify any server-side encryption, this default encryption will\n be applied. For more information, see PUT Bucket encryption in\n the Amazon Simple Storage Service API Reference.

" - } - }, - "com.amazonaws.s3#ServerSideEncryptionConfiguration": { - "type": "structure", - "members": { - "Rules": { - "target": "com.amazonaws.s3#ServerSideEncryptionRules", - "traits": { - "smithy.api#documentation": "

Container for information about a particular server-side encryption configuration\n rule.

", - "smithy.api#required": {}, - "smithy.api#xmlFlattened": {}, - "smithy.api#xmlName": "Rule" - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies the default server-side-encryption configuration.

" - } - }, - "com.amazonaws.s3#ServerSideEncryptionRule": { - "type": "structure", - "members": { - "ApplyServerSideEncryptionByDefault": { - "target": "com.amazonaws.s3#ServerSideEncryptionByDefault", - "traits": { - "smithy.api#documentation": "

Specifies the default server-side encryption to apply to new objects in the bucket. If a\n PUT Object request doesn't specify any server-side encryption, this default encryption will\n be applied.

" - } - }, - "BucketKeyEnabled": { - "target": "com.amazonaws.s3#BucketKeyEnabled", - "traits": { - "smithy.api#documentation": "

Specifies whether Amazon S3 should use an S3 Bucket Key with server-side encryption using KMS (SSE-KMS) for new objects in the bucket. Existing objects are not affected. Setting the BucketKeyEnabled element to true causes Amazon S3 to use an S3 Bucket Key. By default, S3 Bucket Key is not enabled.

\n

For more information, see Amazon S3 Bucket Keys in the Amazon Simple Storage Service Developer Guide.

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

Specifies the default server-side encryption configuration.

" - } - }, - "com.amazonaws.s3#ServerSideEncryptionRules": { - "type": "list", - "member": { - "target": "com.amazonaws.s3#ServerSideEncryptionRule" - } - }, - "com.amazonaws.s3#Setting": { - "type": "boolean" - }, - "com.amazonaws.s3#Size": { - "type": "integer" - }, - "com.amazonaws.s3#SourceSelectionCriteria": { - "type": "structure", - "members": { - "SseKmsEncryptedObjects": { - "target": "com.amazonaws.s3#SseKmsEncryptedObjects", - "traits": { - "smithy.api#documentation": "

A container for filter information for the selection of Amazon S3 objects encrypted with AWS\n KMS. If you include SourceSelectionCriteria in the replication configuration,\n this element is required.

" - } - }, - "ReplicaModifications": { - "target": "com.amazonaws.s3#ReplicaModifications", - "traits": { - "smithy.api#documentation": "

A filter that you can specify for selections for modifications on replicas. Amazon S3 doesn't\n replicate replica modifications by default. In the latest version of replication\n configuration (when Filter is specified), you can specify this element and set\n the status to Enabled to replicate modifications on replicas.

\n \n

If you don't specify the Filter element, Amazon S3 assumes that the\n replication configuration is the earlier version, V1. In the earlier version, this\n element is not allowed

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

A container that describes additional filters for identifying the source objects that\n you want to replicate. You can choose to enable or disable the replication of these\n objects. Currently, Amazon S3 supports only the filter that you can specify for objects created\n with server-side encryption using a customer master key (CMK) stored in AWS Key Management\n Service (SSE-KMS).

" - } - }, - "com.amazonaws.s3#SseKmsEncryptedObjects": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.s3#SseKmsEncryptedObjectsStatus", - "traits": { - "smithy.api#documentation": "

Specifies whether Amazon S3 replicates objects created with server-side encryption using a\n customer master key (CMK) stored in AWS Key Management Service.

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

A container for filter information for the selection of S3 objects encrypted with AWS\n KMS.

" - } - }, - "com.amazonaws.s3#SseKmsEncryptedObjectsStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Enabled" - }, - { - "value": "Disabled" - } - ] - } - }, - "com.amazonaws.s3#Start": { - "type": "long" - }, - "com.amazonaws.s3#StartAfter": { - "type": "string" - }, - "com.amazonaws.s3#Stats": { - "type": "structure", - "members": { - "BytesScanned": { - "target": "com.amazonaws.s3#BytesScanned", - "traits": { - "smithy.api#documentation": "

The total number of object bytes scanned.

" - } - }, - "BytesProcessed": { - "target": "com.amazonaws.s3#BytesProcessed", - "traits": { - "smithy.api#documentation": "

The total number of uncompressed object bytes processed.

" - } - }, - "BytesReturned": { - "target": "com.amazonaws.s3#BytesReturned", - "traits": { - "smithy.api#documentation": "

The total number of bytes of records payload data returned.

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

Container for the stats details.

" - } - }, - "com.amazonaws.s3#StatsEvent": { - "type": "structure", - "members": { - "Details": { - "target": "com.amazonaws.s3#Stats", - "traits": { - "smithy.api#documentation": "

The Stats event details.

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

Container for the Stats Event.

" - } - }, - "com.amazonaws.s3#StorageClass": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "STANDARD" - }, - { - "value": "REDUCED_REDUNDANCY" - }, - { - "value": "STANDARD_IA" - }, - { - "value": "ONEZONE_IA" - }, - { - "value": "INTELLIGENT_TIERING" - }, - { - "value": "GLACIER" - }, - { - "value": "DEEP_ARCHIVE" - }, - { - "value": "OUTPOSTS" - } - ] - } - }, - "com.amazonaws.s3#StorageClassAnalysis": { - "type": "structure", - "members": { - "DataExport": { - "target": "com.amazonaws.s3#StorageClassAnalysisDataExport", - "traits": { - "smithy.api#documentation": "

Specifies how data related to the storage class analysis for an Amazon S3 bucket should be\n exported.

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

Specifies data related to access patterns to be collected and made available to analyze\n the tradeoffs between different storage classes for an Amazon S3 bucket.

" - } - }, - "com.amazonaws.s3#StorageClassAnalysisDataExport": { - "type": "structure", - "members": { - "OutputSchemaVersion": { - "target": "com.amazonaws.s3#StorageClassAnalysisSchemaVersion", - "traits": { - "smithy.api#documentation": "

The version of the output schema to use when exporting data. Must be\n V_1.

", - "smithy.api#required": {} - } - }, - "Destination": { - "target": "com.amazonaws.s3#AnalyticsExportDestination", - "traits": { - "smithy.api#documentation": "

The place to store the data for an analysis.

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

Container for data related to the storage class analysis for an Amazon S3 bucket for\n export.

" - } - }, - "com.amazonaws.s3#StorageClassAnalysisSchemaVersion": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "V_1" - } - ] - } - }, - "com.amazonaws.s3#StreamingBlob": { - "type": "blob", - "traits": { - "smithy.api#streaming": {} - } - }, - "com.amazonaws.s3#Suffix": { - "type": "string" - }, - "com.amazonaws.s3#Tag": { - "type": "structure", - "members": { - "Key": { - "target": "com.amazonaws.s3#ObjectKey", - "traits": { - "smithy.api#documentation": "

Name of the object key.

", - "smithy.api#required": {} - } - }, - "Value": { - "target": "com.amazonaws.s3#Value", - "traits": { - "smithy.api#documentation": "

Value of the tag.

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

A container of a key value name pair.

" - } - }, - "com.amazonaws.s3#TagCount": { - "type": "integer" - }, - "com.amazonaws.s3#TagSet": { - "type": "list", - "member": { - "target": "com.amazonaws.s3#Tag", - "traits": { - "smithy.api#xmlName": "Tag" - } - } - }, - "com.amazonaws.s3#Tagging": { - "type": "structure", - "members": { - "TagSet": { - "target": "com.amazonaws.s3#TagSet", - "traits": { - "smithy.api#documentation": "

A collection for a set of tags

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

Container for TagSet elements.

" - } - }, - "com.amazonaws.s3#TaggingDirective": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "COPY" - }, - { - "value": "REPLACE" - } - ] - } - }, - "com.amazonaws.s3#TaggingHeader": { - "type": "string" - }, - "com.amazonaws.s3#TargetBucket": { - "type": "string" - }, - "com.amazonaws.s3#TargetGrant": { - "type": "structure", - "members": { - "Grantee": { - "target": "com.amazonaws.s3#Grantee", - "traits": { - "smithy.api#documentation": "

Container for the person being granted permissions.

" - } - }, - "Permission": { - "target": "com.amazonaws.s3#BucketLogsPermission", - "traits": { - "smithy.api#documentation": "

Logging permissions assigned to the grantee for the bucket.

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

Container for granting information.

" - } - }, - "com.amazonaws.s3#TargetGrants": { - "type": "list", - "member": { - "target": "com.amazonaws.s3#TargetGrant", - "traits": { - "smithy.api#xmlName": "Grant" - } - } - }, - "com.amazonaws.s3#TargetPrefix": { - "type": "string" - }, - "com.amazonaws.s3#Tier": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Standard" - }, - { - "value": "Bulk" - }, - { - "value": "Expedited" - } - ] - } - }, - "com.amazonaws.s3#Tiering": { - "type": "structure", - "members": { - "Days": { - "target": "com.amazonaws.s3#IntelligentTieringDays", - "traits": { - "smithy.api#documentation": "

The number of consecutive days of no access after which an object will be eligible to be\n transitioned to the corresponding tier. The minimum number of days specified for\n Archive Access tier must be at least 90 days and Deep Archive Access tier must be at least\n 180 days. The maximum can be up to 2 years (730 days).

", - "smithy.api#required": {} - } - }, - "AccessTier": { - "target": "com.amazonaws.s3#IntelligentTieringAccessTier", - "traits": { - "smithy.api#documentation": "

S3 Intelligent-Tiering access tier. See Storage class for\n automatically optimizing frequently and infrequently accessed objects for a list\n of access tiers in the S3 Intelligent-Tiering storage class.

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

The S3 Intelligent-Tiering storage class is designed to optimize storage costs by\n automatically moving data to the most cost-effective storage access tier, without\n additional operational overhead.

" - } - }, - "com.amazonaws.s3#TieringList": { - "type": "list", - "member": { - "target": "com.amazonaws.s3#Tiering" - } - }, - "com.amazonaws.s3#Token": { - "type": "string" - }, - "com.amazonaws.s3#TopicArn": { - "type": "string" - }, - "com.amazonaws.s3#TopicConfiguration": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.s3#NotificationId" - }, - "TopicArn": { - "target": "com.amazonaws.s3#TopicArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon SNS topic to which Amazon S3 publishes a message\n when it detects events of the specified type.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "Topic" - } - }, - "Events": { - "target": "com.amazonaws.s3#EventList", - "traits": { - "smithy.api#documentation": "

The Amazon S3 bucket event about which to send notifications. For more information, see\n Supported\n Event Types in the Amazon Simple Storage Service Developer Guide.

", - "smithy.api#required": {}, - "smithy.api#xmlFlattened": {}, - "smithy.api#xmlName": "Event" - } - }, - "Filter": { - "target": "com.amazonaws.s3#NotificationConfigurationFilter" - } - }, - "traits": { - "smithy.api#documentation": "

A container for specifying the configuration for publication of messages to an Amazon\n Simple Notification Service (Amazon SNS) topic when Amazon S3 detects specified events.

" - } - }, - "com.amazonaws.s3#TopicConfigurationList": { - "type": "list", - "member": { - "target": "com.amazonaws.s3#TopicConfiguration" - } - }, - "com.amazonaws.s3#Transition": { - "type": "structure", - "members": { - "Date": { - "target": "com.amazonaws.s3#Date", - "traits": { - "smithy.api#documentation": "

Indicates when objects are transitioned to the specified storage class. The date value\n must be in ISO 8601 format. The time is always midnight UTC.

" - } - }, - "Days": { - "target": "com.amazonaws.s3#Days", - "traits": { - "smithy.api#documentation": "

Indicates the number of days after creation when objects are transitioned to the\n specified storage class. The value must be a positive integer.

" - } - }, - "StorageClass": { - "target": "com.amazonaws.s3#TransitionStorageClass", - "traits": { - "smithy.api#documentation": "

The storage class to which you want the object to transition.

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

Specifies when an object transitions to a specified storage class. For more information\n about Amazon S3 lifecycle configuration rules, see Transitioning\n Objects Using Amazon S3 Lifecycle in the Amazon Simple Storage Service Developer Guide.

" - } - }, - "com.amazonaws.s3#TransitionList": { - "type": "list", - "member": { - "target": "com.amazonaws.s3#Transition" - } - }, - "com.amazonaws.s3#TransitionStorageClass": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "GLACIER" - }, - { - "value": "STANDARD_IA" - }, - { - "value": "ONEZONE_IA" - }, - { - "value": "INTELLIGENT_TIERING" - }, - { - "value": "DEEP_ARCHIVE" - } - ] - } - }, - "com.amazonaws.s3#Type": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CanonicalUser" - }, - { - "value": "AmazonCustomerByEmail" - }, - { - "value": "Group" - } - ] - } - }, - "com.amazonaws.s3#URI": { - "type": "string" - }, - "com.amazonaws.s3#UploadIdMarker": { - "type": "string" - }, - "com.amazonaws.s3#UploadPart": { - "type": "operation", - "input": { - "target": "com.amazonaws.s3#UploadPartRequest" - }, - "output": { - "target": "com.amazonaws.s3#UploadPartOutput" - }, - "traits": { - "smithy.api#documentation": "

Uploads a part in a multipart upload.

\n \n

In this operation, you provide part data in your request. However, you have an option\n to specify your existing Amazon S3 object as a data source for the part you are uploading. To\n upload a part from an existing object, you use the UploadPartCopy operation.\n

\n \n\n

You must initiate a multipart upload (see CreateMultipartUpload)\n before you can upload any part. In response to your initiate request, Amazon S3 returns an\n upload ID, a unique identifier, that you must include in your upload part request.

\n

Part numbers can be any number from 1 to 10,000, inclusive. A part number uniquely\n identifies a part and also defines its position within the object being created. If you\n upload a new part using the same part number that was used with a previous part, the\n previously uploaded part is overwritten. Each part must be at least 5 MB in size, except\n the last part. There is no size limit on the last part of your multipart upload.

\n

To ensure that data is not corrupted when traversing the network, specify the\n Content-MD5 header in the upload part request. Amazon S3 checks the part data\n against the provided MD5 value. If they do not match, Amazon S3 returns an error.

\n\n

If the upload request is signed with Signature Version 4, then AWS S3 uses the\n x-amz-content-sha256 header as a checksum instead of\n Content-MD5. For more information see Authenticating Requests: Using the Authorization Header (AWS Signature Version\n 4).

\n\n\n\n

\n Note: After you initiate multipart upload and upload\n one or more parts, you must either complete or abort multipart upload in order to stop\n getting charged for storage of the uploaded parts. Only after you either complete or abort\n multipart upload, Amazon S3 frees up the parts storage and stops charging you for the parts\n storage.

\n\n

For more information on multipart uploads, go to Multipart Upload Overview in the\n Amazon Simple Storage Service Developer Guide .

\n

For information on the permissions required to use the multipart upload API, go to\n Multipart Upload API and\n Permissions in the Amazon Simple Storage Service Developer Guide.

\n\n

You can optionally request server-side encryption where Amazon S3 encrypts your data as it\n writes it to disks in its data centers and decrypts it for you when you access it. You have\n the option of providing your own encryption key, or you can use the AWS managed encryption\n keys. If you choose to provide your own encryption key, the request headers you provide in\n the request must match the headers you used in the request to initiate the upload by using\n CreateMultipartUpload. For more information, go to Using Server-Side Encryption in\n the Amazon Simple Storage Service Developer Guide.

\n\n

Server-side encryption is supported by the S3 Multipart Upload actions. Unless you are\n using a customer-provided encryption key, you don't need to specify the encryption\n parameters in each UploadPart request. Instead, you only need to specify the server-side\n encryption parameters in the initial Initiate Multipart request. For more information, see\n CreateMultipartUpload.

\n\n

If you requested server-side encryption using a customer-provided encryption key in your\n initiate multipart upload request, you must provide identical encryption information in\n each part upload using the following headers.

\n\n\n \n\n

\n Special Errors\n

\n \n\n \n\n\n\n\n

\n Related Resources\n

\n ", - "smithy.api#http": { - "method": "PUT", - "uri": "/{Bucket}/{Key+}?x-id=UploadPart", - "code": 200 - } - } - }, - "com.amazonaws.s3#UploadPartCopy": { - "type": "operation", - "input": { - "target": "com.amazonaws.s3#UploadPartCopyRequest" - }, - "output": { - "target": "com.amazonaws.s3#UploadPartCopyOutput" - }, - "traits": { - "smithy.api#documentation": "

Uploads a part by copying data from an existing object as data source. You specify the\n data source by adding the request header x-amz-copy-source in your request and\n a byte range by adding the request header x-amz-copy-source-range in your\n request.

\n

The minimum allowable part size for a multipart upload is 5 MB. For more information\n about multipart upload limits, go to Quick\n Facts in the Amazon Simple Storage Service Developer Guide.

\n \n

Instead of using an existing object as part data, you might use the UploadPart\n operation and provide data in your request.

\n \n\n

You must initiate a multipart upload before you can upload any part. In response to your\n initiate request. Amazon S3 returns a unique identifier, the upload ID, that you must include in\n your upload part request.

\n

For more information about using the UploadPartCopy operation, see the\n following:

\n\n \n

Note the following additional considerations about the request headers\n x-amz-copy-source-if-match, x-amz-copy-source-if-none-match,\n x-amz-copy-source-if-unmodified-since, and\n x-amz-copy-source-if-modified-since:

\n

\n \n

\n Versioning\n

\n

If your bucket has versioning enabled, you could have multiple versions of the same\n object. By default, x-amz-copy-source identifies the current version of the\n object to copy. If the current version is a delete marker and you don't specify a versionId\n in the x-amz-copy-source, Amazon S3 returns a 404 error, because the object does\n not exist. If you specify versionId in the x-amz-copy-source and the versionId\n is a delete marker, Amazon S3 returns an HTTP 400 error, because you are not allowed to specify\n a delete marker as a version for the x-amz-copy-source.

\n

You can optionally specify a specific version of the source object to copy by adding the\n versionId subresource as shown in the following example:

\n

\n x-amz-copy-source: /bucket/object?versionId=version id\n

\n\n

\n Special Errors\n

\n \n\n \n\n\n\n\n

\n Related Resources\n

\n ", - "smithy.api#http": { - "method": "PUT", - "uri": "/{Bucket}/{Key+}?x-id=UploadPartCopy", - "code": 200 - } - } - }, - "com.amazonaws.s3#UploadPartCopyOutput": { - "type": "structure", - "members": { - "CopySourceVersionId": { - "target": "com.amazonaws.s3#CopySourceVersionId", - "traits": { - "smithy.api#documentation": "

The version of the source object that was copied, if you have enabled versioning on the\n source bucket.

", - "smithy.api#httpHeader": "x-amz-copy-source-version-id" - } - }, - "CopyPartResult": { - "target": "com.amazonaws.s3#CopyPartResult", - "traits": { - "smithy.api#documentation": "

Container for all response elements.

", - "smithy.api#httpPayload": {} - } - }, - "ServerSideEncryption": { - "target": "com.amazonaws.s3#ServerSideEncryption", - "traits": { - "smithy.api#documentation": "

The server-side encryption algorithm used when storing this object in Amazon S3 (for example,\n AES256, aws:kms).

", - "smithy.api#httpHeader": "x-amz-server-side-encryption" - } - }, - "SSECustomerAlgorithm": { - "target": "com.amazonaws.s3#SSECustomerAlgorithm", - "traits": { - "smithy.api#documentation": "

If server-side encryption with a customer-provided encryption key was requested, the\n response will include this header confirming the encryption algorithm used.

", - "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-algorithm" - } - }, - "SSECustomerKeyMD5": { - "target": "com.amazonaws.s3#SSECustomerKeyMD5", - "traits": { - "smithy.api#documentation": "

If server-side encryption with a customer-provided encryption key was requested, the\n response will include this header to provide round-trip message integrity verification of\n the customer-provided encryption key.

", - "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key-MD5" - } - }, - "SSEKMSKeyId": { - "target": "com.amazonaws.s3#SSEKMSKeyId", - "traits": { - "smithy.api#documentation": "

If present, specifies the ID of the AWS Key Management Service (AWS KMS) symmetric\n customer managed customer master key (CMK) that was used for the object.

", - "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" - } - }, - "BucketKeyEnabled": { - "target": "com.amazonaws.s3#BucketKeyEnabled", - "traits": { - "smithy.api#documentation": "

Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with AWS KMS (SSE-KMS).

", - "smithy.api#httpHeader": "x-amz-server-side-encryption-bucket-key-enabled" - } - }, - "RequestCharged": { - "target": "com.amazonaws.s3#RequestCharged", - "traits": { - "smithy.api#httpHeader": "x-amz-request-charged" - } - } - } - }, - "com.amazonaws.s3#UploadPartCopyRequest": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

The bucket name.

\n

When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.

\n

When using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "CopySource": { - "target": "com.amazonaws.s3#CopySource", - "traits": { - "smithy.api#documentation": "

Specifies the source object for the copy operation. You specify the value in one of two\n formats, depending on whether you want to access the source object through an access\n point:

\n \n

To copy a specific version of an object, append ?versionId=\n to the value (for example,\n awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893).\n If you don't specify a version ID, Amazon S3 copies the latest version of the source\n object.

", - "smithy.api#httpHeader": "x-amz-copy-source", - "smithy.api#required": {} - } - }, - "CopySourceIfMatch": { - "target": "com.amazonaws.s3#CopySourceIfMatch", - "traits": { - "smithy.api#documentation": "

Copies the object if its entity tag (ETag) matches the specified tag.

", - "smithy.api#httpHeader": "x-amz-copy-source-if-match" - } - }, - "CopySourceIfModifiedSince": { - "target": "com.amazonaws.s3#CopySourceIfModifiedSince", - "traits": { - "smithy.api#documentation": "

Copies the object if it has been modified since the specified time.

", - "smithy.api#httpHeader": "x-amz-copy-source-if-modified-since" - } - }, - "CopySourceIfNoneMatch": { - "target": "com.amazonaws.s3#CopySourceIfNoneMatch", - "traits": { - "smithy.api#documentation": "

Copies the object if its entity tag (ETag) is different than the specified ETag.

", - "smithy.api#httpHeader": "x-amz-copy-source-if-none-match" - } - }, - "CopySourceIfUnmodifiedSince": { - "target": "com.amazonaws.s3#CopySourceIfUnmodifiedSince", - "traits": { - "smithy.api#documentation": "

Copies the object if it hasn't been modified since the specified time.

", - "smithy.api#httpHeader": "x-amz-copy-source-if-unmodified-since" - } - }, - "CopySourceRange": { - "target": "com.amazonaws.s3#CopySourceRange", - "traits": { - "smithy.api#documentation": "

The range of bytes to copy from the source object. The range value must use the form\n bytes=first-last, where the first and last are the zero-based byte offsets to copy. For\n example, bytes=0-9 indicates that you want to copy the first 10 bytes of the source. You\n can copy a range only if the source object is greater than 5 MB.

", - "smithy.api#httpHeader": "x-amz-copy-source-range" - } - }, - "Key": { - "target": "com.amazonaws.s3#ObjectKey", - "traits": { - "smithy.api#documentation": "

Object key for which the multipart upload was initiated.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "PartNumber": { - "target": "com.amazonaws.s3#PartNumber", - "traits": { - "smithy.api#documentation": "

Part number of part being copied. This is a positive integer between 1 and\n 10,000.

", - "smithy.api#httpQuery": "partNumber", - "smithy.api#required": {} - } - }, - "UploadId": { - "target": "com.amazonaws.s3#MultipartUploadId", - "traits": { - "smithy.api#documentation": "

Upload ID identifying the multipart upload whose part is being copied.

", - "smithy.api#httpQuery": "uploadId", - "smithy.api#required": {} - } - }, - "SSECustomerAlgorithm": { - "target": "com.amazonaws.s3#SSECustomerAlgorithm", - "traits": { - "smithy.api#documentation": "

Specifies the algorithm to use to when encrypting the object (for example,\n AES256).

", - "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-algorithm" - } - }, - "SSECustomerKey": { - "target": "com.amazonaws.s3#SSECustomerKey", - "traits": { - "smithy.api#documentation": "

Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This\n value is used to store the object and then it is discarded; Amazon S3 does not store the\n encryption key. The key must be appropriate for use with the algorithm specified in the\n x-amz-server-side-encryption-customer-algorithm header. This must be the\n same encryption key specified in the initiate multipart upload request.

", - "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key" - } - }, - "SSECustomerKeyMD5": { - "target": "com.amazonaws.s3#SSECustomerKeyMD5", - "traits": { - "smithy.api#documentation": "

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses\n this header for a message integrity check to ensure that the encryption key was transmitted\n without error.

", - "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key-MD5" - } - }, - "CopySourceSSECustomerAlgorithm": { - "target": "com.amazonaws.s3#CopySourceSSECustomerAlgorithm", - "traits": { - "smithy.api#documentation": "

Specifies the algorithm to use when decrypting the source object (for example,\n AES256).

", - "smithy.api#httpHeader": "x-amz-copy-source-server-side-encryption-customer-algorithm" - } - }, - "CopySourceSSECustomerKey": { - "target": "com.amazonaws.s3#CopySourceSSECustomerKey", - "traits": { - "smithy.api#documentation": "

Specifies the customer-provided encryption key for Amazon S3 to use to decrypt the source\n object. The encryption key provided in this header must be one that was used when the\n source object was created.

", - "smithy.api#httpHeader": "x-amz-copy-source-server-side-encryption-customer-key" - } - }, - "CopySourceSSECustomerKeyMD5": { - "target": "com.amazonaws.s3#CopySourceSSECustomerKeyMD5", - "traits": { - "smithy.api#documentation": "

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses\n this header for a message integrity check to ensure that the encryption key was transmitted\n without error.

", - "smithy.api#httpHeader": "x-amz-copy-source-server-side-encryption-customer-key-MD5" - } - }, - "RequestPayer": { - "target": "com.amazonaws.s3#RequestPayer", - "traits": { - "smithy.api#httpHeader": "x-amz-request-payer" - } - }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "

The account id of the expected destination bucket owner. If the destination bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", - "smithy.api#httpHeader": "x-amz-expected-bucket-owner" - } - }, - "ExpectedSourceBucketOwner": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "

The account id of the expected source bucket owner. If the source bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", - "smithy.api#httpHeader": "x-amz-source-expected-bucket-owner" - } - } - } - }, - "com.amazonaws.s3#UploadPartOutput": { - "type": "structure", - "members": { - "ServerSideEncryption": { - "target": "com.amazonaws.s3#ServerSideEncryption", - "traits": { - "smithy.api#documentation": "

The server-side encryption algorithm used when storing this object in Amazon S3 (for example,\n AES256, aws:kms).

", - "smithy.api#httpHeader": "x-amz-server-side-encryption" - } - }, - "ETag": { - "target": "com.amazonaws.s3#ETag", - "traits": { - "smithy.api#documentation": "

Entity tag for the uploaded object.

", - "smithy.api#httpHeader": "ETag" - } - }, - "SSECustomerAlgorithm": { - "target": "com.amazonaws.s3#SSECustomerAlgorithm", - "traits": { - "smithy.api#documentation": "

If server-side encryption with a customer-provided encryption key was requested, the\n response will include this header confirming the encryption algorithm used.

", - "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-algorithm" - } - }, - "SSECustomerKeyMD5": { - "target": "com.amazonaws.s3#SSECustomerKeyMD5", - "traits": { - "smithy.api#documentation": "

If server-side encryption with a customer-provided encryption key was requested, the\n response will include this header to provide round-trip message integrity verification of\n the customer-provided encryption key.

", - "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key-MD5" - } - }, - "SSEKMSKeyId": { - "target": "com.amazonaws.s3#SSEKMSKeyId", - "traits": { - "smithy.api#documentation": "

If present, specifies the ID of the AWS Key Management Service (AWS KMS) symmetric\n customer managed customer master key (CMK) was used for the object.

", - "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" - } - }, - "BucketKeyEnabled": { - "target": "com.amazonaws.s3#BucketKeyEnabled", - "traits": { - "smithy.api#documentation": "

Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with AWS KMS (SSE-KMS).

", - "smithy.api#httpHeader": "x-amz-server-side-encryption-bucket-key-enabled" - } - }, - "RequestCharged": { - "target": "com.amazonaws.s3#RequestCharged", - "traits": { - "smithy.api#httpHeader": "x-amz-request-charged" - } - } - } - }, - "com.amazonaws.s3#UploadPartRequest": { - "type": "structure", - "members": { - "Body": { - "target": "com.amazonaws.s3#StreamingBlob", - "traits": { - "smithy.api#documentation": "

Object data.

", - "smithy.api#httpPayload": {} - } - }, - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "

The name of the bucket to which the multipart upload was initiated.

\n

When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.

\n

When using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ContentLength": { - "target": "com.amazonaws.s3#ContentLength", - "traits": { - "smithy.api#documentation": "

Size of the body in bytes. This parameter is useful when the size of the body cannot be\n determined automatically.

", - "smithy.api#httpHeader": "Content-Length" - } - }, - "ContentMD5": { - "target": "com.amazonaws.s3#ContentMD5", - "traits": { - "smithy.api#documentation": "

The base64-encoded 128-bit MD5 digest of the part data. This parameter is auto-populated\n when using the command from the CLI. This parameter is required if object lock parameters\n are specified.

", - "smithy.api#httpHeader": "Content-MD5" - } - }, - "Key": { - "target": "com.amazonaws.s3#ObjectKey", - "traits": { - "smithy.api#documentation": "

Object key for which the multipart upload was initiated.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "PartNumber": { - "target": "com.amazonaws.s3#PartNumber", - "traits": { - "smithy.api#documentation": "

Part number of part being uploaded. This is a positive integer between 1 and\n 10,000.

", - "smithy.api#httpQuery": "partNumber", - "smithy.api#required": {} - } - }, - "UploadId": { - "target": "com.amazonaws.s3#MultipartUploadId", - "traits": { - "smithy.api#documentation": "

Upload ID identifying the multipart upload whose part is being uploaded.

", - "smithy.api#httpQuery": "uploadId", - "smithy.api#required": {} - } - }, - "SSECustomerAlgorithm": { - "target": "com.amazonaws.s3#SSECustomerAlgorithm", - "traits": { - "smithy.api#documentation": "

Specifies the algorithm to use to when encrypting the object (for example,\n AES256).

", - "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-algorithm" - } - }, - "SSECustomerKey": { - "target": "com.amazonaws.s3#SSECustomerKey", - "traits": { - "smithy.api#documentation": "

Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This\n value is used to store the object and then it is discarded; Amazon S3 does not store the\n encryption key. The key must be appropriate for use with the algorithm specified in the\n x-amz-server-side-encryption-customer-algorithm header. This must be the\n same encryption key specified in the initiate multipart upload request.

", - "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key" - } - }, - "SSECustomerKeyMD5": { - "target": "com.amazonaws.s3#SSECustomerKeyMD5", - "traits": { - "smithy.api#documentation": "

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses\n this header for a message integrity check to ensure that the encryption key was transmitted\n without error.

", - "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key-MD5" - } - }, - "RequestPayer": { - "target": "com.amazonaws.s3#RequestPayer", - "traits": { - "smithy.api#httpHeader": "x-amz-request-payer" - } - }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

", - "smithy.api#httpHeader": "x-amz-expected-bucket-owner" - } - } - } - }, - "com.amazonaws.s3#UserMetadata": { - "type": "list", - "member": { - "target": "com.amazonaws.s3#MetadataEntry", - "traits": { - "smithy.api#xmlName": "MetadataEntry" - } - } - }, - "com.amazonaws.s3#Value": { - "type": "string" - }, - "com.amazonaws.s3#VersionIdMarker": { - "type": "string" - }, - "com.amazonaws.s3#VersioningConfiguration": { - "type": "structure", - "members": { - "MFADelete": { - "target": "com.amazonaws.s3#MFADelete", - "traits": { - "smithy.api#documentation": "

Specifies whether MFA delete is enabled in the bucket versioning configuration. This\n element is only returned if the bucket has been configured with MFA delete. If the bucket\n has never been so configured, this element is not returned.

", - "smithy.api#xmlName": "MfaDelete" - } - }, - "Status": { - "target": "com.amazonaws.s3#BucketVersioningStatus", - "traits": { - "smithy.api#documentation": "

The versioning state of the bucket.

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

Describes the versioning state of an Amazon S3 bucket. For more information, see PUT\n Bucket versioning in the Amazon Simple Storage Service API Reference.

" - } - }, - "com.amazonaws.s3#WebsiteConfiguration": { - "type": "structure", - "members": { - "ErrorDocument": { - "target": "com.amazonaws.s3#ErrorDocument", - "traits": { - "smithy.api#documentation": "

The name of the error document for the website.

" - } - }, - "IndexDocument": { - "target": "com.amazonaws.s3#IndexDocument", - "traits": { - "smithy.api#documentation": "

The name of the index document for the website.

" - } - }, - "RedirectAllRequestsTo": { - "target": "com.amazonaws.s3#RedirectAllRequestsTo", - "traits": { - "smithy.api#documentation": "

The redirect behavior for every request to this bucket's website endpoint.

\n \n

If you specify this property, you can't specify any other property.

\n " - } - }, - "RoutingRules": { - "target": "com.amazonaws.s3#RoutingRules", - "traits": { - "smithy.api#documentation": "

Rules that define when a redirect is applied and the redirect behavior.

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

Specifies website configuration parameters for an Amazon S3 bucket.

" - } - }, - "com.amazonaws.s3#WebsiteRedirectLocation": { - "type": "string" - }, - "com.amazonaws.s3#Years": { - "type": "integer" } - } } diff --git a/codegen/sdk-codegen/aws-models/s3control.2018-08-20.json b/codegen/sdk-codegen/aws-models/s3control.2018-08-20.json index bc1a10d1eea..3784bf6a7a5 100644 --- a/codegen/sdk-codegen/aws-models/s3control.2018-08-20.json +++ b/codegen/sdk-codegen/aws-models/s3control.2018-08-20.json @@ -334,16 +334,20 @@ "traits": { "smithy.api#enum": [ { - "value": "private" + "value": "private", + "name": "private" }, { - "value": "public-read" + "value": "public-read", + "name": "public_read" }, { - "value": "public-read-write" + "value": "public-read-write", + "name": "public_read_write" }, { - "value": "authenticated-read" + "value": "authenticated-read", + "name": "authenticated_read" } ] } @@ -373,37 +377,48 @@ "traits": { "smithy.api#enum": [ { - "value": "EU" + "value": "EU", + "name": "EU" }, { - "value": "eu-west-1" + "value": "eu-west-1", + "name": "eu_west_1" }, { - "value": "us-west-1" + "value": "us-west-1", + "name": "us_west_1" }, { - "value": "us-west-2" + "value": "us-west-2", + "name": "us_west_2" }, { - "value": "ap-south-1" + "value": "ap-south-1", + "name": "ap_south_1" }, { - "value": "ap-southeast-1" + "value": "ap-southeast-1", + "name": "ap_southeast_1" }, { - "value": "ap-southeast-2" + "value": "ap-southeast-2", + "name": "ap_southeast_2" }, { - "value": "ap-northeast-1" + "value": "ap-northeast-1", + "name": "ap_northeast_1" }, { - "value": "sa-east-1" + "value": "sa-east-1", + "name": "sa_east_1" }, { - "value": "cn-north-1" + "value": "cn-north-1", + "name": "cn_north_1" }, { - "value": "eu-central-1" + "value": "eu-central-1", + "name": "eu_central_1" } ] } @@ -1290,10 +1305,12 @@ "traits": { "smithy.api#enum": [ { - "value": "Enabled" + "value": "Enabled", + "name": "Enabled" }, { - "value": "Disabled" + "value": "Disabled", + "name": "Disabled" } ] } @@ -1306,10 +1323,12 @@ "traits": { "smithy.api#enum": [ { - "value": "CSV" + "value": "CSV", + "name": "CSV" }, { - "value": "Parquet" + "value": "Parquet", + "name": "Parquet" } ] } @@ -3378,7 +3397,8 @@ "traits": { "smithy.api#enum": [ { - "value": "V_1" + "value": "V_1", + "name": "V_1" } ] } @@ -5101,19 +5121,24 @@ "traits": { "smithy.api#enum": [ { - "value": "GLACIER" + "value": "GLACIER", + "name": "GLACIER" }, { - "value": "STANDARD_IA" + "value": "STANDARD_IA", + "name": "STANDARD_IA" }, { - "value": "ONEZONE_IA" + "value": "ONEZONE_IA", + "name": "ONEZONE_IA" }, { - "value": "INTELLIGENT_TIERING" + "value": "INTELLIGENT_TIERING", + "name": "INTELLIGENT_TIERING" }, { - "value": "DEEP_ARCHIVE" + "value": "DEEP_ARCHIVE", + "name": "DEEP_ARCHIVE" } ] } diff --git a/codegen/sdk-codegen/aws-models/savingsplans.2019-06-28.json b/codegen/sdk-codegen/aws-models/savingsplans.2019-06-28.json index ecf24e87d09..0b3412c02fe 100644 --- a/codegen/sdk-codegen/aws-models/savingsplans.2019-06-28.json +++ b/codegen/sdk-codegen/aws-models/savingsplans.2019-06-28.json @@ -174,10 +174,12 @@ "traits": { "smithy.api#enum": [ { - "value": "CNY" + "value": "CNY", + "name": "CNY" }, { - "value": "USD" + "value": "USD", + "name": "USD" } ] } diff --git a/codegen/sdk-codegen/aws-models/secretsmanager.2017-10-17.json b/codegen/sdk-codegen/aws-models/secretsmanager.2017-10-17.json index c7587c9864c..b1240adee24 100644 --- a/codegen/sdk-codegen/aws-models/secretsmanager.2017-10-17.json +++ b/codegen/sdk-codegen/aws-models/secretsmanager.2017-10-17.json @@ -570,19 +570,24 @@ "traits": { "smithy.api#enum": [ { - "value": "description" + "value": "description", + "name": "description" }, { - "value": "name" + "value": "name", + "name": "name" }, { - "value": "tag-key" + "value": "tag-key", + "name": "tag_key" }, { - "value": "tag-value" + "value": "tag-value", + "name": "tag_value" }, { - "value": "all" + "value": "all", + "name": "all" } ] } diff --git a/codegen/sdk-codegen/aws-models/securityhub.2018-10-26.json b/codegen/sdk-codegen/aws-models/securityhub.2018-10-26.json index 4c794afe640..93462e658a5 100644 --- a/codegen/sdk-codegen/aws-models/securityhub.2018-10-26.json +++ b/codegen/sdk-codegen/aws-models/securityhub.2018-10-26.json @@ -7863,7 +7863,7 @@ } ], "traits": { - "smithy.api#documentation": "

Imports security findings generated from an integrated third-party product into Security Hub.\n This action is requested by the integrated product to import its findings into\n Security Hub.

\n

The maximum allowed size for a finding is 240 Kb. An error is returned for any finding\n larger than 240 Kb.

\n

After a finding is created, BatchImportFindings cannot be used to update\n the following finding fields and objects, which Security Hub customers use to manage their\n investigation workflow.

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

Imports security findings generated from an integrated third-party product into Security Hub.\n This action is requested by the integrated product to import its findings into\n Security Hub.

\n

The maximum allowed size for a finding is 240 Kb. An error is returned for any finding\n larger than 240 Kb.

\n

After a finding is created, BatchImportFindings cannot be used to update\n the following finding fields and objects, which Security Hub customers use to manage their\n investigation workflow.

\n \n

\n BatchImportFindings can be used to update the following finding fields and\n objects only if they have not been updated using BatchUpdateFindings. After\n they are updated using BatchUpdateFindings, these fields cannot be updated\n using BatchImportFindings.

\n ", "smithy.api#http": { "method": "POST", "uri": "/findings/import", @@ -12222,7 +12222,7 @@ } }, "traits": { - "smithy.api#documentation": "

The severity of the finding.

\n

The finding provider can provide the initial severity, but cannot update it after that.\n The severity can only be updated by a master account. It cannot be updated by a member\n account.

\n

The finding must have either Label or Normalized populated. If\n only one of these attributes is populated, then Security Hub automatically populates the other\n one. If neither attribute is populated, then the finding is invalid. Label is\n the preferred attribute.

" + "smithy.api#documentation": "

The severity of the finding.

\n

The finding provider can provide the initial severity. The finding provider can only\n update the severity if it has not been updated using\n BatchUpdateFindings.

\n

The finding must have either Label or Normalized populated. If\n only one of these attributes is populated, then Security Hub automatically populates the other\n one. If neither attribute is populated, then the finding is invalid. Label is\n the preferred attribute.

" } }, "com.amazonaws.securityhub#SeverityLabel": { diff --git a/codegen/sdk-codegen/aws-models/servicecatalog.2015-12-10.json b/codegen/sdk-codegen/aws-models/servicecatalog.2015-12-10.json index a021eb6f82f..07615997488 100644 --- a/codegen/sdk-codegen/aws-models/servicecatalog.2015-12-10.json +++ b/codegen/sdk-codegen/aws-models/servicecatalog.2015-12-10.json @@ -117,6 +117,9 @@ { "target": "com.amazonaws.servicecatalog#DescribePortfolio" }, + { + "target": "com.amazonaws.servicecatalog#DescribePortfolioShares" + }, { "target": "com.amazonaws.servicecatalog#DescribePortfolioShareStatus" }, @@ -270,6 +273,9 @@ { "target": "com.amazonaws.servicecatalog#UpdatePortfolio" }, + { + "target": "com.amazonaws.servicecatalog#UpdatePortfolioShare" + }, { "target": "com.amazonaws.servicecatalog#UpdateProduct" }, @@ -837,6 +843,9 @@ } } }, + "com.amazonaws.servicecatalog#Boolean": { + "type": "boolean" + }, "com.amazonaws.servicecatalog#BudgetDetail": { "type": "structure", "members": { @@ -1338,7 +1347,7 @@ } ], "traits": { - "smithy.api#documentation": "

Shares the specified portfolio with the specified account or organization node.\n Shares to an organization node can only be created by the management account of an\n organization or by a delegated administrator. You can share portfolios to an organization,\n an organizational unit, or a specific account.

\n

Note that if a delegated admin is de-registered, they can no longer create portfolio shares.

\n

\n AWSOrganizationsAccess must be enabled in order to create a portfolio share to an organization node.

\n

You can't share a shared resource. This includes portfolios that contain a shared product.

" + "smithy.api#documentation": "

Shares the specified portfolio with the specified account or organization node.\n Shares to an organization node can only be created by the management account of an\n organization or by a delegated administrator. You can share portfolios to an organization,\n an organizational unit, or a specific account.

\n

Note that if a delegated admin is de-registered, they can no longer create portfolio shares.

\n

\n AWSOrganizationsAccess must be enabled in order to create a portfolio share to an organization node.

\n

You can't share a shared resource, including portfolios that contain a shared product.

\n

If the portfolio share with the specified account or organization node already exists, this action will have no effect and will not return an error. To update an existing share, you must use the UpdatePortfolioShare API instead.

" } }, "com.amazonaws.servicecatalog#CreatePortfolioShareInput": { @@ -1368,6 +1377,12 @@ "traits": { "smithy.api#documentation": "

The organization node to whom you are going to share. If OrganizationNode\n is passed in, PortfolioShare will be created for the node an\n ListOrganizationPortfolioAccessd its children (when applies), and a\n PortfolioShareToken will be returned in the output in order for the\n administrator to monitor the status of the PortfolioShare creation\n process.

" } + }, + "ShareTagOptions": { + "target": "com.amazonaws.servicecatalog#Boolean", + "traits": { + "smithy.api#documentation": "

Enables or disables TagOptions sharing when creating the portfolio share. If this flag is not provided, TagOptions sharing is disabled.

" + } } } }, @@ -1402,7 +1417,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a product.

\n

A delegated admin is authorized to invoke this command.

" + "smithy.api#documentation": "

Creates a product.

\n

A delegated admin is authorized to invoke this command.

\n \n

The user or role that performs this operation must have the\n cloudformation:GetTemplate IAM policy permission. This policy permission is\n required when using the ImportFromPhysicalId template source in the\n information data section.

" } }, "com.amazonaws.servicecatalog#CreateProductInput": { @@ -1455,7 +1470,7 @@ "SupportUrl": { "target": "com.amazonaws.servicecatalog#SupportUrl", "traits": { - "smithy.api#documentation": "

The contact URL for product support.

" + "smithy.api#documentation": "

The contact URL for product support.

\n

\n ^https?:\\/\\// / is the pattern used to validate SupportUrl.

" } }, "ProductType": { @@ -1474,7 +1489,7 @@ "ProvisioningArtifactParameters": { "target": "com.amazonaws.servicecatalog#ProvisioningArtifactProperties", "traits": { - "smithy.api#documentation": "

The configuration of the provisioning artifact. The info field accepts ImportFromPhysicalID.

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

The configuration of the provisioning artifact.

", "smithy.api#required": {} } }, @@ -1667,7 +1682,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a provisioning artifact (also known as a version) for the specified product.

\n

You cannot create a provisioning artifact for a product that was shared with you.

" + "smithy.api#documentation": "

Creates a provisioning artifact (also known as a version) for the specified product.

\n

You cannot create a provisioning artifact for a product that was shared with you.

\n \n

The user or role that performs this operation must have the cloudformation:GetTemplate\n IAM policy permission. This policy permission is required when using the\n ImportFromPhysicalId template source in the information data section.

" } }, "com.amazonaws.servicecatalog#CreateProvisioningArtifactInput": { @@ -1689,7 +1704,7 @@ "Parameters": { "target": "com.amazonaws.servicecatalog#ProvisioningArtifactProperties", "traits": { - "smithy.api#documentation": "

The configuration for the provisioning artifact. The info field accepts ImportFromPhysicalID.\n

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

The configuration for the provisioning artifact.

", "smithy.api#required": {} } }, @@ -1715,7 +1730,7 @@ "Info": { "target": "com.amazonaws.servicecatalog#ProvisioningArtifactInfo", "traits": { - "smithy.api#documentation": "

The URL of the CloudFormation template in Amazon S3, in JSON format.

" + "smithy.api#documentation": "

Specify the template source with one of the following options, but not both. Keys\n accepted: [ LoadTemplateFromURL, ImportFromPhysicalId ].

\n

The URL of the CloudFormation template in Amazon S3, in JSON format.

\n

\n LoadTemplateFromURL\n

\n

Use the URL of the CloudFormation template in Amazon S3 in JSON format.

\n

\n ImportFromPhysicalId\n

\n

Use the physical id of the resource that contains the template; currently supports\n CloudFormation stack ARN.

" } }, "Status": { @@ -2502,6 +2517,102 @@ } } }, + "com.amazonaws.servicecatalog#DescribePortfolioShareType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ACCOUNT", + "name": "ACCOUNT" + }, + { + "value": "ORGANIZATION", + "name": "ORGANIZATION" + }, + { + "value": "ORGANIZATIONAL_UNIT", + "name": "ORGANIZATIONAL_UNIT" + }, + { + "value": "ORGANIZATION_MEMBER_ACCOUNT", + "name": "ORGANIZATION_MEMBER_ACCOUNT" + } + ] + } + }, + "com.amazonaws.servicecatalog#DescribePortfolioShares": { + "type": "operation", + "input": { + "target": "com.amazonaws.servicecatalog#DescribePortfolioSharesInput" + }, + "output": { + "target": "com.amazonaws.servicecatalog#DescribePortfolioSharesOutput" + }, + "errors": [ + { + "target": "com.amazonaws.servicecatalog#InvalidParametersException" + }, + { + "target": "com.amazonaws.servicecatalog#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a summary of each of the portfolio shares that were created for the specified portfolio.

\n

You can use this API to determine which accounts or organizational nodes this\n portfolio have been shared, whether the recipient entity has imported the share, and\n whether TagOptions are included with the share.

\n

The PortfolioId and Type parameters are both required.

", + "smithy.api#paginated": { + "inputToken": "PageToken", + "outputToken": "NextPageToken", + "pageSize": "PageSize" + } + } + }, + "com.amazonaws.servicecatalog#DescribePortfolioSharesInput": { + "type": "structure", + "members": { + "PortfolioId": { + "target": "com.amazonaws.servicecatalog#Id", + "traits": { + "smithy.api#documentation": "

The unique identifier of the portfolio for which shares will be retrieved.

", + "smithy.api#required": {} + } + }, + "Type": { + "target": "com.amazonaws.servicecatalog#DescribePortfolioShareType", + "traits": { + "smithy.api#documentation": "

The type of portfolio share to summarize. This field acts as a filter on the type of portfolio share, which can be one of the following:

\n

1. ACCOUNT - Represents an external account to account share.

\n

2. ORGANIZATION - Represents a share to an organization. This share is available to every account in the organization.

\n

3. ORGANIZATIONAL_UNIT - Represents a share to an organizational unit.

\n

4. ORGANIZATION_MEMBER_ACCOUNT - Represents a share to an account in the organization.

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

The page token for the next set of results. To retrieve the first set of results, use null.

" + } + }, + "PageSize": { + "target": "com.amazonaws.servicecatalog#PageSizeMax100", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return with this call.

" + } + } + } + }, + "com.amazonaws.servicecatalog#DescribePortfolioSharesOutput": { + "type": "structure", + "members": { + "NextPageToken": { + "target": "com.amazonaws.servicecatalog#PageToken", + "traits": { + "smithy.api#documentation": "

The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

" + } + }, + "PortfolioShareDetails": { + "target": "com.amazonaws.servicecatalog#PortfolioShareDetails", + "traits": { + "smithy.api#documentation": "

Summaries about each of the portfolio shares.

" + } + } + } + }, "com.amazonaws.servicecatalog#DescribeProduct": { "type": "operation", "input": { @@ -2562,6 +2673,12 @@ "traits": { "smithy.api#documentation": "

The product name.

" } + }, + "SourcePortfolioId": { + "target": "com.amazonaws.servicecatalog#Id", + "traits": { + "smithy.api#documentation": "

The unique identifier of the shared portfolio that the specified product is associated\n with.

\n

You can provide this parameter to retrieve the shared TagOptions associated with the\n product. If this parameter is provided and if TagOptions sharing is enabled in the\n portfolio share, the API returns both local and shared TagOptions associated with the\n product. Otherwise only local TagOptions will be returned.

" + } } } }, @@ -4039,7 +4156,7 @@ } ], "traits": { - "smithy.api#documentation": "

Requests the import of a resource as a Service Catalog provisioned product that is\n associated to a Service Catalog product and provisioning artifact. Once imported all\n supported Service Catalog governance actions are supported on the provisioned\n product.

\n

Resource import only supports CloudFormation stack ARNs. CloudFormation StackSets and\n non-root nested stacks are not supported.

\n

The CloudFormation stack must have one of the following statuses to be imported:\n CREATE_COMPLETE, UPDATE_COMPLETE, UPDATE_ROLLBACK_COMPLETE, IMPORT_COMPLETE,\n IMPORT_ROLLBACK_COMPLETE.

\n

Import of the resource requires that the CloudFormation stack template matches the\n associated Service Catalog product provisioning artifact.

" + "smithy.api#documentation": "

Requests the import of a resource as a Service Catalog provisioned product that is\n associated to a Service Catalog product and provisioning artifact. Once imported, all\n supported Service Catalog governance actions are supported on the provisioned\n product.

\n

Resource import only supports CloudFormation stack ARNs. CloudFormation StackSets and\n non-root nested stacks are not supported.

\n

The CloudFormation stack must have one of the following statuses to be imported:\n CREATE_COMPLETE, UPDATE_COMPLETE, UPDATE_ROLLBACK_COMPLETE, IMPORT_COMPLETE,\n IMPORT_ROLLBACK_COMPLETE.

\n

Import of the resource requires that the CloudFormation stack template matches the\n associated Service Catalog product provisioning artifact.

\n \n

The user or role that performs this operation must have the cloudformation:GetTemplate\n and cloudformation:DescribeStacks IAM policy permissions.

" } }, "com.amazonaws.servicecatalog#ImportAsProvisionedProductInput": { @@ -5568,6 +5685,12 @@ } } }, + "com.amazonaws.servicecatalog#NullableBoolean": { + "type": "boolean", + "traits": { + "smithy.api#box": {} + } + }, "com.amazonaws.servicecatalog#OperationNotSupportedException": { "type": "structure", "members": { @@ -5658,6 +5781,9 @@ "com.amazonaws.servicecatalog#OutputValue": { "type": "string" }, + "com.amazonaws.servicecatalog#Owner": { + "type": "string" + }, "com.amazonaws.servicecatalog#PageSize": { "type": "integer", "traits": { @@ -5807,6 +5933,44 @@ "com.amazonaws.servicecatalog#PortfolioName": { "type": "string" }, + "com.amazonaws.servicecatalog#PortfolioShareDetail": { + "type": "structure", + "members": { + "PrincipalId": { + "target": "com.amazonaws.servicecatalog#Id", + "traits": { + "smithy.api#documentation": "

The identifier of the recipient entity that received the portfolio share. \n The recipient entities can be one of the following:\n

\n

1. An external account.

\n

2. An organziation member account.

\n

3. An organzational unit (OU).

\n

4. The organization itself. (This shares with every account in the organization).

" + } + }, + "Type": { + "target": "com.amazonaws.servicecatalog#DescribePortfolioShareType", + "traits": { + "smithy.api#documentation": "

The type of the portfolio share.

" + } + }, + "Accepted": { + "target": "com.amazonaws.servicecatalog#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether the shared portfolio is imported by the recipient account. If the recipient is in an organization node, the share is automatically imported, and the field is always set to true.

" + } + }, + "ShareTagOptions": { + "target": "com.amazonaws.servicecatalog#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether TagOptions sharing is enabled or disabled for the portfolio share.

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

Information about the portfolio share.

" + } + }, + "com.amazonaws.servicecatalog#PortfolioShareDetails": { + "type": "list", + "member": { + "target": "com.amazonaws.servicecatalog#PortfolioShareDetail" + } + }, "com.amazonaws.servicecatalog#PortfolioShareType": { "type": "string", "traits": { @@ -7124,7 +7288,7 @@ "Info": { "target": "com.amazonaws.servicecatalog#ProvisioningArtifactInfo", "traits": { - "smithy.api#documentation": "

The URL of the CloudFormation template in Amazon S3. Specify the URL in JSON format as follows:

\n

\n \"LoadTemplateFromURL\": \"https://s3.amazonaws.com/cf-templates-ozkq9d3hgiq2-us-east-1/...\"\n

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

Specify the template source with one of the following options, but not both.\n Keys accepted: [ LoadTemplateFromURL, ImportFromPhysicalId ]

\n

The URL of the CloudFormation template in Amazon S3. Specify the URL in JSON format as follows:

\n

\n \"LoadTemplateFromURL\": \"https://s3.amazonaws.com/cf-templates-ozkq9d3hgiq2-us-east-1/...\"\n

\n

\n ImportFromPhysicalId: The physical id of the resource that contains the\n template. Currently only supports CloudFormation stack arn. Specify the physical id in JSON\n format as follows: ImportFromPhysicalId: “arn:aws:cloudformation:[us-east-1]:[accountId]:stack/[StackName]/[resourceId]\n

", "smithy.api#required": {} } }, @@ -7286,7 +7450,7 @@ "StackSetAccounts": { "target": "com.amazonaws.servicecatalog#StackSetAccounts", "traits": { - "smithy.api#documentation": "

One or more AWS accounts that will have access to the provisioned product.

\n

Applicable only to a CFN_STACKSET provisioned product type.

\n

The AWS accounts specified should be within the list of accounts in the STACKSET constraint. To get the list of accounts in the STACKSET constraint, use the DescribeProvisioningParameters operation.

\n

If no values are specified, the default value is all accounts from the STACKSET constraint.

" + "smithy.api#documentation": "

One or more AWS accounts where the provisioned product will be available.

\n

Applicable only to a CFN_STACKSET provisioned product type.

\n

The specified accounts should be within the list of accounts from the STACKSET constraint. To get the list of accounts in the STACKSET constraint, use the DescribeProvisioningParameters operation.

\n

If no values are specified, the default value is all acounts from the STACKSET constraint.

" } }, "StackSetRegions": { @@ -7321,7 +7485,7 @@ } }, "traits": { - "smithy.api#documentation": "

The user-defined preferences that will be applied when updating a provisioned product. Not all preferences are applicable to all provisioned product types.

" + "smithy.api#documentation": "

The user-defined preferences that will be applied when updating a provisioned\n product. Not all preferences are applicable to all provisioned product type

\n

One or more AWS accounts that will have access to the provisioned product.

\n

Applicable only to a CFN_STACKSET provisioned product type.

\n

The AWS accounts specified should be within the list of accounts in the\n STACKSET constraint. To get the list of accounts in the\n STACKSET constraint, use the DescribeProvisioningParameters\n operation.

\n

If no values are specified, the default value is all accounts from the\n STACKSET constraint.

" } }, "com.amazonaws.servicecatalog#RecordDetail": { @@ -8685,13 +8849,16 @@ "traits": { "smithy.api#enum": [ { - "value": "CREATE" + "value": "CREATE", + "name": "CREATE" }, { - "value": "UPDATE" + "value": "UPDATE", + "name": "UPDATE" }, { - "value": "DELETE" + "value": "DELETE", + "name": "DELETE" } ] } @@ -8833,6 +9000,12 @@ "traits": { "smithy.api#documentation": "

The TagOption identifier.

" } + }, + "Owner": { + "target": "com.amazonaws.servicecatalog#Owner", + "traits": { + "smithy.api#documentation": "

The AWS account Id of the owner account that created the TagOption.

" + } } }, "traits": { @@ -8995,7 +9168,7 @@ "RetainPhysicalResources": { "target": "com.amazonaws.servicecatalog#RetainPhysicalResources", "traits": { - "smithy.api#documentation": "

When this boolean parameter is set to true, the TerminateProvisionedProduct API deletes\n the Service Catalog provisioned product. However, it does not remove the CloudFormation\n stack, stack set, or the underlying resources of the deleted provisioned product. The\n default value is false.

" + "smithy.api#documentation": "

When this boolean parameter is set to true, the TerminateProvisionedProduct API deletes\n the Service Catalog provisioned product. However, it does not remove the CloudFormation\n stack, stack set, or the underlying resources of the deleted provisioned product. The\n default value is false.

" } } } @@ -9178,6 +9351,82 @@ } } }, + "com.amazonaws.servicecatalog#UpdatePortfolioShare": { + "type": "operation", + "input": { + "target": "com.amazonaws.servicecatalog#UpdatePortfolioShareInput" + }, + "output": { + "target": "com.amazonaws.servicecatalog#UpdatePortfolioShareOutput" + }, + "errors": [ + { + "target": "com.amazonaws.servicecatalog#InvalidParametersException" + }, + { + "target": "com.amazonaws.servicecatalog#InvalidStateException" + }, + { + "target": "com.amazonaws.servicecatalog#OperationNotSupportedException" + }, + { + "target": "com.amazonaws.servicecatalog#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the specified portfolio share. You can use this API to enable or disable TagOptions sharing for an existing portfolio share.

\n \n

The portfolio share cannot be updated if the CreatePortfolioShare operation is IN_PROGRESS, as the share is not available to recipient entities. In this case, you must wait for the portfolio share to be COMPLETED.

\n \n

You must provide the accountId or organization node in the input, but not both.

\n \n

If the portfolio is shared to both an external account and an organization node, and both shares need to be updated, you must invoke UpdatePortfolioShare separately for each share type.

\n \n

This API cannot be used for removing the portfolio share. You must use DeletePortfolioShare API for that action.

" + } + }, + "com.amazonaws.servicecatalog#UpdatePortfolioShareInput": { + "type": "structure", + "members": { + "AcceptLanguage": { + "target": "com.amazonaws.servicecatalog#AcceptLanguage", + "traits": { + "smithy.api#documentation": "

The language code.

\n " + } + }, + "PortfolioId": { + "target": "com.amazonaws.servicecatalog#Id", + "traits": { + "smithy.api#documentation": "

The unique identifier of the portfolio for which the share will be updated.

", + "smithy.api#required": {} + } + }, + "AccountId": { + "target": "com.amazonaws.servicecatalog#AccountId", + "traits": { + "smithy.api#documentation": "

The AWS Account Id of the recipient account. This field is required when updating an external account to account type share.

" + } + }, + "OrganizationNode": { + "target": "com.amazonaws.servicecatalog#OrganizationNode" + }, + "ShareTagOptions": { + "target": "com.amazonaws.servicecatalog#NullableBoolean", + "traits": { + "smithy.api#documentation": "

A flag to enable or disable TagOptions sharing for the portfolio share. If this field is not provided, the current state of TagOptions sharing on the portfolio share will not be modified.

" + } + } + } + }, + "com.amazonaws.servicecatalog#UpdatePortfolioShareOutput": { + "type": "structure", + "members": { + "PortfolioShareToken": { + "target": "com.amazonaws.servicecatalog#Id", + "traits": { + "smithy.api#documentation": "

The token that tracks the status of the UpdatePortfolioShare operation for external account to account or organizational type sharing.

" + } + }, + "Status": { + "target": "com.amazonaws.servicecatalog#ShareStatus", + "traits": { + "smithy.api#documentation": "

The status of UpdatePortfolioShare operation.\n You can also obtain the operation status using DescribePortfolioShareStatus API. \n

" + } + } + } + }, "com.amazonaws.servicecatalog#UpdateProduct": { "type": "operation", "input": { diff --git a/codegen/sdk-codegen/aws-models/servicecatalogappregistry.2020-06-24.json b/codegen/sdk-codegen/aws-models/servicecatalogappregistry.2020-06-24.json index bbe8803b7fc..76d5b7ded3a 100644 --- a/codegen/sdk-codegen/aws-models/servicecatalogappregistry.2020-06-24.json +++ b/codegen/sdk-codegen/aws-models/servicecatalogappregistry.2020-06-24.json @@ -78,6 +78,9 @@ { "target": "com.amazonaws.servicecatalogappregistry#ListTagsForResource" }, + { + "target": "com.amazonaws.servicecatalogappregistry#SyncResource" + }, { "target": "com.amazonaws.servicecatalogappregistry#TagResource" }, @@ -1618,6 +1621,93 @@ "com.amazonaws.servicecatalogappregistry#String": { "type": "string" }, + "com.amazonaws.servicecatalogappregistry#SyncAction": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "START_SYNC", + "name": "START_SYNC" + }, + { + "value": "NO_ACTION", + "name": "NO_ACTION" + } + ] + } + }, + "com.amazonaws.servicecatalogappregistry#SyncResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.servicecatalogappregistry#SyncResourceRequest" + }, + "output": { + "target": "com.amazonaws.servicecatalogappregistry#SyncResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.servicecatalogappregistry#ConflictException" + }, + { + "target": "com.amazonaws.servicecatalogappregistry#InternalServerException" + }, + { + "target": "com.amazonaws.servicecatalogappregistry#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Syncs the resource with what is currently recorded in App registry. Specifically, the resource’s App registry system tags are synced with its associated application. The resource is removed if it is not associated with the application. The caller must have permissions to read and update the resource.

", + "smithy.api#http": { + "method": "POST", + "uri": "/sync/{resourceType}/{resource}", + "code": 200 + } + } + }, + "com.amazonaws.servicecatalogappregistry#SyncResourceRequest": { + "type": "structure", + "members": { + "resourceType": { + "target": "com.amazonaws.servicecatalogappregistry#ResourceType", + "traits": { + "smithy.api#documentation": "

The type of resource of which the application will be associated.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "resource": { + "target": "com.amazonaws.servicecatalogappregistry#ResourceSpecifier", + "traits": { + "smithy.api#documentation": "

An entity you can work with and specify with a name or ID. Examples include an Amazon EC2 instance, an AWS CloudFormation stack, or an Amazon S3 bucket.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.servicecatalogappregistry#SyncResourceResponse": { + "type": "structure", + "members": { + "applicationArn": { + "target": "com.amazonaws.servicecatalogappregistry#ApplicationArn", + "traits": { + "smithy.api#documentation": "

The Amazon resource name (ARN) that specifies the application.

" + } + }, + "resourceArn": { + "target": "com.amazonaws.servicecatalogappregistry#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon resource name (ARN) that specifies the resource.

" + } + }, + "actionTaken": { + "target": "com.amazonaws.servicecatalogappregistry#SyncAction", + "traits": { + "smithy.api#documentation": "

The results of the output if an application is associated with an ARN value, which could be syncStarted or None.

" + } + } + } + }, "com.amazonaws.servicecatalogappregistry#TagKey": { "type": "string", "traits": { @@ -1660,7 +1750,7 @@ } ], "traits": { - "smithy.api#documentation": "

Assigns one or more tags (key-value pairs) to the specified resource.

\n

Each tag consists of a key and an optional value. If a tag with the same key is already associated with the resource, this action updates its value.

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

Assigns one or more tags (key-value pairs) to the specified resource.

\n

Each tag consists of a key and an optional value. If a tag with the same key is already associated with the resource, this action updates its value.

\n

This operation returns an empty response if the call was successful.

", "smithy.api#http": { "method": "POST", "uri": "/tags/{resourceArn}", @@ -1743,7 +1833,7 @@ } ], "traits": { - "smithy.api#documentation": "

Removes tags from a resource.

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

Removes tags from a resource.

\n

This operation returns an empty response if the call was successful.

", "smithy.api#http": { "method": "DELETE", "uri": "/tags/{resourceArn}", diff --git a/codegen/sdk-codegen/aws-models/servicequotas.2019-06-24.json b/codegen/sdk-codegen/aws-models/servicequotas.2019-06-24.json index a4946076108..07d345610c0 100644 --- a/codegen/sdk-codegen/aws-models/servicequotas.2019-06-24.json +++ b/codegen/sdk-codegen/aws-models/servicequotas.2019-06-24.json @@ -37,7 +37,7 @@ } }, "traits": { - "smithy.api#documentation": "

The action you attempted is not allowed unless Service Access with Service Quotas is\n enabled in your organization. To enable, call AssociateServiceQuotaTemplate.

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

The action you attempted is not allowed unless Service Access with Service Quotas is\n enabled in your organization.

", "smithy.api#error": "client", "smithy.api#httpError": 403 } @@ -50,11 +50,21 @@ } }, "traits": { - "smithy.api#documentation": "

You do not have sufficient access to perform this action.

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

You do not have sufficient permission to perform this action.

", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, + "com.amazonaws.servicequotas#AmazonResourceName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1011 + }, + "smithy.api#pattern": "arn:aws(-[\\w]+)*:*:.+:[0-9]{12}:.+" + } + }, "com.amazonaws.servicequotas#AssociateServiceQuotaTemplate": { "type": "operation", "input": { @@ -90,7 +100,7 @@ } ], "traits": { - "smithy.api#documentation": "

Associates the Service Quotas template with your organization so that when new accounts\n are created in your organization, the template submits increase requests for the specified\n service quotas. Use the Service Quotas template to request an increase for any adjustable\n quota value. After you define the Service Quotas template, use this operation to associate, or\n enable, the template.

" + "smithy.api#documentation": "

Associates your quota request template with your organization. When a new account is\n created in your organization, the quota increase requests in the template are automatically\n applied to the account. You can add a quota increase request for any adjustable quota to your\n template.

" } }, "com.amazonaws.servicequotas#AssociateServiceQuotaTemplateRequest": { @@ -155,7 +165,7 @@ } ], "traits": { - "smithy.api#documentation": "

Removes a service quota increase request from the Service Quotas template.

" + "smithy.api#documentation": "

Deletes the quota increase request for the specified quota from your quota request\n template.

" } }, "com.amazonaws.servicequotas#DeleteServiceQuotaIncreaseRequestFromTemplateRequest": { @@ -164,21 +174,21 @@ "ServiceCode": { "target": "com.amazonaws.servicequotas#ServiceCode", "traits": { - "smithy.api#documentation": "

Specifies the code for the service that you want to delete.

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

The service identifier.

", "smithy.api#required": {} } }, "QuotaCode": { "target": "com.amazonaws.servicequotas#QuotaCode", "traits": { - "smithy.api#documentation": "

Specifies the code for the quota that you want to delete.

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

The quota identifier.

", "smithy.api#required": {} } }, "AwsRegion": { "target": "com.amazonaws.servicequotas#AwsRegion", "traits": { - "smithy.api#documentation": "

Specifies the AWS Region for the quota that you want to delete.

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

The AWS Region.

", "smithy.api#required": {} } } @@ -236,7 +246,7 @@ } ], "traits": { - "smithy.api#documentation": "

Disables the Service Quotas template. Once the template is disabled, it does not request\n quota increases for new accounts in your organization. Disabling the quota template does not\n apply the quota increase requests from the template.

\n\n

\n Related operations\n

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

Disables your quota request template. After a template is disabled, the quota increase\n requests in the template are not applied to new accounts in your organization. Disabling a\n quota request template does not apply its quota increase requests.

" } }, "com.amazonaws.servicequotas#DisassociateServiceQuotaTemplateRequest": { @@ -279,18 +289,18 @@ "ErrorCode": { "target": "com.amazonaws.servicequotas#ErrorCode", "traits": { - "smithy.api#documentation": "

Service Quotas returns the following error values.\n

\n

\n DEPENDENCY_ACCESS_DENIED_ERROR is returned when the caller does not have\n permission to call the service or service quota. To resolve the error, you need permission to\n access the service or service quota.

\n

\n DEPENDENCY_THROTTLING_ERROR is returned when the service being called is\n throttling Service Quotas.

\n

\n DEPENDENCY_SERVICE_ERROR is returned when the service being called has\n availability issues.

\n

\n SERVICE_QUOTA_NOT_AVAILABLE_ERROR is returned when there was an error in\n Service Quotas.

" + "smithy.api#documentation": "

Service Quotas returns the following error values:

\n " } }, "ErrorMessage": { "target": "com.amazonaws.servicequotas#ErrorMessage", "traits": { - "smithy.api#documentation": "

The error message that provides more detail.

" + "smithy.api#documentation": "

The error message.

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

Returns an error that explains why the action did not succeed.

" + "smithy.api#documentation": "

An error that explains why an action did not succeed.

" } }, "com.amazonaws.servicequotas#ExceptionMessage": { @@ -322,7 +332,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves the default service quotas values. The Value returned for each quota is the AWS\n default value, even if the quotas have been increased..

" + "smithy.api#documentation": "

Retrieves the default value for the specified quota. The default value does not reflect\n any quota increases.

" } }, "com.amazonaws.servicequotas#GetAWSDefaultServiceQuotaRequest": { @@ -331,14 +341,14 @@ "ServiceCode": { "target": "com.amazonaws.servicequotas#ServiceCode", "traits": { - "smithy.api#documentation": "

Specifies the service that you want to use.

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

The service identifier.

", "smithy.api#required": {} } }, "QuotaCode": { "target": "com.amazonaws.servicequotas#QuotaCode", "traits": { - "smithy.api#documentation": "

Identifies the service quota you want to select.

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

The quota identifier.

", "smithy.api#required": {} } } @@ -350,7 +360,7 @@ "Quota": { "target": "com.amazonaws.servicequotas#ServiceQuota", "traits": { - "smithy.api#documentation": "

Returns the ServiceQuota object which contains all values for a\n quota.

" + "smithy.api#documentation": "

Information about the quota.

" } } } @@ -390,7 +400,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves the ServiceQuotaTemplateAssociationStatus value from the service.\n Use this action to determine if the Service Quota template is associated, or enabled.

" + "smithy.api#documentation": "

Retrieves the status of the association for the quota request template.

" } }, "com.amazonaws.servicequotas#GetAssociationForServiceQuotaTemplateRequest": { @@ -403,7 +413,7 @@ "ServiceQuotaTemplateAssociationStatus": { "target": "com.amazonaws.servicequotas#ServiceQuotaTemplateAssociationStatus", "traits": { - "smithy.api#documentation": "

Specifies whether the template is ASSOCIATED or DISASSOCIATED.\n If the template is ASSOCIATED, then it requests service quota increases for all\n new accounts created in your organization.

" + "smithy.api#documentation": "

The association status. If the status is ASSOCIATED, the quota increase\n requests in the template are automatically applied to new accounts in your\n organization.

" } } } @@ -434,7 +444,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves the details for a particular increase request.

" + "smithy.api#documentation": "

Retrieves information about the specified quota increase request.

" } }, "com.amazonaws.servicequotas#GetRequestedServiceQuotaChangeRequest": { @@ -443,7 +453,7 @@ "RequestId": { "target": "com.amazonaws.servicequotas#RequestId", "traits": { - "smithy.api#documentation": "

Identifies the quota increase request.

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

The ID of the quota increase request.

", "smithy.api#required": {} } } @@ -455,7 +465,7 @@ "RequestedQuota": { "target": "com.amazonaws.servicequotas#RequestedServiceQuotaChange", "traits": { - "smithy.api#documentation": "

Returns the RequestedServiceQuotaChange object for the specific increase\n request.

" + "smithy.api#documentation": "

Information about the quota increase request.

" } } } @@ -486,7 +496,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns the details for the specified service quota. This operation provides a different\n Value than the GetAWSDefaultServiceQuota operation. This operation returns the\n applied value for each quota. GetAWSDefaultServiceQuota returns the default AWS\n value for each quota.

" + "smithy.api#documentation": "

Retrieves the applied quota value for the specified quota. For some quotas, only the\n default values are available. If the applied quota value is not available for a quota, the\n quota is not retrieved.

" } }, "com.amazonaws.servicequotas#GetServiceQuotaIncreaseRequestFromTemplate": { @@ -527,7 +537,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns the details of the service quota increase request in your template.

" + "smithy.api#documentation": "

Retrieves information about the specified quota increase request in your quota request\n template.

" } }, "com.amazonaws.servicequotas#GetServiceQuotaIncreaseRequestFromTemplateRequest": { @@ -536,21 +546,21 @@ "ServiceCode": { "target": "com.amazonaws.servicequotas#ServiceCode", "traits": { - "smithy.api#documentation": "

Specifies the service that you want to use.

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

The service identifier.

", "smithy.api#required": {} } }, "QuotaCode": { "target": "com.amazonaws.servicequotas#QuotaCode", "traits": { - "smithy.api#documentation": "

Specifies the quota you want.

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

The quota identifier.

", "smithy.api#required": {} } }, "AwsRegion": { "target": "com.amazonaws.servicequotas#AwsRegion", "traits": { - "smithy.api#documentation": "

Specifies the AWS Region for the quota that you want to use.

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

The AWS Region.

", "smithy.api#required": {} } } @@ -562,7 +572,7 @@ "ServiceQuotaIncreaseRequestInTemplate": { "target": "com.amazonaws.servicequotas#ServiceQuotaIncreaseRequestInTemplate", "traits": { - "smithy.api#documentation": "

This object contains the details about the quota increase request.

" + "smithy.api#documentation": "

Information about the quota increase request.

" } } } @@ -573,14 +583,14 @@ "ServiceCode": { "target": "com.amazonaws.servicequotas#ServiceCode", "traits": { - "smithy.api#documentation": "

Specifies the service that you want to use.

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

The service identifier.

", "smithy.api#required": {} } }, "QuotaCode": { "target": "com.amazonaws.servicequotas#QuotaCode", "traits": { - "smithy.api#documentation": "

Identifies the service quota you want to select.

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

The quota identifier.

", "smithy.api#required": {} } } @@ -592,7 +602,7 @@ "Quota": { "target": "com.amazonaws.servicequotas#ServiceQuota", "traits": { - "smithy.api#documentation": "

Returns the ServiceQuota object which contains all values for a\n quota.

" + "smithy.api#documentation": "

Information about the quota.

" } } } @@ -608,11 +618,28 @@ } }, "traits": { - "smithy.api#documentation": "

Invalid input was provided.

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

Invalid input was provided.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, + "com.amazonaws.servicequotas#InputTagKeys": { + "type": "list", + "member": { + "target": "com.amazonaws.servicequotas#TagKey" + } + }, + "com.amazonaws.servicequotas#InputTags": { + "type": "list", + "member": { + "target": "com.amazonaws.servicequotas#Tag" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, "com.amazonaws.servicequotas#InvalidPaginationTokenException": { "type": "structure", "members": { @@ -634,7 +661,7 @@ } }, "traits": { - "smithy.api#documentation": "

Invalid input was provided for the .

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

The resource is in an invalid state.

", "smithy.api#error": "client", "smithy.api#httpError": 405 } @@ -668,7 +695,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists all default service quotas for the specified AWS service or all AWS services.\n ListAWSDefaultServiceQuotas is similar to ListServiceQuotas except for the\n Value object. The Value object returned by ListAWSDefaultServiceQuotas is the\n default value assigned by AWS. This request returns a list of all service quotas for the\n specified service. The listing of each you'll see the default values are the values that AWS\n provides for the quotas.

\n \n

Always check the NextToken response parameter when calling any of the\n List* operations. These operations can return an unexpected list of results,\n even when there are more results available. When this happens, the NextToken\n response parameter contains a value to pass the next call to the same API to request the\n next part of the list.

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

Lists the default values for the quotas for the specified AWS service. A default value\n does not reflect any quota increases.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -683,20 +710,20 @@ "ServiceCode": { "target": "com.amazonaws.servicequotas#ServiceCode", "traits": { - "smithy.api#documentation": "

Specifies the service that you want to use.

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

The service identifier.

", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.servicequotas#NextToken", "traits": { - "smithy.api#documentation": "

(Optional) Use this parameter in a request if you receive a NextToken\n response in a previous request that indicates that there's more output available. In a\n subsequent call, set it to the value of the previous call's NextToken response to\n indicate where the output should continue from. If additional items exist beyond the specified\n maximum, the NextToken element is present and has a value (isn't null). Include\n that value as the NextToken request parameter in the call to the operation to get\n the next part of the results. You should check NextToken after every operation to\n ensure that you receive all of the results.

" + "smithy.api#documentation": "

The token for the next page of results.

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

(Optional) Limits the number of results that you want to include in the response. If you\n don't include this parameter, the response defaults to a value that's specific to the\n operation. If additional items exist beyond the specified maximum, the NextToken\n element is present and has a value (isn't null). Include that value as the\n NextToken request parameter in the call to the operation to get the next part\n of the results. You should check NextToken after every operation to ensure that\n you receive all of the results.

" + "smithy.api#documentation": "

The maximum number of results to return with a single call. To retrieve the remaining\n results, if any, make another call with the token returned from this call.

" } } } @@ -707,13 +734,13 @@ "NextToken": { "target": "com.amazonaws.servicequotas#NextToken", "traits": { - "smithy.api#documentation": "

(Optional) Use this parameter in a request if you receive a NextToken\n response in a previous request that indicates that there's more output available. In a\n subsequent call, set it to the value of the previous call's NextToken response to\n indicate where the output should continue from.

" + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are\n no more results to return.

" } }, "Quotas": { "target": "com.amazonaws.servicequotas#ServiceQuotaListDefinition", "traits": { - "smithy.api#documentation": "

A list of the quotas in the account with the AWS default values.

" + "smithy.api#documentation": "

Information about the quotas.

" } } } @@ -747,7 +774,7 @@ } ], "traits": { - "smithy.api#documentation": "

Requests a list of the changes to quotas for a service.

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

Retrieves the quota increase requests for the specified service.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -785,7 +812,7 @@ } ], "traits": { - "smithy.api#documentation": "

Requests a list of the changes to specific service quotas. This command provides\n additional granularity over the ListRequestedServiceQuotaChangeHistory command.\n Once a quota change request has reached CASE_CLOSED, APPROVED, or\n DENIED, the history has been kept for 90 days.

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

Retrieves the quota increase requests for the specified quota.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -800,33 +827,33 @@ "ServiceCode": { "target": "com.amazonaws.servicequotas#ServiceCode", "traits": { - "smithy.api#documentation": "

Specifies the service that you want to use.

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

The service identifier.

", "smithy.api#required": {} } }, "QuotaCode": { "target": "com.amazonaws.servicequotas#QuotaCode", "traits": { - "smithy.api#documentation": "

Specifies the service quota that you want to use

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

The quota identifier.

", "smithy.api#required": {} } }, "Status": { "target": "com.amazonaws.servicequotas#RequestStatus", "traits": { - "smithy.api#documentation": "

Specifies the status value of the quota increase request.

" + "smithy.api#documentation": "

The status value of the quota increase request.

" } }, "NextToken": { "target": "com.amazonaws.servicequotas#NextToken", "traits": { - "smithy.api#documentation": "

(Optional) Use this parameter in a request if you receive a NextToken\n response in a previous request that indicates that there's more output available. In a\n subsequent call, set it to the value of the previous call's NextToken response to\n indicate where the output should continue from.

" + "smithy.api#documentation": "

The token for the next page of results.

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

(Optional) Limits the number of results that you want to include in the response. If you\n don't include this parameter, the response defaults to a value that's specific to the\n operation. If additional items exist beyond the specified maximum, the NextToken\n element is present and has a value (isn't null). Include that value as the\n NextToken request parameter in the call to the operation to get the next part\n of the results. You should check NextToken after every operation to ensure that\n you receive all of the results.

" + "smithy.api#documentation": "

The maximum number of results to return with a single call. To retrieve the remaining\n results, if any, make another call with the token returned from this call.

" } } } @@ -837,13 +864,13 @@ "NextToken": { "target": "com.amazonaws.servicequotas#NextToken", "traits": { - "smithy.api#documentation": "

If present in the response, this value indicates there's more output available that what's\n included in the current response. This can occur even when the response includes no values at\n all, such as when you ask for a filtered view of a very long list. Use this value in the\n NextToken request parameter in a subsequent call to the operation to continue\n processing and get the next part of the output. You should repeat this until the\n NextToken response element comes back empty (as null).

" + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are\n no more results to return.

" } }, "RequestedQuotas": { "target": "com.amazonaws.servicequotas#RequestedServiceQuotaChangeHistoryListDefinition", "traits": { - "smithy.api#documentation": "

Returns a list of service quota requests.

" + "smithy.api#documentation": "

Information about the quota increase requests.

" } } } @@ -854,25 +881,25 @@ "ServiceCode": { "target": "com.amazonaws.servicequotas#ServiceCode", "traits": { - "smithy.api#documentation": "

Specifies the service that you want to use.

" + "smithy.api#documentation": "

The service identifier.

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

Specifies the status value of the quota increase request.

" + "smithy.api#documentation": "

The status of the quota increase request.

" } }, "NextToken": { "target": "com.amazonaws.servicequotas#NextToken", "traits": { - "smithy.api#documentation": "

(Optional) Use this parameter in a request if you receive a NextToken\n response in a previous request that indicates that there's more output available. In a\n subsequent call, set it to the value of the previous call's NextToken response to\n indicate where the output should continue from.

" + "smithy.api#documentation": "

The token for the next page of results.

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

(Optional) Limits the number of results that you want to include in the response. If you\n don't include this parameter, the response defaults to a value that's specific to the\n operation. If additional items exist beyond the specified maximum, the NextToken\n element is present and has a value (isn't null). Include that value as the\n NextToken request parameter in the call to the operation to get the next part\n of the results. You should check NextToken after every operation to ensure that\n you receive all of the results.

" + "smithy.api#documentation": "

The maximum number of results to return with a single call. To retrieve the remaining\n results, if any, make another call with the token returned from this call.

" } } } @@ -883,13 +910,13 @@ "NextToken": { "target": "com.amazonaws.servicequotas#NextToken", "traits": { - "smithy.api#documentation": "

If present in the response, this value indicates there's more output available that what's\n included in the current response. This can occur even when the response includes no values at\n all, such as when you ask for a filtered view of a very long list. Use this value in the\n NextToken request parameter in a subsequent call to the operation to continue\n processing and get the next part of the output. You should repeat this until the\n NextToken response element comes back empty (as null).

" + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are\n no more results to return.

" } }, "RequestedQuotas": { "target": "com.amazonaws.servicequotas#RequestedServiceQuotaChangeHistoryListDefinition", "traits": { - "smithy.api#documentation": "

Returns a list of service quota requests.

" + "smithy.api#documentation": "

Information about the quota increase requests.

" } } } @@ -929,7 +956,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of the quota increase requests in the template.

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

Lists the quota increase requests in the specified quota request template.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -944,25 +971,25 @@ "ServiceCode": { "target": "com.amazonaws.servicequotas#ServiceCode", "traits": { - "smithy.api#documentation": "

The identifier for a service. When performing an operation, use the\n ServiceCode to specify a particular service.

" + "smithy.api#documentation": "

The service identifier.

" } }, "AwsRegion": { "target": "com.amazonaws.servicequotas#AwsRegion", "traits": { - "smithy.api#documentation": "

Specifies the AWS Region for the quota that you want to use.

" + "smithy.api#documentation": "

The AWS Region.

" } }, "NextToken": { "target": "com.amazonaws.servicequotas#NextToken", "traits": { - "smithy.api#documentation": "

(Optional) Use this parameter in a request if you receive a NextToken\n response in a previous request that indicates that there's more output available. In a\n subsequent call, set it to the value of the previous call's NextToken response to\n indicate where the output should continue from.

" + "smithy.api#documentation": "

The token for the next page of results.

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

(Optional) Limits the number of results that you want to include in the response. If you\n don't include this parameter, the response defaults to a value that's specific to the\n operation. If additional items exist beyond the specified maximum, the NextToken\n element is present and has a value (isn't null). Include that value as the\n NextToken request parameter in the call to the operation to get the next part\n of the results. You should check NextToken after every operation to ensure that\n you receive all of the results.

" + "smithy.api#documentation": "

The maximum number of results to return with a single call. To retrieve the remaining\n results, if any, make another call with the token returned from this call.

" } } } @@ -973,13 +1000,13 @@ "ServiceQuotaIncreaseRequestInTemplateList": { "target": "com.amazonaws.servicequotas#ServiceQuotaIncreaseRequestInTemplateList", "traits": { - "smithy.api#documentation": "

Returns the list of values of the quota increase request in the template.

" + "smithy.api#documentation": "

Information about the quota increase requests.

" } }, "NextToken": { "target": "com.amazonaws.servicequotas#NextToken", "traits": { - "smithy.api#documentation": "

If present in the response, this value indicates there's more output available that what's\n included in the current response. This can occur even when the response includes no values at\n all, such as when you ask for a filtered view of a very long list. Use this value in the\n NextToken request parameter in a subsequent call to the operation to continue\n processing and get the next part of the output. You should repeat this until the\n NextToken response element comes back empty (as null).

" + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are\n no more results to return.

" } } } @@ -1013,7 +1040,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists all service quotas for the specified AWS service. This request returns a list of the\n service quotas for the specified service. you'll see the default values are the values that\n AWS provides for the quotas.

\n \n

Always check the NextToken response parameter when calling any of the\n List* operations. These operations can return an unexpected list of results,\n even when there are more results available. When this happens, the NextToken\n response parameter contains a value to pass the next call to the same API to request the\n next part of the list.

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

Lists the applied quota values for the specified AWS service. For some quotas, only the\n default values are available. If the applied quota value is not available for a quota, the\n quota is not retrieved.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -1028,20 +1055,20 @@ "ServiceCode": { "target": "com.amazonaws.servicequotas#ServiceCode", "traits": { - "smithy.api#documentation": "

The identifier for a service. When performing an operation, use the\n ServiceCode to specify a particular service.

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

The service identifier.

", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.servicequotas#NextToken", "traits": { - "smithy.api#documentation": "

(Optional) Use this parameter in a request if you receive a NextToken\n response in a previous request that indicates that there's more output available. In a\n subsequent call, set it to the value of the previous call's NextToken response to\n indicate where the output should continue from.

" + "smithy.api#documentation": "

The token for the next page of results.

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

(Optional) Limits the number of results that you want to include in the response. If you\n don't include this parameter, the response defaults to a value that's specific to the\n operation. If additional items exist beyond the specified maximum, the NextToken\n element is present and has a value (isn't null). Include that value as the\n NextToken request parameter in the call to the operation to get the next part\n of the results. You should check NextToken after every operation to ensure that\n you receive all of the results.

" + "smithy.api#documentation": "

The maximum number of results to return with a single call. To retrieve the remaining\n results, if any, make another call with the token returned from this call.

" } } } @@ -1052,13 +1079,13 @@ "NextToken": { "target": "com.amazonaws.servicequotas#NextToken", "traits": { - "smithy.api#documentation": "

If present in the response, this value indicates there's more output available that what's\n included in the current response. This can occur even when the response includes no values at\n all, such as when you ask for a filtered view of a very long list. Use this value in the\n NextToken request parameter in a subsequent call to the operation to continue\n processing and get the next part of the output. You should repeat this until the\n NextToken response element comes back empty (as null).

" + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are\n no more results to return.

" } }, "Quotas": { "target": "com.amazonaws.servicequotas#ServiceQuotaListDefinition", "traits": { - "smithy.api#documentation": "

The response information for a quota lists all attribute information for the quota.\n

" + "smithy.api#documentation": "

Information about the quotas.

" } } } @@ -1089,7 +1116,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the AWS services available in Service Quotas. Not all AWS services are available in\n Service Quotas. To list the see the list of the service quotas for a specific service, use\n ListServiceQuotas.

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

Lists the names and codes for the services integrated with Service Quotas.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -1104,13 +1131,13 @@ "NextToken": { "target": "com.amazonaws.servicequotas#NextToken", "traits": { - "smithy.api#documentation": "

(Optional) Use this parameter in a request if you receive a NextToken\n response in a previous request that indicates that there's more output available. In a\n subsequent call, set it to the value of the previous call's NextToken response to\n indicate where the output should continue from.

" + "smithy.api#documentation": "

The token for the next page of results.

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

(Optional) Limits the number of results that you want to include in the response. If you\n don't include this parameter, the response defaults to a value that's specific to the\n operation. If additional items exist beyond the specified maximum, the NextToken\n element is present and has a value (isn't null). Include that value as the\n NextToken request parameter in the call to the operation to get the next part\n of the results. You should check NextToken after every operation to ensure that\n you receive all of the results.

" + "smithy.api#documentation": "

The maximum number of results to return with a single call. To retrieve the remaining\n results, if any, make another call with the token returned from this call.

" } } } @@ -1121,13 +1148,65 @@ "NextToken": { "target": "com.amazonaws.servicequotas#NextToken", "traits": { - "smithy.api#documentation": "

If present in the response, this value indicates there's more output available that what's\n included in the current response. This can occur even when the response includes no values at\n all, such as when you ask for a filtered view of a very long list. Use this value in the\n NextToken request parameter in a subsequent call to the operation to continue\n processing and get the next part of the output. You should repeat this until the\n NextToken response element comes back empty (as null).

" + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are\n no more results to return.

" } }, "Services": { "target": "com.amazonaws.servicequotas#ServiceInfoListDefinition", "traits": { - "smithy.api#documentation": "

Returns a list of services.

" + "smithy.api#documentation": "

Information about the services.

" + } + } + } + }, + "com.amazonaws.servicequotas#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.servicequotas#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.servicequotas#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.servicequotas#AccessDeniedException" + }, + { + "target": "com.amazonaws.servicequotas#IllegalArgumentException" + }, + { + "target": "com.amazonaws.servicequotas#NoSuchResourceException" + }, + { + "target": "com.amazonaws.servicequotas#ServiceException" + }, + { + "target": "com.amazonaws.servicequotas#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of the tags assigned to the specified applied quota.

" + } + }, + "com.amazonaws.servicequotas#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "ResourceARN": { + "target": "com.amazonaws.servicequotas#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the applied quota for which you want to list tags. You\n can get this information by using the Service Quotas console, or by listing the quotas using the\n list-service-quotas AWS CLI command or the ListServiceQuotas AWS API operation.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.servicequotas#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "Tags": { + "target": "com.amazonaws.servicequotas#OutputTags", + "traits": { + "smithy.api#documentation": "

A complex data type that contains zero or more tag elements.

" } } } @@ -1169,30 +1248,30 @@ "MetricNamespace": { "target": "com.amazonaws.servicequotas#QuotaMetricNamespace", "traits": { - "smithy.api#documentation": "

The namespace of the metric. The namespace is a container for CloudWatch metrics. You can\n specify a name for the namespace when you create a metric.

" + "smithy.api#documentation": "

The namespace of the metric.

" } }, "MetricName": { "target": "com.amazonaws.servicequotas#QuotaMetricName", "traits": { - "smithy.api#documentation": "

The name of the CloudWatch metric that measures usage of a service quota. This is a\n required field.

" + "smithy.api#documentation": "

The name of the metric.

" } }, "MetricDimensions": { "target": "com.amazonaws.servicequotas#MetricDimensionsMapDefinition", "traits": { - "smithy.api#documentation": "

A dimension is a name/value pair that is part of the identity of a metric. Every metric\n has specific characteristics that describe it, and you can think of dimensions as categories\n for those characteristics. These dimensions are part of the CloudWatch Metric Identity that\n measures usage against a particular service quota.

" + "smithy.api#documentation": "

The metric dimension. This is a name/value pair that is part of the identity of a\n metric.

" } }, "MetricStatisticRecommendation": { "target": "com.amazonaws.servicequotas#Statistic", "traits": { - "smithy.api#documentation": "

Statistics are metric data aggregations over specified periods of time. This is the\n recommended statistic to use when comparing usage in the CloudWatch Metric against your\n Service Quota.

" + "smithy.api#documentation": "

The metric statistic that we recommend you use when determining quota usage.

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

A structure that uses CloudWatch metrics to gather data about the service quota.

" + "smithy.api#documentation": "

Information about the CloudWatch metric that reflects quota usage.

" } }, "com.amazonaws.servicequotas#NextToken": { @@ -1239,11 +1318,23 @@ } }, "traits": { - "smithy.api#documentation": "

The organization that your account belongs to, is not in All Features mode. To enable all\n features mode, see EnableAllFeatures.

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

The organization that your account belongs to is not in All Features mode.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, + "com.amazonaws.servicequotas#OutputTags": { + "type": "list", + "member": { + "target": "com.amazonaws.servicequotas#Tag" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, "com.amazonaws.servicequotas#PeriodUnit": { "type": "string", "traits": { @@ -1326,7 +1417,7 @@ } ], "traits": { - "smithy.api#documentation": "

Defines and adds a quota to the service quota template. To add a quota to the template,\n you must provide the ServiceCode, QuotaCode, AwsRegion,\n and DesiredValue. Once you add a quota to the template, use ListServiceQuotaIncreaseRequestsInTemplate to see the list of quotas in the\n template.

" + "smithy.api#documentation": "

Adds a quota increase request to your quota request template.

" } }, "com.amazonaws.servicequotas#PutServiceQuotaIncreaseRequestIntoTemplateRequest": { @@ -1335,28 +1426,28 @@ "QuotaCode": { "target": "com.amazonaws.servicequotas#QuotaCode", "traits": { - "smithy.api#documentation": "

Specifies the service quota that you want to use.

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

The quota identifier.

", "smithy.api#required": {} } }, "ServiceCode": { "target": "com.amazonaws.servicequotas#ServiceCode", "traits": { - "smithy.api#documentation": "

Specifies the service that you want to use.

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

The service identifier.

", "smithy.api#required": {} } }, "AwsRegion": { "target": "com.amazonaws.servicequotas#AwsRegion", "traits": { - "smithy.api#documentation": "

Specifies the AWS Region for the quota.

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

The AWS Region.

", "smithy.api#required": {} } }, "DesiredValue": { "target": "com.amazonaws.servicequotas#QuotaValue", "traits": { - "smithy.api#documentation": "

Specifies the new, increased value for the quota.

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

The new, increased value for the quota.

", "smithy.api#required": {} } } @@ -1368,7 +1459,7 @@ "ServiceQuotaIncreaseRequestInTemplate": { "target": "com.amazonaws.servicequotas#ServiceQuotaIncreaseRequestInTemplate", "traits": { - "smithy.api#documentation": "

A structure that contains information about one service quota increase request.

" + "smithy.api#documentation": "

Information about the quota increase request.

" } } } @@ -1417,18 +1508,18 @@ "PeriodValue": { "target": "com.amazonaws.servicequotas#PeriodValue", "traits": { - "smithy.api#documentation": "

The value of a period.

" + "smithy.api#documentation": "

The value.

" } }, "PeriodUnit": { "target": "com.amazonaws.servicequotas#PeriodUnit", "traits": { - "smithy.api#documentation": "

The time unit of a period.

" + "smithy.api#documentation": "

The time unit.

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

A structure that contains information about the quota period.

" + "smithy.api#documentation": "

Information about the quota period.

" } }, "com.amazonaws.servicequotas#QuotaUnit": { @@ -1492,7 +1583,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves the details of a service quota increase request. The response to this command\n provides the details in the RequestedServiceQuotaChange object.

" + "smithy.api#documentation": "

Submits a quota increase request for the specified quota.

" } }, "com.amazonaws.servicequotas#RequestServiceQuotaIncreaseRequest": { @@ -1501,21 +1592,21 @@ "ServiceCode": { "target": "com.amazonaws.servicequotas#ServiceCode", "traits": { - "smithy.api#documentation": "

Specifies the service that you want to use.

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

The service identifier.

", "smithy.api#required": {} } }, "QuotaCode": { "target": "com.amazonaws.servicequotas#QuotaCode", "traits": { - "smithy.api#documentation": "

Specifies the service quota that you want to use.

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

The quota identifier.

", "smithy.api#required": {} } }, "DesiredValue": { "target": "com.amazonaws.servicequotas#QuotaValue", "traits": { - "smithy.api#documentation": "

Specifies the value submitted in the service quota increase request.

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

The new, increased value for the quota.

", "smithy.api#required": {} } } @@ -1527,7 +1618,7 @@ "RequestedQuota": { "target": "com.amazonaws.servicequotas#RequestedServiceQuotaChange", "traits": { - "smithy.api#documentation": "

Returns a list of service quota requests.

" + "smithy.api#documentation": "

Information about the quota increase request.

" } } } @@ -1565,90 +1656,90 @@ "Id": { "target": "com.amazonaws.servicequotas#RequestId", "traits": { - "smithy.api#documentation": "

The unique identifier of a requested service quota change.

" + "smithy.api#documentation": "

The unique identifier.

" } }, "CaseId": { "target": "com.amazonaws.servicequotas#CustomerServiceEngagementId", "traits": { - "smithy.api#documentation": "

The case Id for the service quota increase request.

" + "smithy.api#documentation": "

The case ID.

" } }, "ServiceCode": { "target": "com.amazonaws.servicequotas#ServiceCode", "traits": { - "smithy.api#documentation": "

Specifies the service that you want to use.

" + "smithy.api#documentation": "

The service identifier.

" } }, "ServiceName": { "target": "com.amazonaws.servicequotas#ServiceName", "traits": { - "smithy.api#documentation": "

The name of the AWS service specified in the increase request.

" + "smithy.api#documentation": "

The service name.

" } }, "QuotaCode": { "target": "com.amazonaws.servicequotas#QuotaCode", "traits": { - "smithy.api#documentation": "

Specifies the service quota that you want to use.

" + "smithy.api#documentation": "

The quota identifier.

" } }, "QuotaName": { "target": "com.amazonaws.servicequotas#QuotaName", "traits": { - "smithy.api#documentation": "

Name of the service quota.

" + "smithy.api#documentation": "

The quota name.

" } }, "DesiredValue": { "target": "com.amazonaws.servicequotas#QuotaValue", "traits": { - "smithy.api#documentation": "

New increased value for the service quota.

" + "smithy.api#documentation": "

The new, increased value for the quota.

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

State of the service quota increase request.

" + "smithy.api#documentation": "

The state of the quota increase request.

" } }, "Created": { "target": "com.amazonaws.servicequotas#DateTime", "traits": { - "smithy.api#documentation": "

The date and time when the service quota increase request was received and the case Id was\n created.

" + "smithy.api#documentation": "

The date and time when the quota increase request was received and the case ID was\n created.

" } }, "LastUpdated": { "target": "com.amazonaws.servicequotas#DateTime", "traits": { - "smithy.api#documentation": "

The date and time of the most recent change in the service quota increase request.

" + "smithy.api#documentation": "

The date and time of the most recent change.

" } }, "Requester": { "target": "com.amazonaws.servicequotas#Requester", "traits": { - "smithy.api#documentation": "

The IAM identity who submitted the service quota increase request.

" + "smithy.api#documentation": "

The IAM identity of the requester.

" } }, "QuotaArn": { "target": "com.amazonaws.servicequotas#QuotaArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the service quota.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the quota.

" } }, "GlobalQuota": { "target": "com.amazonaws.servicequotas#GlobalQuota", "traits": { - "smithy.api#documentation": "

Identifies if the quota is global.

" + "smithy.api#documentation": "

Indicates whether the quota is global.

" } }, "Unit": { "target": "com.amazonaws.servicequotas#QuotaUnit", "traits": { - "smithy.api#documentation": "

Specifies the unit used for the quota.

" + "smithy.api#documentation": "

The unit of measurement.

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

A structure that contains information about a requested change for a quota.

" + "smithy.api#documentation": "

Information about a quota increase request.

" } }, "com.amazonaws.servicequotas#RequestedServiceQuotaChangeHistoryListDefinition": { @@ -1691,7 +1782,7 @@ } }, "traits": { - "smithy.api#documentation": "

Something went wrong.

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

Something went wrong.

", "smithy.api#error": "server", "smithy.api#httpError": 500 } @@ -1702,18 +1793,18 @@ "ServiceCode": { "target": "com.amazonaws.servicequotas#ServiceCode", "traits": { - "smithy.api#documentation": "

Specifies the service that you want to use.

" + "smithy.api#documentation": "

The service identifier.

" } }, "ServiceName": { "target": "com.amazonaws.servicequotas#ServiceName", "traits": { - "smithy.api#documentation": "

The name of the AWS service specified in the increase request.

" + "smithy.api#documentation": "

The service name.

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

A structure that contains the ServiceName and ServiceCode. It\n does not include all details of the service quota. To get those values, use the ListServiceQuotas operation.

" + "smithy.api#documentation": "

Information about a service.

" } }, "com.amazonaws.servicequotas#ServiceInfoListDefinition": { @@ -1731,78 +1822,78 @@ "ServiceCode": { "target": "com.amazonaws.servicequotas#ServiceCode", "traits": { - "smithy.api#documentation": "

Specifies the service that you want to use.

" + "smithy.api#documentation": "

The service identifier.

" } }, "ServiceName": { "target": "com.amazonaws.servicequotas#ServiceName", "traits": { - "smithy.api#documentation": "

The name of the AWS service specified in the increase request.

" + "smithy.api#documentation": "

The service name.

" } }, "QuotaArn": { "target": "com.amazonaws.servicequotas#QuotaArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the service quota.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the quota.

" } }, "QuotaCode": { "target": "com.amazonaws.servicequotas#QuotaCode", "traits": { - "smithy.api#documentation": "

The code identifier for the service quota specified.

" + "smithy.api#documentation": "

The quota identifier.

" } }, "QuotaName": { "target": "com.amazonaws.servicequotas#QuotaName", "traits": { - "smithy.api#documentation": "

The name identifier of the service quota.

" + "smithy.api#documentation": "

The quota name.

" } }, "Value": { "target": "com.amazonaws.servicequotas#QuotaValue", "traits": { - "smithy.api#documentation": "

The value of service quota.

" + "smithy.api#documentation": "

The quota value.

" } }, "Unit": { "target": "com.amazonaws.servicequotas#QuotaUnit", "traits": { - "smithy.api#documentation": "

The unit of measurement for the value of the service quota.

" + "smithy.api#documentation": "

The unit of measurement.

" } }, "Adjustable": { "target": "com.amazonaws.servicequotas#QuotaAdjustable", "traits": { - "smithy.api#documentation": "

Specifies if the quota value can be increased.

" + "smithy.api#documentation": "

Indicates whether the quota value can be increased.

" } }, "GlobalQuota": { "target": "com.amazonaws.servicequotas#GlobalQuota", "traits": { - "smithy.api#documentation": "

Specifies if the quota is global.

" + "smithy.api#documentation": "

Indicates whether the quota is global.

" } }, "UsageMetric": { "target": "com.amazonaws.servicequotas#MetricInfo", "traits": { - "smithy.api#documentation": "

Specifies the details about the measurement.

" + "smithy.api#documentation": "

Information about the measurement.

" } }, "Period": { "target": "com.amazonaws.servicequotas#QuotaPeriod", "traits": { - "smithy.api#documentation": "

Identifies the unit and value of how time is measured.

" + "smithy.api#documentation": "

The period of time.

" } }, "ErrorReason": { "target": "com.amazonaws.servicequotas#ErrorReason", "traits": { - "smithy.api#documentation": "

Specifies the ErrorCode and ErrorMessage when success isn't\n achieved.

" + "smithy.api#documentation": "

The error code and error reason.

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

A structure that contains the full set of details that define the service quota.

" + "smithy.api#documentation": "

Information about a quota.

" } }, "com.amazonaws.servicequotas#ServiceQuotaIncreaseRequestInTemplate": { @@ -1811,54 +1902,54 @@ "ServiceCode": { "target": "com.amazonaws.servicequotas#ServiceCode", "traits": { - "smithy.api#documentation": "

The code identifier for the AWS service specified in the increase request.

" + "smithy.api#documentation": "

The service identifier.

" } }, "ServiceName": { "target": "com.amazonaws.servicequotas#ServiceName", "traits": { - "smithy.api#documentation": "

The name of the AWS service specified in the increase request.

" + "smithy.api#documentation": "

The service name.

" } }, "QuotaCode": { "target": "com.amazonaws.servicequotas#QuotaCode", "traits": { - "smithy.api#documentation": "

The code identifier for the service quota specified in the increase request.

" + "smithy.api#documentation": "

The quota identifier.

" } }, "QuotaName": { "target": "com.amazonaws.servicequotas#QuotaName", "traits": { - "smithy.api#documentation": "

The name of the service quota in the increase request.

" + "smithy.api#documentation": "

The quota name.

" } }, "DesiredValue": { "target": "com.amazonaws.servicequotas#QuotaValue", "traits": { - "smithy.api#documentation": "

Identifies the new, increased value of the service quota in the increase request.

" + "smithy.api#documentation": "

The new, increased value of the quota.

" } }, "AwsRegion": { "target": "com.amazonaws.servicequotas#AwsRegion", "traits": { - "smithy.api#documentation": "

The AWS Region where the increase request occurs.

" + "smithy.api#documentation": "

The AWS Region.

" } }, "Unit": { "target": "com.amazonaws.servicequotas#QuotaUnit", "traits": { - "smithy.api#documentation": "

The unit of measure for the increase request.

" + "smithy.api#documentation": "

The unit of measurement.

" } }, "GlobalQuota": { "target": "com.amazonaws.servicequotas#GlobalQuota", "traits": { - "smithy.api#documentation": "

Specifies if the quota is a global quota.

" + "smithy.api#documentation": "

Indicates whether the quota is global.

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

A structure that contains information about one service quota increase request.

" + "smithy.api#documentation": "

Information about a quota increase request.

" } }, "com.amazonaws.servicequotas#ServiceQuotaIncreaseRequestInTemplateList": { @@ -1896,7 +1987,7 @@ } }, "traits": { - "smithy.api#documentation": "

The quota request template is not associated with your organization.

\n

To use the template, call AssociateServiceQuotaTemplate.

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

The quota request template is not associated with your organization.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -1947,11 +2038,20 @@ { "target": "com.amazonaws.servicequotas#ListServices" }, + { + "target": "com.amazonaws.servicequotas#ListTagsForResource" + }, { "target": "com.amazonaws.servicequotas#PutServiceQuotaIncreaseRequestIntoTemplate" }, { "target": "com.amazonaws.servicequotas#RequestServiceQuotaIncrease" + }, + { + "target": "com.amazonaws.servicequotas#TagResource" + }, + { + "target": "com.amazonaws.servicequotas#UntagResource" } ], "traits": { @@ -1966,7 +2066,7 @@ "name": "servicequotas" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "

Service Quotas is a web service that you can use to manage many of your AWS service\n quotas. Quotas, also referred to as limits, are the maximum values for a resource, item, or\n operation. This guide provide descriptions of the Service Quotas actions that you can call\n from an API. For the Service Quotas user guide, which explains how to use Service Quotas from\n the console, see What is Service Quotas.

\n\n \n

AWS provides SDKs that consist of libraries and sample code for programming languages\n and platforms (Java, Ruby, .NET, iOS, Android, etc...,). The SDKs provide a convenient way\n to create programmatic access to Service Quotas and AWS. For information about the AWS SDKs,\n including how to download and install them, see the Tools for Amazon Web Services page.

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

With Service Quotas, you can view and manage your quotas easily as your AWS workloads\n grow. Quotas, also referred to as limits, are the maximum number of resources that you can\n create in your AWS account. For more information, see the Service Quotas User Guide.

", "smithy.api#title": "Service Quotas" } }, @@ -1980,6 +2080,119 @@ "smithy.api#pattern": "(Sum|Maximum)" } }, + "com.amazonaws.servicequotas#Tag": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.servicequotas#TagKey", + "traits": { + "smithy.api#documentation": "

A string that contains a tag key. The string length should be between 1 and 128\n characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . :\n / = + @.

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

A string that contains an optional tag value. The string length should be between 0 and\n 256 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ -\n . : / = + @.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex data type that contains a tag key and tag value.

" + } + }, + "com.amazonaws.servicequotas#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + } + }, + "com.amazonaws.servicequotas#TagPolicyViolationException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.servicequotas#ExceptionMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The specified tag is a reserved word and cannot be used.

", + "smithy.api#error": "client", + "smithy.api#httpError": 401 + } + }, + "com.amazonaws.servicequotas#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.servicequotas#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.servicequotas#TagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.servicequotas#AccessDeniedException" + }, + { + "target": "com.amazonaws.servicequotas#IllegalArgumentException" + }, + { + "target": "com.amazonaws.servicequotas#NoSuchResourceException" + }, + { + "target": "com.amazonaws.servicequotas#ServiceException" + }, + { + "target": "com.amazonaws.servicequotas#TagPolicyViolationException" + }, + { + "target": "com.amazonaws.servicequotas#TooManyRequestsException" + }, + { + "target": "com.amazonaws.servicequotas#TooManyTagsException" + } + ], + "traits": { + "smithy.api#documentation": "

Adds tags to the specified applied quota. You can include one or more tags to add to the\n quota.

" + } + }, + "com.amazonaws.servicequotas#TagResourceRequest": { + "type": "structure", + "members": { + "ResourceARN": { + "target": "com.amazonaws.servicequotas#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the applied quota. You can get this information by\n using the Service Quotas console, or by listing the quotas using the list-service-quotas AWS CLI command or the ListServiceQuotas AWS API operation.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.servicequotas#InputTags", + "traits": { + "smithy.api#documentation": "

The tags that you want to add to the resource.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.servicequotas#TagResourceResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.servicequotas#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + } + }, "com.amazonaws.servicequotas#TemplatesNotAvailableInRegionException": { "type": "structure", "members": { @@ -1988,7 +2201,7 @@ } }, "traits": { - "smithy.api#documentation": "

The Service Quotas template is not available in the Region where you are making the\n request. Please make the request in us-east-1.

", + "smithy.api#documentation": "

The Service Quotas template is not available in this AWS Region.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } @@ -2001,10 +2214,75 @@ } }, "traits": { - "smithy.api#documentation": "

Due to throttling, the request was denied. Slow down the rate of request calls, or request\n an increase for this quota.

", + "smithy.api#documentation": "

Due to throttling, the request was denied. Slow down the rate of request calls, or request\n an increase for this quota.

", "smithy.api#error": "client", "smithy.api#httpError": 429 } + }, + "com.amazonaws.servicequotas#TooManyTagsException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.servicequotas#ExceptionMessage" + } + }, + "traits": { + "smithy.api#documentation": "

You've exceeded the number of tags allowed for a resource. For more information, see\n Tag\n restrictions in the Service Quotas User Guide.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.servicequotas#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.servicequotas#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.servicequotas#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.servicequotas#AccessDeniedException" + }, + { + "target": "com.amazonaws.servicequotas#IllegalArgumentException" + }, + { + "target": "com.amazonaws.servicequotas#NoSuchResourceException" + }, + { + "target": "com.amazonaws.servicequotas#ServiceException" + }, + { + "target": "com.amazonaws.servicequotas#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes tags from the specified applied quota. You can specify one or more tags to\n remove.

" + } + }, + "com.amazonaws.servicequotas#UntagResourceRequest": { + "type": "structure", + "members": { + "ResourceARN": { + "target": "com.amazonaws.servicequotas#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the applied quota that you want to untag. You can get\n this information by using the Service Quotas console, or by listing the quotas using the list-service-quotas AWS CLI command or the ListServiceQuotas AWS API operation.

", + "smithy.api#required": {} + } + }, + "TagKeys": { + "target": "com.amazonaws.servicequotas#InputTagKeys", + "traits": { + "smithy.api#documentation": "

The keys of the tags that you want to remove from the resource.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.servicequotas#UntagResourceResponse": { + "type": "structure", + "members": {} } } } diff --git a/codegen/sdk-codegen/aws-models/ses.2010-12-01.json b/codegen/sdk-codegen/aws-models/ses.2010-12-01.json index eac6769e867..23ae728032a 100644 --- a/codegen/sdk-codegen/aws-models/ses.2010-12-01.json +++ b/codegen/sdk-codegen/aws-models/ses.2010-12-01.json @@ -2704,10 +2704,12 @@ "traits": { "smithy.api#enum": [ { - "value": "EmailAddress" + "value": "EmailAddress", + "name": "EmailAddress" }, { - "value": "Domain" + "value": "Domain", + "name": "Domain" } ] } @@ -2954,10 +2956,12 @@ "traits": { "smithy.api#enum": [ { - "value": "Event" + "value": "Event", + "name": "Event" }, { - "value": "RequestResponse" + "value": "RequestResponse", + "name": "RequestResponse" } ] } @@ -3579,13 +3583,16 @@ "traits": { "smithy.api#enum": [ { - "value": "Bounce" + "value": "Bounce", + "name": "Bounce" }, { - "value": "Complaint" + "value": "Complaint", + "name": "Complaint" }, { - "value": "Delivery" + "value": "Delivery", + "name": "Delivery" } ] } @@ -6081,19 +6088,24 @@ "traits": { "smithy.api#enum": [ { - "value": "Pending" + "value": "Pending", + "name": "Pending" }, { - "value": "Success" + "value": "Success", + "name": "Success" }, { - "value": "Failed" + "value": "Failed", + "name": "Failed" }, { - "value": "TemporaryFailure" + "value": "TemporaryFailure", + "name": "TemporaryFailure" }, { - "value": "NotStarted" + "value": "NotStarted", + "name": "NotStarted" } ] } diff --git a/codegen/sdk-codegen/aws-models/sfn.2016-11-23.json b/codegen/sdk-codegen/aws-models/sfn.2016-11-23.json index 01c1d7214d6..b83e7268f52 100644 --- a/codegen/sdk-codegen/aws-models/sfn.2016-11-23.json +++ b/codegen/sdk-codegen/aws-models/sfn.2016-11-23.json @@ -1167,19 +1167,24 @@ "traits": { "smithy.api#enum": [ { - "value": "RUNNING" + "value": "RUNNING", + "name": "RUNNING" }, { - "value": "SUCCEEDED" + "value": "SUCCEEDED", + "name": "SUCCEEDED" }, { - "value": "FAILED" + "value": "FAILED", + "name": "FAILED" }, { - "value": "TIMED_OUT" + "value": "TIMED_OUT", + "name": "TIMED_OUT" }, { - "value": "ABORTED" + "value": "ABORTED", + "name": "ABORTED" } ] } @@ -1572,169 +1577,224 @@ "traits": { "smithy.api#enum": [ { - "value": "ActivityFailed" + "value": "ActivityFailed", + "name": "ActivityFailed" }, { - "value": "ActivityScheduled" + "value": "ActivityScheduled", + "name": "ActivityScheduled" }, { - "value": "ActivityScheduleFailed" + "value": "ActivityScheduleFailed", + "name": "ActivityScheduleFailed" }, { - "value": "ActivityStarted" + "value": "ActivityStarted", + "name": "ActivityStarted" }, { - "value": "ActivitySucceeded" + "value": "ActivitySucceeded", + "name": "ActivitySucceeded" }, { - "value": "ActivityTimedOut" + "value": "ActivityTimedOut", + "name": "ActivityTimedOut" }, { - "value": "ChoiceStateEntered" + "value": "ChoiceStateEntered", + "name": "ChoiceStateEntered" }, { - "value": "ChoiceStateExited" + "value": "ChoiceStateExited", + "name": "ChoiceStateExited" }, { - "value": "ExecutionAborted" + "value": "ExecutionAborted", + "name": "ExecutionAborted" }, { - "value": "ExecutionFailed" + "value": "ExecutionFailed", + "name": "ExecutionFailed" }, { - "value": "ExecutionStarted" + "value": "ExecutionStarted", + "name": "ExecutionStarted" }, { - "value": "ExecutionSucceeded" + "value": "ExecutionSucceeded", + "name": "ExecutionSucceeded" }, { - "value": "ExecutionTimedOut" + "value": "ExecutionTimedOut", + "name": "ExecutionTimedOut" }, { - "value": "FailStateEntered" + "value": "FailStateEntered", + "name": "FailStateEntered" }, { - "value": "LambdaFunctionFailed" + "value": "LambdaFunctionFailed", + "name": "LambdaFunctionFailed" }, { - "value": "LambdaFunctionScheduled" + "value": "LambdaFunctionScheduled", + "name": "LambdaFunctionScheduled" }, { - "value": "LambdaFunctionScheduleFailed" + "value": "LambdaFunctionScheduleFailed", + "name": "LambdaFunctionScheduleFailed" }, { - "value": "LambdaFunctionStarted" + "value": "LambdaFunctionStarted", + "name": "LambdaFunctionStarted" }, { - "value": "LambdaFunctionStartFailed" + "value": "LambdaFunctionStartFailed", + "name": "LambdaFunctionStartFailed" }, { - "value": "LambdaFunctionSucceeded" + "value": "LambdaFunctionSucceeded", + "name": "LambdaFunctionSucceeded" }, { - "value": "LambdaFunctionTimedOut" + "value": "LambdaFunctionTimedOut", + "name": "LambdaFunctionTimedOut" }, { - "value": "MapIterationAborted" + "value": "MapIterationAborted", + "name": "MapIterationAborted" }, { - "value": "MapIterationFailed" + "value": "MapIterationFailed", + "name": "MapIterationFailed" }, { - "value": "MapIterationStarted" + "value": "MapIterationStarted", + "name": "MapIterationStarted" }, { - "value": "MapIterationSucceeded" + "value": "MapIterationSucceeded", + "name": "MapIterationSucceeded" }, { - "value": "MapStateAborted" + "value": "MapStateAborted", + "name": "MapStateAborted" }, { - "value": "MapStateEntered" + "value": "MapStateEntered", + "name": "MapStateEntered" }, { - "value": "MapStateExited" + "value": "MapStateExited", + "name": "MapStateExited" }, { - "value": "MapStateFailed" + "value": "MapStateFailed", + "name": "MapStateFailed" }, { - "value": "MapStateStarted" + "value": "MapStateStarted", + "name": "MapStateStarted" }, { - "value": "MapStateSucceeded" + "value": "MapStateSucceeded", + "name": "MapStateSucceeded" }, { - "value": "ParallelStateAborted" + "value": "ParallelStateAborted", + "name": "ParallelStateAborted" }, { - "value": "ParallelStateEntered" + "value": "ParallelStateEntered", + "name": "ParallelStateEntered" }, { - "value": "ParallelStateExited" + "value": "ParallelStateExited", + "name": "ParallelStateExited" }, { - "value": "ParallelStateFailed" + "value": "ParallelStateFailed", + "name": "ParallelStateFailed" }, { - "value": "ParallelStateStarted" + "value": "ParallelStateStarted", + "name": "ParallelStateStarted" }, { - "value": "ParallelStateSucceeded" + "value": "ParallelStateSucceeded", + "name": "ParallelStateSucceeded" }, { - "value": "PassStateEntered" + "value": "PassStateEntered", + "name": "PassStateEntered" }, { - "value": "PassStateExited" + "value": "PassStateExited", + "name": "PassStateExited" }, { - "value": "SucceedStateEntered" + "value": "SucceedStateEntered", + "name": "SucceedStateEntered" }, { - "value": "SucceedStateExited" + "value": "SucceedStateExited", + "name": "SucceedStateExited" }, { - "value": "TaskFailed" + "value": "TaskFailed", + "name": "TaskFailed" }, { - "value": "TaskScheduled" + "value": "TaskScheduled", + "name": "TaskScheduled" }, { - "value": "TaskStarted" + "value": "TaskStarted", + "name": "TaskStarted" }, { - "value": "TaskStartFailed" + "value": "TaskStartFailed", + "name": "TaskStartFailed" }, { - "value": "TaskStateAborted" + "value": "TaskStateAborted", + "name": "TaskStateAborted" }, { - "value": "TaskStateEntered" + "value": "TaskStateEntered", + "name": "TaskStateEntered" }, { - "value": "TaskStateExited" + "value": "TaskStateExited", + "name": "TaskStateExited" }, { - "value": "TaskSubmitFailed" + "value": "TaskSubmitFailed", + "name": "TaskSubmitFailed" }, { - "value": "TaskSubmitted" + "value": "TaskSubmitted", + "name": "TaskSubmitted" }, { - "value": "TaskSucceeded" + "value": "TaskSucceeded", + "name": "TaskSucceeded" }, { - "value": "TaskTimedOut" + "value": "TaskTimedOut", + "name": "TaskTimedOut" }, { - "value": "WaitStateAborted" + "value": "WaitStateAborted", + "name": "WaitStateAborted" }, { - "value": "WaitStateEntered" + "value": "WaitStateEntered", + "name": "WaitStateEntered" }, { - "value": "WaitStateExited" + "value": "WaitStateExited", + "name": "WaitStateExited" } ] } @@ -2259,16 +2319,20 @@ "traits": { "smithy.api#enum": [ { - "value": "ALL" + "value": "ALL", + "name": "ALL" }, { - "value": "ERROR" + "value": "ERROR", + "name": "ERROR" }, { - "value": "FATAL" + "value": "FATAL", + "name": "FATAL" }, { - "value": "OFF" + "value": "OFF", + "name": "OFF" } ] } @@ -2956,10 +3020,12 @@ "traits": { "smithy.api#enum": [ { - "value": "ACTIVE" + "value": "ACTIVE", + "name": "ACTIVE" }, { - "value": "DELETING" + "value": "DELETING", + "name": "DELETING" } ] } @@ -2969,10 +3035,12 @@ "traits": { "smithy.api#enum": [ { - "value": "STANDARD" + "value": "STANDARD", + "name": "STANDARD" }, { - "value": "EXPRESS" + "value": "EXPRESS", + "name": "EXPRESS" } ] } @@ -3050,13 +3118,16 @@ "traits": { "smithy.api#enum": [ { - "value": "SUCCEEDED" + "value": "SUCCEEDED", + "name": "SUCCEEDED" }, { - "value": "FAILED" + "value": "FAILED", + "name": "FAILED" }, { - "value": "TIMED_OUT" + "value": "TIMED_OUT", + "name": "TIMED_OUT" } ] } diff --git a/codegen/sdk-codegen/aws-models/signer.2017-08-25.json b/codegen/sdk-codegen/aws-models/signer.2017-08-25.json index 627ddd5bd62..2f11a6669ab 100644 --- a/codegen/sdk-codegen/aws-models/signer.2017-08-25.json +++ b/codegen/sdk-codegen/aws-models/signer.2017-08-25.json @@ -226,7 +226,8 @@ "traits": { "smithy.api#enum": [ { - "value": "AWSIoT" + "value": "AWSIoT", + "name": "AWSIoT" } ] } @@ -471,10 +472,12 @@ "traits": { "smithy.api#enum": [ { - "value": "RSA" + "value": "RSA", + "name": "RSA" }, { - "value": "ECDSA" + "value": "ECDSA", + "name": "ECDSA" } ] } @@ -755,10 +758,12 @@ "traits": { "smithy.api#enum": [ { - "value": "SHA1" + "value": "SHA1", + "name": "SHA1" }, { - "value": "SHA256" + "value": "SHA256", + "name": "SHA256" } ] } @@ -796,13 +801,16 @@ "traits": { "smithy.api#enum": [ { - "value": "JSON" + "value": "JSON", + "name": "JSON" }, { - "value": "JSONEmbedded" + "value": "JSONEmbedded", + "name": "JSONEmbedded" }, { - "value": "JSONDetached" + "value": "JSONDetached", + "name": "JSONDetached" } ] } @@ -2240,13 +2248,16 @@ "traits": { "smithy.api#enum": [ { - "value": "Active" + "value": "Active", + "name": "Active" }, { - "value": "Canceled" + "value": "Canceled", + "name": "Canceled" }, { - "value": "Revoked" + "value": "Revoked", + "name": "Revoked" } ] } @@ -2262,13 +2273,16 @@ "traits": { "smithy.api#enum": [ { - "value": "InProgress" + "value": "InProgress", + "name": "InProgress" }, { - "value": "Failed" + "value": "Failed", + "name": "Failed" }, { - "value": "Succeeded" + "value": "Succeeded", + "name": "Succeeded" } ] } @@ -2609,13 +2623,16 @@ "traits": { "smithy.api#enum": [ { - "value": "DAYS" + "value": "DAYS", + "name": "DAYS" }, { - "value": "MONTHS" + "value": "MONTHS", + "name": "MONTHS" }, { - "value": "YEARS" + "value": "YEARS", + "name": "YEARS" } ] } diff --git a/codegen/sdk-codegen/aws-models/sqs.2012-11-05.json b/codegen/sdk-codegen/aws-models/sqs.2012-11-05.json index b7f5e5d9897..0239dff2474 100644 --- a/codegen/sdk-codegen/aws-models/sqs.2012-11-05.json +++ b/codegen/sdk-codegen/aws-models/sqs.2012-11-05.json @@ -52,7 +52,7 @@ } ], "traits": { - "smithy.api#documentation": "

Adds a permission to a queue for a specific \n principal.\n This allows sharing access to the queue.

\n

When you create a queue, you have full control access rights for the queue.\n Only you, the owner of the queue, can grant or deny permissions to the queue.\n For more information about these permissions, see\n Allow \n Developers to Write Messages to a Shared Queue in the Amazon Simple Queue Service Developer Guide.

\n \n \n \n

Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:

\n

\n &AttributeName.1=first\n

\n

\n &AttributeName.2=second\n

\n \n

Cross-account permissions don't apply to this action. For more information, see Grant Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue Service Developer Guide.

\n " + "smithy.api#documentation": "

Adds a permission to a queue for a specific \n principal.\n This allows sharing access to the queue.

\n

When you create a queue, you have full control access rights for the queue.\n Only you, the owner of the queue, can grant or deny permissions to the queue.\n For more information about these permissions, see\n Allow \n Developers to Write Messages to a Shared Queue in the Amazon Simple Queue Service Developer Guide.

\n \n \n \n

Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:

\n

\n &AttributeName.1=first\n

\n

\n &AttributeName.2=second\n

\n \n

Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a user name in the Amazon Simple Queue Service Developer Guide.

\n " } }, "com.amazonaws.sqs#AddPermissionRequest": { @@ -456,7 +456,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new standard or FIFO queue. You can pass one or more attributes in\n the request. Keep the following in mind:

\n \n\n

To successfully create a new queue, you must provide a queue name that adheres to the limits related to queues and is unique within the scope of your queues.

\n \n

After you create a queue, you must wait at least one second after the queue is\n created to be able to use the queue.

\n \n

To get the queue URL, use the \n GetQueueUrl\n action. \n GetQueueUrl\n requires only the QueueName parameter.\n be aware of existing queue names:

\n \n

Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:

\n

\n &AttributeName.1=first\n

\n

\n &AttributeName.2=second\n

\n \n

Cross-account permissions don't apply to this action. For more information, see Grant Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue Service Developer Guide.

\n " + "smithy.api#documentation": "

Creates a new standard or FIFO queue. You can pass one or more attributes in\n the request. Keep the following in mind:

\n \n\n

To successfully create a new queue, you must provide a queue name that adheres to the limits related to queues and is unique within the scope of your queues.

\n \n

After you create a queue, you must wait at least one second after the queue is\n created to be able to use the queue.

\n \n

To get the queue URL, use the \n GetQueueUrl\n action. \n GetQueueUrl\n requires only the QueueName parameter.\n be aware of existing queue names:

\n \n

Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:

\n

\n &AttributeName.1=first\n

\n

\n &AttributeName.2=second\n

\n \n

Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a user name in the Amazon Simple Queue Service Developer Guide.

\n " } }, "com.amazonaws.sqs#CreateQueueRequest": { @@ -472,7 +472,7 @@ "tags": { "target": "com.amazonaws.sqs#TagMap", "traits": { - "smithy.api#documentation": "

Add cost allocation tags to the specified Amazon SQS queue. For an overview, see Tagging Your Amazon SQS Queues in the Amazon Simple Queue Service Developer Guide.

\n \n

When you use queue tags, keep the following guidelines in mind:

\n \n

For a full list of tag restrictions, see Limits Related to Queues in the Amazon Simple Queue Service Developer Guide.

\n \n

To be able to tag a queue on creation, you must have the\n sqs:CreateQueue and sqs:TagQueue permissions.

\n

Cross-account permissions don't apply to this action. For more information, see Grant Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue Service Developer Guide.

\n ", + "smithy.api#documentation": "

Add cost allocation tags to the specified Amazon SQS queue. For an overview, see Tagging Your Amazon SQS Queues in the Amazon Simple Queue Service Developer Guide.

\n \n

When you use queue tags, keep the following guidelines in mind:

\n \n

For a full list of tag restrictions, see Limits Related to Queues in the Amazon Simple Queue Service Developer Guide.

\n \n

To be able to tag a queue on creation, you must have the\n sqs:CreateQueue and sqs:TagQueue permissions.

\n

Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a user name in the Amazon Simple Queue Service Developer Guide.

\n ", "smithy.api#xmlFlattened": {}, "smithy.api#xmlName": "Tag" } @@ -480,7 +480,7 @@ "Attributes": { "target": "com.amazonaws.sqs#QueueAttributeMap", "traits": { - "smithy.api#documentation": "

A map of attributes with their corresponding values.

\n

The following lists the names, descriptions, and values of the special request parameters that the CreateQueue action uses:

\n \n \n

The following attributes apply only to server-side-encryption:

\n \n \n \n

The following attributes apply only to FIFO (first-in-first-out) queues:

\n ", + "smithy.api#documentation": "

A map of attributes with their corresponding values.

\n

The following lists the names, descriptions, and values of the special request parameters that the CreateQueue action uses:

\n \n \n

The following attributes apply only to server-side-encryption:

\n \n \n \n

The following attributes apply only to FIFO (first-in-first-out) queues:

\n \n \n \n

\n Preview: High throughput for FIFO queues\n

\n

\n High throughput for Amazon SQS FIFO queues is in preview release and is subject to change. \n This feature provides a high number of transactions per second (TPS) for messages in FIFO queues. For information on throughput quotas, \n see Quotas related to messages \n in the Amazon Simple Queue Service Developer Guide.

\n

This preview includes two new attributes:

\n \n

To enable high throughput for FIFO queues, do the following:

\n \n

If you set these attributes to anything other than the values shown for enabling high\n throughput, standard throughput is in effect and deduplication occurs as specified.

\n

This preview is available in the following AWS Regions:

\n \n

For more information about high throughput for FIFO queues, \n see Preview: \n High throughput for FIFO queues in the Amazon Simple Queue Service Developer Guide.

", "smithy.api#xmlFlattened": {}, "smithy.api#xmlName": "Attribute" } @@ -674,7 +674,7 @@ "target": "com.amazonaws.sqs#DeleteQueueRequest" }, "traits": { - "smithy.api#documentation": "

Deletes the queue specified by the QueueUrl, regardless of the queue's contents.

\n \n

Be careful with the DeleteQueue action: When you delete a queue, any messages in the queue are no longer available.\n

\n \n

When you delete a queue, the deletion process takes up to 60 seconds. Requests you send involving that queue during the 60 seconds might succeed. For example, a \n \n SendMessage\n request might succeed, but after 60 seconds the queue and the message you sent no longer exist.

\n

When you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.

\n \n

Cross-account permissions don't apply to this action. For more information, see Grant Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue Service Developer Guide.

\n " + "smithy.api#documentation": "

Deletes the queue specified by the QueueUrl, regardless of the queue's contents.

\n \n

Be careful with the DeleteQueue action: When you delete a queue, any messages in the queue are no longer available.\n

\n \n

When you delete a queue, the deletion process takes up to 60 seconds. Requests you send involving that queue during the 60 seconds might succeed. For example, a \n \n SendMessage\n request might succeed, but after 60 seconds the queue and the message you sent no longer exist.

\n

When you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.

\n \n

Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a user name in the Amazon Simple Queue Service Developer Guide.

\n " } }, "com.amazonaws.sqs#DeleteQueueRequest": { @@ -731,7 +731,7 @@ "AttributeNames": { "target": "com.amazonaws.sqs#AttributeNameList", "traits": { - "smithy.api#documentation": "

A list of attributes for which to retrieve information.

\n \n

In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.

\n \n

The following attributes are supported:

\n \n

The ApproximateNumberOfMessagesDelayed, ApproximateNumberOfMessagesNotVisible, \n and ApproximateNumberOfMessagesVisible metrics may not achieve consistency\n until at least 1 minute after the producers stop sending messages. This period is required for \n the queue metadata to reach eventual consistency.

\n \n \n \n

The following attributes apply only to server-side-encryption:

\n \n \n \n

The following attributes apply only to FIFO (first-in-first-out) queues:

\n ", + "smithy.api#documentation": "

A list of attributes for which to retrieve information.

\n \n

In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.

\n \n

The following attributes are supported:

\n \n

The ApproximateNumberOfMessagesDelayed, ApproximateNumberOfMessagesNotVisible, \n and ApproximateNumberOfMessagesVisible metrics may not achieve consistency\n until at least 1 minute after the producers stop sending messages. This period is required for \n the queue metadata to reach eventual consistency.

\n \n \n \n

The following attributes apply only to server-side-encryption:

\n \n \n \n

The following attributes apply only to FIFO (first-in-first-out) queues:

\n \n \n \n

\n Preview: High throughput for FIFO queues\n

\n

\n High throughput for Amazon SQS FIFO queues is in preview release and is subject to change. \n This feature provides a high number of transactions per second (TPS) for messages in FIFO queues. For information on throughput quotas, \n see Quotas related to messages \n in the Amazon Simple Queue Service Developer Guide.

\n

This preview includes two new attributes:

\n \n

To enable high throughput for FIFO queues, do the following:

\n \n

If you set these attributes to anything other than the values shown for enabling high\n throughput, standard throughput is in effect and deduplication occurs as specified.

\n

This preview is available in the following AWS Regions:

\n \n

For more information about high throughput for FIFO queues, \n see Preview: \n High throughput for FIFO queues in the Amazon Simple Queue Service Developer Guide.

", "smithy.api#xmlFlattened": {}, "smithy.api#xmlName": "AttributeName" } @@ -927,7 +927,7 @@ "target": "com.amazonaws.sqs#ListQueueTagsResult" }, "traits": { - "smithy.api#documentation": "

List all cost allocation tags added to the specified Amazon SQS queue. For an overview, see Tagging Your Amazon SQS Queues in the Amazon Simple Queue Service Developer Guide.

\n \n

Cross-account permissions don't apply to this action. For more information, see Grant Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue Service Developer Guide.

\n " + "smithy.api#documentation": "

List all cost allocation tags added to the specified Amazon SQS queue. For an overview, see Tagging Your Amazon SQS Queues in the Amazon Simple Queue Service Developer Guide.

\n \n

Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a user name in the Amazon Simple Queue Service Developer Guide.

\n " } }, "com.amazonaws.sqs#ListQueueTagsRequest": { @@ -964,7 +964,7 @@ "target": "com.amazonaws.sqs#ListQueuesResult" }, "traits": { - "smithy.api#documentation": "

Returns a list of your queues in the current region. The response includes a maximum of 1,000 results. If you specify a value for the optional \n QueueNamePrefix parameter, only queues with a name that begins with the specified value are returned.

\n

The listQueues methods supports\n pagination. Set parameter MaxResults in the request to specify the maximum number of\n results to be returned in the response. If you do not set MaxResults,\n the response includes a maximum of 1,000 results. If you set MaxResults and there are additional results to\n display, the response includes a value for NextToken. Use\n NextToken as a parameter in your next request to\n listQueues to receive the next page of results.

\n \n

Cross-account permissions don't apply to this action. For more information, see Grant Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue Service Developer Guide.

\n ", + "smithy.api#documentation": "

Returns a list of your queues in the current region. The response includes a maximum of 1,000 results. If you specify a value for the optional \n QueueNamePrefix parameter, only queues with a name that begins with the specified value are returned.

\n

The listQueues methods supports\n pagination. Set parameter MaxResults in the request to specify the maximum number of\n results to be returned in the response. If you do not set MaxResults,\n the response includes a maximum of 1,000 results. If you set MaxResults and there are additional results to\n display, the response includes a value for NextToken. Use\n NextToken as a parameter in your next request to\n listQueues to receive the next page of results.

\n \n

Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a user name in the Amazon Simple Queue Service Developer Guide.

\n ", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -1192,28 +1192,36 @@ "traits": { "smithy.api#enum": [ { - "value": "SenderId" + "value": "SenderId", + "name": "SenderId" }, { - "value": "SentTimestamp" + "value": "SentTimestamp", + "name": "SentTimestamp" }, { - "value": "ApproximateReceiveCount" + "value": "ApproximateReceiveCount", + "name": "ApproximateReceiveCount" }, { - "value": "ApproximateFirstReceiveTimestamp" + "value": "ApproximateFirstReceiveTimestamp", + "name": "ApproximateFirstReceiveTimestamp" }, { - "value": "SequenceNumber" + "value": "SequenceNumber", + "name": "SequenceNumber" }, { - "value": "MessageDeduplicationId" + "value": "MessageDeduplicationId", + "name": "MessageDeduplicationId" }, { - "value": "MessageGroupId" + "value": "MessageGroupId", + "name": "MessageGroupId" }, { - "value": "AWSTraceHeader" + "value": "AWSTraceHeader", + "name": "AWSTraceHeader" } ] } @@ -1223,7 +1231,8 @@ "traits": { "smithy.api#enum": [ { - "value": "AWSTraceHeader" + "value": "AWSTraceHeader", + "name": "AWSTraceHeader" } ] } @@ -1341,58 +1350,84 @@ "traits": { "smithy.api#enum": [ { - "value": "All" + "value": "All", + "name": "All" }, { - "value": "Policy" + "value": "Policy", + "name": "Policy" }, { - "value": "VisibilityTimeout" + "value": "VisibilityTimeout", + "name": "VisibilityTimeout" }, { - "value": "MaximumMessageSize" + "value": "MaximumMessageSize", + "name": "MaximumMessageSize" }, { - "value": "MessageRetentionPeriod" + "value": "MessageRetentionPeriod", + "name": "MessageRetentionPeriod" }, { - "value": "ApproximateNumberOfMessages" + "value": "ApproximateNumberOfMessages", + "name": "ApproximateNumberOfMessages" }, { - "value": "ApproximateNumberOfMessagesNotVisible" + "value": "ApproximateNumberOfMessagesNotVisible", + "name": "ApproximateNumberOfMessagesNotVisible" }, { - "value": "CreatedTimestamp" + "value": "CreatedTimestamp", + "name": "CreatedTimestamp" }, { - "value": "LastModifiedTimestamp" + "value": "LastModifiedTimestamp", + "name": "LastModifiedTimestamp" }, { - "value": "QueueArn" + "value": "QueueArn", + "name": "QueueArn" }, { - "value": "ApproximateNumberOfMessagesDelayed" + "value": "ApproximateNumberOfMessagesDelayed", + "name": "ApproximateNumberOfMessagesDelayed" }, { - "value": "DelaySeconds" + "value": "DelaySeconds", + "name": "DelaySeconds" }, { - "value": "ReceiveMessageWaitTimeSeconds" + "value": "ReceiveMessageWaitTimeSeconds", + "name": "ReceiveMessageWaitTimeSeconds" }, { - "value": "RedrivePolicy" + "value": "RedrivePolicy", + "name": "RedrivePolicy" }, { - "value": "FifoQueue" + "value": "FifoQueue", + "name": "FifoQueue" }, { - "value": "ContentBasedDeduplication" + "value": "ContentBasedDeduplication", + "name": "ContentBasedDeduplication" }, { - "value": "KmsMasterKeyId" + "value": "KmsMasterKeyId", + "name": "KmsMasterKeyId" }, { - "value": "KmsDataKeyReusePeriodSeconds" + "value": "KmsDataKeyReusePeriodSeconds", + "name": "KmsDataKeyReusePeriodSeconds" + }, + { + "value": "DeduplicationScope", + "name": "DeduplicationScope" + }, + { + "value": "FifoThroughputLimit", + "name": "FifoThroughputLimit" } ] } @@ -1532,7 +1567,7 @@ "target": "com.amazonaws.sqs#RemovePermissionRequest" }, "traits": { - "smithy.api#documentation": "

Revokes any permissions in the queue policy that matches the specified Label parameter.

\n \n \n " + "smithy.api#documentation": "

Revokes any permissions in the queue policy that matches the specified Label parameter.

\n \n \n " } }, "com.amazonaws.sqs#RemovePermissionRequest": { @@ -1879,7 +1914,7 @@ } ], "traits": { - "smithy.api#documentation": "

Sets the value of one or more queue attributes. When you change a queue's attributes, the change can take up to 60 seconds for most of the attributes to propagate throughout the Amazon SQS system. \n Changes made to the MessageRetentionPeriod attribute can take up to 15 minutes.

\n \n \n " + "smithy.api#documentation": "

Sets the value of one or more queue attributes. When you change a queue's attributes, the change can take up to 60 seconds for most of the attributes to propagate throughout the Amazon SQS system. \n Changes made to the MessageRetentionPeriod attribute can take up to 15 minutes.

\n \n \n " } }, "com.amazonaws.sqs#SetQueueAttributesRequest": { @@ -1895,7 +1930,7 @@ "Attributes": { "target": "com.amazonaws.sqs#QueueAttributeMap", "traits": { - "smithy.api#documentation": "

A map of attributes to set.

\n

The following lists the names, descriptions, and values of the special request parameters that the SetQueueAttributes action uses:

\n \n \n

The following attributes apply only to server-side-encryption:

\n \n \n \n

The following attribute applies only to FIFO (first-in-first-out) queues:

\n ", + "smithy.api#documentation": "

A map of attributes to set.

\n

The following lists the names, descriptions, and values of the special request parameters that the SetQueueAttributes action uses:

\n \n \n

The following attributes apply only to server-side-encryption:

\n \n \n \n

The following attribute applies only to FIFO (first-in-first-out) queues:

\n \n \n \n

\n Preview: High throughput for FIFO queues\n

\n

\n High throughput for Amazon SQS FIFO queues is in preview release and is subject to change. \n This feature provides a high number of transactions per second (TPS) for messages in FIFO queues. For information on throughput quotas, \n see Quotas related to messages \n in the Amazon Simple Queue Service Developer Guide.

\n

This preview includes two new attributes:

\n \n

To enable high throughput for FIFO queues, do the following:

\n \n

If you set these attributes to anything other than the values shown for enabling high\n throughput, standard throughput is in effect and deduplication occurs as specified.

\n

This preview is available in the following AWS Regions:

\n \n

For more information about high throughput for FIFO queues, \n see Preview: \n High throughput for FIFO queues in the Amazon Simple Queue Service Developer Guide.

", "smithy.api#required": {}, "smithy.api#xmlFlattened": {}, "smithy.api#xmlName": "Attribute" @@ -1948,7 +1983,7 @@ "target": "com.amazonaws.sqs#TagQueueRequest" }, "traits": { - "smithy.api#documentation": "

Add cost allocation tags to the specified Amazon SQS queue. For an overview, see Tagging Your Amazon SQS Queues in the Amazon Simple Queue Service Developer Guide.

\n \n

When you use queue tags, keep the following guidelines in mind:

\n \n

For a full list of tag restrictions, see Limits Related to Queues in the Amazon Simple Queue Service Developer Guide.

\n \n

Cross-account permissions don't apply to this action. For more information, see Grant Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue Service Developer Guide.

\n " + "smithy.api#documentation": "

Add cost allocation tags to the specified Amazon SQS queue. For an overview, see Tagging Your Amazon SQS Queues in the Amazon Simple Queue Service Developer Guide.

\n \n

When you use queue tags, keep the following guidelines in mind:

\n \n

For a full list of tag restrictions, see Limits Related to Queues in the Amazon Simple Queue Service Developer Guide.

\n \n

Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a user name in the Amazon Simple Queue Service Developer Guide.

\n " } }, "com.amazonaws.sqs#TagQueueRequest": { @@ -2002,7 +2037,7 @@ "target": "com.amazonaws.sqs#UntagQueueRequest" }, "traits": { - "smithy.api#documentation": "

Remove cost allocation tags from the specified Amazon SQS queue. For an overview, see Tagging Your Amazon SQS Queues in the Amazon Simple Queue Service Developer Guide.

\n \n

Cross-account permissions don't apply to this action. For more information, see Grant Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue Service Developer Guide.

\n " + "smithy.api#documentation": "

Remove cost allocation tags from the specified Amazon SQS queue. For an overview, see Tagging Your Amazon SQS Queues in the Amazon Simple Queue Service Developer Guide.

\n \n

Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a user name in the Amazon Simple Queue Service Developer Guide.

\n " } }, "com.amazonaws.sqs#UntagQueueRequest": { diff --git a/codegen/sdk-codegen/aws-models/ssm.2014-11-06.json b/codegen/sdk-codegen/aws-models/ssm.2014-11-06.json index ffef417657a..f6c0669936a 100644 --- a/codegen/sdk-codegen/aws-models/ssm.2014-11-06.json +++ b/codegen/sdk-codegen/aws-models/ssm.2014-11-06.json @@ -558,6 +558,9 @@ { "target": "com.amazonaws.ssm#ListComplianceSummaries" }, + { + "target": "com.amazonaws.ssm#ListDocumentMetadataHistory" + }, { "target": "com.amazonaws.ssm#ListDocuments" }, @@ -567,6 +570,9 @@ { "target": "com.amazonaws.ssm#ListInventoryEntries" }, + { + "target": "com.amazonaws.ssm#ListOpsItemEvents" + }, { "target": "com.amazonaws.ssm#ListOpsMetadata" }, @@ -624,6 +630,9 @@ { "target": "com.amazonaws.ssm#StartAutomationExecution" }, + { + "target": "com.amazonaws.ssm#StartChangeRequestExecution" + }, { "target": "com.amazonaws.ssm#StartSession" }, @@ -645,6 +654,9 @@ { "target": "com.amazonaws.ssm#UpdateDocumentDefaultVersion" }, + { + "target": "com.amazonaws.ssm#UpdateDocumentMetadata" + }, { "target": "com.amazonaws.ssm#UpdateMaintenanceWindow" }, @@ -949,6 +961,12 @@ "traits": { "smithy.api#documentation": "

By default, when you create a new associations, the system runs it immediately after it is\n created and then according to the schedule you specified. Specify this option if you don't want\n an association to run immediately after you create it. This parameter is not supported for rate\n expressions.

" } + }, + "TargetLocations": { + "target": "com.amazonaws.ssm#TargetLocations", + "traits": { + "smithy.api#documentation": "

The combination of AWS Regions and AWS accounts where you want to run the\n association.

" + } } }, "traits": { @@ -1626,6 +1644,12 @@ "traits": { "smithy.api#documentation": "

By default, when you create a new associations, the system runs it immediately after it is\n created and then according to the schedule you specified. Specify this option if you don't want\n an association to run immediately after you create it. This parameter is not supported for rate\n expressions.

" } + }, + "TargetLocations": { + "target": "com.amazonaws.ssm#TargetLocations", + "traits": { + "smithy.api#documentation": "

The combination of AWS Regions and AWS accounts where you wanted to run the association when\n this association version was created.

" + } } }, "traits": { @@ -1862,6 +1886,18 @@ "smithy.api#pattern": "^aws:[a-zA-Z]{3,25}$" } }, + "com.amazonaws.ssm#AutomationDefinitionNotApprovedException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.ssm#String" + } + }, + "traits": { + "smithy.api#documentation": "

Indicates that the Change Manager change template used in the change request was rejected or is\n still in a pending state.

", + "smithy.api#error": "client" + } + }, "com.amazonaws.ssm#AutomationDefinitionNotFoundException": { "type": "structure", "members": { @@ -2038,6 +2074,42 @@ "traits": { "smithy.api#documentation": "

An aggregate of step execution statuses displayed in the AWS Console for a multi-Region and\n multi-account Automation execution.

" } + }, + "AutomationSubtype": { + "target": "com.amazonaws.ssm#AutomationSubtype", + "traits": { + "smithy.api#documentation": "

The subtype of the Automation operation. Currently, the only supported value is\n ChangeRequest.

" + } + }, + "ScheduledTime": { + "target": "com.amazonaws.ssm#DateTime", + "traits": { + "smithy.api#documentation": "

The date and time the Automation operation is scheduled to start.

" + } + }, + "Runbooks": { + "target": "com.amazonaws.ssm#Runbooks", + "traits": { + "smithy.api#documentation": "

Information about the Automation runbooks (Automation documents) that are run as part of a\n runbook workflow.

\n \n

The Automation runbooks specified for the runbook workflow can't run until all required\n approvals for the change request have been received.

\n " + } + }, + "OpsItemId": { + "target": "com.amazonaws.ssm#String", + "traits": { + "smithy.api#documentation": "

The ID of an OpsItem that is created to represent a Change Manager change request.

" + } + }, + "AssociationId": { + "target": "com.amazonaws.ssm#String", + "traits": { + "smithy.api#documentation": "

The ID of a State Manager association used in the Automation operation.

" + } + }, + "ChangeRequestName": { + "target": "com.amazonaws.ssm#ChangeRequestName", + "traits": { + "smithy.api#documentation": "

The name of the Change Manager change request.

" + } } }, "traits": { @@ -2109,6 +2181,14 @@ { "value": "TargetResourceGroup", "name": "TARGET_RESOURCE_GROUP" + }, + { + "value": "AutomationSubtype", + "name": "AUTOMATION_SUBTYPE" + }, + { + "value": "OpsItemId", + "name": "OPS_ITEM_ID" } ] } @@ -2301,6 +2381,42 @@ "traits": { "smithy.api#documentation": "

Use this filter with DescribeAutomationExecutions. Specify either Local or\n CrossAccount. CrossAccount is an Automation that runs in multiple AWS Regions and accounts. For\n more information, see Running Automation workflows in multiple AWS Regions and accounts in the\n AWS Systems Manager User Guide.

" } + }, + "AutomationSubtype": { + "target": "com.amazonaws.ssm#AutomationSubtype", + "traits": { + "smithy.api#documentation": "

The subtype of the Automation operation. Currently, the only supported value is\n ChangeRequest.

" + } + }, + "ScheduledTime": { + "target": "com.amazonaws.ssm#DateTime", + "traits": { + "smithy.api#documentation": "

The date and time the Automation operation is scheduled to start.

" + } + }, + "Runbooks": { + "target": "com.amazonaws.ssm#Runbooks", + "traits": { + "smithy.api#documentation": "

Information about the Automation runbooks (Automation documents) that are run during a\n runbook workflow in Change Manager.

\n \n

The Automation runbooks specified for the runbook workflow can't run until all required\n approvals for the change request have been received.

\n " + } + }, + "OpsItemId": { + "target": "com.amazonaws.ssm#String", + "traits": { + "smithy.api#documentation": "

The ID of an OpsItem that is created to represent a Change Manager change request.

" + } + }, + "AssociationId": { + "target": "com.amazonaws.ssm#String", + "traits": { + "smithy.api#documentation": "

The ID of a State Manager association used in the Automation operation.

" + } + }, + "ChangeRequestName": { + "target": "com.amazonaws.ssm#ChangeRequestName", + "traits": { + "smithy.api#documentation": "

The name of the Change Manager change request.

" + } } }, "traits": { @@ -2360,6 +2476,46 @@ { "value": "Failed", "name": "FAILED" + }, + { + "value": "PendingApproval", + "name": "PENDING_APPROVAL" + }, + { + "value": "Approved", + "name": "APPROVED" + }, + { + "value": "Rejected", + "name": "REJECTED" + }, + { + "value": "Scheduled", + "name": "SCHEDULED" + }, + { + "value": "RunbookInProgress", + "name": "RUNBOOK_INPROGRESS" + }, + { + "value": "PendingChangeCalendarOverride", + "name": "PENDING_CHANGE_CALENDAR_OVERRIDE" + }, + { + "value": "ChangeCalendarOverrideApproved", + "name": "CHANGE_CALENDAR_OVERRIDE_APPROVED" + }, + { + "value": "ChangeCalendarOverrideRejected", + "name": "CHANGE_CALENDAR_OVERRIDE_REJECTED" + }, + { + "value": "CompletedWithSuccess", + "name": "COMPLETED_WITH_SUCCESS" + }, + { + "value": "CompletedWithFailure", + "name": "COMPLETED_WITH_FAILURE" } ] } @@ -2421,6 +2577,17 @@ "smithy.api#error": "client" } }, + "com.amazonaws.ssm#AutomationSubtype": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ChangeRequest", + "name": "ChangeRequest" + } + ] + } + }, "com.amazonaws.ssm#AutomationTargetParameterName": { "type": "string", "traits": { @@ -2601,6 +2768,15 @@ } } }, + "com.amazonaws.ssm#ChangeRequestName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, "com.amazonaws.ssm#ClientToken": { "type": "string", "traits": { @@ -3994,6 +4170,12 @@ "traits": { "smithy.api#documentation": "

By default, when you create a new associations, the system runs it immediately after it is\n created and then according to the schedule you specified. Specify this option if you don't want\n an association to run immediately after you create it. This parameter is not supported for rate\n expressions.

" } + }, + "TargetLocations": { + "target": "com.amazonaws.ssm#TargetLocations", + "traits": { + "smithy.api#documentation": "

Use this action to create an association in multiple Regions and multiple accounts.

" + } } }, "traits": { @@ -4104,6 +4286,12 @@ "traits": { "smithy.api#documentation": "

By default, when you create a new associations, the system runs it immediately after it is\n created and then according to the schedule you specified. Specify this option if you don't want\n an association to run immediately after you create it. This parameter is not supported for rate\n expressions.

" } + }, + "TargetLocations": { + "target": "com.amazonaws.ssm#TargetLocations", + "traits": { + "smithy.api#documentation": "

A location is a combination of AWS Regions and AWS accounts where you want to run the\n association. Use this action to create an association in multiple Regions and multiple\n accounts.

" + } } } }, @@ -4283,14 +4471,14 @@ "ScheduleTimezone": { "target": "com.amazonaws.ssm#MaintenanceWindowTimezone", "traits": { - "smithy.api#documentation": "

The time zone that the scheduled maintenance window executions are based on, in Internet\n Assigned Numbers Authority (IANA) format. For example: \"America/Los_Angeles\", \"etc/UTC\", or\n \"Asia/Seoul\". For more information, see the Time\n Zone Database on the IANA website.

" + "smithy.api#documentation": "

The time zone that the scheduled maintenance window executions are based on, in Internet\n Assigned Numbers Authority (IANA) format. For example: \"America/Los_Angeles\", \"UTC\", or\n \"Asia/Seoul\". For more information, see the Time\n Zone Database on the IANA website.

" } }, "ScheduleOffset": { "target": "com.amazonaws.ssm#MaintenanceWindowOffset", "traits": { "smithy.api#box": {}, - "smithy.api#documentation": "

The number of days to wait after the date and time specified by a CRON expression before\n running the maintenance window.

\n

For example, the following cron expression schedules a maintenance window to run on the\n third Tuesday of every month at 11:30 PM.

\n

\n cron(0 30 23 ? * TUE#3 *)\n

\n

If the schedule offset is 2, the maintenance window won't run until two days\n later.

" + "smithy.api#documentation": "

The number of days to wait after the date and time specified by a CRON expression before\n running the maintenance window.

\n

For example, the following cron expression schedules a maintenance window to run on the\n third Tuesday of every month at 11:30 PM.

\n

\n cron(30 23 ? * TUE#3 *)\n

\n

If the schedule offset is 2, the maintenance window won't run until two days\n later.

" } }, "Duration": { @@ -4376,6 +4564,12 @@ "smithy.api#required": {} } }, + "OpsItemType": { + "target": "com.amazonaws.ssm#OpsItemType", + "traits": { + "smithy.api#documentation": "

The type of OpsItem to create. Currently, the only valid values are\n /aws/changerequest and /aws/issue.

" + } + }, "OperationalData": { "target": "com.amazonaws.ssm#OpsItemOperationalData", "traits": { @@ -4431,6 +4625,30 @@ "traits": { "smithy.api#documentation": "

Specify a severity to assign to an OpsItem.

" } + }, + "ActualStartTime": { + "target": "com.amazonaws.ssm#DateTime", + "traits": { + "smithy.api#documentation": "

The time a runbook workflow started. Currently reported only for the OpsItem type\n /aws/changerequest.

" + } + }, + "ActualEndTime": { + "target": "com.amazonaws.ssm#DateTime", + "traits": { + "smithy.api#documentation": "

The time a runbook workflow ended. Currently reported only for the OpsItem type\n /aws/changerequest.

" + } + }, + "PlannedStartTime": { + "target": "com.amazonaws.ssm#DateTime", + "traits": { + "smithy.api#documentation": "

The time specified in a change request for a runbook workflow to start. Currently supported\n only for the OpsItem type /aws/changerequest.

" + } + }, + "PlannedEndTime": { + "target": "com.amazonaws.ssm#DateTime", + "traits": { + "smithy.api#documentation": "

The time specified in a change request for a runbook workflow to end. Currently supported\n only for the OpsItem type /aws/changerequest.

" + } } } }, @@ -4471,7 +4689,7 @@ } ], "traits": { - "smithy.api#documentation": "

If you create a new application in AppManager, Systems Manager calls this API action to specify\n information about the new application, including the application type.

" + "smithy.api#documentation": "

If you create a new application in Application Manager, Systems Manager calls this API action to specify\n information about the new application, including the application type.

" } }, "com.amazonaws.ssm#CreateOpsMetadataRequest": { @@ -4480,14 +4698,14 @@ "ResourceId": { "target": "com.amazonaws.ssm#OpsMetadataResourceId", "traits": { - "smithy.api#documentation": "

A resource ID for a new AppManager application.

", + "smithy.api#documentation": "

A resource ID for a new Application Manager application.

", "smithy.api#required": {} } }, "Metadata": { "target": "com.amazonaws.ssm#MetadataMap", "traits": { - "smithy.api#documentation": "

Metadata for a new AppManager application.

" + "smithy.api#documentation": "

Metadata for a new Application Manager application.

" } } } @@ -7108,7 +7326,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the tasks in a maintenance window.

", + "smithy.api#documentation": "

Lists the tasks in a maintenance window.

\n \n \n

For maintenance window tasks without a specified target, you cannot supply values for\n --max-errors and --max-concurrency. Instead, the system inserts a\n placeholder value of 1, which may be reported in the response to this command.\n These values do not affect the running of your task and can be ignored.

\n ", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -7843,6 +8061,9 @@ "smithy.api#error": "client" } }, + "com.amazonaws.ssm#DocumentAuthor": { + "type": "string" + }, "com.amazonaws.ssm#DocumentContent": { "type": "string", "traits": { @@ -8011,6 +8232,36 @@ "traits": { "smithy.api#documentation": "

A list of SSM documents required by a document. For example, an\n ApplicationConfiguration document requires an\n ApplicationConfigurationSchema document.

" } + }, + "Author": { + "target": "com.amazonaws.ssm#DocumentAuthor", + "traits": { + "smithy.api#documentation": "

The user in your organization who created the document.

" + } + }, + "ReviewInformation": { + "target": "com.amazonaws.ssm#ReviewInformationList", + "traits": { + "smithy.api#documentation": "

Details about the review of a document.

" + } + }, + "ApprovedVersion": { + "target": "com.amazonaws.ssm#DocumentVersion", + "traits": { + "smithy.api#documentation": "

The version of the document currently approved for use in the organization.

" + } + }, + "PendingReviewVersion": { + "target": "com.amazonaws.ssm#DocumentVersion", + "traits": { + "smithy.api#documentation": "

The version of the document that is currently under review.

" + } + }, + "ReviewStatus": { + "target": "com.amazonaws.ssm#ReviewStatus", + "traits": { + "smithy.api#documentation": "

The current status of the review.

" + } } }, "traits": { @@ -8195,6 +8446,18 @@ "traits": { "smithy.api#documentation": "

A list of SSM documents required by a document. For example, an\n ApplicationConfiguration document requires an\n ApplicationConfigurationSchema document.

" } + }, + "ReviewStatus": { + "target": "com.amazonaws.ssm#ReviewStatus", + "traits": { + "smithy.api#documentation": "

The current status of a document review.

" + } + }, + "Author": { + "target": "com.amazonaws.ssm#DocumentAuthor", + "traits": { + "smithy.api#documentation": "

The user in your organization who created the document.

" + } } }, "traits": { @@ -8278,6 +8541,31 @@ "smithy.api#error": "client" } }, + "com.amazonaws.ssm#DocumentMetadataEnum": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "DocumentReviews", + "name": "DocumentReviews" + } + ] + } + }, + "com.amazonaws.ssm#DocumentMetadataResponseInfo": { + "type": "structure", + "members": { + "ReviewerResponse": { + "target": "com.amazonaws.ssm#DocumentReviewerResponseList", + "traits": { + "smithy.api#documentation": "

Details about a reviewer's response to a document review request.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about the response to a document review request.

" + } + }, "com.amazonaws.ssm#DocumentName": { "type": "string", "traits": { @@ -8342,10 +8630,12 @@ "traits": { "smithy.api#enum": [ { - "value": "String" + "value": "String", + "name": "String" }, { - "value": "StringList" + "value": "StringList", + "name": "StringList" } ] } @@ -8405,59 +8695,200 @@ } } }, - "com.amazonaws.ssm#DocumentSchemaVersion": { - "type": "string", - "traits": { - "smithy.api#pattern": "([0-9]+)\\.([0-9]+)" - } - }, - "com.amazonaws.ssm#DocumentSha1": { - "type": "string" - }, - "com.amazonaws.ssm#DocumentStatus": { + "com.amazonaws.ssm#DocumentReviewAction": { "type": "string", "traits": { - "smithy.api#documentation": "

The status of a document.

", "smithy.api#enum": [ { - "value": "Creating", - "name": "Creating" - }, - { - "value": "Active", - "name": "Active" + "value": "SendForReview", + "name": "SendForReview" }, { - "value": "Updating", - "name": "Updating" + "value": "UpdateReview", + "name": "UpdateReview" }, { - "value": "Deleting", - "name": "Deleting" + "value": "Approve", + "name": "Approve" }, { - "value": "Failed", - "name": "Failed" + "value": "Reject", + "name": "Reject" } ] } }, - "com.amazonaws.ssm#DocumentStatusInformation": { - "type": "string" + "com.amazonaws.ssm#DocumentReviewComment": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^(?!\\s*$).+" + } }, - "com.amazonaws.ssm#DocumentType": { + "com.amazonaws.ssm#DocumentReviewCommentList": { + "type": "list", + "member": { + "target": "com.amazonaws.ssm#DocumentReviewCommentSource" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.ssm#DocumentReviewCommentSource": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.ssm#DocumentReviewCommentType", + "traits": { + "smithy.api#documentation": "

The type of information added to a review request. Currently, only the value\n Comment is supported.

" + } + }, + "Content": { + "target": "com.amazonaws.ssm#DocumentReviewComment", + "traits": { + "smithy.api#documentation": "

The content of a comment entered by a user who requests a review of a new document version,\n or who reviews the new version.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about comments added to a document review request.

" + } + }, + "com.amazonaws.ssm#DocumentReviewCommentType": { "type": "string", "traits": { "smithy.api#enum": [ { - "value": "Command", - "name": "Command" - }, - { - "value": "Policy", - "name": "Policy" - }, - { + "value": "Comment", + "name": "Comment" + } + ] + } + }, + "com.amazonaws.ssm#DocumentReviewerResponseList": { + "type": "list", + "member": { + "target": "com.amazonaws.ssm#DocumentReviewerResponseSource" + } + }, + "com.amazonaws.ssm#DocumentReviewerResponseSource": { + "type": "structure", + "members": { + "CreateTime": { + "target": "com.amazonaws.ssm#DateTime", + "traits": { + "smithy.api#documentation": "

The date and time that a reviewer entered a response to a document review request.

" + } + }, + "UpdatedTime": { + "target": "com.amazonaws.ssm#DateTime", + "traits": { + "smithy.api#documentation": "

The date and time that a reviewer last updated a response to a document review\n request.

" + } + }, + "ReviewStatus": { + "target": "com.amazonaws.ssm#ReviewStatus", + "traits": { + "smithy.api#documentation": "

The current review status of a new custom SSM document created by a member of your\n organization, or of the latest version of an existing SSM document.

\n

Only one version of a document can be in the APPROVED state at a time. When a new version is\n approved, the status of the previous version changes to REJECTED.

\n

Only one version of a document can be in review, or PENDING, at a time.

" + } + }, + "Comment": { + "target": "com.amazonaws.ssm#DocumentReviewCommentList", + "traits": { + "smithy.api#documentation": "

The comment entered by a reviewer as part of their document review response.

" + } + }, + "Reviewer": { + "target": "com.amazonaws.ssm#Reviewer", + "traits": { + "smithy.api#documentation": "

The user in your organization assigned to review a document request.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about a reviewer's response to a document review request.

" + } + }, + "com.amazonaws.ssm#DocumentReviews": { + "type": "structure", + "members": { + "Action": { + "target": "com.amazonaws.ssm#DocumentReviewAction", + "traits": { + "smithy.api#documentation": "

The action to take on a document approval review request.

", + "smithy.api#required": {} + } + }, + "Comment": { + "target": "com.amazonaws.ssm#DocumentReviewCommentList", + "traits": { + "smithy.api#documentation": "

A comment entered by a user in your organization about the document review request.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about a document approval review.

" + } + }, + "com.amazonaws.ssm#DocumentSchemaVersion": { + "type": "string", + "traits": { + "smithy.api#pattern": "([0-9]+)\\.([0-9]+)" + } + }, + "com.amazonaws.ssm#DocumentSha1": { + "type": "string" + }, + "com.amazonaws.ssm#DocumentStatus": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The status of a document.

", + "smithy.api#enum": [ + { + "value": "Creating", + "name": "Creating" + }, + { + "value": "Active", + "name": "Active" + }, + { + "value": "Updating", + "name": "Updating" + }, + { + "value": "Deleting", + "name": "Deleting" + }, + { + "value": "Failed", + "name": "Failed" + } + ] + } + }, + "com.amazonaws.ssm#DocumentStatusInformation": { + "type": "string" + }, + "com.amazonaws.ssm#DocumentType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Command", + "name": "Command" + }, + { + "value": "Policy", + "name": "Policy" + }, + { "value": "Automation", "name": "Automation" }, @@ -8484,6 +8915,10 @@ { "value": "ChangeCalendar", "name": "ChangeCalendar" + }, + { + "value": "Automation.ChangeTemplate", + "name": "ChangeTemplate" } ] } @@ -8544,6 +8979,12 @@ "traits": { "smithy.api#documentation": "

A message returned by AWS Systems Manager that explains the Status value. For example, a\n Failed status might be explained by the StatusInformation message,\n \"The specified S3 bucket does not exist. Verify that the URL of the S3 bucket is correct.\"

" } + }, + "ReviewStatus": { + "target": "com.amazonaws.ssm#ReviewStatus", + "traits": { + "smithy.api#documentation": "

The current status of the approval review for the latest version of the document.

" + } } }, "traits": { @@ -8691,7 +9132,8 @@ "smithy.api#length": { "min": 1, "max": 64 - } + }, + "smithy.api#pattern": "[\\w+=,.@-]+" } }, "com.amazonaws.ssm#ExpirationDate": { @@ -8763,13 +9205,16 @@ "traits": { "smithy.api#enum": [ { - "value": "Client" + "value": "Client", + "name": "Client" }, { - "value": "Server" + "value": "Server", + "name": "Server" }, { - "value": "Unknown" + "value": "Unknown", + "name": "Unknown" } ] } @@ -9421,6 +9866,12 @@ "traits": { "smithy.api#documentation": "

A description of the document attachments, including names, locations, sizes, and so\n on.

" } + }, + "ReviewStatus": { + "target": "com.amazonaws.ssm#ReviewStatus", + "traits": { + "smithy.api#documentation": "

The current review status of a new custom Systems Manager document (SSM document) created by a member\n of your organization, or of the latest version of an existing SSM document.

\n

Only one version of an SSM document can be in the APPROVED state at a time. When a new\n version is approved, the status of the previous version changes to REJECTED.

\n

Only one version of an SSM document can be in review, or PENDING, at a time.

" + } } } }, @@ -10002,7 +10453,7 @@ "ScheduleTimezone": { "target": "com.amazonaws.ssm#MaintenanceWindowTimezone", "traits": { - "smithy.api#documentation": "

The time zone that the scheduled maintenance window executions are based on, in Internet\n Assigned Numbers Authority (IANA) format. For example: \"America/Los_Angeles\", \"etc/UTC\", or\n \"Asia/Seoul\". For more information, see the Time\n Zone Database on the IANA website.

" + "smithy.api#documentation": "

The time zone that the scheduled maintenance window executions are based on, in Internet\n Assigned Numbers Authority (IANA) format. For example: \"America/Los_Angeles\", \"UTC\", or\n \"Asia/Seoul\". For more information, see the Time\n Zone Database on the IANA website.

" } }, "ScheduleOffset": { @@ -10073,7 +10524,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the tasks in a maintenance window.

" + "smithy.api#documentation": "

Lists the tasks in a maintenance window.

\n \n \n

For maintenance window tasks without a specified target, you cannot supply values for\n --max-errors and --max-concurrency. Instead, the system inserts a\n placeholder value of 1, which may be reported in the response to this command.\n These values do not affect the running of your task and can be ignored.

\n " } }, "com.amazonaws.ssm#GetMaintenanceWindowTaskRequest": { @@ -10155,13 +10606,13 @@ "MaxConcurrency": { "target": "com.amazonaws.ssm#MaxConcurrency", "traits": { - "smithy.api#documentation": "

The maximum number of targets allowed to run this task in parallel.

" + "smithy.api#documentation": "

The maximum number of targets allowed to run this task in parallel.

\n \n \n

For maintenance window tasks without a target specified, you cannot supply a value for this\n option. Instead, the system inserts a placeholder value of 1, which may be reported\n in the response to this command. This value does not affect the running of your task and can be\n ignored.

\n " } }, "MaxErrors": { "target": "com.amazonaws.ssm#MaxErrors", "traits": { - "smithy.api#documentation": "

The maximum number of errors allowed before the task stops being scheduled.

" + "smithy.api#documentation": "

The maximum number of errors allowed before the task stops being scheduled.

\n \n \n

For maintenance window tasks without a target specified, you cannot supply a value for this\n option. Instead, the system inserts a placeholder value of 1, which may be reported\n in the response to this command. This value does not affect the running of your task and can be\n ignored.

\n " } }, "LoggingInfo": { @@ -10247,7 +10698,7 @@ } ], "traits": { - "smithy.api#documentation": "

View operational metadata related to an application in AppManager.

" + "smithy.api#documentation": "

View operational metadata related to an application in Application Manager.

" } }, "com.amazonaws.ssm#GetOpsMetadataMaxResults": { @@ -10290,13 +10741,13 @@ "ResourceId": { "target": "com.amazonaws.ssm#OpsMetadataResourceId", "traits": { - "smithy.api#documentation": "

The resource ID of the AppManager application.

" + "smithy.api#documentation": "

The resource ID of the Application Manager application.

" } }, "Metadata": { "target": "com.amazonaws.ssm#MetadataMap", "traits": { - "smithy.api#documentation": "

OpsMetadata for an AppManager application.

" + "smithy.api#documentation": "

OpsMetadata for an Application Manager application.

" } }, "NextToken": { @@ -11266,7 +11717,7 @@ "LastPingDateTime": { "target": "com.amazonaws.ssm#DateTime", "traits": { - "smithy.api#documentation": "

The date and time when agent last pinged Systems Manager service.

" + "smithy.api#documentation": "

The date and time when the agent last pinged the Systems Manager service.

" } }, "AgentVersion": { @@ -13647,6 +14098,105 @@ } } }, + "com.amazonaws.ssm#ListDocumentMetadataHistory": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssm#ListDocumentMetadataHistoryRequest" + }, + "output": { + "target": "com.amazonaws.ssm#ListDocumentMetadataHistoryResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ssm#InternalServerError" + }, + { + "target": "com.amazonaws.ssm#InvalidDocument" + }, + { + "target": "com.amazonaws.ssm#InvalidDocumentVersion" + }, + { + "target": "com.amazonaws.ssm#InvalidNextToken" + } + ], + "traits": { + "smithy.api#documentation": "

Information about approval reviews for a version of an SSM document.

" + } + }, + "com.amazonaws.ssm#ListDocumentMetadataHistoryRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.ssm#DocumentName", + "traits": { + "smithy.api#documentation": "

The name of the document.

", + "smithy.api#required": {} + } + }, + "DocumentVersion": { + "target": "com.amazonaws.ssm#DocumentVersion", + "traits": { + "smithy.api#documentation": "

The version of the document.

" + } + }, + "Metadata": { + "target": "com.amazonaws.ssm#DocumentMetadataEnum", + "traits": { + "smithy.api#documentation": "

The type of data for which details are being requested. Currently, the only supported value\n is DocumentReviews.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.ssm#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of items to return. (You received this token from a previous\n call.)

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ssm#MaxResults", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

The maximum number of items to return for this call. The call also returns a token that you\n can specify in a subsequent call to get the next set of results.

" + } + } + } + }, + "com.amazonaws.ssm#ListDocumentMetadataHistoryResponse": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.ssm#DocumentName", + "traits": { + "smithy.api#documentation": "

The name of the document.

" + } + }, + "DocumentVersion": { + "target": "com.amazonaws.ssm#DocumentVersion", + "traits": { + "smithy.api#documentation": "

The version of the document.

" + } + }, + "Author": { + "target": "com.amazonaws.ssm#DocumentAuthor", + "traits": { + "smithy.api#documentation": "

The user ID of the person in the organization who requested the document review.

" + } + }, + "Metadata": { + "target": "com.amazonaws.ssm#DocumentMetadataResponseInfo", + "traits": { + "smithy.api#documentation": "

Information about the response to the document approval request.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ssm#NextToken", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return for this call. The call also returns a token that you\n can specify in a subsequent call to get the next set of results.

" + } + } + } + }, "com.amazonaws.ssm#ListDocumentVersions": { "type": "operation", "input": { @@ -13902,111 +14452,189 @@ } } }, - "com.amazonaws.ssm#ListOpsMetadata": { + "com.amazonaws.ssm#ListOpsItemEvents": { "type": "operation", "input": { - "target": "com.amazonaws.ssm#ListOpsMetadataRequest" + "target": "com.amazonaws.ssm#ListOpsItemEventsRequest" }, "output": { - "target": "com.amazonaws.ssm#ListOpsMetadataResult" + "target": "com.amazonaws.ssm#ListOpsItemEventsResponse" }, "errors": [ { "target": "com.amazonaws.ssm#InternalServerError" }, { - "target": "com.amazonaws.ssm#OpsMetadataInvalidArgumentException" + "target": "com.amazonaws.ssm#OpsItemInvalidParameterException" + }, + { + "target": "com.amazonaws.ssm#OpsItemLimitExceededException" + }, + { + "target": "com.amazonaws.ssm#OpsItemNotFoundException" } ], "traits": { - "smithy.api#documentation": "

Systems Manager calls this API action when displaying all AppManager OpsMetadata objects or\n blobs.

" - } - }, - "com.amazonaws.ssm#ListOpsMetadataMaxResults": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 50 + "smithy.api#documentation": "

Returns a list of all OpsItem events in the current AWS account and Region. You can limit\n the results to events associated with specific OpsItems by specifying a filter.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Summaries", + "pageSize": "MaxResults" } } }, - "com.amazonaws.ssm#ListOpsMetadataRequest": { + "com.amazonaws.ssm#ListOpsItemEventsRequest": { "type": "structure", "members": { "Filters": { - "target": "com.amazonaws.ssm#OpsMetadataFilterList", + "target": "com.amazonaws.ssm#OpsItemEventFilters", "traits": { - "smithy.api#documentation": "

One or more filters to limit the number of OpsMetadata objects returned by the\n call.

" + "smithy.api#documentation": "

One or more OpsItem filters. Use a filter to return a more specific list of results.

" } }, "MaxResults": { - "target": "com.amazonaws.ssm#ListOpsMetadataMaxResults", + "target": "com.amazonaws.ssm#OpsItemEventMaxResults", "traits": { - "smithy.api#box": {}, - "smithy.api#documentation": "

The maximum number of items to return for this call. The call also returns a token that you\n can specify in a subsequent call to get the next set of results.

" + "smithy.api#documentation": "

The maximum number of items to return for this call. The call also returns a token that you\n can specify in a subsequent call to get the next set of results.

" } }, "NextToken": { - "target": "com.amazonaws.ssm#NextToken", + "target": "com.amazonaws.ssm#String", "traits": { - "smithy.api#documentation": "

A token to start the list. Use this token to get the next set of results.

" + "smithy.api#documentation": "

A token to start the list. Use this token to get the next set of results.

" } } } }, - "com.amazonaws.ssm#ListOpsMetadataResult": { + "com.amazonaws.ssm#ListOpsItemEventsResponse": { "type": "structure", "members": { - "OpsMetadataList": { - "target": "com.amazonaws.ssm#OpsMetadataList", + "NextToken": { + "target": "com.amazonaws.ssm#String", "traits": { - "smithy.api#documentation": "

Returns a list of OpsMetadata objects.

" + "smithy.api#documentation": "

The token for the next set of items to return. Use this token to get the next set of\n results.

" } }, - "NextToken": { - "target": "com.amazonaws.ssm#NextToken", + "Summaries": { + "target": "com.amazonaws.ssm#OpsItemEventSummaries", "traits": { - "smithy.api#documentation": "

The token for the next set of items to return. Use this token to get the next set of\n results.

" + "smithy.api#documentation": "

A list of event information for the specified OpsItems.

" } } } }, - "com.amazonaws.ssm#ListResourceComplianceSummaries": { + "com.amazonaws.ssm#ListOpsMetadata": { "type": "operation", "input": { - "target": "com.amazonaws.ssm#ListResourceComplianceSummariesRequest" + "target": "com.amazonaws.ssm#ListOpsMetadataRequest" }, "output": { - "target": "com.amazonaws.ssm#ListResourceComplianceSummariesResult" + "target": "com.amazonaws.ssm#ListOpsMetadataResult" }, "errors": [ { "target": "com.amazonaws.ssm#InternalServerError" }, { - "target": "com.amazonaws.ssm#InvalidFilter" - }, - { - "target": "com.amazonaws.ssm#InvalidNextToken" + "target": "com.amazonaws.ssm#OpsMetadataInvalidArgumentException" } ], "traits": { - "smithy.api#documentation": "

Returns a resource-level summary count. The summary includes information about compliant and\n non-compliant statuses and detailed compliance-item severity counts, according to the filter\n criteria you specify.

", + "smithy.api#documentation": "

Systems Manager calls this API action when displaying all Application Manager OpsMetadata objects or\n blobs.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", - "items": "ResourceComplianceSummaryItems", + "items": "OpsMetadataList", "pageSize": "MaxResults" } } }, - "com.amazonaws.ssm#ListResourceComplianceSummariesRequest": { - "type": "structure", - "members": { - "Filters": { - "target": "com.amazonaws.ssm#ComplianceStringFilterList", - "traits": { + "com.amazonaws.ssm#ListOpsMetadataMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.ssm#ListOpsMetadataRequest": { + "type": "structure", + "members": { + "Filters": { + "target": "com.amazonaws.ssm#OpsMetadataFilterList", + "traits": { + "smithy.api#documentation": "

One or more filters to limit the number of OpsMetadata objects returned by the call.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ssm#ListOpsMetadataMaxResults", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

The maximum number of items to return for this call. The call also returns a token that you\n can specify in a subsequent call to get the next set of results.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ssm#NextToken", + "traits": { + "smithy.api#documentation": "

A token to start the list. Use this token to get the next set of results.

" + } + } + } + }, + "com.amazonaws.ssm#ListOpsMetadataResult": { + "type": "structure", + "members": { + "OpsMetadataList": { + "target": "com.amazonaws.ssm#OpsMetadataList", + "traits": { + "smithy.api#documentation": "

Returns a list of OpsMetadata objects.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ssm#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of items to return. Use this token to get the next set of\n results.

" + } + } + } + }, + "com.amazonaws.ssm#ListResourceComplianceSummaries": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssm#ListResourceComplianceSummariesRequest" + }, + "output": { + "target": "com.amazonaws.ssm#ListResourceComplianceSummariesResult" + }, + "errors": [ + { + "target": "com.amazonaws.ssm#InternalServerError" + }, + { + "target": "com.amazonaws.ssm#InvalidFilter" + }, + { + "target": "com.amazonaws.ssm#InvalidNextToken" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a resource-level summary count. The summary includes information about compliant and\n non-compliant statuses and detailed compliance-item severity counts, according to the filter\n criteria you specify.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ResourceComplianceSummaryItems", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ssm#ListResourceComplianceSummariesRequest": { + "type": "structure", + "members": { + "Filters": { + "target": "com.amazonaws.ssm#ComplianceStringFilterList", + "traits": { "smithy.api#documentation": "

One or more filters. Use a filter to return a more specific list of results.

" } }, @@ -15363,12 +15991,12 @@ "Value": { "target": "com.amazonaws.ssm#MetadataValueString", "traits": { - "smithy.api#documentation": "

Metadata value to assign to an AppManager application.

" + "smithy.api#documentation": "

Metadata value to assign to an Application Manager application.

" } } }, "traits": { - "smithy.api#documentation": "

Metadata to assign to an AppManager application.

" + "smithy.api#documentation": "

Metadata to assign to an Application Manager application.

" } }, "com.amazonaws.ssm#MetadataValueString": { @@ -15944,6 +16572,12 @@ "smithy.api#documentation": "

The ARN of the AWS account that created the OpsItem.

" } }, + "OpsItemType": { + "target": "com.amazonaws.ssm#OpsItemType", + "traits": { + "smithy.api#documentation": "

The type of OpsItem. Currently, the only valid values are /aws/changerequest\n and /aws/issue.

" + } + }, "CreatedTime": { "target": "com.amazonaws.ssm#DateTime", "traits": { @@ -16033,6 +16667,30 @@ "traits": { "smithy.api#documentation": "

The severity of the OpsItem. Severity options range from 1 to 4.

" } + }, + "ActualStartTime": { + "target": "com.amazonaws.ssm#DateTime", + "traits": { + "smithy.api#documentation": "

The time a runbook workflow started. Currently reported only for the OpsItem type\n /aws/changerequest.

" + } + }, + "ActualEndTime": { + "target": "com.amazonaws.ssm#DateTime", + "traits": { + "smithy.api#documentation": "

The time a runbook workflow ended. Currently reported only for the OpsItem type\n /aws/changerequest.

" + } + }, + "PlannedStartTime": { + "target": "com.amazonaws.ssm#DateTime", + "traits": { + "smithy.api#documentation": "

The time specified in a change request for a runbook workflow to start. Currently supported\n only for the OpsItem type /aws/changerequest.

" + } + }, + "PlannedEndTime": { + "target": "com.amazonaws.ssm#DateTime", + "traits": { + "smithy.api#documentation": "

The time specified in a change request for a runbook workflow to end. Currently supported\n only for the OpsItem type /aws/changerequest.

" + } } }, "traits": { @@ -16060,7 +16718,8 @@ "smithy.api#length": { "min": 1, "max": 64 - } + }, + "smithy.api#pattern": "^(?!\\s*$).+" } }, "com.amazonaws.ssm#OpsItemDataKey": { @@ -16069,7 +16728,8 @@ "smithy.api#length": { "min": 1, "max": 128 - } + }, + "smithy.api#pattern": "^(?!\\s*$).+" } }, "com.amazonaws.ssm#OpsItemDataType": { @@ -16108,7 +16768,10 @@ } }, "com.amazonaws.ssm#OpsItemDataValueString": { - "type": "string" + "type": "string", + "traits": { + "smithy.api#pattern": "[\\s\\S]*\\S[\\s\\S]*" + } }, "com.amazonaws.ssm#OpsItemDescription": { "type": "string", @@ -16116,9 +16779,149 @@ "smithy.api#length": { "min": 1, "max": 1024 + }, + "smithy.api#pattern": "[\\s\\S]*\\S[\\s\\S]*" + } + }, + "com.amazonaws.ssm#OpsItemEventFilter": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.ssm#OpsItemEventFilterKey", + "traits": { + "smithy.api#documentation": "

The name of the filter key. Currently, the only supported value is\n OpsItemId.

", + "smithy.api#required": {} + } + }, + "Values": { + "target": "com.amazonaws.ssm#OpsItemEventFilterValues", + "traits": { + "smithy.api#documentation": "

The values for the filter, consisting of one or more OpsItem IDs.

", + "smithy.api#required": {} + } + }, + "Operator": { + "target": "com.amazonaws.ssm#OpsItemEventFilterOperator", + "traits": { + "smithy.api#documentation": "

The operator used by the filter call. Currently, the only supported value is\n Equal.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a filter for a specific list of OpsItem events. You can filter event information\n by using tags. You specify tags by using a key-value pair mapping.

" + } + }, + "com.amazonaws.ssm#OpsItemEventFilterKey": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "OpsItemId", + "name": "OPSITEM_ID" + } + ] + } + }, + "com.amazonaws.ssm#OpsItemEventFilterOperator": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Equal", + "name": "EQUAL" + } + ] + } + }, + "com.amazonaws.ssm#OpsItemEventFilterValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 15 + }, + "smithy.api#pattern": "^(oi)-[0-9a-f]{12}$" + } + }, + "com.amazonaws.ssm#OpsItemEventFilterValues": { + "type": "list", + "member": { + "target": "com.amazonaws.ssm#OpsItemEventFilterValue" + } + }, + "com.amazonaws.ssm#OpsItemEventFilters": { + "type": "list", + "member": { + "target": "com.amazonaws.ssm#OpsItemEventFilter" + } + }, + "com.amazonaws.ssm#OpsItemEventMaxResults": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1, + "max": 50 } } }, + "com.amazonaws.ssm#OpsItemEventSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.ssm#OpsItemEventSummary" + } + }, + "com.amazonaws.ssm#OpsItemEventSummary": { + "type": "structure", + "members": { + "OpsItemId": { + "target": "com.amazonaws.ssm#String", + "traits": { + "smithy.api#documentation": "

The ID of the OpsItem.

" + } + }, + "EventId": { + "target": "com.amazonaws.ssm#String", + "traits": { + "smithy.api#documentation": "

The ID of the OpsItem event.

" + } + }, + "Source": { + "target": "com.amazonaws.ssm#String", + "traits": { + "smithy.api#documentation": "

The source of the OpsItem event.

" + } + }, + "DetailType": { + "target": "com.amazonaws.ssm#String", + "traits": { + "smithy.api#documentation": "

The type of information provided as a detail.

" + } + }, + "Detail": { + "target": "com.amazonaws.ssm#String", + "traits": { + "smithy.api#documentation": "

Specific information about the OpsItem event.

" + } + }, + "CreatedBy": { + "target": "com.amazonaws.ssm#OpsItemIdentity", + "traits": { + "smithy.api#documentation": "

Information about the user or resource that created the OpsItem event.

" + } + }, + "CreatedTime": { + "target": "com.amazonaws.ssm#DateTime", + "traits": { + "smithy.api#documentation": "

The date and time the OpsItem event was created.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Summary information about an OpsItem event.

" + } + }, "com.amazonaws.ssm#OpsItemFilter": { "type": "structure", "members": { @@ -16184,6 +16987,22 @@ "value": "LastModifiedTime", "name": "LAST_MODIFIED_TIME" }, + { + "value": "ActualStartTime", + "name": "ACTUAL_START_TIME" + }, + { + "value": "ActualEndTime", + "name": "ACTUAL_END_TIME" + }, + { + "value": "PlannedStartTime", + "name": "PLANNED_START_TIME" + }, + { + "value": "PlannedEndTime", + "name": "PLANNED_END_TIME" + }, { "value": "OperationalData", "name": "OPERATIONAL_DATA" @@ -16211,6 +17030,34 @@ { "value": "Severity", "name": "SEVERITY" + }, + { + "value": "OpsItemType", + "name": "OPSITEM_TYPE" + }, + { + "value": "ChangeRequestByRequesterArn", + "name": "CHANGE_REQUEST_REQUESTER_ARN" + }, + { + "value": "ChangeRequestByRequesterName", + "name": "CHANGE_REQUEST_REQUESTER_NAME" + }, + { + "value": "ChangeRequestByApproverArn", + "name": "CHANGE_REQUEST_APPROVER_ARN" + }, + { + "value": "ChangeRequestByApproverName", + "name": "CHANGE_REQUEST_APPROVER_NAME" + }, + { + "value": "ChangeRequestByTemplate", + "name": "CHANGE_REQUEST_TEMPLATE" + }, + { + "value": "ChangeRequestByTargetsResourceGroup", + "name": "CHANGE_REQUEST_TARGETS_RESOURCE_GROUP" } ] } @@ -16259,6 +17106,20 @@ "smithy.api#pattern": "^(oi)-[0-9a-f]{12}$" } }, + "com.amazonaws.ssm#OpsItemIdentity": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.ssm#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM entity that created the OpsItem event.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the user or resource that created an OpsItem event.

" + } + }, "com.amazonaws.ssm#OpsItemInvalidParameterException": { "type": "structure", "members": { @@ -16374,7 +17235,8 @@ "smithy.api#length": { "min": 1, "max": 64 - } + }, + "smithy.api#pattern": "^(?!\\s*$).+" } }, "com.amazonaws.ssm#OpsItemSource": { @@ -16382,8 +17244,9 @@ "traits": { "smithy.api#length": { "min": 1, - "max": 64 - } + "max": 128 + }, + "smithy.api#pattern": "^(?!\\s*$).+" } }, "com.amazonaws.ssm#OpsItemStatus": { @@ -16401,6 +17264,66 @@ { "value": "Resolved", "name": "RESOLVED" + }, + { + "value": "Pending", + "name": "PENDING" + }, + { + "value": "TimedOut", + "name": "TIMED_OUT" + }, + { + "value": "Cancelling", + "name": "CANCELLING" + }, + { + "value": "Cancelled", + "name": "CANCELLED" + }, + { + "value": "Failed", + "name": "FAILED" + }, + { + "value": "CompletedWithSuccess", + "name": "COMPLETED_WITH_SUCCESS" + }, + { + "value": "CompletedWithFailure", + "name": "COMPLETED_WITH_FAILURE" + }, + { + "value": "Scheduled", + "name": "SCHEDULED" + }, + { + "value": "RunbookInProgress", + "name": "RUNBOOK_IN_PROGRESS" + }, + { + "value": "PendingChangeCalendarOverride", + "name": "PENDING_CHANGE_CALENDAR_OVERRIDE" + }, + { + "value": "ChangeCalendarOverrideApproved", + "name": "CHANGE_CALENDAR_OVERRIDE_APPROVED" + }, + { + "value": "ChangeCalendarOverrideRejected", + "name": "CHANGE_CALENDAR_OVERRIDE_REJECTED" + }, + { + "value": "PendingApproval", + "name": "PENDING_APPROVAL" + }, + { + "value": "Approved", + "name": "APPROVED" + }, + { + "value": "Rejected", + "name": "REJECTED" } ] } @@ -16485,6 +17408,36 @@ "traits": { "smithy.api#documentation": "

A list of OpsItems by severity.

" } + }, + "OpsItemType": { + "target": "com.amazonaws.ssm#OpsItemType", + "traits": { + "smithy.api#documentation": "

The type of OpsItem. Currently, the only valid values are /aws/changerequest\n and /aws/issue.

" + } + }, + "ActualStartTime": { + "target": "com.amazonaws.ssm#DateTime", + "traits": { + "smithy.api#documentation": "

The time a runbook workflow started. Currently reported only for the OpsItem type\n /aws/changerequest.

" + } + }, + "ActualEndTime": { + "target": "com.amazonaws.ssm#DateTime", + "traits": { + "smithy.api#documentation": "

The time a runbook workflow ended. Currently reported only for the OpsItem type\n /aws/changerequest.

" + } + }, + "PlannedStartTime": { + "target": "com.amazonaws.ssm#DateTime", + "traits": { + "smithy.api#documentation": "

The time specified in a change request for a runbook workflow to start. Currently supported\n only for the OpsItem type /aws/changerequest.

" + } + }, + "PlannedEndTime": { + "target": "com.amazonaws.ssm#DateTime", + "traits": { + "smithy.api#documentation": "

The time specified in a change request for a runbook workflow to end. Currently supported\n only for the OpsItem type /aws/changerequest.

" + } } }, "traits": { @@ -16497,16 +17450,20 @@ "smithy.api#length": { "min": 1, "max": 1024 - } + }, + "smithy.api#pattern": "^(?!\\s*$).+" } }, + "com.amazonaws.ssm#OpsItemType": { + "type": "string" + }, "com.amazonaws.ssm#OpsMetadata": { "type": "structure", "members": { "ResourceId": { "target": "com.amazonaws.ssm#OpsMetadataResourceId", "traits": { - "smithy.api#documentation": "

The ID of the AppManager application.

" + "smithy.api#documentation": "

The ID of the Application Manager application.

" } }, "OpsMetadataArn": { @@ -16535,7 +17492,7 @@ } }, "traits": { - "smithy.api#documentation": "

Operational metadata for an application in AppManager.

" + "smithy.api#documentation": "

Operational metadata for an application in Application Manager.

" } }, "com.amazonaws.ssm#OpsMetadataAlreadyExistsException": { @@ -16645,7 +17602,7 @@ } }, "traits": { - "smithy.api#documentation": "

The OpsMetadata object exceeds the maximum number of OpsMetadata keys that you can assign to an application in AppManager.

", + "smithy.api#documentation": "

The OpsMetadata object exceeds the maximum number of OpsMetadata keys that you can assign to\n an application in Application Manager.

", "smithy.api#error": "client" } }, @@ -16657,7 +17614,7 @@ } }, "traits": { - "smithy.api#documentation": "

Your account reached the maximum number of OpsMetadata objects allowed by AppManager. The\n maximum is 200 OpsMetadata objects. Delete one or more OpsMetadata object and try again.

", + "smithy.api#documentation": "

Your account reached the maximum number of OpsMetadata objects allowed by Application Manager. The\n maximum is 200 OpsMetadata objects. Delete one or more OpsMetadata object and try again.

", "smithy.api#error": "client" } }, @@ -19139,8 +20096,7 @@ "Targets": { "target": "com.amazonaws.ssm#Targets", "traits": { - "smithy.api#documentation": "

The targets (either instances or maintenance window targets).

\n

Specify instances using the following format:

\n

\n Key=InstanceIds,Values=,\n

\n

Specify maintenance window targets using the following format:

\n

\n Key=WindowTargetIds;,Values=,\n

", - "smithy.api#required": {} + "smithy.api#documentation": "

The targets (either instances or maintenance window targets).

\n \n \n

One or more targets must be specified for maintenance window Run Command-type tasks.\n Depending on the task, targets are optional for other maintenance window task types (Automation,\n AWS Lambda, and AWS Step Functions). For more information about running tasks that do not\n specify targets, see see Registering\n maintenance window tasks without targets in the\n AWS Systems Manager User Guide.

\n \n

Specify instances using the following format:

\n

\n Key=InstanceIds,Values=,\n

\n

Specify maintenance window targets using the following format:

\n

\n Key=WindowTargetIds,Values=,\n

" } }, "TaskArn": { @@ -19185,15 +20141,13 @@ "MaxConcurrency": { "target": "com.amazonaws.ssm#MaxConcurrency", "traits": { - "smithy.api#documentation": "

The maximum number of targets this task can be run for in parallel.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The maximum number of targets this task can be run for in parallel.

\n \n \n

For maintenance window tasks without a target specified, you cannot supply a value for this\n option. Instead, the system inserts a placeholder value of 1. This value does not\n affect the running of your task.

\n " } }, "MaxErrors": { "target": "com.amazonaws.ssm#MaxErrors", "traits": { - "smithy.api#documentation": "

The maximum number of errors allowed before this task stops being scheduled.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The maximum number of errors allowed before this task stops being scheduled.

\n \n \n

For maintenance window tasks without a target specified, you cannot supply a value for this\n option. Instead, the system inserts a placeholder value of 1. This value does not\n affect the running of your task.

\n " } }, "LoggingInfo": { @@ -20096,6 +21050,148 @@ } } }, + "com.amazonaws.ssm#ReviewInformation": { + "type": "structure", + "members": { + "ReviewedTime": { + "target": "com.amazonaws.ssm#DateTime", + "traits": { + "smithy.api#documentation": "

The time that the reviewer took action on the document review request.

" + } + }, + "Status": { + "target": "com.amazonaws.ssm#ReviewStatus", + "traits": { + "smithy.api#documentation": "

The current status of the document review request.

" + } + }, + "Reviewer": { + "target": "com.amazonaws.ssm#Reviewer", + "traits": { + "smithy.api#documentation": "

The reviewer assigned to take action on the document review request.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the result of a document review request.

" + } + }, + "com.amazonaws.ssm#ReviewInformationList": { + "type": "list", + "member": { + "target": "com.amazonaws.ssm#ReviewInformation", + "traits": { + "smithy.api#xmlName": "ReviewInformation" + } + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.ssm#ReviewStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "APPROVED", + "name": "APPROVED" + }, + { + "value": "NOT_REVIEWED", + "name": "NOT_REVIEWED" + }, + { + "value": "PENDING", + "name": "PENDING" + }, + { + "value": "REJECTED", + "name": "REJECTED" + } + ] + } + }, + "com.amazonaws.ssm#Reviewer": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_\\-.]{1,128}$" + } + }, + "com.amazonaws.ssm#Runbook": { + "type": "structure", + "members": { + "DocumentName": { + "target": "com.amazonaws.ssm#DocumentARN", + "traits": { + "smithy.api#documentation": "

The name of the Automation runbook (Automation document) used in a runbook workflow.

", + "smithy.api#required": {} + } + }, + "DocumentVersion": { + "target": "com.amazonaws.ssm#DocumentVersion", + "traits": { + "smithy.api#documentation": "

The version of the Automation runbook (Automation document) used in a\n runbook workflow.

" + } + }, + "Parameters": { + "target": "com.amazonaws.ssm#AutomationParameterMap", + "traits": { + "smithy.api#documentation": "

The key-value map of execution parameters, which were supplied when calling\n StartChangeRequestExecution.

" + } + }, + "TargetParameterName": { + "target": "com.amazonaws.ssm#AutomationParameterKey", + "traits": { + "smithy.api#documentation": "

The name of the parameter used as the target resource for the rate-controlled\n runbook workflow. Required if you specify Targets.

" + } + }, + "Targets": { + "target": "com.amazonaws.ssm#Targets", + "traits": { + "smithy.api#documentation": "

A key-value mapping to target resources that the Runbook operation performs tasks on.\n Required if you specify TargetParameterName.

" + } + }, + "MaxConcurrency": { + "target": "com.amazonaws.ssm#MaxConcurrency", + "traits": { + "smithy.api#documentation": "

The MaxConcurrency value specified by the user when the operation started,\n indicating the maximum number of resources that the runbook operation can run on at the same\n time.

" + } + }, + "MaxErrors": { + "target": "com.amazonaws.ssm#MaxErrors", + "traits": { + "smithy.api#documentation": "

The MaxErrors value specified by the user when the execution started,\n indicating the maximum number of errors that can occur during the operation before the updates\n are stopped or rolled back.

" + } + }, + "TargetLocations": { + "target": "com.amazonaws.ssm#TargetLocations", + "traits": { + "smithy.api#documentation": "

Information about the AWS Regions and accounts targeted by the current Runbook\n operation.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about an Automation runbook (Automation document) used in a runbook workflow in\n Change Manager.

\n \n

The Automation runbooks specified for the runbook workflow can't run until all required\n approvals for the change request have been received.

\n " + } + }, + "com.amazonaws.ssm#Runbooks": { + "type": "list", + "member": { + "target": "com.amazonaws.ssm#Runbook" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, "com.amazonaws.ssm#S3BucketName": { "type": "string", "traits": { @@ -21080,6 +22176,107 @@ } } }, + "com.amazonaws.ssm#StartChangeRequestExecution": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssm#StartChangeRequestExecutionRequest" + }, + "output": { + "target": "com.amazonaws.ssm#StartChangeRequestExecutionResult" + }, + "errors": [ + { + "target": "com.amazonaws.ssm#AutomationDefinitionNotApprovedException" + }, + { + "target": "com.amazonaws.ssm#AutomationDefinitionNotFoundException" + }, + { + "target": "com.amazonaws.ssm#AutomationDefinitionVersionNotFoundException" + }, + { + "target": "com.amazonaws.ssm#AutomationExecutionLimitExceededException" + }, + { + "target": "com.amazonaws.ssm#IdempotentParameterMismatch" + }, + { + "target": "com.amazonaws.ssm#InternalServerError" + }, + { + "target": "com.amazonaws.ssm#InvalidAutomationExecutionParametersException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a change request for Change Manager. The runbooks (Automation documents) specified in the\n change request run only after all required approvals for the change request have been\n received.

" + } + }, + "com.amazonaws.ssm#StartChangeRequestExecutionRequest": { + "type": "structure", + "members": { + "ScheduledTime": { + "target": "com.amazonaws.ssm#DateTime", + "traits": { + "smithy.api#documentation": "

The date and time specified in the change request to run the Automation runbooks.

\n \n

The Automation runbooks specified for the runbook workflow can't run until all required\n approvals for the change request have been received.

\n " + } + }, + "DocumentName": { + "target": "com.amazonaws.ssm#DocumentARN", + "traits": { + "smithy.api#documentation": "

The name of the change template document to run during the runbook workflow.

", + "smithy.api#required": {} + } + }, + "DocumentVersion": { + "target": "com.amazonaws.ssm#DocumentVersion", + "traits": { + "smithy.api#documentation": "

The version of the change template document to run during the runbook workflow.

" + } + }, + "Parameters": { + "target": "com.amazonaws.ssm#AutomationParameterMap", + "traits": { + "smithy.api#documentation": "

A key-value map of parameters that match the declared parameters in the change template\n document.

" + } + }, + "ChangeRequestName": { + "target": "com.amazonaws.ssm#ChangeRequestName", + "traits": { + "smithy.api#documentation": "

The name of the change request associated with the runbook workflow to be run.

" + } + }, + "ClientToken": { + "target": "com.amazonaws.ssm#IdempotencyToken", + "traits": { + "smithy.api#documentation": "

The user-provided idempotency token. The token must be unique, is case insensitive, enforces\n the UUID format, and can't be reused.

" + } + }, + "Runbooks": { + "target": "com.amazonaws.ssm#Runbooks", + "traits": { + "smithy.api#documentation": "

Information about the Automation runbooks (Automation documents) that are run during the\n runbook workflow.

\n \n

The Automation runbooks specified for the runbook workflow can't run until all required\n approvals for the change request have been received.

\n ", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.ssm#TagList", + "traits": { + "smithy.api#documentation": "

Optional metadata that you assign to a resource. You can specify a maximum of five tags for\n a change request. Tags enable you to categorize a resource in different ways, such as by\n purpose, owner, or environment. For example, you might want to tag a change request to identify\n an environment or target AWS Region. In this case, you could specify the following key-value\n pairs:

\n " + } + } + } + }, + "com.amazonaws.ssm#StartChangeRequestExecutionResult": { + "type": "structure", + "members": { + "AutomationExecutionId": { + "target": "com.amazonaws.ssm#AutomationExecutionId", + "traits": { + "smithy.api#documentation": "

The unique ID of a runbook workflow operation. (A runbook workflow is a type of Automation\n operation.)

" + } + } + } + }, "com.amazonaws.ssm#StartSession": { "type": "operation", "input": { @@ -21585,7 +22782,7 @@ } }, "traits": { - "smithy.api#documentation": "

An array of search criteria that targets instances using a Key,Value combination that you\n specify.\n

\n

Supported formats include the following.

\n \n

For example:

\n \n

For more information about how to send commands that target instances using\n Key,Value parameters, see Targeting multiple instances in the AWS Systems Manager User Guide.

" + "smithy.api#documentation": "

An array of search criteria that targets instances using a Key,Value combination that you\n specify.\n

\n \n \n

One or more targets must be specified for maintenance window Run Command-type tasks.\n Depending on the task, targets are optional for other maintenance window task types (Automation,\n AWS Lambda, and AWS Step Functions). For more information about running tasks that do not\n specify targets, see see Registering\n maintenance window tasks without targets in the\n AWS Systems Manager User Guide.

\n \n

Supported formats include the following.

\n \n

For example:

\n \n

For more information about how to send commands that target instances using\n Key,Value parameters, see Targeting multiple instances in the AWS Systems Manager User Guide.

" } }, "com.amazonaws.ssm#TargetCount": { @@ -21631,19 +22828,19 @@ "TargetLocationMaxConcurrency": { "target": "com.amazonaws.ssm#MaxConcurrency", "traits": { - "smithy.api#documentation": "

The maximum number of AWS accounts and AWS regions allowed to run the Automation\n concurrently

" + "smithy.api#documentation": "

The maximum number of AWS accounts and AWS regions allowed to run the Automation\n concurrently.

" } }, "TargetLocationMaxErrors": { "target": "com.amazonaws.ssm#MaxErrors", "traits": { - "smithy.api#documentation": "

The maximum number of errors allowed before the system stops queueing additional Automation\n executions for the currently running Automation.

" + "smithy.api#documentation": "

The maximum number of errors allowed before the system stops queueing additional Automation\n executions for the currently running Automation.

" } }, "ExecutionRoleName": { "target": "com.amazonaws.ssm#ExecutionRoleName", "traits": { - "smithy.api#documentation": "

The Automation execution role used by the currently running Automation.

" + "smithy.api#documentation": "

The Automation execution role used by the currently running Automation. If not specified,\n the default value is AWS-SystemsManager-AutomationExecutionRole.

" } } }, @@ -22107,6 +23304,12 @@ "traits": { "smithy.api#documentation": "

By default, when you update an association, the system runs it immediately after it is\n updated and then according to the schedule you specified. Specify this option if you don't want\n an association to run immediately after you update it. This parameter is not supported for rate\n expressions.

\n

Also, if you specified this option when you created the association, you can reset it. To do\n so, specify the no-apply-only-at-cron-interval parameter when you update the\n association from the command line. This parameter forces the association to run immediately after\n updating it and according to the interval specified.

" } + }, + "TargetLocations": { + "target": "com.amazonaws.ssm#TargetLocations", + "traits": { + "smithy.api#documentation": "

A location is a combination of AWS Regions and AWS accounts where you want to run the\n association. Use this action to update an association in multiple Regions and multiple\n accounts.

" + } } } }, @@ -22290,6 +23493,61 @@ } } }, + "com.amazonaws.ssm#UpdateDocumentMetadata": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssm#UpdateDocumentMetadataRequest" + }, + "output": { + "target": "com.amazonaws.ssm#UpdateDocumentMetadataResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ssm#InternalServerError" + }, + { + "target": "com.amazonaws.ssm#InvalidDocument" + }, + { + "target": "com.amazonaws.ssm#InvalidDocumentOperation" + }, + { + "target": "com.amazonaws.ssm#InvalidDocumentVersion" + } + ], + "traits": { + "smithy.api#documentation": "

Updates information related to approval reviews for a specific version of a document.

" + } + }, + "com.amazonaws.ssm#UpdateDocumentMetadataRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.ssm#DocumentName", + "traits": { + "smithy.api#documentation": "

The name of the document for which a version is to be updated.

", + "smithy.api#required": {} + } + }, + "DocumentVersion": { + "target": "com.amazonaws.ssm#DocumentVersion", + "traits": { + "smithy.api#documentation": "

The version of a document to update.

" + } + }, + "DocumentReviews": { + "target": "com.amazonaws.ssm#DocumentReviews", + "traits": { + "smithy.api#documentation": "

The document review details to update.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.ssm#UpdateDocumentMetadataResponse": { + "type": "structure", + "members": {} + }, "com.amazonaws.ssm#UpdateDocumentRequest": { "type": "structure", "members": { @@ -22395,7 +23653,7 @@ "StartDate": { "target": "com.amazonaws.ssm#MaintenanceWindowStringDateTime", "traits": { - "smithy.api#documentation": "

The time zone that the scheduled maintenance window executions are based on, in Internet\n Assigned Numbers Authority (IANA) format. For example: \"America/Los_Angeles\", \"etc/UTC\", or\n \"Asia/Seoul\". For more information, see the Time\n Zone Database on the IANA website.

" + "smithy.api#documentation": "

The time zone that the scheduled maintenance window executions are based on, in Internet\n Assigned Numbers Authority (IANA) format. For example: \"America/Los_Angeles\", \"UTC\", or\n \"Asia/Seoul\". For more information, see the Time\n Zone Database on the IANA website.

" } }, "EndDate": { @@ -22413,14 +23671,14 @@ "ScheduleTimezone": { "target": "com.amazonaws.ssm#MaintenanceWindowTimezone", "traits": { - "smithy.api#documentation": "

The time zone that the scheduled maintenance window executions are based on, in Internet\n Assigned Numbers Authority (IANA) format. For example: \"America/Los_Angeles\", \"etc/UTC\", or\n \"Asia/Seoul\". For more information, see the Time\n Zone Database on the IANA website.

" + "smithy.api#documentation": "

The time zone that the scheduled maintenance window executions are based on, in Internet\n Assigned Numbers Authority (IANA) format. For example: \"America/Los_Angeles\", \"UTC\", or\n \"Asia/Seoul\". For more information, see the Time\n Zone Database on the IANA website.

" } }, "ScheduleOffset": { "target": "com.amazonaws.ssm#MaintenanceWindowOffset", "traits": { "smithy.api#box": {}, - "smithy.api#documentation": "

The number of days to wait after the date and time specified by a CRON expression before\n running the maintenance window.

\n

For example, the following cron expression schedules a maintenance window to run the third\n Tuesday of every month at 11:30 PM.

\n

\n cron(0 30 23 ? * TUE#3 *)\n

\n

If the schedule offset is 2, the maintenance window won't run until two days\n later.

" + "smithy.api#documentation": "

The number of days to wait after the date and time specified by a CRON expression before\n running the maintenance window.

\n

For example, the following cron expression schedules a maintenance window to run the third\n Tuesday of every month at 11:30 PM.

\n

\n cron(30 23 ? * TUE#3 *)\n

\n

If the schedule offset is 2, the maintenance window won't run until two days\n later.

" } }, "Duration": { @@ -22502,7 +23760,7 @@ "ScheduleTimezone": { "target": "com.amazonaws.ssm#MaintenanceWindowTimezone", "traits": { - "smithy.api#documentation": "

The time zone that the scheduled maintenance window executions are based on, in Internet\n Assigned Numbers Authority (IANA) format. For example: \"America/Los_Angeles\", \"etc/UTC\", or\n \"Asia/Seoul\". For more information, see the Time\n Zone Database on the IANA website.

" + "smithy.api#documentation": "

The time zone that the scheduled maintenance window executions are based on, in Internet\n Assigned Numbers Authority (IANA) format. For example: \"America/Los_Angeles\", \"UTC\", or\n \"Asia/Seoul\". For more information, see the Time\n Zone Database on the IANA website.

" } }, "ScheduleOffset": { @@ -22666,7 +23924,7 @@ } ], "traits": { - "smithy.api#documentation": "

Modifies a task assigned to a maintenance window. You can't change the task type, but you\n can change the following values:

\n \n

If the value for a parameter in UpdateMaintenanceWindowTask is null, then the\n corresponding field is not modified. If you set Replace to true, then all fields\n required by the RegisterTaskWithMaintenanceWindow action are required for this\n request. Optional fields that aren't specified are set to null.

\n \n

When you update a maintenance window task that has options specified in\n TaskInvocationParameters, you must provide again all the\n TaskInvocationParameters values that you want to retain. The values you do not\n specify again are removed. For example, suppose that when you registered a Run Command task, you\n specified TaskInvocationParameters values for Comment,\n NotificationConfig, and OutputS3BucketName. If you update the\n maintenance window task and specify only a different OutputS3BucketName value, the\n values for Comment and NotificationConfig are removed.

\n " + "smithy.api#documentation": "

Modifies a task assigned to a maintenance window. You can't change the task type, but you\n can change the following values:

\n \n \n \n

One or more targets must be specified for maintenance window Run Command-type tasks.\n Depending on the task, targets are optional for other maintenance window task types (Automation,\n AWS Lambda, and AWS Step Functions). For more information about running tasks that do not\n specify targets, see see Registering\n maintenance window tasks without targets in the\n AWS Systems Manager User Guide.

\n \n

If the value for a parameter in UpdateMaintenanceWindowTask is null, then the\n corresponding field is not modified. If you set Replace to true, then all fields\n required by the RegisterTaskWithMaintenanceWindow action are required for this\n request. Optional fields that aren't specified are set to null.

\n \n

When you update a maintenance window task that has options specified in\n TaskInvocationParameters, you must provide again all the\n TaskInvocationParameters values that you want to retain. The values you do not\n specify again are removed. For example, suppose that when you registered a Run Command task, you\n specified TaskInvocationParameters values for Comment,\n NotificationConfig, and OutputS3BucketName. If you update the\n maintenance window task and specify only a different OutputS3BucketName value, the\n values for Comment and NotificationConfig are removed.

\n " } }, "com.amazonaws.ssm#UpdateMaintenanceWindowTaskRequest": { @@ -22689,7 +23947,7 @@ "Targets": { "target": "com.amazonaws.ssm#Targets", "traits": { - "smithy.api#documentation": "

The targets (either instances or tags) to modify. Instances are specified using\n Key=instanceids,Values=instanceID_1,instanceID_2. Tags are specified using\n Key=tag_name,Values=tag_value.

" + "smithy.api#documentation": "

The targets (either instances or tags) to modify. Instances are specified using\n Key=instanceids,Values=instanceID_1,instanceID_2. Tags are specified using\n Key=tag_name,Values=tag_value.

\n \n \n

One or more targets must be specified for maintenance window Run Command-type tasks.\n Depending on the task, targets are optional for other maintenance window task types (Automation,\n AWS Lambda, and AWS Step Functions). For more information about running tasks that do not\n specify targets, see see Registering\n maintenance window tasks without targets in the\n AWS Systems Manager User Guide.

\n " } }, "TaskArn": { @@ -22726,13 +23984,13 @@ "MaxConcurrency": { "target": "com.amazonaws.ssm#MaxConcurrency", "traits": { - "smithy.api#documentation": "

The new MaxConcurrency value you want to specify. MaxConcurrency\n is the number of targets that are allowed to run this task in parallel.

" + "smithy.api#documentation": "

The new MaxConcurrency value you want to specify. MaxConcurrency\n is the number of targets that are allowed to run this task in parallel.

\n \n \n

For maintenance window tasks without a target specified, you cannot supply a value for this\n option. Instead, the system inserts a placeholder value of 1, which may be reported\n in the response to this command. This value does not affect the running of your task and can be\n ignored.

\n " } }, "MaxErrors": { "target": "com.amazonaws.ssm#MaxErrors", "traits": { - "smithy.api#documentation": "

The new MaxErrors value to specify. MaxErrors is the maximum\n number of errors that are allowed before the task stops being scheduled.

" + "smithy.api#documentation": "

The new MaxErrors value to specify. MaxErrors is the maximum\n number of errors that are allowed before the task stops being scheduled.

\n \n \n

For maintenance window tasks without a target specified, you cannot supply a value for this\n option. Instead, the system inserts a placeholder value of 1, which may be reported\n in the response to this command. This value does not affect the running of your task and can be\n ignored.

\n " } }, "LoggingInfo": { @@ -22986,6 +24244,30 @@ "traits": { "smithy.api#documentation": "

Specify a new severity for an OpsItem.

" } + }, + "ActualStartTime": { + "target": "com.amazonaws.ssm#DateTime", + "traits": { + "smithy.api#documentation": "

The time a runbook workflow started. Currently reported only for the OpsItem type\n /aws/changerequest.

" + } + }, + "ActualEndTime": { + "target": "com.amazonaws.ssm#DateTime", + "traits": { + "smithy.api#documentation": "

The time a runbook workflow ended. Currently reported only for the OpsItem type\n /aws/changerequest.

" + } + }, + "PlannedStartTime": { + "target": "com.amazonaws.ssm#DateTime", + "traits": { + "smithy.api#documentation": "

The time specified in a change request for a runbook workflow to start. Currently supported\n only for the OpsItem type /aws/changerequest.

" + } + }, + "PlannedEndTime": { + "target": "com.amazonaws.ssm#DateTime", + "traits": { + "smithy.api#documentation": "

The time specified in a change request for a runbook workflow to end. Currently supported\n only for the OpsItem type /aws/changerequest.

" + } } } }, @@ -23019,7 +24301,7 @@ } ], "traits": { - "smithy.api#documentation": "

Systems Manager calls this API action when you edit OpsMetadata in AppManager.

" + "smithy.api#documentation": "

Systems Manager calls this API action when you edit OpsMetadata in Application Manager.

" } }, "com.amazonaws.ssm#UpdateOpsMetadataRequest": { diff --git a/codegen/sdk-codegen/aws-models/storagegateway.2013-06-30.json b/codegen/sdk-codegen/aws-models/storagegateway.2013-06-30.json index 56bb4e6f2ca..7bff75de1cd 100644 --- a/codegen/sdk-codegen/aws-models/storagegateway.2013-06-30.json +++ b/codegen/sdk-codegen/aws-models/storagegateway.2013-06-30.json @@ -134,25 +134,32 @@ "traits": { "smithy.api#enum": [ { - "value": "ACCESS_DENIED" + "value": "ACCESS_DENIED", + "name": "ACCESS_DENIED" }, { - "value": "DETACHED" + "value": "DETACHED", + "name": "DETACHED" }, { - "value": "JOINED" + "value": "JOINED", + "name": "JOINED" }, { - "value": "JOINING" + "value": "JOINING", + "name": "JOINING" }, { - "value": "NETWORK_ERROR" + "value": "NETWORK_ERROR", + "name": "NETWORK_ERROR" }, { - "value": "TIMEOUT" + "value": "TIMEOUT", + "name": "TIMEOUT" }, { - "value": "UNKNOWN_ERROR" + "value": "UNKNOWN_ERROR", + "name": "UNKNOWN_ERROR" } ] } @@ -595,13 +602,16 @@ "traits": { "smithy.api#enum": [ { - "value": "COMPLETE" + "value": "COMPLETE", + "name": "COMPLETE" }, { - "value": "FAILED" + "value": "FAILED", + "name": "FAILED" }, { - "value": "PENDING" + "value": "PENDING", + "name": "PENDING" } ] } @@ -933,10 +943,12 @@ "traits": { "smithy.api#enum": [ { - "value": "ClientSpecified" + "value": "ClientSpecified", + "name": "ClientSpecified" }, { - "value": "CaseSensitive" + "value": "CaseSensitive", + "name": "CaseSensitive" } ] } @@ -4095,190 +4107,252 @@ "traits": { "smithy.api#enum": [ { - "value": "ActivationKeyExpired" + "value": "ActivationKeyExpired", + "name": "ActivationKeyExpired" }, { - "value": "ActivationKeyInvalid" + "value": "ActivationKeyInvalid", + "name": "ActivationKeyInvalid" }, { - "value": "ActivationKeyNotFound" + "value": "ActivationKeyNotFound", + "name": "ActivationKeyNotFound" }, { - "value": "GatewayInternalError" + "value": "GatewayInternalError", + "name": "GatewayInternalError" }, { - "value": "GatewayNotConnected" + "value": "GatewayNotConnected", + "name": "GatewayNotConnected" }, { - "value": "GatewayNotFound" + "value": "GatewayNotFound", + "name": "GatewayNotFound" }, { - "value": "GatewayProxyNetworkConnectionBusy" + "value": "GatewayProxyNetworkConnectionBusy", + "name": "GatewayProxyNetworkConnectionBusy" }, { - "value": "AuthenticationFailure" + "value": "AuthenticationFailure", + "name": "AuthenticationFailure" }, { - "value": "BandwidthThrottleScheduleNotFound" + "value": "BandwidthThrottleScheduleNotFound", + "name": "BandwidthThrottleScheduleNotFound" }, { - "value": "Blocked" + "value": "Blocked", + "name": "Blocked" }, { - "value": "CannotExportSnapshot" + "value": "CannotExportSnapshot", + "name": "CannotExportSnapshot" }, { - "value": "ChapCredentialNotFound" + "value": "ChapCredentialNotFound", + "name": "ChapCredentialNotFound" }, { - "value": "DiskAlreadyAllocated" + "value": "DiskAlreadyAllocated", + "name": "DiskAlreadyAllocated" }, { - "value": "DiskDoesNotExist" + "value": "DiskDoesNotExist", + "name": "DiskDoesNotExist" }, { - "value": "DiskSizeGreaterThanVolumeMaxSize" + "value": "DiskSizeGreaterThanVolumeMaxSize", + "name": "DiskSizeGreaterThanVolumeMaxSize" }, { - "value": "DiskSizeLessThanVolumeSize" + "value": "DiskSizeLessThanVolumeSize", + "name": "DiskSizeLessThanVolumeSize" }, { - "value": "DiskSizeNotGigAligned" + "value": "DiskSizeNotGigAligned", + "name": "DiskSizeNotGigAligned" }, { - "value": "DuplicateCertificateInfo" + "value": "DuplicateCertificateInfo", + "name": "DuplicateCertificateInfo" }, { - "value": "DuplicateSchedule" + "value": "DuplicateSchedule", + "name": "DuplicateSchedule" }, { - "value": "EndpointNotFound" + "value": "EndpointNotFound", + "name": "EndpointNotFound" }, { - "value": "IAMNotSupported" + "value": "IAMNotSupported", + "name": "IAMNotSupported" }, { - "value": "InitiatorInvalid" + "value": "InitiatorInvalid", + "name": "InitiatorInvalid" }, { - "value": "InitiatorNotFound" + "value": "InitiatorNotFound", + "name": "InitiatorNotFound" }, { - "value": "InternalError" + "value": "InternalError", + "name": "InternalError" }, { - "value": "InvalidGateway" + "value": "InvalidGateway", + "name": "InvalidGateway" }, { - "value": "InvalidEndpoint" + "value": "InvalidEndpoint", + "name": "InvalidEndpoint" }, { - "value": "InvalidParameters" + "value": "InvalidParameters", + "name": "InvalidParameters" }, { - "value": "InvalidSchedule" + "value": "InvalidSchedule", + "name": "InvalidSchedule" }, { - "value": "LocalStorageLimitExceeded" + "value": "LocalStorageLimitExceeded", + "name": "LocalStorageLimitExceeded" }, { - "value": "LunAlreadyAllocated " + "value": "LunAlreadyAllocated ", + "name": "LunAlreadyAllocated_" }, { - "value": "LunInvalid" + "value": "LunInvalid", + "name": "LunInvalid" }, { - "value": "JoinDomainInProgress" + "value": "JoinDomainInProgress", + "name": "JoinDomainInProgress" }, { - "value": "MaximumContentLengthExceeded" + "value": "MaximumContentLengthExceeded", + "name": "MaximumContentLengthExceeded" }, { - "value": "MaximumTapeCartridgeCountExceeded" + "value": "MaximumTapeCartridgeCountExceeded", + "name": "MaximumTapeCartridgeCountExceeded" }, { - "value": "MaximumVolumeCountExceeded" + "value": "MaximumVolumeCountExceeded", + "name": "MaximumVolumeCountExceeded" }, { - "value": "NetworkConfigurationChanged" + "value": "NetworkConfigurationChanged", + "name": "NetworkConfigurationChanged" }, { - "value": "NoDisksAvailable" + "value": "NoDisksAvailable", + "name": "NoDisksAvailable" }, { - "value": "NotImplemented" + "value": "NotImplemented", + "name": "NotImplemented" }, { - "value": "NotSupported" + "value": "NotSupported", + "name": "NotSupported" }, { - "value": "OperationAborted" + "value": "OperationAborted", + "name": "OperationAborted" }, { - "value": "OutdatedGateway" + "value": "OutdatedGateway", + "name": "OutdatedGateway" }, { - "value": "ParametersNotImplemented" + "value": "ParametersNotImplemented", + "name": "ParametersNotImplemented" }, { - "value": "RegionInvalid" + "value": "RegionInvalid", + "name": "RegionInvalid" }, { - "value": "RequestTimeout" + "value": "RequestTimeout", + "name": "RequestTimeout" }, { - "value": "ServiceUnavailable" + "value": "ServiceUnavailable", + "name": "ServiceUnavailable" }, { - "value": "SnapshotDeleted" + "value": "SnapshotDeleted", + "name": "SnapshotDeleted" }, { - "value": "SnapshotIdInvalid" + "value": "SnapshotIdInvalid", + "name": "SnapshotIdInvalid" }, { - "value": "SnapshotInProgress" + "value": "SnapshotInProgress", + "name": "SnapshotInProgress" }, { - "value": "SnapshotNotFound" + "value": "SnapshotNotFound", + "name": "SnapshotNotFound" }, { - "value": "SnapshotScheduleNotFound" + "value": "SnapshotScheduleNotFound", + "name": "SnapshotScheduleNotFound" }, { - "value": "StagingAreaFull" + "value": "StagingAreaFull", + "name": "StagingAreaFull" }, { - "value": "StorageFailure" + "value": "StorageFailure", + "name": "StorageFailure" }, { - "value": "TapeCartridgeNotFound" + "value": "TapeCartridgeNotFound", + "name": "TapeCartridgeNotFound" }, { - "value": "TargetAlreadyExists" + "value": "TargetAlreadyExists", + "name": "TargetAlreadyExists" }, { - "value": "TargetInvalid" + "value": "TargetInvalid", + "name": "TargetInvalid" }, { - "value": "TargetNotFound" + "value": "TargetNotFound", + "name": "TargetNotFound" }, { - "value": "UnauthorizedOperation" + "value": "UnauthorizedOperation", + "name": "UnauthorizedOperation" }, { - "value": "VolumeAlreadyExists" + "value": "VolumeAlreadyExists", + "name": "VolumeAlreadyExists" }, { - "value": "VolumeIdInvalid" + "value": "VolumeIdInvalid", + "name": "VolumeIdInvalid" }, { - "value": "VolumeInUse" + "value": "VolumeInUse", + "name": "VolumeInUse" }, { - "value": "VolumeNotFound" + "value": "VolumeNotFound", + "name": "VolumeNotFound" }, { - "value": "VolumeNotReady" + "value": "VolumeNotReady", + "name": "VolumeNotReady" } ] } @@ -4382,10 +4456,12 @@ "smithy.api#documentation": "

The type of the file share.

", "smithy.api#enum": [ { - "value": "NFS" + "value": "NFS", + "name": "NFS" }, { - "value": "SMB" + "value": "SMB", + "name": "SMB" } ] } @@ -4575,19 +4651,24 @@ "traits": { "smithy.api#enum": [ { - "value": "VMWARE" + "value": "VMWARE", + "name": "VMWARE" }, { - "value": "HYPER-V" + "value": "HYPER-V", + "name": "HYPER_V" }, { - "value": "EC2" + "value": "EC2", + "name": "EC2" }, { - "value": "KVM" + "value": "KVM", + "name": "KVM" }, { - "value": "OTHER" + "value": "OTHER", + "name": "OTHER" } ] } @@ -5716,25 +5797,32 @@ "smithy.api#documentation": "

A value that sets the access control list (ACL) permission for objects in the S3 bucket\n that a file gateway puts objects into. The default value is private.

", "smithy.api#enum": [ { - "value": "private" + "value": "private", + "name": "private" }, { - "value": "public-read" + "value": "public-read", + "name": "public_read" }, { - "value": "public-read-write" + "value": "public-read-write", + "name": "public_read_write" }, { - "value": "authenticated-read" + "value": "authenticated-read", + "name": "authenticated_read" }, { - "value": "bucket-owner-read" + "value": "bucket-owner-read", + "name": "bucket_owner_read" }, { - "value": "bucket-owner-full-control" + "value": "bucket-owner-full-control", + "name": "bucket_owner_full_control" }, { - "value": "aws-exec-read" + "value": "aws-exec-read", + "name": "aws_exec_read" } ] } @@ -5863,10 +5951,12 @@ "traits": { "smithy.api#enum": [ { - "value": "ACTIVE" + "value": "ACTIVE", + "name": "ACTIVE" }, { - "value": "DELETED" + "value": "DELETED", + "name": "DELETED" } ] } @@ -6079,13 +6169,16 @@ "traits": { "smithy.api#enum": [ { - "value": "COMPLIANCE" + "value": "COMPLIANCE", + "name": "COMPLIANCE" }, { - "value": "GOVERNANCE" + "value": "GOVERNANCE", + "name": "GOVERNANCE" }, { - "value": "NONE" + "value": "NONE", + "name": "NONE" } ] } @@ -6371,13 +6464,16 @@ "traits": { "smithy.api#enum": [ { - "value": "ClientSpecified" + "value": "ClientSpecified", + "name": "ClientSpecified" }, { - "value": "MandatorySigning" + "value": "MandatorySigning", + "name": "MandatorySigning" }, { - "value": "MandatoryEncryption" + "value": "MandatoryEncryption", + "name": "MandatoryEncryption" } ] } @@ -7469,10 +7565,12 @@ "traits": { "smithy.api#enum": [ { - "value": "DEEP_ARCHIVE" + "value": "DEEP_ARCHIVE", + "name": "DEEP_ARCHIVE" }, { - "value": "GLACIER" + "value": "GLACIER", + "name": "GLACIER" } ] } diff --git a/codegen/sdk-codegen/aws-models/swf.2012-01-25.json b/codegen/sdk-codegen/aws-models/swf.2012-01-25.json index a501e193621..cd7586a4cd3 100644 --- a/codegen/sdk-codegen/aws-models/swf.2012-01-25.json +++ b/codegen/sdk-codegen/aws-models/swf.2012-01-25.json @@ -359,16 +359,20 @@ "traits": { "smithy.api#enum": [ { - "value": "START_TO_CLOSE" + "value": "START_TO_CLOSE", + "name": "START_TO_CLOSE" }, { - "value": "SCHEDULE_TO_START" + "value": "SCHEDULE_TO_START", + "name": "SCHEDULE_TO_START" }, { - "value": "SCHEDULE_TO_CLOSE" + "value": "SCHEDULE_TO_CLOSE", + "name": "SCHEDULE_TO_CLOSE" }, { - "value": "HEARTBEAT" + "value": "HEARTBEAT", + "name": "HEARTBEAT" } ] } @@ -558,10 +562,12 @@ "traits": { "smithy.api#enum": [ { - "value": "TIMER_ID_UNKNOWN" + "value": "TIMER_ID_UNKNOWN", + "name": "TIMER_ID_UNKNOWN" }, { - "value": "OPERATION_NOT_PERMITTED" + "value": "OPERATION_NOT_PERMITTED", + "name": "OPERATION_NOT_PERMITTED" } ] } @@ -614,10 +620,12 @@ "traits": { "smithy.api#enum": [ { - "value": "UNHANDLED_DECISION" + "value": "UNHANDLED_DECISION", + "name": "UNHANDLED_DECISION" }, { - "value": "OPERATION_NOT_PERMITTED" + "value": "OPERATION_NOT_PERMITTED", + "name": "OPERATION_NOT_PERMITTED" } ] } @@ -661,13 +669,16 @@ "traits": { "smithy.api#enum": [ { - "value": "TERMINATE" + "value": "TERMINATE", + "name": "TERMINATE" }, { - "value": "REQUEST_CANCEL" + "value": "REQUEST_CANCEL", + "name": "REQUEST_CANCEL" }, { - "value": "ABANDON" + "value": "ABANDON", + "name": "ABANDON" } ] } @@ -917,22 +928,28 @@ "traits": { "smithy.api#enum": [ { - "value": "COMPLETED" + "value": "COMPLETED", + "name": "COMPLETED" }, { - "value": "FAILED" + "value": "FAILED", + "name": "FAILED" }, { - "value": "CANCELED" + "value": "CANCELED", + "name": "CANCELED" }, { - "value": "TERMINATED" + "value": "TERMINATED", + "name": "TERMINATED" }, { - "value": "CONTINUED_AS_NEW" + "value": "CONTINUED_AS_NEW", + "name": "CONTINUED_AS_NEW" }, { - "value": "TIMED_OUT" + "value": "TIMED_OUT", + "name": "TIMED_OUT" } ] } @@ -971,10 +988,12 @@ "traits": { "smithy.api#enum": [ { - "value": "UNHANDLED_DECISION" + "value": "UNHANDLED_DECISION", + "name": "UNHANDLED_DECISION" }, { - "value": "OPERATION_NOT_PERMITTED" + "value": "OPERATION_NOT_PERMITTED", + "name": "OPERATION_NOT_PERMITTED" } ] } @@ -1068,31 +1087,40 @@ "traits": { "smithy.api#enum": [ { - "value": "UNHANDLED_DECISION" + "value": "UNHANDLED_DECISION", + "name": "UNHANDLED_DECISION" }, { - "value": "WORKFLOW_TYPE_DEPRECATED" + "value": "WORKFLOW_TYPE_DEPRECATED", + "name": "WORKFLOW_TYPE_DEPRECATED" }, { - "value": "WORKFLOW_TYPE_DOES_NOT_EXIST" + "value": "WORKFLOW_TYPE_DOES_NOT_EXIST", + "name": "WORKFLOW_TYPE_DOES_NOT_EXIST" }, { - "value": "DEFAULT_EXECUTION_START_TO_CLOSE_TIMEOUT_UNDEFINED" + "value": "DEFAULT_EXECUTION_START_TO_CLOSE_TIMEOUT_UNDEFINED", + "name": "DEFAULT_EXECUTION_START_TO_CLOSE_TIMEOUT_UNDEFINED" }, { - "value": "DEFAULT_TASK_START_TO_CLOSE_TIMEOUT_UNDEFINED" + "value": "DEFAULT_TASK_START_TO_CLOSE_TIMEOUT_UNDEFINED", + "name": "DEFAULT_TASK_START_TO_CLOSE_TIMEOUT_UNDEFINED" }, { - "value": "DEFAULT_TASK_LIST_UNDEFINED" + "value": "DEFAULT_TASK_LIST_UNDEFINED", + "name": "DEFAULT_TASK_LIST_UNDEFINED" }, { - "value": "DEFAULT_CHILD_POLICY_UNDEFINED" + "value": "DEFAULT_CHILD_POLICY_UNDEFINED", + "name": "DEFAULT_CHILD_POLICY_UNDEFINED" }, { - "value": "CONTINUE_AS_NEW_WORKFLOW_EXECUTION_RATE_EXCEEDED" + "value": "CONTINUE_AS_NEW_WORKFLOW_EXECUTION_RATE_EXCEEDED", + "name": "CONTINUE_AS_NEW_WORKFLOW_EXECUTION_RATE_EXCEEDED" }, { - "value": "OPERATION_NOT_PERMITTED" + "value": "OPERATION_NOT_PERMITTED", + "name": "OPERATION_NOT_PERMITTED" } ] } @@ -1603,7 +1631,8 @@ "traits": { "smithy.api#enum": [ { - "value": "START_TO_CLOSE" + "value": "START_TO_CLOSE", + "name": "START_TO_CLOSE" } ] } @@ -1613,43 +1642,56 @@ "traits": { "smithy.api#enum": [ { - "value": "ScheduleActivityTask" + "value": "ScheduleActivityTask", + "name": "ScheduleActivityTask" }, { - "value": "RequestCancelActivityTask" + "value": "RequestCancelActivityTask", + "name": "RequestCancelActivityTask" }, { - "value": "CompleteWorkflowExecution" + "value": "CompleteWorkflowExecution", + "name": "CompleteWorkflowExecution" }, { - "value": "FailWorkflowExecution" + "value": "FailWorkflowExecution", + "name": "FailWorkflowExecution" }, { - "value": "CancelWorkflowExecution" + "value": "CancelWorkflowExecution", + "name": "CancelWorkflowExecution" }, { - "value": "ContinueAsNewWorkflowExecution" + "value": "ContinueAsNewWorkflowExecution", + "name": "ContinueAsNewWorkflowExecution" }, { - "value": "RecordMarker" + "value": "RecordMarker", + "name": "RecordMarker" }, { - "value": "StartTimer" + "value": "StartTimer", + "name": "StartTimer" }, { - "value": "CancelTimer" + "value": "CancelTimer", + "name": "CancelTimer" }, { - "value": "SignalExternalWorkflowExecution" + "value": "SignalExternalWorkflowExecution", + "name": "SignalExternalWorkflowExecution" }, { - "value": "RequestCancelExternalWorkflowExecution" + "value": "RequestCancelExternalWorkflowExecution", + "name": "RequestCancelExternalWorkflowExecution" }, { - "value": "StartChildWorkflowExecution" + "value": "StartChildWorkflowExecution", + "name": "StartChildWorkflowExecution" }, { - "value": "ScheduleLambdaFunction" + "value": "ScheduleLambdaFunction", + "name": "ScheduleLambdaFunction" } ] } @@ -2109,166 +2151,220 @@ "traits": { "smithy.api#enum": [ { - "value": "WorkflowExecutionStarted" + "value": "WorkflowExecutionStarted", + "name": "WorkflowExecutionStarted" }, { - "value": "WorkflowExecutionCancelRequested" + "value": "WorkflowExecutionCancelRequested", + "name": "WorkflowExecutionCancelRequested" }, { - "value": "WorkflowExecutionCompleted" + "value": "WorkflowExecutionCompleted", + "name": "WorkflowExecutionCompleted" }, { - "value": "CompleteWorkflowExecutionFailed" + "value": "CompleteWorkflowExecutionFailed", + "name": "CompleteWorkflowExecutionFailed" }, { - "value": "WorkflowExecutionFailed" + "value": "WorkflowExecutionFailed", + "name": "WorkflowExecutionFailed" }, { - "value": "FailWorkflowExecutionFailed" + "value": "FailWorkflowExecutionFailed", + "name": "FailWorkflowExecutionFailed" }, { - "value": "WorkflowExecutionTimedOut" + "value": "WorkflowExecutionTimedOut", + "name": "WorkflowExecutionTimedOut" }, { - "value": "WorkflowExecutionCanceled" + "value": "WorkflowExecutionCanceled", + "name": "WorkflowExecutionCanceled" }, { - "value": "CancelWorkflowExecutionFailed" + "value": "CancelWorkflowExecutionFailed", + "name": "CancelWorkflowExecutionFailed" }, { - "value": "WorkflowExecutionContinuedAsNew" + "value": "WorkflowExecutionContinuedAsNew", + "name": "WorkflowExecutionContinuedAsNew" }, { - "value": "ContinueAsNewWorkflowExecutionFailed" + "value": "ContinueAsNewWorkflowExecutionFailed", + "name": "ContinueAsNewWorkflowExecutionFailed" }, { - "value": "WorkflowExecutionTerminated" + "value": "WorkflowExecutionTerminated", + "name": "WorkflowExecutionTerminated" }, { - "value": "DecisionTaskScheduled" + "value": "DecisionTaskScheduled", + "name": "DecisionTaskScheduled" }, { - "value": "DecisionTaskStarted" + "value": "DecisionTaskStarted", + "name": "DecisionTaskStarted" }, { - "value": "DecisionTaskCompleted" + "value": "DecisionTaskCompleted", + "name": "DecisionTaskCompleted" }, { - "value": "DecisionTaskTimedOut" + "value": "DecisionTaskTimedOut", + "name": "DecisionTaskTimedOut" }, { - "value": "ActivityTaskScheduled" + "value": "ActivityTaskScheduled", + "name": "ActivityTaskScheduled" }, { - "value": "ScheduleActivityTaskFailed" + "value": "ScheduleActivityTaskFailed", + "name": "ScheduleActivityTaskFailed" }, { - "value": "ActivityTaskStarted" + "value": "ActivityTaskStarted", + "name": "ActivityTaskStarted" }, { - "value": "ActivityTaskCompleted" + "value": "ActivityTaskCompleted", + "name": "ActivityTaskCompleted" }, { - "value": "ActivityTaskFailed" + "value": "ActivityTaskFailed", + "name": "ActivityTaskFailed" }, { - "value": "ActivityTaskTimedOut" + "value": "ActivityTaskTimedOut", + "name": "ActivityTaskTimedOut" }, { - "value": "ActivityTaskCanceled" + "value": "ActivityTaskCanceled", + "name": "ActivityTaskCanceled" }, { - "value": "ActivityTaskCancelRequested" + "value": "ActivityTaskCancelRequested", + "name": "ActivityTaskCancelRequested" }, { - "value": "RequestCancelActivityTaskFailed" + "value": "RequestCancelActivityTaskFailed", + "name": "RequestCancelActivityTaskFailed" }, { - "value": "WorkflowExecutionSignaled" + "value": "WorkflowExecutionSignaled", + "name": "WorkflowExecutionSignaled" }, { - "value": "MarkerRecorded" + "value": "MarkerRecorded", + "name": "MarkerRecorded" }, { - "value": "RecordMarkerFailed" + "value": "RecordMarkerFailed", + "name": "RecordMarkerFailed" }, { - "value": "TimerStarted" + "value": "TimerStarted", + "name": "TimerStarted" }, { - "value": "StartTimerFailed" + "value": "StartTimerFailed", + "name": "StartTimerFailed" }, { - "value": "TimerFired" + "value": "TimerFired", + "name": "TimerFired" }, { - "value": "TimerCanceled" + "value": "TimerCanceled", + "name": "TimerCanceled" }, { - "value": "CancelTimerFailed" + "value": "CancelTimerFailed", + "name": "CancelTimerFailed" }, { - "value": "StartChildWorkflowExecutionInitiated" + "value": "StartChildWorkflowExecutionInitiated", + "name": "StartChildWorkflowExecutionInitiated" }, { - "value": "StartChildWorkflowExecutionFailed" + "value": "StartChildWorkflowExecutionFailed", + "name": "StartChildWorkflowExecutionFailed" }, { - "value": "ChildWorkflowExecutionStarted" + "value": "ChildWorkflowExecutionStarted", + "name": "ChildWorkflowExecutionStarted" }, { - "value": "ChildWorkflowExecutionCompleted" + "value": "ChildWorkflowExecutionCompleted", + "name": "ChildWorkflowExecutionCompleted" }, { - "value": "ChildWorkflowExecutionFailed" + "value": "ChildWorkflowExecutionFailed", + "name": "ChildWorkflowExecutionFailed" }, { - "value": "ChildWorkflowExecutionTimedOut" + "value": "ChildWorkflowExecutionTimedOut", + "name": "ChildWorkflowExecutionTimedOut" }, { - "value": "ChildWorkflowExecutionCanceled" + "value": "ChildWorkflowExecutionCanceled", + "name": "ChildWorkflowExecutionCanceled" }, { - "value": "ChildWorkflowExecutionTerminated" + "value": "ChildWorkflowExecutionTerminated", + "name": "ChildWorkflowExecutionTerminated" }, { - "value": "SignalExternalWorkflowExecutionInitiated" + "value": "SignalExternalWorkflowExecutionInitiated", + "name": "SignalExternalWorkflowExecutionInitiated" }, { - "value": "SignalExternalWorkflowExecutionFailed" + "value": "SignalExternalWorkflowExecutionFailed", + "name": "SignalExternalWorkflowExecutionFailed" }, { - "value": "ExternalWorkflowExecutionSignaled" + "value": "ExternalWorkflowExecutionSignaled", + "name": "ExternalWorkflowExecutionSignaled" }, { - "value": "RequestCancelExternalWorkflowExecutionInitiated" + "value": "RequestCancelExternalWorkflowExecutionInitiated", + "name": "RequestCancelExternalWorkflowExecutionInitiated" }, { - "value": "RequestCancelExternalWorkflowExecutionFailed" + "value": "RequestCancelExternalWorkflowExecutionFailed", + "name": "RequestCancelExternalWorkflowExecutionFailed" }, { - "value": "ExternalWorkflowExecutionCancelRequested" + "value": "ExternalWorkflowExecutionCancelRequested", + "name": "ExternalWorkflowExecutionCancelRequested" }, { - "value": "LambdaFunctionScheduled" + "value": "LambdaFunctionScheduled", + "name": "LambdaFunctionScheduled" }, { - "value": "LambdaFunctionStarted" + "value": "LambdaFunctionStarted", + "name": "LambdaFunctionStarted" }, { - "value": "LambdaFunctionCompleted" + "value": "LambdaFunctionCompleted", + "name": "LambdaFunctionCompleted" }, { - "value": "LambdaFunctionFailed" + "value": "LambdaFunctionFailed", + "name": "LambdaFunctionFailed" }, { - "value": "LambdaFunctionTimedOut" + "value": "LambdaFunctionTimedOut", + "name": "LambdaFunctionTimedOut" }, { - "value": "ScheduleLambdaFunctionFailed" + "value": "ScheduleLambdaFunctionFailed", + "name": "ScheduleLambdaFunctionFailed" }, { - "value": "StartLambdaFunctionFailed" + "value": "StartLambdaFunctionFailed", + "name": "StartLambdaFunctionFailed" } ] } @@ -2278,10 +2374,12 @@ "traits": { "smithy.api#enum": [ { - "value": "OPEN" + "value": "OPEN", + "name": "OPEN" }, { - "value": "CLOSED" + "value": "CLOSED", + "name": "CLOSED" } ] } @@ -2376,10 +2474,12 @@ "traits": { "smithy.api#enum": [ { - "value": "UNHANDLED_DECISION" + "value": "UNHANDLED_DECISION", + "name": "UNHANDLED_DECISION" }, { - "value": "OPERATION_NOT_PERMITTED" + "value": "OPERATION_NOT_PERMITTED", + "name": "OPERATION_NOT_PERMITTED" } ] } @@ -3051,7 +3151,8 @@ "traits": { "smithy.api#enum": [ { - "value": "START_TO_CLOSE" + "value": "START_TO_CLOSE", + "name": "START_TO_CLOSE" } ] } @@ -3783,7 +3884,8 @@ "traits": { "smithy.api#enum": [ { - "value": "OPERATION_NOT_PERMITTED" + "value": "OPERATION_NOT_PERMITTED", + "name": "OPERATION_NOT_PERMITTED" } ] } @@ -4058,10 +4160,12 @@ "traits": { "smithy.api#enum": [ { - "value": "REGISTERED" + "value": "REGISTERED", + "name": "REGISTERED" }, { - "value": "DEPRECATED" + "value": "DEPRECATED", + "name": "DEPRECATED" } ] } @@ -4086,10 +4190,12 @@ "traits": { "smithy.api#enum": [ { - "value": "ACTIVITY_ID_UNKNOWN" + "value": "ACTIVITY_ID_UNKNOWN", + "name": "ACTIVITY_ID_UNKNOWN" }, { - "value": "OPERATION_NOT_PERMITTED" + "value": "OPERATION_NOT_PERMITTED", + "name": "OPERATION_NOT_PERMITTED" } ] } @@ -4155,13 +4261,16 @@ "traits": { "smithy.api#enum": [ { - "value": "UNKNOWN_EXTERNAL_WORKFLOW_EXECUTION" + "value": "UNKNOWN_EXTERNAL_WORKFLOW_EXECUTION", + "name": "UNKNOWN_EXTERNAL_WORKFLOW_EXECUTION" }, { - "value": "REQUEST_CANCEL_EXTERNAL_WORKFLOW_EXECUTION_RATE_EXCEEDED" + "value": "REQUEST_CANCEL_EXTERNAL_WORKFLOW_EXECUTION_RATE_EXCEEDED", + "name": "REQUEST_CANCEL_EXTERNAL_WORKFLOW_EXECUTION_RATE_EXCEEDED" }, { - "value": "OPERATION_NOT_PERMITTED" + "value": "OPERATION_NOT_PERMITTED", + "name": "OPERATION_NOT_PERMITTED" } ] } @@ -4588,37 +4697,48 @@ "traits": { "smithy.api#enum": [ { - "value": "ACTIVITY_TYPE_DEPRECATED" + "value": "ACTIVITY_TYPE_DEPRECATED", + "name": "ACTIVITY_TYPE_DEPRECATED" }, { - "value": "ACTIVITY_TYPE_DOES_NOT_EXIST" + "value": "ACTIVITY_TYPE_DOES_NOT_EXIST", + "name": "ACTIVITY_TYPE_DOES_NOT_EXIST" }, { - "value": "ACTIVITY_ID_ALREADY_IN_USE" + "value": "ACTIVITY_ID_ALREADY_IN_USE", + "name": "ACTIVITY_ID_ALREADY_IN_USE" }, { - "value": "OPEN_ACTIVITIES_LIMIT_EXCEEDED" + "value": "OPEN_ACTIVITIES_LIMIT_EXCEEDED", + "name": "OPEN_ACTIVITIES_LIMIT_EXCEEDED" }, { - "value": "ACTIVITY_CREATION_RATE_EXCEEDED" + "value": "ACTIVITY_CREATION_RATE_EXCEEDED", + "name": "ACTIVITY_CREATION_RATE_EXCEEDED" }, { - "value": "DEFAULT_SCHEDULE_TO_CLOSE_TIMEOUT_UNDEFINED" + "value": "DEFAULT_SCHEDULE_TO_CLOSE_TIMEOUT_UNDEFINED", + "name": "DEFAULT_SCHEDULE_TO_CLOSE_TIMEOUT_UNDEFINED" }, { - "value": "DEFAULT_TASK_LIST_UNDEFINED" + "value": "DEFAULT_TASK_LIST_UNDEFINED", + "name": "DEFAULT_TASK_LIST_UNDEFINED" }, { - "value": "DEFAULT_SCHEDULE_TO_START_TIMEOUT_UNDEFINED" + "value": "DEFAULT_SCHEDULE_TO_START_TIMEOUT_UNDEFINED", + "name": "DEFAULT_SCHEDULE_TO_START_TIMEOUT_UNDEFINED" }, { - "value": "DEFAULT_START_TO_CLOSE_TIMEOUT_UNDEFINED" + "value": "DEFAULT_START_TO_CLOSE_TIMEOUT_UNDEFINED", + "name": "DEFAULT_START_TO_CLOSE_TIMEOUT_UNDEFINED" }, { - "value": "DEFAULT_HEARTBEAT_TIMEOUT_UNDEFINED" + "value": "DEFAULT_HEARTBEAT_TIMEOUT_UNDEFINED", + "name": "DEFAULT_HEARTBEAT_TIMEOUT_UNDEFINED" }, { - "value": "OPERATION_NOT_PERMITTED" + "value": "OPERATION_NOT_PERMITTED", + "name": "OPERATION_NOT_PERMITTED" } ] } @@ -4704,16 +4824,20 @@ "traits": { "smithy.api#enum": [ { - "value": "ID_ALREADY_IN_USE" + "value": "ID_ALREADY_IN_USE", + "name": "ID_ALREADY_IN_USE" }, { - "value": "OPEN_LAMBDA_FUNCTIONS_LIMIT_EXCEEDED" + "value": "OPEN_LAMBDA_FUNCTIONS_LIMIT_EXCEEDED", + "name": "OPEN_LAMBDA_FUNCTIONS_LIMIT_EXCEEDED" }, { - "value": "LAMBDA_FUNCTION_CREATION_RATE_EXCEEDED" + "value": "LAMBDA_FUNCTION_CREATION_RATE_EXCEEDED", + "name": "LAMBDA_FUNCTION_CREATION_RATE_EXCEEDED" }, { - "value": "LAMBDA_SERVICE_NOT_AVAILABLE_IN_REGION" + "value": "LAMBDA_SERVICE_NOT_AVAILABLE_IN_REGION", + "name": "LAMBDA_SERVICE_NOT_AVAILABLE_IN_REGION" } ] } @@ -4799,13 +4923,16 @@ "traits": { "smithy.api#enum": [ { - "value": "UNKNOWN_EXTERNAL_WORKFLOW_EXECUTION" + "value": "UNKNOWN_EXTERNAL_WORKFLOW_EXECUTION", + "name": "UNKNOWN_EXTERNAL_WORKFLOW_EXECUTION" }, { - "value": "SIGNAL_EXTERNAL_WORKFLOW_EXECUTION_RATE_EXCEEDED" + "value": "SIGNAL_EXTERNAL_WORKFLOW_EXECUTION_RATE_EXCEEDED", + "name": "SIGNAL_EXTERNAL_WORKFLOW_EXECUTION_RATE_EXCEEDED" }, { - "value": "OPERATION_NOT_PERMITTED" + "value": "OPERATION_NOT_PERMITTED", + "name": "OPERATION_NOT_PERMITTED" } ] } @@ -5185,37 +5312,48 @@ "traits": { "smithy.api#enum": [ { - "value": "WORKFLOW_TYPE_DOES_NOT_EXIST" + "value": "WORKFLOW_TYPE_DOES_NOT_EXIST", + "name": "WORKFLOW_TYPE_DOES_NOT_EXIST" }, { - "value": "WORKFLOW_TYPE_DEPRECATED" + "value": "WORKFLOW_TYPE_DEPRECATED", + "name": "WORKFLOW_TYPE_DEPRECATED" }, { - "value": "OPEN_CHILDREN_LIMIT_EXCEEDED" + "value": "OPEN_CHILDREN_LIMIT_EXCEEDED", + "name": "OPEN_CHILDREN_LIMIT_EXCEEDED" }, { - "value": "OPEN_WORKFLOWS_LIMIT_EXCEEDED" + "value": "OPEN_WORKFLOWS_LIMIT_EXCEEDED", + "name": "OPEN_WORKFLOWS_LIMIT_EXCEEDED" }, { - "value": "CHILD_CREATION_RATE_EXCEEDED" + "value": "CHILD_CREATION_RATE_EXCEEDED", + "name": "CHILD_CREATION_RATE_EXCEEDED" }, { - "value": "WORKFLOW_ALREADY_RUNNING" + "value": "WORKFLOW_ALREADY_RUNNING", + "name": "WORKFLOW_ALREADY_RUNNING" }, { - "value": "DEFAULT_EXECUTION_START_TO_CLOSE_TIMEOUT_UNDEFINED" + "value": "DEFAULT_EXECUTION_START_TO_CLOSE_TIMEOUT_UNDEFINED", + "name": "DEFAULT_EXECUTION_START_TO_CLOSE_TIMEOUT_UNDEFINED" }, { - "value": "DEFAULT_TASK_LIST_UNDEFINED" + "value": "DEFAULT_TASK_LIST_UNDEFINED", + "name": "DEFAULT_TASK_LIST_UNDEFINED" }, { - "value": "DEFAULT_TASK_START_TO_CLOSE_TIMEOUT_UNDEFINED" + "value": "DEFAULT_TASK_START_TO_CLOSE_TIMEOUT_UNDEFINED", + "name": "DEFAULT_TASK_START_TO_CLOSE_TIMEOUT_UNDEFINED" }, { - "value": "DEFAULT_CHILD_POLICY_UNDEFINED" + "value": "DEFAULT_CHILD_POLICY_UNDEFINED", + "name": "DEFAULT_CHILD_POLICY_UNDEFINED" }, { - "value": "OPERATION_NOT_PERMITTED" + "value": "OPERATION_NOT_PERMITTED", + "name": "OPERATION_NOT_PERMITTED" } ] } @@ -5359,7 +5497,8 @@ "traits": { "smithy.api#enum": [ { - "value": "ASSUME_ROLE_FAILED" + "value": "ASSUME_ROLE_FAILED", + "name": "ASSUME_ROLE_FAILED" } ] } @@ -5423,16 +5562,20 @@ "traits": { "smithy.api#enum": [ { - "value": "TIMER_ID_ALREADY_IN_USE" + "value": "TIMER_ID_ALREADY_IN_USE", + "name": "TIMER_ID_ALREADY_IN_USE" }, { - "value": "OPEN_TIMERS_LIMIT_EXCEEDED" + "value": "OPEN_TIMERS_LIMIT_EXCEEDED", + "name": "OPEN_TIMERS_LIMIT_EXCEEDED" }, { - "value": "TIMER_CREATION_RATE_EXCEEDED" + "value": "TIMER_CREATION_RATE_EXCEEDED", + "name": "TIMER_CREATION_RATE_EXCEEDED" }, { - "value": "OPERATION_NOT_PERMITTED" + "value": "OPERATION_NOT_PERMITTED", + "name": "OPERATION_NOT_PERMITTED" } ] } @@ -6114,7 +6257,8 @@ "traits": { "smithy.api#enum": [ { - "value": "CHILD_POLICY_APPLIED" + "value": "CHILD_POLICY_APPLIED", + "name": "CHILD_POLICY_APPLIED" } ] } @@ -6674,13 +6818,16 @@ "traits": { "smithy.api#enum": [ { - "value": "CHILD_POLICY_APPLIED" + "value": "CHILD_POLICY_APPLIED", + "name": "CHILD_POLICY_APPLIED" }, { - "value": "EVENT_LIMIT_EXCEEDED" + "value": "EVENT_LIMIT_EXCEEDED", + "name": "EVENT_LIMIT_EXCEEDED" }, { - "value": "OPERATOR_INITIATED" + "value": "OPERATOR_INITIATED", + "name": "OPERATOR_INITIATED" } ] } @@ -6745,7 +6892,8 @@ "traits": { "smithy.api#enum": [ { - "value": "START_TO_CLOSE" + "value": "START_TO_CLOSE", + "name": "START_TO_CLOSE" } ] } diff --git a/codegen/sdk-codegen/aws-models/wellarchitected.2020-03-31.json b/codegen/sdk-codegen/aws-models/wellarchitected.2020-03-31.json new file mode 100644 index 00000000000..ffa8029093e --- /dev/null +++ b/codegen/sdk-codegen/aws-models/wellarchitected.2020-03-31.json @@ -0,0 +1,4024 @@ +{ + "smithy": "1.0", + "metadata": { + "suppressions": [ + { + "id": "HttpMethodSemantics", + "namespace": "*" + }, + { + "id": "HttpResponseCodeSemantics", + "namespace": "*" + }, + { + "id": "PaginatedTrait", + "namespace": "*" + }, + { + "id": "HttpHeaderTrait", + "namespace": "*" + }, + { + "id": "HttpUriConflict", + "namespace": "*" + }, + { + "id": "Service", + "namespace": "*" + } + ] + }, + "shapes": { + "com.amazonaws.wellarchitected#AccessDeniedException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.wellarchitected#ExceptionMessage", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

User does not have sufficient access to perform this action.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.wellarchitected#Answer": { + "type": "structure", + "members": { + "QuestionId": { + "target": "com.amazonaws.wellarchitected#QuestionId" + }, + "PillarId": { + "target": "com.amazonaws.wellarchitected#PillarId" + }, + "QuestionTitle": { + "target": "com.amazonaws.wellarchitected#QuestionTitle" + }, + "QuestionDescription": { + "target": "com.amazonaws.wellarchitected#QuestionDescription" + }, + "ImprovementPlanUrl": { + "target": "com.amazonaws.wellarchitected#ImprovementPlanUrl" + }, + "HelpfulResourceUrl": { + "target": "com.amazonaws.wellarchitected#HelpfulResourceUrl" + }, + "Choices": { + "target": "com.amazonaws.wellarchitected#Choices" + }, + "SelectedChoices": { + "target": "com.amazonaws.wellarchitected#SelectedChoices" + }, + "IsApplicable": { + "target": "com.amazonaws.wellarchitected#IsApplicable" + }, + "Risk": { + "target": "com.amazonaws.wellarchitected#Risk" + }, + "Notes": { + "target": "com.amazonaws.wellarchitected#Notes" + } + }, + "traits": { + "smithy.api#documentation": "

An answer of the question.

" + } + }, + "com.amazonaws.wellarchitected#AnswerSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#AnswerSummary" + }, + "traits": { + "smithy.api#documentation": "

List of answer summaries of lens review in a workload.

" + } + }, + "com.amazonaws.wellarchitected#AnswerSummary": { + "type": "structure", + "members": { + "QuestionId": { + "target": "com.amazonaws.wellarchitected#QuestionId" + }, + "PillarId": { + "target": "com.amazonaws.wellarchitected#PillarId" + }, + "QuestionTitle": { + "target": "com.amazonaws.wellarchitected#QuestionTitle" + }, + "Choices": { + "target": "com.amazonaws.wellarchitected#Choices" + }, + "SelectedChoices": { + "target": "com.amazonaws.wellarchitected#SelectedChoices" + }, + "IsApplicable": { + "target": "com.amazonaws.wellarchitected#IsApplicable" + }, + "Risk": { + "target": "com.amazonaws.wellarchitected#Risk" + } + }, + "traits": { + "smithy.api#documentation": "

An answer summary of a lens review in a workload.

" + } + }, + "com.amazonaws.wellarchitected#AssociateLenses": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#AssociateLensesInput" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#ConflictException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Associate a lens to a workload.

", + "smithy.api#http": { + "method": "PATCH", + "uri": "/workloads/{WorkloadId}/associateLenses", + "code": 200 + } + } + }, + "com.amazonaws.wellarchitected#AssociateLensesInput": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "LensAliases": { + "target": "com.amazonaws.wellarchitected#LensAliases", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Input to associate lens reviews.

" + } + }, + "com.amazonaws.wellarchitected#AwsAccountId": { + "type": "string", + "traits": { + "smithy.api#documentation": "

An AWS account ID.

", + "smithy.api#pattern": "[0-9]{12}" + } + }, + "com.amazonaws.wellarchitected#AwsRegion": { + "type": "string", + "traits": { + "smithy.api#documentation": "

An AWS Region, for example, us-west-2 or\n ap-northeast-1.

", + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.wellarchitected#Base64String": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The Base64-encoded string representation of a lens review report.

\n

This data can be used to create a PDF file.

" + } + }, + "com.amazonaws.wellarchitected#Choice": { + "type": "structure", + "members": { + "ChoiceId": { + "target": "com.amazonaws.wellarchitected#ChoiceId" + }, + "Title": { + "target": "com.amazonaws.wellarchitected#ChoiceTitle" + }, + "Description": { + "target": "com.amazonaws.wellarchitected#ChoiceDescription" + } + }, + "traits": { + "smithy.api#documentation": "

A choice available to answer question.

" + } + }, + "com.amazonaws.wellarchitected#ChoiceDescription": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The description of a choice.

", + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.wellarchitected#ChoiceId": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The ID of a choice.

", + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.wellarchitected#ChoiceTitle": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The title of a choice.

", + "smithy.api#length": { + "min": 1, + "max": 512 + } + } + }, + "com.amazonaws.wellarchitected#Choices": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#Choice" + }, + "traits": { + "smithy.api#documentation": "

List of choices available for a question.

" + } + }, + "com.amazonaws.wellarchitected#ClientRequestToken": { + "type": "string", + "traits": { + "smithy.api#documentation": "

A unique case-sensitive string used to ensure that this request is idempotent\n (executes only once).

\n

You should not reuse the same token for other requests. If you retry a request with\n the same client request token and the same parameters after it has completed\n successfully, the result of the original request is returned.

\n \n

This token is listed as required, however, if you do not specify it, the AWS SDKs\n automatically generate one for you. If you are not using the AWS SDK or the AWS CLI,\n you must provide this token or the request will fail.

\n " + } + }, + "com.amazonaws.wellarchitected#ConflictException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.wellarchitected#ExceptionMessage", + "traits": { + "smithy.api#required": {} + } + }, + "ResourceId": { + "target": "com.amazonaws.wellarchitected#ExceptionResourceId", + "traits": { + "smithy.api#required": {} + } + }, + "ResourceType": { + "target": "com.amazonaws.wellarchitected#ExceptionResourceType", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The resource already exists.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.wellarchitected#Count": { + "type": "integer", + "traits": { + "smithy.api#documentation": "

A non-negative integer that denotes how many.

", + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.wellarchitected#CreateMilestone": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#CreateMilestoneInput" + }, + "output": { + "target": "com.amazonaws.wellarchitected#CreateMilestoneOutput" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#ConflictException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wellarchitected#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Create a milestone for an existing workload.

", + "smithy.api#http": { + "method": "POST", + "uri": "/workloads/{WorkloadId}/milestones", + "code": 200 + } + } + }, + "com.amazonaws.wellarchitected#CreateMilestoneInput": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "MilestoneName": { + "target": "com.amazonaws.wellarchitected#MilestoneName", + "traits": { + "smithy.api#required": {} + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.wellarchitected#ClientRequestToken", + "traits": { + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Input for milestone creation.

" + } + }, + "com.amazonaws.wellarchitected#CreateMilestoneOutput": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId" + }, + "MilestoneNumber": { + "target": "com.amazonaws.wellarchitected#MilestoneNumber" + } + }, + "traits": { + "smithy.api#documentation": "

Output of a create milestone call.

" + } + }, + "com.amazonaws.wellarchitected#CreateWorkload": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#CreateWorkloadInput" + }, + "output": { + "target": "com.amazonaws.wellarchitected#CreateWorkloadOutput" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#ConflictException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Create a new workload.

\n

The owner of a workload can share the workload with other AWS accounts and IAM users\n in the same AWS Region. Only the owner of a workload can delete it.

\n

For more information, see Defining a Workload in the\n AWS Well-Architected Tool User Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/workloads", + "code": 200 + } + } + }, + "com.amazonaws.wellarchitected#CreateWorkloadInput": { + "type": "structure", + "members": { + "WorkloadName": { + "target": "com.amazonaws.wellarchitected#WorkloadName", + "traits": { + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.wellarchitected#WorkloadDescription", + "traits": { + "smithy.api#required": {} + } + }, + "Environment": { + "target": "com.amazonaws.wellarchitected#WorkloadEnvironment", + "traits": { + "smithy.api#required": {} + } + }, + "AccountIds": { + "target": "com.amazonaws.wellarchitected#WorkloadAccountIds" + }, + "AwsRegions": { + "target": "com.amazonaws.wellarchitected#WorkloadAwsRegions" + }, + "NonAwsRegions": { + "target": "com.amazonaws.wellarchitected#WorkloadNonAwsRegions" + }, + "PillarPriorities": { + "target": "com.amazonaws.wellarchitected#WorkloadPillarPriorities" + }, + "ArchitecturalDesign": { + "target": "com.amazonaws.wellarchitected#WorkloadArchitecturalDesign" + }, + "ReviewOwner": { + "target": "com.amazonaws.wellarchitected#WorkloadReviewOwner", + "traits": { + "smithy.api#required": {} + } + }, + "IndustryType": { + "target": "com.amazonaws.wellarchitected#WorkloadIndustryType" + }, + "Industry": { + "target": "com.amazonaws.wellarchitected#WorkloadIndustry" + }, + "Lenses": { + "target": "com.amazonaws.wellarchitected#WorkloadLenses", + "traits": { + "smithy.api#required": {} + } + }, + "Notes": { + "target": "com.amazonaws.wellarchitected#Notes" + }, + "ClientRequestToken": { + "target": "com.amazonaws.wellarchitected#ClientRequestToken", + "traits": { + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Input for workload creation.

" + } + }, + "com.amazonaws.wellarchitected#CreateWorkloadOutput": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId" + }, + "WorkloadArn": { + "target": "com.amazonaws.wellarchitected#WorkloadArn" + } + }, + "traits": { + "smithy.api#documentation": "

Output of a create workload call.

" + } + }, + "com.amazonaws.wellarchitected#CreateWorkloadShare": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#CreateWorkloadShareInput" + }, + "output": { + "target": "com.amazonaws.wellarchitected#CreateWorkloadShareOutput" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#ConflictException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wellarchitected#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Create a workload share.

\n

The owner of a workload can share it with other AWS accounts and IAM users in the same\n AWS Region. Shared access to a workload is not removed until the workload invitation is\n deleted.

\n

For more information, see Sharing a Workload in the\n AWS Well-Architected Tool User Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/workloads/{WorkloadId}/shares", + "code": 200 + } + } + }, + "com.amazonaws.wellarchitected#CreateWorkloadShareInput": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "SharedWith": { + "target": "com.amazonaws.wellarchitected#SharedWith", + "traits": { + "smithy.api#required": {} + } + }, + "PermissionType": { + "target": "com.amazonaws.wellarchitected#PermissionType", + "traits": { + "smithy.api#required": {} + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.wellarchitected#ClientRequestToken", + "traits": { + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Input for Create Workload Share

" + } + }, + "com.amazonaws.wellarchitected#CreateWorkloadShareOutput": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId" + }, + "ShareId": { + "target": "com.amazonaws.wellarchitected#ShareId" + } + }, + "traits": { + "smithy.api#documentation": "

Input for Create Workload Share

" + } + }, + "com.amazonaws.wellarchitected#DeleteWorkload": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#DeleteWorkloadInput" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#ConflictException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Delete an existing workload.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/workloads/{WorkloadId}", + "code": 200 + } + } + }, + "com.amazonaws.wellarchitected#DeleteWorkloadInput": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.wellarchitected#ClientRequestToken", + "traits": { + "smithy.api#httpQuery": "ClientRequestToken", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Input for workload deletion.

" + } + }, + "com.amazonaws.wellarchitected#DeleteWorkloadShare": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#DeleteWorkloadShareInput" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#ConflictException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Delete a workload share.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/workloads/{WorkloadId}/shares/{ShareId}", + "code": 200 + } + } + }, + "com.amazonaws.wellarchitected#DeleteWorkloadShareInput": { + "type": "structure", + "members": { + "ShareId": { + "target": "com.amazonaws.wellarchitected#ShareId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.wellarchitected#ClientRequestToken", + "traits": { + "smithy.api#httpQuery": "ClientRequestToken", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Input for Delete Workload Share

" + } + }, + "com.amazonaws.wellarchitected#DifferenceStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "UPDATED", + "name": "UPDATED" + }, + { + "value": "NEW", + "name": "NEW" + }, + { + "value": "DELETED", + "name": "DELETED" + } + ] + } + }, + "com.amazonaws.wellarchitected#DisassociateLenses": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#DisassociateLensesInput" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#ConflictException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Disassociate a lens from a workload.

\n \n

The AWS Well-Architected Framework lens (wellarchitected) cannot be\n removed from a workload.

\n ", + "smithy.api#http": { + "method": "PATCH", + "uri": "/workloads/{WorkloadId}/disassociateLenses", + "code": 200 + } + } + }, + "com.amazonaws.wellarchitected#DisassociateLensesInput": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "LensAliases": { + "target": "com.amazonaws.wellarchitected#LensAliases", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Input to disassociate lens reviews.

" + } + }, + "com.amazonaws.wellarchitected#ExceptionMessage": { + "type": "string", + "traits": { + "smithy.api#documentation": "

Description of the error.

" + } + }, + "com.amazonaws.wellarchitected#ExceptionResourceId": { + "type": "string", + "traits": { + "smithy.api#documentation": "

Identifier of the resource affected.

" + } + }, + "com.amazonaws.wellarchitected#ExceptionResourceType": { + "type": "string", + "traits": { + "smithy.api#documentation": "

Type of the resource affected.

" + } + }, + "com.amazonaws.wellarchitected#GetAnswer": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#GetAnswerInput" + }, + "output": { + "target": "com.amazonaws.wellarchitected#GetAnswerOutput" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Get lens review.

", + "smithy.api#http": { + "method": "GET", + "uri": "/workloads/{WorkloadId}/lensReviews/{LensAlias}/answers/{QuestionId}", + "code": 200 + } + } + }, + "com.amazonaws.wellarchitected#GetAnswerInput": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "LensAlias": { + "target": "com.amazonaws.wellarchitected#LensAlias", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "QuestionId": { + "target": "com.amazonaws.wellarchitected#QuestionId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "MilestoneNumber": { + "target": "com.amazonaws.wellarchitected#MilestoneNumber", + "traits": { + "smithy.api#httpQuery": "MilestoneNumber" + } + } + }, + "traits": { + "smithy.api#documentation": "

Input to get answer.

" + } + }, + "com.amazonaws.wellarchitected#GetAnswerOutput": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId" + }, + "MilestoneNumber": { + "target": "com.amazonaws.wellarchitected#MilestoneNumber" + }, + "LensAlias": { + "target": "com.amazonaws.wellarchitected#LensAlias" + }, + "Answer": { + "target": "com.amazonaws.wellarchitected#Answer" + } + }, + "traits": { + "smithy.api#documentation": "

Output of a get answer call.

" + } + }, + "com.amazonaws.wellarchitected#GetLensReview": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#GetLensReviewInput" + }, + "output": { + "target": "com.amazonaws.wellarchitected#GetLensReviewOutput" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Get lens review.

", + "smithy.api#http": { + "method": "GET", + "uri": "/workloads/{WorkloadId}/lensReviews/{LensAlias}", + "code": 200 + } + } + }, + "com.amazonaws.wellarchitected#GetLensReviewInput": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "LensAlias": { + "target": "com.amazonaws.wellarchitected#LensAlias", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "MilestoneNumber": { + "target": "com.amazonaws.wellarchitected#MilestoneNumber", + "traits": { + "smithy.api#httpQuery": "MilestoneNumber" + } + } + }, + "traits": { + "smithy.api#documentation": "

Input to get lens review.

" + } + }, + "com.amazonaws.wellarchitected#GetLensReviewOutput": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId" + }, + "MilestoneNumber": { + "target": "com.amazonaws.wellarchitected#MilestoneNumber" + }, + "LensReview": { + "target": "com.amazonaws.wellarchitected#LensReview" + } + }, + "traits": { + "smithy.api#documentation": "

Output of a get lens review call.

" + } + }, + "com.amazonaws.wellarchitected#GetLensReviewReport": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#GetLensReviewReportInput" + }, + "output": { + "target": "com.amazonaws.wellarchitected#GetLensReviewReportOutput" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Get lens review report.

", + "smithy.api#http": { + "method": "GET", + "uri": "/workloads/{WorkloadId}/lensReviews/{LensAlias}/report", + "code": 200 + } + } + }, + "com.amazonaws.wellarchitected#GetLensReviewReportInput": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "LensAlias": { + "target": "com.amazonaws.wellarchitected#LensAlias", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "MilestoneNumber": { + "target": "com.amazonaws.wellarchitected#MilestoneNumber", + "traits": { + "smithy.api#httpQuery": "MilestoneNumber" + } + } + }, + "traits": { + "smithy.api#documentation": "

Input to get lens review report.

" + } + }, + "com.amazonaws.wellarchitected#GetLensReviewReportOutput": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId" + }, + "MilestoneNumber": { + "target": "com.amazonaws.wellarchitected#MilestoneNumber" + }, + "LensReviewReport": { + "target": "com.amazonaws.wellarchitected#LensReviewReport" + } + }, + "traits": { + "smithy.api#documentation": "

Output of a get lens review report call.

" + } + }, + "com.amazonaws.wellarchitected#GetLensVersionDifference": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#GetLensVersionDifferenceInput" + }, + "output": { + "target": "com.amazonaws.wellarchitected#GetLensVersionDifferenceOutput" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Get lens version differences.

", + "smithy.api#http": { + "method": "GET", + "uri": "/lenses/{LensAlias}/versionDifference", + "code": 200 + } + } + }, + "com.amazonaws.wellarchitected#GetLensVersionDifferenceInput": { + "type": "structure", + "members": { + "LensAlias": { + "target": "com.amazonaws.wellarchitected#LensAlias", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "BaseLensVersion": { + "target": "com.amazonaws.wellarchitected#LensVersion", + "traits": { + "smithy.api#documentation": "

The base version of the lens.

", + "smithy.api#httpQuery": "BaseLensVersion", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.wellarchitected#GetLensVersionDifferenceOutput": { + "type": "structure", + "members": { + "LensAlias": { + "target": "com.amazonaws.wellarchitected#LensAlias" + }, + "BaseLensVersion": { + "target": "com.amazonaws.wellarchitected#LensVersion", + "traits": { + "smithy.api#documentation": "

The base version of the lens.

" + } + }, + "LatestLensVersion": { + "target": "com.amazonaws.wellarchitected#LensVersion", + "traits": { + "smithy.api#documentation": "

The latest version of the lens.

" + } + }, + "VersionDifferences": { + "target": "com.amazonaws.wellarchitected#VersionDifferences" + } + } + }, + "com.amazonaws.wellarchitected#GetMilestone": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#GetMilestoneInput" + }, + "output": { + "target": "com.amazonaws.wellarchitected#GetMilestoneOutput" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Get a milestone for an existing workload.

", + "smithy.api#http": { + "method": "GET", + "uri": "/workloads/{WorkloadId}/milestones/{MilestoneNumber}", + "code": 200 + } + } + }, + "com.amazonaws.wellarchitected#GetMilestoneInput": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "MilestoneNumber": { + "target": "com.amazonaws.wellarchitected#MilestoneNumber", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Input to get a milestone.

" + } + }, + "com.amazonaws.wellarchitected#GetMilestoneOutput": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId" + }, + "Milestone": { + "target": "com.amazonaws.wellarchitected#Milestone" + } + }, + "traits": { + "smithy.api#documentation": "

Output of a get milestone call.

" + } + }, + "com.amazonaws.wellarchitected#GetWorkload": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#GetWorkloadInput" + }, + "output": { + "target": "com.amazonaws.wellarchitected#GetWorkloadOutput" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Get an existing workload.

", + "smithy.api#http": { + "method": "GET", + "uri": "/workloads/{WorkloadId}", + "code": 200 + } + } + }, + "com.amazonaws.wellarchitected#GetWorkloadInput": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Input to get a workload.

" + } + }, + "com.amazonaws.wellarchitected#GetWorkloadOutput": { + "type": "structure", + "members": { + "Workload": { + "target": "com.amazonaws.wellarchitected#Workload" + } + }, + "traits": { + "smithy.api#documentation": "

Output of a get workload call.

" + } + }, + "com.amazonaws.wellarchitected#HelpfulResourceUrl": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The helpful resource URL for a question.

", + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "com.amazonaws.wellarchitected#ImprovementPlanUrl": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The improvement plan URL for a question.

", + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "com.amazonaws.wellarchitected#ImprovementSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#ImprovementSummary" + }, + "traits": { + "smithy.api#documentation": "

List of improvement summaries of lens review in a workload.

" + } + }, + "com.amazonaws.wellarchitected#ImprovementSummary": { + "type": "structure", + "members": { + "QuestionId": { + "target": "com.amazonaws.wellarchitected#QuestionId" + }, + "PillarId": { + "target": "com.amazonaws.wellarchitected#PillarId" + }, + "QuestionTitle": { + "target": "com.amazonaws.wellarchitected#QuestionTitle" + }, + "Risk": { + "target": "com.amazonaws.wellarchitected#Risk" + }, + "ImprovementPlanUrl": { + "target": "com.amazonaws.wellarchitected#ImprovementPlanUrl" + } + }, + "traits": { + "smithy.api#documentation": "

An improvement summary of a lens review in a workload.

" + } + }, + "com.amazonaws.wellarchitected#InternalServerException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.wellarchitected#ExceptionMessage", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

There is a problem with the AWS Well-Architected Tool API service.

", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.wellarchitected#IsApplicable": { + "type": "boolean", + "traits": { + "smithy.api#documentation": "

Defines whether this question is applicable to a lens review.

" + } + }, + "com.amazonaws.wellarchitected#IsReviewOwnerUpdateAcknowledged": { + "type": "boolean" + }, + "com.amazonaws.wellarchitected#LensAlias": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The alias of the lens, for example, serverless.

\n

Each lens is identified by its LensSummary$LensAlias.

", + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.wellarchitected#LensAliases": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#LensAlias" + }, + "traits": { + "smithy.api#documentation": "

List of lens aliases to associate or disassociate with a workload.

\n

Identify a lens using its LensSummary$LensAlias.

", + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.wellarchitected#LensDescription": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The description of the lens.

", + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.wellarchitected#LensName": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The full name of the lens.

", + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.wellarchitected#LensReview": { + "type": "structure", + "members": { + "LensAlias": { + "target": "com.amazonaws.wellarchitected#LensAlias" + }, + "LensVersion": { + "target": "com.amazonaws.wellarchitected#LensVersion", + "traits": { + "smithy.api#documentation": "

The version of the lens.

" + } + }, + "LensName": { + "target": "com.amazonaws.wellarchitected#LensName" + }, + "LensStatus": { + "target": "com.amazonaws.wellarchitected#LensStatus", + "traits": { + "smithy.api#documentation": "

The status of the lens.

" + } + }, + "PillarReviewSummaries": { + "target": "com.amazonaws.wellarchitected#PillarReviewSummaries" + }, + "UpdatedAt": { + "target": "com.amazonaws.wellarchitected#Timestamp" + }, + "Notes": { + "target": "com.amazonaws.wellarchitected#Notes" + }, + "RiskCounts": { + "target": "com.amazonaws.wellarchitected#RiskCounts" + }, + "NextToken": { + "target": "com.amazonaws.wellarchitected#NextToken" + } + }, + "traits": { + "smithy.api#documentation": "

A lens review of a question.

" + } + }, + "com.amazonaws.wellarchitected#LensReviewReport": { + "type": "structure", + "members": { + "LensAlias": { + "target": "com.amazonaws.wellarchitected#LensAlias" + }, + "Base64String": { + "target": "com.amazonaws.wellarchitected#Base64String" + } + }, + "traits": { + "smithy.api#documentation": "

A report of a lens review.

" + } + }, + "com.amazonaws.wellarchitected#LensReviewSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#LensReviewSummary" + }, + "traits": { + "smithy.api#documentation": "

List of lens summaries of lens reviews of a workload.

" + } + }, + "com.amazonaws.wellarchitected#LensReviewSummary": { + "type": "structure", + "members": { + "LensAlias": { + "target": "com.amazonaws.wellarchitected#LensAlias" + }, + "LensVersion": { + "target": "com.amazonaws.wellarchitected#LensVersion", + "traits": { + "smithy.api#documentation": "

The version of the lens.

" + } + }, + "LensName": { + "target": "com.amazonaws.wellarchitected#LensName" + }, + "LensStatus": { + "target": "com.amazonaws.wellarchitected#LensStatus", + "traits": { + "smithy.api#documentation": "

The status of the lens.

" + } + }, + "UpdatedAt": { + "target": "com.amazonaws.wellarchitected#Timestamp" + }, + "RiskCounts": { + "target": "com.amazonaws.wellarchitected#RiskCounts" + } + }, + "traits": { + "smithy.api#documentation": "

A lens review summary of a workload.

" + } + }, + "com.amazonaws.wellarchitected#LensStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CURRENT", + "name": "CURRENT" + }, + { + "value": "NOT_CURRENT", + "name": "NOT_CURRENT" + }, + { + "value": "DEPRECATED", + "name": "DEPRECATED" + } + ] + } + }, + "com.amazonaws.wellarchitected#LensSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#LensSummary" + }, + "traits": { + "smithy.api#documentation": "

List of lens summaries of available lenses.

" + } + }, + "com.amazonaws.wellarchitected#LensSummary": { + "type": "structure", + "members": { + "LensAlias": { + "target": "com.amazonaws.wellarchitected#LensAlias" + }, + "LensVersion": { + "target": "com.amazonaws.wellarchitected#LensVersion", + "traits": { + "smithy.api#documentation": "

The version of the lens.

" + } + }, + "LensName": { + "target": "com.amazonaws.wellarchitected#LensName" + }, + "Description": { + "target": "com.amazonaws.wellarchitected#LensDescription" + } + }, + "traits": { + "smithy.api#documentation": "

A lens summary of a lens.

" + } + }, + "com.amazonaws.wellarchitected#LensUpgradeSummary": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId" + }, + "WorkloadName": { + "target": "com.amazonaws.wellarchitected#WorkloadName" + }, + "LensAlias": { + "target": "com.amazonaws.wellarchitected#LensAlias" + }, + "CurrentLensVersion": { + "target": "com.amazonaws.wellarchitected#LensVersion", + "traits": { + "smithy.api#documentation": "

The current version of the lens.

" + } + }, + "LatestLensVersion": { + "target": "com.amazonaws.wellarchitected#LensVersion", + "traits": { + "smithy.api#documentation": "

The latest version of the lens.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Lens upgrade summary return object.

" + } + }, + "com.amazonaws.wellarchitected#LensVersion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.wellarchitected#ListAnswers": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#ListAnswersInput" + }, + "output": { + "target": "com.amazonaws.wellarchitected#ListAnswersOutput" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

List of answers.

", + "smithy.api#http": { + "method": "GET", + "uri": "/workloads/{WorkloadId}/lensReviews/{LensAlias}/answers", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.wellarchitected#ListAnswersInput": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "LensAlias": { + "target": "com.amazonaws.wellarchitected#LensAlias", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "PillarId": { + "target": "com.amazonaws.wellarchitected#PillarId", + "traits": { + "smithy.api#httpQuery": "PillarId" + } + }, + "MilestoneNumber": { + "target": "com.amazonaws.wellarchitected#MilestoneNumber", + "traits": { + "smithy.api#httpQuery": "MilestoneNumber" + } + }, + "NextToken": { + "target": "com.amazonaws.wellarchitected#NextToken", + "traits": { + "smithy.api#httpQuery": "NextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.wellarchitected#ListAnswersMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return for this request.

", + "smithy.api#httpQuery": "MaxResults" + } + } + }, + "traits": { + "smithy.api#documentation": "

Input to list answers.

" + } + }, + "com.amazonaws.wellarchitected#ListAnswersMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.wellarchitected#ListAnswersOutput": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId" + }, + "MilestoneNumber": { + "target": "com.amazonaws.wellarchitected#MilestoneNumber" + }, + "LensAlias": { + "target": "com.amazonaws.wellarchitected#LensAlias" + }, + "AnswerSummaries": { + "target": "com.amazonaws.wellarchitected#AnswerSummaries" + }, + "NextToken": { + "target": "com.amazonaws.wellarchitected#NextToken" + } + }, + "traits": { + "smithy.api#documentation": "

Output of a list answers call.

" + } + }, + "com.amazonaws.wellarchitected#ListLensReviewImprovements": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#ListLensReviewImprovementsInput" + }, + "output": { + "target": "com.amazonaws.wellarchitected#ListLensReviewImprovementsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

List lens review improvements.

", + "smithy.api#http": { + "method": "GET", + "uri": "/workloads/{WorkloadId}/lensReviews/{LensAlias}/improvements", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.wellarchitected#ListLensReviewImprovementsInput": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "LensAlias": { + "target": "com.amazonaws.wellarchitected#LensAlias", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "PillarId": { + "target": "com.amazonaws.wellarchitected#PillarId", + "traits": { + "smithy.api#httpQuery": "PillarId" + } + }, + "MilestoneNumber": { + "target": "com.amazonaws.wellarchitected#MilestoneNumber", + "traits": { + "smithy.api#httpQuery": "MilestoneNumber" + } + }, + "NextToken": { + "target": "com.amazonaws.wellarchitected#NextToken", + "traits": { + "smithy.api#httpQuery": "NextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.wellarchitected#ListLensReviewImprovementsMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return for this request.

", + "smithy.api#httpQuery": "MaxResults" + } + } + }, + "traits": { + "smithy.api#documentation": "

Input to list lens review improvements.

" + } + }, + "com.amazonaws.wellarchitected#ListLensReviewImprovementsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.wellarchitected#ListLensReviewImprovementsOutput": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId" + }, + "MilestoneNumber": { + "target": "com.amazonaws.wellarchitected#MilestoneNumber" + }, + "LensAlias": { + "target": "com.amazonaws.wellarchitected#LensAlias" + }, + "ImprovementSummaries": { + "target": "com.amazonaws.wellarchitected#ImprovementSummaries" + }, + "NextToken": { + "target": "com.amazonaws.wellarchitected#NextToken" + } + }, + "traits": { + "smithy.api#documentation": "

Output of a list lens review improvements call.

" + } + }, + "com.amazonaws.wellarchitected#ListLensReviews": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#ListLensReviewsInput" + }, + "output": { + "target": "com.amazonaws.wellarchitected#ListLensReviewsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

List lens reviews.

", + "smithy.api#http": { + "method": "GET", + "uri": "/workloads/{WorkloadId}/lensReviews", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.wellarchitected#ListLensReviewsInput": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "MilestoneNumber": { + "target": "com.amazonaws.wellarchitected#MilestoneNumber", + "traits": { + "smithy.api#httpQuery": "MilestoneNumber" + } + }, + "NextToken": { + "target": "com.amazonaws.wellarchitected#NextToken", + "traits": { + "smithy.api#httpQuery": "NextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.wellarchitected#MaxResults", + "traits": { + "smithy.api#httpQuery": "MaxResults" + } + } + }, + "traits": { + "smithy.api#documentation": "

Input to list lens reviews.

" + } + }, + "com.amazonaws.wellarchitected#ListLensReviewsOutput": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId" + }, + "MilestoneNumber": { + "target": "com.amazonaws.wellarchitected#MilestoneNumber" + }, + "LensReviewSummaries": { + "target": "com.amazonaws.wellarchitected#LensReviewSummaries" + }, + "NextToken": { + "target": "com.amazonaws.wellarchitected#NextToken" + } + }, + "traits": { + "smithy.api#documentation": "

Output of a list lens reviews call.

" + } + }, + "com.amazonaws.wellarchitected#ListLenses": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#ListLensesInput" + }, + "output": { + "target": "com.amazonaws.wellarchitected#ListLensesOutput" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

List the available lenses.

", + "smithy.api#http": { + "method": "GET", + "uri": "/lenses", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.wellarchitected#ListLensesInput": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.wellarchitected#NextToken", + "traits": { + "smithy.api#httpQuery": "NextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.wellarchitected#MaxResults", + "traits": { + "smithy.api#httpQuery": "MaxResults" + } + } + }, + "traits": { + "smithy.api#documentation": "

Input to list lenses.

" + } + }, + "com.amazonaws.wellarchitected#ListLensesOutput": { + "type": "structure", + "members": { + "LensSummaries": { + "target": "com.amazonaws.wellarchitected#LensSummaries" + }, + "NextToken": { + "target": "com.amazonaws.wellarchitected#NextToken" + } + }, + "traits": { + "smithy.api#documentation": "

Output of a list lenses call.

" + } + }, + "com.amazonaws.wellarchitected#ListMilestones": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#ListMilestonesInput" + }, + "output": { + "target": "com.amazonaws.wellarchitected#ListMilestonesOutput" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

List all milestones for an existing workload.

", + "smithy.api#http": { + "method": "POST", + "uri": "/workloads/{WorkloadId}/milestonesSummaries", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.wellarchitected#ListMilestonesInput": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.wellarchitected#NextToken" + }, + "MaxResults": { + "target": "com.amazonaws.wellarchitected#MaxResults" + } + }, + "traits": { + "smithy.api#documentation": "

Input to list all milestones for a workload.

" + } + }, + "com.amazonaws.wellarchitected#ListMilestonesOutput": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId" + }, + "MilestoneSummaries": { + "target": "com.amazonaws.wellarchitected#MilestoneSummaries" + }, + "NextToken": { + "target": "com.amazonaws.wellarchitected#NextToken" + } + }, + "traits": { + "smithy.api#documentation": "

Output of a list milestones call.

" + } + }, + "com.amazonaws.wellarchitected#ListNotifications": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#ListNotificationsInput" + }, + "output": { + "target": "com.amazonaws.wellarchitected#ListNotificationsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

List lens notifications.

", + "smithy.api#http": { + "method": "POST", + "uri": "/notifications", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.wellarchitected#ListNotificationsInput": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId" + }, + "NextToken": { + "target": "com.amazonaws.wellarchitected#NextToken" + }, + "MaxResults": { + "target": "com.amazonaws.wellarchitected#ListNotificationsMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return for this request.

" + } + } + } + }, + "com.amazonaws.wellarchitected#ListNotificationsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.wellarchitected#ListNotificationsOutput": { + "type": "structure", + "members": { + "NotificationSummaries": { + "target": "com.amazonaws.wellarchitected#NotificationSummaries", + "traits": { + "smithy.api#documentation": "

List of lens notification summaries in a workload.

" + } + }, + "NextToken": { + "target": "com.amazonaws.wellarchitected#NextToken" + } + } + }, + "com.amazonaws.wellarchitected#ListShareInvitations": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#ListShareInvitationsInput" + }, + "output": { + "target": "com.amazonaws.wellarchitected#ListShareInvitationsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

List the workload invitations.

", + "smithy.api#http": { + "method": "GET", + "uri": "/shareInvitations", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.wellarchitected#ListShareInvitationsInput": { + "type": "structure", + "members": { + "WorkloadNamePrefix": { + "target": "com.amazonaws.wellarchitected#WorkloadNamePrefix", + "traits": { + "smithy.api#httpQuery": "WorkloadNamePrefix" + } + }, + "NextToken": { + "target": "com.amazonaws.wellarchitected#NextToken", + "traits": { + "smithy.api#httpQuery": "NextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.wellarchitected#ListShareInvitationsMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return for this request.

", + "smithy.api#httpQuery": "MaxResults" + } + } + }, + "traits": { + "smithy.api#documentation": "

Input for List Share Invitations

" + } + }, + "com.amazonaws.wellarchitected#ListShareInvitationsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.wellarchitected#ListShareInvitationsOutput": { + "type": "structure", + "members": { + "ShareInvitationSummaries": { + "target": "com.amazonaws.wellarchitected#ShareInvitationSummaries", + "traits": { + "smithy.api#documentation": "

List of share invitation summaries in a workload.

" + } + }, + "NextToken": { + "target": "com.amazonaws.wellarchitected#NextToken" + } + }, + "traits": { + "smithy.api#documentation": "

Input for List Share Invitations

" + } + }, + "com.amazonaws.wellarchitected#ListWorkloadShares": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#ListWorkloadSharesInput" + }, + "output": { + "target": "com.amazonaws.wellarchitected#ListWorkloadSharesOutput" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

List the workload shares associated with the workload.

", + "smithy.api#http": { + "method": "GET", + "uri": "/workloads/{WorkloadId}/shares", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.wellarchitected#ListWorkloadSharesInput": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "SharedWithPrefix": { + "target": "com.amazonaws.wellarchitected#SharedWithPrefix", + "traits": { + "smithy.api#documentation": "

The AWS account ID or IAM role with which the workload is shared.

", + "smithy.api#httpQuery": "SharedWithPrefix" + } + }, + "NextToken": { + "target": "com.amazonaws.wellarchitected#NextToken", + "traits": { + "smithy.api#httpQuery": "NextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.wellarchitected#ListWorkloadSharesMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return for this request.

", + "smithy.api#httpQuery": "MaxResults" + } + } + }, + "traits": { + "smithy.api#documentation": "

Input for List Workload Share

" + } + }, + "com.amazonaws.wellarchitected#ListWorkloadSharesMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.wellarchitected#ListWorkloadSharesOutput": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId" + }, + "WorkloadShareSummaries": { + "target": "com.amazonaws.wellarchitected#WorkloadShareSummaries" + }, + "NextToken": { + "target": "com.amazonaws.wellarchitected#NextToken" + } + }, + "traits": { + "smithy.api#documentation": "

Input for List Workload Share

" + } + }, + "com.amazonaws.wellarchitected#ListWorkloads": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#ListWorkloadsInput" + }, + "output": { + "target": "com.amazonaws.wellarchitected#ListWorkloadsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

List workloads. Paginated.

", + "smithy.api#http": { + "method": "POST", + "uri": "/workloadsSummaries", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.wellarchitected#ListWorkloadsInput": { + "type": "structure", + "members": { + "WorkloadNamePrefix": { + "target": "com.amazonaws.wellarchitected#WorkloadNamePrefix" + }, + "NextToken": { + "target": "com.amazonaws.wellarchitected#NextToken" + }, + "MaxResults": { + "target": "com.amazonaws.wellarchitected#ListWorkloadsMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return for this request.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Input to list all workloads.

" + } + }, + "com.amazonaws.wellarchitected#ListWorkloadsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.wellarchitected#ListWorkloadsOutput": { + "type": "structure", + "members": { + "WorkloadSummaries": { + "target": "com.amazonaws.wellarchitected#WorkloadSummaries" + }, + "NextToken": { + "target": "com.amazonaws.wellarchitected#NextToken" + } + }, + "traits": { + "smithy.api#documentation": "

Output of a list workloads call.

" + } + }, + "com.amazonaws.wellarchitected#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return for this request.

", + "smithy.api#range": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.wellarchitected#Milestone": { + "type": "structure", + "members": { + "MilestoneNumber": { + "target": "com.amazonaws.wellarchitected#MilestoneNumber" + }, + "MilestoneName": { + "target": "com.amazonaws.wellarchitected#MilestoneName" + }, + "RecordedAt": { + "target": "com.amazonaws.wellarchitected#Timestamp" + }, + "Workload": { + "target": "com.amazonaws.wellarchitected#Workload" + } + }, + "traits": { + "smithy.api#documentation": "

A milestone return object.

" + } + }, + "com.amazonaws.wellarchitected#MilestoneName": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The name of the milestone in a workload.

\n

Milestone names must be unique within a workload.

", + "smithy.api#length": { + "min": 3, + "max": 100 + } + } + }, + "com.amazonaws.wellarchitected#MilestoneNumber": { + "type": "integer", + "traits": { + "smithy.api#documentation": "

The milestone number.

\n

A workload can have a maximum of 100 milestones.

", + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.wellarchitected#MilestoneSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#MilestoneSummary" + }, + "traits": { + "smithy.api#documentation": "

A list of milestone summaries.

" + } + }, + "com.amazonaws.wellarchitected#MilestoneSummary": { + "type": "structure", + "members": { + "MilestoneNumber": { + "target": "com.amazonaws.wellarchitected#MilestoneNumber" + }, + "MilestoneName": { + "target": "com.amazonaws.wellarchitected#MilestoneName" + }, + "RecordedAt": { + "target": "com.amazonaws.wellarchitected#Timestamp" + }, + "WorkloadSummary": { + "target": "com.amazonaws.wellarchitected#WorkloadSummary" + } + }, + "traits": { + "smithy.api#documentation": "

A milestone summary return object.

" + } + }, + "com.amazonaws.wellarchitected#NextToken": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The token to use to retrieve the next set of results.

" + } + }, + "com.amazonaws.wellarchitected#Notes": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The notes associated with the workload.

", + "smithy.api#length": { + "min": 0, + "max": 2084 + } + } + }, + "com.amazonaws.wellarchitected#NotificationSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#NotificationSummary" + } + }, + "com.amazonaws.wellarchitected#NotificationSummary": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.wellarchitected#NotificationType", + "traits": { + "smithy.api#documentation": "

The type of notification.

" + } + }, + "LensUpgradeSummary": { + "target": "com.amazonaws.wellarchitected#LensUpgradeSummary", + "traits": { + "smithy.api#documentation": "

Summary of lens upgrade.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A notification summary return object.

" + } + }, + "com.amazonaws.wellarchitected#NotificationType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "LENS_VERSION_UPGRADED", + "name": "LENS_VERSION_UPGRADED" + }, + { + "value": "LENS_VERSION_DEPRECATED", + "name": "LENS_VERSION_DEPRECATED" + } + ] + } + }, + "com.amazonaws.wellarchitected#PermissionType": { + "type": "string", + "traits": { + "smithy.api#documentation": "

Permission granted on a workload share.

", + "smithy.api#enum": [ + { + "value": "READONLY", + "name": "READONLY" + }, + { + "value": "CONTRIBUTOR", + "name": "CONTRIBUTOR" + } + ] + } + }, + "com.amazonaws.wellarchitected#PillarDifference": { + "type": "structure", + "members": { + "PillarId": { + "target": "com.amazonaws.wellarchitected#PillarId" + }, + "DifferenceStatus": { + "target": "com.amazonaws.wellarchitected#DifferenceStatus", + "traits": { + "smithy.api#documentation": "

Indicates the type of change to the pillar.

" + } + }, + "QuestionDifferences": { + "target": "com.amazonaws.wellarchitected#QuestionDifferences", + "traits": { + "smithy.api#documentation": "

List of question differences.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A pillar difference return object.

" + } + }, + "com.amazonaws.wellarchitected#PillarDifferences": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#PillarDifference" + } + }, + "com.amazonaws.wellarchitected#PillarId": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The ID used to identify a pillar, for example, security.

\n

A pillar is identified by its PillarReviewSummary$PillarId.

", + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.wellarchitected#PillarName": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The name of the pillar.

", + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.wellarchitected#PillarNotes": { + "type": "map", + "key": { + "target": "com.amazonaws.wellarchitected#PillarId" + }, + "value": { + "target": "com.amazonaws.wellarchitected#Notes" + }, + "traits": { + "smithy.api#documentation": "

List of pillar notes of a lens review in a workload.

" + } + }, + "com.amazonaws.wellarchitected#PillarReviewSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#PillarReviewSummary" + }, + "traits": { + "smithy.api#documentation": "

List of pillar review summaries of lens review in a workload.

" + } + }, + "com.amazonaws.wellarchitected#PillarReviewSummary": { + "type": "structure", + "members": { + "PillarId": { + "target": "com.amazonaws.wellarchitected#PillarId" + }, + "PillarName": { + "target": "com.amazonaws.wellarchitected#PillarName" + }, + "Notes": { + "target": "com.amazonaws.wellarchitected#Notes" + }, + "RiskCounts": { + "target": "com.amazonaws.wellarchitected#RiskCounts" + } + }, + "traits": { + "smithy.api#documentation": "

A pillar review summary of a lens review.

" + } + }, + "com.amazonaws.wellarchitected#QuestionDescription": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The description of the question.

", + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.wellarchitected#QuestionDifference": { + "type": "structure", + "members": { + "QuestionId": { + "target": "com.amazonaws.wellarchitected#QuestionId" + }, + "QuestionTitle": { + "target": "com.amazonaws.wellarchitected#QuestionTitle" + }, + "DifferenceStatus": { + "target": "com.amazonaws.wellarchitected#DifferenceStatus", + "traits": { + "smithy.api#documentation": "

Indicates the type of change to the question.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A question difference return object.

" + } + }, + "com.amazonaws.wellarchitected#QuestionDifferences": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#QuestionDifference" + } + }, + "com.amazonaws.wellarchitected#QuestionId": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The ID of the question.

", + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.wellarchitected#QuestionTitle": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The title of the question.

", + "smithy.api#length": { + "min": 1, + "max": 512 + } + } + }, + "com.amazonaws.wellarchitected#QuotaCode": { + "type": "string", + "traits": { + "smithy.api#documentation": "

Service Quotas requirement to identify originating quota.

" + } + }, + "com.amazonaws.wellarchitected#ResourceNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.wellarchitected#ExceptionMessage", + "traits": { + "smithy.api#required": {} + } + }, + "ResourceId": { + "target": "com.amazonaws.wellarchitected#ExceptionResourceId", + "traits": { + "smithy.api#required": {} + } + }, + "ResourceType": { + "target": "com.amazonaws.wellarchitected#ExceptionResourceType", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The requested resource was not found.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.wellarchitected#Risk": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The risk for a given workload, lens review, pillar, or question.

", + "smithy.api#enum": [ + { + "value": "UNANSWERED", + "name": "UNANSWERED" + }, + { + "value": "HIGH", + "name": "HIGH" + }, + { + "value": "MEDIUM", + "name": "MEDIUM" + }, + { + "value": "NONE", + "name": "NONE" + }, + { + "value": "NOT_APPLICABLE", + "name": "NOT_APPLICABLE" + } + ] + } + }, + "com.amazonaws.wellarchitected#RiskCounts": { + "type": "map", + "key": { + "target": "com.amazonaws.wellarchitected#Risk" + }, + "value": { + "target": "com.amazonaws.wellarchitected#Count" + }, + "traits": { + "smithy.api#documentation": "

A map from risk names to the count of how questions have that rating.

" + } + }, + "com.amazonaws.wellarchitected#SelectedChoices": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#ChoiceId" + }, + "traits": { + "smithy.api#documentation": "

List of selected choice IDs in a question answer.

" + } + }, + "com.amazonaws.wellarchitected#ServiceCode": { + "type": "string", + "traits": { + "smithy.api#documentation": "

Service Quotas requirement to identify originating service.

" + } + }, + "com.amazonaws.wellarchitected#ServiceQuotaExceededException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.wellarchitected#ExceptionMessage", + "traits": { + "smithy.api#required": {} + } + }, + "ResourceId": { + "target": "com.amazonaws.wellarchitected#ExceptionResourceId" + }, + "ResourceType": { + "target": "com.amazonaws.wellarchitected#ExceptionResourceType" + }, + "QuotaCode": { + "target": "com.amazonaws.wellarchitected#QuotaCode", + "traits": { + "smithy.api#required": {} + } + }, + "ServiceCode": { + "target": "com.amazonaws.wellarchitected#ServiceCode", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The user has reached their resource quota.

", + "smithy.api#error": "client", + "smithy.api#httpError": 402 + } + }, + "com.amazonaws.wellarchitected#ShareId": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The ID associated with the workload share.

", + "smithy.api#pattern": "[0-9a-f]{32}" + } + }, + "com.amazonaws.wellarchitected#ShareInvitation": { + "type": "structure", + "members": { + "ShareInvitationId": { + "target": "com.amazonaws.wellarchitected#ShareInvitationId", + "traits": { + "smithy.api#documentation": "

The ID assigned to the share invitation.

" + } + }, + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId" + } + }, + "traits": { + "smithy.api#documentation": "

The share invitation.

" + } + }, + "com.amazonaws.wellarchitected#ShareInvitationAction": { + "type": "string", + "traits": { + "smithy.api#documentation": "

Share invitation action taken by contributor.

", + "smithy.api#enum": [ + { + "value": "ACCEPT", + "name": "ACCEPT" + }, + { + "value": "REJECT", + "name": "REJECT" + } + ] + } + }, + "com.amazonaws.wellarchitected#ShareInvitationId": { + "type": "string", + "traits": { + "smithy.api#pattern": "[0-9a-f]{32}" + } + }, + "com.amazonaws.wellarchitected#ShareInvitationSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#ShareInvitationSummary" + } + }, + "com.amazonaws.wellarchitected#ShareInvitationSummary": { + "type": "structure", + "members": { + "ShareInvitationId": { + "target": "com.amazonaws.wellarchitected#ShareInvitationId", + "traits": { + "smithy.api#documentation": "

The ID assigned to the share invitation.

" + } + }, + "SharedBy": { + "target": "com.amazonaws.wellarchitected#AwsAccountId" + }, + "SharedWith": { + "target": "com.amazonaws.wellarchitected#SharedWith" + }, + "PermissionType": { + "target": "com.amazonaws.wellarchitected#PermissionType" + }, + "WorkloadName": { + "target": "com.amazonaws.wellarchitected#WorkloadName" + }, + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId" + } + }, + "traits": { + "smithy.api#documentation": "

A share invitation summary return object.

" + } + }, + "com.amazonaws.wellarchitected#ShareStatus": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The status of a workload share.

", + "smithy.api#enum": [ + { + "value": "ACCEPTED", + "name": "ACCEPTED" + }, + { + "value": "REJECTED", + "name": "REJECTED" + }, + { + "value": "PENDING", + "name": "PENDING" + }, + { + "value": "REVOKED", + "name": "REVOKED" + }, + { + "value": "EXPIRED", + "name": "EXPIRED" + } + ] + } + }, + "com.amazonaws.wellarchitected#SharedWith": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The AWS account ID or IAM role with which the workload is shared.

", + "smithy.api#length": { + "min": 12, + "max": 2048 + } + } + }, + "com.amazonaws.wellarchitected#SharedWithPrefix": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.wellarchitected#ThrottlingException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.wellarchitected#ExceptionMessage", + "traits": { + "smithy.api#required": {} + } + }, + "QuotaCode": { + "target": "com.amazonaws.wellarchitected#QuotaCode" + }, + "ServiceCode": { + "target": "com.amazonaws.wellarchitected#ServiceCode" + } + }, + "traits": { + "smithy.api#documentation": "

Request was denied due to request throttling.

", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, + "com.amazonaws.wellarchitected#Timestamp": { + "type": "timestamp", + "traits": { + "smithy.api#documentation": "

The date and time recorded.

" + } + }, + "com.amazonaws.wellarchitected#UpdateAnswer": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#UpdateAnswerInput" + }, + "output": { + "target": "com.amazonaws.wellarchitected#UpdateAnswerOutput" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#ConflictException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Update the answer.

", + "smithy.api#http": { + "method": "PATCH", + "uri": "/workloads/{WorkloadId}/lensReviews/{LensAlias}/answers/{QuestionId}", + "code": 200 + } + } + }, + "com.amazonaws.wellarchitected#UpdateAnswerInput": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "LensAlias": { + "target": "com.amazonaws.wellarchitected#LensAlias", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "QuestionId": { + "target": "com.amazonaws.wellarchitected#QuestionId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "SelectedChoices": { + "target": "com.amazonaws.wellarchitected#SelectedChoices" + }, + "Notes": { + "target": "com.amazonaws.wellarchitected#Notes" + }, + "IsApplicable": { + "target": "com.amazonaws.wellarchitected#IsApplicable" + } + }, + "traits": { + "smithy.api#documentation": "

Input to update answer.

" + } + }, + "com.amazonaws.wellarchitected#UpdateAnswerOutput": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId" + }, + "LensAlias": { + "target": "com.amazonaws.wellarchitected#LensAlias" + }, + "Answer": { + "target": "com.amazonaws.wellarchitected#Answer" + } + }, + "traits": { + "smithy.api#documentation": "

Output of a update answer call.

" + } + }, + "com.amazonaws.wellarchitected#UpdateLensReview": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#UpdateLensReviewInput" + }, + "output": { + "target": "com.amazonaws.wellarchitected#UpdateLensReviewOutput" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#ConflictException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Update lens review.

", + "smithy.api#http": { + "method": "PATCH", + "uri": "/workloads/{WorkloadId}/lensReviews/{LensAlias}", + "code": 200 + } + } + }, + "com.amazonaws.wellarchitected#UpdateLensReviewInput": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "LensAlias": { + "target": "com.amazonaws.wellarchitected#LensAlias", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "LensNotes": { + "target": "com.amazonaws.wellarchitected#Notes" + }, + "PillarNotes": { + "target": "com.amazonaws.wellarchitected#PillarNotes" + } + }, + "traits": { + "smithy.api#documentation": "

Input for update lens review.

" + } + }, + "com.amazonaws.wellarchitected#UpdateLensReviewOutput": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId" + }, + "LensReview": { + "target": "com.amazonaws.wellarchitected#LensReview" + } + }, + "traits": { + "smithy.api#documentation": "

Output of a update lens review call.

" + } + }, + "com.amazonaws.wellarchitected#UpdateShareInvitation": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#UpdateShareInvitationInput" + }, + "output": { + "target": "com.amazonaws.wellarchitected#UpdateShareInvitationOutput" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#ConflictException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Update a workload invitation.

", + "smithy.api#http": { + "method": "PATCH", + "uri": "/shareInvitations/{ShareInvitationId}", + "code": 200 + } + } + }, + "com.amazonaws.wellarchitected#UpdateShareInvitationInput": { + "type": "structure", + "members": { + "ShareInvitationId": { + "target": "com.amazonaws.wellarchitected#ShareInvitationId", + "traits": { + "smithy.api#documentation": "

The ID assigned to the share invitation.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ShareInvitationAction": { + "target": "com.amazonaws.wellarchitected#ShareInvitationAction", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Input for Update Share Invitation

" + } + }, + "com.amazonaws.wellarchitected#UpdateShareInvitationOutput": { + "type": "structure", + "members": { + "ShareInvitation": { + "target": "com.amazonaws.wellarchitected#ShareInvitation", + "traits": { + "smithy.api#documentation": "

The updated workload share invitation.

" + } + } + } + }, + "com.amazonaws.wellarchitected#UpdateWorkload": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#UpdateWorkloadInput" + }, + "output": { + "target": "com.amazonaws.wellarchitected#UpdateWorkloadOutput" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#ConflictException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Update an existing workload.

", + "smithy.api#http": { + "method": "PATCH", + "uri": "/workloads/{WorkloadId}", + "code": 200 + } + } + }, + "com.amazonaws.wellarchitected#UpdateWorkloadInput": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "WorkloadName": { + "target": "com.amazonaws.wellarchitected#WorkloadName" + }, + "Description": { + "target": "com.amazonaws.wellarchitected#WorkloadDescription" + }, + "Environment": { + "target": "com.amazonaws.wellarchitected#WorkloadEnvironment" + }, + "AccountIds": { + "target": "com.amazonaws.wellarchitected#WorkloadAccountIds" + }, + "AwsRegions": { + "target": "com.amazonaws.wellarchitected#WorkloadAwsRegions" + }, + "NonAwsRegions": { + "target": "com.amazonaws.wellarchitected#WorkloadNonAwsRegions" + }, + "PillarPriorities": { + "target": "com.amazonaws.wellarchitected#WorkloadPillarPriorities" + }, + "ArchitecturalDesign": { + "target": "com.amazonaws.wellarchitected#WorkloadArchitecturalDesign" + }, + "ReviewOwner": { + "target": "com.amazonaws.wellarchitected#WorkloadReviewOwner" + }, + "IsReviewOwnerUpdateAcknowledged": { + "target": "com.amazonaws.wellarchitected#IsReviewOwnerUpdateAcknowledged", + "traits": { + "smithy.api#documentation": "

Flag indicating whether the workload owner has acknowledged that the Review\n owner field is required.

\n

If a Review owner is not added to the workload within\n 60 days of acknowledgement, access to the workload is restricted until an owner is\n added.

" + } + }, + "IndustryType": { + "target": "com.amazonaws.wellarchitected#WorkloadIndustryType" + }, + "Industry": { + "target": "com.amazonaws.wellarchitected#WorkloadIndustry" + }, + "Notes": { + "target": "com.amazonaws.wellarchitected#Notes" + }, + "ImprovementStatus": { + "target": "com.amazonaws.wellarchitected#WorkloadImprovementStatus" + } + }, + "traits": { + "smithy.api#documentation": "

Input to update a workload.

" + } + }, + "com.amazonaws.wellarchitected#UpdateWorkloadOutput": { + "type": "structure", + "members": { + "Workload": { + "target": "com.amazonaws.wellarchitected#Workload" + } + }, + "traits": { + "smithy.api#documentation": "

Output of an update workload call.

" + } + }, + "com.amazonaws.wellarchitected#UpdateWorkloadShare": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#UpdateWorkloadShareInput" + }, + "output": { + "target": "com.amazonaws.wellarchitected#UpdateWorkloadShareOutput" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#ConflictException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Update a workload share.

", + "smithy.api#http": { + "method": "PATCH", + "uri": "/workloads/{WorkloadId}/shares/{ShareId}", + "code": 200 + } + } + }, + "com.amazonaws.wellarchitected#UpdateWorkloadShareInput": { + "type": "structure", + "members": { + "ShareId": { + "target": "com.amazonaws.wellarchitected#ShareId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "PermissionType": { + "target": "com.amazonaws.wellarchitected#PermissionType", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Input for Update Workload Share

" + } + }, + "com.amazonaws.wellarchitected#UpdateWorkloadShareOutput": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId" + }, + "WorkloadShare": { + "target": "com.amazonaws.wellarchitected#WorkloadShare" + } + }, + "traits": { + "smithy.api#documentation": "

Input for Update Workload Share

" + } + }, + "com.amazonaws.wellarchitected#UpgradeLensReview": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#UpgradeLensReviewInput" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#ConflictException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Upgrade lens review.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/workloads/{WorkloadId}/lensReviews/{LensAlias}/upgrade", + "code": 200 + } + } + }, + "com.amazonaws.wellarchitected#UpgradeLensReviewInput": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "LensAlias": { + "target": "com.amazonaws.wellarchitected#LensAlias", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "MilestoneName": { + "target": "com.amazonaws.wellarchitected#MilestoneName", + "traits": { + "smithy.api#required": {} + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.wellarchitected#ClientRequestToken" + } + } + }, + "com.amazonaws.wellarchitected#ValidationException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.wellarchitected#ExceptionMessage", + "traits": { + "smithy.api#required": {} + } + }, + "Reason": { + "target": "com.amazonaws.wellarchitected#ValidationExceptionReason" + }, + "Fields": { + "target": "com.amazonaws.wellarchitected#ValidationExceptionFieldList" + } + }, + "traits": { + "smithy.api#documentation": "

The user input is not valid.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.wellarchitected#ValidationExceptionField": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wellarchitected#ValidationExceptionFieldName", + "traits": { + "smithy.api#required": {} + } + }, + "Message": { + "target": "com.amazonaws.wellarchitected#ExceptionMessage", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Stores information about a field passed inside a request that resulted in an exception.

" + } + }, + "com.amazonaws.wellarchitected#ValidationExceptionFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#ValidationExceptionField" + }, + "traits": { + "smithy.api#documentation": "

The fields that caused the error, if applicable.

" + } + }, + "com.amazonaws.wellarchitected#ValidationExceptionFieldName": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The field name for which validation failed.

" + } + }, + "com.amazonaws.wellarchitected#ValidationExceptionReason": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The reason why the request failed validation.

", + "smithy.api#enum": [ + { + "value": "UNKNOWN_OPERATION", + "name": "UNKNOWN_OPERATION" + }, + { + "value": "CANNOT_PARSE", + "name": "CANNOT_PARSE" + }, + { + "value": "FIELD_VALIDATION_FAILED", + "name": "FIELD_VALIDATION_FAILED" + }, + { + "value": "OTHER", + "name": "OTHER" + } + ] + } + }, + "com.amazonaws.wellarchitected#VersionDifferences": { + "type": "structure", + "members": { + "PillarDifferences": { + "target": "com.amazonaws.wellarchitected#PillarDifferences", + "traits": { + "smithy.api#documentation": "

The differences between the base and latest versions of the lens.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The differences between the base and latest versions of the lens.

" + } + }, + "com.amazonaws.wellarchitected#WellArchitectedApiServiceLambda": { + "type": "service", + "version": "2020-03-31", + "operations": [ + { + "target": "com.amazonaws.wellarchitected#AssociateLenses" + }, + { + "target": "com.amazonaws.wellarchitected#CreateMilestone" + }, + { + "target": "com.amazonaws.wellarchitected#CreateWorkload" + }, + { + "target": "com.amazonaws.wellarchitected#CreateWorkloadShare" + }, + { + "target": "com.amazonaws.wellarchitected#DeleteWorkload" + }, + { + "target": "com.amazonaws.wellarchitected#DeleteWorkloadShare" + }, + { + "target": "com.amazonaws.wellarchitected#DisassociateLenses" + }, + { + "target": "com.amazonaws.wellarchitected#GetAnswer" + }, + { + "target": "com.amazonaws.wellarchitected#GetLensReview" + }, + { + "target": "com.amazonaws.wellarchitected#GetLensReviewReport" + }, + { + "target": "com.amazonaws.wellarchitected#GetLensVersionDifference" + }, + { + "target": "com.amazonaws.wellarchitected#GetMilestone" + }, + { + "target": "com.amazonaws.wellarchitected#GetWorkload" + }, + { + "target": "com.amazonaws.wellarchitected#ListAnswers" + }, + { + "target": "com.amazonaws.wellarchitected#ListLenses" + }, + { + "target": "com.amazonaws.wellarchitected#ListLensReviewImprovements" + }, + { + "target": "com.amazonaws.wellarchitected#ListLensReviews" + }, + { + "target": "com.amazonaws.wellarchitected#ListMilestones" + }, + { + "target": "com.amazonaws.wellarchitected#ListNotifications" + }, + { + "target": "com.amazonaws.wellarchitected#ListShareInvitations" + }, + { + "target": "com.amazonaws.wellarchitected#ListWorkloads" + }, + { + "target": "com.amazonaws.wellarchitected#ListWorkloadShares" + }, + { + "target": "com.amazonaws.wellarchitected#UpdateAnswer" + }, + { + "target": "com.amazonaws.wellarchitected#UpdateLensReview" + }, + { + "target": "com.amazonaws.wellarchitected#UpdateShareInvitation" + }, + { + "target": "com.amazonaws.wellarchitected#UpdateWorkload" + }, + { + "target": "com.amazonaws.wellarchitected#UpdateWorkloadShare" + }, + { + "target": "com.amazonaws.wellarchitected#UpgradeLensReview" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "WellArchitected", + "arnNamespace": "wellarchitected", + "cloudFormationName": "WellArchitected", + "cloudTrailEventSource": "wellarchitected.amazonaws.com", + "endpointPrefix": "wellarchitected" + }, + "aws.auth#sigv4": { + "name": "wellarchitected" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "AWS Well-Architected Tool\n

This is the AWS Well-Architected Tool API Reference.

\n \n

The AWS Well-Architected Tool API provides programmatic access to the AWS Well-Architected Tool in the AWS Management Console.

\n

\n Managing workloads:\n

\n \n

\n Managing milestones:\n

\n \n

\n Managing lenses:\n

\n \n

\n Managing reviews:\n

\n \n

\n Managing workload shares:\n

\n \n

\n Managing workload share invitations:\n

\n \n

For information about the AWS Well-Architected Tool, see the AWS Well-Architected Tool User Guide.

", + "smithy.api#title": "AWS Well-Architected Tool" + } + }, + "com.amazonaws.wellarchitected#Workload": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId" + }, + "WorkloadArn": { + "target": "com.amazonaws.wellarchitected#WorkloadArn" + }, + "WorkloadName": { + "target": "com.amazonaws.wellarchitected#WorkloadName" + }, + "Description": { + "target": "com.amazonaws.wellarchitected#WorkloadDescription" + }, + "Environment": { + "target": "com.amazonaws.wellarchitected#WorkloadEnvironment" + }, + "UpdatedAt": { + "target": "com.amazonaws.wellarchitected#Timestamp" + }, + "AccountIds": { + "target": "com.amazonaws.wellarchitected#WorkloadAccountIds" + }, + "AwsRegions": { + "target": "com.amazonaws.wellarchitected#WorkloadAwsRegions" + }, + "NonAwsRegions": { + "target": "com.amazonaws.wellarchitected#WorkloadNonAwsRegions" + }, + "ArchitecturalDesign": { + "target": "com.amazonaws.wellarchitected#WorkloadArchitecturalDesign" + }, + "ReviewOwner": { + "target": "com.amazonaws.wellarchitected#WorkloadReviewOwner" + }, + "ReviewRestrictionDate": { + "target": "com.amazonaws.wellarchitected#Timestamp" + }, + "IsReviewOwnerUpdateAcknowledged": { + "target": "com.amazonaws.wellarchitected#IsReviewOwnerUpdateAcknowledged", + "traits": { + "smithy.api#documentation": "

Flag indicating whether the workload owner has acknowledged that the Review\n owner field is required.

\n

If a Review owner is not added to the workload within\n 60 days of acknowledgement, access to the workload is restricted until an owner is\n added.

" + } + }, + "IndustryType": { + "target": "com.amazonaws.wellarchitected#WorkloadIndustryType" + }, + "Industry": { + "target": "com.amazonaws.wellarchitected#WorkloadIndustry" + }, + "Notes": { + "target": "com.amazonaws.wellarchitected#Notes" + }, + "ImprovementStatus": { + "target": "com.amazonaws.wellarchitected#WorkloadImprovementStatus" + }, + "RiskCounts": { + "target": "com.amazonaws.wellarchitected#RiskCounts" + }, + "PillarPriorities": { + "target": "com.amazonaws.wellarchitected#WorkloadPillarPriorities" + }, + "Lenses": { + "target": "com.amazonaws.wellarchitected#WorkloadLenses" + }, + "Owner": { + "target": "com.amazonaws.wellarchitected#AwsAccountId" + }, + "ShareInvitationId": { + "target": "com.amazonaws.wellarchitected#ShareInvitationId", + "traits": { + "smithy.api#documentation": "

The ID assigned to the share invitation.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A workload return object.

" + } + }, + "com.amazonaws.wellarchitected#WorkloadAccountIds": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#AwsAccountId" + }, + "traits": { + "smithy.api#documentation": "

The list of AWS account IDs associated with the workload.

", + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.wellarchitected#WorkloadArchitecturalDesign": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The URL of the architectural design for the workload.

", + "smithy.api#length": { + "min": 0, + "max": 2048 + } + } + }, + "com.amazonaws.wellarchitected#WorkloadArn": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The ARN for the workload.

" + } + }, + "com.amazonaws.wellarchitected#WorkloadAwsRegions": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#AwsRegion" + }, + "traits": { + "smithy.api#documentation": "

The list of AWS Regions associated with the workload, for example,\n us-east-2, or ca-central-1.

", + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.wellarchitected#WorkloadDescription": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The description for the workload.

", + "smithy.api#length": { + "min": 3, + "max": 250 + } + } + }, + "com.amazonaws.wellarchitected#WorkloadEnvironment": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The environment for the workload.

", + "smithy.api#enum": [ + { + "value": "PRODUCTION", + "name": "PRODUCTION" + }, + { + "value": "PREPRODUCTION", + "name": "PREPRODUCTION" + } + ] + } + }, + "com.amazonaws.wellarchitected#WorkloadId": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The ID assigned to the workload. This ID is unique within an AWS Region.

", + "smithy.api#pattern": "[0-9a-f]{32}" + } + }, + "com.amazonaws.wellarchitected#WorkloadImprovementStatus": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The improvement status for a workload.

", + "smithy.api#enum": [ + { + "value": "NOT_APPLICABLE", + "name": "NOT_APPLICABLE" + }, + { + "value": "NOT_STARTED", + "name": "NOT_STARTED" + }, + { + "value": "IN_PROGRESS", + "name": "IN_PROGRESS" + }, + { + "value": "COMPLETE", + "name": "COMPLETE" + }, + { + "value": "RISK_ACKNOWLEDGED", + "name": "RISK_ACKNOWLEDGED" + } + ] + } + }, + "com.amazonaws.wellarchitected#WorkloadIndustry": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The industry for the workload.

", + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.wellarchitected#WorkloadIndustryType": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The industry type for the workload.

\n

If specified, must be one of the following:

\n ", + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.wellarchitected#WorkloadLenses": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#LensAlias" + }, + "traits": { + "smithy.api#documentation": "

The list of lenses associated with the workload. Each lens is identified by its LensSummary$LensAlias.

" + } + }, + "com.amazonaws.wellarchitected#WorkloadName": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The name of the workload.

\n

The name must be unique within an account within a Region. Spaces and capitalization\n are ignored when checking for uniqueness.

", + "smithy.api#length": { + "min": 3, + "max": 100 + } + } + }, + "com.amazonaws.wellarchitected#WorkloadNamePrefix": { + "type": "string", + "traits": { + "smithy.api#documentation": "

An optional string added to the beginning of each workload name returned in the\n results.

", + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.wellarchitected#WorkloadNonAwsRegion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 25 + } + } + }, + "com.amazonaws.wellarchitected#WorkloadNonAwsRegions": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#WorkloadNonAwsRegion" + }, + "traits": { + "smithy.api#documentation": "

The list of non-AWS Regions associated with the workload.

", + "smithy.api#length": { + "min": 0, + "max": 5 + } + } + }, + "com.amazonaws.wellarchitected#WorkloadPillarPriorities": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#PillarId" + }, + "traits": { + "smithy.api#documentation": "

The priorities of the pillars, which are used to order items in the improvement plan.\n Each pillar is represented by its PillarReviewSummary$PillarId.

" + } + }, + "com.amazonaws.wellarchitected#WorkloadReviewOwner": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The review owner of the workload. The name, email address, or identifier for the\n primary group or individual that owns the workload review process.

", + "smithy.api#length": { + "min": 3, + "max": 255 + } + } + }, + "com.amazonaws.wellarchitected#WorkloadShare": { + "type": "structure", + "members": { + "ShareId": { + "target": "com.amazonaws.wellarchitected#ShareId" + }, + "SharedBy": { + "target": "com.amazonaws.wellarchitected#AwsAccountId" + }, + "SharedWith": { + "target": "com.amazonaws.wellarchitected#SharedWith" + }, + "PermissionType": { + "target": "com.amazonaws.wellarchitected#PermissionType" + }, + "Status": { + "target": "com.amazonaws.wellarchitected#ShareStatus" + }, + "WorkloadName": { + "target": "com.amazonaws.wellarchitected#WorkloadName" + }, + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId" + } + }, + "traits": { + "smithy.api#documentation": "

A workload share return object.

" + } + }, + "com.amazonaws.wellarchitected#WorkloadShareSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#WorkloadShareSummary" + }, + "traits": { + "smithy.api#documentation": "

A list of workload share summaries.

" + } + }, + "com.amazonaws.wellarchitected#WorkloadShareSummary": { + "type": "structure", + "members": { + "ShareId": { + "target": "com.amazonaws.wellarchitected#ShareId" + }, + "SharedWith": { + "target": "com.amazonaws.wellarchitected#SharedWith" + }, + "PermissionType": { + "target": "com.amazonaws.wellarchitected#PermissionType" + }, + "Status": { + "target": "com.amazonaws.wellarchitected#ShareStatus" + } + }, + "traits": { + "smithy.api#documentation": "

A workload share summary return object.

" + } + }, + "com.amazonaws.wellarchitected#WorkloadSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#WorkloadSummary" + }, + "traits": { + "smithy.api#documentation": "

A list of workload summaries.

" + } + }, + "com.amazonaws.wellarchitected#WorkloadSummary": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId" + }, + "WorkloadArn": { + "target": "com.amazonaws.wellarchitected#WorkloadArn" + }, + "WorkloadName": { + "target": "com.amazonaws.wellarchitected#WorkloadName" + }, + "Owner": { + "target": "com.amazonaws.wellarchitected#AwsAccountId" + }, + "UpdatedAt": { + "target": "com.amazonaws.wellarchitected#Timestamp" + }, + "Lenses": { + "target": "com.amazonaws.wellarchitected#WorkloadLenses" + }, + "RiskCounts": { + "target": "com.amazonaws.wellarchitected#RiskCounts" + }, + "ImprovementStatus": { + "target": "com.amazonaws.wellarchitected#WorkloadImprovementStatus" + } + }, + "traits": { + "smithy.api#documentation": "

A workload summary return object.

" + } + } + } +} diff --git a/codegen/sdk-codegen/aws-models/workmail.2017-10-01.json b/codegen/sdk-codegen/aws-models/workmail.2017-10-01.json index 1ffdd942176..205583065f6 100644 --- a/codegen/sdk-codegen/aws-models/workmail.2017-10-01.json +++ b/codegen/sdk-codegen/aws-models/workmail.2017-10-01.json @@ -29,12 +29,176 @@ ] }, "shapes": { + "com.amazonaws.workmail#AccessControlRule": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.workmail#AccessControlRuleName", + "traits": { + "smithy.api#documentation": "

The rule name.

" + } + }, + "Effect": { + "target": "com.amazonaws.workmail#AccessControlRuleEffect", + "traits": { + "smithy.api#documentation": "

The rule effect.

" + } + }, + "Description": { + "target": "com.amazonaws.workmail#AccessControlRuleDescription", + "traits": { + "smithy.api#documentation": "

The rule description.

" + } + }, + "IpRanges": { + "target": "com.amazonaws.workmail#IpRangeList", + "traits": { + "smithy.api#documentation": "

IPv4 CIDR ranges to include in the rule.

" + } + }, + "NotIpRanges": { + "target": "com.amazonaws.workmail#IpRangeList", + "traits": { + "smithy.api#documentation": "

IPv4 CIDR ranges to exclude from the rule.

" + } + }, + "Actions": { + "target": "com.amazonaws.workmail#ActionsList", + "traits": { + "smithy.api#documentation": "

Access protocol actions to include in the rule. Valid values include\n ActiveSync, AutoDiscover, EWS, IMAP,\n SMTP, WindowsOutlook, and WebMail.

" + } + }, + "NotActions": { + "target": "com.amazonaws.workmail#ActionsList", + "traits": { + "smithy.api#documentation": "

Access protocol actions to exclude from the rule. Valid values include\n ActiveSync, AutoDiscover, EWS, IMAP,\n SMTP, WindowsOutlook, and WebMail.

" + } + }, + "UserIds": { + "target": "com.amazonaws.workmail#UserIdList", + "traits": { + "smithy.api#documentation": "

User IDs to include in the rule.

" + } + }, + "NotUserIds": { + "target": "com.amazonaws.workmail#UserIdList", + "traits": { + "smithy.api#documentation": "

User IDs to exclude from the rule.

" + } + }, + "DateCreated": { + "target": "com.amazonaws.workmail#Timestamp", + "traits": { + "smithy.api#documentation": "

The date that the rule was created.

" + } + }, + "DateModified": { + "target": "com.amazonaws.workmail#Timestamp", + "traits": { + "smithy.api#documentation": "

The date that the rule was modified.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A rule that controls access to an Amazon WorkMail organization.

" + } + }, + "com.amazonaws.workmail#AccessControlRuleAction": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "[a-zA-Z]+" + } + }, + "com.amazonaws.workmail#AccessControlRuleDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + }, + "smithy.api#pattern": "[\\u0020-\\u00FF]+" + } + }, + "com.amazonaws.workmail#AccessControlRuleEffect": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ALLOW", + "name": "ALLOW" + }, + { + "value": "DENY", + "name": "DENY" + } + ] + } + }, + "com.amazonaws.workmail#AccessControlRuleName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "[a-zA-Z0-9_-]+" + } + }, + "com.amazonaws.workmail#AccessControlRuleNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.workmail#AccessControlRuleName" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.workmail#AccessControlRulesList": { + "type": "list", + "member": { + "target": "com.amazonaws.workmail#AccessControlRule" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.workmail#ActionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.workmail#AccessControlRuleAction" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, "com.amazonaws.workmail#Aliases": { "type": "list", "member": { "target": "com.amazonaws.workmail#EmailAddress" } }, + "com.amazonaws.workmail#AmazonResourceName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1011 + } + } + }, "com.amazonaws.workmail#AssociateDelegateToResource": { "type": "operation", "input": { @@ -170,7 +334,7 @@ "AutoAcceptRequests": { "target": "com.amazonaws.workmail#Boolean", "traits": { - "smithy.api#documentation": "

The resource's ability to automatically reply to requests. If disabled, delegates must be associated to the resource.

" + "smithy.api#documentation": "

The resource's ability to automatically reply to requests. If disabled, delegates\n must be associated to the resource.

" } }, "AutoDeclineRecurringRequests": { @@ -193,6 +357,64 @@ "com.amazonaws.workmail#Boolean": { "type": "boolean" }, + "com.amazonaws.workmail#CancelMailboxExportJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.workmail#CancelMailboxExportJobRequest" + }, + "output": { + "target": "com.amazonaws.workmail#CancelMailboxExportJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.workmail#EntityNotFoundException" + }, + { + "target": "com.amazonaws.workmail#InvalidParameterException" + }, + { + "target": "com.amazonaws.workmail#OrganizationNotFoundException" + }, + { + "target": "com.amazonaws.workmail#OrganizationStateException" + } + ], + "traits": { + "smithy.api#documentation": "

Cancels a mailbox export job.

\n \n

If the mailbox export job is near completion, it might not be possible to cancel\n it.

\n ", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.workmail#CancelMailboxExportJobRequest": { + "type": "structure", + "members": { + "ClientToken": { + "target": "com.amazonaws.workmail#IdempotencyClientToken", + "traits": { + "smithy.api#documentation": "

The idempotency token for the client request.

", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + }, + "JobId": { + "target": "com.amazonaws.workmail#MailboxExportJobId", + "traits": { + "smithy.api#documentation": "

The job ID.

", + "smithy.api#required": {} + } + }, + "OrganizationId": { + "target": "com.amazonaws.workmail#OrganizationId", + "traits": { + "smithy.api#documentation": "

The organization ID.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workmail#CancelMailboxExportJobResponse": { + "type": "structure", + "members": {} + }, "com.amazonaws.workmail#CreateAlias": { "type": "operation", "input": { @@ -214,6 +436,9 @@ { "target": "com.amazonaws.workmail#InvalidParameterException" }, + { + "target": "com.amazonaws.workmail#LimitExceededException" + }, { "target": "com.amazonaws.workmail#MailDomainNotFoundException" }, @@ -297,7 +522,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a group that can be used in Amazon WorkMail by calling the RegisterToWorkMail\n operation.

", + "smithy.api#documentation": "

Creates a group that can be used in Amazon WorkMail by calling the RegisterToWorkMail operation.

", "smithy.api#idempotent": {} } }, @@ -331,6 +556,90 @@ } } }, + "com.amazonaws.workmail#CreateOrganization": { + "type": "operation", + "input": { + "target": "com.amazonaws.workmail#CreateOrganizationRequest" + }, + "output": { + "target": "com.amazonaws.workmail#CreateOrganizationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.workmail#DirectoryInUseException" + }, + { + "target": "com.amazonaws.workmail#DirectoryUnavailableException" + }, + { + "target": "com.amazonaws.workmail#InvalidParameterException" + }, + { + "target": "com.amazonaws.workmail#LimitExceededException" + }, + { + "target": "com.amazonaws.workmail#NameAvailabilityException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new Amazon WorkMail organization. Optionally, you can choose to associate an existing AWS Directory Service directory with your organization. If an AWS Directory Service directory ID is specified, the organization alias must match the directory alias. If you choose not to associate an existing directory with your organization, then we create a new Amazon WorkMail directory for you. For more information, see Adding an organization in the Amazon WorkMail Administrator Guide.

\n

You can associate multiple email domains with an organization, then set your default email domain from the Amazon WorkMail console. You can also associate a domain that is managed in an Amazon Route 53 public hosted zone. For more information, see Adding a domain and Choosing the default domain in the Amazon WorkMail Administrator Guide.

\n

Optionally, you can use a customer managed master key from AWS Key Management Service\n (AWS KMS) to encrypt email for your organization. If you don't associate an AWS KMS key, Amazon WorkMail creates a\n default AWS managed master key for you.

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.workmail#CreateOrganizationRequest": { + "type": "structure", + "members": { + "DirectoryId": { + "target": "com.amazonaws.workmail#DirectoryId", + "traits": { + "smithy.api#documentation": "

The AWS Directory Service directory ID.

" + } + }, + "Alias": { + "target": "com.amazonaws.workmail#OrganizationName", + "traits": { + "smithy.api#documentation": "

The organization alias.

", + "smithy.api#required": {} + } + }, + "ClientToken": { + "target": "com.amazonaws.workmail#IdempotencyClientToken", + "traits": { + "smithy.api#documentation": "

The idempotency token associated with the request.

", + "smithy.api#idempotencyToken": {} + } + }, + "Domains": { + "target": "com.amazonaws.workmail#Domains", + "traits": { + "smithy.api#documentation": "

The email domains to associate with the organization.

" + } + }, + "KmsKeyArn": { + "target": "com.amazonaws.workmail#KmsKeyArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a customer managed master key from AWS\n KMS.

" + } + }, + "EnableInteroperability": { + "target": "com.amazonaws.workmail#Boolean", + "traits": { + "smithy.api#documentation": "

When true, allows organization interoperability between Amazon WorkMail and Microsoft Exchange. Can only be set to true if an AD Connector directory ID is included in the request.

" + } + } + } + }, + "com.amazonaws.workmail#CreateOrganizationResponse": { + "type": "structure", + "members": { + "OrganizationId": { + "target": "com.amazonaws.workmail#OrganizationId", + "traits": { + "smithy.api#documentation": "

The organization ID.

" + } + } + } + }, "com.amazonaws.workmail#CreateResource": { "type": "operation", "input": { @@ -442,7 +751,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a user who can be used in Amazon WorkMail by calling the\n RegisterToWorkMail operation.

", + "smithy.api#documentation": "

Creates a user who can be used in Amazon WorkMail by calling the RegisterToWorkMail operation.

", "smithy.api#idempotent": {} } }, @@ -459,7 +768,7 @@ "Name": { "target": "com.amazonaws.workmail#UserName", "traits": { - "smithy.api#documentation": "

The name for the new user. Simple AD or AD Connector user names have a maximum length of 20. All others have a maximum length of 64.

", + "smithy.api#documentation": "

The name for the new user. WorkMail directory user names have a maximum length of 64. All others have a maximum length of 20.

", "smithy.api#required": {} } }, @@ -512,6 +821,49 @@ "smithy.api#documentation": "

The name of the attribute, which is one of the values defined in the UserAttribute\n enumeration.

" } }, + "com.amazonaws.workmail#DeleteAccessControlRule": { + "type": "operation", + "input": { + "target": "com.amazonaws.workmail#DeleteAccessControlRuleRequest" + }, + "output": { + "target": "com.amazonaws.workmail#DeleteAccessControlRuleResponse" + }, + "errors": [ + { + "target": "com.amazonaws.workmail#OrganizationNotFoundException" + }, + { + "target": "com.amazonaws.workmail#OrganizationStateException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an access control rule for the specified WorkMail organization.

" + } + }, + "com.amazonaws.workmail#DeleteAccessControlRuleRequest": { + "type": "structure", + "members": { + "OrganizationId": { + "target": "com.amazonaws.workmail#OrganizationId", + "traits": { + "smithy.api#documentation": "

The identifier for the organization.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.workmail#AccessControlRuleName", + "traits": { + "smithy.api#documentation": "

The name of the access control rule.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workmail#DeleteAccessControlRuleResponse": { + "type": "structure", + "members": {} + }, "com.amazonaws.workmail#DeleteAlias": { "type": "operation", "input": { @@ -674,7 +1026,7 @@ "EntityId": { "target": "com.amazonaws.workmail#WorkMailIdentifier", "traits": { - "smithy.api#documentation": "

The identifier of the member (user or group)that owns the mailbox.

", + "smithy.api#documentation": "

The identifier of the member (user or group) that owns the mailbox.

", "smithy.api#required": {} } }, @@ -691,18 +1043,85 @@ "type": "structure", "members": {} }, - "com.amazonaws.workmail#DeleteResource": { + "com.amazonaws.workmail#DeleteOrganization": { "type": "operation", "input": { - "target": "com.amazonaws.workmail#DeleteResourceRequest" + "target": "com.amazonaws.workmail#DeleteOrganizationRequest" }, "output": { - "target": "com.amazonaws.workmail#DeleteResourceResponse" + "target": "com.amazonaws.workmail#DeleteOrganizationResponse" }, "errors": [ - { - "target": "com.amazonaws.workmail#EntityStateException" - }, + { + "target": "com.amazonaws.workmail#InvalidParameterException" + }, + { + "target": "com.amazonaws.workmail#OrganizationNotFoundException" + }, + { + "target": "com.amazonaws.workmail#OrganizationStateException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an Amazon WorkMail organization and all underlying AWS resources managed by Amazon WorkMail as part of the organization. You can choose whether to delete the associated directory. For more information, see Removing an organization in the Amazon WorkMail Administrator Guide.

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.workmail#DeleteOrganizationRequest": { + "type": "structure", + "members": { + "ClientToken": { + "target": "com.amazonaws.workmail#IdempotencyClientToken", + "traits": { + "smithy.api#documentation": "

The idempotency token associated with the request.

", + "smithy.api#idempotencyToken": {} + } + }, + "OrganizationId": { + "target": "com.amazonaws.workmail#OrganizationId", + "traits": { + "smithy.api#documentation": "

The organization ID.

", + "smithy.api#required": {} + } + }, + "DeleteDirectory": { + "target": "com.amazonaws.workmail#Boolean", + "traits": { + "smithy.api#documentation": "

If true, deletes the AWS Directory Service directory associated with the organization.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workmail#DeleteOrganizationResponse": { + "type": "structure", + "members": { + "OrganizationId": { + "target": "com.amazonaws.workmail#OrganizationId", + "traits": { + "smithy.api#documentation": "

The organization ID.

" + } + }, + "State": { + "target": "com.amazonaws.workmail#String", + "traits": { + "smithy.api#documentation": "

The state of the organization.

" + } + } + } + }, + "com.amazonaws.workmail#DeleteResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.workmail#DeleteResourceRequest" + }, + "output": { + "target": "com.amazonaws.workmail#DeleteResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.workmail#EntityStateException" + }, { "target": "com.amazonaws.workmail#InvalidParameterException" }, @@ -741,6 +1160,53 @@ "type": "structure", "members": {} }, + "com.amazonaws.workmail#DeleteRetentionPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.workmail#DeleteRetentionPolicyRequest" + }, + "output": { + "target": "com.amazonaws.workmail#DeleteRetentionPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.workmail#InvalidParameterException" + }, + { + "target": "com.amazonaws.workmail#OrganizationNotFoundException" + }, + { + "target": "com.amazonaws.workmail#OrganizationStateException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the specified retention policy from the specified organization.

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.workmail#DeleteRetentionPolicyRequest": { + "type": "structure", + "members": { + "OrganizationId": { + "target": "com.amazonaws.workmail#OrganizationId", + "traits": { + "smithy.api#documentation": "

The organization ID.

", + "smithy.api#required": {} + } + }, + "Id": { + "target": "com.amazonaws.workmail#ShortString", + "traits": { + "smithy.api#documentation": "

The retention policy ID.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workmail#DeleteRetentionPolicyResponse": { + "type": "structure", + "members": {} + }, "com.amazonaws.workmail#DeleteUser": { "type": "operation", "input": { @@ -773,7 +1239,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a user from Amazon WorkMail and all subsequent systems. Before you can delete a user, the\n user state must be DISABLED. Use the DescribeUser action to\n confirm the user state.

\n

Deleting a user is permanent and cannot be undone.\n WorkMail archives user mailboxes for 30 days before they are permanently removed.

", + "smithy.api#documentation": "

Deletes a user from Amazon WorkMail and all subsequent systems. Before you can delete a\n user, the user state must be DISABLED. Use the DescribeUser\n action to confirm the user state.

\n

Deleting a user is permanent and cannot be undone. WorkMail archives user mailboxes for\n 30 days before they are permanently removed.

", "smithy.api#idempotent": {} } }, @@ -826,7 +1292,7 @@ } ], "traits": { - "smithy.api#documentation": "

Mark a user, group, or resource as no longer used in Amazon WorkMail. This action\n disassociates the mailbox and schedules it for clean-up. WorkMail keeps mailboxes\n for 30 days before they are permanently removed. The functionality in the console is\n Disable.

", + "smithy.api#documentation": "

Mark a user, group, or resource as no longer used in Amazon WorkMail. This action\n disassociates the mailbox and schedules it for clean-up. WorkMail keeps mailboxes for 30 days\n before they are permanently removed. The functionality in the console is\n Disable.

", "smithy.api#idempotent": {} } }, @@ -836,7 +1302,7 @@ "OrganizationId": { "target": "com.amazonaws.workmail#OrganizationId", "traits": { - "smithy.api#documentation": "

The identifier for the organization under which the Amazon WorkMail entity\n exists.

", + "smithy.api#documentation": "

The identifier for the organization under which the Amazon WorkMail entity exists.

", "smithy.api#required": {} } }, @@ -923,7 +1389,7 @@ "State": { "target": "com.amazonaws.workmail#EntityState", "traits": { - "smithy.api#documentation": "

The state of the user: enabled (registered to Amazon WorkMail) or disabled\n (deregistered or never registered to WorkMail).

" + "smithy.api#documentation": "

The state of the user: enabled (registered to Amazon WorkMail) or disabled (deregistered or\n never registered to WorkMail).

" } }, "EnabledDate": { @@ -940,6 +1406,129 @@ } } }, + "com.amazonaws.workmail#DescribeMailboxExportJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.workmail#DescribeMailboxExportJobRequest" + }, + "output": { + "target": "com.amazonaws.workmail#DescribeMailboxExportJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.workmail#EntityNotFoundException" + }, + { + "target": "com.amazonaws.workmail#InvalidParameterException" + }, + { + "target": "com.amazonaws.workmail#OrganizationNotFoundException" + }, + { + "target": "com.amazonaws.workmail#OrganizationStateException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes the current status of a mailbox export job.

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.workmail#DescribeMailboxExportJobRequest": { + "type": "structure", + "members": { + "JobId": { + "target": "com.amazonaws.workmail#MailboxExportJobId", + "traits": { + "smithy.api#documentation": "

The mailbox export job ID.

", + "smithy.api#required": {} + } + }, + "OrganizationId": { + "target": "com.amazonaws.workmail#OrganizationId", + "traits": { + "smithy.api#documentation": "

The organization ID.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workmail#DescribeMailboxExportJobResponse": { + "type": "structure", + "members": { + "EntityId": { + "target": "com.amazonaws.workmail#WorkMailIdentifier", + "traits": { + "smithy.api#documentation": "

The identifier of the user or resource associated with the mailbox.

" + } + }, + "Description": { + "target": "com.amazonaws.workmail#Description", + "traits": { + "smithy.api#documentation": "

The mailbox export job description.

" + } + }, + "RoleArn": { + "target": "com.amazonaws.workmail#RoleArn", + "traits": { + "smithy.api#documentation": "

The ARN of the AWS Identity and Access Management (IAM) role that grants write permission to the Amazon Simple\n Storage Service (Amazon S3) bucket.

" + } + }, + "KmsKeyArn": { + "target": "com.amazonaws.workmail#KmsKeyArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the symmetric AWS Key Management Service (AWS KMS)\n key that encrypts the exported mailbox content.

" + } + }, + "S3BucketName": { + "target": "com.amazonaws.workmail#S3BucketName", + "traits": { + "smithy.api#documentation": "

The name of the S3 bucket.

" + } + }, + "S3Prefix": { + "target": "com.amazonaws.workmail#S3ObjectKey", + "traits": { + "smithy.api#documentation": "

The S3 bucket prefix.

" + } + }, + "S3Path": { + "target": "com.amazonaws.workmail#S3ObjectKey", + "traits": { + "smithy.api#documentation": "

The path to the S3 bucket and file that the mailbox export job is exporting\n to.

" + } + }, + "EstimatedProgress": { + "target": "com.amazonaws.workmail#Percentage", + "traits": { + "smithy.api#documentation": "

The estimated progress of the mailbox export job, in percentage points.

" + } + }, + "State": { + "target": "com.amazonaws.workmail#MailboxExportJobState", + "traits": { + "smithy.api#documentation": "

The state of the mailbox export job.

" + } + }, + "ErrorInfo": { + "target": "com.amazonaws.workmail#MailboxExportErrorInfo", + "traits": { + "smithy.api#documentation": "

Error information for failed mailbox export jobs.

" + } + }, + "StartTime": { + "target": "com.amazonaws.workmail#Timestamp", + "traits": { + "smithy.api#documentation": "

The mailbox export job start timestamp.

" + } + }, + "EndTime": { + "target": "com.amazonaws.workmail#Timestamp", + "traits": { + "smithy.api#documentation": "

The mailbox export job end timestamp.

" + } + } + } + }, "com.amazonaws.workmail#DescribeOrganization": { "type": "operation", "input": { @@ -957,7 +1546,7 @@ } ], "traits": { - "smithy.api#documentation": "

Provides more information regarding a given organization based on its identifier.

", + "smithy.api#documentation": "

Provides more information regarding a given organization based on its\n identifier.

", "smithy.api#idempotent": {} } }, @@ -997,7 +1586,7 @@ "DirectoryId": { "target": "com.amazonaws.workmail#String", "traits": { - "smithy.api#documentation": "

The identifier for the directory associated with an Amazon WorkMail\n organization.

" + "smithy.api#documentation": "

The identifier for the directory associated with an Amazon WorkMail organization.

" } }, "DirectoryType": { @@ -1023,6 +1612,12 @@ "traits": { "smithy.api#documentation": "

(Optional) The error message indicating if unexpected behavior was encountered with\n regards to the organization.

" } + }, + "ARN": { + "target": "com.amazonaws.workmail#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the organization.

" + } } } }, @@ -1108,7 +1703,7 @@ "State": { "target": "com.amazonaws.workmail#EntityState", "traits": { - "smithy.api#documentation": "

The state of the resource: enabled (registered to Amazon WorkMail) or disabled\n (deregistered or never registered to WorkMail).

" + "smithy.api#documentation": "

The state of the resource: enabled (registered to Amazon WorkMail), disabled (deregistered\n or never registered to WorkMail), or deleted.

" } }, "EnabledDate": { @@ -1201,29 +1796,61 @@ "State": { "target": "com.amazonaws.workmail#EntityState", "traits": { - "smithy.api#documentation": "

The state of a user: enabled (registered to Amazon WorkMail) or disabled\n (deregistered or never registered to WorkMail).

" + "smithy.api#documentation": "

The state of a user: enabled (registered to Amazon WorkMail) or disabled (deregistered or\n never registered to WorkMail).

" } }, "UserRole": { "target": "com.amazonaws.workmail#UserRole", "traits": { - "smithy.api#documentation": "

In certain cases, other entities are modeled as users. If interoperability is\n enabled, resources are imported into Amazon WorkMail as users. Because different \n WorkMail organizations rely on different directory types, administrators can distinguish\n between an unregistered user (account is disabled and has a user role) and the directory\n administrators. The values are USER, RESOURCE, and SYSTEM_USER.

" + "smithy.api#documentation": "

In certain cases, other entities are modeled as users. If interoperability is\n enabled, resources are imported into Amazon WorkMail as users. Because different WorkMail\n organizations rely on different directory types, administrators can distinguish between an\n unregistered user (account is disabled and has a user role) and the directory\n administrators. The values are USER, RESOURCE, and SYSTEM_USER.

" } }, "EnabledDate": { "target": "com.amazonaws.workmail#Timestamp", "traits": { - "smithy.api#documentation": "

The date and time at which the user was enabled for Amazon WorkMail usage, in UNIX epoch time format.

" + "smithy.api#documentation": "

The date and time at which the user was enabled for Amazon WorkMail usage, in UNIX epoch\n time format.

" } }, "DisabledDate": { "target": "com.amazonaws.workmail#Timestamp", "traits": { - "smithy.api#documentation": "

The date and time at which the user was disabled for Amazon WorkMail usage, in UNIX epoch time format.

" + "smithy.api#documentation": "

The date and time at which the user was disabled for Amazon WorkMail usage, in UNIX epoch\n time format.

" } } } }, + "com.amazonaws.workmail#Description": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1023 + }, + "smithy.api#pattern": "[\\S\\s]*" + } + }, + "com.amazonaws.workmail#DirectoryId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 12, + "max": 12 + }, + "smithy.api#pattern": "^d-[0-9a-f]{10}$" + } + }, + "com.amazonaws.workmail#DirectoryInUseException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.workmail#String" + } + }, + "traits": { + "smithy.api#documentation": "

The directory is already in use by another WorkMail organization in the same account and Region.

", + "smithy.api#error": "client" + } + }, "com.amazonaws.workmail#DirectoryServiceAuthenticationFailedException": { "type": "structure", "members": { @@ -1232,7 +1859,7 @@ } }, "traits": { - "smithy.api#documentation": "

The directory service doesn't recognize the credentials supplied by \n WorkMail.

", + "smithy.api#documentation": "

The directory service doesn't recognize the credentials supplied by WorkMail.

", "smithy.api#error": "client" } }, @@ -1244,7 +1871,7 @@ } }, "traits": { - "smithy.api#documentation": "

The directory on which you are trying to perform operations isn't\n available.

", + "smithy.api#documentation": "

The directory is unavailable. It might be located in another Region or deleted.

", "smithy.api#error": "client" } }, @@ -1291,14 +1918,14 @@ "ResourceId": { "target": "com.amazonaws.workmail#ResourceId", "traits": { - "smithy.api#documentation": "

The identifier of the resource from which delegates' set members are removed.

", + "smithy.api#documentation": "

The identifier of the resource from which delegates' set members are removed.\n

", "smithy.api#required": {} } }, "EntityId": { "target": "com.amazonaws.workmail#WorkMailIdentifier", "traits": { - "smithy.api#documentation": "

The identifier for the member (user, group) to be removed from the resource's delegates.

", + "smithy.api#documentation": "

The identifier for the member (user, group) to be removed from the resource's\n delegates.

", "smithy.api#required": {} } } @@ -1377,6 +2004,48 @@ "type": "structure", "members": {} }, + "com.amazonaws.workmail#Domain": { + "type": "structure", + "members": { + "DomainName": { + "target": "com.amazonaws.workmail#DomainName", + "traits": { + "smithy.api#documentation": "

The fully qualified domain name.

" + } + }, + "HostedZoneId": { + "target": "com.amazonaws.workmail#HostedZoneId", + "traits": { + "smithy.api#documentation": "

The hosted zone ID for a domain hosted in Route 53. Required when configuring a domain hosted in Route 53.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The domain to associate with an Amazon WorkMail organization.

\n

When you configure a domain hosted in Amazon Route 53 (Route 53), all recommended DNS records are added to the organization when you create it. For more information, see Adding a domain in the Amazon WorkMail Administrator Guide.

" + } + }, + "com.amazonaws.workmail#DomainName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 255 + }, + "smithy.api#pattern": "[a-zA-Z0-9.-]+\\.[a-zA-Z-]{2,}" + } + }, + "com.amazonaws.workmail#Domains": { + "type": "list", + "member": { + "target": "com.amazonaws.workmail#Domain" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5 + } + } + }, "com.amazonaws.workmail#EmailAddress": { "type": "string", "traits": { @@ -1384,7 +2053,7 @@ "min": 1, "max": 254 }, - "smithy.api#pattern": "[a-zA-Z0-9._%+-]{1,64}@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}" + "smithy.api#pattern": "[a-zA-Z0-9._%+-]{1,64}@[a-zA-Z0-9.-]+\\.[a-zA-Z-]{2,}" } }, "com.amazonaws.workmail#EmailAddressInUseException": { @@ -1407,7 +2076,7 @@ } }, "traits": { - "smithy.api#documentation": "

The user, group, or resource that you're trying to register is already registered.

", + "smithy.api#documentation": "

The user, group, or resource that you're trying to register is already\n registered.

", "smithy.api#error": "client" } }, @@ -1419,7 +2088,7 @@ } }, "traits": { - "smithy.api#documentation": "

The identifier supplied for the user, group, or resource does not\n exist in your organization.

", + "smithy.api#documentation": "

The identifier supplied for the user, group, or resource does not exist in your\n organization.

", "smithy.api#error": "client" } }, @@ -1454,23 +2123,228 @@ "smithy.api#error": "client" } }, - "com.amazonaws.workmail#GetMailboxDetails": { - "type": "operation", - "input": { - "target": "com.amazonaws.workmail#GetMailboxDetailsRequest" - }, - "output": { - "target": "com.amazonaws.workmail#GetMailboxDetailsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.workmail#EntityNotFoundException" + "com.amazonaws.workmail#FolderConfiguration": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.workmail#FolderName", + "traits": { + "smithy.api#documentation": "

The folder name.

", + "smithy.api#required": {} + } }, - { - "target": "com.amazonaws.workmail#OrganizationNotFoundException" + "Action": { + "target": "com.amazonaws.workmail#RetentionAction", + "traits": { + "smithy.api#documentation": "

The action to take on the folder contents at the end of the folder configuration\n period.

", + "smithy.api#required": {} + } }, - { - "target": "com.amazonaws.workmail#OrganizationStateException" + "Period": { + "target": "com.amazonaws.workmail#RetentionPeriod", + "traits": { + "smithy.api#documentation": "

The period of time at which the folder configuration action is applied.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration applied to an organization's folders by its retention\n policy.

" + } + }, + "com.amazonaws.workmail#FolderConfigurations": { + "type": "list", + "member": { + "target": "com.amazonaws.workmail#FolderConfiguration" + } + }, + "com.amazonaws.workmail#FolderName": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "INBOX", + "name": "INBOX" + }, + { + "value": "DELETED_ITEMS", + "name": "DELETED_ITEMS" + }, + { + "value": "SENT_ITEMS", + "name": "SENT_ITEMS" + }, + { + "value": "DRAFTS", + "name": "DRAFTS" + }, + { + "value": "JUNK_EMAIL", + "name": "JUNK_EMAIL" + } + ] + } + }, + "com.amazonaws.workmail#GetAccessControlEffect": { + "type": "operation", + "input": { + "target": "com.amazonaws.workmail#GetAccessControlEffectRequest" + }, + "output": { + "target": "com.amazonaws.workmail#GetAccessControlEffectResponse" + }, + "errors": [ + { + "target": "com.amazonaws.workmail#EntityNotFoundException" + }, + { + "target": "com.amazonaws.workmail#InvalidParameterException" + }, + { + "target": "com.amazonaws.workmail#OrganizationNotFoundException" + }, + { + "target": "com.amazonaws.workmail#OrganizationStateException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets the effects of an organization's access control rules as they apply to a\n specified IPv4 address, access protocol action, or user ID.

" + } + }, + "com.amazonaws.workmail#GetAccessControlEffectRequest": { + "type": "structure", + "members": { + "OrganizationId": { + "target": "com.amazonaws.workmail#OrganizationId", + "traits": { + "smithy.api#documentation": "

The identifier for the organization.

", + "smithy.api#required": {} + } + }, + "IpAddress": { + "target": "com.amazonaws.workmail#IpAddress", + "traits": { + "smithy.api#documentation": "

The IPv4 address.

", + "smithy.api#required": {} + } + }, + "Action": { + "target": "com.amazonaws.workmail#AccessControlRuleAction", + "traits": { + "smithy.api#documentation": "

The access protocol action. Valid values include ActiveSync,\n AutoDiscover, EWS, IMAP, SMTP,\n WindowsOutlook, and WebMail.

", + "smithy.api#required": {} + } + }, + "UserId": { + "target": "com.amazonaws.workmail#WorkMailIdentifier", + "traits": { + "smithy.api#documentation": "

The user ID.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workmail#GetAccessControlEffectResponse": { + "type": "structure", + "members": { + "Effect": { + "target": "com.amazonaws.workmail#AccessControlRuleEffect", + "traits": { + "smithy.api#documentation": "

The rule effect.

" + } + }, + "MatchedRules": { + "target": "com.amazonaws.workmail#AccessControlRuleNameList", + "traits": { + "smithy.api#documentation": "

The rules that match the given parameters, resulting in an effect.

" + } + } + } + }, + "com.amazonaws.workmail#GetDefaultRetentionPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.workmail#GetDefaultRetentionPolicyRequest" + }, + "output": { + "target": "com.amazonaws.workmail#GetDefaultRetentionPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.workmail#EntityNotFoundException" + }, + { + "target": "com.amazonaws.workmail#InvalidParameterException" + }, + { + "target": "com.amazonaws.workmail#OrganizationNotFoundException" + }, + { + "target": "com.amazonaws.workmail#OrganizationStateException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets the default retention policy details for the specified organization.

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.workmail#GetDefaultRetentionPolicyRequest": { + "type": "structure", + "members": { + "OrganizationId": { + "target": "com.amazonaws.workmail#OrganizationId", + "traits": { + "smithy.api#documentation": "

The organization ID.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workmail#GetDefaultRetentionPolicyResponse": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.workmail#ShortString", + "traits": { + "smithy.api#documentation": "

The retention policy ID.

" + } + }, + "Name": { + "target": "com.amazonaws.workmail#ShortString", + "traits": { + "smithy.api#documentation": "

The retention policy name.

" + } + }, + "Description": { + "target": "com.amazonaws.workmail#String", + "traits": { + "smithy.api#documentation": "

The retention policy description.

" + } + }, + "FolderConfigurations": { + "target": "com.amazonaws.workmail#FolderConfigurations", + "traits": { + "smithy.api#documentation": "

The retention policy folder configurations.

" + } + } + } + }, + "com.amazonaws.workmail#GetMailboxDetails": { + "type": "operation", + "input": { + "target": "com.amazonaws.workmail#GetMailboxDetailsRequest" + }, + "output": { + "target": "com.amazonaws.workmail#GetMailboxDetailsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.workmail#EntityNotFoundException" + }, + { + "target": "com.amazonaws.workmail#OrganizationNotFoundException" + }, + { + "target": "com.amazonaws.workmail#OrganizationStateException" } ], "traits": { @@ -1574,6 +2448,26 @@ "target": "com.amazonaws.workmail#Group" } }, + "com.amazonaws.workmail#HostedZoneId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 32 + }, + "smithy.api#pattern": "[\\S\\s]*" + } + }, + "com.amazonaws.workmail#IdempotencyClientToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "[\\x21-\\x7e]+" + } + }, "com.amazonaws.workmail#InvalidConfigurationException": { "type": "structure", "members": { @@ -1610,6 +2504,109 @@ "smithy.api#error": "client" } }, + "com.amazonaws.workmail#IpAddress": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 15 + }, + "smithy.api#pattern": "^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$" + } + }, + "com.amazonaws.workmail#IpRange": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 18 + }, + "smithy.api#pattern": "^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])/([0-9]|[12][0-9]|3[0-2])$" + } + }, + "com.amazonaws.workmail#IpRangeList": { + "type": "list", + "member": { + "target": "com.amazonaws.workmail#IpRange" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.workmail#Jobs": { + "type": "list", + "member": { + "target": "com.amazonaws.workmail#MailboxExportJob" + } + }, + "com.amazonaws.workmail#KmsKeyArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "arn:aws:kms:[a-z0-9-]*:[a-z0-9-]+:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}" + } + }, + "com.amazonaws.workmail#LimitExceededException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.workmail#String" + } + }, + "traits": { + "smithy.api#documentation": "

The request exceeds the limit of the resource.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.workmail#ListAccessControlRules": { + "type": "operation", + "input": { + "target": "com.amazonaws.workmail#ListAccessControlRulesRequest" + }, + "output": { + "target": "com.amazonaws.workmail#ListAccessControlRulesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.workmail#OrganizationNotFoundException" + }, + { + "target": "com.amazonaws.workmail#OrganizationStateException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the access control rules for the specified organization.

" + } + }, + "com.amazonaws.workmail#ListAccessControlRulesRequest": { + "type": "structure", + "members": { + "OrganizationId": { + "target": "com.amazonaws.workmail#OrganizationId", + "traits": { + "smithy.api#documentation": "

The identifier for the organization.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workmail#ListAccessControlRulesResponse": { + "type": "structure", + "members": { + "Rules": { + "target": "com.amazonaws.workmail#AccessControlRulesList", + "traits": { + "smithy.api#documentation": "

The access control rules.

" + } + } + } + }, "com.amazonaws.workmail#ListAliases": { "type": "operation", "input": { @@ -1636,7 +2633,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a paginated call to list the aliases associated with a given entity.

", + "smithy.api#documentation": "

Creates a paginated call to list the aliases associated with a given\n entity.

", "smithy.api#idempotent": {}, "smithy.api#paginated": { "inputToken": "NextToken", @@ -1719,7 +2716,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns an overview of the members\n of a group. Users and groups can be members of a group.

", + "smithy.api#documentation": "

Returns an overview of the members of a group. Users and groups can be members of a\n group.

", "smithy.api#idempotent": {}, "smithy.api#paginated": { "inputToken": "NextToken", @@ -1741,7 +2738,7 @@ "GroupId": { "target": "com.amazonaws.workmail#WorkMailIdentifier", "traits": { - "smithy.api#documentation": "

The identifier for the group to which the members (users or groups) are associated.

", + "smithy.api#documentation": "

The identifier for the group to which the members (users or groups) are\n associated.

", "smithy.api#required": {} } }, @@ -1849,18 +2846,15 @@ } } }, - "com.amazonaws.workmail#ListMailboxPermissions": { + "com.amazonaws.workmail#ListMailboxExportJobs": { "type": "operation", "input": { - "target": "com.amazonaws.workmail#ListMailboxPermissionsRequest" + "target": "com.amazonaws.workmail#ListMailboxExportJobsRequest" }, "output": { - "target": "com.amazonaws.workmail#ListMailboxPermissionsResponse" + "target": "com.amazonaws.workmail#ListMailboxExportJobsResponse" }, "errors": [ - { - "target": "com.amazonaws.workmail#EntityNotFoundException" - }, { "target": "com.amazonaws.workmail#InvalidParameterException" }, @@ -1872,7 +2866,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the mailbox permissions associated with a user, group, or resource\n mailbox.

", + "smithy.api#documentation": "

Lists the mailbox export jobs started for the specified organization within the last\n seven days.

", "smithy.api#idempotent": {}, "smithy.api#paginated": { "inputToken": "NextToken", @@ -1881,27 +2875,100 @@ } } }, - "com.amazonaws.workmail#ListMailboxPermissionsRequest": { + "com.amazonaws.workmail#ListMailboxExportJobsRequest": { "type": "structure", "members": { "OrganizationId": { "target": "com.amazonaws.workmail#OrganizationId", "traits": { - "smithy.api#documentation": "

The identifier of the organization under which the user, group, or resource\n exists.

", + "smithy.api#documentation": "

The organization ID.

", "smithy.api#required": {} } }, - "EntityId": { - "target": "com.amazonaws.workmail#WorkMailIdentifier", + "NextToken": { + "target": "com.amazonaws.workmail#NextToken", "traits": { - "smithy.api#documentation": "

The identifier of the user, group, or resource for which to list mailbox\n permissions.

", + "smithy.api#documentation": "

The token to use to retrieve the next page of results.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.workmail#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return in a single call.

" + } + } + } + }, + "com.amazonaws.workmail#ListMailboxExportJobsResponse": { + "type": "structure", + "members": { + "Jobs": { + "target": "com.amazonaws.workmail#Jobs", + "traits": { + "smithy.api#documentation": "

The mailbox export job details.

" + } + }, + "NextToken": { + "target": "com.amazonaws.workmail#NextToken", + "traits": { + "smithy.api#documentation": "

The token to use to retrieve the next page of results.

" + } + } + } + }, + "com.amazonaws.workmail#ListMailboxPermissions": { + "type": "operation", + "input": { + "target": "com.amazonaws.workmail#ListMailboxPermissionsRequest" + }, + "output": { + "target": "com.amazonaws.workmail#ListMailboxPermissionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.workmail#EntityNotFoundException" + }, + { + "target": "com.amazonaws.workmail#InvalidParameterException" + }, + { + "target": "com.amazonaws.workmail#OrganizationNotFoundException" + }, + { + "target": "com.amazonaws.workmail#OrganizationStateException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the mailbox permissions associated with a user, group, or resource\n mailbox.

", + "smithy.api#idempotent": {}, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.workmail#ListMailboxPermissionsRequest": { + "type": "structure", + "members": { + "OrganizationId": { + "target": "com.amazonaws.workmail#OrganizationId", + "traits": { + "smithy.api#documentation": "

The identifier of the organization under which the user, group, or resource\n exists.

", + "smithy.api#required": {} + } + }, + "EntityId": { + "target": "com.amazonaws.workmail#WorkMailIdentifier", + "traits": { + "smithy.api#documentation": "

The identifier of the user, group, or resource for which to list mailbox\n permissions.

", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.workmail#NextToken", "traits": { - "smithy.api#documentation": "

The token to use to retrieve the next page of results. The first call does not contain any tokens.

" + "smithy.api#documentation": "

The token to use to retrieve the next page of results. The first call does not\n contain any tokens.

" } }, "MaxResults": { @@ -1924,7 +2991,7 @@ "NextToken": { "target": "com.amazonaws.workmail#NextToken", "traits": { - "smithy.api#documentation": "

The token to use to retrieve the next page of results. The value is \"null\" when there are no more results to return.

" + "smithy.api#documentation": "

The token to use to retrieve the next page of results. The value is \"null\" when there\n are no more results to return.

" } } } @@ -1943,7 +3010,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns summaries of the customer's non-deleted organizations.

", + "smithy.api#documentation": "

Returns summaries of the customer's organizations.

", "smithy.api#idempotent": {}, "smithy.api#paginated": { "inputToken": "NextToken", @@ -1975,7 +3042,7 @@ "OrganizationSummaries": { "target": "com.amazonaws.workmail#OrganizationSummaries", "traits": { - "smithy.api#documentation": "

The overview of owned organizations presented as a list of organization summaries.

" + "smithy.api#documentation": "

The overview of owned organizations presented as a list of organization\n summaries.

" } }, "NextToken": { @@ -2041,7 +3108,7 @@ "NextToken": { "target": "com.amazonaws.workmail#NextToken", "traits": { - "smithy.api#documentation": "

The token used to paginate through the delegates associated with a resource.

" + "smithy.api#documentation": "

The token used to paginate through the delegates associated with a\n resource.

" } }, "MaxResults": { @@ -2139,6 +3206,46 @@ } } }, + "com.amazonaws.workmail#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.workmail#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.workmail#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.workmail#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the tags applied to an Amazon WorkMail organization resource.

" + } + }, + "com.amazonaws.workmail#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "ResourceARN": { + "target": "com.amazonaws.workmail#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

The resource ARN.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workmail#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "Tags": { + "target": "com.amazonaws.workmail#TagList", + "traits": { + "smithy.api#documentation": "

A list of tag key-value pairs.

" + } + } + } + }, "com.amazonaws.workmail#ListUsers": { "type": "operation", "input": { @@ -2181,7 +3288,7 @@ "NextToken": { "target": "com.amazonaws.workmail#NextToken", "traits": { - "smithy.api#documentation": "

The token to use to retrieve the next page of results. The first call does not contain any tokens.

" + "smithy.api#documentation": "

The token to use to retrieve the next page of results. The first call does not\n contain any tokens.

" } }, "MaxResults": { @@ -2204,7 +3311,7 @@ "NextToken": { "target": "com.amazonaws.workmail#NextToken", "traits": { - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is `null` when there are no more results to return.

" + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is `null` when\n there are no more results to return.

" } } } @@ -2217,7 +3324,7 @@ } }, "traits": { - "smithy.api#documentation": "

For an email or alias to be created in Amazon WorkMail, the included domain must be\n defined in the organization.

", + "smithy.api#documentation": "

For an email or alias to be created in Amazon WorkMail, the included domain must be defined\n in the organization.

", "smithy.api#error": "client" } }, @@ -2233,6 +3340,111 @@ "smithy.api#error": "client" } }, + "com.amazonaws.workmail#MailboxExportErrorInfo": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "[\\S\\s]*" + } + }, + "com.amazonaws.workmail#MailboxExportJob": { + "type": "structure", + "members": { + "JobId": { + "target": "com.amazonaws.workmail#MailboxExportJobId", + "traits": { + "smithy.api#documentation": "

The identifier of the mailbox export job.

" + } + }, + "EntityId": { + "target": "com.amazonaws.workmail#WorkMailIdentifier", + "traits": { + "smithy.api#documentation": "

The identifier of the user or resource associated with the mailbox.

" + } + }, + "Description": { + "target": "com.amazonaws.workmail#Description", + "traits": { + "smithy.api#documentation": "

The mailbox export job description.

" + } + }, + "S3BucketName": { + "target": "com.amazonaws.workmail#S3BucketName", + "traits": { + "smithy.api#documentation": "

The name of the S3 bucket.

" + } + }, + "S3Path": { + "target": "com.amazonaws.workmail#S3ObjectKey", + "traits": { + "smithy.api#documentation": "

The path to the S3 bucket and file that the mailbox export job exports to.

" + } + }, + "EstimatedProgress": { + "target": "com.amazonaws.workmail#Percentage", + "traits": { + "smithy.api#documentation": "

The estimated progress of the mailbox export job, in percentage points.

" + } + }, + "State": { + "target": "com.amazonaws.workmail#MailboxExportJobState", + "traits": { + "smithy.api#documentation": "

The state of the mailbox export job.

" + } + }, + "StartTime": { + "target": "com.amazonaws.workmail#Timestamp", + "traits": { + "smithy.api#documentation": "

The mailbox export job start timestamp.

" + } + }, + "EndTime": { + "target": "com.amazonaws.workmail#Timestamp", + "traits": { + "smithy.api#documentation": "

The mailbox export job end timestamp.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The details of a mailbox export job, including the user or resource ID associated\n with the mailbox and the S3 bucket that the mailbox contents are exported to.

" + } + }, + "com.amazonaws.workmail#MailboxExportJobId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "[A-Za-z0-9-]+" + } + }, + "com.amazonaws.workmail#MailboxExportJobState": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "RUNNING", + "name": "RUNNING" + }, + { + "value": "COMPLETED", + "name": "COMPLETED" + }, + { + "value": "FAILED", + "name": "FAILED" + }, + { + "value": "CANCELLED", + "name": "CANCELLED" + } + ] + } + }, "com.amazonaws.workmail#MailboxQuota": { "type": "integer", "traits": { @@ -2290,13 +3502,13 @@ "EnabledDate": { "target": "com.amazonaws.workmail#Timestamp", "traits": { - "smithy.api#documentation": "

The date indicating when the member was enabled for Amazon WorkMail\n use.

" + "smithy.api#documentation": "

The date indicating when the member was enabled for Amazon WorkMail use.

" } }, "DisabledDate": { "target": "com.amazonaws.workmail#Timestamp", "traits": { - "smithy.api#documentation": "

The date indicating when the member was disabled from Amazon WorkMail\n use.

" + "smithy.api#documentation": "

The date indicating when the member was disabled from Amazon WorkMail use.

" } } }, @@ -2343,12 +3555,17 @@ "smithy.api#length": { "min": 1, "max": 1024 - } + }, + "smithy.api#pattern": "[\\S\\s]*|[a-zA-Z0-9/+=]{1,1024}" } }, "com.amazonaws.workmail#OrganizationId": { "type": "string", "traits": { + "smithy.api#length": { + "min": 34, + "max": 34 + }, "smithy.api#pattern": "^m-[0-9a-f]{32}$" } }, @@ -2359,7 +3576,7 @@ "min": 1, "max": 62 }, - "smithy.api#pattern": "^(?!d-)([\\da-zA-Z]+)([-]*[\\da-zA-Z])*" + "smithy.api#pattern": "^(?!d-)([\\da-zA-Z]+)([-][\\da-zA-Z]+)*" } }, "com.amazonaws.workmail#OrganizationNotFoundException": { @@ -2382,7 +3599,7 @@ } }, "traits": { - "smithy.api#documentation": "

The organization must have a valid state (Active or Synchronizing) to perform certain\n operations on the organization or its members.

", + "smithy.api#documentation": "

The organization must have a valid state to perform certain\n operations on the organization or its members.

", "smithy.api#error": "client" } }, @@ -2407,10 +3624,16 @@ "smithy.api#documentation": "

The alias associated with the organization.

" } }, + "DefaultMailDomain": { + "target": "com.amazonaws.workmail#DomainName", + "traits": { + "smithy.api#documentation": "

The default email domain associated with the organization.

" + } + }, "ErrorMessage": { "target": "com.amazonaws.workmail#String", "traits": { - "smithy.api#documentation": "

The error message associated with the organization. It is only present if unexpected\n behavior has occurred with regards to the organization. It provides insight or solutions\n regarding unexpected behavior.

" + "smithy.api#documentation": "

The error message associated with the organization. It is only present if unexpected\n behavior has occurred with regards to the organization. It provides insight or solutions\n regarding unexpected behavior.

" } }, "State": { @@ -2435,6 +3658,15 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.workmail#Percentage": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 100 + } + } + }, "com.amazonaws.workmail#Permission": { "type": "structure", "members": { @@ -2455,7 +3687,7 @@ "PermissionValues": { "target": "com.amazonaws.workmail#PermissionValues", "traits": { - "smithy.api#documentation": "

The permissions granted to the grantee. SEND_AS allows the grantee to send email as the owner of the mailbox (the grantee is not mentioned on these emails). SEND_ON_BEHALF allows the grantee to send email on behalf of the owner of the mailbox (the grantee is not mentioned as the physical sender of these emails). FULL_ACCESS allows the grantee full access to the mailbox, irrespective of other folder-level permissions set on the mailbox.

", + "smithy.api#documentation": "

The permissions granted to the grantee. SEND_AS allows the grantee to send email as\n the owner of the mailbox (the grantee is not mentioned on these emails). SEND_ON_BEHALF\n allows the grantee to send email on behalf of the owner of the mailbox (the grantee is not\n mentioned as the physical sender of these emails). FULL_ACCESS allows the grantee full\n access to the mailbox, irrespective of other folder-level permissions set on the\n mailbox.

", "smithy.api#required": {} } } @@ -2495,23 +3727,34 @@ "target": "com.amazonaws.workmail#Permission" } }, - "com.amazonaws.workmail#PutMailboxPermissions": { + "com.amazonaws.workmail#PolicyDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "[\\w\\d\\s\\S\\-!?=,.;:'_]+", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.workmail#PutAccessControlRule": { "type": "operation", "input": { - "target": "com.amazonaws.workmail#PutMailboxPermissionsRequest" + "target": "com.amazonaws.workmail#PutAccessControlRuleRequest" }, "output": { - "target": "com.amazonaws.workmail#PutMailboxPermissionsResponse" + "target": "com.amazonaws.workmail#PutAccessControlRuleResponse" }, "errors": [ { "target": "com.amazonaws.workmail#EntityNotFoundException" }, { - "target": "com.amazonaws.workmail#EntityStateException" + "target": "com.amazonaws.workmail#InvalidParameterException" }, { - "target": "com.amazonaws.workmail#InvalidParameterException" + "target": "com.amazonaws.workmail#LimitExceededException" }, { "target": "com.amazonaws.workmail#OrganizationNotFoundException" @@ -2521,68 +3764,91 @@ } ], "traits": { - "smithy.api#documentation": "

Sets permissions for a user, group, or resource. This replaces any pre-existing\n permissions.

", - "smithy.api#idempotent": {} + "smithy.api#documentation": "

Adds a new access control rule for the specified organization. The rule allows or\n denies access to the organization for the specified IPv4 addresses, access protocol\n actions, and user IDs. Adding a new rule with the same name as an existing rule replaces\n the older rule.

" } }, - "com.amazonaws.workmail#PutMailboxPermissionsRequest": { + "com.amazonaws.workmail#PutAccessControlRuleRequest": { "type": "structure", "members": { - "OrganizationId": { - "target": "com.amazonaws.workmail#OrganizationId", + "Name": { + "target": "com.amazonaws.workmail#AccessControlRuleName", "traits": { - "smithy.api#documentation": "

The identifier of the organization under which the user, group, or resource\n exists.

", + "smithy.api#documentation": "

The rule name.

", "smithy.api#required": {} } }, - "EntityId": { - "target": "com.amazonaws.workmail#WorkMailIdentifier", + "Effect": { + "target": "com.amazonaws.workmail#AccessControlRuleEffect", "traits": { - "smithy.api#documentation": "

The identifier of the user, group, or resource for which to update mailbox\n permissions.

", + "smithy.api#documentation": "

The rule effect.

", "smithy.api#required": {} } }, - "GranteeId": { - "target": "com.amazonaws.workmail#WorkMailIdentifier", + "Description": { + "target": "com.amazonaws.workmail#AccessControlRuleDescription", "traits": { - "smithy.api#documentation": "

The identifier of the user, group, or resource to which to grant the\n permissions.

", + "smithy.api#documentation": "

The rule description.

", "smithy.api#required": {} } }, - "PermissionValues": { - "target": "com.amazonaws.workmail#PermissionValues", + "IpRanges": { + "target": "com.amazonaws.workmail#IpRangeList", + "traits": { + "smithy.api#documentation": "

IPv4 CIDR ranges to include in the rule.

" + } + }, + "NotIpRanges": { + "target": "com.amazonaws.workmail#IpRangeList", + "traits": { + "smithy.api#documentation": "

IPv4 CIDR ranges to exclude from the rule.

" + } + }, + "Actions": { + "target": "com.amazonaws.workmail#ActionsList", + "traits": { + "smithy.api#documentation": "

Access protocol actions to include in the rule. Valid values include\n ActiveSync, AutoDiscover, EWS, IMAP,\n SMTP, WindowsOutlook, and WebMail.

" + } + }, + "NotActions": { + "target": "com.amazonaws.workmail#ActionsList", + "traits": { + "smithy.api#documentation": "

Access protocol actions to exclude from the rule. Valid values include\n ActiveSync, AutoDiscover, EWS, IMAP,\n SMTP, WindowsOutlook, and WebMail.

" + } + }, + "UserIds": { + "target": "com.amazonaws.workmail#UserIdList", + "traits": { + "smithy.api#documentation": "

User IDs to include in the rule.

" + } + }, + "NotUserIds": { + "target": "com.amazonaws.workmail#UserIdList", + "traits": { + "smithy.api#documentation": "

User IDs to exclude from the rule.

" + } + }, + "OrganizationId": { + "target": "com.amazonaws.workmail#OrganizationId", "traits": { - "smithy.api#documentation": "

The permissions granted to the grantee. SEND_AS allows the grantee to send email as the owner of the mailbox (the grantee is not mentioned on these emails). SEND_ON_BEHALF allows the grantee to send email on behalf of the owner of the mailbox (the grantee is not mentioned as the physical sender of these emails). FULL_ACCESS allows the grantee full access to the mailbox, irrespective of other folder-level permissions set on the mailbox.

", + "smithy.api#documentation": "

The identifier of the organization.

", "smithy.api#required": {} } } } }, - "com.amazonaws.workmail#PutMailboxPermissionsResponse": { + "com.amazonaws.workmail#PutAccessControlRuleResponse": { "type": "structure", "members": {} }, - "com.amazonaws.workmail#RegisterToWorkMail": { + "com.amazonaws.workmail#PutMailboxPermissions": { "type": "operation", "input": { - "target": "com.amazonaws.workmail#RegisterToWorkMailRequest" + "target": "com.amazonaws.workmail#PutMailboxPermissionsRequest" }, "output": { - "target": "com.amazonaws.workmail#RegisterToWorkMailResponse" + "target": "com.amazonaws.workmail#PutMailboxPermissionsResponse" }, "errors": [ - { - "target": "com.amazonaws.workmail#DirectoryServiceAuthenticationFailedException" - }, - { - "target": "com.amazonaws.workmail#DirectoryUnavailableException" - }, - { - "target": "com.amazonaws.workmail#EmailAddressInUseException" - }, - { - "target": "com.amazonaws.workmail#EntityAlreadyRegisteredException" - }, { "target": "com.amazonaws.workmail#EntityNotFoundException" }, @@ -2592,12 +3858,6 @@ { "target": "com.amazonaws.workmail#InvalidParameterException" }, - { - "target": "com.amazonaws.workmail#MailDomainNotFoundException" - }, - { - "target": "com.amazonaws.workmail#MailDomainStateException" - }, { "target": "com.amazonaws.workmail#OrganizationNotFoundException" }, @@ -2606,7 +3866,161 @@ } ], "traits": { - "smithy.api#documentation": "

Registers an existing and disabled user, group, or resource for Amazon WorkMail use by\n associating a mailbox and calendaring capabilities. It performs no change if the user,\n group, or resource is enabled and fails if the user, group, or resource is deleted. This\n operation results in the accumulation of costs. For more information, see Pricing. The equivalent console\n functionality for this operation is Enable.

\n

Users can either be created by calling the CreateUser API operation or\n they can be synchronized from your directory. For more information, see DeregisterFromWorkMail.

", + "smithy.api#documentation": "

Sets permissions for a user, group, or resource. This replaces any pre-existing\n permissions.

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.workmail#PutMailboxPermissionsRequest": { + "type": "structure", + "members": { + "OrganizationId": { + "target": "com.amazonaws.workmail#OrganizationId", + "traits": { + "smithy.api#documentation": "

The identifier of the organization under which the user, group, or resource\n exists.

", + "smithy.api#required": {} + } + }, + "EntityId": { + "target": "com.amazonaws.workmail#WorkMailIdentifier", + "traits": { + "smithy.api#documentation": "

The identifier of the user, group, or resource for which to update mailbox\n permissions.

", + "smithy.api#required": {} + } + }, + "GranteeId": { + "target": "com.amazonaws.workmail#WorkMailIdentifier", + "traits": { + "smithy.api#documentation": "

The identifier of the user, group, or resource to which to grant the\n permissions.

", + "smithy.api#required": {} + } + }, + "PermissionValues": { + "target": "com.amazonaws.workmail#PermissionValues", + "traits": { + "smithy.api#documentation": "

The permissions granted to the grantee. SEND_AS allows the grantee to send email as\n the owner of the mailbox (the grantee is not mentioned on these emails). SEND_ON_BEHALF\n allows the grantee to send email on behalf of the owner of the mailbox (the grantee is not\n mentioned as the physical sender of these emails). FULL_ACCESS allows the grantee full\n access to the mailbox, irrespective of other folder-level permissions set on the\n mailbox.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workmail#PutMailboxPermissionsResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.workmail#PutRetentionPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.workmail#PutRetentionPolicyRequest" + }, + "output": { + "target": "com.amazonaws.workmail#PutRetentionPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.workmail#InvalidParameterException" + }, + { + "target": "com.amazonaws.workmail#LimitExceededException" + }, + { + "target": "com.amazonaws.workmail#OrganizationNotFoundException" + }, + { + "target": "com.amazonaws.workmail#OrganizationStateException" + } + ], + "traits": { + "smithy.api#documentation": "

Puts a retention policy to the specified organization.

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.workmail#PutRetentionPolicyRequest": { + "type": "structure", + "members": { + "OrganizationId": { + "target": "com.amazonaws.workmail#OrganizationId", + "traits": { + "smithy.api#documentation": "

The organization ID.

", + "smithy.api#required": {} + } + }, + "Id": { + "target": "com.amazonaws.workmail#ShortString", + "traits": { + "smithy.api#documentation": "

The retention policy ID.

" + } + }, + "Name": { + "target": "com.amazonaws.workmail#ShortString", + "traits": { + "smithy.api#documentation": "

The retention policy name.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.workmail#PolicyDescription", + "traits": { + "smithy.api#documentation": "

The retention policy description.

" + } + }, + "FolderConfigurations": { + "target": "com.amazonaws.workmail#FolderConfigurations", + "traits": { + "smithy.api#documentation": "

The retention policy folder configurations.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workmail#PutRetentionPolicyResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.workmail#RegisterToWorkMail": { + "type": "operation", + "input": { + "target": "com.amazonaws.workmail#RegisterToWorkMailRequest" + }, + "output": { + "target": "com.amazonaws.workmail#RegisterToWorkMailResponse" + }, + "errors": [ + { + "target": "com.amazonaws.workmail#DirectoryServiceAuthenticationFailedException" + }, + { + "target": "com.amazonaws.workmail#DirectoryUnavailableException" + }, + { + "target": "com.amazonaws.workmail#EmailAddressInUseException" + }, + { + "target": "com.amazonaws.workmail#EntityAlreadyRegisteredException" + }, + { + "target": "com.amazonaws.workmail#EntityNotFoundException" + }, + { + "target": "com.amazonaws.workmail#EntityStateException" + }, + { + "target": "com.amazonaws.workmail#InvalidParameterException" + }, + { + "target": "com.amazonaws.workmail#MailDomainNotFoundException" + }, + { + "target": "com.amazonaws.workmail#MailDomainStateException" + }, + { + "target": "com.amazonaws.workmail#OrganizationNotFoundException" + }, + { + "target": "com.amazonaws.workmail#OrganizationStateException" + } + ], + "traits": { + "smithy.api#documentation": "

Registers an existing and disabled user, group, or resource for Amazon WorkMail use by\n associating a mailbox and calendaring capabilities. It performs no change if the user,\n group, or resource is enabled and fails if the user, group, or resource is deleted. This\n operation results in the accumulation of costs. For more information, see Pricing. The equivalent console\n functionality for this operation is Enable.

\n

Users can either be created by calling the CreateUser API operation\n or they can be synchronized from your directory. For more information, see DeregisterFromWorkMail.

", "smithy.api#idempotent": {} } }, @@ -2636,188 +4050,485 @@ } } }, - "com.amazonaws.workmail#RegisterToWorkMailResponse": { - "type": "structure", - "members": {} - }, - "com.amazonaws.workmail#ReservedNameException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.workmail#String" - } - }, + "com.amazonaws.workmail#RegisterToWorkMailResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.workmail#ReservedNameException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.workmail#String" + } + }, + "traits": { + "smithy.api#documentation": "

This user, group, or resource name is not allowed in Amazon WorkMail.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.workmail#ResetPassword": { + "type": "operation", + "input": { + "target": "com.amazonaws.workmail#ResetPasswordRequest" + }, + "output": { + "target": "com.amazonaws.workmail#ResetPasswordResponse" + }, + "errors": [ + { + "target": "com.amazonaws.workmail#DirectoryServiceAuthenticationFailedException" + }, + { + "target": "com.amazonaws.workmail#DirectoryUnavailableException" + }, + { + "target": "com.amazonaws.workmail#EntityNotFoundException" + }, + { + "target": "com.amazonaws.workmail#EntityStateException" + }, + { + "target": "com.amazonaws.workmail#InvalidParameterException" + }, + { + "target": "com.amazonaws.workmail#InvalidPasswordException" + }, + { + "target": "com.amazonaws.workmail#OrganizationNotFoundException" + }, + { + "target": "com.amazonaws.workmail#OrganizationStateException" + }, + { + "target": "com.amazonaws.workmail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Allows the administrator to reset the password for a user.

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.workmail#ResetPasswordRequest": { + "type": "structure", + "members": { + "OrganizationId": { + "target": "com.amazonaws.workmail#OrganizationId", + "traits": { + "smithy.api#documentation": "

The identifier of the organization that contains the user for which the password is\n reset.

", + "smithy.api#required": {} + } + }, + "UserId": { + "target": "com.amazonaws.workmail#WorkMailIdentifier", + "traits": { + "smithy.api#documentation": "

The identifier of the user for whom the password is reset.

", + "smithy.api#required": {} + } + }, + "Password": { + "target": "com.amazonaws.workmail#Password", + "traits": { + "smithy.api#documentation": "

The new password for the user.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workmail#ResetPasswordResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.workmail#Resource": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.workmail#WorkMailIdentifier", + "traits": { + "smithy.api#documentation": "

The identifier of the resource.

" + } + }, + "Email": { + "target": "com.amazonaws.workmail#EmailAddress", + "traits": { + "smithy.api#documentation": "

The email of the resource.

" + } + }, + "Name": { + "target": "com.amazonaws.workmail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the resource.

" + } + }, + "Type": { + "target": "com.amazonaws.workmail#ResourceType", + "traits": { + "smithy.api#documentation": "

The type of the resource: equipment or room.

" + } + }, + "State": { + "target": "com.amazonaws.workmail#EntityState", + "traits": { + "smithy.api#documentation": "

The state of the resource, which can be ENABLED, DISABLED, or DELETED.

" + } + }, + "EnabledDate": { + "target": "com.amazonaws.workmail#Timestamp", + "traits": { + "smithy.api#documentation": "

The date indicating when the resource was enabled for Amazon WorkMail use.

" + } + }, + "DisabledDate": { + "target": "com.amazonaws.workmail#Timestamp", + "traits": { + "smithy.api#documentation": "

The date indicating when the resource was disabled from Amazon WorkMail use.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The representation of a resource.

" + } + }, + "com.amazonaws.workmail#ResourceDelegates": { + "type": "list", + "member": { + "target": "com.amazonaws.workmail#Delegate" + } + }, + "com.amazonaws.workmail#ResourceId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 34, + "max": 34 + }, + "smithy.api#pattern": "^r-[0-9a-f]{32}$" + } + }, + "com.amazonaws.workmail#ResourceName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20 + }, + "smithy.api#pattern": "[\\w\\-.]+(@[a-zA-Z0-9.\\-]+\\.[a-zA-Z0-9-]{2,})?" + } + }, + "com.amazonaws.workmail#ResourceNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.workmail#String" + } + }, + "traits": { + "smithy.api#documentation": "

The resource cannot be found.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.workmail#ResourceType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ROOM", + "name": "ROOM" + }, + { + "value": "EQUIPMENT", + "name": "EQUIPMENT" + } + ] + } + }, + "com.amazonaws.workmail#Resources": { + "type": "list", + "member": { + "target": "com.amazonaws.workmail#Resource" + } + }, + "com.amazonaws.workmail#RetentionAction": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "NONE", + "name": "NONE" + }, + { + "value": "DELETE", + "name": "DELETE" + }, + { + "value": "PERMANENTLY_DELETE", + "name": "PERMANENTLY_DELETE" + } + ] + } + }, + "com.amazonaws.workmail#RetentionPeriod": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1, + "max": 730 + } + } + }, + "com.amazonaws.workmail#RoleArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + } + } + }, + "com.amazonaws.workmail#S3BucketName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "[A-Za-z0-9.-]+" + } + }, + "com.amazonaws.workmail#S3ObjectKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1023 + }, + "smithy.api#pattern": "[A-Za-z0-9!_.*'()/-]+" + } + }, + "com.amazonaws.workmail#ShortString": { + "type": "string", "traits": { - "smithy.api#documentation": "

This user, group, or resource name is not allowed in Amazon WorkMail.

", - "smithy.api#error": "client" + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "[a-zA-Z0-9_-]+" } }, - "com.amazonaws.workmail#ResetPassword": { + "com.amazonaws.workmail#StartMailboxExportJob": { "type": "operation", "input": { - "target": "com.amazonaws.workmail#ResetPasswordRequest" + "target": "com.amazonaws.workmail#StartMailboxExportJobRequest" }, "output": { - "target": "com.amazonaws.workmail#ResetPasswordResponse" + "target": "com.amazonaws.workmail#StartMailboxExportJobResponse" }, "errors": [ - { - "target": "com.amazonaws.workmail#DirectoryServiceAuthenticationFailedException" - }, - { - "target": "com.amazonaws.workmail#DirectoryUnavailableException" - }, { "target": "com.amazonaws.workmail#EntityNotFoundException" }, - { - "target": "com.amazonaws.workmail#EntityStateException" - }, { "target": "com.amazonaws.workmail#InvalidParameterException" }, { - "target": "com.amazonaws.workmail#InvalidPasswordException" + "target": "com.amazonaws.workmail#LimitExceededException" }, { "target": "com.amazonaws.workmail#OrganizationNotFoundException" }, { "target": "com.amazonaws.workmail#OrganizationStateException" - }, - { - "target": "com.amazonaws.workmail#UnsupportedOperationException" } ], "traits": { - "smithy.api#documentation": "

Allows the administrator to reset the password for a user.

", + "smithy.api#documentation": "

Starts a mailbox export job to export MIME-format email messages and calendar items\n from the specified mailbox to the specified Amazon Simple Storage Service (Amazon S3)\n bucket. For more information, see Exporting mailbox content in\n the Amazon WorkMail Administrator Guide.

", "smithy.api#idempotent": {} } }, - "com.amazonaws.workmail#ResetPasswordRequest": { + "com.amazonaws.workmail#StartMailboxExportJobRequest": { "type": "structure", "members": { + "ClientToken": { + "target": "com.amazonaws.workmail#IdempotencyClientToken", + "traits": { + "smithy.api#documentation": "

The idempotency token for the client request.

", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + }, "OrganizationId": { "target": "com.amazonaws.workmail#OrganizationId", "traits": { - "smithy.api#documentation": "

The identifier of the organization that contains the user for which the password is\n reset.

", + "smithy.api#documentation": "

The identifier associated with the organization.

", "smithy.api#required": {} } }, - "UserId": { + "EntityId": { "target": "com.amazonaws.workmail#WorkMailIdentifier", "traits": { - "smithy.api#documentation": "

The identifier of the user for whom the password is reset.

", + "smithy.api#documentation": "

The identifier of the user or resource associated with the mailbox.

", "smithy.api#required": {} } }, - "Password": { - "target": "com.amazonaws.workmail#Password", + "Description": { + "target": "com.amazonaws.workmail#Description", "traits": { - "smithy.api#documentation": "

The new password for the user.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The mailbox export job description.

" } - } - } - }, - "com.amazonaws.workmail#ResetPasswordResponse": { - "type": "structure", - "members": {} - }, - "com.amazonaws.workmail#Resource": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.workmail#WorkMailIdentifier", + }, + "RoleArn": { + "target": "com.amazonaws.workmail#RoleArn", "traits": { - "smithy.api#documentation": "

The identifier of the resource.

" + "smithy.api#documentation": "

The ARN of the AWS Identity and Access Management (IAM) role that grants write permission to the S3\n bucket.

", + "smithy.api#required": {} } }, - "Email": { - "target": "com.amazonaws.workmail#EmailAddress", + "KmsKeyArn": { + "target": "com.amazonaws.workmail#KmsKeyArn", "traits": { - "smithy.api#documentation": "

The email of the resource.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the symmetric AWS Key Management Service (AWS KMS)\n key that encrypts the exported mailbox content.

", + "smithy.api#required": {} } }, - "Name": { - "target": "com.amazonaws.workmail#ResourceName", + "S3BucketName": { + "target": "com.amazonaws.workmail#S3BucketName", "traits": { - "smithy.api#documentation": "

The name of the resource.

" + "smithy.api#documentation": "

The name of the S3 bucket.

", + "smithy.api#required": {} } }, - "Type": { - "target": "com.amazonaws.workmail#ResourceType", + "S3Prefix": { + "target": "com.amazonaws.workmail#S3ObjectKey", "traits": { - "smithy.api#documentation": "

The type of the resource: equipment or room.

" + "smithy.api#documentation": "

The S3 bucket prefix.

", + "smithy.api#required": {} } - }, - "State": { - "target": "com.amazonaws.workmail#EntityState", + } + } + }, + "com.amazonaws.workmail#StartMailboxExportJobResponse": { + "type": "structure", + "members": { + "JobId": { + "target": "com.amazonaws.workmail#MailboxExportJobId", "traits": { - "smithy.api#documentation": "

The state of the resource, which can be ENABLED, DISABLED, or DELETED.

" + "smithy.api#documentation": "

The job ID.

" } - }, - "EnabledDate": { - "target": "com.amazonaws.workmail#Timestamp", + } + } + }, + "com.amazonaws.workmail#String": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.workmail#Tag": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.workmail#TagKey", "traits": { - "smithy.api#documentation": "

The date indicating when the resource was enabled for Amazon WorkMail use.

" + "smithy.api#documentation": "

The key of the tag.

", + "smithy.api#required": {} } }, - "DisabledDate": { - "target": "com.amazonaws.workmail#Timestamp", + "Value": { + "target": "com.amazonaws.workmail#TagValue", "traits": { - "smithy.api#documentation": "

The date indicating when the resource was disabled from Amazon WorkMail\n use.

" + "smithy.api#documentation": "

The value of the tag.

", + "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

The representation of a resource.

" + "smithy.api#documentation": "

Describes a tag applied to a resource.

" } }, - "com.amazonaws.workmail#ResourceDelegates": { - "type": "list", - "member": { - "target": "com.amazonaws.workmail#Delegate" + "com.amazonaws.workmail#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } } }, - "com.amazonaws.workmail#ResourceId": { - "type": "string", + "com.amazonaws.workmail#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.workmail#TagKey" + }, "traits": { - "smithy.api#pattern": "^r-[0-9a-f]{32}$" + "smithy.api#length": { + "min": 0, + "max": 50 + } } }, - "com.amazonaws.workmail#ResourceName": { - "type": "string", + "com.amazonaws.workmail#TagList": { + "type": "list", + "member": { + "target": "com.amazonaws.workmail#Tag" + }, "traits": { "smithy.api#length": { - "min": 1, - "max": 20 - }, - "smithy.api#pattern": "[\\w\\-.]+(@[a-zA-Z0-9.\\-]+\\.[a-zA-Z0-9]{2,})?" + "min": 0, + "max": 50 + } } }, - "com.amazonaws.workmail#ResourceType": { - "type": "string", + "com.amazonaws.workmail#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.workmail#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.workmail#TagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.workmail#OrganizationStateException" + }, + { + "target": "com.amazonaws.workmail#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.workmail#TooManyTagsException" + } + ], "traits": { - "smithy.api#enum": [ - { - "value": "ROOM", - "name": "ROOM" - }, - { - "value": "EQUIPMENT", - "name": "EQUIPMENT" - } - ] + "smithy.api#documentation": "

Applies the specified tags to the specified Amazon WorkMail organization\n resource.

" } }, - "com.amazonaws.workmail#Resources": { - "type": "list", - "member": { - "target": "com.amazonaws.workmail#Resource" + "com.amazonaws.workmail#TagResourceRequest": { + "type": "structure", + "members": { + "ResourceARN": { + "target": "com.amazonaws.workmail#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

The resource ARN.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.workmail#TagList", + "traits": { + "smithy.api#documentation": "

The tag key-value pairs.

", + "smithy.api#required": {} + } + } } }, - "com.amazonaws.workmail#String": { + "com.amazonaws.workmail#TagResourceResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.workmail#TagValue": { "type": "string", "traits": { "smithy.api#length": { @@ -2829,6 +4540,19 @@ "com.amazonaws.workmail#Timestamp": { "type": "timestamp" }, + "com.amazonaws.workmail#TooManyTagsException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.workmail#String" + } + }, + "traits": { + "smithy.api#documentation": "

The resource can have up to 50 user-applied tags.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, "com.amazonaws.workmail#UnsupportedOperationException": { "type": "structure", "members": { @@ -2841,6 +4565,46 @@ "smithy.api#error": "client" } }, + "com.amazonaws.workmail#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.workmail#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.workmail#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.workmail#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Untags the specified tags from the specified Amazon WorkMail organization\n resource.

" + } + }, + "com.amazonaws.workmail#UntagResourceRequest": { + "type": "structure", + "members": { + "ResourceARN": { + "target": "com.amazonaws.workmail#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

The resource ARN.

", + "smithy.api#required": {} + } + }, + "TagKeys": { + "target": "com.amazonaws.workmail#TagKeyList", + "traits": { + "smithy.api#documentation": "

The tag keys.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workmail#UntagResourceResponse": { + "type": "structure", + "members": {} + }, "com.amazonaws.workmail#UpdateMailboxQuota": { "type": "operation", "input": { @@ -2867,7 +4631,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates a user's current mailbox quota for a specified organization and user.

", + "smithy.api#documentation": "

Updates a user's current mailbox quota for a specified organization and\n user.

", "smithy.api#idempotent": {} } }, @@ -2877,7 +4641,7 @@ "OrganizationId": { "target": "com.amazonaws.workmail#OrganizationId", "traits": { - "smithy.api#documentation": "

The identifier for the organization that contains the user for whom to update the mailbox quota.

", + "smithy.api#documentation": "

The identifier for the organization that contains the user for whom to update the\n mailbox quota.

", "smithy.api#required": {} } }, @@ -3115,6 +4879,18 @@ "smithy.api#documentation": "

The representation of an Amazon WorkMail user.

" } }, + "com.amazonaws.workmail#UserIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.workmail#WorkMailIdentifier" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, "com.amazonaws.workmail#UserName": { "type": "string", "traits": { @@ -3122,7 +4898,7 @@ "min": 1, "max": 64 }, - "smithy.api#pattern": "[\\w\\-.]+(@[a-zA-Z0-9.\\-]+\\.[a-zA-Z0-9]{2,})?" + "smithy.api#pattern": "[\\w\\-.]+(@[a-zA-Z0-9.\\-]+\\.[a-zA-Z0-9-]{2,})?" } }, "com.amazonaws.workmail#UserRole": { @@ -3169,18 +4945,27 @@ { "target": "com.amazonaws.workmail#AssociateMemberToGroup" }, + { + "target": "com.amazonaws.workmail#CancelMailboxExportJob" + }, { "target": "com.amazonaws.workmail#CreateAlias" }, { "target": "com.amazonaws.workmail#CreateGroup" }, + { + "target": "com.amazonaws.workmail#CreateOrganization" + }, { "target": "com.amazonaws.workmail#CreateResource" }, { "target": "com.amazonaws.workmail#CreateUser" }, + { + "target": "com.amazonaws.workmail#DeleteAccessControlRule" + }, { "target": "com.amazonaws.workmail#DeleteAlias" }, @@ -3190,9 +4975,15 @@ { "target": "com.amazonaws.workmail#DeleteMailboxPermissions" }, + { + "target": "com.amazonaws.workmail#DeleteOrganization" + }, { "target": "com.amazonaws.workmail#DeleteResource" }, + { + "target": "com.amazonaws.workmail#DeleteRetentionPolicy" + }, { "target": "com.amazonaws.workmail#DeleteUser" }, @@ -3202,6 +4993,9 @@ { "target": "com.amazonaws.workmail#DescribeGroup" }, + { + "target": "com.amazonaws.workmail#DescribeMailboxExportJob" + }, { "target": "com.amazonaws.workmail#DescribeOrganization" }, @@ -3217,9 +5011,18 @@ { "target": "com.amazonaws.workmail#DisassociateMemberFromGroup" }, + { + "target": "com.amazonaws.workmail#GetAccessControlEffect" + }, + { + "target": "com.amazonaws.workmail#GetDefaultRetentionPolicy" + }, { "target": "com.amazonaws.workmail#GetMailboxDetails" }, + { + "target": "com.amazonaws.workmail#ListAccessControlRules" + }, { "target": "com.amazonaws.workmail#ListAliases" }, @@ -3229,6 +5032,9 @@ { "target": "com.amazonaws.workmail#ListGroups" }, + { + "target": "com.amazonaws.workmail#ListMailboxExportJobs" + }, { "target": "com.amazonaws.workmail#ListMailboxPermissions" }, @@ -3241,18 +5047,36 @@ { "target": "com.amazonaws.workmail#ListResources" }, + { + "target": "com.amazonaws.workmail#ListTagsForResource" + }, { "target": "com.amazonaws.workmail#ListUsers" }, + { + "target": "com.amazonaws.workmail#PutAccessControlRule" + }, { "target": "com.amazonaws.workmail#PutMailboxPermissions" }, + { + "target": "com.amazonaws.workmail#PutRetentionPolicy" + }, { "target": "com.amazonaws.workmail#RegisterToWorkMail" }, { "target": "com.amazonaws.workmail#ResetPassword" }, + { + "target": "com.amazonaws.workmail#StartMailboxExportJob" + }, + { + "target": "com.amazonaws.workmail#TagResource" + }, + { + "target": "com.amazonaws.workmail#UntagResource" + }, { "target": "com.amazonaws.workmail#UpdateMailboxQuota" }, @@ -3275,7 +5099,7 @@ "name": "workmail" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "

Amazon WorkMail is a secure, managed business email and calendaring service with support for\n existing desktop and mobile email clients. You can access your email, contacts, and\n calendars using Microsoft Outlook, your browser, or other native iOS and Android email\n applications. You can integrate WorkMail with your existing corporate directory and control\n both the keys that encrypt your data and the location in which your data is\n stored.

\n

The WorkMail API is designed for the following scenarios:

\n \n \n \n \n

All WorkMail API operations are Amazon-authenticated and certificate-signed. They not only\n require the use of the AWS SDK, but also allow for the exclusive use of AWS Identity and Access Management users and roles\n to help facilitate access, trust, and permission policies. By creating a role and allowing\n an IAM user to access the WorkMail site, the IAM user gains full administrative visibility into\n the entire WorkMail organization (or as set in the IAM policy). This includes, but is not\n limited to, the ability to create, update, and delete users, groups, and resources. This\n allows developers to perform the scenarios listed above, as well as give users the ability\n to grant access on a selective basis using the IAM model.

", + "smithy.api#documentation": "

Amazon WorkMail is a secure, managed business email and calendaring service with support for\n existing desktop and mobile email clients. You can access your email, contacts, and\n calendars using Microsoft Outlook, your browser, or other native iOS and Android email\n applications. You can integrate WorkMail with your existing corporate directory and control\n both the keys that encrypt your data and the location in which your data is\n stored.

\n

The WorkMail API is designed for the following scenarios:

\n \n \n \n \n

All WorkMail API operations are Amazon-authenticated and certificate-signed. They not\n only require the use of the AWS SDK, but also allow for the exclusive use of AWS Identity and Access Management\n users and roles to help facilitate access, trust, and permission policies. By creating a\n role and allowing an IAM user to access the WorkMail site, the IAM user gains full\n administrative visibility into the entire WorkMail organization (or as set in the IAM\n policy). This includes, but is not limited to, the ability to create, update, and delete\n users, groups, and resources. This allows developers to perform the scenarios listed above,\n as well as give users the ability to grant access on a selective basis using the IAM\n model.

", "smithy.api#title": "Amazon WorkMail" } }